Tuesday, June 30, 2009

Zend Framework and Dojo: configuration

Latest version of Zend framework- ZF 1.6.0 ship dojo toolkit. You can find it in ZendFramework-1.6.0/external/ directory when you download ZF.

Recently I come across a problem using third party “calendar”- Java script Calendar, and as Zend has now done collaboration with Dojo, so people using zend will definitely start using Dojo for java scripts and all other functionality Dojo is providing. And that’s why I decided to study and use Dojo and implement it in my application instead of fixing the issue in the third party calendar.

Although Zend has done excellent job and has made things quite easy for those who wish to use dojo in their applications, however novice and those with little experience may find it a bit difficult to configure Zend for Dojo.

It this post I will tell you how to configure Zend for working with Dojo.

The first and most important thing is to copy “external/dojo” into your js directory under www/public folder.

After you copy the dojo folder add the following code in your bootstrap.
    $view = new Zend_View();

$view->addHelperPath(’Zend/Dojo/View/Helper/’, ‘Zend_Dojo_View_Helper’);

$viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer();



Ignore the first line $view= new Zend_View() if you have already instantiated view object in your bootstrap file.

That’s it. You have now added path to Dojo view helpers. You can now access dojo view helpers in your template-phtml file as you access other helper files and their functionality.

You job has not done yet.

Next you would need to add path to dojo.js file and other module of the dojo toolkit.

So open your layout file and put following code.
    if($this->dojo()->isEnabled()) {




echo $this->dojo();


As you can see we are adding path to js and stylesheet files so put the above code in <head> tag of your layout file.

The only thing you need to do is to enable dojo in your template file.

Let suppose you have controller “IndexController”. So in the views/scripts/index/index.phtml file put the following code.


I would like to explain the last line ->requireModule(’dijit.form.DateTextBox’). This line tells php to load DateTextBox. DateTextBox render textbox that display calendar when someone click on the field.

Your configuration is now completed. Now create your form as follows.
class MyForm extends Zend_Dojo_Form


public function init()




'label' => 'Date:',
'required' => true,
'invalidMessage' => 'Invalid date specified.',
'formatLength' => 'long',




In your controller, write
    $form= new MyForm();


In your view template
 echo $this->form;

The last thing I’d mention is, In your layout file replace “body” tag with
body class=”tundra”


  1. external/dojo means the dojo in the library/zend ???
    thnz in advance

  2. Great Post!! thanks i see a lot of blogs and this is the most clear and ussefull.
    Only have a dubt , in my controller i'dont found the way to instanciate my form without write include_once 'forms/myfor.php' it OK.

    Thanks a lot again


  3. I am trying a demo project (Studio 7) with "Full featured Zend Framework and Dojo project" selected.

    How do I configure dojo? I'm assuming it's different than what you have discribed.

  4. Hello!

    I am using Zend Framework with Smarty Template in my PHP project. Is this possible to use DOJO with Smarty in Zend Framework.

    Is answer is yes than can you pls explain me that how can I configure DOJO and Smarty together in Zend Framework.

    I am eagrly waiting for reply!

    Thanking you!
    Ronit Passwala.

  5. Finally, clearly written,
    Thank you Abbas!

  6. Ronit, you should avoid to use smarty anyway.
    Why should u use smarty when zend framework has the mvc and layout ?

  7. Hi everyone,

    My project hierarchy is like this
    from there i given the link to dojo like this
    /usr/local/zend/share/ZendFramework/externals/dojo so when i am trying to use dojo library in my project it is not able to bring the correct path

    Could please help me to come out of this problem

    warm regards

  8. thank you very much!

    great post


  9. Ecorptrainings.com provides DOJO in hyderabad with best faculties on real time projects. We give the best online trainingamong the DOJO in Hyderabad. Classroom Training in Hyderabad India