• 홈
• Swagger
• Annotations
• AbstractAnnotation

PHP 클래스 Swagger\Annotations\AbstractAnnotation

파일 보기 프로젝트 열기: zircote/swagger-php 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$_blacklist	array	List of properties are blacklisted from the JSON output.
$_context	Swagger\Context
$_nested	array	Examples: 'Swagger\Annotation\Info' => 'info', // Set @SWG\Info annotation as the info property. 'Swagger\Annotation\Parameter' => ['parameters'], // Append @SWG\Parameter annotations the parameters array. 'Swagger\Annotation\Path' => ['paths', 'path'], // Append @SWG\Path annotations the paths array and use path as key.
$_parents	string[]	Reverse mapping of $_nested with the allowed parent annotations.
$_required	array	The properties which are required by the spec
$_types	array	Examples: 'name' => 'string' // a string 'required' => 'boolean', // true or false 'tags' => '[string]', // array containing strings 'in' => ["query", "header", "path", "formData", "body"] // must be one on these
$_unmerged	array	Annotations that couldn't be merged by mapping or postprocessing.
$x	array	The keys inside the array will be prefixed with x-. For further details see https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#vendorExtensions.

공개 메소드들

메소드	설명
__construct ( array $properties )
__debugInfo ( )
__get ( $property )
__set ( $property, $value )
__toString ( )
identity ( ) : string	Return a identity for easy debugging.
jsonSerialize ( ) : array	Customize the way json_encode() renders the annotations.
merge ( AbstractAnnotation[] $annotations, boolean $ignore = false ) : AbstractAnnotation[]	Merge given annotations to their mapped properties configured in static::$_nested.
mergeProperties ( object $object )	Merge the properties from the given object into this annotation.
validate ( array $parents = [], array $skip = [] ) : boolean	Validate annotation tree, and log notices & warnings.

보호된 메소드들

메소드	설명
_identity ( array $properties ) : string	Helper for generating the identity()

비공개 메소드들

메소드	설명
_validate ( array | object $fields, array $path, $skip ) : boolean	Recursively validate all annotation properties.
nested ( AbstractAnnotation $annotation, Context $nestedContext ) : AbstractAnnotation	Wrap the context with a reference to the annotation it is nested in.
validateType ( $type, $value )

메소드 상세

프로퍼티 상세