Spec-Zone.ru › Symfony 4.1

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
ReflectionMethod|ReflectionProperty newReflectionMember(object|string $objectOrClassName)

Создает новый экземпляр рефлексии для доступа к значению члена.

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[] Список экземпляров ограничений

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 Экземпляр отражения

protected ReflectionMethod|ReflectionProperty newReflectionMember(object|string $objectOrClassName)

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

Должно быть реализовано подклассами.

Параметры

object|string $objectOrClassName Объект или имя класса

Возвращаемое значение

ReflectionMethod|ReflectionProperty Экземпляр отражения

mixed getPropertyValue($object)

Извлекает значение свойства из заданного контейнера.

Параметры

$object

Возвращаемое значение

mixed Значение свойства

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/Mapping/PropertyMetadata.html

Spec-Zone.ru

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