Spec-Zone.ru › Symfony 3.4

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 Данные, специфичные для домена, прикреплённые к ограничению. from Constraint
array $groups Группы, к которым относится ограничение. from Constraint
$version
$message

Методы

static string getErrorName(int $errorCode)

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

from Constraint
__construct(mixed $options = null)

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

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

Spec-Zone.ru

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