Serializer
in package
Allows to serialize/de-serialize annotations from/to JSON.
Tags
Table of Contents
- $VALID_ANNOTATIONS : mixed
- deserialize() : AbstractAnnotation
- Deserialize a string.
- deserializeFile() : AbstractAnnotation
- Deserialize a file.
- isValidAnnotationClass() : mixed
- serialize() : string
- Serialize.
- doDeserialize() : AbstractAnnotation
- Do deserialization.
- doDeserializeBaseProperty() : array<string|int, mixed>|AbstractAnnotation
- Deserialize base annotation property.
- doDeserializeProperty() : mixed
- Deserialize the annotation's property.
Properties
$VALID_ANNOTATIONS
private
static mixed
$VALID_ANNOTATIONS
= [\OpenApi\Annotations\AdditionalProperties::class, \OpenApi\Annotations\Attachable::class, \OpenApi\Annotations\Components::class, \OpenApi\Annotations\Contact::class, \OpenApi\Annotations\Delete::class, \OpenApi\Annotations\Discriminator::class, \OpenApi\Annotations\Examples::class, \OpenApi\Annotations\ExternalDocumentation::class, \OpenApi\Annotations\Flow::class, \OpenApi\Annotations\Get::class, \OpenApi\Annotations\Head::class, \OpenApi\Annotations\Header::class, \OpenApi\Annotations\Info::class, \OpenApi\Annotations\Items::class, \OpenApi\Annotations\JsonContent::class, \OpenApi\Annotations\License::class, \OpenApi\Annotations\Link::class, \OpenApi\Annotations\MediaType::class, \OpenApi\Annotations\OpenApi::class, \OpenApi\Annotations\Operation::class, \OpenApi\Annotations\Options::class, \OpenApi\Annotations\Parameter::class, \OpenApi\Annotations\Patch::class, \OpenApi\Annotations\PathItem::class, \OpenApi\Annotations\Post::class, \OpenApi\Annotations\Property::class, \OpenApi\Annotations\Put::class, \OpenApi\Annotations\RequestBody::class, \OpenApi\Annotations\Response::class, \OpenApi\Annotations\Schema::class, \OpenApi\Annotations\SecurityScheme::class, \OpenApi\Annotations\Server::class, \OpenApi\Annotations\ServerVariable::class, \OpenApi\Annotations\Tag::class, \OpenApi\Annotations\Trace::class, \OpenApi\Annotations\Xml::class, \OpenApi\Annotations\XmlContent::class]
Methods
deserialize()
Deserialize a string.
public
deserialize(string $jsonString, string $className) : AbstractAnnotation
Parameters
- $jsonString : string
- $className : string
Return values
AbstractAnnotation —deserializeFile()
Deserialize a file.
public
deserializeFile(string $filename[, string $className = OAOpenApi::class ]) : AbstractAnnotation
Parameters
- $filename : string
- $className : string = OAOpenApi::class
Return values
AbstractAnnotation —isValidAnnotationClass()
public
static isValidAnnotationClass(mixed $className) : mixed
Parameters
- $className : mixed
Return values
mixed —serialize()
Serialize.
public
serialize(AbstractAnnotation $annotation) : string
Parameters
- $annotation : AbstractAnnotation
Return values
string —doDeserialize()
Do deserialization.
protected
doDeserialize(stdClass $c, string $class) : AbstractAnnotation
Parameters
- $c : stdClass
- $class : string
Return values
AbstractAnnotation —doDeserializeBaseProperty()
Deserialize base annotation property.
protected
doDeserializeBaseProperty(array<string|int, mixed>|string $type, mixed $value) : array<string|int, mixed>|AbstractAnnotation
Parameters
- $type : array<string|int, mixed>|string
-
The property type
- $value : mixed
-
The value to deserialization
Return values
array<string|int, mixed>|AbstractAnnotation —doDeserializeProperty()
Deserialize the annotation's property.
protected
doDeserializeProperty(AbstractAnnotation $annotation, string $property, mixed $value) : mixed
Parameters
- $annotation : AbstractAnnotation
- $property : string
- $value : mixed