Class yii\apidoc\models\TraitDoc

Inheritanceyii\apidoc\models\TraitDoc » yii\apidoc\models\TypeDoc » yii\apidoc\models\BaseDoc » yii\base\Object
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/models/TraitDoc.php

Represents API documentation information for a trait.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Object
__construct() yii\apidoc\models\TraitDoc
__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
findSubject() Finds subject (method or property) by name yii\apidoc\models\TypeDoc
getFirstTag() Get the first tag of a given name yii\apidoc\models\BaseDoc
getNativeMethods() yii\apidoc\models\TypeDoc
getNativeProperties() yii\apidoc\models\TypeDoc
getProtectedMethods() yii\apidoc\models\TypeDoc
getProtectedProperties() yii\apidoc\models\TypeDoc
getPublicMethods() yii\apidoc\models\TypeDoc
getPublicProperties() yii\apidoc\models\TypeDoc
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

Protected Methods

Hide inherited methods

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

Property Details

$traits public property
public $traits = []
$usedBy public property
public $usedBy = []

Method Details

__construct() public method

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