Класс ClassMetadataInterface
интерфейс ClassMetadataInterface реализует MetadataInterface
Хранит все метаданные, необходимые для валидации объектов определенного класса.
Самое главное, метаданные хранят ограничения, которым должен соответствовать объект и его свойства.
Кроме того, метаданные хранят информацию о том, переопределена ли группа «Default» последовательностью групп для данного класса, и следует ли проходить обход по экземплярам этого класса.
Методы
| int | getCascadingStrategy() Возвращает стратегию для каскадного обращения к объектам. | из MetadataInterface |
| int | getTraversalStrategy() Возвращает стратегию для обхода перебираемых объектов. | из MetadataInterface |
| Constraint[] | getConstraints() Возвращает все ограничения этого элемента. | из MetadataInterface |
| Constraint[] | findConstraints(string $group) Возвращает все ограничения для заданной группы валидации. | из MetadataInterface |
| string[] | getConstrainedProperties() Возвращает имена всех ограниченных свойств. | |
| bool | hasGroupSequence() Возвращает, переопределена ли группа «Default» последовательностью групп. | |
| GroupSequence|null | getGroupSequence() Возвращает последовательность групп, которая переопределяет группу «Default» для этого класса. | |
| bool | isGroupSequenceProvider() Возвращает, переопределена ли группа «Default» динамической последовательностью групп, полученной от валидируемых объектов. | |
| bool | hasPropertyMetadata(string $property) Проверяет, есть ли какие-либо метаданные, прикрепленные к свойству с заданным именем. | |
| PropertyMetadataInterface[] | getPropertyMetadata(string $property) Возвращает все экземпляры метаданных для свойства с заданным именем. | |
| string | getClassName() Возвращает имя базового PHP-класса. |
Подробности
int getCascadingStrategy()
Возвращает стратегию для каскадного обращения к объектам.
Возвращаемое значение
| int | Стратегия каскадного обращения |
См. также
| CascadingStrategy |
int getTraversalStrategy()
Возвращает стратегию для обхода перебираемых объектов.
Возвращаемое значение
| int | Стратегия обхода |
См. также
| TraversalStrategy |
Constraint[] getConstraints()
Возвращает все ограничения этого элемента.
Возвращаемое значение
| Constraint[] | Список экземпляров Constraint |
Constraint[] findConstraints(string $group)
Возвращает все ограничения для заданной группы валидации.
Параметры
| string | $group | Группа валидации |
Возвращаемое значение
| Constraint[] | Список экземпляров ограничений |
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 |
bool hasPropertyMetadata(string $property)
Проверяет, есть ли какие-либо метаданные, прикрепленные к свойству с заданным именем.
Параметры
| string | $property | Имя свойства. |
Возвращаемое значение
| bool |
PropertyMetadataInterface[] getPropertyMetadata(string $property)
Возвращает все экземпляры метаданных для свойства с заданным именем.
Если ваша реализация не поддерживает свойства, просто выбросьте исключение в этом методе (например, BadMethodCallException).
Параметры
| string | $property | Имя свойства. |
Возвращаемое значение
| PropertyMetadataInterface[] | Список экземпляров метаданных. Пустой, если метаданных для свойства нет. |
string getClassName()
Возвращает имя базового PHP-класса.
Возвращаемое значение
| string | Имя базового класса. |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Validator/Mapping/ClassMetadataInterface.html