mediatekformation

AbstractObjectNormalizer extends AbstractNormalizer

in package

• Application

Base class for a normalizer dealing with objects.

Tags

author

Kévin Dunglas dunglas@gmail.com

Table of Contents

ALLOW_EXTRA_ATTRIBUTES  = '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).

ATTRIBUTES  = 'attributes'

Limit (de)normalize to the specified names.

CALLBACKS  = 'callbacks'

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

CIRCULAR_REFERENCE_HANDLER  = 'circular_reference_handler'

Handler to call when a circular reference has been detected.

CIRCULAR_REFERENCE_LIMIT  = 'circular_reference_limit'

How many loops of circular reference to allow while normalizing.

DEEP_OBJECT_TO_POPULATE  = 'deep_object_to_populate'

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

DEFAULT_CONSTRUCTOR_ARGUMENTS  = 'default_constructor_arguments'

Hashmap of default values for constructor arguments.

DEPTH_KEY_PATTERN  = 'depth_%s::%s'

How to track the current depth in the context.

DISABLE_TYPE_ENFORCEMENT  = 'disable_type_enforcement'

While denormalizing, we can verify that types match.

ENABLE_MAX_DEPTH  = 'enable_max_depth'

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

EXCLUDE_FROM_CACHE_KEY  = 'exclude_from_cache_key'

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

GROUPS  = 'groups'

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

IGNORED_ATTRIBUTES  = 'ignored_attributes'

Skip the specified attributes when normalizing an object tree.

MAX_DEPTH_HANDLER  = 'max_depth_handler'

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

OBJECT_TO_POPULATE  = 'object_to_populate'

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

PRESERVE_EMPTY_OBJECTS  = 'preserve_empty_objects'

SKIP_NULL_VALUES  = 'skip_null_values'

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

$callbacks  : mixed

$camelizedAttributes  : mixed

$circularReferenceHandler  : callable|null

$circularReferenceLimit  : mixed

$classDiscriminatorResolver  : ClassDiscriminatorResolverInterface|null

$classMetadataFactory  : ClassMetadataFactoryInterface|null

$defaultContext  : mixed

$ignoredAttributes  : mixed

$nameConverter  : NameConverterInterface|null

$serializer  : SerializerInterface

$attributesCache  : mixed

$maxDepthHandler  : callable|null

$objectClassResolver  : mixed

$propertyTypeExtractor  : mixed

$typesCache  : mixed

__construct()  : mixed

Sets the {@link ClassMetadataFactoryInterface} to use.

denormalize()  : mixed

{@inheritdoc}

hasCacheableSupportsMethod()  : bool

normalize()  : mixed

{@inheritdoc}

setCallbacks()  : self

Sets normalization callbacks.

setCircularReferenceHandler()  : self

Sets circular reference handler.

setCircularReferenceLimit()  : self

Sets circular reference limit.

setIgnoredAttributes()  : self

Sets ignored attributes for normalization and denormalization.

setMaxDepthHandler()  : void

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

setSerializer()  : mixed

supportsDenormalization()  : mixed

{@inheritdoc}

supportsNormalization()  : mixed

{@inheritdoc}

extractAttributes()  : array<string|int, string>

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

extractObjectToPopulate()  : object|null

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

getAllowedAttributes()  : array<string|int, string>|array<string|int, AttributeMetadataInterface>|bool

Gets attributes to normalize using groups.

getAttributes()  : array<string|int, string>

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

getAttributeValue()  : mixed

Gets the attribute value.

getConstructor()  : ReflectionMethod|null

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

handleCircularReference()  : mixed

Handles a circular reference.

instantiateObject()  : object

Instantiates an object using constructor parameters when needed.

isAllowedAttribute()  : bool

Is this attribute allowed?

isCircularReference()  : bool

Detects if the configured circular reference limit is reached.

prepareForDenormalization()  : array<string|int, mixed>

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

setAttributeValue()  : mixed

Sets attribute value.

getCacheKey()  : bool|string

Builds the cache key for the attributes cache.

getTypes()  : array<string|int, Type>|null

isMaxDepthReached()  : bool

Is the max depth reached for the given attribute?

updateData()  : array<string|int, mixed>

Sets an attribute and apply the name converter if necessary.

validateAndDenormalize()  : mixed

Validates the submitted data and denormalizes it.