Spec-Zone.ru › Symfony 3.1

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

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

from MemberMetadata
GenericMetadata 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
accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath, $propagatedGroup = null) устарело

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

from MemberMetadata
__construct(string $class, string $property)

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

string getName()

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

from MemberMetadata
string getClassName()

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

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
bool isCascaded() устарело

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

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

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

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

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

from MemberMetadata
ReflectionMethod|ReflectionProperty getReflectionMember(object|string $objectOrClassName)

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

from 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) устарело

устарело

Устарело с версии 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 $property)

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

Параметры

string $class Имя класса, в котором определен этот член
string $property Свойство, к которому относится член

Исключения

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() устарело

устарело

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

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

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

bool

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

устарело

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

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

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

bool

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

устарело

Устарело с версии 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.1/Symfony/Component/Validator/Mapping/GetterMetadata.html

Spec-Zone.ru

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