Symfony 1.3 + Doctrine 1.2

Symfony 1.3 + Doctrine 1.2

Jonathan H. Wage: Symfony 1.3 + Doctrine 1.2 1

Symfony 1.3+

Doctrine 1.2



Continued Evolutionof Symfony 1.x



Lots of new features, enhancements and bug fixes.



Out with the old and in with the new!



Doctrine is the default ORM



Propel is deprecated



Propel is deprecated in 1.3 but not removed. It will be dropped

completely in symfony 2.0



Still want to use Propel? :)Generate your project with the new --orm option

$ php /path/to/symfony generate:project foo --orm=Propel



New Symfony Features



Use the --installer option to execute Symfony installer

scripts



$ php /path/to/symfony generate:project --installer=my_installer.php



Now in your my_installer.php you can do things like...if (!$this->askConfirmation('Are you sure you want to run this installer?')){ return;} $this->installDir(dirname(__FILE__).'/skeleton');

$this->runTask('plugin:publish-assets');

$validator = new sfValidatorEmail(array(), array('invalid' => 'hmmm, it does not look like an email!'));$email = $this->askAndValidate('Please, give me your email:', $validator);

$this->runTask('configure:author', sprintf("'%s'", $email));

$secret = $this->ask('Give a unique string for the CSRF secret:');

$this->runTask('generate:app', 'frontend --escaping-strategy=true --csrf-secret='.$secret);

$this->runTask('plugin:install', 'sfDoctrineGuardPlugin');$this->reloadTasks();

$this->runTask('guard:create-user', 'jwage changeme');$this->runTask('cache:clear');



It replaces the need to maintain your own skeleton symfony project. Just write your own custom installer to

generate a new project the way you want it.



Form Framework



Recognize this?

class LoginForm extends BaseUserForm{ public function configure() { unset( $this['first_name'], $this['last_name'], $this['email_address'] ); }}



Using unset() to remove fields



Instead, lets say what form fields we WANT to use instead

of the ones we don’t want



Now it is possible with the useFields() method.

class LoginForm extends BaseUserForm{ public function configure() { $this->useFields(array( 'username', 'password' )); }}



Easier to maintain



Does not require keeping unset() list updated when we

add new fields to model



Forms + Events



We now have a sfFormSymfony in core and BaseForm class in

each project.



Sits on top of the agnostic sfForm and couples symfony

dispatcher with the form framework.



Allows us to dispatch symfony events from within the form

framework. YES!



What events can I use?



• form.post_configure - Notified after every form is configured

• form.filter_values - Filters tainted parameters and files array just prior to binding

• form.validation_error - Notified whenever form validation fails.

• form.method_not_found - Notified whenever an unknown method is called



Example Form Event

Add easy ReCaptcha functionality to all forms



Define a regular form that extends sfFormSymfony

class MyForm extends BaseForm{ public function configure() { $this->widgetSchema['title'] = new sfWidgetFormInputText(); $this->validatorSchema['title'] = new sfValidatorString();

$this->widgetSchema->setNameFormat('my_form[%s]'); }}



Connect events form.post_configure and form.filter_values

class ProjectConfiguration extends sfProjectConfiguration{ public function setup() { // ...

$this->dispatcher->connect('form.post_configure', array( $this, 'formPostConfigure' ));

$this->dispatcher->connect('form.filter_values', array( $this, 'formFilterValues' )); }}



Define formPostConfigure() method.

public function formPostConfigure(sfEvent $event) { $form = $event->getSubject();

if ($form->reCaptcha) { $widgetSchema = $form->getWidgetSchema(); $validatorSchema = $form->getValidatorSchema(); $widgetSchema['captcha'] = new sfWidgetFormReCaptcha(array( 'public_key' => '6Ld2DgQAAAAAAApXLteupHPcbSxbSHkhNTuYLChX' ));

$validatorSchema['captcha'] = new sfValidatorReCaptcha(array( 'private_key' => '6Ld2DgQAAAAAANIbaXJsFEBOyg56CL_ljy3APlPb' )); } }



Define formFilterValues() method.

public function formFilterValues(sfEvent $event, $values) { $form = $event->getSubject();

if ($form->reCaptcha) { $request = sfContext::getInstance()->getRequest();

$captcha = array( 'captcha' => array( 'recaptcha_challenge_field' => $request->getParameter('recaptcha_challenge_field'), 'recaptcha_response_field' => $request->getParameter('recaptcha_response_field') ) ); $values = array_merge($values, $captcha); } return $values; }



Now to enable recaptcha for any of your forms just add a public property to your forms

with a value of true



Enable recaptcha on MyForm.

class MyForm extends BaseForm{ public $reCaptcha = true;

public function configure() { $this->widgetSchema['title'] = new sfWidgetFormInputText(); $this->validatorSchema['title'] = new sfValidatorString();

$this->widgetSchema->setNameFormat('my_form[%s]'); }}



Now MyForm has recaptcha enabled. Enable it on any of

