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