Class yii\apidoc\models\BaseDoc

Inheritanceyii\apidoc\models\BaseDoc » yii\base\BaseObject
Implementsyii\base\Configurable
Subclassesyii\apidoc\models\ClassDoc, yii\apidoc\models\ConstDoc, yii\apidoc\models\EventDoc, yii\apidoc\models\FunctionDoc, yii\apidoc\models\InterfaceDoc, yii\apidoc\models\MethodDoc, yii\apidoc\models\PropertyDoc, yii\apidoc\models\TraitDoc, yii\apidoc\models\TypeDoc
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/models/BaseDoc.php

Base class for API documentation information.

Public Properties

Hide inherited properties

Property Type Description Defined By
$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
$fullName string|null yii\apidoc\models\BaseDoc
$name string|null yii\apidoc\models\BaseDoc
$packageName string|null yii\apidoc\models\BaseDoc
$parent yii\apidoc\models\BaseDoc
$phpDocContext \phpDocumentor\Reflection\Types\Context|null yii\apidoc\models\BaseDoc
$phpStanTypeImports array<string, yii\apidoc\models\PseudoTypeImportDoc> yii\apidoc\models\BaseDoc
$phpStanTypes array<string, yii\apidoc\models\PseudoTypeDoc> yii\apidoc\models\BaseDoc
$psalmTypeImports array<string, yii\apidoc\models\PseudoTypeImportDoc> yii\apidoc\models\BaseDoc
$psalmTypes array<string, yii\apidoc\models\PseudoTypeDoc> yii\apidoc\models\BaseDoc
$shortDescription string|null yii\apidoc\models\BaseDoc
$since string|null Available since this version. yii\apidoc\models\BaseDoc
$sinceMap array<string, string> 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
$tags \phpDocumentor\Reflection\DocBlock\Tag[] yii\apidoc\models\BaseDoc
$templates array<string, \phpDocumentor\Reflection\DocBlock\Tags\Template> yii\apidoc\models\BaseDoc
$todos \phpDocumentor\Reflection\DocBlock\Tags\Generic[] yii\apidoc\models\BaseDoc

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() yii\apidoc\models\BaseDoc
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
getFirstTag() Get the first tag of a given name yii\apidoc\models\BaseDoc
getPackageName() Returns the Composer package for this type, if it can be determined from $sourceFile. yii\apidoc\models\BaseDoc
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
hasTag() Checks if doc has tag of a given name yii\apidoc\models\BaseDoc
init() Initializes the object. yii\base\BaseObject
removeTag() Removes tag of a given name yii\apidoc\models\BaseDoc

Protected Methods

Hide inherited methods

Method Description Defined By
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

$deprecatedReason public property
$deprecatedSince public property
$description public property
public string|null $description = null
$endLine public property
public integer|null $endLine = null
$fullName public property
public string|null $fullName = null
$name public property
public string|null $name = null
$packageName public property
public string|null $packageName = null
$parent public property
public $parent = null
$phpDocContext public property
public \phpDocumentor\Reflection\Types\Context|null $phpDocContext = null
$phpStanTypeImports public property
$phpStanTypes public property
$psalmTypeImports public property
$psalmTypes public property
$shortDescription public property
$since public property

Available since this version.

public string|null $since = null
$sinceMap public property

A mapping where keys are versions and values are descriptions.

$sourceFile public property
public string|null $sourceFile = null
$startLine public property
public integer|null $startLine = null
$tags public property
public \phpDocumentor\Reflection\DocBlock\Tag[] $tags = []
$templates public property
public array<string, \phpDocumentor\Reflection\DocBlock\Tags\Template> $templates = []
$todos public property
public \phpDocumentor\Reflection\DocBlock\Tags\Generic[] $todos = []

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

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\base\UnknownMethodException

