GetterMetadata
class GetterMetadata extends MemberMetadata
Хранит все метаданные, необходимые для проверки свойства класса через метод-геттер.
Геттер свойства — это любой метод, соответствующий имени свойства, с префиксом «get» или «is». Этот метод используется для доступа к значению свойства.
Геттер будет вызываться с помощью рефлексии, поэтому поддерживается доступ к приватным и защищённым геттерам.
Этот класс поддерживает сериализацию и клонирование.
Свойства
| Constraint[] | $constraints | из GenericMetadata | |
| array | $constraintsByGroup | из GenericMetadata | |
| int | $cascadingStrategy | Стратегия каскадного обращения к объектам. | из GenericMetadata |
| int | $traversalStrategy | Стратегия обхода итерируемых объектов. | из GenericMetadata |
| string | $class | из MemberMetadata | |
| string | $name | из MemberMetadata | |
| string | $property | из MemberMetadata |
Методы
| string[] | __sleep() Возвращает имена свойств, которые должны быть сериализованы. | из MemberMetadata |
| __clone() Клонирует этот объект. | из GenericMetadata | |
| $this | addConstraint(Constraint $constraint) Добавляет ограничение. | из MemberMetadata |
| $this | addConstraints(array $constraints) Добавляет список ограничений. | из GenericMetadata |
| Constraint[] | getConstraints() Возвращает все ограничения этого элемента. | из GenericMetadata |
| bool | hasConstraints() Возвращает, имеет ли этот элемент какие-либо ограничения. | из GenericMetadata |
| Constraint[] | findConstraints(string $group) Возвращает все ограничения для заданной группы валидации. | из GenericMetadata |
| int | getCascadingStrategy() Возвращает стратегию каскадного обращения к объектам. | из GenericMetadata |
| int | getTraversalStrategy() Возвращает стратегию обхода итерируемых объектов. | из GenericMetadata |
| __construct(string $class, string $property, string|null $method = null) | ||
| string | getName() Возвращает имя члена. | из MemberMetadata |
| getClassName() {@inheritdoc} | из MemberMetadata | |
| string | getPropertyName() Возвращает имя свойства. | из MemberMetadata |
| bool | isPublic(object|string $objectOrClassName) Возвращает, является ли этот член публичным. | из MemberMetadata |
| bool | isProtected(object|string $objectOrClassName) Возвращает, является ли этот член защищённым. | из MemberMetadata |
| bool | isPrivate(object|string $objectOrClassName) Возвращает, является ли этот член приватным. | из MemberMetadata |
| ReflectionMethod|ReflectionProperty | getReflectionMember(object|string $objectOrClassName) Возвращает рефлексионный экземпляр для доступа к значению члена. | из MemberMetadata |
| mixed | getPropertyValue($object) Извлекает значение свойства из заданного контейнера. |
Подробности
string[] __sleep()
Возвращает имена свойств, которые должны быть сериализованы.
Результат
| string[] |
__clone()
Клонирует этот объект.
$this addConstraint(Constraint $constraint)
Добавляет ограничение.
Если ограничение {@link Valid} добавлено, стратегия каскадирования будет изменена на {@link CascadingStrategy::CASCADE}. В зависимости от свойства $traverse этого ограничения, стратегия обхода будет установлена на одну из следующих:
- {@link TraversalStrategy::IMPLICIT}, если $traverse включен
- {@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()
Возвращает стратегию для каскадного обработки объектов.
Результат
| int | Стратегия каскадирования |
int getTraversalStrategy()
Возвращает стратегию для обхода итерационных объектов.
Результат
| int | Стратегия обхода |
__construct(string $class, string $property, string|null $method = null)
Параметры
| string | $class | Имя класса, в котором определен этот член |
| string | $property | Свойство, к которому принадлежит член |
| string|null | $method | Метод, вызываемый для получения проверяемого значения (null для автоматического определения) |
Исключения
| ValidatorException |
string getName()
Возвращает имя члена.
Результат
| string |
getClassName()
{@inheritdoc}
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 |
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.4/Symfony/Component/Validator/Mapping/GetterMetadata.html
