The normalization which is under the object control.
- All private object properties should be ready for normalization. the normalization process is easy to customize by
adding or changing the sequence of the normalizers in the
NormalizationFacade
- To allow the normalization customization Object has to implement the next interfaces:
NormalizableInterface
NormalizationFacadeInterface
The basic interface. Could be used separately to build fully manual normalization. How:
- any objet implements
NormalizableInterface
- It is called object::normalize in
NormalizableInterface::normalize
for all required to be present in normalized view objects
If it is needed to have all normalization happen automatically then NormalizableTrait
has to be used
with NormalizableInterface
. In that case all objects should be supported by the DefaultNormalizationFacade
Will normalize all private object properties by the next rules:
AsIsKeyDecorator
the property name will become the array key without any decorations- all properties will be processed by predefined normalizers:
NotObjectNormalizer
will return not objects as isListNormalizableToNormalizableAdapterNormalizer
will process the array of normalizable objects- all keys will be left as is
AsIsKeyDecorator
- all values will be processed in according to the current rules by
DefaultNormalizationFacade
- all keys will be left as is
NormalizableNormalizer
will callNormalizableInterface::normalize
WithTypeNormalizableNormalizerDecorator
is decorates theNormalizableNormalizer
to add@type
field with ShortClassName of normalized objectScalarableNormalizer
will get the scalar value in object implementsScalarableInterface
StringableNormalizer
will get the scalar value in object implementsStringableInterface
- and the last one is
FailNormalizer
which wil throw an exception if no Normalizer was found
Should be implenented by all Normalizable objects to support the normalization customization. The normalization should
be initiated by the custom NormalizationFacade
implementation and it will be set to all Normalizable objects
recursively