AbstractObjectNormalizer

class AbstractObjectNormalizer extends AbstractNormalizer

Base class for a normalizer dealing with objects.

Traits

SerializerAware trait.

Constants

CIRCULAR_REFERENCE_LIMIT
OBJECT_TO_POPULATE
GROUPS
ENABLE_MAX_DEPTH
DEPTH_KEY_PATTERN

Methods

	setSerializer(SerializerInterface $serializer) Sets the serializer.	from SerializerAwareTrait
	__construct(ClassMetadataFactoryInterface $classMetadataFactory = null, NameConverterInterface $nameConverter = null, PropertyTypeExtractorInterface $propertyTypeExtractor = null) Sets the {@link ClassMetadataFactoryInterface} to use.
AbstractNormalizer	setCircularReferenceLimit(int $circularReferenceLimit) Set circular reference limit.	from AbstractNormalizer
AbstractNormalizer	setCircularReferenceHandler(callable $circularReferenceHandler) Set circular reference handler.	from AbstractNormalizer
AbstractNormalizer	setCallbacks(array $callbacks) Set normalization callbacks.	from AbstractNormalizer
AbstractNormalizer	setIgnoredAttributes(array $ignoredAttributes) Set ignored attributes for normalization and denormalization.	from AbstractNormalizer
bool	supportsNormalization(mixed $data, string $format = null) Checks whether the given class is supported for normalization by this normalizer.
array\|scalar	normalize(object $object, string $format = null, array $context = array()) Normalizes an object into a set of arrays/scalars.
bool	supportsDenormalization(mixed $data, string $type, string $format = null) Checks whether the given class is supported for denormalization by this normalizer.
object	denormalize(mixed $data, string $class, string $format = null, array $context = array()) Denormalizes data back into an object of the given class.

Details

setSerializer(SerializerInterface $serializer)

Sets the serializer.

Parameters

SerializerInterface

$serializer

A SerializerInterface instance

__construct(ClassMetadataFactoryInterface $classMetadataFactory = null, NameConverterInterface $nameConverter = null, PropertyTypeExtractorInterface $propertyTypeExtractor = null)

Sets the {@link ClassMetadataFactoryInterface} to use.

Parameters

ClassMetadataFactoryInterface	$classMetadataFactory
NameConverterInterface	$nameConverter
PropertyTypeExtractorInterface	$propertyTypeExtractor

AbstractNormalizer setCircularReferenceLimit(int $circularReferenceLimit)

Set circular reference limit.

Parameters

int

$circularReferenceLimit

limit of iterations for the same object

Return Value

AbstractNormalizer

AbstractNormalizer setCircularReferenceHandler(callable $circularReferenceHandler)

Set circular reference handler.

Parameters

callable

$circularReferenceHandler

Return Value

AbstractNormalizer

AbstractNormalizer setCallbacks(array $callbacks)

Set normalization callbacks.

Parameters

array

$callbacks

help normalize the result

Return Value

AbstractNormalizer

Exceptions

InvalidArgumentException

if a non-callable callback is set

AbstractNormalizer setIgnoredAttributes(array $ignoredAttributes)

Set ignored attributes for normalization and denormalization.

Parameters

array

$ignoredAttributes

Return Value

AbstractNormalizer

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

Checks whether the given class is supported for normalization by this normalizer.

Parameters

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

Return Value

bool

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

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

Checks whether the given class is supported for denormalization by this normalizer.

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

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

Links:

http://api.symfony.com/master/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.html

doc_Symfony

2016-10-28 06:04:17

Comments