Класс ClassMetadata

string[] __sleep()

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

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

string[]

__clone()

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

$this addConstraint(Constraint $constraint)

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

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

• {@link TraversalStrategy::IMPLICIT}, если $traverse включен и $deep включен
• {@link TraversalStrategy::IMPLICIT} | {@link TraversalStrategy::STOP_RECURSION}, если $traverse включен, но $deep выключен
• {@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	Стратегия обхода

accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath, $propagatedGroup = null) ^deprecated

^deprecated

since version 2.5, to be removed in 3.0.

Существует для совместимости с устаревшим {@link Symfony\Component\Validator\MetadataInterface}.

Не следует использовать.

Реализовано для обратной совместимости с Symfony < 2.5.

Параметры

ValidationVisitorInterface	$visitor	Посетитель, реализующий логику валидации
mixed	$value	Значение для проверки
string|string[]	$group	Группа валидации для проверки
string	$propertyPath	Текущий путь к свойству в графе валидации
	$propagatedGroup

Исключения

BadMethodCallException

__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 hasMemberMetadatas(string $property) ^deprecated

^deprecated

since version 2.6, to be removed in 3.0. Use {@link hasPropertyMetadata} instead.

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

Параметры

string

$property

Имя свойства

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

bool

MemberMetadata[] getMemberMetadatas(string $property) ^deprecated

^deprecated

since version 2.6, to be removed in 3.0. Use {@link getPropertyMetadata} instead.

Возвращает все метаданные членов, описывающие заданный свойство.

Parameters

string

$property

Имя свойства

Return Value

MemberMetadata[]

Массив MemberMetadata

bool hasPropertyMetadata(string $property)

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

Parameters

string

$property

Имя свойства

Return Value

bool

PropertyMetadataInterface[] getPropertyMetadata(string $property)

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

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

Parameters

string

$property

Имя свойства

Return Value

PropertyMetadataInterface[]

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

string[] getConstrainedProperties()

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

Return Value

string[]

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

$this setGroupSequence(array $groupSequence)

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

Parameters

array

$groupSequence

Массив имён групп

Return Value

$this

Exceptions

GroupDefinitionException

bool hasGroupSequence()

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

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

Return Value

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

GroupSequence|null getGroupSequence()

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

Return Value

GroupSequence|null

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

ReflectionClass getReflectionClass()

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

Return Value

ReflectionClass

setGroupSequenceProvider(bool $active)

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

Parameters

bool

$active

Exceptions

GroupDefinitionException

bool isGroupSequenceProvider()

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

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

Return Value

bool	Возвращает true, если группа "Default" переопределена динамической последовательностью групп