Spec-Zone.ru › Symfony 3.0

Регулярные выражения

класс Regex расширяет Constraint

Постоянные значения

DEFAULT_GROUP

Имя группы, присваиваемой всем ограничениям без явного указания.

CLASS_CONSTRAINT

Отмечает ограничение, которое может быть применено к классам.

PROPERTY_CONSTRAINT

Отмечает ограничение, которое может быть применено к свойствам.

REGEX_FAILED_ERROR

Свойства

mixed $payload Данные, специфичные для домена, прикреплённые к ограничению. из Constraint
array $groups Группы, к которым относится ограничение из Constraint
$message
$pattern
$htmlPattern
$match

Методы

static string getErrorName(int $errorCode)

Возвращает имя заданного кода ошибки.

из Constraint
__construct(mixed $options = null)

Инициализирует ограничение с параметрами.

из Constraint
__set(string $option, mixed $value)

Устанавливает значение параметра, инициализированного по требованию.

из Constraint
mixed __get(string $option)

Возвращает значение параметра, инициализированного по требованию.

из Constraint
addImplicitGroupName(string $group)

Добавляет заданную группу, если это ограничение находится в группе Default.

из Constraint
string getDefaultOption()

Возвращает имя параметра по умолчанию.

array getRequiredOptions()

Возвращает имена обязательных параметров.

string validatedBy()

Возвращает имя класса, который валидирует данное ограничение.

из Constraint
string|array getTargets()

Возвращает, можно ли применить ограничение к классам, свойствам или обоим.

из Constraint
array __sleep()

Оптимизирует сериализованное значение для минимизации занимаемого места.

из Constraint
string|null getHtmlPattern()

Преобразует htmlPattern в подходящий формат для атрибута pattern HTML5.

Подробности

static string getErrorName(int $errorCode)

Возвращает имя заданного кода ошибки.

Параметры

int $errorCode Код ошибки

Значение результата

string Имя кода ошибки

Исключения

InvalidArgumentException Если код ошибки не существует

__construct(mixed $options = null)

Инициализирует ограничение с параметрами.

Вы должны передать ассоциативный массив. Ключи должны быть именами существующих свойств в этом классе. Значения должны быть значениями для этих свойств.

В качестве альтернативы вы можете переопределить метод getDefaultOption(), чтобы вернуть имя существующего свойства. Если не передается ассоциативный массив, устанавливается это свойство.

Вы можете принудительно задать определенные параметры, переопределив getRequiredOptions(), чтобы вернуть имена этих параметров. Если какой-либо параметр не задан здесь, генерируется исключение.

Параметры

mixed $options Параметры (как ассоциативный массив) или значение для параметра по умолчанию (любой другой тип)

Исключения

InvalidOptionsException Когда вы передаёте имена несуществующих параметров
MissingOptionsException Когда вы не передаёте ни одного из параметров, возвращаемых getRequiredOptions()
ConstraintDefinitionException Когда вы не передаёте ассоциативный массив, а getDefaultOption() возвращает null

__set(string $option, mixed $value)

Устанавливает значение параметра, инициализированного по требованию.

Соответствующие свойства добавляются в объект при первом доступе. Таким образом, этот метод будет вызван не более одного раза на экземпляр ограничения и имя параметра.

Параметры

string $option Имя параметра
mixed $value Значение для установки

Исключения

InvalidOptionsException Если задано неверное имя параметра

mixed __get(string $option)

Возвращает значение параметра, инициализированного по требованию.

Соответствующие свойства добавляются в объект при первом доступе. Таким образом, этот метод будет вызван не более одного раза на экземпляр ограничения и имя параметра.

Параметры

string $option Имя параметра

Значение результата

mixed Значение параметра

Исключения

InvalidOptionsException Если задано неверное имя параметра

addImplicitGroupName(string $group)

Добавляет заданную группу, если это ограничение находится в группе Default.

Параметры

string $group

string getDefaultOption()

Возвращает имя параметра по умолчанию.

Переопределите этот метод для определения параметра по умолчанию.

Значение результата

string

array getRequiredOptions()

Возвращает имена обязательных параметров.

Переопределите этот метод, если хотите определить обязательные параметры.

Значение результата

array

string validatedBy()

Возвращает имя класса, который валидирует данное ограничение.

По умолчанию это полное имя класса ограничения с суффиксом "Validator". Вы можете переопределить этот метод, чтобы изменить это поведение.

Значение результата

string

string|array getTargets()

Возвращает, можно ли применить ограничение к классам, свойствам или обоим.

Этот метод должен возвращать одно или несколько значений констант Constraint::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.

Значение результата

string|array Одно или несколько значений констант

array __sleep()

Оптимизирует сериализованное значение для минимизации занимаемого места.

Значение результата

array Свойства для сериализации

string|null getHtmlPattern()

Преобразует htmlPattern в подходящий формат для атрибута pattern HTML5.

Пример: /^[a-z]+$/ будет преобразован в [a-z]+. Однако, если указаны параметры, преобразование невозможно.

Шаблон также игнорируется, если match=false, так как шаблон должен быть изменен на обратный перед применением.

Значение результата

string|null

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Validator/Constraints/Regex.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API