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