mediatekformation

PropertyNormalizer extends AbstractObjectNormalizer
in package

Application

Converts between objects and arrays by mapping properties.

The normalization process looks for all the object's properties (public and private). The result is a map from property names 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 property with the corresponding name exists. If found, the property gets the value.

ALLOW_EXTRA_ATTRIBUTES

If ATTRIBUTES are specified, and the source has fields that are not part of that list, either ignore those attributes (true) or throw an ExtraAttributesException (false).


    public
        mixed
    ALLOW_EXTRA_ATTRIBUTES
    = 'allow_extra_attributes'

ATTRIBUTES

Limit (de)normalize to the specified names.


    public
        mixed
    ATTRIBUTES
    = 'attributes'

For nested structures, this list needs to reflect the object tree.

CALLBACKS

Hashmap of field name => callable to normalize this field.


    public
        mixed
    CALLBACKS
    = 'callbacks'

The callable is called if the field is encountered with the arguments:

mixed $attributeValue value of this field
object $object the whole object being normalized
string $attributeName name of the attribute being normalized
string $format the requested format
array $context the serialization context

CIRCULAR_REFERENCE_HANDLER

Handler to call when a circular reference has been detected.


    public
        mixed
    CIRCULAR_REFERENCE_HANDLER
    = 'circular_reference_handler'

If you specify no handler, a CircularReferenceException is thrown.

The method will be called with ($object, $format, $context) and its return value is returned as the result of the normalize call.

CIRCULAR_REFERENCE_LIMIT

How many loops of circular reference to allow while normalizing.


    public
        mixed
    CIRCULAR_REFERENCE_LIMIT
    = 'circular_reference_limit'

The default value of 1 means that when we encounter the same object a second time, we consider that a circular reference.

You can raise this value for special cases, e.g. in combination with the max depth setting of the object normalizer.

DEEP_OBJECT_TO_POPULATE

Flag to tell the denormalizer to also populate existing objects on attributes of the main object.


    public
        mixed
    DEEP_OBJECT_TO_POPULATE
    = 'deep_object_to_populate'

Setting this to true is only useful if you also specify the root object in OBJECT_TO_POPULATE.

DEFAULT_CONSTRUCTOR_ARGUMENTS

Hashmap of default values for constructor arguments.


    public
        mixed
    DEFAULT_CONSTRUCTOR_ARGUMENTS
    = 'default_constructor_arguments'

The names need to match the parameter names in the constructor arguments.

DEPTH_KEY_PATTERN

How to track the current depth in the context.


    public
        mixed
    DEPTH_KEY_PATTERN
    = 'depth_%s::%s'

DISABLE_TYPE_ENFORCEMENT

While denormalizing, we can verify that types match.


    public
        mixed
    DISABLE_TYPE_ENFORCEMENT
    = 'disable_type_enforcement'

You can disable this by setting this flag to true.

ENABLE_MAX_DEPTH

Set to true to respect the max depth metadata on fields.


    public
        mixed
    ENABLE_MAX_DEPTH
    = 'enable_max_depth'

EXCLUDE_FROM_CACHE_KEY

Specify which context key are not relevant to determine which attributes of an object to (de)normalize.


    public
        mixed
    EXCLUDE_FROM_CACHE_KEY
    = 'exclude_from_cache_key'

GROUPS

Only (de)normalize attributes that are in the specified groups.


    public
        mixed
    GROUPS
    = 'groups'

IGNORED_ATTRIBUTES

Skip the specified attributes when normalizing an object tree.


    public
        mixed
    IGNORED_ATTRIBUTES
    = 'ignored_attributes'

This list is applied to each element of nested structures.

Note: The behaviour for nested structures is different from ATTRIBUTES for historical reason. Aligning the behaviour would be a BC break.

MAX_DEPTH_HANDLER

Callback to allow to set a value for an attribute when the max depth has been reached.


    public
        mixed
    MAX_DEPTH_HANDLER
    = 'max_depth_handler'

If no callback is given, the attribute is skipped. If a callable is given, its return value is used (even if null).

The arguments are:

mixed $attributeValue value of this field
object $object the whole object being normalized
string $attributeName name of the attribute being normalized
string $format the requested format
array $context the serialization context

OBJECT_TO_POPULATE

Instead of creating a new instance of an object, update the specified object.


    public
        mixed
    OBJECT_TO_POPULATE
    = 'object_to_populate'

If you have a nested structure, child objects will be overwritten with new instances unless you set DEEP_OBJECT_TO_POPULATE to true.

