Spec-Zone.ru › Symfony 2.7

Url

class Url extends Constraint

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

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

Свойства

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.7/Symfony/Component/Validator/Constraints/Url.html

Spec-Zone.ru

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