ZF and Doctrine Integration: A Deep Dive

Just married: Zend
Framework and Doctrine
Benjamin Eberlei
direkt eﬀekt GmbH

IPC Spring 2010

Eberlei (direkt eﬀekt GmbH) ZF and Doctrine 1 IPC Spring 2010 1 / 55

About Me

Benjamin Eberlei
direkt eﬀekt GmBH
(digital marketing)
Open Source contributor
(Zend Framework and Doctrine)
Twitter @beberlei
Blog: www.whitewashing.de

And You?


Model vs Persistence

Model
=
Your code


Persistence
=
Framework Code


Model = Your code
Persistence = Framework Code
You can implement the same
business logic using any persistence
solution out there!


Zend Framework Persistence

Zend Db - Abstraction Layer



Zend Db Select - SQL Query Object



Zend Db Table - Table/Row Data
Gateway pattern



Zend Db Table - Table/Row Data
Gateway pattern
No Object-Relational Mapping Support!


Doctrine 1

Object-Relational Mapping, Active Record


Doctrine 1

Doctrine Query Language


Doctrine 1

Hydrators


Doctrine 1

Hydrators
Database Migrations


Doctrine Modelling Workﬂow

1. Setup Doctrine Bootstrap



2. Deﬁne a YAML Schema



3. Generate Model and Table PHP classes



4. Generate Database Schema from Models



5. Repeat (2)-(4) for Iterations of your models.



5. Repeat (2)-(4) for Iterations of your models.
6. In production, use migrations for schema
evolvement.


A Doctrine Project Layout

Non-PEAR Structure



Non-PEAR Structure
No Module Preﬁxes



Non-PEAR Structure
No Module Preﬁxes
Autoloading?



Non-PEAR Structure
No Module Preﬁxes
Autoloading?
Conﬁgurable (PEAR)..



Non-PEAR Structure
No Module Preﬁxes
Autoloading?
Conﬁgurable (PEAR)..
..Not enough for ZF!


Zend Framework Projects

Model * in models/



Model * in models/
Single Module Project



Model * in models/
Not PEAR Standard



Model * in models/
Not PEAR Standard
Special Autoloader


Modular ZF Project

Each Module has models/


Modular ZF Project

Each Module has models/
Again Special Autoloader


ZF + Doctrine Integration
Not a ZF Component


Not a ZF Component
Download:
http://github.com/beberlei/zf-doctrine


Not a ZF Component
Download:
One Goal: No code-generation


Not a ZF Component
Download:
Includes:
1. Zend Application Resource


Not a ZF Component
Download:
Includes:
2. Zend Tool Integration


Not a ZF Component
Download:
Includes:
3. Zend Forms from Doctrine Metadata


Not a ZF Component
Download:
Includes:
4. Paginator Adapter


Not a ZF Component
Download:
Includes:
4. Paginator Adapter
5. Model List View Helper

Zend Application Resource

1. Install using Zend Tool:
zf create project forum
zf create-project doctrine –dsn=$DSN


Zend Application Resource
2. Register manually with Zend Application
resources . doctrine . connections . default . dsn = " "
pluginpaths . Z F D o c t r i n e _ A p p l i c a t i o n _ R e s o u r c e
= " ZFDoctrine / Application / Resource "
a u toloade r n a m e s p a c e s [] = " Doctrine "
a u toloade r n a m e s p a c e s [] = " ZFDoctrine

.


Configuring the Application
Resource
Configuring Connection DSN
resources . doctrine . connections . < name >. dsn

Configuring Connection Attributes
resources . doctrine . connections . < name >. attributes

Configuring Manager Attributes
resources . doctrine . manager . attributes


ZFDoctrine Conventions
Both ZF 1 and Doctrine 1 are magic boxes


Enforcing Conventions


Model Classes: $Module Model $Name:
1. Default Model User
2. Default Model Group
3. Forum Model Thread
4. Forum Model Board


