Spec-Zone.ru › Symfony 3.0

PropertyMetadata

class PropertyMetadata extends MemberMetadata

Хранит всю метаданные, необходимую для проверки свойства класса.

Значение свойства извлекается путём прямого доступа к свойству. Свойство будет обработано с помощью рефлексии, поэтому поддерживается доступ к закрытым и защищённым свойствам.

Этот класс поддерживает сериализацию и клонирование.

Свойства

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
GenericMetadata addConstraint(Constraint $constraint)

Добавляет ограничение.

из MemberMetadata
GenericMetadata 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) устарело

Существует для совместимости с устаревшим {@link Symfony\Component\Validator\MetadataInterface}.

из MemberMetadata
__construct(string $class, string $name)

Конструктор.

string getName()

Возвращает имя члена.

из MemberMetadata
string getClassName()

Возвращает имя базового PHP класса.

из MemberMetadata
string getPropertyName()

Возвращает имя свойства.

из MemberMetadata
bool isPublic(object|string $objectOrClassName)

Возвращает, является ли этот член публичным.

из MemberMetadata
bool isProtected(object|string $objectOrClassName)

Возвращает, является ли этот член защищённым.

из MemberMetadata
bool isPrivate(object|string $objectOrClassName)

Возвращает, является ли этот член закрытым.

из MemberMetadata
bool isCascaded() устарело

Возвращает, должны ли объекты, хранящиеся в этом члене, быть проверены.

из MemberMetadata
bool isCollectionCascaded() устарело

Возвращает, должны ли массивы или перебираемые объекты, хранящиеся в этом члене, быть обработаны и проверены в каждом элементе.

из MemberMetadata
bool isCollectionCascadedDeeply() устарело

Возвращает, должны ли массивы или перебираемые объекты, хранящиеся в этом члене, быть рекурсивно обработаны для вложенных массивов/перебираемых объектов.

из MemberMetadata
ReflectionMethod|ReflectionProperty getReflectionMember(object|string $objectOrClassName)

Возвращает отражающий экземпляр для доступа к значению члена.

из 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) deprecated

deprecated

Устарело с версии 2.5, будет удалено в Symfony 3.0.

Существует для совместимости с устаревшим {@link Symfony\Component\Validator\MetadataInterface}.

Не следует использовать.

Параметры

ValidationVisitorInterface $visitor Визитор, реализующий логику валидации
mixed $value Значение для валидации
string|string[] $group Группа валидации для проверки
string $propertyPath Текущий путь к свойству в графе валидации
$propagatedGroup

Исключения

BadMethodCallException

__construct(string $class, string $name)

Конструктор.

Параметры

string $class Имя класса, в котором определен этот член
string $name Имя члена

Исключения

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() deprecated

deprecated

Устарело с версии 2.5, будет удалено в Symfony 3.0. Используйте {@link getCascadingStrategy()} вместо этого.

Возвращает, следует ли валидировать объекты, хранящиеся в этом члене.

Значение возврата

bool

bool isCollectionCascaded() deprecated

deprecated

Устарело с версии 2.5, будет удалено в Symfony 3.0. Используйте {@link getTraversalStrategy()} вместо этого.

Возвращает, следует ли обрабатывать и валидировать массивы или перебираемые объекты, хранящиеся в этом члене, в каждом элементе.

Значение возврата

bool

bool isCollectionCascadedDeeply() deprecated

deprecated

Устарело с версии 2.5, будет удалено в Symfony 3.0. Используйте {@link getTraversalStrategy()} вместо этого.

Возвращает, следует ли рекурсивно обрабатывать массивы или перебираемые объекты, хранящиеся в этом члене, для вложенных массивов/перебираемых объектов.

Значение возврата

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/PropertyMetadata.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API