Zend Framework 2 : Create Simple Upload Form with File Validation

Zend Framework 2 has Zend\File\Transfer component that can provide file transfer need for our application. We can add Files validator and pass error message to Zend\Form component object, that can be retrieve by view if process was failed. We can add another validator instead of Upload validator that registered by default in Http Adapter.

For example, i have upload form like this :

The code form will be like the following :

// filename : module/Test/src/Test/Form/ProfileForm.php
namespace Test\Form;

use Zend\Form\Form;

class ProfileForm extends Form
{
    public function __construct($name = null)
    {
        parent::__construct('Profile');
        $this->setAttribute('method', 'post');
        $this->setAttribute('enctype','multipart/form-data');
        
        $this->add(array(
            'name' => 'profilename',
            'attributes' => array(
                'type'  => 'text',
            ),
            'options' => array(
                'label' => 'Profile Name',
            ),
        ));

        
        $this->add(array(
            'name' => 'fileupload',
            'attributes' => array(
                'type'  => 'file',
            ),
            'options' => array(
                'label' => 'File Upload',
            ),
        )); 
        
        
        $this->add(array(
            'name' => 'submit',
            'attributes' => array(
                'type'  => 'submit',
                'value' => 'Upload Now'
            ),
        )); 
    }
}

By that code above, we can call ProfileForm from action Controller :

// filename : module/Test/src/Test/Controller/ProfileController.php
namespace Test\Controller;

use Zend\Mvc\Controller\AbstractActionController;
use Test\Model\Profile;

class ProfileController extends AbstractActionController
{
    public function addAction()
    {
        $form = new ProfileForm();
        return array('form' => $form);
    }
}

For view, we can write the following :

// filename : module/Test/view/test/profile/add.phtml
$form = $this->form;
$form->setAttribute('action',
                    $this->url('Test/profile', //your route name ...
                               array('controller'=>'profile', 'action' => 'add'))); 
$form->prepare();

echo $this->form()->openTag($form);
echo $this->formRow($form->get('profilename'));

echo $this->formRow($form->get('fileupload'));

echo $this->formSubmit($form->get('submit'));
echo $this->form()->closeTag();

Just that, and form will be created. How we filter the input ? we can create input filter by following :

// filename : module/Test/src/Test/Model/Profile.php
namespace Test\Model;

use Zend\InputFilter\Factory as InputFactory;
use Zend\InputFilter\InputFilter;
use Zend\InputFilter\InputFilterAwareInterface;
use Zend\InputFilter\InputFilterInterface;

class Profile implements InputFilterAwareInterface
{
    public $profilename;
    public $fileupload;
    protected $inputFilter;
    
    public function exchangeArray($data)
    {
        $this->profilename  = (isset($data['profilename']))  ? $data['profilename']     : null; 
        $this->fileupload  = (isset($data['fileupload']))  ? $data['fileupload']     : null; 
    } 
    
    public function setInputFilter(InputFilterInterface $inputFilter)
    {
        throw new \Exception("Not used");
    }
    
    public function getInputFilter()
    {
        if (!$this->inputFilter) {
            $inputFilter = new InputFilter();
            $factory     = new InputFactory();
             
            $inputFilter->add(
                $factory->createInput(array(
                    'name'     => 'profilename',
                    'required' => true,
                    'filters'  => array(
                        array('name' => 'StripTags'),
                        array('name' => 'StringTrim'),
                    ),
                    'validators' => array(
                        array(
                            'name'    => 'StringLength',
                            'options' => array(
                                'encoding' => 'UTF-8',
                                'min'      => 1,
                                'max'      => 100,
                            ),
                        ),
                    ),
                ))
            );
            
            $inputFilter->add(
                $factory->createInput(array(
                    'name'     => 'fileupload',
                    'required' => true,
                ))
            );
            
            $this->inputFilter = $inputFilter;
        }
        
        return $this->inputFilter;
    }
}

Now, we can set inputFilter to form from action controller, pass data post and file to form object, and check the validation :

// filename : module/Test/src/Test/Controller/ProfileController.php
namespace Test\Controller;

use Zend\Mvc\Controller\AbstractActionController;

