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