Class yii\apidoc\models\ClassDoc

All Classes | Properties | Methods | Constants
Inheritanceyii\apidoc\models\ClassDoc » yii\apidoc\models\TypeDoc » yii\apidoc\models\BaseDoc » yii\base\BaseObject
Available since extension's version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/models/ClassDoc.php

Represents API documentation information for a class.

Public Properties

Hide inherited properties

Property Type Description Defined By
$authors array yii\apidoc\models\TypeDoc
$constants array yii\apidoc\models\TypeDoc
$deprecatedReason string|null yii\apidoc\models\BaseDoc
$deprecatedSince string|null yii\apidoc\models\BaseDoc
$description string|null yii\apidoc\models\BaseDoc
$endLine integer|null yii\apidoc\models\BaseDoc
$events array yii\apidoc\models\TypeDoc
$fullName string|null yii\apidoc\models\BaseDoc
$interfaces string[] yii\apidoc\models\ClassDoc
$isAbstract boolean yii\apidoc\models\ClassDoc
$isFinal boolean yii\apidoc\models\ClassDoc
$methods yii\apidoc\models\MethodDoc[] yii\apidoc\models\TypeDoc
$name string|null yii\apidoc\models\BaseDoc
$namespace string yii\apidoc\models\TypeDoc
$nativeEvents yii\apidoc\models\EventDoc[] yii\apidoc\models\ClassDoc
$nativeMethods yii\apidoc\models\MethodDoc[] yii\apidoc\models\TypeDoc
$nativeProperties yii\apidoc\models\PropertyDoc[] yii\apidoc\models\TypeDoc
$packageName string|null yii\apidoc\models\BaseDoc
$parent yii\apidoc\models\BaseDoc
$parentClass string|null yii\apidoc\models\ClassDoc
$phpDocContext \phpDocumentor\Reflection\Types\Context|null yii\apidoc\models\BaseDoc
$phpStanTypeImports array yii\apidoc\models\BaseDoc
$phpStanTypes array yii\apidoc\models\BaseDoc
$properties yii\apidoc\models\PropertyDoc[] yii\apidoc\models\TypeDoc
$protectedMethods yii\apidoc\models\MethodDoc[] yii\apidoc\models\TypeDoc
$protectedProperties yii\apidoc\models\PropertyDoc[] yii\apidoc\models\TypeDoc
$psalmTypeImports array yii\apidoc\models\BaseDoc
$psalmTypes array yii\apidoc\models\BaseDoc
$publicMethods yii\apidoc\models\MethodDoc[] yii\apidoc\models\TypeDoc
$publicProperties yii\apidoc\models\PropertyDoc[] yii\apidoc\models\TypeDoc
$shortDescription string|null yii\apidoc\models\BaseDoc
$since string|null Available since this version. yii\apidoc\models\BaseDoc
$sinceMap array A mapping where keys are versions and values are descriptions. yii\apidoc\models\BaseDoc
$sourceFile string|null yii\apidoc\models\BaseDoc
$startLine integer|null yii\apidoc\models\BaseDoc
$subclasses string[] yii\apidoc\models\ClassDoc
$tags \phpDocumentor\Reflection\DocBlock\Tag[] yii\apidoc\models\BaseDoc
$templates array yii\apidoc\models\BaseDoc
$todos \phpDocumentor\Reflection\DocBlock\Tags\Generic[] yii\apidoc\models\BaseDoc
$traits string[] yii\apidoc\models\ClassDoc

Public Methods

Hide inherited methods

Method Description Defined By
__construct() yii\apidoc\models\ClassDoc
findSubject() Finds subject (method or property) by name yii\apidoc\models\ClassDoc
getFirstTag() Get the first tag of a given name yii\apidoc\models\BaseDoc
getNativeEvents() yii\apidoc\models\ClassDoc
getNativeMethods() yii\apidoc\models\TypeDoc
getNativeProperties() yii\apidoc\models\TypeDoc
getPackageName() Returns the Composer package for this type, if it can be determined from $sourceFile. yii\apidoc\models\BaseDoc
getProtectedMethods() yii\apidoc\models\TypeDoc
getProtectedProperties() yii\apidoc\models\TypeDoc
getPublicMethods() yii\apidoc\models\TypeDoc
getPublicProperties() yii\apidoc\models\TypeDoc
hasTag() Checks if doc has tag of a given name yii\apidoc\models\BaseDoc
removeTag() Removes tag of a given name yii\apidoc\models\BaseDoc

Protected Methods

Hide inherited methods

Method Description Defined By
initProperties() yii\apidoc\models\TypeDoc
isInheritdocTag() yii\apidoc\models\BaseDoc

Constants

Hide inherited constants

Constant Value Description Defined By
INHERITDOC_TAG_NAME 'inheritdoc' yii\apidoc\models\BaseDoc
PHPSTAN_IMPORT_TYPE_ANNOTATION_NAME 'phpstan-import-type' yii\apidoc\models\BaseDoc
PHPSTAN_TYPE_ANNOTATION_NAME 'phpstan-type' yii\apidoc\models\BaseDoc
PSALM_IMPORT_TYPE_ANNOTATION_NAME 'psalm-import-type' yii\apidoc\models\BaseDoc
PSALM_TYPE_ANNOTATION_NAME 'psalm-type' yii\apidoc\models\BaseDoc
TODO_TAG_NAME 'todo' yii\apidoc\models\BaseDoc

