Richard Knop's Zend Framework Blog » ZF File Uploads http://blog.richardknop.com Zend Framework, PHP, MySQL, jQuery, JavaScript, AJAX, SEO, E-commerce and more Mon, 06 Sep 2010 15:49:00 +0000 en hourly 1 http://wordpress.org/?v=3.0.1 Uploading files with Zend Framework http://blog.richardknop.com/2009/10/uploading-files-with-zend-framework/ http://blog.richardknop.com/2009/10/uploading-files-with-zend-framework/#comments Wed, 14 Oct 2009 17:57:36 +0000 Richard Knop http://blog.richardknop.com/?p=479 Uploading files with Zend Framework is an easy and straightforward task. First, you need to create a form from which to upload files. For example, here is a very simple form for uploading a picture with just two fields – picture title and a file input field:

  1. class UploadPicture extends Zend_Form
  2. {
  3.     public function init()
  4.     {
  5.         $this->setMethod('post');
  6.  
  7.         $title = new Zend_Form_Element_Text('title', array(
  8.             'label' => 'Title',
  9.             'required' => false,
  10.             'filters' => array(
  11.                 'StringTrim'
  12.             ),
  13.             'validators' => array(
  14.                 array('StringLength', false, array(3, 100))
  15.             ),
  16.         ));
  17.  
  18.         $picture = new Zend_Form_Element_File('picture', array(
  19.             'label' => 'Picture',
  20.             'required' => true,
  21.             'MaxFileSize' => 2097152, // 2097152 bytes = 2 megabytes
  22.             'validators' => array(
  23.                 array('Count', false, 1),
  24.                 array('Size', false, 2097152),
  25.                 array('Extension', false, 'gif,jpg,png'),
  26.                 array('ImageSize', false, array('minwidth' => 100,
  27.                                                 'minheight' => 100,
  28.                                                 'maxwidth' => 1000,
  29.                                                 'maxheight' => 1000))
  30.             )
  31.         ));
  32.  
  33.         $picture->setValueDisabled(true);
  34.  
  35.         $submit = new Zend_Form_Element_Submit('upload_picture', array(
  36.             'label' => 'Upload the picture!'
  37.         ));
  38.  
  39.         $this->addElements(array(
  40.             $title,
  41.             $picture,
  42.             $submit
  43.         ));
  44.     }
  45. }

Besides few filters and validators, there is one important line:

  1. $picture->setValueDisabled(true);

From ZF 1.8, files are automatically received when you call $form->getValues() method. I like to receive files manually because sometimes I will want to add some new filter or validator based on values from the submitted form. So, the $element->setValueDisabled(true) disables the automatic transfer of files.

Second thing you need to do is to handle the form submission in the controller. Here is how to do that:

  1. public function uploadPictureAction()
  2. {
  3.     $request = $this->getRequest();
  4.  
  5.     $form = $this->_getForm('UploadPicture',
  6.                             $this->_helper->url('upload-picture'));
  7.  
  8.     // if POST data has been submitted
  9.     if ($request->isPost()) {
  10.         // if the UploadPicture form has been submitted and the submitted data is valid
  11.         if (isset($_POST['upload_picture']) && $form->isValid($_POST)) {
  12.  
  13.             $data = $form->getValues();
  14.  
  15.             // get the picture extension
  16.             $ext = end(explode('.', $form->picture->getFileName()));
  17.  
  18.             // you will probably want to save the picture in the database
  19.             $dbTrans = false;
  20.  
  21.             try {
  22.  
  23.                 $db = $this->_getDb();
  24.                 $dbTrans = $db->beginTransaction();
  25.  
  26.                 // query the database here
  27.  
  28.                 $db->commit();
  29.  
  30.                 // where do you want to save the image?
  31.                 $path = 'images/my-image.' . $ext;
  32.  
  33.                 // add filter for renaming the uploaded picture
  34.                 $form->picture->addFilter('Rename',
  35.                                           array('target' => $path,
  36.                                                 'overwrite' => true));
  37.  
  38.                 // upload the picture
  39.                 $form->picture->receive();                
  40.  
  41.                 $form->reset();
  42.  
  43.             } catch (Exception $e) {
  44.                 if (true === $dbTrans) {
  45.                     $db->rollBack();
  46.                 }
  47.                 // pass possible exceptions to the view
  48.                 $this->view->error = $e->getMessage();
  49.             }
  50.  
  51.         }
  52.     }
  53.  
  54.     // pass the form to the view
  55.     $this->view->form = $form;
  56. }

In case you are wondering what method I used to initialize the form, here it is (I think I’ve already posted it in one of my older entries):

  1. private function _getForm($form, $action = null)
  2. {
  3.     include APPLICATION_PATH . '/modules/' . $this->_request->getModuleName()
  4.     . '/forms/' . $form . '.php';
  5.     $form = new $form();
  6.     if (null !== $action) {
  7.         $form->setAction($action);
  8.     }
  9.     return $form;
  10. }

So, that’s it. It wasn’t too difficult, was it?

For some more details, study the Zend_Form_Element_File documentation.

]]> http://blog.richardknop.com/2009/10/uploading-files-with-zend-framework/feed/ 0