# 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

Hide inherited 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 | boolean | If property is read only. This property is read-only. | yii\apidoc\models\PropertyDoc
$isStatic |  |  | yii\apidoc\models\PropertyDoc
$isWriteOnly | boolean | If property is write only. This property is read-only. | yii\apidoc\models\PropertyDoc
$name |  |  | yii\apidoc\models\BaseDoc
$packageName | string|null |  | 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

## Public Methods

Hide inherited 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

Hide inherited methods

Method | Description | Defined 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
$isReadOnly public property

If property is read only. This property is read-only.

public boolean $isReadOnly = null
$isStatic public property
public $isStatic = null
$isWriteOnly public property

If property is write only. This property is read-only.

public boolean $isWriteOnly = 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