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 | |
| $this | addConstraint(Constraint $constraint) Добавляет ограничение. | from MemberMetadata |
| $this | 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 |
| __construct(string $class, string $property, string|null $method = null) Конструктор. | ||
| string | getName() Возвращает имя члена. | from MemberMetadata |
| getClassName() {@inheritdoc} | 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 |
| ReflectionMethod|ReflectionProperty | getReflectionMember(object|string $objectOrClassName) Возвращает экземпляр рефлексии для доступа к значению члена. | from 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.2/Symfony/Component/Validator/Mapping/GetterMetadata.html
