Class yii\apidoc\models\ClassDoc

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.

Protected Methods

Hide inherited methods

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

Property Details

$constants public property
$events public property
$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 )
getNativeEvents() public method

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