ClassMetadataInterface
интерфейс ClassMetadataInterface реализует MetadataInterface, PropertyMetadataContainerInterface, ClassBasedInterface
Хранит всю метаданные, необходимую для валидации объектов определенного класса.
Наиболее важно, что метаданные хранят ограничения, по которым должен проверяться объект и его свойства.
Кроме того, метаданные хранят информацию о том, переопределена ли группа "Default" последовательностью групп для этого класса и следует ли перебирать экземпляры этого класса.
Методы
| accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath) устарело Реализация паттерна проектирования Visitor. | из MetadataInterface | |
| Constraint[] | findConstraints(string $group) Возвращает все ограничения для заданной группы валидации. | из MetadataInterface |
| int | getCascadingStrategy() Возвращает стратегию для каскадирования объектов. | из MetadataInterface |
| int | getTraversalStrategy() Возвращает стратегию для перебора перебираемых объектов. | из MetadataInterface |
| Constraint[] | getConstraints() Возвращает все ограничения этого элемента. | из MetadataInterface |
| bool | hasPropertyMetadata(string $property) Проверяет, есть ли какие-либо метаданные, присоединенные к свойству с заданным именем. | из PropertyMetadataContainerInterface |
| PropertyMetadataInterface[] | getPropertyMetadata(string $property) Возвращает все экземпляры метаданных для свойства с заданным именем. | из PropertyMetadataContainerInterface |
| string | getClassName() Возвращает имя поддерживаемого PHP-класса. | из ClassBasedInterface |
| string[] | getConstrainedProperties() Возвращает имена всех ограниченных свойств. | |
| bool | hasGroupSequence() Возвращает значение, указывающее, переопределена ли группа "Default" последовательностью групп. | |
| GroupSequence|null | getGroupSequence() Возвращает последовательность групп, которая переопределяет группу "Default" для этого класса. | |
| bool | isGroupSequenceProvider() Возвращает значение, указывающее, переопределена ли группа "Default" динамической последовательностью групп, полученной от проверяемых объектов. |
Подробности
accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath) deprecated
deprecated
Реализация паттерна проектирования Visitor.
Вызывает {@link ValidationVisitorInterface::visit} и затем перенаправляет вызов accept() всем экземплярам метаданных свойств.
Параметры
| ValidationVisitorInterface | $visitor | Посетитель, реализующий логику валидации |
| mixed | $value | Значение для проверки |
| string|string[] | $group | Группа валидации для проверки |
| string | $propertyPath | Текущий путь к свойству в графе валидации |
Constraint[] findConstraints(string $group)
Возвращает все ограничения для заданной группы валидации.
Параметры
| string | $group | Группа валидации |
Значение, возвращаемое функцией
| Constraint[] | Список экземпляров ограничений |
int getCascadingStrategy()
Возвращает стратегию для каскадирования объектов.
Значение, возвращаемое функцией
| int | Стратегия каскадирования |
См. также
| CascadingStrategy |
int getTraversalStrategy()
Возвращает стратегию для обхода обходимых объектов.
Значение, возвращаемое функцией
| int | Стратегия обхода |
См. также
| TraversalStrategy |
Constraint[] getConstraints()
Возвращает все ограничения этого элемента.
Значение, возвращаемое функцией
| Constraint[] | Список экземпляров Constraint |
bool hasPropertyMetadata(string $property)
Проверяет, есть ли какие-либо метаданные, привязанные к заданному свойству по имени.
Параметры
| string | $property | Имя свойства |
Значение, возвращаемое функцией
| bool |
PropertyMetadataInterface[] getPropertyMetadata(string $property)
Возвращает все экземпляры метаданных для заданного свойства по имени.
Если ваша реализация не поддерживает свойства, просто выбросьте исключение в этом методе (например, BadMethodCallException).
Параметры
| string | $property | Имя свойства |
Значение, возвращаемое функцией
| PropertyMetadataInterface[] | Список экземпляров метаданных. Пустой, если для свойства нет метаданных. |
string getClassName()
Возвращает имя поддерживаемого PHP-класса.
Значение, возвращаемое функцией
| string | Имя поддерживаемого класса |
string[] getConstrainedProperties()
Возвращает имена всех ограниченных свойств.
Значение, возвращаемое функцией
| string[] | Список имён свойств |
bool hasGroupSequence()
Возвращает, переопределяет ли группа «Default» последовательность групп.
Если это так, вы можете получить последовательность групп с помощью {@link getGroupSequence()}.
Значение, возвращаемое функцией
| bool | Возвращает true, если группа «Default» переопределена |
См. также
| \Symfony\Component\Validator\Constraints\GroupSequence |
GroupSequence|null getGroupSequence()
Возвращает последовательность групп, которая переопределяет группу «Default» для этого класса.
Значение, возвращаемое функцией
| GroupSequence|null | Последовательность групп или null |
См. также
| \Symfony\Component\Validator\Constraints\GroupSequence |
bool isGroupSequenceProvider()
Возвращает, переопределяет ли группа «Default» динамической последовательностью групп, полученной от проверяемых объектов.
Если этот метод возвращает true, класс должен реализовывать {@link \Symfony\Component\Validator\GroupSequenceProviderInterface}. Этот интерфейс будет использован для получения последовательности групп при проверке объекта этого класса.
Значение, возвращаемое функцией
| bool | Возвращает true, если группа «Default» переопределена динамической последовательностью групп |
См. также
| \Symfony\Component\Validator\GroupSequenceProviderInterface |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Validator/Mapping/ClassMetadataInterface.html