Файл
класс Файл расширяет Constraint
Константы
| DEFAULT_GROUP | Имя группы, присваиваемой всем ограничениям без явного указания группы. |
| CLASS_CONSTRAINT | Помечает ограничение, которое может быть применено к классам. |
| PROPERTY_CONSTRAINT | Помечает ограничение, которое может быть применено к свойствам. |
| NOT_FOUND_ERROR | |
| NOT_READABLE_ERROR | |
| EMPTY_ERROR | |
| TOO_LARGE_ERROR | |
| INVALID_MIME_TYPE_ERROR |
Свойства
| mixed | $payload | Данные, специфичные для домена, прикрепленные к ограничению. | из Constraint |
| array | $groups | Группы, к которым относится ограничение | из Constraint |
| $binaryFormat | |||
| $mimeTypes | |||
| $notFoundMessage | |||
| $notReadableMessage | |||
| $maxSizeMessage | |||
| $mimeTypesMessage | |||
| $disallowEmptyMessage | |||
| $uploadIniSizeErrorMessage | |||
| $uploadFormSizeErrorMessage | |||
| $uploadPartialErrorMessage | |||
| $uploadNoFileErrorMessage | |||
| $uploadNoTmpDirErrorMessage | |||
| $uploadCantWriteErrorMessage | |||
| $uploadExtensionErrorMessage | |||
| $uploadErrorMessage |
Методы
| static string | getErrorName(int $errorCode) Возвращает имя заданного кода ошибки. | из Constraint |
| __construct(mixed $options = null) Инициализирует ограничение с параметрами. | ||
| __set(string $option, mixed $value) Устанавливает значение параметра, инициализированного по требованию. | ||
| mixed | __get(string $option) Возвращает значение параметра, инициализированного по требованию. | |
| 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/File.html