Коллекция
класс Collection наследует Composite
Константы
| DEFAULT_GROUP | Имя группы, присваиваемой всем ограничениям без явного указания. |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам. |
| MISSING_FIELD_ERROR | |
| NO_SUCH_FIELD_ERROR |
Свойства
| static protected | $errorNames | ||
| mixed | $payload | Данные, специфичные для области, прикреплённые к ограничению. | из Constraint |
| array | $groups | Группы, к которым относится ограничение | из Constraint |
| $fields | |||
| $allowExtraFields | |||
| $allowMissingFields | |||
| $extraFieldsMessage | |||
| $missingFieldsMessage |
Методы
| static string | getErrorName(string $errorCode) Возвращает имя заданного кода ошибки. | из Constraint |
| __construct(mixed $options = null) Инициализирует ограничение с опциями. | ||
| __set(string $option, mixed $value) Устанавливает значение лениво инициализированной опции. | из Constraint | |
| mixed | __get(string $option) Возвращает значение лениво инициализированной опции. | из Constraint |
| bool | __isset(string $option) | из Constraint |
| addImplicitGroupName(string $group) Добавляет заданную группу, если это ограничение находится в группе «По умолчанию». | из Composite | |
| string | getDefaultOption() Возвращает имя опции по умолчанию. | из Constraint |
| array | getRequiredOptions() Возвращает имя требуемых опций. | |
| string | validatedBy() Возвращает имя класса, который валидирует данное ограничение. | из Constraint |
| string|array | getTargets() Возвращает, можно ли применить ограничение к классам, свойствам или обоим. | из Constraint |
| array | __sleep() Оптимизирует сериализованное значение для минимизации занимаемого места. | из Constraint |
| string | getCompositeOption() Возвращает имя свойства, содержащего вложенные ограничения. | |
| initializeNestedConstraints() Инициализирует вложенные ограничения. |
Подробности
статический строка 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 | Если указано недопустимое имя параметра |
bool __isset(строка $option)
Параметры
| строка | $option | Имя параметра |
Значение возврата
| bool |
addImplicitGroupName(строка $group)
Добавляет заданную группу, если данное ограничение находится в группе по умолчанию.
Параметры
| строка | $group |
строка getDefaultOption()
Возвращает имя параметра по умолчанию.
Переопределите этот метод для определения параметра по умолчанию.
Значение возврата
| строка |
См. также
| __construct() |
массив getRequiredOptions()
Возвращает имена обязательных параметров.
Переопределите этот метод, если хотите определить обязательные параметры.
Значение возврата
| массив |
строка validatedBy()
Возвращает имя класса, который валидирует данное ограничение.
По умолчанию это полное имя класса ограничения с добавленным "Validator". Вы можете переопределить этот метод, чтобы изменить это поведение.
Значение возврата
| строка |
строка|массив getTargets()
Возвращает, может ли ограничение быть применено к классам, свойствам или обоим.
Этот метод должен вернуть одно или несколько значений констант Constraint::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.
Значение возврата
| строка|массив | Одно или несколько значений констант |
массив __sleep()
Оптимизирует сериализованное значение для минимизации занимаемого места.
Значение возврата
| массив | Свойства для сериализации |
защищённый строка getCompositeOption()
Возвращает имя свойства, содержащего вложенные ограничения.
Значение возврата
| строка | Имя свойства |
защищённый initializeNestedConstraints()
Инициализирует вложенные ограничения.
Этот метод можно переопределить в подклассах для обработки вложенных ограничений, переданных в конструктор.
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/Constraints/Collection.html
