Class yii\apidoc\models\TraitDoc
| Inheritance | yii\ |
|---|---|
| Available since extension's version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/models/TraitDoc.php |
Represents API documentation information for a trait.
Public Properties
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __construct() | yii\ |
|
| findSubject() | Finds subject (method or property) by name | yii\ |
| getFirstTag() | Get the first tag of a given name | yii\ |
| getNativeMethods() | yii\ |
|
| getNativeProperties() | yii\ |
|
| getPackageName() | Returns the Composer package for this type, if it can be determined from $sourceFile. | yii\ |
| getProtectedMethods() | yii\ |
|
| getProtectedProperties() | yii\ |
|
| getPublicMethods() | yii\ |
|
| getPublicProperties() | yii\ |
|
| hasTag() | Checks if doc has tag of a given name | yii\ |
| removeTag() | Removes tag of a given name | yii\ |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| initProperties() | yii\ |
|
| 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
Method Details
| public mixed __construct ( \ | ||
| $reflector | \ |
|
| $context | yii\ |
|
| $config | array | |
public function __construct($reflector = null, $context = null, $config = [])
{
parent::__construct($reflector, $context, $config);
if ($reflector === null) {
return;
}
foreach ($reflector->getUsedTraits() as $trait) {
$this->traits[] = ltrim($trait, '\\');
}
}
Defined in:
yii\
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\ | ||
| $subjectName | mixed | |
public function findSubject($subjectName)
{
if (empty($subjectName)) {
return null;
}
$subjectName = ltrim(str_replace($this->namespace, '', $subjectName), '\\');
if ($subjectName[0] !== '$') {
foreach ($this->methods as $name => $method) {
if (rtrim($subjectName, '()') == $name) {
return $method;
}
}
}
if (str_ends_with($subjectName, '()')) {
return null;
}
if ($this->properties === null) {
return null;
}
foreach ($this->properties as $name => $property) {
if (ltrim($subjectName, '$') == ltrim((string) $name, '$')) {
return $property;
}
}
return null;
}
Defined in:
yii\
Get the first tag of a given name
| public \ | ||
| $name | string |
Tag name. |
| return | \ |
Tag instance, |
|---|---|---|
public function getFirstTag($name)
{
foreach ($this->tags as $i => $tag) {
if (strtolower($tag->getName()) == $name) {
return $this->tags[$i];
}
}
return null;
}
Defined in:
yii\
| public yii\ |
public function getNativeMethods()
{
return $this->getFilteredMethods(null, $this->name);
}
Defined in:
yii\
| public yii\ |
public function getNativeProperties()
{
return $this->getFilteredProperties(null, $this->name);
}
Defined in:
yii\
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];
}
Defined in:
yii\
| public yii\ |
public function getProtectedMethods()
{
return $this->getFilteredMethods('protected');
}
| public yii\ |
public function getProtectedProperties()
{
return $this->getFilteredProperties('protected');
}
Defined in:
yii\
| public yii\ |
public function getPublicMethods()
{
return $this->getFilteredMethods('public');
}
Defined in:
yii\
| public yii\ |
public function getPublicProperties()
{
return $this->getFilteredProperties('public');
}
Defined in:
yii\
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;
}
Defined in:
yii\
| protected mixed initProperties ( \ | ||
| $reflector | \ |
|
| $context | yii\ |
|
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;
}
}
}
Defined in:
yii\
| protected boolean isInheritdocTag ( \ | ||
| $tag | \ |
|
protected function isInheritdocTag(Tag $tag): bool
{
return $tag instanceof Generic && $tag->getName() === self::INHERITDOC_TAG_NAME;
}
Defined in:
yii\
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]);
}
}
}