Just Married: Zend Framework and Doctrine

Just married: ZendFramework and Doctrine

Benjamin Eberlei

direkt effekt GmbH

IPC Spring 2010

Eberlei (direkt effekt GmbH) ZF and Doctrine 1 IPC Spring 2010 1 / 55

About Me

I Benjamin Eberlei

I direkt effekt GmBH

(digital marketing)

I Open Source contributor

(Zend Framework and Doctrine)

I Twitter @beberlei

I Blog: www.whitewashing.de


And You?


Model vs Persistence

Model=

Your code



Persistence=

Framework Code



I Model = Your code

I Persistence = Framework Code

I You can implement the samebusiness logic using any persistencesolution out there!


Zend Framework Persistence

I Zend Db - Abstraction Layer

I Zend Db Select - SQL Query Object

I Zend Db Table - Table/Row DataGateway pattern

No Object-Relational Mapping Support!




















Doctrine 1

I Object-Relational Mapping, Active Record

I Doctrine Query Language

I Hydrators

I Database Migrations


Doctrine 1



I Hydrators



Doctrine 1



I Hydrators



Doctrine 1



I Hydrators



Doctrine Modelling Workflow

1. Setup Doctrine Bootstrap

2. Define 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.

6. In production, use migrations for schema

evolvement.









evolvement.









evolvement.









evolvement.









evolvement.









evolvement.


A Doctrine Project Layout

I Non-PEAR Structure

I No Module Prefixes

I Autoloading?

I Configurable (PEAR)..

I ..Not enough for ZF!





I Autoloading?







I Autoloading?







I Autoloading?







I Autoloading?




Zend Framework Projects

I Model * in models/

I Single Module Project

I Not PEAR Standard

I Special Autoloader





I Not PEAR Standard






I Not PEAR Standard






I Not PEAR Standard



Modular ZF Project

I Each Module has models/

I Again Special Autoloader


Modular ZF Project

I Each Module has models/

I Again Special Autoloader


ZF + Doctrine Integration

I Not a ZF Component

I Download:

http://github.com/beberlei/zf-doctrine

I One Goal: No code-generationI Includes:

1. Zend Application Resource2. Zend Tool Integration3. Zend Forms from Doctrine Metadata4. Paginator Adapter5. Model List View Helper




I Download:







I Download:


I One Goal: No code-generation

I Includes:1. Zend Application Resource2. Zend Tool Integration3. Zend Forms from Doctrine Metadata4. Paginator Adapter5. Model List View Helper




I Download:



1. Zend Application Resource

2. Zend Tool Integration3. Zend Forms from Doctrine Metadata4. Paginator Adapter5. Model List View Helper




I Download:



1. Zend Application Resource2. Zend Tool Integration

3. Zend Forms from Doctrine Metadata4. Paginator Adapter5. Model List View Helper




I Download:



1. Zend Application Resource2. Zend Tool Integration3. Zend Forms from Doctrine Metadata

4. Paginator Adapter5. Model List View Helper




I Download:



1. Zend Application Resource2. Zend Tool Integration3. Zend Forms from Doctrine Metadata4. Paginator Adapter

5. Model List View Helper




I Download:





Zend Application Resource

1. Install using Zend Tool:

zf create project forumzf create-project doctrine –dsn=$DSN


Zend Application Resource

2. Register manually with Zend Applicationresources.doctrine.connections.default.dsn = ""pluginpaths.ZFDoctrine_Application_Resource

= "ZFDoctrine/Application/Resource"autoloadernamespaces [] = "Doctrine"autoloadernamespaces [] = "ZFDoctrine

.


Configuring the ApplicationResource

Configuring Connection DSNresources.doctrine.connections.<name >.dsn

Configuring Connection Attributesresources.doctrine.connections.<name >. attributes

Configuring Manager Attributesresources.doctrine.manager.attributes


ZFDoctrine Conventions

I Both ZF 1 and Doctrine 1 are magic boxes

I Enforcing ConventionsI Model Classes: $Module Model $Name:

1. Default Model User2. Default Model Group3. Forum Model Thread4. Forum Model Board

I Define Metadata Attributes refClass, local,

model and foreign explicitly




