Class yii\apidoc\models\PropertyDoc

Inheritanceyii\apidoc\models\PropertyDoc » yii\apidoc\models\BaseDoc » yii\base\BaseObject
Available since version2.0

Represents API documentation information for a property.

Public Methods

Hide inherited methods

MethodDescriptionDefined 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
getPackageName() Returns the Composer package for this type, if it can be determined from $sourceFile. 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

Hide inherited methods

MethodDescriptionDefined By
mbUcFirst() Multibyte version of ucfirst() yii\apidoc\models\BaseDoc

Property Details

$defaultValue public property
public $defaultValue null
$definedBy public property
public $definedBy null
$getter public property
public $getter null
$isStatic public property
public $isStatic null
$setter public property
public $setter null
$type public property
public $type null
$types public property
public $types null
$visibility public property
public $visibility null

Method Details

__construct() public method

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

public boolean getIsReadOnly ( )
return boolean

If property is read only

getIsWriteOnly() public method

public boolean getIsWriteOnly ( )
return boolean

If property is write only