Ограничение
класс Constraint
Содержит свойства определения ограничения.
Ограничение может быть определено для класса, свойства или метода-геттера. Класс Constraint encapsulates всю конфигурацию, необходимую для успешной проверки этого класса, свойства или результата метода-геттера.
Экземпляры Constraint неизменяемы и сериализуемы.
Константы
| DEFAULT_GROUP | Имя группы, задаваемое всем ограничениям без явной группы. |
| CLASS_CONSTRAINT | Помечает ограничение, которое можно применить к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое можно применить к свойствам. |
Свойства
| mixed | $payload | Данные, специфичные для домена, прикрепленные к ограничению. | |
| array | $groups | Группы, к которым относится ограничение |
Методы
| static string | getErrorName(string $errorCode) Возвращает имя заданного кода ошибки. | |
| __construct(mixed $options = null) Инициализирует ограничение параметрами. | ||
| __set(string $option, mixed $value) Устанавливает значение отложенно инициализированного параметра. | ||
| mixed | __get(string $option) Возвращает значение отложенно инициализированного параметра. | |
| addImplicitGroupName(string $group) Добавляет заданную группу, если это ограничение находится в группе Default. | ||
| 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 | Если задано неверное имя параметра |
addImplicitGroupName(string $group)
Добавляет заданную группу, если это ограничение находится в группе Default.
Параметры
| 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.
http://api.symfony.com/3.2/Symfony/Component/Validator/Constraint.html
