Spec-Zone.ru › Symfony 3.0

Ip

class Ip extends Constraint

Проверяет, является ли значение корректным IP-адресом.

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

DEFAULT_GROUP

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

CLASS_CONSTRAINT

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

PROPERTY_CONSTRAINT

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

V4
V6
ALL
V4_NO_PRIV
V6_NO_PRIV
ALL_NO_PRIV
V4_NO_RES
V6_NO_RES
ALL_NO_RES
V4_ONLY_PUBLIC
V6_ONLY_PUBLIC
ALL_ONLY_PUBLIC
INVALID_IP_ERROR

Свойства

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

Методы

static string getErrorName(int $errorCode)

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

из Constraint
__construct(mixed $options = null)

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

__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/3.0/Symfony/Component/Validator/Constraints/Ip.html

Spec-Zone.ru

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