Spec-Zone.ru › Symfony 4.1

КлассMetadata

класс ClassMetadata расширяет GenericMetadata и реализует ClassMetadataInterface

Стандартная реализация {@link ClassMetadataInterface}.

Этот класс поддерживает сериализацию и клонирование.

Свойства

Constraint[] $constraints из GenericMetadata
массив $constraintsByGroup из GenericMetadata
int $cascadingStrategy Стратегия для каскадирования объектов. из GenericMetadata
int $traversalStrategy Стратегия для обхода итерируемых объектов.
строка $name
строка $defaultGroup
MemberMetadata[][] $members
PropertyMetadata[] $properties
GetterMetadata[] $getters
массив $groupSequence
bool $groupSequenceProvider

Методы

массив строк __sleep()

Возвращает имена свойств, которые должны быть сериализованы.

__clone()

Клонирует этот объект.

из GenericMetadata
$this addConstraint(Constraint $constraint)

Добавляет ограничение.

$this addConstraints(массив $constraints)

Добавляет список ограничений.

из GenericMetadata
Constraint[] getConstraints()

Возвращает все ограничения этого элемента.

из GenericMetadata
bool hasConstraints()

Возвращает, имеет ли этот элемент какие-либо ограничения.

из GenericMetadata
Constraint[] findConstraints(строка $group)

Возвращает все ограничения для заданной группы валидации.

из GenericMetadata
int getCascadingStrategy()

Узлы классов никогда не каскадируются.

int getTraversalStrategy()

Возвращает стратегию обхода итерируемых объектов.

из GenericMetadata
__construct(строка $class)
строка getClassName()

Возвращает имя базового PHP класса.

строка getDefaultGroup()

Возвращает имя группы по умолчанию для этого класса.

$this addPropertyConstraint(строка $property, Constraint $constraint)

Добавляет ограничение к заданному свойству.

$this addPropertyConstraints(строка $property, массив $constraints)
$this addGetterConstraint(строка $property, Constraint $constraint)

Добавляет ограничение к методу-геттеру заданного свойства.

$this addGetterMethodConstraint(строка $property, строка $method, Constraint $constraint)

Добавляет ограничение к методу-геттеру заданного свойства.

$this addGetterConstraints(строка $property, массив $constraints)
$this addGetterMethodConstraints(строка $property, строка $method, массив $constraints)
mergeConstraints(ClassMetadata $source)

Объединяет ограничения заданного метаданных в этот объект.

bool hasPropertyMetadata(строка $property)

Проверяет наличие метаданных, прикрепленных к заданному свойству.

PropertyMetadataInterface[] getPropertyMetadata(строка $property)

Возвращает все экземпляры метаданных для заданного свойства.

массив строк getConstrainedProperties()

Возвращает имена всех ограниченных свойств.

$this setGroupSequence(массив строк|GroupSequence $groupSequence)

Устанавливает последовательность групп по умолчанию для этого класса.

bool hasGroupSequence()

Возвращает, переопределена ли группа "Default" последовательностью групп.

GroupSequence|null getGroupSequence()

Возвращает последовательность групп, которая переопределяет группу "Default" для этого класса.

ReflectionClass getReflectionClass()

Возвращает экземпляр ReflectionClass для этого класса.

setGroupSequenceProvider(bool $active)

Устанавливает, следует ли использовать поставщика последовательности групп.

bool isGroupSequenceProvider()

Возвращает, переопределена ли группа "Default" динамической последовательностью групп, полученной от валидируемых объектов.

Подробное описание

string[] __sleep()

Возвращает имена свойств, которые должны быть сериализованы.

Значение возврата

string[]

__clone()

Клонирует этот объект.

$this addConstraint(Constraint $constraint)

Добавляет ограничение.

Если ограничение {@link Valid} добавлено, стратегия каскадирования будет изменена на {@link CascadingStrategy::CASCADE}. В зависимости от свойства $traverse этого ограничения, стратегия обхода будет установлена на одну из следующих:

  • {@link TraversalStrategy::IMPLICIT}, если $traverse включено
  • {@link TraversalStrategy::NONE}, если $traverse отключено

Параметры

Constraint $constraint

Значение возврата

$this

Исключения

ConstraintDefinitionException При попытке добавить ограничение {@link Traverse}

$this addConstraints(array $constraints)

Добавляет список ограничений.

Параметры

array $constraints Добавляемые ограничения

Значение возврата

$this

Constraint[] getConstraints()

Возвращает все ограничения этого элемента.

Значение возврата

Constraint[] Список экземпляров Constraint

bool hasConstraints()

Возвращает, имеет ли этот элемент какие-либо ограничения.

Значение возврата

bool

Constraint[] findConstraints(string $group)

Возвращает все ограничения для заданной группы валидации.