when calling unknown method

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__construct() public method
public __construct( self|null $parent = null, \phpDocumentor\Reflection\Php\Class_|\phpDocumentor\Reflection\Php\Method|\phpDocumentor\Reflection\Php\Trait_|\phpDocumentor\Reflection\Php\Interface_|\phpDocumentor\Reflection\Php\Property|\phpDocumentor\Reflection\Php\Constant|null $reflector = null, yii\apidoc\models\Context|null $context = null, array $config = [] ): mixed
$parent self|null
$reflector \phpDocumentor\Reflection\Php\Class_|\phpDocumentor\Reflection\Php\Method|\phpDocumentor\Reflection\Php\Trait_|\phpDocumentor\Reflection\Php\Interface_|\phpDocumentor\Reflection\Php\Property|\phpDocumentor\Reflection\Php\Constant|null
$context yii\apidoc\models\Context|null
$config array

                public function __construct(public $parent = null, $reflector = null, $context = null, $config = [])
{
    parent::__construct($config);
    if ($reflector === null) {
        return;
    }
    $fqsenResolver = new FqsenResolver();
    $typeResolver = new TypeResolver($fqsenResolver);
    // base properties
    $this->fullName = trim((string) $reflector->getFqsen(), '\\()');
    $position = strrpos($this->fullName, '::');
    $this->name = $position === false ? $this->fullName : substr($this->fullName, $position + 2);
    $this->startLine = $reflector->getLocation()->getLineNumber();
    $this->endLine = $reflector->getEndLocation()->getLineNumber();
    $docBlock = $reflector->getDocBlock();
    if ($docBlock === null) {
        if ($context !== null) {
            $context->warnings[] = [
                'line' => $this->startLine,
                'file' => $this->sourceFile,
                'message' => "No docblock for element '{$this->name}'",
            ];
        }
        return;
    }
    $this->shortDescription = StringHelper::mb_ucfirst($docBlock->getSummary());
    if (empty($this->shortDescription) && !($this instanceof PropertyDoc) && $context !== null && !$docBlock->getTagsByName(self::INHERITDOC_TAG_NAME)) {
        $context->warnings[] = [
            'line' => $this->startLine,
            'file' => $this->sourceFile,
            'message' => 'No short description for ' . substr(StringHelper::basename(static::class), 0, -3) . " '{$this->name}'",
        ];
    }
    $this->description = $docBlock->getDescription()->render();
    $this->phpDocContext = $docBlock->getContext();
    $this->tags = $docBlock->getTags();
    foreach ($this->tags as $i => $tag) {
        if ($tag instanceof Since) {
            $description = (string) $tag->getDescription();
            if (!$this->since && !$this->sinceMap && !$description) {
                $this->since = $tag->getVersion();
            }
            if ($description) {
                $this->sinceMap[$tag->getVersion()] = $description;
            }
            unset($this->tags[$i]);
        } elseif ($tag instanceof Deprecated) {
            $this->deprecatedSince = $tag->getVersion();
            $this->deprecatedReason = (string) $tag->getDescription();
            unset($this->tags[$i]);
        } elseif ($tag instanceof Template) {
            $this->templates[$tag->getTemplateName()] = $tag;
            unset($this->tags[$i]);
        } elseif ($tag instanceof Generic) {
            try {
                if ($tag->getName() === self::TODO_TAG_NAME) {
                    $this->todos[] = $tag;
                    unset($this->tags[$i]);
                } elseif ($tag->getName() === self::PHPSTAN_TYPE_ANNOTATION_NAME) {
                    $tagData = $this->parsePseudoTypeTag($tag);
                    $phpStanType = new PseudoTypeDoc(
                        PseudoTypeDoc::TYPE_PHPSTAN,
                        $this,
                        trim($tagData[0]),
                        $typeResolver->resolve(trim($tagData[1]), $this->phpDocContext),
                    );
                    $this->phpStanTypes[$phpStanType->name] = $phpStanType;
                    unset($this->tags[$i]);
                } elseif ($tag->getName() === self::PSALM_TYPE_ANNOTATION_NAME) {
                    $tagData = $this->parsePseudoTypeTag($tag);
                    $psalmType = new PseudoTypeDoc(
                        PseudoTypeDoc::TYPE_PSALM,
                        $this,
                        trim($tagData[0]),
                        $typeResolver->resolve(trim($tagData[1]), $this->phpDocContext),
                    );
                    $this->psalmTypes[$psalmType->name] = $psalmType;
                    unset($this->tags[$i]);
                } elseif ($tag->getName() === self::PHPSTAN_IMPORT_TYPE_ANNOTATION_NAME) {
                    $tagData = $this->parsePseudoTypeImportTag($tag);
                    $phpStanTypeImport = new PseudoTypeImportDoc(
                        PseudoTypeImportDoc::TYPE_PHPSTAN,
                        trim($tagData[0]),
                        $fqsenResolver->resolve(trim($tagData[1]), $this->phpDocContext),
                    );
                    $this->phpStanTypeImports[$phpStanTypeImport->typeName] = $phpStanTypeImport;
                    unset($this->tags[$i]);
                } elseif ($tag->getName() === self::PSALM_IMPORT_TYPE_ANNOTATION_NAME) {
                    $tagData = $this->parsePseudoTypeImportTag($tag);
                    $psalmTypeImport = new PseudoTypeImportDoc(
                        PseudoTypeImportDoc::TYPE_PSALM,
                        trim($tagData[0]),
                        $fqsenResolver->resolve(trim($tagData[1]), $this->phpDocContext),
                    );
                    $this->psalmTypeImports[$psalmTypeImport->typeName] = $psalmTypeImport;
                    unset($this->tags[$i]);
                }
            } catch (InvalidArgumentException | RuntimeException $e) {
                if ($context !== null) {
                    $context->errors[] = [
                        'line' => $this->startLine,
                        'file' => $this->sourceFile,
                        'message' => 'Exception: ' . $e->getMessage(),
                    ];
                } else {
                    throw $e;
                }
            }
        } elseif ($tag instanceof InvalidTag && $context !== null) {
            $exception = $tag->getException();
            $message = 'Invalid tag: ' . $tag->render() . '.';
            if ($exception !== null) {
                $message .= ' Exception message: ' . $exception->getMessage();
            }
            $context->errors[] = [
                'line' => $this->startLine,
                'file' => $this->sourceFile,
                'message' => $message,
            ];
        }
    }
    if (in_array($this->shortDescription, ['{@inheritdoc}', '{@inheritDoc}', '@inheritdoc', '@inheritDoc'], true)) {
        // Mock up parsing of '{@inheritdoc}' (in brackets) tag, which is not yet supported at "phpdocumentor/reflection-docblock" 2.x
        // todo consider removal in case of "phpdocumentor/reflection-docblock" upgrade
        $this->tags[] = new Generic(self::INHERITDOC_TAG_NAME);
        $this->shortDescription = '';
    }
}

            
__get() public method

Defined in: yii\base\BaseObject::__get()

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\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

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);
}

            
__isset() public method

Defined in: yii\base\BaseObject::__isset()

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.

See also https://www.php.net/manual/en/function.isset.php.

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;
}

            
__set() public method

Defined in: yii\base\BaseObject::__set()

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\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

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);
    }
}

            
__unset() public method

Defined in: yii\base\BaseObject::__unset()

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.

See also https://www.php.net/manual/en/function.unset.php.

public __unset( string $name ): mixed
$name string

The property name

throws yii\base\InvalidCallException

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);
    }
}

            
canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

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 $checkVars is 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);
}

            
canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

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 $checkVars is 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);
}

            
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

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

            
getFirstTag() public method (available since version 2.0.5)

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, 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;
}

            
getPackageName() public method (available since version 2.1.3)

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];
}

            
hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

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);
}

            
hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

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 $checkVars is 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);
}

            
hasTag() public method

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;
}

            
init() public method

Defined in: yii\base\BaseObject::init()

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()
{
}

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

            
removeTag() public method

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]);
        }
    }
}