Class yii\apidoc\models\ClassDoc
| Inheritance | yii\ |
|---|---|
| Implements | yii\ |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/models/ClassDoc.php |
Represents API documentation information for a class.
Public Properties
Public Methods
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| initProperties() | yii\ |
|
| isInheritdocTag() | yii\ |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| INHERITDOC_TAG_NAME | 'inheritdoc' | yii\ |
|
| PHPSTAN_IMPORT_TYPE_ANNOTATION_NAME | 'phpstan-import-type' | yii\ |
|
| PHPSTAN_TYPE_ANNOTATION_NAME | 'phpstan-type' | yii\ |
|
| PSALM_IMPORT_TYPE_ANNOTATION_NAME | 'psalm-import-type' | yii\ |
|
| PSALM_TYPE_ANNOTATION_NAME | 'psalm-type' | yii\ |
|
| TODO_TAG_NAME | 'todo' | yii\ |
Property Details
Method Details
Defined in:
yii\
Calls the named method which is not a class method.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
| public __call( string $name, array $params ): mixed | ||
| $name | string |
The method name |
| $params | array |
Method parameters |
| return | mixed |
The method return value |
|---|---|---|
| throws | yii\ |
when calling unknown method |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
| public __construct( \phpDocumentor\Reflection\Php\Class_|null $reflector = null, yii\ | ||
| $reflector | \phpDocumentor\Reflection\Php\Class_|null | |
| $context | yii\ |
|
| $config | array | |
public function __construct($reflector = null, $context = null, $config = [])
{
parent::__construct($reflector, $context, $config);
if ($reflector === null) {
return;
}
$reflectorParent = $reflector->getParent();
$this->parentClass = $reflectorParent !== null ? ltrim($reflectorParent, '\\') : null;
if (empty($this->parentClass)) {
$this->parentClass = null;
}
$this->isAbstract = $reflector->isAbstract();
$this->isFinal = $reflector->isFinal();
foreach ($reflector->getInterfaces() as $interface) {
$this->interfaces[] = ltrim($interface, '\\');
}
foreach ($reflector->getUsedTraits() as $trait) {
$this->traits[] = ltrim($trait, '\\');
}
}
Defined in:
yii\
Returns the value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $object->property;.
See also __set().
| public __get( string $name ): mixed | ||
| $name | string |
The property name |
| return | mixed |
The property value |
|---|---|---|
| throws | yii\ |
if the property is not defined |
| throws | yii\ |
if the property is write-only |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in:
yii\
Checks if a property is set, i.e. defined and not null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($object->property).
Note that if the property is not defined, false will be returned.
| public __isset( string $name ): boolean | ||
| $name | string |
The property name or the event name |
| return | boolean |
Whether the named property is set (not null). |
|---|---|---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
Defined in:
yii\
Sets value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $object->property = $value;.
See also __get().
| public __set( string $name, mixed $value ): mixed | ||
| $name | string |
The property name or the event name |
| $value | mixed |
The property value |
| throws | yii\ |
if the property is not defined |
|---|---|---|
| throws | yii\ |
if the property is read-only |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
Defined in:
yii\
Sets an object property to null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($object->property).
Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.
| public __unset( string $name ): mixed | ||
| $name | string |
The property name |
| throws | yii\ |
if the property is read only. |
|---|---|---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
Defined in:
yii\
Returns a value indicating whether a property can be read.
A property is readable if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also canSetProperty().
| public canGetProperty( string $name, boolean $checkVars = true ): boolean | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property can be read |
|---|---|---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
Defined in:
yii\
Returns a value indicating whether a property can be set.
A property is writable if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also canGetProperty().
| public canSetProperty( string $name, boolean $checkVars = true ): boolean | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property can be written |
|---|---|---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class instead.
Defined in:
yii\
Returns the fully qualified name of this class.
| public static className( ): string | ||
| return | string |
The fully qualified name of this class. |
|---|---|---|
public static function className()
{
return get_called_class();
}
Finds subject (method or property) by name
If there is a property with the same as a method, the method will be returned if the name is not stated
explicitly by prefixing with $.
Example for method attributes() and property $attributes which both may exist:
$subjectName = '$attributes'finds a property or nothing.$subjectName = 'attributes()'finds a method or nothing.$subjectName = 'attributes'finds the method if it exists, if not it will find the property.
| public findSubject( mixed $subjectName ): yii\ | ||
| $subjectName | mixed | |
public function findSubject($subjectName)
{
if (($subject = parent::findSubject($subjectName)) !== null) {
return $subject;
}
foreach ($this->events as $name => $event) {
if ($subjectName == $name) {
return $event;
}
}
foreach ($this->constants as $name => $constant) {
if ($subjectName == $name) {
return $constant;
}
}
return null;
}
Defined in:
yii\
Get the first tag of a given name
| public getFirstTag( string $name ): \phpDocumentor\Reflection\DocBlock\Tag|null | ||
| $name | string |
Tag name. |
| return | \phpDocumentor\Reflection\DocBlock\Tag|null |
Tag instance, |
|---|---|---|
public function getFirstTag($name)
{
foreach ($this->tags as $i => $tag) {
if (strtolower($tag->getName()) == $name) {
return $this->tags[$i];
}
}
return null;
}
| public getNativeEvents( ): yii\ |
public function getNativeEvents()
{
$events = [];
foreach ($this->events as $name => $event) {
if ($event->definedBy != $this->name) {
continue;
}
$events[$name] = $event;
}
return $events;
}
Defined in:
yii\
| public getNativeMethods( ): yii\ |
public function getNativeMethods()
{
return $this->getFilteredMethods(null, $this->name);
}
Defined in:
yii\
| public getNativeProperties( ): yii\ |
public function getNativeProperties()
{
return $this->getFilteredProperties(null, $this->name);
}
Defined in:
yii\
Returns the Composer package for this type, if it can be determined from $sourceFile.
| public getPackageName( ): string|null |
public function getPackageName()
{
if (!$this->sourceFile || !preg_match('/\/vendor\/([\w\-]+\/[\w\-]+)/', $this->sourceFile, $match)) {
return null;
}
return $match[1];
}
Defined in:
yii\
| public getProtectedMethods( ): yii\ |
public function getProtectedMethods()
{
return $this->getFilteredMethods('protected');
}
| public getProtectedProperties( ): yii\ |
public function getProtectedProperties()
{
return $this->getFilteredProperties('protected');
}
Defined in:
yii\
| public getPublicMethods( ): yii\ |
public function getPublicMethods()
{
return $this->getFilteredMethods('public');
}
Defined in:
yii\
| public getPublicProperties( ): yii\ |
public function getPublicProperties()
{
return $this->getFilteredProperties('public');
}
Defined in:
yii\
Returns a value indicating whether a method is defined.
The default implementation is a call to php function method_exists().
You may override this method when you implemented the php magic method __call().
| public hasMethod( string $name ): boolean | ||
| $name | string |
The method name |
| return | boolean |
Whether the method is defined |
|---|---|---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
Defined in:
yii\
Returns a value indicating whether a property is defined.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also:
| public hasProperty( string $name, boolean $checkVars = true ): boolean | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property is defined |
|---|---|---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
Defined in:
yii\
Checks if doc has tag of a given name
| public hasTag( string $name ): boolean | ||
| $name | string |
Tag name |
| return | boolean |
If doc has tag of a given name |
|---|---|---|
public function hasTag($name)
{
foreach ($this->tags as $tag) {
if (strtolower($tag->getName()) == $name) {
return true;
}
}
return false;
}
Defined in:
yii\
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
| public init( ): mixed |
public function init()
{
}
Defined in:
yii\
| protected initProperties( \phpDocumentor\Reflection\Php\Class_ $reflector, yii\ | ||
| $reflector | \phpDocumentor\Reflection\Php\Class_ | |
| $context | yii\ |
|
protected function initProperties($reflector, $context)
{
foreach ($reflector->getProperties() as $propertyReflector) {
if ($propertyReflector->getDocBlock() && $propertyReflector->getDocBlock()->hasTag('internal')) {
continue;
}
if ((string) $propertyReflector->getVisibility() !== 'private') {
$property = new PropertyDoc($this, $propertyReflector, $context, ['sourceFile' => $this->sourceFile]);
$property->definedBy = $this->name;
$this->properties[$property->name] = $property;
}
}
}
Defined in:
yii\
| protected isInheritdocTag( \phpDocumentor\Reflection\DocBlock\Tag $tag ): boolean | ||
| $tag | \phpDocumentor\Reflection\DocBlock\Tag | |
protected function isInheritdocTag(Tag $tag): bool
{
return $tag instanceof Generic && $tag->getName() === self::INHERITDOC_TAG_NAME;
}
Defined in:
yii\
Removes tag of a given name
| public removeTag( string $name ): mixed | ||
| $name | string | |
public function removeTag($name)
{
foreach ($this->tags as $i => $tag) {
if (strtolower($tag->getName()) == $name) {
unset($this->tags[$i]);
}
}
}