PropertyMetadata
class PropertyMetadata extends MemberMetadata
Хранит всю метаданные, необходимую для валидации свойства класса.
Значение свойства извлекается путем непосредственного доступа к свойству. К свойству будет осуществляться доступ с помощью рефлексии, поэтому поддерживается доступ к приватным и защищенным свойствам.
Этот класс поддерживает сериализацию и клонирование.
Свойства
| Constraint[] | $constraints | от GenericMetadata | |
| array | $constraintsByGroup | от GenericMetadata | |
| int | $cascadingStrategy | Стратегия для каскадного валидирования объектов. | от GenericMetadata |
| int | $traversalStrategy | Стратегия для обхода перебираемых объектов. | от GenericMetadata |
| $class | от MemberMetadata | ||
| $name | от MemberMetadata | ||
| $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 $name) | ||
| 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[] | Список экземпляров constraint |
int getCascadingStrategy()
Возвращает стратегию для каскадирования объектов.
Возвращаемое значение
| int | Стратегия каскадирования |
int getTraversalStrategy()
Возвращает стратегию для обхода обходимых объектов.
Возвращаемое значение
| int | Стратегия обхода |
__construct(string $class, string $name)
Параметры
| string | $class | Имя класса, в котором определен этот член |
| string | $name | Имя члена |
Исключения
| 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/4.0/Symfony/Component/Validator/Mapping/PropertyMetadata.html