I Enforcing Conventions

I Model Classes: $Module Model $Name:1. Default Model User2. Default Model Group3. Forum Model Thread4. Forum Model Board


















A Doctrine Project

zf create project forumzf create-project doctrine –dsn

Creating four essential Doctrine Directories:

I application/configs/schema

I application/configs/fixtures

I application/configs/migrations

I application/configs/sql


Example Yaml schema: Forum

Put a forum.yml in the schema directory:Forum_Model_Category:

columns:name: string (50)description: string (99999)

Forum_Model_Board:columns:

category_id: integer (10)name: string (100)description: string (5000)

relations:Category:

class: Forum_Model_Categorylocal: category_idforeign: id

Threads:class: Forum_Model_Threadlocal: idforeign: board_id


Generate Models from Yaml

zf generate-models-from-yaml doctrine

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

true


Generate Models from Yaml

zf generate-models-from-yaml doctrine

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

true


Generate Models


Generate Models


Generated Model Classes

I Records

I Base Records

I Tables


Code Generation?

I Doctrine creates Models from Yaml files.

I ...optionally(!)

I You can skip Yaml and directly code the

Model (Records and Tables)

I Zend Framework Project Support works

without Yaml.


Code Generation?


I ...optionally(!)




without Yaml.


Code Generation?


I ...optionally(!)




without Yaml.


Code Generation?


I ...optionally(!)




without Yaml.


Generated Record:class Forum_Model_Category extends

Forum_Model_Base_Category{}

Generated Table:class Forum_Model_CategoryTable extends Doctrine_Table{

public static function getInstance (){

return Doctrine_Core :: getTable(’Forum_Model_Category ’);

}}

Generated Base Record:


abstract class Forum_Model_Base_Category extendsDoctrine_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

I Drop and Create Database

I Create Tables

I Load Fixtures


Migrations

Update your Database Schema:

I zf show-migration doctrine

I zf generate-migration doctrine

I zf execute-migration doctrine


Migrations






Migrations






Forms for Doctrine Models

I Using Doctrine Metadata for other, non

ORM purposes

I Configuration of Zend Form instances

I Mostly for backend (scaffolding) purposes




ORM purposes






ORM purposes




A Simple Form

$form = new ZFDoctrine_From_Model(array(’model ’ => ’Forum_Model_Category ’,’action ’ => ’.’,’method ’ => ’post’

));


A Simple Form: Tweaking

