Class yii\apidoc\models\FunctionDoc

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

Represents API documentation information for a function.

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
$exceptions \phpDocumentor\Reflection\DocBlock\Tags\Throws[] yii\apidoc\models\FunctionDoc
$fullName string|null yii\apidoc\models\BaseDoc
$isReturnByReference boolean yii\apidoc\models\FunctionDoc
$name string|null yii\apidoc\models\BaseDoc
$packageName string|null yii\apidoc\models\BaseDoc
$params yii\apidoc\models\ParamDoc[] yii\apidoc\models\FunctionDoc
$parent yii\apidoc\models\BaseDoc
$phpDocContext \phpDocumentor\Reflection\Types\Context|null yii\apidoc\models\BaseDoc
$phpStanTypeImports array yii\apidoc\models\BaseDoc
$phpStanTypes array yii\apidoc\models\BaseDoc
$psalmTypeImports array yii\apidoc\models\BaseDoc
$psalmTypes array yii\apidoc\models\BaseDoc
$return string|null yii\apidoc\models\FunctionDoc
$returnType \phpDocumentor\Reflection\Type|null yii\apidoc\models\FunctionDoc
$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
$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

Public Methods

Hide inherited methods

Method Description Defined By
__construct() yii\apidoc\models\FunctionDoc
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
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
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

$exceptions public property
public \phpDocumentor\Reflection\DocBlock\Tags\Throws[] $exceptions = []
$isReturnByReference public property
public boolean $isReturnByReference = null
$params public property
public yii\apidoc\models\ParamDoc[] $params = []
$return public property
public string|null $return = null
$returnType public property
public \phpDocumentor\Reflection\Type|null $returnType = null

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( yii\apidoc\models\BaseDoc|null $parent, \phpDocumentor\Reflection\Php\Method|null $reflector = null, yii\apidoc\models\Context|null $context = null, array $config = [] )
$parent yii\apidoc\models\BaseDoc|null
$reflector \phpDocumentor\Reflection\Php\Method|null
$context yii\apidoc\models\Context|null
$config array 

                public function __construct($parent, $reflector = null, $context = null, $config = [])
{
    parent::__construct($parent, $reflector, $context, $config);
    if ($reflector === null) {
        return;
    }
    $this->isReturnByReference = $reflector->getHasReturnByReference();
    foreach ($reflector->getArguments() as $arg) {
        $arg = new ParamDoc($this, $arg, $context, ['sourceFile' => $this->sourceFile]);
        $this->params[$arg->name] = $arg;
    }
    $hasInheritdoc = false;
    foreach ($this->tags as $i => $tag) {
        if ($tag instanceof Throws) {
            $this->exceptions[] = $tag;
            unset($this->tags[$i]);
        } elseif ($tag instanceof Param) {
            $paramName = '$' . $tag->getVariableName();
            if (!isset($this->params[$paramName]) && $context !== null) {
                $context->errors[] = [
                    'line' => $this->startLine,
                    'file' => $this->sourceFile,
                    'message' => "Undefined parameter documented: $paramName in {$this->name}().",
                ];
                continue;
            }
            $this->params[$paramName]->description = StringHelper::mb_ucfirst($tag->getDescription());
            $this->params[$paramName]->type = $tag->getType();
            unset($this->tags[$i]);
        } elseif ($tag instanceof Return_) {
            $this->returnType = $tag->getType();
            $this->return = StringHelper::mb_ucfirst($tag->getDescription());
            unset($this->tags[$i]);
        } elseif ($this->isInheritdocTag($tag)) {
            $hasInheritdoc = true;
        }
    }
    if (!$hasInheritdoc && $this->returnType === null) {
        $this->returnType = $reflector->getReturnType();
    }
}
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;
}
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];
}
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;
}
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]);
        }
    }
}