Class yii\apidoc\models\PropertyDoc
| Inheritance | yii\apidoc\models\PropertyDoc » yii\apidoc\models\BaseDoc » yii\base\Object |
|---|---|
| Available since version | 2.0 |
Represents API documentation information for a property.
Public Properties
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __construct() | yii\apidoc\models\PropertyDoc | |
| extractFirstSentence() | Extracts first sentence out of text | yii\apidoc\models\BaseDoc |
| getFirstTag() | Get the first tag of a given name | yii\apidoc\models\BaseDoc |
| getIsReadOnly() | yii\apidoc\models\PropertyDoc | |
| getIsWriteOnly() | yii\apidoc\models\PropertyDoc | |
| 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\PropertyReflector | |
| $context | yii\apidoc\models\Context | |
| $config | array | |
| public boolean getIsReadOnly ( ) | ||
| return | boolean | If property is read only |
|---|---|---|
| public boolean getIsWriteOnly ( ) | ||
| return | boolean | If property is write only |
|---|---|---|