ProblemNormalizer
in package
implements
NormalizerInterface, CacheableSupportsMethodInterface
Normalizes errors according to the API Problem spec (RFC 7807).
Tags
Table of Contents
Interfaces
- NormalizerInterface
- CacheableSupportsMethodInterface
- Marker interface for normalizers and denormalizers that use only the type and the format in their supports*() methods.
Properties
- $debug : mixed
- $defaultContext : mixed
Methods
- __construct() : mixed
- hasCacheableSupportsMethod() : bool
- normalize() : array<string|int, mixed>|string|int|float|bool|ArrayObject|null
- Normalizes an object into a set of arrays/scalars.
- supportsNormalization() : bool
- Checks whether the given class is supported for normalization by this normalizer.
Properties
$debug
private
mixed
$debug
$defaultContext
private
mixed
$defaultContext
= ['type' => 'https://tools.ietf.org/html/rfc2616#section-10', 'title' => 'An error occurred']
Methods
__construct()
public
__construct([bool $debug = false ][, array<string|int, mixed> $defaultContext = [] ]) : mixed
Parameters
- $debug : bool = false
- $defaultContext : array<string|int, mixed> = []
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
supportsNormalization()
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