your other forms.



The previous example requires that sfFormExtraPlugin be installed in your project.



Of course we could have implemented this right in

BaseForm without events. This would make more sense if implemented via a plugin.



Testing Improvements



sfTesterResponse adds matches() method



Runs a regex on the entire response content.

$browser->with('response')->begin()-> matches('/I have \d+ apples/')-> // it takes a regex as an argument matches('!/I have \d+ apples/')-> // a ! at the beginning means that the regex must not match matches('!/I have \d+ apples/i')-> // you can also add regex modifiersend();



$browser->with('response')->begin()-> matches('/I have \d+ apples/')-> matches('!/I have \d+ apples/')-> matches('!/I have \d+ apples/i')->end();



More powerful than contains() and is useful for non-XML type

responses where checkElement() cannot be used


Jonathan H. Wage: Symfony 1.3 + Doctrine 1.2

$ php symfony test:all --xml=log.xml

42

Tests now have JUnit Compatible XML Output



$ php symfony test:all -t

Output exception traces when running all tests

Useful for debugging failing tests



New checkForm() method on sfTesterResponse

Tests that all form fields are rendered properly in the HTML response.



$browser->with('response')->begin()-> checkForm('ArticleForm')->end();



Use CSS selectors when dealing with multiple forms

$browser->with('response')->begin()-> checkForm('ArticleForm', '#articleForm')->end();



Improve Developer Testing Efficiency



When you have a large test suite it is time consuming to run all tests every time you

make a change.



Use the --only-failed option



After you run the test suite once, re-run with the

--only-failed option to execute only the failed tests from the

previous run.



Now you can re-run this over and over until you have zero

failures again.



Interactive CLI Tasks

Ask the user for some input and use it in your task



In your task class you can use some code like below.

$anwser = $this->askAndValidate( 'What is you email?', new sfValidatorEmail());



Improved Doctrine Integration



Disable Form Generation for Certain Models



For models like many to many join tables we don’t need form classes so we can disable the generation of them.

UserGroup: options: symfony: form: false filter: false columns: user_id: type: integer primary: true group_id: type: integer primary: true



Generated forms now follow model inheritance hierarchy



Now your form classes will generate the same inheritance structure that your models define.

