Существование
абстрактный класс Существование наследует от Composite
Константы
| DEFAULT_GROUP | Имя группы, присваиваемой всем ограничениям без явного указания. |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам. |
Свойства
| статический защищённый | $errorNames | Сопоставление кодов ошибок с именами их констант. | из Constraint |
| mixed | $payload | Данные, специфичные для домена, прикреплённые к ограничению. | из Constraint |
| массив | $groups | Группы, к которым относится ограничение | из Constraint |
| $constraints |
Методы
| статический строка | getErrorName(строка $errorCode) Возвращает имя заданного кода ошибки. | из Constraint |
| __construct(mixed $options = null) Инициализирует ограничение с параметрами. | из Composite | |
| __set(строка $option, mixed $value) Устанавливает значение отложенно инициализированного параметра. | из Constraint | |
| mixed | __get(строка $option) Возвращает значение отложенно инициализированного параметра. | из Constraint |
| логическое значение | __isset(строка $option) | из Constraint |
| addImplicitGroupName(строка $group) Добавляет заданную группу, если это ограничение находится в группе По умолчанию. | из Composite | |
| строка | getDefaultOption() Возвращает имя параметра по умолчанию. | |
| массив | getRequiredOptions() Возвращает имя необходимых параметров. | из Constraint |
| строка | validatedBy() Возвращает имя класса, который валидирует это ограничение. | из Constraint |
| строка или массив | getTargets() Возвращает, может ли ограничение быть применено к классам, свойствам или обоим. | из Constraint |
| массив | __sleep() Оптимизирует сериализованное значение для минимизации занимаемого места. | из Constraint |
| строка | getCompositeOption() Возвращает имя свойства, содержащего вложенные ограничения. | |
| initializeNestedConstraints() Инициализирует вложенные ограничения. | из Composite |
Подробности
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 | Если указано неверное имя параметра |
bool __isset(string $option)
Параметры
| string | $option | Имя параметра |
Значение возврата
| bool |
addImplicitGroupName(string $group)
Добавляет заданную группу, если данное ограничение находится в группе по умолчанию.
Параметры
| string | $group |
string getDefaultOption()
Возвращает имя параметра по умолчанию.
Переопределите этот метод, чтобы определить параметр по умолчанию.
Значение возврата
| string |
array getRequiredOptions()
Возвращает имена необходимых параметров.
Переопределите этот метод, если хотите определить необходимые параметры.
Значение возврата
| array |
См. также
| __construct() |
string validatedBy()
Возвращает имя класса, который валидирует это ограничение.
По умолчанию это полное имя класса ограничения с добавленным "Validator". Вы можете переопределить этот метод, чтобы изменить это поведение.
Значение возврата
| string |
string|array getTargets()
Возвращает, можно ли установить ограничение на классы, свойства или оба.
Этот метод должен вернуть одну или несколько констант Constraint::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.
Значение возврата
| string|array | Одно или несколько значений констант |
array __sleep()
Оптимизирует сериализованное значение для минимизации занимаемого места.
Значение возврата
| array | Свойства для сериализации |
protected string getCompositeOption()
Возвращает имя свойства, содержащего вложенные ограничения.
Значение возврата
| string | Имя свойства |
protected initializeNestedConstraints()
Инициализирует вложенные ограничения.
Этот метод можно переопределить в подклассах для обработки вложенных ограничений, переданных в конструктор.
См. также
| Collection::initializeNestedConstraints |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/Constraints/Existence.html