Class yii\apidoc\models\ClassDoc

All Classes | Properties | Methods
Inheritanceyii\apidoc\models\ClassDoc » yii\apidoc\models\TypeDoc » yii\apidoc\models\BaseDoc » yii\base\Object
Available since version2.0

Represents API documentation information for a class.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$authors yii\apidoc\models\TypeDoc
$constants yii\apidoc\models\ConstDoc[] yii\apidoc\models\ClassDoc
$deprecatedReason yii\apidoc\models\BaseDoc
$deprecatedSince yii\apidoc\models\BaseDoc
$description yii\apidoc\models\BaseDoc
$endLine yii\apidoc\models\BaseDoc
$events yii\apidoc\models\EventDoc[] yii\apidoc\models\ClassDoc
$interfaces string[] yii\apidoc\models\ClassDoc
$isAbstract yii\apidoc\models\ClassDoc
$isFinal yii\apidoc\models\ClassDoc
$methods yii\apidoc\models\MethodDoc[] yii\apidoc\models\TypeDoc
$name yii\apidoc\models\BaseDoc
$namespace yii\apidoc\models\TypeDoc
$parentClass yii\apidoc\models\ClassDoc
$phpDocContext \phpDocumentor\Reflection\DocBlock\Context yii\apidoc\models\BaseDoc
$properties yii\apidoc\models\PropertyDoc[] yii\apidoc\models\TypeDoc
$shortDescription yii\apidoc\models\BaseDoc
$since yii\apidoc\models\BaseDoc
$sourceFile yii\apidoc\models\BaseDoc
$startLine yii\apidoc\models\BaseDoc
$subclasses yii\apidoc\models\ClassDoc
$tags \phpDocumentor\Reflection\DocBlock\Tag[] yii\apidoc\models\BaseDoc
$traits yii\apidoc\models\ClassDoc

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() yii\apidoc\models\ClassDoc
extractFirstSentence() Extracts first sentence out of text yii\apidoc\models\BaseDoc
findSubject() Finds subject (method or property) by name yii\apidoc\models\ClassDoc
getFirstTag() Get the first tag of a given name yii\apidoc\models\BaseDoc
getNativeEvents() yii\apidoc\models\ClassDoc
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
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

$constants public property
public yii\apidoc\models\ConstDoc[] $constants = []
$events public property
public yii\apidoc\models\EventDoc[] $events = []
$interfaces public property
public string[] $interfaces = []
$isAbstract public property
public $isAbstract = null
$isFinal public property
public $isFinal = null
$parentClass public property
public $parentClass = null
$subclasses public property
public $subclasses = []
$traits public property
public $traits = []

Method Details

__construct() public method

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

Finds subject (method or property) by name

If there is a property with the same as a method, the method will be returned if the name is not stated explicitly by prefixing with $.

Example for method attributes() and property $attributes which both may exist:

  • $subjectName = '$attributes' finds a property or nothing.
  • $subjectName = 'attributes()' finds a method or nothing.
  • $subjectName = 'attributes' finds the method if it exists, if not it will find the property.
public null|yii\apidoc\models\MethodDoc|yii\apidoc\models\PropertyDoc findSubject ( $subjectName )
$subjectName
getNativeEvents() public method

public yii\apidoc\models\EventDoc[] getNativeEvents ( )