# Class yii\apidoc\models\Context

Inheritance | yii\apidoc\models\Context » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/models/Context.php

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$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

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component
__construct() | Constructor. | yii\base\BaseObject
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__unset() | Sets a component property to be null. | yii\base\Component
addFile() | Adds file to context | yii\apidoc\models\Context
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
getType() | Returning TypeDoc for a type given | yii\apidoc\models\Context
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
init() | Initializes the object. | yii\base\BaseObject
off() | Detaches an existing event handler from this component. | yii\base\Component
on() | Attaches an event handler to an event. | yii\base\Component
trigger() | Triggers an event. | yii\base\Component
updateReferences() | Updates references | yii\apidoc\models\Context

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
handlePropertyFeature() | Add properties for getters and setters if class is subclass of yii\base\BaseObject. | yii\apidoc\models\Context
inheritDocs() | Inherit 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\BaseObject.

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

inheritDocs() protected method

Inherit 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 | yii\apidoc\models\InterfaceDoc |

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 |