Class yii\apidoc\models\BaseDoc
Inheritance | yii\apidoc\models\BaseDoc » yii\base\BaseObject |
---|---|
Subclasses | yii\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 extension's version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/models/BaseDoc.php |
Base class for API documentation information.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$deprecatedReason | yii\apidoc\models\BaseDoc | ||
$deprecatedSince | yii\apidoc\models\BaseDoc | ||
$description | yii\apidoc\models\BaseDoc | ||
$endLine | yii\apidoc\models\BaseDoc | ||
$name | yii\apidoc\models\BaseDoc | ||
$phpDocContext | \phpDocumentor\Reflection\DocBlock\Context | yii\apidoc\models\BaseDoc | |
$shortDescription | yii\apidoc\models\BaseDoc | ||
$shortName | yii\apidoc\models\BaseDoc | ||
$since | yii\apidoc\models\BaseDoc | ||
$sourceFile | yii\apidoc\models\BaseDoc | ||
$startLine | yii\apidoc\models\BaseDoc | ||
$tags | \phpDocumentor\Reflection\DocBlock\Tag[] | yii\apidoc\models\BaseDoc |
Public Methods
Method | Description | Defined By |
---|---|---|
__construct() | yii\apidoc\models\BaseDoc | |
extractFirstSentence() | Extracts first sentence out of text | yii\apidoc\models\BaseDoc |
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
Method | Description | Defined By |
---|---|---|
mbUcFirst() | Multibyte version of ucfirst() | yii\apidoc\models\BaseDoc |
Property Details
Method Details
public void __construct ( $reflector = null, $context = null, $config = [] ) | ||
$reflector | \phpDocumentor\Reflection\Php\Class_ | |
$context | yii\apidoc\models\Context | |
$config | array |
public function __construct($reflector = null, $context = null, $config = [])
{
parent::__construct($config);
if ($reflector === null) {
return;
}
// base properties
$this->name = ltrim((string) $reflector->getFqsen(), '\\');
$separator = strrpos($this->name, '::');
if ($separator !== false) {
$this->shortName = substr($this->name, $separator + 2);
}
$this->startLine = $reflector->getLocation()->getLineNumber();
//$this->endLine = $reflector->getNode()->getAttribute('endLine');
$docblock = $reflector->getDocBlock();
if ($docblock !== null) {
$this->shortDescription = StringHelper::mb_ucfirst($docblock->getSummary());
if (empty($this->shortDescription) && !($this instanceof PropertyDoc) && $context !== null && $docblock->getTagsByName('inheritdoc') === null) {
$context->warnings[] = [
'line' => $this->startLine,
'file' => $this->sourceFile,
'message' => "No short description for " . substr(StringHelper::basename(get_class($this)), 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) {
$this->since = $tag->getVersion();
unset($this->tags[$i]);
} elseif ($tag instanceof Deprecated) {
$this->deprecatedSince = $tag->getVersion();
$this->deprecatedReason = $tag->getDescription();
unset($this->tags[$i]);
}
}
if ($this->shortDescription === '{@inheritdoc}') {
// 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('inheritdoc');
$this->shortDescription = '';
}
} elseif ($context !== null) {
$context->warnings[] = [
'line' => $this->startLine,
'file' => $this->sourceFile,
'message' => "No docblock for element '{$this->name}'",
];
}
}
Extracts first sentence out of text
public static string extractFirstSentence ( $text ) | ||
$text | string |
public static function extractFirstSentence($text)
{
if (mb_strlen($text, 'utf-8') > 4 && ($pos = mb_strpos($text, '.', 4, 'utf-8')) !== false) {
$sentence = mb_substr($text, 0, $pos + 1, 'utf-8');
if (mb_strlen($text, 'utf-8') >= $pos + 3) {
$abbrev = mb_substr($text, $pos - 1, 4, 'utf-8');
if ($abbrev === 'e.g.' || $abbrev === 'i.e.') { // do not break sentence after abbreviation
$sentence .= static::extractFirstSentence(mb_substr($text, $pos + 1, mb_strlen($text, 'utf-8'), 'utf-8'));
}
}
return $sentence;
}
return $text;
}
Get the first tag of a given name
public \phpDocumentor\Reflection\DocBlock\Tag|null getFirstTag ( $name ) | ||
$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 string|null getPackageName ( ) |
public function getPackageName()
{
if (!$this->sourceFile || !preg_match('/\/vendor\/([\w\-]+\/[\w\-]+)/', $this->sourceFile, $match)) {
return null;
}
return $match[1];
}
Checks if doc has tag of a given name
public boolean hasTag ( $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;
}
Multibyte version of ucfirst()
protected static void mbUcFirst ( $string ) | ||
$string |
protected static function mbUcFirst($string)
{
$firstChar = mb_strtoupper(mb_substr($string, 0, 1, 'utf-8'), 'utf-8');
return $firstChar . mb_substr($string, 1, mb_strlen($string, 'utf-8'), 'utf-8');
}