ExecutionContext
class ExecutionContext implements ExecutionContextInterface
Контекст, используемый и создаваемый {@link ExecutionContextFactory}.
Методы
| __construct(ValidatorInterface $validator, mixed $root, TranslatorInterface $translator, string|null $translationDomain = null) Создаёт новый контекст выполнения. | ||
| setNode(mixed $value, object|null $object, MetadataInterface $metadata = null, string $propertyPath) Устанавливает текущее проверяемое значение. | ||
| setGroup(string|null $group) Устанавливает текущую проверяемую группу. | ||
| setConstraint(Constraint $constraint) Устанавливает текущее проверяемое ограничение. | ||
| addViolation(string $message, array $parameters = array()) Добавляет нарушение в текущей узле графа проверки. | ||
| ConstraintViolationBuilderInterface | buildViolation(string $message, array $parameters = array()) Возвращает билдер для добавления нарушения с дополнительной информацией. | |
| ConstraintViolationListInterface | getViolations() Возвращает нарушения, сгенерированные валидатором до сих пор. | |
| ValidatorInterface | getValidator() Возвращает валидатор. | |
| mixed | getRoot() Возвращает значение, с которого началась проверка в графе объектов. | |
| mixed | getValue() Возвращает значение, которое валидатор в данный момент проверяет. | |
| object|null | getObject() Возвращает текущий проверяемый объект. | |
| MetadataInterface|null | getMetadata() Возвращает метаданные для текущего проверяемого значения. | |
| string | getGroup() Возвращает группу валидации, которая в данный момент проверяется. | |
| getConstraint() | ||
| string|null | getClassName() Возвращает имя класса текущего узла. | |
| string|null | getPropertyName() Возвращает имя свойства текущего узла. | |
| string | getPropertyPath(string $subPath = '') Возвращает путь к свойству значения, которое валидатор в данный момент проверяет. | |
| markGroupAsValidated(string $cacheKey, string $groupHash) Помечает объект как проверенный в определённой группе валидации. | ||
| bool | isGroupValidated(string $cacheKey, string $groupHash) Возвращает, был ли объект проверен в определённой группе валидации. | |
| markConstraintAsValidated(string $cacheKey, string $constraintHash) Помечает ограничение как проверенное для объекта. | ||
| bool | isConstraintValidated(string $cacheKey, string $constraintHash) Возвращает, было ли ограничение проверено для объекта. | |
| markObjectAsInitialized(string $cacheKey) Помечает, что объект был инициализирован. | ||
| bool | isObjectInitialized(string $cacheKey) Возвращает, был ли объект инициализирован. |
Подробности
__construct(ValidatorInterface $validator, mixed $root, TranslatorInterface $translator, string|null $translationDomain = null)
Создаёт новый контекст выполнения.
Параметры
| ValidatorInterface | $validator | Валидатор |
| mixed | $root | Корневое значение графа валидируемого объекта |
| TranslatorInterface | $translator | Переводчик |
| string|null | $translationDomain | Домен перевода для перевода сообщений об ошибках |
setNode(mixed $value, object|null $object, MetadataInterface $metadata = null, string $propertyPath)
Устанавливает текущее значение для валидации.
Параметры
| mixed | $value | Валидируемое значение |
| object|null | $object | Текущий валидируемый объект |
| MetadataInterface | $metadata | Данные метаданных валидации |
| string | $propertyPath | Путь к свойству текущего значения |
setGroup(string|null $group)
Устанавливает текущую группу валидации.
Параметры
| string|null | $group | Валидируемая группа |
setConstraint(Constraint $constraint)
Устанавливает текущее ограничение для валидации.
Параметры
| Constraint | $constraint | Валидируемое ограничение |
addViolation(string $message, array $parameters = array())
Добавляет нарушение в текущем узле графа валидации.
Параметры
| string | $message | Сообщение об ошибке |
| array | $parameters |
ConstraintViolationBuilderInterface buildViolation(string $message, array $parameters = array())
Возвращает билдер для добавления нарушения с расширенной информацией.
Вызовите {@link ConstraintViolationBuilderInterface::addViolation()}, чтобы добавить нарушение, когда закончите с настройкой:
$context->buildViolation('Please enter a number between %min% and %max%.')
->setParameter('%min%', 3)
->setParameter('%max%', 10)
->setTranslationDomain('number_validation')
->addViolation();
Параметры
| string | $message | Сообщение об ошибке |
| array | $parameters | Параметры, подставляемые в сообщение об ошибке |
Значение возврата
| ConstraintViolationBuilderInterface | Билдер нарушений |
ConstraintViolationListInterface getViolations()
Возвращает нарушения, сгенерированные валидатором до этого момента.
Значение возврата
| ConstraintViolationListInterface | Список нарушений ограничений |
ValidatorInterface getValidator()
Возвращает валидатор.
Полезно, если вы хотите выполнить валидацию дополнительных ограничений:
public function validate($value, Constraint $constraint)
{
$validator = $this->context->getValidator();
$violations = $validator->validateValue($value, new Length(array('min' => 3)));
if (count($violations) > 0) {
// ...
}
}
Значение возврата
| ValidatorInterface |
mixed getRoot()
Возвращает значение, с которого началась валидация в графе объектов.
Валидатор, получая объект, обходит свойства и связанные объекты, а также их свойства. Корень валидации — это объект, с которого начался обход.
Текущее значение возвращается методом {@link getValue}.
Значение возврата
| mixed | Корневое значение валидации |
mixed getValue()
Возвращает значение, которое в данный момент валидируется валидатором.
Если вы хотите получить объект, который изначально был передан валидатору, используйте {@link getRoot}.
Значение возврата
| mixed | Текущее значение, которое валидируется |
object|null getObject()
Возвращает текущий валидируемый объект.
Если валидатор в данный момент валидирует ограничение класса, возвращается объект этого класса. Если это ограничение свойства или метода get, возвращается объект, к которому принадлежит свойство/метод get.
В других случаях возвращается null.
Значение возврата
| object|null | Текущий валидируемый объект или null |
MetadataInterface|null getMetadata()
Возвращает метаданные для текущего валидируемого значения.
В реализации по умолчанию этот метод возвращает экземпляр {@link Mapping\ClassMetadataInterface}, если текущее значение является объектом, экземпляр {@link Mapping\PropertyMetadata}, если текущее значение — значение свойства, и экземпляр {@link Mapping\GetterMetadata}, если валидируемое значение является результатом метода get.
Если валидируемое значение не соответствует ни одному из этих случаев, например, если валидатор был вызван со значением и ограничением, этот метод возвращает null.
Значение возврата
| MetadataInterface|null | Метаданные текущего валидируемого значения. |
string getGroup()
Возвращает группу валидации, которая в данный момент валидируется.
Значение возврата
| string | Текущая группа валидации |
getConstraint()
string|null getClassName()
Возвращает имя класса текущего узла.
Если метаданные текущего узла не реализуют {@link Mapping\ClassMetadataInterface} или если для текущего узла нет метаданных, этот метод возвращает null.
Значение возврата
| string|null | Имя класса или null, если имя класса не найдено |
string|null getPropertyName()
Возвращает имя свойства текущего узла.
Если метаданные текущего узла не реализуют {@link PropertyMetadataInterface} или если для текущего узла нет метаданных, этот метод возвращает null.
Значение возврата
| string|null | Имя свойства или null, если имя свойства не найдено |
string getPropertyPath(string $subPath = '')
Возвращает путь к свойству значения, которое в данный момент валидируется валидатором.
Например, рассмотрим следующий граф объекта:
(Person)---($address: Address)---($street: string)
Когда экземпляр Person передаётся валидатору, путь к свойству изначально пустой. Когда свойство $address этого человека валидируется, путь к свойству — "address". Когда свойство $street связанного экземпляра Address валидируется, путь к свойству — "address.street".
Свойства объектов предваряются точкой в пути к свойству. Индексы массивов или объектов, реализующих интерфейс {@link \ArrayAccess}, заключаются в квадратные скобки. Например, если свойство в предыдущем примере — $addresses и содержит массив экземпляров Address, путь к свойству для свойства $street одного из этих адресов будет, например, "addresses[0].street".
Параметры
| string | $subPath | Необязательно. Суффикс, добавляемый к текущему пути к свойству. |
Значение возврата
| string | Текущий путь к свойству. Результат может быть пустой строкой, если валидатор в данный момент валидирует корневое значение графа валидации. |
markGroupAsValidated(string $cacheKey, string $groupHash)
Помечает объект как валидированный в определённой группе валидации.
Параметры
| string | $cacheKey | Хэш объекта |
| string | $groupHash | Имя или хэш группы, если это последовательность групп |
bool isGroupValidated(string $cacheKey, string $groupHash)
Возвращает, был ли объект валидирован в определённой группе валидации.
Параметры
| string | $cacheKey | Хэш объекта |
| string | $groupHash | Имя или хэш группы, если это последовательность групп |
Значение возврата
| bool | Был ли объект уже валидирован для этой группы |
markConstraintAsValidated(string $cacheKey, string $constraintHash)
Помечает ограничение как валидированное для объекта.
Параметры
| string | $cacheKey | Хэш объекта |
| string | $constraintHash | Хэш ограничения |
bool isConstraintValidated(string $cacheKey, string $constraintHash)
Возвращает, было ли ограничение валидировано для объекта.
Параметры
| string | $cacheKey | Хэш объекта |
| string | $constraintHash | Хэш ограничения |
Значение возврата
| bool | Было ли ограничение уже валидировано |
markObjectAsInitialized(string $cacheKey)
Помечает, что объект был инициализирован.
Параметры
| string | $cacheKey | Хэш объекта |
bool isObjectInitialized(string $cacheKey)
Возвращает, был ли объект инициализирован.
Параметры
| string | $cacheKey | Хэш объекта |
Значение возврата
| bool | Был ли объект уже инициализирован |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Validator/Context/ExecutionContext.html