57 lines
1.3 KiB
YAML
57 lines
1.3 KiB
YAML
|
name: NormalizableInterface
|
||
|
|
class_comment: null
|
||
|
|
dependencies: []
|
||
|
|
properties: []
|
||
|
|
methods:
|
||
|
|
- name: normalize
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: normalizer
|
||
|
|
- name: format
|
||
|
|
default: 'null'
|
||
|
|
- name: context
|
||
|
|
default: '[]'
|
||
|
|
comment: '# * Defines the most basic interface a class must implement to be normalizable.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * If a normalizer is registered for the class and it doesn''t implement
|
||
|
|
|
||
|
|
# * the Normalizable interfaces, the normalizer will be used instead.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @author Jordi Boggiano <j.boggiano@seld.be>
|
||
|
|
|
||
|
|
# */
|
||
|
|
|
||
|
|
# interface NormalizableInterface
|
||
|
|
|
||
|
|
# {
|
||
|
|
|
||
|
|
# /**
|
||
|
|
|
||
|
|
# * Normalizes the object into an array of scalars|arrays.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * It is important to understand that the normalize() call should normalize
|
||
|
|
|
||
|
|
# * recursively all child objects of the implementor.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param NormalizerInterface $normalizer The normalizer is given so that you
|
||
|
|
|
||
|
|
# * can use it to normalize objects contained
|
||
|
|
within this object
|
||
|
|
|
||
|
|
# * @param string|null $format The format is optionally given to be
|
||
|
|
able to normalize differently
|
||
|
|
|
||
|
|
# * based on different output formats
|
||
|
|
|
||
|
|
# * @param array $context Options for normalizing this object'
|
||
|
|
traits: []
|
||
|
|
interfaces: []
|