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