Package Home

Zend Framework 2 Documentation (Manual)

PHK Home

File: /_sources/modules/zend.validator.file.upload-file.txt

Size:774
Storage flags:no_autoload,compress/gzip (53%)

.. _zend.validator.file.upload-file:

UploadFile
----------

``Zend\Validator\File\UploadFile`` checks whether a single file has been uploaded via a form ``POST``
and will return descriptive messages for any upload errors.

.. note::

   :ref:`Zend\\InputFilter\\FileInput <zend.input-filter.file-input>` will automatically
   prepend this validator in it's validation chain.

.. _zend.validator.file.upload-file.usage:

Usage Examples
^^^^^^^^^^^^^^

.. code-block:: php
   :linenos:

   use Zend\Http\PhpEnvironment\Request;

   $request = new Request();
   $files   = $request->getFiles();
   // i.e. $files['my-upload']['error'] == 0

   $validator = new \Zend\Validator\File\UploadFile();
   if ($validator->isValid($files['my-upload'])) {
       // file is valid
   }

For more information about the PHK package format: http://phk.tekwire.net