Spec-Zone.ru › Symfony 4.1

CustomNormalizer

class CustomNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, CacheableSupportsMethodInterface

Свойства

ObjectToPopulateTrait
SerializerAwareTrait SerializerAware trait.

Свойства

protected SerializerInterface $serializer from SerializerAwareTrait

Методы

object|null extractObjectToPopulate(string $class, array $context, string $key = null)

Извлечь поле object_to_populate из контекста, если оно существует и является экземпляром указанного $class.

from ObjectToPopulateTrait
setSerializer(SerializerInterface $serializer)

Устанавливает сериализатор.

from SerializerAwareTrait
array|string|int|float|bool normalize(mixed $object, string $format = null, array $context = array())

Нормализует объект в набор массивов/скаляров.

object denormalize(mixed $data, string $class, string $format = null, array $context = array())

Денормализует данные обратно в объект заданного класса.

bool supportsNormalization(mixed $data, string $format = null)

Проверяет, реализует ли данный класс интерфейс NormalizableInterface.

bool supportsDenormalization(mixed $data, string $type, string $format = null)

Проверяет, реализует ли данный класс интерфейс DenormalizableInterface.

bool hasCacheableSupportsMethod()

Подробности

protected object|null extractObjectToPopulate(string $class, array $context, string $key = null)

Извлечь поле object_to_populate из контекста, если оно существует и является экземпляром указанного $class.

Параметры

string $class Класс, к которому должен принадлежать объект
array $context Контекст денормализации
string $key Ключ, по которому искать объект для заполнения. Обеспечивает обратную совместимость с AbstractNormalizer.

Возвращаемое значение

object|null объект, если проверка пройдена, иначе null

setSerializer(SerializerInterface $serializer)

Устанавливает сериализатор.

Параметры

SerializerInterface $serializer Экземпляр SerializerInterface

array|string|int|float|bool normalize(mixed $object, string $format = null, array $context = array())

Нормализует объект в набор массивов/скаляров.

Параметры

mixed $object Объект для нормализации
string $format Формат, в котором будет закодирован результат нормализации
array $context Параметры контекста для нормализатора

Возвращаемое значение

array|string|int|float|bool

Исключения

InvalidArgumentException Возникает, когда предоставленный объект не является допустимым типом для нормализатора
CircularReferenceException Возникает, когда нормализатор обнаруживает циклическую ссылку, которую обработчик циклических ссылок не может исправить
LogicException Возникает, когда нормализатор не вызывается в ожидаемом контексте

object denormalize(mixed $data, string $class, string $format = null, array $context = array())

Денормализует данные обратно в объект заданного класса.

Параметры

mixed $data Данные для восстановления
string $class Ожидаемый класс для создания экземпляра
string $format Формат, из которого были извлечены данные
array $context Параметры, доступные денормализатору

Возвращаемое значение

object

Исключения

BadMethodCallException Возникает, когда нормализатор не вызывается в ожидаемом контексте
InvalidArgumentException Возникает, когда аргументы не согласованы или не поддерживаются
UnexpectedValueException Возникает, когда элемент не может быть гидратирован заданными данными
ExtraAttributesException Возникает, когда у элемента нет атрибута для получения заданных данных
LogicException Возникает, когда нормализатор не должен выполнять денормализацию
RuntimeException Возникает, если класс не может быть создан

bool supportsNormalization(mixed $data, string $format = null)

Проверяет, реализует ли данный класс интерфейс NormalizableInterface.

Параметры

mixed $data Данные для нормализации
string $format Формат, из которого/в который происходит (де-)сериализация

Возвращаемое значение

bool

bool supportsDenormalization(mixed $data, string $type, string $format = null)

Проверяет, реализует ли данный класс интерфейс DenormalizableInterface.

Параметры

mixed $data Данные для денормализации
string $type Класс, в который должны быть денормализованы данные
string $format Формат, из которого происходит десериализация

Возвращаемое значение

bool

bool hasCacheableSupportsMethod()

Возвращаемое значение

bool

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Serializer/Normalizer/CustomNormalizer.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API