Class yii\apidoc\models\BaseDoc
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 | ||
| $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 |
|---|---|---|
| __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 |
| 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 |
| 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
| 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\BaseReflector | |
| $context | yii\apidoc\models\Context | |
| $config | array | |
Extracts first sentence out of text
| public static string extractFirstSentence ( $text ) | ||
| $text | string | |
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, |
|---|---|---|
Returns the Composer package for this type, if it can be determined from $sourceFile.
| public string|null getPackageName ( ) |
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 |
|---|---|---|
Multibyte version of ucfirst()
| protected static void mbUcFirst ( $string ) | ||
| $string | ||
Removes tag of a given name
| public void removeTag ( $name ) | ||
| $name | string | |