$form = new ZFDoctrine_Form_Model(array(’model ’ => ’Forum_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 addCategoryAction (){

$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 editCategoryAction (){

$categoryId = $this ->_getParam(’id’);

$form = $this ->createCategoryForm ();$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 addCategoryAction (){

$form = $this ->createCategoryForm ();$this ->_helper ->modelForm($form , ’success ’);

}

public function editCategoryAction (){

$form = $this ->createCategoryForm ();$this ->getHelper(’modelForm ’)

->setRecordIdParam(’id’)->handleForm($form , ’success ’);

}


Advanced Forms: Relations

Relations rendered as (multi-)select fields:public function addBoardAction (){

$form = new ZFDoctrine_Form_Model(array(’model ’ => ’Forum_Model_Board ’,

));$this ->_helper ->modelForm($form , "success");

}

Control Option Labels:class Forum_Model_Category extends ...{

public function __toString () {return $this ->id . ", " . $this ->name;

}}



Relations rendered as (multi-)select fields:public function addBoardAction (){

$form = new ZFDoctrine_Form_Model(array(’model ’ => ’Forum_Model_Board ’,

));$this ->_helper ->modelForm($form , "success");

}

Control Option Labels:class Forum_Model_Category extends ...{

public function __toString () {return $this ->id . ", " . $this ->name;

}}




Advanced Forms: Hooks

I Add Validators and Filters

I Change Decorators

I Use jQuery or Dojo Integration

I Hook methods: preGenerate() and

postGenerate()




I Change Decorators



postGenerate()




I Change Decorators



postGenerate()




I Change Decorators



postGenerate()



Adding decorators in preGenerate():class Forum_Form_Thread extends ZFDoctrine_Form_Model{

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:class Forum_Form_Thread extends ZFDoctrine_Form_Model{

protected function _preGenerate (){

ZendX_JQuery :: enableForm($this);// Zend_Dojo :: enableForm($this);

}}



Adding a validator in postGenerate():class Forum_Form_Thread extends ZFDoctrine_Form_Model{

protected function _postGenerate (){

// called after the form is generated$validator = new Zend_Validate_StringLength(

array(’min’ => 5, ’max’ => 255));$this ->getElement(’title ’)

->addValidator($validator);}

}


Paginator Adapter

Paginate a Doctrine Query:$query = Doctrine_Query :: create (); // $query ...$adapter =

new ZFDoctrine_Paginator_Adapter_DoctrineQuery($query);$paginator = new Zend_Paginator($adapter);

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


Paginator Adapter

Paginate a Doctrine Query:$query = Doctrine_Query :: create (); // $query ...$adapter =

new ZFDoctrine_Paginator_Adapter_DoctrineQuery($query);$paginator = new Zend_Paginator($adapter);

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


Model List View Helper

I Creates a paginated list for a model

I Links to CRUD actions

I Reasonable default Look & Feel

I But offers full customization





















<h1 >Boards </h1>

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

<h1 >Boards </h1><?= $this ->modelList(’Forum_Model_Board ’, array(

’editRecordAction ’ => ’edit -board ’,’addRecordAction ’ => ’add -board ’,’fieldLabels ’ => array(

’id’ => ’ID’,’category_id ’ => ’Category ’,’name’ => ’Name’,’description ’ => ’Description ’,

))); ?>



<h1 >Boards </h1>

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

<h1 >Boards </h1><?= $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

I Currently Conversion to Namespaces

I Specified Goals:1. Ease the learning curve2. Make extending the framework trivially

simple3. Simplify4. Favor the explicit over the magical

I ETA Q4/2010 or Q1/2011


Zend Framework 2.0

I Currently Conversion to NamespacesI Specified Goals:

1. Ease the learning curve2. Make extending the framework trivially


I ETA Q4/2010 or Q1/2011


Zend Framework 2.0

I Currently Conversion to NamespacesI Specified Goals:

1. Ease the learning curve2. Make extending the framework trivially


I ETA Q4/2010 or Q1/2011


Doctrine 2

I Separation of DBAL and ORM

I Less Magic, More Explicit Design

I DataMapper instead of ActiveRecord

I Powerful Metadata Mapping

I Considerable Performance Improvements

I Currently Beta 1, Release on September 1st

I First class citizen in Symfony 2


Doctrine 2









Doctrine 2









Doctrine 2









Doctrine 2









Doctrine 2









Doctrine 2









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


Doctrine 2 DBAL

I PDO API (ezcDatabase)

I Currently Support for MySql, PgSql,

Oracle, Sqlite, IBM and PDO Db2

I SqlSrv (+PDO) under development

I Lots of Convenience Methods (Zend Db)

I Currently planned: A Query Object

(Zend Db Select, ezcDatabaseQuery)

I SQL DDL and Data-QL abstraction (PEAR

MDB2 and ezcDatabaseSchema)


Doctrine 2 DBAL











Doctrine 2 DBAL











Doctrine 2 DBAL











Doctrine 2 DBAL











Doctrine 2 DBAL











Doctrine 2 DBAL Schema

I An OO-Approach to Database Schema

I Vendor independent abstraction of Tables,

Indexes, ForeignKeys and Sequences

I Get required set-up or tear-down SQL

I Get SQL to move from one to another

schema

I Doctrine Migrations








schema









schema









schema









schema



ZF 2 with Doctrine DBAL 2

I First class support?

I Doctrine 2 DBAL API compatible with

Zend Db?

I Zend Db Select drop-in replacement?

I Table-, Row-Data-Gateway?

I ORM Integration?





Zend Db?



I ORM Integration?





Zend Db?



I ORM Integration?





Zend Db?



I ORM Integration?





Zend Db?



I ORM Integration?


Questions?


Thank You!

Please rate this talk on joind.in:

http://joind.in/1710

Twitter: @beberlei Blog:

http://www.whitewashing.de


Technology

Just Married: Zend Framework and Doctrine