Spec-Zone.ru › Symfony 2.8

GetterMetadata

class GetterMetadata extends MemberMetadata

Хранит всю метаданные, необходимую для валидации свойства класса через метод-геттер.

Метод-геттер — это любой метод, равный имени свойства, с префиксом «get» или «is». Этот метод будет использоваться для доступа к значению свойства.

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

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

Свойства

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
$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
accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath, $propagatedGroup = null) устаревший

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

от MemberMetadata
__construct(string $class, string $property, string|null $method = null)
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()

Клонирует этот объект.

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

устарело

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

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

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

Реализовано для обратной совместимости с Symfony < 2.5.

Параметры

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

Исключения

BadMethodCallException

__construct(string $class, string $property, string|null $method = null)

Параметры

string $class Имя класса, в котором определен этот член
string $property Свойство, к которому принадлежит член
string|null $method Метод, который вызывается для получения проверяемого значения (null для автоматического определения)

Исключения

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

устарело

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

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

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

bool

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

устарело

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

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

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

bool

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

устарело

since версия 2.5, будет удалено в 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/2.8/Symfony/Component/Validator/Mapping/GetterMetadata.html

Spec-Zone.ru

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