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