Class yii\apidoc\models\TypeDoc

Inheritanceyii\apidoc\models\TypeDoc » yii\apidoc\models\BaseDoc » yii\base\BaseObject
Subclassesyii\apidoc\models\ClassDoc, yii\apidoc\models\InterfaceDoc, yii\apidoc\models\TraitDoc
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/models/TypeDoc.php

Base class for API documentation information for classes, interfaces and traits.

Protected Methods

Hide inherited methods

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

Property Details

$authors public property
public $authors = []
$methods public property
$namespace public property
public $namespace null
$nativeMethods public property

This property is read-only.

$nativeProperties public property

This property is read-only.

$properties public property
$protectedMethods public property

This property is read-only.

$protectedProperties public property

This property is read-only.

$publicMethods public property

This property is read-only.

$publicProperties public property

This property is read-only.

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
getNativeMethods() public method

public yii\apidoc\models\MethodDoc[] getNativeMethods ( )
getNativeProperties() public method

public yii\apidoc\models\PropertyDoc[] getNativeProperties ( )
getProtectedMethods() public method

public yii\apidoc\models\MethodDoc[] getProtectedMethods ( )
getProtectedProperties() public method

public yii\apidoc\models\PropertyDoc[] getProtectedProperties ( )
getPublicMethods() public method

public yii\apidoc\models\MethodDoc[] getPublicMethods ( )
getPublicProperties() public method

public yii\apidoc\models\PropertyDoc[] getPublicProperties ( )