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