Doctrine ORM and Zend Framework

Deprecated: This code uses an old version of Doctrine and Zend Framework, there is now an semi-official way of integrating Doctrine and Zend Framework, see the announcement of the zf-doctrine project and checkout my plugin for ZFDebug to have access to the Doctrine Profiler: http://github.com/danceric/zfdebugdoctrine

—

This is my notes on integrating the Doctrine ORM with a Zend Framework project that use Zend_Application. This post was largely inspired by the post Integrating Zend Framework and Doctrine. In fact, you can see mine as an updated version of this great post to work in ZF 1.8. Ruben Vermeersch, the author, have stated on his blog that he want to update the post but he don’t have the time yet, so this is me trying to help.

This was done on OS X, so the instructions here assume a n*x like environment. You should also be comfortable with Zend Framework 1.8+ and the new Zend_Application. As stated in the ZF quickstart tutorial, you can create a project by running this command from the uncompressed Zend Framework folder:

./bin/zf.sh create project ~/Sites/zfdoctrine

In the newly created directory, which is a complete zf application, create the directories that will be needed by doctrine

cd ~/Sites/zfdoctrine
mkdir doctrine doctrine/migrations doctrine/schema
mkdir doctrine/data doctrine/data/fixtures doctrine/data/sql

Now, put the content of the Doctrine (1.0 or 1.1) lib folder in library. I strongly suggest that you put the ZF library here too. If you manage more that one project, it’s very unlikely that you will have time to update all your projects at the same time, which is needed if you use a global include path.

Create the Doctrine configuration in application/configs/application.ini

;doctrine.connection_string = "mysql://root:pwd@localhost/zfdoctrine"
doctrine.connection_string = "sqlite:///" APPLICATION_PATH "/zfdoctrine.db"
doctrine.data_fixtures_path = APPLICATION_PATH "/../doctrine/data/fixtures"
doctrine.models_path = APPLICATION_PATH "/models"
doctrine.migrations_path = APPLICATION_PATH "/../doctrine/migrations"
doctrine.sql_path = APPLICATION_PATH "/../doctrine/data/sql"
doctrine.yaml_schema_path = APPLICATION_PATH "/../doctrine/schema"

Initialize Doctrine in you application by adding this function to application/Bootstrap.php

public function _initDoctrine()
{
    require_once 'Doctrine.php';        
    $loader = Zend_Loader_Autoloader::getInstance();
    $loader->pushAutoloader(array('Doctrine', 'autoload'));
 
    $doctrineConfig = $this->getOption('doctrine');
 
    $manager = Doctrine_Manager::getInstance();
    $manager->setAttribute(
        Doctrine::ATTR_MODEL_LOADING, 
        Doctrine::MODEL_LOADING_CONSERVATIVE);    
 
    // Add models and generated base classes to Doctrine autoloader
    Doctrine::loadModels($doctrineConfig['models_path']);
 
    $manager->openConnection($doctrineConfig['connection_string']);    
 
    return $manager;
}

One of the fun thing about Doctrine is that you have access to a lot of command line tool to create your database, models, sql, schema, etc. Create a new file called doctrine-cli in a scripts folder at the root of you project with the following content:

#!/usr/bin/env php
<?php
/**
 * Doctrine CLI script
 */
 
define('APPLICATION_ENV', 'development');
 
define('APPLICATION_PATH', realpath(dirname(__FILE__) . '/../application'));
 
set_include_path(implode(PATH_SEPARATOR, array(
    realpath(APPLICATION_PATH . '/../library'),
    get_include_path(),
)));
 
require_once 'Zend/Application.php';
 
// Create application, bootstrap, and run
$application = new Zend_Application(
    APPLICATION_ENV,
    APPLICATION_PATH . '/configs/application.ini'
);
 
$application->getBootstrap()->bootstrap('doctrine');
 
$cli = new Doctrine_Cli($application->getOption('doctrine'));
$cli->run($_SERVER['argv']);

You can make this script executable and try it, to see the list of task that doctrine-cli can do for you

chmod +x ./scripts/doctrine-cli
./scripts/doctrine-cli