PRESERVE_EMPTY_OBJECTS


    public
        mixed
    PRESERVE_EMPTY_OBJECTS
    = 'preserve_empty_objects'

SKIP_NULL_VALUES

Flag to control whether fields with the value `null` should be output when normalizing or omitted.


    public
        mixed
    SKIP_NULL_VALUES
    = 'skip_null_values'

$callbacks


    protected
        mixed
    $callbacks
     = []

$camelizedAttributes


    protected
        mixed
    $camelizedAttributes
     = []

$circularReferenceHandler


    protected
        callable|null
    $circularReferenceHandler

$circularReferenceLimit


    protected
        mixed
    $circularReferenceLimit
     = 1

$classDiscriminatorResolver


    protected
        ClassDiscriminatorResolverInterface|null
    $classDiscriminatorResolver

$classMetadataFactory


    protected
        ClassMetadataFactoryInterface|null
    $classMetadataFactory

$defaultContext


    protected
        mixed
    $defaultContext
     = [self::ALLOW_EXTRA_ATTRIBUTES => true, self::CIRCULAR_REFERENCE_LIMIT => 1, self::IGNORED_ATTRIBUTES => []]

$ignoredAttributes


    protected
        mixed
    $ignoredAttributes
     = []

$nameConverter


    protected
        NameConverterInterface|null
    $nameConverter

$serializer


    protected
        SerializerInterface
    $serializer

$attributesCache


    private
        mixed
    $attributesCache
     = []

$maxDepthHandler


    private
        callable|null
    $maxDepthHandler

$objectClassResolver


    private
        mixed
    $objectClassResolver

$propertyTypeExtractor


    private
        mixed
    $propertyTypeExtractor

$typesCache


    private
        mixed
    $typesCache
     = []

__construct()

Sets the {@link ClassMetadataFactoryInterface} to use.


    public
                __construct([ClassMetadataFactoryInterface $classMetadataFactory = null ][, NameConverterInterface $nameConverter = null ][, array<string|int, mixed> $defaultContext = [] ]) : mixed

Parameters

$classMetadataFactory : ClassMetadataFactoryInterface = null
$nameConverter : NameConverterInterface = null
$defaultContext : array<string|int, mixed> = []

Return values

mixed —

denormalize()

{@inheritdoc}


    public
                denormalize(mixed $data, mixed $type[, mixed $format = null ][, array<string|int, mixed> $context = [] ]) : mixed

Parameters

$data : mixed
$type : mixed
$format : mixed = null
$context : array<string|int, mixed> = []

Return values

mixed —

hasCacheableSupportsMethod()

{@inheritdoc}


    public
                hasCacheableSupportsMethod() : bool

Return values

bool —

normalize()

{@inheritdoc}


    public
                normalize(mixed $object[, mixed $format = null ][, array<string|int, mixed> $context = [] ]) : mixed

Parameters

$object : mixed
$format : mixed = null
$context : array<string|int, mixed> = []

Return values

mixed —

setCallbacks()

Sets normalization callbacks.


    public
                setCallbacks(array<string|int, callable> $callbacks) : self

Parameters

$callbacks : array<string|int, callable>: Help normalize the result

Return values

self —

setCircularReferenceHandler()

Sets circular reference handler.


    public
                setCircularReferenceHandler(callable $circularReferenceHandler) : self

Parameters

$circularReferenceHandler : callable

Return values

self —

setCircularReferenceLimit()

Sets circular reference limit.


    public
                setCircularReferenceLimit(int $circularReferenceLimit) : self

Parameters

$circularReferenceLimit : int: Limit of iterations for the same object

Return values

self —

setIgnoredAttributes()

Sets ignored attributes for normalization and denormalization.


    public
                setIgnoredAttributes(array<string|int, mixed> $ignoredAttributes) : self

Parameters

$ignoredAttributes : array<string|int, mixed>

Return values

self —

setMaxDepthHandler()

Sets a handler function that will be called when the max depth is reached.


    public
                setMaxDepthHandler(callable|null $handler) : void

Parameters

$handler : callable|null

Return values

void —

setSerializer()


    public
                setSerializer(SerializerInterface $serializer) : mixed

Parameters

$serializer : SerializerInterface

Return values

mixed —

supportsDenormalization()

{@inheritdoc}


    public
                supportsDenormalization(mixed $data, mixed $type[, mixed $format = null ]) : mixed

Parameters