use Test\Model\Profile,
    Test\Form\ProfileForm;

class ProfileController extends AbstractActionController
{
    public function addAction()
    {
        $form = new ProfileForm();
        $request = $this->getRequest();  
        if ($request->isPost()) {
            
            $profile = new Profile();
            $form->setInputFilter($profile->getInputFilter());
            
            $nonFile = $request->getPost()->toArray();
            $File    = $this->params()->fromFiles('fileupload');
            $data = array_merge(
                 $nonFile, //POST 
                 array('fileupload'=> $File['name']) //FILE...
             );
            
            /** if you're using ZF >= 2.1.1  
              *  you should update to the latest ZF2 version
              *  and assign $data like the following 
                   $data    = array_merge_recursive(
                        $this->getRequest()->getPost()->toArray(),           
                       $this->getRequest()->getFiles()->toArray()
                   );
             */

            //set data post and file ...    
            $form->setData($data);
             
            if ($form->isValid()) {
                //HEY, FORM IS VALID...
            } 
        }
         
        return array('form' => $form);
    }
}

If form is valid, we can save file to directory we desired by \Zend\File\Transfer\Adapter\Http component, and add other validation, for example, add Size validation to validate minimal size will be accepted to be uploaded.

//import Size validator...
use use Zend\Validator\File\Size;
.........
if ($form->isValid()) {
    
    $size = new Size(array('min'=>2000000)); //minimum bytes filesize
    
    $adapter = new \Zend\File\Transfer\Adapter\Http(); 
    //validator can be more than one...
    $adapter->setValidators(array($size), $File['name']);
    
    if (!$adapter->isValid()){
        $dataError = $adapter->getMessages();
        $error = array();
        foreach($dataError as $key=>$row)
        {
            $error[] = $row;
        } //set formElementErrors
        $form->setMessages(array('fileupload'=>$error ));
    } else {
        $adapter->setDestination(dirname(__DIR__).'/assets');
        if ($adapter->receive($File['name'])) {
            $profile->exchangeArray($form->getData());
            echo 'Profile Name '.$profile->profilename.' upload '.$profile->fileupload;
        }
    }  
} 

Finally, the complete controller source code :

// filename : module/Test/src/Test/Controller/ProfileController.php
namespace Test\Controller;

use Zend\Mvc\Controller\AbstractActionController;
    
use Test\Model\Profile,
    Test\Form\ProfileForm;

use Zend\Validator\File\Size;

class ProfileController extends AbstractActionController
{
    public function addAction()
    {
        $form = new ProfileForm();
        $request = $this->getRequest();  
        if ($request->isPost()) {
            
            $profile = new Profile();
            $form->setInputFilter($profile->getInputFilter());
            
            $nonFile = $request->getPost()->toArray();
            $File    = $this->params()->fromFiles('fileupload');
            $data = array_merge(
                 $nonFile,
                 array('fileupload'=> $File['name'])
             );
            //set data post and file ...    
            $form->setData($data);
             
            if ($form->isValid()) {
                
                $size = new Size(array('min'=>2000000)); //minimum bytes filesize
                
                $adapter = new \Zend\File\Transfer\Adapter\Http(); 
                $adapter->setValidators(array($size), $File['name']);
                if (!$adapter->isValid()){
                    $dataError = $adapter->getMessages();
                    $error = array();
                    foreach($dataError as $key=>$row)
                    {
                        $error[] = $row;
                    }
                    $form->setMessages(array('fileupload'=>$error ));
                } else {
                    $adapter->setDestination(dirname(__DIR__).'/assets');
                    if ($adapter->receive($File['name'])) {
                        $profile->exchangeArray($form->getData());
                        echo 'Profile Name '.$profile->profilename.' upload '.$profile->fileupload;
                    }
                }  
            } 
        }
         
        return array('form' => $form);
    }
}

You can separate File Transfer process in another function or model if you want. If Size validation failed, the form will show this :

References :
1.http://stackoverflow.com/questions/11690320/how-do-i-pass-file-and-post-data-into-a-form
2.http://zf2.readthedocs.org/en/latest/user-guide/forms-and-actions.html