Параметры

string $group Группа валидации

Значение возврата

Constraint[] Список экземпляров ограничений

int getCascadingStrategy()

Узлы класса никогда не каскадируются.

{@inheritdoc}

Значение возврата

int Стратегия каскадирования

int getTraversalStrategy()

Возвращает стратегию обхода перебираемых объектов.

Значение возврата

int Стратегия обхода

__construct(string $class)

Параметры

string $class

string getClassName()

Возвращает имя базового PHP-класса.

Значение возврата

string Имя базового класса

string getDefaultGroup()

Возвращает имя группы по умолчанию для этого класса.

Для каждого класса группа "Default" является псевдонимом для группы "", где — имя класса без именованного пространства имён. Все ограничения, неявно или явно назначенные группе "Default", относятся к обеим этим группам, если класс не определяет последовательность групп.

Если класс определяет последовательность групп, валидация класса в "Default" будет валидировать последовательность групп. Ограничения, назначенные группе "Default", всё ещё могут быть валидированы путём валидации класса в "".

Значение возврата

string Имя группы по умолчанию

$this addPropertyConstraint(string $property, Constraint $constraint)

Добавляет ограничение к заданному свойству.

Параметры

string $property Имя свойства
Constraint $constraint Ограничение

Значение возврата

$this

$this addPropertyConstraints(string $property, array $constraints)

Параметры

string $property
array $constraints

Значение возврата

$this

$this addGetterConstraint(string $property, Constraint $constraint)

Добавляет ограничение к методу-геттеру заданного свойства.

Имя геттера предполагается равным имени свойства с заглавной первой буквой и префиксом "get" или "is".

Параметры

string $property Имя свойства
Constraint $constraint Ограничение

Значение возврата

$this

$this addGetterMethodConstraint(string $property, string $method, Constraint $constraint)

Добавляет ограничение к методу-геттеру заданного свойства.

Параметры

string $property Имя свойства
string $method Имя метода-геттера
Constraint $constraint Ограничение

Значение возврата

$this

$this addGetterConstraints(string $property, array $constraints)

Параметры

string $property
array $constraints

Значение возврата

$this

$this addGetterMethodConstraints(string $property, string $method, array $constraints)

Параметры

string $property
string $method
array $constraints

Значение возврата

$this

mergeConstraints(ClassMetadata $source)

Объединяет ограничения заданного метаданных в этот объект.

Параметры

ClassMetadata $source

bool hasPropertyMetadata(string $property)

Проверяет наличие метаданных, привязанных к свойству с заданным именем.

Параметры

string $property Имя свойства

Значение возврата

bool

PropertyMetadataInterface[] getPropertyMetadata(string $property)

Возвращает все экземпляры метаданных для заданного свойства с именем.

Если ваша реализация не поддерживает свойства, просто выбросьте исключение в этом методе (например, BadMethodCallException).

Параметры

string $property Имя свойства

Значение возврата

PropertyMetadataInterface[] Список экземпляров метаданных. Пустой, если для свойства метаданные отсутствуют.

string[] getConstrainedProperties()

Возвращает имена всех ограниченных свойств.

Значение возврата

string[] Список имён свойств

$this setGroupSequence(string[]|GroupSequence $groupSequence)

Устанавливает последовательность групп по умолчанию для этого класса.

Параметры

string[]|GroupSequence $groupSequence Массив имён групп

Значение возврата

$this

Исключения

GroupDefinitionException

bool hasGroupSequence()

Возвращает, переопределён ли групповой порядок «По умолчанию».

Если переопределён, вы можете получить последовательность групп с помощью {@link getGroupSequence()}.

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

bool Возвращает true, если группа «По умолчанию» переопределена

GroupSequence|null getGroupSequence()

Возвращает последовательность групп, которая переопределяет группу «По умолчанию» для данного класса.

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

GroupSequence|null Последовательность групп или null

ReflectionClass getReflectionClass()

Возвращает экземпляр ReflectionClass для данного класса.

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

ReflectionClass

setGroupSequenceProvider(bool $active)

Устанавливает, нужно ли использовать поставщик последовательности групп.

Параметры

bool $active

Исключения

GroupDefinitionException

bool isGroupSequenceProvider()

Возвращает, переопределён ли групповой порядок «По умолчанию» динамической последовательностью групп, полученной от валидируемых объектов.

Если этот метод возвращает true, класс должен реализовывать {@link \Symfony\Component\Validator\GroupSequenceProviderInterface}. Этот интерфейс будет использован для получения последовательности групп при валидации объекта данного класса.

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

bool Возвращает true, если групповой порядок «По умолчанию» переопределён динамической последовательностью групп

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/Mapping/ClassMetadata.html

Spec-Zone.ru

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