$data : mixed
$type : mixed
$format : mixed = null

Return values

mixed —

supportsNormalization()

{@inheritdoc}


    public
                supportsNormalization(mixed $data[, mixed $format = null ]) : mixed

Parameters

$data : mixed
$format : mixed = null

Return values

mixed —

extractAttributes()

Extracts attributes to normalize from the class of the given object, format and context.


    protected
                extractAttributes(mixed $object[, mixed $format = null ][, array<string|int, mixed> $context = [] ]) : array<string|int, string>

Parameters

$object : mixed
$format : mixed = null
$context : array<string|int, mixed> = []

Return values

array<string|int, string> —

extractObjectToPopulate()

Extract the `object_to_populate` field from the context if it exists and is an instance of the provided $class.


    protected
                extractObjectToPopulate(string $class, array<string|int, mixed> $context[, string|null $key = null ]) : object|null

Parameters

$class : string: The class the object should be
$context : array<string|int, mixed>
$key : string|null = null: They in which to look for the object to populate. Keeps backwards compatibility with AbstractNormalizer.

Return values

object|null —

an object if things check out, null otherwise

getAllowedAttributes()

Gets attributes to normalize using groups.


    protected
                getAllowedAttributes(string|object $classOrObject, array<string|int, mixed> $context[, bool $attributesAsString = false ]) : array<string|int, string>|array<string|int, AttributeMetadataInterface>|bool

Parameters

$classOrObject : string|object
$context : array<string|int, mixed>
$attributesAsString : bool = false: If false, return an array of

Return values

array<string|int, string>|array<string|int, AttributeMetadataInterface>|bool —

getAttributes()

Gets and caches attributes for the given object, format and context.


    protected
                getAttributes(object $object, string|null $format, array<string|int, mixed> $context) : array<string|int, string>

Parameters

$object : object
$format : string|null
$context : array<string|int, mixed>

Return values

array<string|int, string> —

getAttributeValue()

Gets the attribute value.


    protected
                getAttributeValue(mixed $object, mixed $attribute[, mixed $format = null ][, array<string|int, mixed> $context = [] ]) : mixed

Parameters

$object : mixed
$attribute : mixed
$format : mixed = null
$context : array<string|int, mixed> = []

Return values

mixed —

getConstructor()

Returns the method to use to construct an object. This method must be either the object constructor or static.


    protected
                getConstructor(array<string|int, mixed> &$data, string $class, array<string|int, mixed> &$context, ReflectionClass $reflectionClass, array<string|int, mixed>|bool $allowedAttributes) : ReflectionMethod|null

Parameters

$data : array<string|int, mixed>
$class : string
$context : array<string|int, mixed>
$reflectionClass : ReflectionClass
$allowedAttributes : array<string|int, mixed>|bool

Return values

ReflectionMethod|null —

handleCircularReference()

Handles a circular reference.


    protected
                handleCircularReference(object $object) : mixed

If a circular reference handler is set, it will be called. Otherwise, a CircularReferenceException will be thrown.

Parameters

$object : object

Return values

mixed —

instantiateObject()

Instantiates an object using constructor parameters when needed.


    protected
                instantiateObject(array<string|int, mixed> &$data, string $class, array<string|int, mixed> &$context, ReflectionClass $reflectionClass, array<string|int, mixed>|bool $allowedAttributes[, string $format = null ]) : object

This method also allows to denormalize data into an existing object if it is present in the context with the object_to_populate. This object is removed from the context before being returned to avoid side effects when recursively normalizing an object graph.

Parameters

$data : array<string|int, mixed>
$class : string
$context : array<string|int, mixed>
$reflectionClass : ReflectionClass
$allowedAttributes : array<string|int, mixed>|bool
$format : string = null

Return values

object —

isAllowedAttribute()

{@inheritdoc}


    protected
                isAllowedAttribute(mixed $classOrObject, mixed $attribute[, mixed $format = null ][, array<string|int, mixed> $context = [] ]) : mixed

Parameters

$classOrObject : mixed
$attribute : mixed
$format : mixed = null
$context : array<string|int, mixed> = []

Return values

mixed —

isCircularReference()

Detects if the configured circular reference limit is reached.


    protected
                isCircularReference(object $object, array<string|int, mixed> &$context) : bool

Parameters

$object : object
$context : array<string|int, mixed>

Return values

bool —

prepareForDenormalization()

Normalizes the given data to an array. It's particularly useful during the denormalization process.


    protected
                prepareForDenormalization(object|array<string|int, mixed> $data) : array<string|int, mixed>

