PHP 클래스 yii\apidoc\models\Context

부터: 2.0
저자: Carsten Brandt ([email protected])
상속: extends yii\base\Component
파일 보기 프로젝트 열기: yiisoft/yii2-apidoc 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$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