Regex
class Regex extends Constraint
Постоянные значения
| DEFAULT_GROUP | Название группы, присваиваемой всем ограничениям без явного указания группы. |
| CLASS_CONSTRAINT | Помечает ограничение, которое можно применить к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое можно применить к свойствам. |
| REGEX_FAILED_ERROR |
Свойства
| static protected | $errorNames | ||
| mixed | $payload | Данные, специфичные для домена, прикрепленные к ограничению. | из Constraint |
| array | $groups | Группы, к которым относится ограничение | из Constraint |
| $message | |||
| $pattern | |||
| $htmlPattern | |||
| $match |
Методы
| static string | getErrorName(string $errorCode) Возвращает имя заданного кода ошибки. | из Constraint |
| __construct(mixed $options = null) Инициализирует ограничение с параметрами. | из Constraint | |
| __set(string $option, mixed $value) Устанавливает значение параметра, инициализированного по требованию. | из Constraint | |
| mixed | __get(string $option) Возвращает значение параметра, инициализированного по требованию. | из Constraint |
| bool | __isset(string $option) | из Constraint |
| addImplicitGroupName(string $group) Добавляет заданную группу, если данное ограничение находится в группе по умолчанию. | из Constraint | |
| string | getDefaultOption() Возвращает имя параметра по умолчанию. | |
| array | getRequiredOptions() Возвращает имя обязательных параметров. | |
| string | validatedBy() Возвращает имя класса, который валидирует данное ограничение. | из Constraint |
| string|array | getTargets() Возвращает, можно ли ограничение применить к классам, свойствам или обоим. | из Constraint |
| array | __sleep() Оптимизирует сериализованное значение для минимизации занимаемого места. | из Constraint |
| string|null | getHtmlPattern() Преобразует htmlPattern в подходящий формат для атрибута pattern HTML5. |
Подробности
static строка 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()
Возвращает имя параметра по умолчанию.
Переопределите этот метод для определения параметра по умолчанию.
Значение возврата
| строка |
массив getRequiredOptions()
Возвращает имена обязательных параметров.
Переопределите этот метод, если хотите определить обязательные параметры.
Значение возврата
| массив |
строка validatedBy()
Возвращает имя класса, который проверяет это ограничение.
По умолчанию это полное имя класса ограничения, дополненное "Validator". Вы можете переопределить этот метод, чтобы изменить это поведение.
Значение возврата
| строка |
строка|массив getTargets()
Возвращает, может ли ограничение быть применено к классам, свойствам или обоим.
Этот метод должен вернуть одну или несколько констант Constraint::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.
Значение возврата
| строка|массив | Одно или несколько значений констант |
массив __sleep()
Оптимизирует сериализованное значение для минимизации занимаемого места.
Значение возврата
| массив | Свойства для сериализации |
строка|null getHtmlPattern()
Преобразует htmlPattern в подходящий формат для HTML5 pattern.
Пример: /^[a-z]+$/ будет преобразован в [a-z]+ Однако, если параметры указаны, он не может быть преобразован.
Шаблон также игнорируется, если match=false, поскольку шаблон должен быть затем изменен перед применением.
Значение возврата
| строка|null |
См. также
| http://dev.w3.org/html5/spec/single-page.html#the-pattern-attribute |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/Constraints/Regex.html