Parameters

$data : object|array<string|int, mixed>

Return values

array<string|int, mixed> —

setAttributeValue()

Sets attribute value.


    protected
                setAttributeValue(mixed $object, mixed $attribute, mixed $value[, mixed $format = null ][, array<string|int, mixed> $context = [] ]) : mixed

Parameters

$object : mixed
$attribute : mixed
$value : mixed
$format : mixed = null
$context : array<string|int, mixed> = []

Return values

mixed —

getCacheKey()

Builds the cache key for the attributes cache.


    private
                getCacheKey(string|null $format, array<string|int, mixed> $context) : bool|string

The key must be different for every option in the context that could change which attributes should be handled.

Parameters

$format : string|null
$context : array<string|int, mixed>

Return values

bool|string —

getReflectionProperty()


    private
                getReflectionProperty(string|object $classOrObject, string $attribute) : ReflectionProperty

Parameters

$classOrObject : string|object
$attribute : string

Return values

ReflectionProperty —

getTypes()


    private
                getTypes(string $currentClass, string $attribute) : array<string|int, Type>|null

Parameters

$currentClass : string
$attribute : string

Return values

array<string|int, Type>|null —

isMaxDepthReached()

Is the max depth reached for the given attribute?


    private
                isMaxDepthReached(array<string|int, AttributeMetadataInterface> $attributesMetadata, string $class, string $attribute, array<string|int, mixed> &$context) : bool

Parameters

$attributesMetadata : array<string|int, AttributeMetadataInterface>
$class : string
$attribute : string
$context : array<string|int, mixed>

Return values

bool —

supports()

Checks if the given class has any non-static property.


    private
                supports(string $class) : bool

Parameters

$class : string

Return values

bool —

updateData()

Sets an attribute and apply the name converter if necessary.


    private
                updateData(array<string|int, mixed> $data, string $attribute, mixed $attributeValue, string $class, string|null $format, array<string|int, mixed> $context) : array<string|int, mixed>

Parameters

$data : array<string|int, mixed>
$attribute : string
$attributeValue : mixed
$class : string
$format : string|null
$context : array<string|int, mixed>

Return values

array<string|int, mixed> —

validateAndDenormalize()

Validates the submitted data and denormalizes it.


    private
                validateAndDenormalize(string $currentClass, string $attribute, mixed $data, string|null $format, array<string|int, mixed> $context) : mixed

Parameters

$currentClass : string
$attribute : string
$data : mixed
$format : string|null
$context : array<string|int, mixed>

Return values

mixed —

PropertyNormalizer extends AbstractObjectNormalizer in package Application

Tags

Table of Contents

Constants

ALLOW_EXTRA_ATTRIBUTES

ATTRIBUTES

CALLBACKS

CIRCULAR_REFERENCE_HANDLER

CIRCULAR_REFERENCE_LIMIT

DEEP_OBJECT_TO_POPULATE

DEFAULT_CONSTRUCTOR_ARGUMENTS

DEPTH_KEY_PATTERN

DISABLE_TYPE_ENFORCEMENT

ENABLE_MAX_DEPTH

EXCLUDE_FROM_CACHE_KEY

GROUPS

IGNORED_ATTRIBUTES

MAX_DEPTH_HANDLER

OBJECT_TO_POPULATE

PRESERVE_EMPTY_OBJECTS

SKIP_NULL_VALUES

Properties

$callbacks

Tags

$camelizedAttributes

Tags

$circularReferenceHandler

Tags

$circularReferenceLimit

Tags

$classDiscriminatorResolver

$classMetadataFactory

$defaultContext

$ignoredAttributes

Tags

$nameConverter

$serializer

$attributesCache

$maxDepthHandler

Tags

$objectClassResolver

$propertyTypeExtractor

$typesCache

Methods

__construct()

Parameters

Return values

denormalize()

Parameters

Return values

hasCacheableSupportsMethod()

Return values

normalize()

Parameters

Return values

setCallbacks()

Parameters

Tags

Return values

setCircularReferenceHandler()

Parameters

Tags

Return values

setCircularReferenceLimit()

Parameters

Tags

Return values

setIgnoredAttributes()

Parameters

Tags

Return values

setMaxDepthHandler()

Parameters

Tags

Return values

setSerializer()

Parameters

Return values

supportsDenormalization()

Parameters

PropertyNormalizer extends AbstractObjectNormalizer
in package

Application