Url
class Url extends Constraint
Константы
| DEFAULT_GROUP | Название группы, присваиваемой всем ограничениям без явного указания группы. |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам. |
| CHECK_DNS_TYPE_ANY | |
| CHECK_DNS_TYPE_NONE | |
| CHECK_DNS_TYPE_A | |
| CHECK_DNS_TYPE_A6 | |
| CHECK_DNS_TYPE_AAAA | |
| CHECK_DNS_TYPE_CNAME | |
| CHECK_DNS_TYPE_MX | |
| CHECK_DNS_TYPE_NAPTR | |
| CHECK_DNS_TYPE_NS | |
| CHECK_DNS_TYPE_PTR | |
| CHECK_DNS_TYPE_SOA | |
| CHECK_DNS_TYPE_SRV | |
| CHECK_DNS_TYPE_TXT | |
| INVALID_URL_ERROR |
Свойства
| mixed | $payload | Данные, специфичные для домена, прикрепленные к ограничению. | из Constraint |
| array | $groups | Группы, к которым относится ограничение | из Constraint |
| $message | |||
| $dnsMessage | |||
| $protocols | |||
| $checkDNS |
Методы
| static string | getErrorName(string $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(string $errorCode)
Возвращает имя заданного кода ошибки.
Параметры
| string | $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.4/Symfony/Component/Validator/Constraints/Url.html