interface NormalizerInterface
@author Jordi Boggiano <j.boggiano@seld.be>
Hierarchy
- interface \Symfony\Component\Serializer\Normalizer\NormalizerInterface
Expanded class hierarchy of NormalizerInterface
All classes that implement NormalizerInterface
11 files declare their use of NormalizerInterface
- CacheableNormalizerInterface.php in core/
modules/ serialization/ src/ Normalizer/ CacheableNormalizerInterface.php - ChainEntityResolver.php in core/
modules/ serialization/ src/ EntityResolver/ ChainEntityResolver.php - EntityResolverInterface.php in core/
modules/ serialization/ src/ EntityResolver/ EntityResolverInterface.php - JsonApiDocumentTopLevelNormalizer.php in core/
modules/ jsonapi/ src/ Normalizer/ JsonApiDocumentTopLevelNormalizer.php - Serializer.php in vendor/
symfony/ serializer/ Serializer.php
File
-
vendor/
symfony/ serializer/ Normalizer/ NormalizerInterface.php, line 22
Namespace
Symfony\Component\Serializer\NormalizerView source
interface NormalizerInterface {
/**
* Normalizes data into a set of arrays/scalars.
*
* @param mixed $data Data to normalize
* @param string|null $format Format the normalization result will be encoded as
* @param array $context Context options for the normalizer
*
* @return array|string|int|float|bool|\ArrayObject|null \ArrayObject is used to make sure an empty object is encoded as an object not an array
*
* @throws InvalidArgumentException Occurs when the object given is not a supported type for the normalizer
* @throws CircularReferenceException Occurs when the normalizer detects a circular reference when no circular
* reference handler can fix it
* @throws LogicException Occurs when the normalizer is not called in an expected context
* @throws ExceptionInterface Occurs for all the other cases of errors
*/
public function normalize(mixed $data, ?string $format = null, array $context = []) : array|string|int|float|bool|\ArrayObject|null;
/**
* Checks whether the given class is supported for normalization by this normalizer.
*
* @param mixed $data Data to normalize
* @param string|null $format The format being (de-)serialized from or into
*/
public function supportsNormalization(mixed $data, ?string $format = null, array $context = []) : bool;
/**
* Returns the types potentially supported by this normalizer.
*
* For each supported formats (if applicable), the supported types should be
* returned as keys, and each type should be mapped to a boolean indicating
* if the result of supportsNormalization() can be cached or not
* (a result cannot be cached when it depends on the context or on the data.)
* A null value means that the normalizer does not support the corresponding
* type.
*
* Use type "object" to match any classes or interfaces,
* and type "*" to match any types.
*
* @return array<class-string|'*'|'object'|string, bool|null>
*/
public function getSupportedTypes(?string $format) : array;
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
NormalizerInterface::getSupportedTypes | public | function | Returns the types potentially supported by this normalizer. | 20 |
NormalizerInterface::normalize | public | function | Normalizes data into a set of arrays/scalars. | 34 |
NormalizerInterface::supportsNormalization | public | function | Checks whether the given class is supported for normalization by this normalizer. | 18 |