GetterMetadata
class GetterMetadata extends MemberMetadata
Хранит всю метаданные, необходимую для проверки свойства класса через метод-геттер.
Метод-геттер — это любой метод, который равен имени свойства, с префиксом «get» или «is». Этот метод будет использоваться для доступа к значению свойства.
Геттер будет вызываться с помощью рефлексии, поэтому поддерживается доступ к закрытым и защищенным геттерам.
Этот класс поддерживает сериализацию и клонирование.
Свойства
| Constraint[] | $constraints | from GenericMetadata | |
| array | $constraintsByGroup | from GenericMetadata | |
| int | $cascadingStrategy | Стратегия для каскадного валидирования объектов. | from GenericMetadata |
| int | $traversalStrategy | Стратегия для обхода итерационных объектов. | from GenericMetadata |
| string | $class | from MemberMetadata | |
| string | $name | from MemberMetadata | |
| string | $property | from MemberMetadata |
Методы
| string[] | __sleep() Возвращает имена свойств, которые должны быть сериализованы. | from MemberMetadata |
| __clone() Клонирует этот объект. | from GenericMetadata | |
| GenericMetadata | addConstraint(Constraint $constraint) Добавляет ограничение. | from MemberMetadata |
| GenericMetadata | addConstraints(array $constraints) Добавляет список ограничений. | from GenericMetadata |
| Constraint[] | getConstraints() Возвращает все ограничения этого элемента. | from GenericMetadata |
| bool | hasConstraints() Возвращает, имеет ли этот элемент какие-либо ограничения. | from GenericMetadata |
| Constraint[] | findConstraints(string $group) Возвращает все ограничения для заданной группы проверки. | from GenericMetadata |
| int | getCascadingStrategy() Возвращает стратегию каскадного валидирования. | from GenericMetadata |
| int | getTraversalStrategy() Возвращает стратегию обхода итерационных объектов. | from GenericMetadata |
| accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath, $propagatedGroup = null) deprecated Существует для совместимости со устаревшим {@link Symfony\Component\Validator\MetadataInterface}. | from MemberMetadata | |
| __construct(string $class, string $property) Конструктор. | ||
| string | getName() Возвращает имя члена. | from MemberMetadata |
| string | getClassName() Возвращает имя поддерживаемого PHP класса. | from MemberMetadata |
| string | getPropertyName() Возвращает имя свойства. | from MemberMetadata |
| bool | isPublic(object|string $objectOrClassName) Возвращает, является ли этот член публичным. | from MemberMetadata |
| bool | isProtected(object|string $objectOrClassName) Возвращает, является ли этот член защищенным. | from MemberMetadata |
| bool | isPrivate(object|string $objectOrClassName) Возвращает, является ли этот член приватным. | from MemberMetadata |
| bool | isCascaded() deprecated Возвращает, должны ли объекты, хранящиеся в этом члене, быть проверены. | from MemberMetadata |
| bool | isCollectionCascaded() deprecated Возвращает, должны ли массивы или итерируемые объекты, хранящиеся в этом члене, быть обработаны и проверены в каждом элементе. | from MemberMetadata |
| bool | isCollectionCascadedDeeply() deprecated Возвращает, должны ли массивы или итерируемые объекты, хранящиеся в этом члене, быть рекурсивно обработаны для вложенных массивов/итерируемых объектов. | from MemberMetadata |
| ReflectionMethod|ReflectionProperty | getReflectionMember(object|string $objectOrClassName) Возвращает экземпляр рефлексии для доступа к значению члена. | from MemberMetadata |
| mixed | getPropertyValue($object) Извлекает значение свойства из заданного контейнера. |
Подробности
string[] __sleep()
Возвращает имена свойств, которые должны быть сериализованы.
Значение возврата
| string[] |
__clone()
Клонирует этот объект.
GenericMetadata 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 | Ограничение для добавления |
Значение возврата
| GenericMetadata | Этот объект |
Исключения
| ConstraintDefinitionException | При попытке добавить ограничение {@link Traverse} |
GenericMetadata addConstraints(array $constraints)
Добавляет список ограничений.
Параметры
| array | $constraints | Ограничения для добавления |
Значение возврата
| GenericMetadata | Этот объект |
Constraint[] getConstraints()
Возвращает все ограничения этого элемента.
Значение возврата
| Constraint[] | Список экземпляров Constraint |
bool hasConstraints()
Возвращает, имеет ли этот элемент какие-либо ограничения.
Значение возврата
| bool |
Constraint[] findConstraints(string $group)
Возвращает все ограничения для заданной группы проверки.
Параметры
| string | $group | Группа проверки |
Значение возврата
| Constraint[] | Список экземпляров ограничений |
int getCascadingStrategy()
Возвращает стратегию для каскадирования объектов.
Значение возврата
| int | Стратегия каскадирования |
int getTraversalStrategy()
Возвращает стратегию для обхода перебираемых объектов.
Значение возврата
| int | Стратегия обхода |
accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath, $propagatedGroup = null) устаревшее
устаревшее
Существует для совместимости с устаревшим {@link Symfony\Component\Validator\MetadataInterface}.
Не следует использовать.
Параметры
| ValidationVisitorInterface | $visitor | Визитор, реализующий логику проверки |
| mixed | $value | Значение для проверки |
| string|string[] | $group | Группа проверки |
| string | $propertyPath | Текущий путь к свойству в графе проверки |
| $propagatedGroup |
Исключения
| BadMethodCallException |
__construct(string $class, string $property)
Конструктор.
Параметры
| string | $class | Имя класса, в котором определен этот член |
| string | $property | Свойство, к которому принадлежит член |
Исключения
| ValidatorException |
string getName()
Возвращает имя члена.
Значение возврата
| string |
string getClassName()
Возвращает имя базового PHP класса.
Значение возврата
| string | Имя базового класса. |
string getPropertyName()
Возвращает имя свойства.
Значение возврата
| string | Имя свойства. |
bool isPublic(object|string $objectOrClassName)
Возвращает, является ли этот член общедоступным.
Параметры
| object|string | $objectOrClassName | Объект или имя класса |
Значение возврата
| bool |
bool isProtected(object|string $objectOrClassName)
Возвращает, является ли этот член защищенным.
Параметры
| object|string | $objectOrClassName | Объект или имя класса |
Значение возврата
| bool |
bool isPrivate(object|string $objectOrClassName)
Возвращает, является ли этот член закрытым.
Параметры
| object|string | $objectOrClassName | Объект или имя класса |
Значение возврата
| bool |
bool isCascaded() устаревшее
устаревшее
Возвращает, следует ли проверять объекты, хранящиеся в этом члене.
Значение возврата
| bool |
bool isCollectionCascaded() устаревшее
устаревшее
Возвращает, следует ли обходить и проверять массивы или итерируемые объекты, хранящиеся в этом члене, в каждом элементе.
Значение возврата
| bool |
bool isCollectionCascadedDeeply() устаревшее
устаревшее
Возвращает, следует ли рекурсивно обходить массивы или итерируемые объекты, хранящиеся в этом члене, для вложенных массивов/итерируемых объектов.
Значение возврата
| bool |
ReflectionMethod|ReflectionProperty getReflectionMember(object|string $objectOrClassName)
Возвращает отражающий экземпляр для доступа к значению члена.
Параметры
| object|string | $objectOrClassName | Объект или имя класса |
Значение возврата
| ReflectionMethod|ReflectionProperty | Экземпляр отражения |
mixed getPropertyValue($object)
Извлекает значение свойства из заданного контейнера.
Параметры
| $object |
Значение возврата
| mixed | Значение свойства. |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Validator/Mapping/GetterMetadata.html
