Класс ClassMetadataInterface
интерфейс ClassMetadataInterface реализует MetadataInterface
Хранит все метаданные, необходимые для проверки объектов определенного класса.
Наиболее важным образом, метаданные хранят ограничения, против которых должен проверяться объект и его свойства.
Кроме того, метаданные хранят, переопределен ли «Группа по умолчанию» последовательностью групп для этого класса и нужно ли проходить по экземплярам этого класса или нет.
Методы
| int | getCascadingStrategy() Возвращает стратегию для каскадирования объектов. | из MetadataInterface |
| int | getTraversalStrategy() Возвращает стратегию для обхода объектов, которые можно обходить. | из MetadataInterface |
| Constraint[] | getConstraints() Возвращает все ограничения этого элемента. | из MetadataInterface |
| Constraint[] | findConstraints(string $group) Возвращает все ограничения для заданной группы валидации. | из MetadataInterface |
| string[] | getConstrainedProperties() Возвращает имена всех ограниченных свойств. | |
| bool | hasGroupSequence() Возвращает, переопределена ли группа «По умолчанию» последовательностью групп. | |
| GroupSequence|null | getGroupSequence() Возвращает последовательность групп, которая переопределяет группу «По умолчанию» для этого класса. | |
| bool | isGroupSequenceProvider() Возвращает, переопределяется ли группа «По умолчанию» динамической последовательностью групп, полученной от проверяемых объектов. | |
| 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()
Возвращает, переопределена ли группа «По умолчанию» последовательностью групп.
Если это так, вы можете получить доступ к последовательности групп с помощью {@link getGroupSequence()}.
Значение, возвращаемое функцией
| bool | Возвращает true, если группа «По умолчанию» переопределена |
См. также
| GroupSequence |
GroupSequence|null getGroupSequence()
Возвращает последовательность групп, которая переопределяет группу «По умолчанию» для этого класса.
Значение, возвращаемое функцией
| GroupSequence|null | Последовательность групп или null |
См. также
| GroupSequence |
bool isGroupSequenceProvider()
Возвращает, переопределяется ли группа «По умолчанию» динамической последовательностью групп, полученной от проверяемых объектов.
Если этот метод возвращает true, класс должен реализовывать {@link \Symfony\Component\Validator\GroupSequenceProviderInterface}. Этот интерфейс будет использоваться для получения последовательности групп, когда объект этого класса проверяется.
Значение, возвращаемое функцией
| bool | Возвращает true, если группа «По умолчанию» переопределяется динамической последовательностью групп |
См. также
| 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.
https://api.symfony.com/4.1/Symfony/Component/Validator/Mapping/ClassMetadataInterface.html