Class yii\apidoc\models\Context

All Classes | Properties | Methods
Inheritanceyii\apidoc\models\Context » yii\base\Component
Available since version2.0

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$classes yii\apidoc\models\ClassDoc[] yii\apidoc\models\Context
$errors array yii\apidoc\models\Context
$files array List of php files that have been added to this context. yii\apidoc\models\Context
$interfaces yii\apidoc\models\InterfaceDoc[] yii\apidoc\models\Context
$traits yii\apidoc\models\TraitDoc[] yii\apidoc\models\Context
$warnings array yii\apidoc\models\Context

Public Methods

Hide inherited methods

MethodDescriptionDefined By
addFile() Adds file to context yii\apidoc\models\Context
getType() Returning TypeDoc for a type given yii\apidoc\models\Context
updateReferences() Updates references yii\apidoc\models\Context

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
handlePropertyFeature() Add properties for getters and setters if class is subclass of \yii\base\Object. yii\apidoc\models\Context
inheritDocs() Inhertit docsblocks using @inheritDoc tag. yii\apidoc\models\Context
isSubclassOf() yii\apidoc\models\Context
updateSubInterfaceInheritance() Add methods to subinterfaces yii\apidoc\models\Context
updateSubclassInheritance() Add implemented interfaces and used traits to subclasses yii\apidoc\models\Context
updateSubclassInterfacesTraits() Add implemented interfaces and used traits to subclasses yii\apidoc\models\Context

Property Details

$classes public property
public yii\apidoc\models\ClassDoc[] $classes = []
$errors public property
public array $errors = []
$files public property

List of php files that have been added to this context.

public array $files = []
$interfaces public property
public yii\apidoc\models\InterfaceDoc[] $interfaces = []
$traits public property
public yii\apidoc\models\TraitDoc[] $traits = []
$warnings public property (available since version 2.0.6)
public array $warnings = []

Method Details

addFile() public method

Adds file to context

public void addFile ( $fileName )
$fileName string
getType() public method

Returning TypeDoc for a type given

public null|yii\apidoc\models\ClassDoc|yii\apidoc\models\InterfaceDoc|yii\apidoc\models\TraitDoc getType ( $type )
$type string
handlePropertyFeature() protected method

Add properties for getters and setters if class is subclass of \yii\base\Object.

protected void handlePropertyFeature ( $class )
$class yii\apidoc\models\ClassDoc
inheritDocs() protected method

Inhertit docsblocks using @inheritDoc tag.

See also http://phpdoc.org/docs/latest/guides/inheritance.html.

protected void inheritDocs ( $class )
$class yii\apidoc\models\ClassDoc
isSubclassOf() protected method

protected boolean isSubclassOf ( $classA, $classB )
$classA yii\apidoc\models\ClassDoc
$classB yii\apidoc\models\ClassDoc|string
updateReferences() public method

Updates references

public void updateReferences ( )
updateSubInterfaceInheritance() protected method

Add methods to subinterfaces

protected void updateSubInterfaceInheritance ( $interface )
$interface
updateSubclassInheritance() protected method

Add implemented interfaces and used traits to subclasses

protected void updateSubclassInheritance ( $class )
$class yii\apidoc\models\ClassDoc
updateSubclassInterfacesTraits() protected method

Add implemented interfaces and used traits to subclasses

protected void updateSubclassInterfacesTraits ( $class )
$class yii\apidoc\models\ClassDoc