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) Возвращает имя заданного кода ошибки. | из Constraint |
| __construct(mixed $options = null) Инициализирует ограничение с опциями. | из Constraint | |
| __set(string $option, mixed $value) Устанавливает значение отложенно инициализированной опции. | из Constraint | |
| mixed | __get(string $option) Возвращает значение отложенно инициализированной опции. | из Constraint |
| addImplicitGroupName(string $group) Добавляет заданную группу, если данное ограничение находится в группе по умолчанию. | из Constraint | |
| string | getDefaultOption() Возвращает имя опции по умолчанию. | из Constraint |
| array | getRequiredOptions() Возвращает имена необходимых опций. | из Constraint |
| string | validatedBy() Возвращает имя класса, который валидирует это ограничение. | из Constraint |
| string|array | getTargets() Возвращает, можно ли ограничение применить к классам, свойствам или обоим. | из Constraint |
| array | __sleep() Оптимизирует сериализованное значение для минимизации занимаемого места. | из 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/2.8/Symfony/Component/Validator/Constraints/Url.html