Class yii\apidoc\models\ClassDoc

All Classes | Properties | Methods
Inheritanceyii\apidoc\models\ClassDoc » yii\apidoc\models\TypeDoc » yii\apidoc\models\BaseDoc » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/models/ClassDoc.php

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 boolean yii\apidoc\models\ClassDoc
$isFinal boolean yii\apidoc\models\ClassDoc
$methods yii\apidoc\models\MethodDoc[] yii\apidoc\models\TypeDoc
$name yii\apidoc\models\BaseDoc
$namespace yii\apidoc\models\TypeDoc
$parentClass string 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 string[] yii\apidoc\models\ClassDoc
$tags \phpDocumentor\Reflection\DocBlock\Tag[] yii\apidoc\models\BaseDoc
$traits string[] yii\apidoc\models\ClassDoc

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() yii\apidoc\models\ClassDoc
__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
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
getPackageName() Returns the Composer package for this type, if it can be determined from $sourceFile. yii\apidoc\models\BaseDoc
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\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

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 boolean $isAbstract = null
$isFinal public property
public boolean $isFinal = null
$parentClass public property
public string $parentClass = null
$subclasses public property
public string[] $subclasses = []
$traits public property
public string[] $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 ( )