Class yii\apidoc\models\BaseDoc
Base class for API documentation information.
Public Properties
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\ |
| __construct() | yii\ |
|
| __get() | Returns the value of an object property. | yii\ |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\ |
| __set() | Sets value of an object property. | yii\ |
| __unset() | Sets an object property to null. | yii\ |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\ |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\ |
| className() | Returns the fully qualified name of this class. | yii\ |
| getFirstTag() | Get the first tag of a given name | yii\ |
| getPackageName() | Returns the Composer package for this type, if it can be determined from $sourceFile. | yii\ |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\ |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\ |
| hasTag() | Checks if doc has tag of a given name | yii\ |
| init() | Initializes the object. | yii\ |
| removeTag() | Removes tag of a given name | yii\ |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| 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
A mapping where keys are versions and values are descriptions.
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( 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\ | ||
| $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\ |
|
| $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 = '';
}
}
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();
}
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;
}
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\
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);
}
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()
{
}
| 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;
}