Model Classes: $Module Model $Name:
1. Default Model User
2. Default Model Group
3. Forum Model Thread
4. Forum Model Board
Deﬁne Metadata Attributes refClass, local,
model and foreign explicitly

A Doctrine Project
zf create project forum
zf create-project doctrine –dsn

Creating four essential Doctrine Directories:
application/configs/schema
application/configs/fixtures
application/configs/migrations
application/configs/sql

Example Yaml schema: Forum
Put a forum.yml in the schema directory:
F o rum_Mod e l _ C a t e g o r y :
columns :
name : string (50)
description : string (99999)

Forum_Mode l_Boar d :
columns :
category_id : integer (10)
name : string (100)
description : string (5000)
relations :
Category :
class : F o r u m _ Model_Category
local : category_id
foreign : id
Threads :
class : Fo ru m_ Model_Thread
local : id
foreign : board_id


Generate Models from Yaml

zf generate-models-from-yaml doctrine


Generate Models from Yaml

zf generate-models-from-yaml doctrine

Generate Table Classes (application.ini)
resources . doctrine . generateModels . generateTableClasses =
true


Generate Models


Generated Model Classes

Records
Base Records
Tables


Code Generation?

Doctrine creates Models from Yaml ﬁles.


Code Generation?

...optionally(!)


Code Generation?

...optionally(!)
You can skip Yaml and directly code the
Model (Records and Tables)


Code Generation?

...optionally(!)
You can skip Yaml and directly code the
Model (Records and Tables)
Zend Framework Project Support works
without Yaml.


Generated Record:
class For u m _ M o de l _ C ategory extends
Forum_Model_Base_Category
{
}

Generated Table:
class F o r u m _ M o d e l _ C a t e g o r y T a b le extends Doctrine_Table
{
public static function getInstance ()
{
return Doctrine_Core :: getTable (
’ F o r u m _ Model_Category ’) ;
}
}

Generated Base Record:


abstract class F o r u m _ M o d e l _ B a s e _ C a t e g o r y extends
Doctrine_Record
{
public function setTableDefinition ()
{
$this - > setTableName ( ’ forum_categories ’) ;
$this - > hasColumn ( ’ name ’ , ’ string ’ , 50 , array (
’ type ’ = > ’ string ’ ,
’ length ’ = > ’ 50 ’ ,
));
$this - > hasColumn ( ’ description ’ , ’ string ’ , 99999 ,
array (
’ type ’ = > ’ string ’ ,
’ length ’ = > ’ 99999 ’ ,
));
}

public function setUp ()
{
parent :: setUp () ;
$this - > hasMany ( ’ Forum_Model_Board ’ , array (
’ local ’ = > ’ id ’ ,
’ foreign ’ = > ’ category_id ’) ) ;
}
}


Generating Database

zf build-project doctrine –reload
Drop and Create Database
Create Tables
Load Fixtures


Migrations

Update your Database Schema:
zf show-migration doctrine


Migrations

zf generate-migration doctrine


Migrations

zf generate-migration doctrine
zf execute-migration doctrine


Forms for Doctrine Models

Using Doctrine Metadata for other, non
ORM purposes



ORM purposes
Conﬁguration of Zend Form instances



ORM purposes
Conﬁguration of Zend Form instances
Mostly for backend (scaﬀolding) purposes


A Simple Form

$form = new Z F D o c t r i ne_Fr om_M odel ( array (
’ model ’ = > ’ F o r um_Model_Category ’ ,
’ action ’ = > ’. ’ ,
’ method ’ = > ’ post ’
));


A Simple Form: Tweaking

$form = new Z F D o c t r i ne_Fo rm_M odel ( array (
’ model ’ = > ’ F o r um_Model_Category ’ ,
’ method ’ = > ’ post ’ ,
’ action ’ = > $this - > _helper - > url (
’add - category ’ , ’ admin ’) ,
’ fieldLabels ’ = > array (
’ name ’ = > ’ Name ’ ,
’ description ’ = > ’ Description ’ ,
),
’ fieldTypes ’ = > array (
’ description ’ = > ’ textarea ’ ,
),
));


