PHP Класс yii\apidoc\models\Context

С версии: 2.0

Автор: Carsten Brandt ([email protected])

Наследование: extends yii\base\Component

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$classes	yii\apidoc\models\ClassDoc[]
$errors	array
$files		list of php files that have been added to this context.
$interfaces	yii\apidoc\models\InterfaceDoc[]
$traits	yii\apidoc\models\TraitDoc[]
$warnings	array

Открытые методы

Метод	Описание
addFile ( string $fileName )	Adds file to context
getType ( string $type ) : null \| yii\apidoc\models\ClassDoc \| yii\apidoc\models\InterfaceDoc \| yii\apidoc\models\TraitDoc	Returning TypeDoc for a type given
updateReferences ( )	Updates references

Защищенные методы

Метод	Описание
handlePropertyFeature ( yii\apidoc\models\ClassDoc $class )	Add properties for getters and setters if class is subclass of Object.
inheritDocs ( yii\apidoc\models\ClassDoc $class )	Inhertit docsblocks using @inheritDoc tag.
isSubclassOf ( yii\apidoc\models\ClassDoc $classA, yii\apidoc\models\ClassDoc \| string $classB ) : boolean
updateSubInterfaceInheritance ( $interface )	Add methods to subinterfaces
updateSubclassInheritance ( yii\apidoc\models\ClassDoc $class )	Add implemented interfaces and used traits to subclasses
updateSubclassInterfacesTraits ( yii\apidoc\models\ClassDoc $class )	Add implemented interfaces and used traits to subclasses

Приватные методы

Метод	Описание
getFirstNotOptionalParameter ( yii\apidoc\models\MethodDoc $method ) : yii\apidoc\models\ParamDoc
getInterfaces ( yii\apidoc\models\ClassDoc $class ) : array
getParents ( yii\apidoc\models\ClassDoc $class ) : array
hasNonOptionalParams ( yii\apidoc\models\MethodDoc $method, integer $number ) : boolean	Check whether a method has $number non-optional parameters.
inheritMethodRecursive ( yii\apidoc\models\MethodDoc $method, yii\apidoc\models\ClassDoc $class ) : mixed
inheritPropertyRecursive ( PropertyDoc $method, yii\apidoc\models\ClassDoc $class ) : mixed

Описание методов

addFile() публичный Метод

Adds file to context

public addFile ( string $fileName )
$fileName	string

getType() публичный Метод

Returning TypeDoc for a type given

public getType ( string $type ) : null \| yii\apidoc\models\ClassDoc \| yii\apidoc\models\InterfaceDoc \| yii\apidoc\models\TraitDoc
$type	string
Результат	null \| yii\apidoc\models\ClassDoc \| yii\apidoc\models\InterfaceDoc \| yii\apidoc\models\TraitDoc

handlePropertyFeature() защищенный Метод

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

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

inheritDocs() защищенный Метод

Inhertit docsblocks using @inheritDoc tag.

См. также: http://phpdoc.org/docs/latest/guides/inheritance.html

protected inheritDocs ( yii\apidoc\models\ClassDoc $class )
$class	yii\apidoc\models\ClassDoc

isSubclassOf() защищенный Метод

protected isSubclassOf ( yii\apidoc\models\ClassDoc $classA, yii\apidoc\models\ClassDoc \| string $classB ) : boolean
$classA	yii\apidoc\models\ClassDoc
$classB	yii\apidoc\models\ClassDoc \| string
Результат	boolean

updateReferences() публичный Метод

Updates references

public updateReferences ( )

updateSubInterfaceInheritance() защищенный Метод

Add methods to subinterfaces

protected updateSubInterfaceInheritance ( $interface )

updateSubclassInheritance() защищенный Метод

Add implemented interfaces and used traits to subclasses

protected updateSubclassInheritance ( yii\apidoc\models\ClassDoc $class )
$class	yii\apidoc\models\ClassDoc

updateSubclassInterfacesTraits() защищенный Метод

Add implemented interfaces and used traits to subclasses

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

Описание свойств

$classes публичное свойство

public ClassDoc[],yii\apidoc\models $classes
Результат	yii\apidoc\models\ClassDoc[]

$errors публичное свойство

public array $errors
Результат	array

$files публичное свойство

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

public $files

$interfaces публичное свойство

public InterfaceDoc[],yii\apidoc\models $interfaces
Результат	yii\apidoc\models\InterfaceDoc[]

$traits публичное свойство

public TraitDoc[],yii\apidoc\models $traits
Результат	yii\apidoc\models\TraitDoc[]

$warnings публичное свойство

С версии: 2.0.6

public array $warnings
Результат	array