Существование
класс Существование расширяет Composite
Константы
| DEFAULT_GROUP | Имя группы, задаваемое всем ограничениям без явной группы |
| CLASS_CONSTRAINT | Помечает ограничение, которое можно применить к классам |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое можно применить к свойствам |
Свойства
| mixed | $payload | Данные, специфичные для домена, прикреплённые к ограничению | из Constraint |
| array | $groups | Группы, к которым принадлежит ограничение | из Constraint |
| $constraints |
Методы
| static string | getErrorName(int $errorCode) Возвращает имя заданного кода ошибки. | из Constraint |
| __construct(mixed $options = null) Инициализирует ограничение с параметрами. | из Composite | |
| __set(string $option, mixed $value) Устанавливает значение лениво инициализированного параметра. | из Constraint | |
| mixed | __get(string $option) Возвращает значение лениво инициализированного параметра. | из Constraint |
| addImplicitGroupName(string $group) Добавляет заданную группу, если это ограничение находится в группе По умолчанию. | из Composite | |
| string | getDefaultOption() Возвращает имя параметра по умолчанию | |
| array | getRequiredOptions() Возвращает имя необходимых параметров | из Constraint |
| string | validatedBy() Возвращает имя класса, который валидирует это ограничение | из Constraint |
| string|array | getTargets() Возвращает, можно ли применить ограничение к классам, свойствам или обоим | из Constraint |
| array | __sleep() Оптимизирует сериализованное значение, чтобы минимизировать занимаемое место. | из Constraint |
Подробности
static string getErrorName(int $errorCode)
Возвращает имя заданного кода ошибки.
Параметры
| int | $errorCode | Код ошибки |
Возвращаемое значение
| string | Имя кода ошибки |
Исключения
| InvalidArgumentException | Если код ошибки не существует |
__construct(mixed $options = null)
Инициализирует ограничение с параметрами.
Вы должны передать ассоциативный массив. Ключи должны быть именами существующих свойств в этом классе. Значения должны быть значениями для этих свойств.
В качестве альтернативы вы можете переопределить метод getDefaultOption(), чтобы вернуть имя существующего свойства. Если ассоциативный массив не передан, это свойство устанавливается вместо него.
Вы можете принудительно установить определённые параметры, переопределив getRequiredOptions(), чтобы вернуть имена этих параметров. Если какой-либо параметр не установлен здесь, выбрасывается исключение.
Параметры
| mixed | $options | Параметры (как ассоциативный массив) или значение для параметра по умолчанию (любой другой тип) |
Исключения
| InvalidOptionsException | Когда вы передаёте имена несуществующих параметров |
| MissingOptionsException | Когда вы не передаёте ни одного из параметров, возвращаемых getRequiredOptions() |
| ConstraintDefinitionException | Когда вы не передаёте ассоциативный массив, но getDefaultOption() возвращает null |
__set(string $option, mixed $value)
Устанавливает значение лениво инициализированного параметра.
Соответствующие свойства добавляются в объект при первом обращении. Таким образом, этот метод будет вызван не более одного раза на экземпляр ограничения и имя параметра.
Параметры
| string | $option | Имя параметра |
| mixed | $value | Значение для установки |
Исключения
| InvalidOptionsException | Если задано неверное имя параметра |
mixed __get(string $option)
Возвращает значение лениво инициализированного параметра.
Соответствующие свойства добавляются в объект при первом обращении. Таким образом, этот метод будет вызван не более одного раза на экземпляр ограничения и имя параметра.
Параметры
| string | $option | Имя параметра |
Возвращаемое значение
| mixed | Значение параметра |
Исключения
| InvalidOptionsException | Если задано неверное имя параметра |
addImplicitGroupName(string $group)
Добавляет заданную группу, если это ограничение находится в группе По умолчанию
Параметры
| string | $group |
string getDefaultOption()
Возвращает имя параметра по умолчанию
Переопределите этот метод, чтобы определить параметр по умолчанию.
Возвращаемое значение
| string |
array getRequiredOptions()
Возвращает имена необходимых параметров
Переопределите этот метод, если хотите определить необходимые параметры.
Возвращаемое значение
| array |
См. также
| __construct() |
string validatedBy()
Возвращает имя класса, который валидирует это ограничение
По умолчанию это полное имя класса ограничения с добавленным "Validator". Вы можете переопределить этот метод, чтобы изменить это поведение.
Возвращаемое значение
| string |
string|array getTargets()
Возвращает, можно ли применить ограничение к классам, свойствам или обоим
Этот метод должен возвращать одну или несколько констант Constraint::CLASSCONSTRAINT и Constraint::PROPERTYCONSTRAINT.
Возвращаемое значение
| string|array | Одна или несколько константных значений |
array __sleep()
Оптимизирует сериализованное значение, чтобы минимизировать занимаемое место.
Возвращаемое значение
| array | Свойства для сериализации |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/Validator/Constraints/Existence.html