A Simple Form: Tweaking


A Simple Form: Controller

public function add CategoryAction ()
{
$form = $this - > createCategoryForm () ;
$request = $this - > getRequest () ;
$post = $request - > getPost () ;

if ( $request - > isPost () && $form - > isValid ( $post ) ) {
$form - > save () ;

$this - > _helper - > redirector ( ’ success ’ , ’ admin ’) ;
}

$this - > view - > form = $form ;
}


A Simple Form: Updating
public function e di tCategoryAction ()
{
$categoryId = $this - > _getParam ( ’ id ’) ;

$request = $this - > getRequest () ;
$post = $request - > getPost () ;

$table = Doctrine :: getTable ( ’ Forum_Model_Category ’) ;
$category = $table - > find ( $categoryId ) ;
$form - > setRecord ( $category ) ;

if ( $request - > isPost () && $form - > isValid ( $post ) ) {
$form - > save () ;

$this - > _helper - > redirector ( ’ success ’ , ’ admin ’) ;
}

$this - > view - > form = $form ;
}


A Simple Form: Action Helper

public function add CategoryAction ()
{
$this - > _helper - > modelForm ( $form , ’ success ’) ;
}

public function e di tCategoryAction ()
{
$this - > getHelper ( ’ modelForm ’)
-> setRecordIdParam ( ’ id ’)
-> handleForm ( $form , ’ success ’) ;
}


Advanced Forms: Relations
Relations rendered as (multi-)select ﬁelds:
public function addBoardAction ()
{
$form = new Z F D o ctri ne_Fo rm_M odel ( array (
’ model ’ = > ’ Forum_Model_Board ’ ,
));
$this - > _helper - > modelForm ( $form , " success " ) ;
}


Relations rendered as (multi-)select ﬁelds:
public function addBoardAction ()
{
$form = new Z F D o ctri ne_Fo rm_M odel ( array (
’ model ’ = > ’ Forum_Model_Board ’ ,
));
$this - > _helper - > modelForm ( $form , " success " ) ;
}

Control Option Labels:
class For u m _ M o del _ C a tegory extends ...
{
public function __toString () {
return $this - > id . " , " . $this - > name ;
}
}


Advanced Forms: Hooks

Add Validators and Filters



Change Decorators



Change Decorators
Use jQuery or Dojo Integration



Change Decorators
Use jQuery or Dojo Integration
Hook methods: preGenerate() and
postGenerate()


Adding decorators in preGenerate():
class Forum _Form_T hread extends ZFDo ctrin e_Fo rm_Mo del
{
protected function _preGenerate ()
{
// called before the form is generated
$decorators = array (
’ FormElements ’ ,
array ( array ( ’ data ’= > ’ HtmlTag ’) , array ( ’ tag ’= > ’
table ’) ) ,
’ Form ’
);

$this - > setDecorators ( $decorators ) ;
}
}



jQuery or Dojo Enable a Form:
{
protected function _preGenerate ()
{
ZendX_JQuery :: enableForm ( $this ) ;
// Zend_Dojo :: enableForm ( $this ) ;
}
}



Adding a validator in postGenerate():
{
protected function _postGenerate ()
{
// called after the form is generated
$validator = new Z e n d _ V a l i d a t e _ S t r i n g L e n g t h (
array ( ’ min ’ = > 5 , ’ max ’ = > 255)
);
$this - > getElement ( ’ title ’)
-> addValidator ( $validator ) ;
}
}


Paginator Adapter

Paginate a Doctrine Query:
$query = Doctrine_Query :: create () ; // $query ...
$adapter =
new Z F D o c t r i n e _ P a g i n a t o r _ A d a p t e r _ D o c t r i n e Q u e r y ( $query ) ;
$paginator = new Zend_Paginator ( $adapter ) ;


Paginator Adapter

Paginate a Doctrine Query:
$query = Doctrine_Query :: create () ; // $query ...
$adapter =
new Z F D o c t r i n e _ P a g i n a t o r _ A d a p t e r _ D o c t r i n e Q u e r y ( $query ) ;
$paginator = new Zend_Paginator ( $adapter ) ;

