Файл
класс Файл расширяет 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(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 |
| __isset($option) |
Подробности
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)
Добавляет указанную группу, если данное ограничение находится в группе Default.
Параметры
| 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 | Свойства для сериализации |
__isset($option)
Параметры
| $option |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Validator/Constraints/File.html
