Class yii\apidoc\models\PropertyDoc
| Inheritance | yii\apidoc\models\PropertyDoc » yii\apidoc\models\BaseDoc » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/models/PropertyDoc.php |
Represents API documentation information for a property.
Public Properties
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\BaseObject |
| __construct() | yii\apidoc\models\PropertyDoc | |
| __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 |
| getIsReadOnly() | yii\apidoc\models\PropertyDoc | |
| getIsWriteOnly() | yii\apidoc\models\PropertyDoc | |
| 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
If property is read only. This property is read-only.
If property is write only. This property is read-only.
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 |
|---|---|---|