File
Edit this pageWarning: You are browsing the documentation for Symfony 3.3, which is no longer maintained.
Read the updated version of this page for Symfony 6.2 (the current stable version).
File
Validates that a value is a valid "file", which can be one of the following:
- A string (or object with a
__toString()method) path to an existing file; - A valid File object (including objects of class UploadedFile).
This constraint is commonly used in forms with the FileType form field.
Tip
If the file you're validating is an image, try the Image constraint.
| Applies to | property or method |
| Options | |
| Class | File |
| Validator | FileValidator |
Basic Usage
This constraint is most commonly used on a property that will be rendered
in a form as a FileType field. For
example, suppose you're creating an author form where you can upload a "bio"
PDF for the author. In your form, the bioFile property would be a file
type. The Author class might look as follows:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;
use Symfony\Component\HttpFoundation\File\File;
class Author
{
protected $bioFile;
public function setBioFile(File $file = null)
{
$this->bioFile = $file;
}
public function getBioFile()
{
return $this->bioFile;
}
}To guarantee that the bioFile File object is valid and that it is
below a certain file size and a valid PDF, add the following:
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\File(
* maxSize = "1024k",
* mimeTypes = {"application/pdf", "application/x-pdf"},
* mimeTypesMessage = "Please upload a valid PDF"
* )
*/
protected $bioFile;
}The bioFile property is validated to guarantee that it is a real file.
Its size and mime type are also validated because the appropriate options
have been specified.
Options
maxSize
type: mixed
If set, the size of the underlying file must be below this file size in order to be valid. The size of the file can be given in one of the following formats:
| Suffix | Unit Name | value | e.g. |
|---|---|---|---|
| byte | 1 byte | 4096 | |
| k | kilobyte | 1,000 bytes | 200k |
| M | megabyte | 1,000,000 bytes | 2M |
| Ki | kibibyte | 1,024 bytes | 32Ki |
| Mi | mebibyte | 1,048,576 bytes | 8Mi |
For more information about the difference between binary and SI prefixes, see Wikipedia: Binary prefix.
binaryFormat
type: boolean default: null
When true, the sizes will be displayed in messages with binary-prefixed
units (KiB, MiB). When false, the sizes will be displayed with SI-prefixed
units (kB, MB). When null, then the binaryFormat will be guessed from
the value defined in the maxSize option.
For more information about the difference between binary and SI prefixes, see Wikipedia: Binary prefix.
mimeTypes
type: array or string
If set, the validator will check that the mime type of the underlying file is equal to the given mime type (if a string) or exists in the collection of given mime types (if an array).
You can find a list of existing mime types on the IANA website.
maxSizeMessage
type: string default: The file is too large ({{ size }} {{ suffix }}). Allowed maximum size is {{ limit }} {{ suffix }}.
The message displayed if the file is larger than the maxSize option.
mimeTypesMessage
type: string default: The mime type of the file is invalid ({{ type }}). Allowed mime types are {{ types }}.
The message displayed if the mime type of the file is not a valid mime type per the mimeTypes option.
disallowEmptyMessage
type: string default: An empty file is not allowed.
This constraint checks if the uploaded file is empty (i.e. 0 bytes). If it is, this message is displayed.
notFoundMessage
type: string default: The file could not be found.
The message displayed if no file can be found at the given path. This error
is only likely if the underlying value is a string path, as a File object
cannot be constructed with an invalid file path.
notReadableMessage
type: string default: The file is not readable.
The message displayed if the file exists, but the PHP is_readable() function
fails when passed the path to the file.
uploadIniSizeErrorMessage
type: string default: The file is too large. Allowed maximum size is {{ limit }} {{ suffix }}.
The message that is displayed if the uploaded file is larger than the upload_max_filesize
php.ini setting.
uploadFormSizeErrorMessage
type: string default: The file is too large.
The message that is displayed if the uploaded file is larger than allowed by the HTML file input field.
uploadErrorMessage
type: string default: The file could not be uploaded.
The message that is displayed if the uploaded file could not be uploaded for some unknown reason, such as the file upload failed or it couldn't be written to disk.
payload
type: mixed default: null
This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.
For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.