Paginate a Doctrine Table:
$table = Doctrine_Core :: getTable ( ’ MyModel ’) ;
$query = $table - > createQuery () ;


Model List View Helper

Creates a paginated list for a model



Links to CRUD actions



Reasonable default Look & Feel



Reasonable default Look & Feel
But oﬀers full customization


<h1 > Boards </ h1 >

<?= $this - > modelList ( ’ Forum_Model_Board ’) ; ? >



<?= $this - > modelList ( ’ Forum_Model_Board ’) ; ? >

<?= $this - > modelList ( ’ Forum_Model_Board ’ , array (
’ editRecordAction ’ = > ’ edit - board ’ ,
’ addRecordAction ’ = > ’add - board ’ ,
’ fieldLabels ’ = > array (
’ id ’ = > ’ ID ’ ,
’ category_id ’ = > ’ Category ’ ,
’ name ’ = > ’ Name ’ ,
’ description ’ = > ’ Description ’ ,
)
)); ?>


Questions?


Zend Framework 2.0

Currently Conversion to Namespaces


Zend Framework 2.0

Speciﬁed Goals:
1. Ease the learning curve
2. Make extending the framework trivially
simple
3. Simplify
4. Favor the explicit over the magical


Zend Framework 2.0

Speciﬁed Goals:
1. Ease the learning curve
2. Make extending the framework trivially
simple
3. Simplify
4. Favor the explicit over the magical
ETA Q4/2010 or Q1/2011


Doctrine 2

Separation of DBAL and ORM


Doctrine 2

Less Magic, More Explicit Design


Doctrine 2

DataMapper instead of ActiveRecord


Doctrine 2

Powerful Metadata Mapping


Doctrine 2

Considerable Performance Improvements


Doctrine 2

Currently Beta 1, Release on September 1st


Doctrine 2

Currently Beta 1, Release on September 1st
First class citizen in Symfony 2


Wednesday, 8:30, Room Salon 1
Guilherme on Doctrine 2!


Doctrine 2 DBAL
PDO API (ezcDatabase)


Doctrine 2 DBAL
Currently Support for MySql, PgSql,
Oracle, Sqlite, IBM and PDO Db2


Doctrine 2 DBAL
SqlSrv (+PDO) under development


Doctrine 2 DBAL
Lots of Convenience Methods (Zend Db)


Doctrine 2 DBAL
Currently planned: A Query Object
(Zend Db Select, ezcDatabaseQuery)


Doctrine 2 DBAL
Currently planned: A Query Object
(Zend Db Select, ezcDatabaseQuery)
SQL DDL and Data-QL abstraction (PEAR
MDB2 and ezcDatabaseSchema)

Doctrine 2 DBAL Schema

An OO-Approach to Database Schema



Vendor independent abstraction of Tables,
Indexes, ForeignKeys and Sequences



Get required set-up or tear-down SQL



Get SQL to move from one to another
schema



Get SQL to move from one to another
schema
Doctrine Migrations


ZF 2 with Doctrine DBAL 2

First class support?



Doctrine 2 DBAL API compatible with
Zend Db?



Zend Db?
Zend Db Select drop-in replacement?



Zend Db?
Table-, Row-Data-Gateway?



Zend Db?
Table-, Row-Data-Gateway?
ORM Integration?


Questions?


Thank You!
Please rate this talk on joind.in:
http://joind.in/1710
Twitter: @beberlei Blog:
http://www.whitewashing.de


ZF and Doctrine Integration: A Deep Dive

Recommended

Recommended

More Related Content

Similar to ZF and Doctrine Integration: A Deep Dive

Similar to ZF and Doctrine Integration: A Deep Dive (20)

More from Benjamin Eberlei

More from Benjamin Eberlei (6)

Recently uploaded

Recently uploaded (20)

ZF and Doctrine Integration: A Deep Dive