Symfony2 API
Class

Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer

class GetSetMethodNormalizer extends SerializerAwareNormalizer implements NormalizerInterface, DenormalizerInterface

Converts between objects with getter and setter methods and arrays.

The normalization process looks at all public methods and calls the ones
which have a name starting with get and take no parameters. The result is a
map from property names (method name stripped of the get prefix and converted
to lower case) to property values. Property values are normalized through the
serializer.

The denormalization first looks at the constructor of the given class to see
if any of the parameters have the same name as one of the properties. The
constructor is then called with all parameters or an exception is thrown if
any required parameters were not present as properties. Then the denormalizer
walks through the given map of property names to property values to see if a
setter method exists for any of the properties. If a setter exists it is
called with the property value. No automatic denormalization of the value
takes place.

Methods

setSerializer(SerializerInterface $serializer)

Sets the owning Serializer object

 from SerializerAwareNormalizer
setCallbacks(array $callbacks)

Set normalization callbacks
setIgnoredAttributes(array $ignoredAttributes)

Set ignored attributes for normalization
setCamelizedAttributes(array $camelizedAttributes)

Set attributes to be camelized on denormalize
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
Boolean supportsNormalization(mixed $data, string $format = null)

Checks whether the given class is supported for normalization by this normalizer
Boolean supportsDenormalization(mixed $data, string $type, string $format = null)

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

Details

in SerializerAwareNormalizer at line 32
public setSerializer(SerializerInterface $serializer)

Sets the owning Serializer object

Parameters

SerializerInterface $serializer

at line 50
public setCallbacks(array $callbacks)

Set normalization callbacks

Parameters

array $callbacks help normalize the result

Exceptions

InvalidArgumentException if a non-callable callback is set

at line 65
public setIgnoredAttributes(array $ignoredAttributes)

Set ignored attributes for normalization

Parameters

array $ignoredAttributes

at line 75
public setCamelizedAttributes(array $camelizedAttributes)

Set attributes to be camelized on denormalize

Parameters

array $camelizedAttributes

at line 83
public 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

at line 115
public 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

at line 180
public Boolean 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

Boolean

at line 188
public Boolean 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

Boolean