class Moderator extends User{ // ...}

class ModeratorForm extends UserForm{ // ...}



New Doctrine Tasks



$ php symfony doctrine:create-model-tables Model1 Model2 Model3

Create Tables for Set of ModelsTask will drop and recreate specified tables.

Useful in development mode when you want to rebuild a set of models in the database over and over while you’re working on it. Instead of having to rebuild the entire database just to test.



Delete Model FilesDelete associated generated files for a model like forms and filter classes.

$ php symfony doctrine:delete-model-files ModelName

This is useful if you remove a model or rename a model, before you would have to manually clean up these classes and it was a pain. This task automates it for you.



Clean Model FilesThis task is combined with the previous task to clean up orphaned model files.

$ php symfony doctrine:clean-model-files

It detects what model all model files exist on disk but cannot be found in your YAML schema files. It will find these files and report them to you asking you to confirm whether or not they should be deleted.



Reload Data$ php symfony doctrine:reload-data

The above is the same as doing the following

$ php symfony doctrine:drop-db $ php symfony doctrine:build-db $ php symfony doctrine:insert-sql $ php symfony doctrine:data-load

This is commonly used to prepare a test database before each test is run.



The New Build TaskThe new doctrine:build task allows you to specify what exactly you would like symfony and Doctrine to build. This task replicates the functionality in many of the existing combination-tasks, which have all been deprecated in favor of this more flexible solution.

This will drop and create the database, create the tables configured in your YAML schema and load the fixture data.



$ php symfony doctrine:build --db --and-load

Build Examples



This will build the model, forms, form filters and run any pending migrations.

$ php symfony doctrine:build --all-classes --and-migrate

Build Examples



This will build the model, migrate the database and append category fixtures data.

$ php symfony doctrine:build --model --and-migrate --and-append=data/fixtures/categories.yml

Build Examples

We've added two new methods for retrieving Doctrine date/time values as PHP DateTime object instances.



Dealing with Doctrine Dates



If you prefer to work with DateTime objects then you can use these methods to get and set your Doctrine date values.

echo $article->getDateTimeObject('created_at')->format('m/d/Y');

$article->setDateTimeObject('created_at', new DateTime('09/01/1985'));

www.php.net/DateTime

http://www.php.net/DateTime

http://www.php.net/DateTime



Alternative doctrine:dql output

$ ./symfony doctrine:dql "FROM Article a" --table>> doctrine executing dql queryDQL: FROM Article a+----+-----------+----------------+---------------------+---------------------+| id | author_id | is_on_homepage | created_at | updated_at |+----+-----------+----------------+---------------------+---------------------+| 1 | 1 | | 2009-07-07 18:02:24 | 2009-07-07 18:02:24 || 2 | 2 | | 2009-07-07 18:02:24 | 2009-07-07 18:02:24 |+----+-----------+----------------+---------------------+---------------------+(2 results)

You probably recognize this as it is how the mysql command line outputs SQL queries.



Doctrine 1.2



Easy to upgrade from 1.1



Some deprecated functions, methods, etc. removed but the core of things have remained mostly the same. Only new

features and flexibilities have been added.



Custom Query Class



Specify the query class to use in your project somewhere in your configuration.

$manager->setAttribute( Doctrine::ATTR_QUERY_CLASS, 'MyQuery');



Define the MyQuery class which extends Doctrine_Query

class MyQuery extends Doctrine_Query{ }



Now you can add new methods and override functionality in

the Doctrine_Query class for all your query objects in your

application



Custom Collection Class



Specify the collection class to use in your project somewhere in your configuration.

$manager->setAttribute( Doctrine::ATTR_COLLECTION_CLASS, 'MyCollection');



Define the MyCollection class which extends Doctrine_Collection

class MyCollection extends Doctrine_Collection{ }



Now you can add new methods and override functionality in

your collections.



Add new method to get the sum of a field in a collection.

class MyCollection extends Doctrine_Collection{ public function getSum($field) { $sum = 0; foreach ($this as $record) { $sum = $sum + $record->get($field); } return $sum; }}



Now it can be used like the following

$transactions = Doctrine::getTable('Transaction') ->retrieveAllUserTransactions('jwage');

echo get_class($transactions); // MyCollection

// Output the total amount billed for all transactions for jwageecho $transactions->getSum('total_billed');



Custom Data Hydrators



It is now possible to write and register your own custom data hydrators which can be used from your query objects.

$manager->registerHydrator('MyHydrator', ‘MyHydratorDriver’);



Define the MyHydrator class

class MyHydratorDriver extends Doctrine_Hydrator_Abstract{ public function hydrateResultSet($stmt) { return $stmt->fetchAll(PDO::FETCH_ASSOC); }}



Custom hydrators must extend Doctrine_Hydrator_Abstract

and must implement thehydrateResultSet() method.



The core hydrators execute the PDO statement and build a

special structure to be returned. You can execute the

statement and do whatever you want with the data before

returning it.



Using Custom Hydrator

$q->execute(array(), 'MyHydrator');



Custom Connection Classes



Sometimes you may have some proprietary database type that Doctrine

does not support. The custom connections allow you to implement your own database drivers to use.



Register Connection Driver

$manager->registerConnectionDriver( 'test', 'Doctrine_Connection_Test');



Define Connection Classes class Doctrine_Connection_Test extends Doctrine_Connection_Common{}

class Doctrine_Adapter_Test implements Doctrine_Adapter_Interface{ // ... all the methods defined in the interface // ... mimics the PDO interface which connects // ... to your database}



Open a New Connection $conn = $manager->openConnection('test://username:password@localhost/dbname');

echo get_class($conn); // Doctrine_Connection_Testecho get_class($conn->getDbh()); // Doctrine_Adapter_Test



Improve Save Performance

$manager->setAttribute(Doctrine::ATTR_CASCADE_SAVES, false);

Disabling cascading saves to improve performance when saving lots of objects. The negative affect of this change is that you can’t save dirty objects that are more than one level deep in the object hierarchy.



New Convenience Magic Finders



$user = $table->findOneByUsernameAndPassword('jwage', md5('changeme'));$users = $table->findByIsAdminOrIsModerator(true, true);

Please be aware these finders are very limited and are only meant for quickly prototyping code. It is almost always recommended to write your own DQL queries which select and join the exact resultset you need.

Method name is converted in to a DQL query. Combine AND/OR

conditions.



Doctrine Extensions Repository

With the start of Doctrine 1.2 development we opened a special repository for users to contribute extensions to Doctrine to share with the community.



Similar to Symfony Plugins



Outside of Symfony Doctrine has a mechanism for autoloading and registering extensions. This is not necessary in Symfony because the native autoloading will load the code for the extension. We just need to download the code and put it somewhere in Symfony.

Using the Extensions



$ cd /path/to/symfony/project$ mkdir lib/doctrine_extensions$ svn co http://svn.doctrine-project.org/extensions/Taggable/branches/1.2-1.0/ Taggable$ ./symfony cc


http://svn.doctrine-project.org/extensions/Taggable/branches/1.2-1.0/

http://svn.doctrine-project.org/extensions/Taggable/branches/1.2-1.0/




---Article: actAs: [Taggable] columns: title: string(255) body: clob



You can contact Jonathan about Doctrine and Open-Source or for training, consulting, application development, or business

related questions at [email protected]

Jonathan H. [email protected]+1 415 992 5468

sensiolabs.com | doctrine-project.org | sympalphp.org | jwage.com

Questions?

mailto:[email protected]




Symfony 1.3 + Doctrine 1.2

Technology

Transcript of Symfony 1.3 + Doctrine 1.2