DataUriNormalizer
in package
implements
NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
Normalizes an {@see \SplFileInfo} object to a data URI.
Denormalizes a data URI to a SplFileObject object.
Tags
Table of Contents
Interfaces
- NormalizerInterface
- DenormalizerInterface
- CacheableSupportsMethodInterface
- Marker interface for normalizers and denormalizers that use only the type and the format in their supports*() methods.
Constants
- SUPPORTED_TYPES = [\SplFileInfo::class => true, \SplFileObject::class => true, \Symfony\Component\HttpFoundation\File\File::class => true]
Properties
Methods
- __construct() : mixed
- denormalize() : mixed
- Denormalizes data back into an object of the given class.
- hasCacheableSupportsMethod() : bool
- normalize() : array<string|int, mixed>|string|int|float|bool|ArrayObject|null
- Normalizes an object into a set of arrays/scalars.
- supportsDenormalization() : bool
- Checks whether the given class is supported for denormalization by this normalizer.
- supportsNormalization() : bool
- Checks whether the given class is supported for normalization by this normalizer.
- extractSplFileObject() : SplFileObject
- Returns the \SplFileObject instance associated with the given \SplFileInfo instance.
- getMimeType() : string
- Gets the mime type of the object. Defaults to application/octet-stream.
Constants
SUPPORTED_TYPES
private
mixed
SUPPORTED_TYPES
= [\SplFileInfo::class => true, \SplFileObject::class => true, \Symfony\Component\HttpFoundation\File\File::class => true]
Properties
$mimeTypeGuesser
private
MimeTypeGuesserInterface|null
$mimeTypeGuesser
Methods
__construct()
public
__construct([MimeTypeGuesserInterface $mimeTypeGuesser = null ]) : mixed
Parameters
- $mimeTypeGuesser : MimeTypeGuesserInterface = null
denormalize()
Denormalizes data back into an object of the given class.
public
denormalize(mixed $data, string $type[, string $format = null ][, array<string|int, mixed> $context = [] ]) : mixed
Regex adapted from Brian Grinstead code.
Parameters
- $data : mixed
-
Data to restore
- $type : string
-
The expected class to instantiate
- $format : string = null
-
Format the given data was extracted from
- $context : array<string|int, mixed> = []
-
Options available to the denormalizer
Tags
hasCacheableSupportsMethod()
public
hasCacheableSupportsMethod() : bool
Return values
boolnormalize()
Normalizes an object into a set of arrays/scalars.
public
normalize(mixed $object[, string $format = null ][, array<string|int, mixed> $context = [] ]) : array<string|int, mixed>|string|int|float|bool|ArrayObject|null
Parameters
- $object : mixed
-
Object to normalize
- $format : string = null
-
Format the normalization result will be encoded as
- $context : array<string|int, mixed> = []
-
Context options for the normalizer
Return values
array<string|int, mixed>|string|int|float|bool|ArrayObject|null —\ArrayObject is used to make sure an empty object is encoded as an object not an array
supportsDenormalization()
Checks whether the given class is supported for denormalization by this normalizer.
public
supportsDenormalization(mixed $data, string $type[, string $format = null ]) : bool
Parameters
- $data : mixed
-
Data to denormalize from
- $type : string
-
The class to which the data should be denormalized
- $format : string = null
-
The format being deserialized from
Return values
boolsupportsNormalization()
Checks whether the given class is supported for normalization by this normalizer.
public
supportsNormalization(mixed $data[, string $format = null ]) : bool
Parameters
- $data : mixed
-
Data to normalize
- $format : string = null
-
The format being (de-)serialized from or into
Return values
boolextractSplFileObject()
Returns the \SplFileObject instance associated with the given \SplFileInfo instance.
private
extractSplFileObject(SplFileInfo $object) : SplFileObject
Parameters
- $object : SplFileInfo
Return values
SplFileObjectgetMimeType()
Gets the mime type of the object. Defaults to application/octet-stream.
private
getMimeType(SplFileInfo $object) : string
Parameters
- $object : SplFileInfo