Now you can jump back to [Ruben Vermeersch's Tutorial]http://ruben.savanne.be/articles/integrating-zend-framework-and-doctrine) tutorial in the “Building an application” section and create the sample application. You’ll learn how to use Doctrine do a simple insert, a query and how to use the command line to create your database and model.

note: If you’re using these two projects together, you may be interested in my next post too: ZFDebug and Doctrine ORM

update 2009/10/29: things are getting easier, check out: Doctrine 1.2 is Zend Framework friendly

Posted Saturday, June 6th, 2009 under php.

19 comments

Yuta says:

June 14, 2009 at 3:46 am

Hi, Eric,

Nice entry. I have one question. In doctrine-cli, you write
```
$application->bootstrap('doctrine');
```
In this line , you want to execute just “_initDoctrine()” method in Bootstrap? If it’s so, I think you need to modify it as

$application->getBootstrap()->bootstrap(‘doctrine’);

Thanks.
Zend Framework Quick StartにDoctrineを適用してみる - その２ - KDF Memo says:

June 14, 2009 at 4:58 am

[...] Doctrine ORM and Zend Framework « Danceric [...]
Fabian says:

June 15, 2009 at 1:22 pm

Thanks for this helpful article.

I have encountered a problem with the doctrine-cli script in line 12: It overwrites the include paths defined in the php.ini. Maybe you should use the same set_include_path() which is used in public/index.php, because it remains the settings by adding get_include_path():

set_include_path(implode(PATH_SEPARATOR, array( realpath(APPLICATION_PATH . ‘/../library’), get_include_path(), )));
Eric says:

June 15, 2009 at 8:22 pm

@Yuta, Thanks for the fix, I this exactly what I was trying to do, load only the _initDoctrine() method

@Fabian, You’re right, I have updated the code. I have the strange habit of overriding the include_path when I deploy on shared hosting to have full control on it
anso says:

July 11, 2009 at 3:22 am

Thank you very much for the great example. Could you tell me how this one could be used modules? So that it works with multiple models folders. Is there a way to configure Doctrine to work in such an environment?

Thank you very much.
Ants in my Zend Framework (with doctrine for good measure) | sproif.com says:

July 15, 2009 at 8:08 am

[...] started with this tutorial: Doctrine ORM and Zend Framework It shows you how to create a Zend 1.8.4 project with doctrine. The key aspect is the [...]
Silvan Mühlemann says:

July 15, 2009 at 11:07 am

Very useful! Thank you! I got it running in a matter of minutes. Thinking I saw doctrine for the first time this morning
Rafael Izidoro says:

July 23, 2009 at 1:48 pm

Thank you for this article.
Phil Oertel says:

August 11, 2009 at 2:59 pm

awesome article, thanks! i’ve never used doctrine until this afternoon, but i love love that you set up autoloading in the nice zf1.8 bootstrap, and wrote the doctrine-cli wrapper to go through the application. really really well done.
jens says:

August 13, 2009 at 4:01 pm

if anyone out there who also want only use the zend autoloader this link maybe interesting, zend core dev matthew (mwo) explains how

http://www.nabble.com/Autoloader-issue-td24426857.html

works great!
Eric says:

August 21, 2009 at 10:26 am

Matthew Weier O’Phinney from the Zend Framework fame have posted his thought on the subject, take a look at it, it’s probably better than my way of doing things

http://weierophinney.net/matthew/archives/220-Autoloading-Doctrine-and-Doctrine-entities-from-Zend-Framework.html
Integrando o Doctrine com o Zend Framework says:

August 21, 2009 at 9:07 pm

[...] Zend Framework. Após várias tentativas e erros, além de buscas na web, encontrei o tutorial de Eric Leclerc, que faz uma atualização do tutorial de Ruben Vermeersch, para utilizar o Doctrine com o Zend [...]
Doctrine ORM and Zend Framework « Danceric says:

September 4, 2009 at 9:11 am

[...] here to read the rest: Doctrine ORM and Zend Framework « Danceric Share and [...]
Hari K T says:

October 7, 2009 at 4:26 pm

Eric great post . This will be helpful for those who are looking to configure doctrine ORM with ZF . Though I have not used ORM I would love to try it out . Thanks for your post to help all ZF developers .
Chris MacPherson says:

October 20, 2009 at 7:08 pm

Hi, Thanks for the info, I had this working well and it allowed me to get Doctrine up and running quickly and as I’m new to Doctrine that was great. I was using Doctrine 1.1, but can you tell me if 1.2 can be set up the same way? I tried just swapping the Doctrine 1.2 files in but things don’t seem to work unfortunately.

Thanks again,

Chris
Eric says:

October 21, 2009 at 11:10 pm

Hi Chris, I haven’t tried Doctrine 1.2 with this setup yet, but as soon as the beta for 1.2 land, I’ll have it working and I will update my post accordingly
Xaljava says:

October 23, 2009 at 4:21 pm

Thank you very much! This post really helped. I having WAMP, ZF 1.9.4 and Doctrine 1.1.4. No problems with setup even on Windows.
Eric says:

October 25, 2009 at 10:54 am

I’m playing around with the latest alpha of Doctrine 1.2 and the future seems really bright. It seems way easier to use it with ZF now. Can’t wait for the beta
Zend Framework and Doctrine | Hot Dorkage says:

November 20, 2009 at 12:58 am

[...] post from ruben Ruben’s ideas updated for 1.8 tools WeieroPhinney’s post on this subject Php Melb’s own Phil Brown with a reusable, [...]

Eric Leclerc

Doctrine ORM and Zend Framework

—

19 comments