Docs4dev
Docs
symfony / 3.3 / symfony / component / serializer / normalizer / customnormalizer.html

CustomNormalizer

class CustomNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface

Traits

SerializerAwareTrait SerializerAware trait.

Methods

setSerializer(SerializerInterface $serializer)

Sets the serializer.

 from SerializerAwareTrait
array|scalar normalize(object $object, string $format = null, array $context = array())

Normalizes an object into a set of arrays/scalars.
object denormalize(mixed $data, string $class, string $format = null, array $context = array())

Denormalizes data back into an object of the given class.
bool supportsNormalization(mixed $data, string $format = null)

Checks if the given class implements the NormalizableInterface.
bool supportsDenormalization(mixed $data, string $type, string $format = null)

Checks if the given class implements the DenormalizableInterface.

Details

setSerializer(SerializerInterface $serializer)

Sets the serializer.

Parameters

SerializerInterface $serializer A SerializerInterface instance

array|scalar normalize(object $object, string $format = null, array $context = array())

Normalizes an object into a set of arrays/scalars.

Parameters

object $object Object to normalize
string $format Format the normalization result will be encoded as
array $context Context options for the normalizer

Return Value

array|scalar

Exceptions

InvalidArgumentException Occurs when the object given is not an attempted type for the normalizer
CircularReferenceException Occurs when the normalizer detects a circular reference when no circular reference handler can fix it
LogicException Occurs when the normalizer is not called in an expected context

object denormalize(mixed $data, string $class, string $format = null, array $context = array())

Denormalizes data back into an object of the given class.

Parameters

mixed $data Data to restore
string $class The expected class to instantiate
string $format Format the given data was extracted from
array $context Options available to the denormalizer

Return Value

object

Exceptions

BadMethodCallException Occurs when the normalizer is not called in an expected context
InvalidArgumentException Occurs when the arguments are not coherent or not supported
UnexpectedValueException Occurs when the item cannot be hydrated with the given data
ExtraAttributesException Occurs when the item doesn't have attribute to receive given data
LogicException Occurs when the normalizer is not supposed to denormalize
RuntimeException Occurs if the class cannot be instantiated

bool supportsNormalization(mixed $data, string $format = null)

Checks if the given class implements the NormalizableInterface.

Parameters

mixed $data Data to normalize
string $format The format being (de-)serialized from or into

Return Value

bool

bool supportsDenormalization(mixed $data, string $type, string $format = null)

Checks if the given class implements the DenormalizableInterface.

Parameters

mixed $data Data to denormalize from
string $type The class to which the data should be denormalized
string $format The format being deserialized from

Return Value

bool

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/Serializer/Normalizer/CustomNormalizer.html