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