Property Details

Hide inherited properties

$interfaces public property
public string[] $interfaces = []
$isAbstract public property
public boolean $isAbstract = null
$isFinal public property
public boolean $isFinal = null
$nativeEvents public property
public yii\apidoc\models\EventDoc[] $nativeEvents = null
$parentClass public property
public string|null $parentClass = null
$subclasses public property
public string[] $subclasses = []
$traits public property
public string[] $traits = []

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( \phpDocumentor\Reflection\Php\Class_|null $reflector = null, yii\apidoc\models\Context|null $context = null, array $config = [] )
$reflector \phpDocumentor\Reflection\Php\Class_|null
$context yii\apidoc\models\Context|null
$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, '\\');
    }
}
findSubject() public method

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 yii\apidoc\models\BaseDoc|null findSubject ( mixed $subjectName )
$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;
}
getFirstTag() public method (available since version 2.0.5)

Defined in: yii\apidoc\models\BaseDoc::getFirstTag()

Get the first tag of a given name

public \phpDocumentor\Reflection\DocBlock\Tag|null getFirstTag ( string $name )
$name string

Tag name.
return \phpDocumentor\Reflection\DocBlock\Tag|null

Tag instance, null if not found.

 

                public function getFirstTag($name)
{
    foreach ($this->tags as $i => $tag) {
        if (strtolower($tag->getName()) == $name) {
            return $this->tags[$i];
        }
    }
    return null;
}
getNativeEvents() public method

public yii\apidoc\models\EventDoc[] getNativeEvents ( )

                public function getNativeEvents()
{
    $events = [];
    foreach ($this->events as $name => $event) {
        if ($event->definedBy != $this->name) {
            continue;
        }
        $events[$name] = $event;
    }
    return $events;
}
getNativeMethods() public method

Defined in: yii\apidoc\models\TypeDoc::getNativeMethods()

public yii\apidoc\models\MethodDoc[] getNativeMethods ( )

                public function getNativeMethods()
{
    return $this->getFilteredMethods(null, $this->name);
}
getNativeProperties() public method

Defined in: yii\apidoc\models\TypeDoc::getNativeProperties()

public yii\apidoc\models\PropertyDoc[] getNativeProperties ( )

                public function getNativeProperties()
{
    return $this->getFilteredProperties(null, $this->name);
}
getPackageName() public method (available since version 2.1.3)

Defined in: yii\apidoc\models\BaseDoc::getPackageName()

Returns the Composer package for this type, if it can be determined from $sourceFile.

public string|null getPackageName ( )

                public function getPackageName()
{
    if (!$this->sourceFile || !preg_match('/\/vendor\/([\w\-]+\/[\w\-]+)/', $this->sourceFile, $match)) {
        return null;
    }
    return $match[1];
}
getProtectedMethods() public method

Defined in: yii\apidoc\models\TypeDoc::getProtectedMethods()

public yii\apidoc\models\MethodDoc[] getProtectedMethods ( )

                public function getProtectedMethods()
{
    return $this->getFilteredMethods('protected');
}
getProtectedProperties() public method

Defined in: yii\apidoc\models\TypeDoc::getProtectedProperties()

public yii\apidoc\models\PropertyDoc[] getProtectedProperties ( )

                public function getProtectedProperties()
{
    return $this->getFilteredProperties('protected');
}
getPublicMethods() public method

Defined in: yii\apidoc\models\TypeDoc::getPublicMethods()

public yii\apidoc\models\MethodDoc[] getPublicMethods ( )

                public function getPublicMethods()
{
    return $this->getFilteredMethods('public');
}
getPublicProperties() public method

Defined in: yii\apidoc\models\TypeDoc::getPublicProperties()

public yii\apidoc\models\PropertyDoc[] getPublicProperties ( )

                public function getPublicProperties()
{
    return $this->getFilteredProperties('public');
}
hasTag() public method

Defined in: yii\apidoc\models\BaseDoc::hasTag()

Checks if doc has tag of a given name

public boolean hasTag ( string $name )
$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;
}
initProperties() protected method

Defined in: yii\apidoc\models\TypeDoc::initProperties()

protected mixed initProperties ( \phpDocumentor\Reflection\Php\Class_ $reflector, yii\apidoc\models\Context $context )
$reflector \phpDocumentor\Reflection\Php\Class_
$context yii\apidoc\models\Context 

                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;
        }
    }
}
isInheritdocTag() protected method

Defined in: yii\apidoc\models\BaseDoc::isInheritdocTag()

protected boolean isInheritdocTag ( \phpDocumentor\Reflection\DocBlock\Tag $tag )
$tag \phpDocumentor\Reflection\DocBlock\Tag 

                protected function isInheritdocTag(Tag $tag): bool
{
    return $tag instanceof Generic && $tag->getName() === self::INHERITDOC_TAG_NAME;
}
removeTag() public method

Defined in: yii\apidoc\models\BaseDoc::removeTag()

Removes tag of a given name

public mixed removeTag ( string $name )
$name string 

                public function removeTag($name)
{
    foreach ($this->tags as $i => $tag) {
        if (strtolower($tag->getName()) == $name) {
            unset($this->tags[$i]);
        }
    }
}