Class yii\apidoc\models\PropertyDoc

All Classes | Properties | Methods

Inheritance	yii\apidoc\models\PropertyDoc » yii\apidoc\models\BaseDoc » yii\base\Object
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

Property	Type	Description	Defined By
$defaultValue			yii\apidoc\models\PropertyDoc
$definedBy			yii\apidoc\models\PropertyDoc
$deprecatedReason			yii\apidoc\models\BaseDoc
$deprecatedSince			yii\apidoc\models\BaseDoc
$description			yii\apidoc\models\BaseDoc
$endLine			yii\apidoc\models\BaseDoc
$getter			yii\apidoc\models\PropertyDoc
$isReadOnly	bool	If property is read only	yii\apidoc\models\PropertyDoc
$isStatic			yii\apidoc\models\PropertyDoc
$isWriteOnly	bool	If property is write only	yii\apidoc\models\PropertyDoc
$name			yii\apidoc\models\BaseDoc
$phpDocContext	\phpDocumentor\Reflection\DocBlock\Context		yii\apidoc\models\BaseDoc
$setter			yii\apidoc\models\PropertyDoc
$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\PropertyDoc
$types			yii\apidoc\models\PropertyDoc
$visibility			yii\apidoc\models\PropertyDoc

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__construct()		yii\apidoc\models\PropertyDoc
__get()	Returns the value of an object property.	yii\base\Object
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Object
__set()	Sets value of an object property.	yii\base\Object
__unset()	Sets an object property to null.	yii\base\Object
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Object
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Object
className()	Returns the fully qualified name of this class.	yii\base\Object
extractFirstSentence()	Extracts first sentence out of text	yii\apidoc\models\BaseDoc
getIsReadOnly()		yii\apidoc\models\PropertyDoc
getIsWriteOnly()		yii\apidoc\models\PropertyDoc
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Object
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\Object
hasTag()	Checks if doc has tag of a given name	yii\apidoc\models\BaseDoc
init()	Initializes the object.	yii\base\Object
removeTag()	Removes tag of a given name	yii\apidoc\models\BaseDoc

$defaultValue public property

$definedBy public property

$getter public property

$getter = null

$isReadOnly public read-only property

bool getIsReadOnly( )

If property is read only

$isStatic public property

$isWriteOnly public read-only property

bool getIsWriteOnly( )

If property is write only

$setter public property

$setter = null

$type public property

$type = null

$types public property

$types = null

$visibility public property

__construct() public method

void __construct( $reflector = null, $context = null, $config = [] )
$reflector	\phpDocumentor\Reflection\ClassReflector\PropertyReflector
$context	yii\apidoc\models\Context
$config	array

getIsReadOnly() public method

bool getIsReadOnly( )
return	bool	If property is read only

getIsWriteOnly() public method

bool getIsWriteOnly( )
return	bool	If property is write only