Class yii\apidoc\models\EventDoc
| Inheritance | yii\apidoc\models\EventDoc » yii\apidoc\models\ConstDoc » yii\apidoc\models\BaseDoc » yii\base\Object |
|---|---|
| Available since version | 2.0 |
Represents API documentation information for an event.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $definedBy | yii\apidoc\models\ConstDoc | ||
| $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 | |
| $type | yii\apidoc\models\EventDoc | ||
| $types | yii\apidoc\models\EventDoc | ||
| $value | yii\apidoc\models\ConstDoc |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __construct() | yii\apidoc\models\EventDoc | |
| extractFirstSentence() | Extracts first sentence out of text | yii\apidoc\models\BaseDoc |
| getFirstTag() | Get the first tag of a given name | 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\ClassReflector\ConstantReflector | |
| $context | yii\apidoc\models\Context | |
| $config | array | |