Zend Framework: File upload using Zend_Form_Element_File

hello All ,

This post will be helpful for all people who are wishing to get some practicle example for using ‘Zend_Form_Element_File’ of Zend framework’s ‘Zend_Form’.
There will 3 steps to implement it:

1. Create form with ‘enctype’ set to ‘multipart/form-data’ using Zend_Form
2. Create File upload box using Zend_Form_Element_File
3. Upload the file on server and get uploaded file’s detail for saving in database

So Let’s explore these steps one by one:

Step 1: Create form with ‘enctype’ set to ‘multipart/form-data’ using Zend_Form

Setting Form ‘enctype’ to ‘mutipart/form-data’ in Zend framework appears difficult if you don’t know about it. In real it is very simple if you ever got a chance to observe setAttrib() function for setting attributes of any element. Lemme give you an example.

(For example, i am creating ‘DocumentForm’ Class that will handle Document uploading Form)

First thing that you’ll need is to set Zend_Form’s ecryption type to ‘multipart/form-data’. This is must for file uploading.
So here it goes ..

class DocumentForm extends Zend_Form
{
    public function __construct($options = null)
    {
	parent::__construct($options);
  	// setting Form name,Form action and Form Ecryption type
	$this->setName('document');
	$this->setAction("");
	$this->setAttrib('enctype', 'multipart/form-data');
    }
}

Above code will create a form named ‘document’ with encryption type ‘multipart/form-data’. Now lets move to next step.

Step2: Create File upload box using Zend_Form_Element_File

You may notice some new code in Bold here:

class DocumentForm extends Zend_Form
{
	 public function __construct($options = null)
	 {
		 parent::__construct($options);
		 // setting Form name, Form action and Form Ecryption type
		 $this->setName(’document’);
		 $this->setAction(”");
		 $this->setAttrib(’enctype’, ‘multipart/form-data’);
		 
		 // creating object for Zend_Form_Element_File
		 $doc_file = new Zend_Form_Element_File(’doc_path’);
		 $doc_file->setLabel(’Document File Path’)
				  ->setRequired(true);

		 // creating object for submit button
		 $submit = new Zend_Form_Element_Submit(’submit’);
		 $submit->setLabel(’Upload File’)
				 ->setAttrib(’id’, ’submitbutton’);

		// adding elements to form Object
		$this->addElements(array($doc_file, $submit));
	 }
}

Bold lines in above code will populate a File Element along with a Submit button on Form.

Now user will select the file for uploading and press the Submit button,so here comes our step 3.

Step 3: Upload the file on server and get uploaded file’s detail for saving in database

This is last but most important step of the process that saves the file on server and returns back file upload details. Above Form will be called by some Controller’s Action so here comes my Controller and Action that will show and handle this form.

class DocumentForm extends Zend_Form
{
 function addAction()
 {
 $form = new DocumentForm();
 $this->view->form = $form;

 if ($this->_request->isPost()) {

 $formData = $this->_request->getPost();
 if ($form->isValid($formData)) {

 /* Uploading Document File on Server */
 $upload = new Zend_File_Transfer_Adapter_Http();
 $upload->setDestination("/uploads/files/");
 try {
 // upload received file(s)
 $upload->receive();
 } catch (Zend_File_Transfer_Exception $e) {
 $e->getMessage();
 }

 // so, Finally lets See the Data that we received on Form Submit
 $uploadedData = $form->getValues();
 Zend_Debug::dump($uploadedData, 'Form Data:');

 // you MUST use following functions for knowing about uploaded file 
 # Returns the file name for 'doc_path' named file element
 $name = $upload->getFileName('doc_path');

 # Returns the size for 'doc_path' named file element 
 # Switches of the SI notation to return plain numbers
 $upload->setOption(array('useByteString' => false));
 $size = $upload->getFileSize('doc_path');

 # Returns the mimetype for the 'doc_path' form element
 $mimeType = $upload->getMimeType('doc_path');

 // following lines are just for being sure that we got data
 print "Name of uploaded file: $name 
";
 print "File Size: $size 
";
 print "File's Mime Type: $mimeType";

 // New Code For Zend Framework :: Rename Uploaded File
 $renameFile = 'newName.jpg';

 $fullFilePath = '/images/'.$renameFile;

 // Rename uploaded file using Zend Framework
 $filterFileRename = new Zend_Filter_File_Rename(array('target' => $fullFilePath, 'overwrite' => true));

 $filterFileRename -> filter($name);

 exit; 
 } 

 } else {

 // this line will be called if data was not submited
 $form->populate($formData);
 }
 }
}

and thats it!

please let me know if you guys feel anything more to add in it. :)For more advancements in above code, please see the File upload manual here: http://zendframework.com/manual/en/zend.file.html