PHP 클래스 Swagger\Context

The context in which the annotation is parsed. It includes useful metadata which the Processors can use to augment the annotations. Context hierarchy: - parseContext |- docBlockContext |- classContext |- docBlockContext |- propertyContext |- methodContext
파일 보기 프로젝트 열기: zircote/swagger-php 1 사용 예제들

공개 메소드들

메소드 설명
__construct ( array $properties = [], Context $parent = null )
__debugInfo ( )
__get ( string $property ) : mixed Traverse the context tree to get the property value.
__toString ( )
detect ( integer $index ) : Context Create a Context based on the debug_backtrace
fullyQualifiedName ( string $class ) : string Resolve the fully qualified name.
getDebugLocation ( ) : string Export location for debugging.
getRootContext ( ) : Context
is ( string $type ) : boolean Check if a property is set directly on this context and not its parent context.
not ( string $type ) : boolean Check if a property is NOT set directly on this context and but its parent context.
phpdocContent ( ) : string | null The text contents of the phpdoc comment (excl. tags)
phpdocDescription ( ) : string | null An optional longer piece of text providing more details on the associated element’s function. This is very useful when working with a complex element.
phpdocSummary ( ) : string | null A short piece of text, usually one line, providing the basic function of the associated element.
with ( string $property ) : boolean | Context Return the context containing the specified property.

메소드 상세

__construct() 공개 메소드

public __construct ( array $properties = [], Context $parent = null )
$properties array new properties for this context.
$parent Context The parent context

__debugInfo() 공개 메소드

public __debugInfo ( )

__get() 공개 메소드

Traverse the context tree to get the property value.
public __get ( string $property ) : mixed
$property string
리턴 mixed

__toString() 공개 메소드

public __toString ( )

detect() 공개 정적인 메소드

Create a Context based on the debug_backtrace
public static detect ( integer $index ) : Context
$index integer
리턴 Context

fullyQualifiedName() 공개 메소드

Resolve the fully qualified name.
public fullyQualifiedName ( string $class ) : string
$class string The class name
리턴 string

getDebugLocation() 공개 메소드

Export location for debugging.
public getDebugLocation ( ) : string
리턴 string Example: "file1.php on line 12"

getRootContext() 공개 메소드

public getRootContext ( ) : Context
리턴 Context

is() 공개 메소드

Check if a property is set directly on this context and not its parent context.
public is ( string $type ) : boolean
$type string Example: $c->is('method') or $c->is('class')
리턴 boolean

not() 공개 메소드

Check if a property is NOT set directly on this context and but its parent context.
public not ( string $type ) : boolean
$type string Example: $c->not('method') or $c->not('class')
리턴 boolean

phpdocContent() 공개 메소드

The text contents of the phpdoc comment (excl. tags)
public phpdocContent ( ) : string | null
리턴 string | null

phpdocDescription() 공개 메소드

An optional longer piece of text providing more details on the associated element’s function. This is very useful when working with a complex element.
public phpdocDescription ( ) : string | null
리턴 string | null

phpdocSummary() 공개 메소드

A short piece of text, usually one line, providing the basic function of the associated element.
public phpdocSummary ( ) : string | null
리턴 string | null

with() 공개 메소드

Return the context containing the specified property.
public with ( string $property ) : boolean | Context
$property string
리턴 boolean | Context