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 :class:`Symfony\\Component\\HttpFoundation\\File\\File` object (including objects of :class:`Symfony\\Component\\HttpFoundation\\File\\UploadedFile` class). This constraint is commonly used in forms with the :doc:`FileType ` form field. .. tip:: If the file you're validating is an image, try the :doc:`Image ` constraint. ========== =================================================================== Applies to :ref:`property or method ` Options - `binaryFormat`_ - `disallowEmptyMessage`_ - `groups`_ - `maxSize`_ - `maxSizeMessage`_ - `mimeTypes`_ - `mimeTypesMessage`_ - `notFoundMessage`_ - `notReadableMessage`_ - `payload`_ - `uploadCantWriteErrorMessage`_ - `uploadErrorMessage`_ - `uploadExtensionErrorMessage`_ - `uploadFormSizeErrorMessage`_ - `uploadIniSizeErrorMessage`_ - `uploadNoFileErrorMessage`_ - `uploadNoTmpDirErrorMessage`_ - `uploadPartialErrorMessage`_ Class :class:`Symfony\\Component\\Validator\\Constraints\\File` Validator :class:`Symfony\\Component\\Validator\\Constraints\\FileValidator` ========== =================================================================== Basic Usage ----------- This constraint is most commonly used on a property that will be rendered in a form as a :doc:`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:: // src/Entity/Author.php namespace App\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: .. configuration-block:: .. code-block:: php-annotations // src/Entity/Author.php namespace App\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; } .. code-block:: yaml # config/validator/validation.yaml App\Entity\Author: properties: bioFile: - File: maxSize: 1024k mimeTypes: [application/pdf, application/x-pdf] mimeTypesMessage: Please upload a valid PDF .. code-block:: xml .. code-block:: php // src/Entity/Author.php namespace App\Entity; use Symfony\Component\Validator\Constraints as Assert; use Symfony\Component\Validator\Mapping\ClassMetadata; class Author { public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('bioFile', new Assert\File([ 'maxSize' => '1024k', 'mimeTypes' => [ 'application/pdf', 'application/x-pdf', ], 'mimeTypesMessage' => 'Please upload a valid PDF', ])); } } 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. .. include:: /reference/constraints/_empty-values-are-valid.rst.inc Options ------- 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`_. 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. You can use the following parameters in this message: =============== ============================================================== Parameter Description =============== ============================================================== ``{{ file }}`` Absolute file path ``{{ name }}`` Base file name =============== ============================================================== .. include:: /reference/constraints/_groups-option.rst.inc 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 Example ====== ========= =============== ======== (none) 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`_. 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. You can use the following parameters in this message: ================ ============================================================= Parameter Description ================ ============================================================= ``{{ file }}`` Absolute file path ``{{ limit }}`` Maximum file size allowed ``{{ name }}`` Base file name ``{{ size }}`` File size of the given file ``{{ suffix }}`` Suffix for the used file size unit (see above) ================ ============================================================= 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`_. .. note:: When using this constraint on a :doc:`FileType field `, the value of the ``mimeTypes`` option is also used in the ``accept`` attribute of the related ```` HTML element. This behavior is applied only when using :ref:`form type guessing ` (i.e. the form type is not defined explicitly in the ``->add()`` method of the form builder) and when the field doesn't define its own ``accept`` value. 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. You can use the following parameters in this message: =============== ============================================================== Parameter Description =============== ============================================================== ``{{ file }}`` Absolute file path ``{{ name }}`` Base file name ``{{ type }}`` The MIME type of the given file ``{{ types }}`` The list of allowed MIME types =============== ============================================================== 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. You can use the following parameters in this message: =============== ============================================================== Parameter Description =============== ============================================================== ``{{ file }}`` Absolute 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. You can use the following parameters in this message: =============== ============================================================== Parameter Description =============== ============================================================== ``{{ file }}`` Absolute file path =============== ============================================================== .. include:: /reference/constraints/_payload-option.rst.inc uploadCantWriteErrorMessage ~~~~~~~~~~~~~~~~~~~~~~~~~~~ **type**: ``string`` **default**: ``Cannot write temporary file to disk.`` The message that is displayed if the uploaded file can't be stored in the temporary folder. This message has no parameters. 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. This message has no parameters. uploadExtensionErrorMessage ~~~~~~~~~~~~~~~~~~~~~~~~~~~ **type**: ``string`` **default**: ``A PHP extension caused the upload to fail.`` The message that is displayed if a PHP extension caused the file upload to fail. This message has no parameters. 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. This message has no parameters. 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. You can use the following parameters in this message: ================ ============================================================= Parameter Description ================ ============================================================= ``{{ limit }}`` Maximum file size allowed ``{{ suffix }}`` Suffix for the used file size unit (see above) ================ ============================================================= uploadNoFileErrorMessage ~~~~~~~~~~~~~~~~~~~~~~~~ **type**: ``string`` **default**: ``No file was uploaded.`` The message that is displayed if no file was uploaded. This message has no parameters. uploadNoTmpDirErrorMessage ~~~~~~~~~~~~~~~~~~~~~~~~~~ **type**: ``string`` **default**: ``No temporary folder was configured in php.ini.`` The message that is displayed if the php.ini setting ``upload_tmp_dir`` is missing. This message has no parameters. uploadPartialErrorMessage ~~~~~~~~~~~~~~~~~~~~~~~~~ **type**: ``string`` **default**: ``The file was only partially uploaded.`` The message that is displayed if the uploaded file is only partially uploaded. This message has no parameters. .. _`IANA website`: http://www.iana.org/assignments/media-types/media-types.xhtml .. _`Wikipedia: Binary prefix`: https://en.wikipedia.org/wiki/Binary_prefix