Ограничение
абстрактный класс Constraint
Содержит свойства определения ограничения.
Ограничение может быть определено для класса, свойства или метода-геттера. Класс Constraint инкапсулирует всю конфигурацию, необходимую для успешной проверки этого класса, свойства или результата метода-геттера.
Экземпляры Constraint неизменяемы и сериализуемы.
Константы
| DEFAULT_GROUP | Имя группы, присвоенной всем ограничениям без явной группы. |
| CLASS_CONSTRAINT | Отмечает ограничение, которое можно применить к классам. |
| PROPERTY_CONSTRAINT | Отмечает ограничение, которое можно применить к свойствам. |
Свойства
| static protected | $errorNames | Сопоставление кодов ошибок с именами их констант. | |
| mixed | $payload | Данные, специфичные для домена, прикрепленные к ограничению. | |
| array | $groups | Группы, к которым относится ограничение |
Методы
| static string | getErrorName(string $errorCode) Возвращает имя данного кода ошибки. | |
| __construct(mixed $options = null) Инициализирует ограничение параметрами. | ||
| __set(string $option, mixed $value) Устанавливает значение параметра, инициализируемого по мере необходимости. | ||
| mixed | __get(string $option) Возвращает значение параметра, инициализируемого по мере необходимости. | |
| bool | __isset(string $option) | |
| addImplicitGroupName(string $group) Добавляет заданную группу, если данное ограничение находится в группе По умолчанию. | ||
| string | getDefaultOption() Возвращает имя параметра по умолчанию. | |
| array | getRequiredOptions() Возвращает имя необходимых параметров. | |
| string | validatedBy() Возвращает имя класса, который проверяет это ограничение. | |
| string|array | getTargets() Возвращает, можно ли применить ограничение к классам, свойствам или обоим. | |
| array | __sleep() Оптимизирует сериализованное значение, чтобы минимизировать занимаемое место. |
Подробности
static string getErrorName(string $errorCode)
Возвращает имя данного кода ошибки.
Параметры
| string | $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 | Если указано неверное имя параметра |
bool __isset(string $option)
Параметры
| string | $option | Имя параметра |
Возвращаемое значение
| bool |
addImplicitGroupName(string $group)
Добавляет заданную группу, если данное ограничение находится в группе По умолчанию.
Параметры
| string | $group |
string getDefaultOption()
Возвращает имя параметра по умолчанию.
Переопределите этот метод для определения параметра по умолчанию.
Возвращаемое значение
| string |
См. также
| __construct() |
array getRequiredOptions()
Возвращает имена необходимых параметров.
Переопределите этот метод, если хотите определить необходимые параметры.
Возвращаемое значение
| array |
См. также
| __construct() |
string validatedBy()
Возвращает имя класса, который проверяет это ограничение.
По умолчанию это полное имя класса ограничения с добавленным «Validator». Вы можете переопределить этот метод, чтобы изменить это поведение.
Возвращаемое значение
| string |
string|array getTargets()
Возвращает, можно ли применить ограничение к классам, свойствам или обоим.
Этот метод должен возвращать одну или несколько констант Constraint::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.
Возвращаемое значение
| string|array | Одно или несколько значений констант |
array __sleep()
Оптимизирует сериализованное значение, чтобы минимизировать занимаемое место.
Возвращаемое значение
| array | Свойства для сериализации |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/Constraint.html
