Файл
класс File расширяет 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 | |||
| int | $maxSize |
Методы
| static string | getErrorName(string $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 |
| __isset($option) |
Подробности
static строка getErrorName(строка $errorCode)
Возвращает имя заданного кода ошибки.
Параметры
| строка | $errorCode | Код ошибки |
Значение возврата
| строка | Имя кода ошибки |
Исключения
| InvalidArgumentException | Если код ошибки не существует |
__construct(смешанный $options = null)
Инициализирует ограничение параметрами.
Вы должны передать ассоциативный массив. Ключи должны быть именами существующих свойств в этом классе. Значения должны быть значением для этих свойств.
В качестве альтернативы вы можете переопределить метод getDefaultOption(), чтобы вернуть имя существующего свойства. Если ассоциативный массив не передан, устанавливается это свойство.
Вы можете принудительно установить определенные параметры, переопределив getRequiredOptions(), чтобы вернуть имена этих параметров. Если какой-либо параметр здесь не установлен, генерируется исключение.
Параметры
| смешанный | $options | Параметры (как ассоциативный массив) или значение для параметра по умолчанию (любой другой тип) |
Исключения
| InvalidOptionsException | Когда вы передаете имена несуществующих параметров |
| MissingOptionsException | Когда вы не передаете ни одного из параметров, возвращённых getRequiredOptions() |
| ConstraintDefinitionException | Когда вы не передаёте ассоциативный массив, но getDefaultOption() возвращает null |
__set(строка $option, смешанный $value)
Устанавливает значение параметра, инициализируемого по мере необходимости.
Соответствующие свойства добавляются в объект при первом доступе. Следовательно, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя параметра.
Параметры
| строка | $option | Имя параметра |
| смешанный | $value | Значение для установки |
Исключения
| InvalidOptionsException | Если задано неверное имя параметра |
смешанный __get(строка $option)
Возвращает значение параметра, инициализируемого по мере необходимости.
Соответствующие свойства добавляются в объект при первом доступе. Следовательно, этот метод будет вызываться не более одного раза на экземпляр ограничения и имя параметра.
Параметры
| строка | $option | Имя параметра |
Значение возврата
| смешанный | Значение параметра |
Исключения
| InvalidOptionsException | Если задано неверное имя параметра |
addImplicitGroupName(строка $group)
Добавляет заданную группу, если это ограничение находится в группе по умолчанию.
Параметры
| строка | $group |
строка getDefaultOption()
Возвращает имя параметра по умолчанию.
Переопределите этот метод для определения параметра по умолчанию.
Значение возврата
| строка |
См. также
| __construct() |
массив getRequiredOptions()
Возвращает имена необходимых параметров.
Переопределите этот метод, если хотите определить необходимые параметры.
Значение возврата
| массив |
См. также
| __construct() |
строка validatedBy()
Возвращает имя класса, который валидирует это ограничение.
По умолчанию это полное имя класса ограничения с добавленным "Validator". Вы можете переопределить этот метод, чтобы изменить это поведение.
Значение возврата
| строка |
строка|массив getTargets()
Возвращает, может ли ограничение быть применено к классам, свойствам или обоим.
Этот метод должен вернуть одну или несколько констант Constraint::CLASS_CONSTRAINT и Constraint::PROPERTY_CONSTRAINT.
Значение возврата
| строка|массив | Одно или несколько значений констант |
массив __sleep()
Оптимизирует сериализованное значение, чтобы минимизировать занимаемое место.
Значение возврата
| массив | Свойства для сериализации |
__isset($option)
Параметры
| $option |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Validator/Constraints/File.html
