ProblemNormalizer
in package
implements
NormalizerInterface, CacheableSupportsMethodInterface
Normalizes errors according to the API Problem spec (RFC 7807).
Tags
Interfaces, Classes, Traits and Enums
- NormalizerInterface
- CacheableSupportsMethodInterface
- Marker interface for normalizers and denormalizers that use only the type and the format in their supports*() methods.
Table of Contents
- $debug : mixed
- $defaultContext : mixed
- __construct() : mixed
- hasCacheableSupportsMethod() : bool
- normalize() : array<string|int, mixed>
- 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> = []
Return values
mixed —hasCacheableSupportsMethod()
public
hasCacheableSupportsMethod() : bool
Return values
bool —normalize()
Normalizes an object into a set of arrays/scalars.
public
normalize(mixed $object[, mixed $format = null ][, array<string|int, mixed> $context = [] ]) : array<string|int, mixed>
Parameters
- $object : mixed
-
Object to normalize
- $format : mixed = 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> —supportsNormalization()
Checks whether the given class is supported for normalization by this normalizer.
public
supportsNormalization(mixed $data[, mixed $format = null ]) : bool
Parameters
- $data : mixed
-
Data to normalize
- $format : mixed = null
-
The format being (de-)serialized from or into