Extending Doctrine 2 for your Domain Model

Extending Doctrine 2For Your Domain Model Ross Tuck June 9th, DPC

Who Am I?

Ross Tuck

Team Lead at IbuildingsCodemonkeyREST nutHat guyToken Foreigner America, &@* ! Yeah

@rosstuck#dashinglyHandsome

Quick But Necessary

Doctrine 101

Doctrine 102

Doctrine 102.5

Model /** @Entity */ class Article { /** @Id @GeneratedValue * @Column(type="integer") */ protected $id; /** @Column(type="string") */ protected $title; /** @Column(type="text") */ protected $content; }

Controller $article = $em->find(Article, 1); $article->setTitle(Awesome New Story); $em->flush();

Filters

TPS RequestWe need a way to approve commentsbefore they appear to all users.

Controller $comments = $em->getRepository(Comment)->findAll(); foreach($comments as $comment) { echo $comment->getContent()."n"; }Output:Doug isnt humanDoug is the best

Controller $comments = $em->getRepository(Comment)->findAll(); foreach($comments as $comment) { echo $comment->getContent()."n"; }

Controller $comments = $em->createQuery(SELECT c FROM Comment c); foreach($comments->getResult() as $comment) { echo $comment->getContent()."n"; }

Controller $comments = $em->find(Article, 1)->getComments(); foreach($comments as $comment) { echo $comment->getContent()."n"; } ! ce s in your code Approx 100 pla

FiltersNew in 2.2

Filter use DoctrineORMQueryFilterSQLFilter; class CommentFilter extends SQLFilter { public function addFilterConstraint($entityInfo, $alias) { if ($entityInfo->name !== Comment) { return ""; } return $alias.".approved = 1"; } }

Bootstrap y Ha ndy ke $em->getConfiguration() ->addFilter(approved_comments, CommentFilter); Class name

Bootstrap $em->getConfiguration() ->addFilter(approved_comments, CommentFilter); $em->getFilters()->enable(approved_comments);

Bootstrap if ($this->isNormalUser()) { $em->getConfiguration() ->addFilter(approved_comments, CommentFilter); $em->getFilters()->enable(approved_comments); }

Controller $comments = $em->getRepository(Comment)->findAll(); foreach($comments as $comment) { echo $comment->getContent()."n"; } al UserOutput: A s NormDoug is the best

Controller $comments = $em->getRepository(Comment)->findAll(); foreach($comments as $comment) { echo $comment->getContent()."n"; } inOutput: As the AdmDoug isnt humanDoug is the best

Parameters

Bootstrap $filter = $em->getFilters()->getFilter(approved_comments); $filter->setParameter(level, $this->getUserLevel());

Filter use DoctrineORMQueryFilterSQLFilter; class CommentFilter extends SQLFilter { public function addFilterConstraint($entityInfo, $alias) { if ($entityInfo->name !== Comment) { return ""; } $level = $this->getParameter(level); return $alias.".approved = 1"; } }

Filter use DoctrineORMQueryFilterSQLFilter; class CommentFilter extends SQLFilter { public function addFilterConstraint($entityInfo, $alias) { if ($entityInfo->name !== Comment) { return ""; } $level = $this->getParameter(level); return $alias.".approved = ".$level; } }

Filter use DoctrineORMQueryFilterSQLFilter; class CommentFilter extends SQLFilter { public function addFilterConstraint($entityInfo, $alias) { if ($entityInfo->name !== Comment) { return ""; } Already escaped $level = $this->getParameter(level); return $alias.".approved = ".$level; } }

Limitations

Events

Inser tprePersist postLoadpostPersist loadClassMetadatapreUpdate preFlushpostUpdate onFlushpreRemove postFlushpostRemove onClear

Callbacks ListenersOn the model External objects

Lifecycle Callbacks

Model /** @Entity */ class Article { /** @Id @GeneratedValue * @Column(type="integer") */ protected $id; /** @Column(type="string") */ protected $title; /** @Column(type="text") */ protected $content; }

Controller $article = $em->find(Article, 1); $article->setTitle(Awesome New Story); $em->flush();

TPS RequestArticles must record the last date theywere modified in any way.

Controller $article = $em->find(Article, 1); $article->setTitle(Awesome New Story); $article->setUpdatedAt(new DateTime(now)); + 100 other files $em->flush(); + testing + missed bugs

Model /** @Entity */ class Article { /** @Id @GeneratedValue * @Column(type="integer") */ protected $id; /** @Column(type="string") */ protected $title; }

Model /** @Entity */ class Article { /** @Id @GeneratedValue * @Column(type="integer") */ protected $id; /** @Column(type="string") */ protected $title; /** @Column(type="datetime") */ protected $updatedAt; }

Model /** @Entity */ class Article { // ... public function markAsUpdated() { $this->updatedAt = new Datetime(now); } }

Model /** @Entity @HasLifecycleCallbacks */ class Article { // ... Event mapping /** @PreUpdate */ public function markAsUpdated() { $this->updatedAt = new Datetime(now); } }

Controller $article = $em->find(Article, 1); $article->setTitle(Awesome New Story); No Changes! $em->flush(); echo $article->getUpdatedAt()->format(c); // 2012-05-29T10:48:00+02:00

Model /** @Entity @HasLifecycleCallbacks */ class Article { // ... /** @PreUpdate */ public function markAsUpdated() { $this->updatedAt = new Datetime(now); } }

What else can I do?

prePersist postLoadpostPersist loadClassMetadatapreUpdate preFlushpostUpdate onFlushpreRemove postFlushpostRemove onClear

Protip:Only fires if youre dirty

new MudWrestling();

Controller $article = $em->find(Article, 1); $article->setTitle(Awesome New Story); $em->flush(); // 2012-05-29T10:48:00+02:00 // 2012-05-29T10:48:00+02:00 2X

Controller $article = $em->find(Article, 1); $article->setTitle(Awesome New Story); $em->flush(); Awesome New Story === Awesome New Story No update

Controller $article = $em->find(Article, 1); $article->setTitle(Fantabulous Updated Story); $em->flush(); Awesome New Story !== Fantabulous Updated Story Update, yeah!

Controller $article = $em->find(Article, 1); $article->setTitle(Awesome New Project.uniqid()); $em->flush();

So, heres the thing.

The Thing

Events are cool.

Callbacks?

Eeeeeeeeeeeeeeeeeeh.

• Limited to model dependencies• Do you really need that function?• Protected function? Silent error• Repeated Code• Performance implications

Listeners

Listener class UpdateTimeListener { public function preUpdate($event) { } }

Bootstrap $em->getEventManager()->addEventListener( array(DoctrineORMEvents::preUpdate), new UpdateTimeListener() );

Invert

Bootstrap $em->getEventManager()->addEventListener( array(DoctrineORMEvents::preUpdate), new UpdateTimeListener() );

Bootstrap $em->getEventManager()->addEventSubscriber( new UpdateTimeListener() );

Listener class UpdateTimeListener { public function preUpdate($event) { } public function getSubscribedEvents() { return array(Events::preUpdate); } }

Listener use DoctrineCommonEventSubscriber; class UpdateTimeListener implements EventSubscriber { public function preUpdate($event) { } public function getSubscribedEvents() { return array(Events::preUpdate); } }

Functionally? No differenceDesign? Subscriber

Bootstrap $em->getEventManager()->addEventSubscriber( new ChangeMailListener() );

Bootstrap $em->getEventManager()->addEventSubscriber( new ChangeMailListener($mailer) );

Listener class UpdateTimeListener implements EventSubscriber { public function getSubscribedEvents() { return array(Events::preUpdate); } public function preUpdate($event) { } }

Listener public function preUpdate($event) { $em = $event->getEntityManager(); $model = $event->getEntity(); if (!$model instanceof Article) { return; } $model->setUpdatedAt(new Datetime(now)); $uow = $event->getEntityManager()->getUnitOfWork(); $uow->recomputeSingleEntityChangeSet( $em->getClassMetadata(Article), $model ); }

Controller $article = $em->find(Article, 1); $article->setTitle(Awesome New Story); $em->flush(); echo $article->getUpdatedAt()->format(c); // 2012-05-29T10:48:00+02:00

Whoopity-doo

Theory Land interface LastUpdatedInterface { public function setUpdatedAt(Datetime $date); public function getUpdatedAt(); }

Listener public function preUpdate($event) { $em = $event->getEntityManager(); $model = $event->getEntity(); if (!$model instanceof Article) { return; } $model->setUpdatedAt(new Datetime(now)); $uow = $event->getEntityManager()->getUnitOfWork(); $uow->recomputeSingleEntityChangeSet( $em->getClassMetadata(Article), $model ); }

Listener public function preUpdate($event) { $em = $event->getEntityManager(); $model = $event->getEntity(); if (!$model instanceof LastUpdatedInterface) { return; } $model->setUpdatedAt(new Datetime(now)); $uow = $event->getEntityManager()->getUnitOfWork(); $uow->recomputeSingleEntityChangeSet( $em->getClassMetadata(Article), $model ); }

Listener public function preUpdate($event) { $em = $event->getEntityManager(); $model = $event->getEntity(); if (!$model instanceof LastUpdatedInterface) { return; } $model->setUpdatedAt(new Datetime(now)); $uow = $event->getEntityManager()->getUnitOfWork(); $uow->recomputeSingleEntityChangeSet( $em->getClassMetadata(get_class($model)), $model ); }

The POWAH

Flushing And Multiple Events

OnFlush

TPS RequestAfter every update to an article, I wantan email of the changes sent to me.Also, bring me more lettuce.

Listener class ChangeMailListener implements EventSubscriber { protected $mailMessage; public function getSubscribedEvents() { return array(Events::onFlush, Events::postFlush); } }

Listener public function onFlush($event) { $uow = $event->getEntityManager()->getUnitOfWork(); foreach($uow->getScheduledEntityUpdates() as $model) { $changeset = $uow->getEntityChangeSet($model); } }

array(1) { ["title"]=> array(2) { [0]=> string(16) "Boring Old Title" [1]=> string(16) "Great New Title!" }}

Listener public function onFlush($event) { $uow = $event->getEntityManager()->getUnitOfWork(); foreach($uow->getScheduledEntityUpdates() as $model) { $changeset = $uow->getEntityChangeSet($model); $this->formatAllPrettyInMail($model, $changeset); } }

Listener public function onFlush($event) { $uow = $event->getEntityManager()->getUnitOfWork(); foreach($uow->getScheduledEntityUpdates() as $model) { $changeset = $uow->getEntityChangeSet($model); $this->formatAllPrettyInMail($model, $changeset); } } public function postFlush($event) { if (!$this->hasMessage()) { return; } $this->mailTheBoss($this->message); }

Thats really all there is to it.

Listener public function formatAllPrettyInMail($model, $changes) { if (!$model instanceof Article) { return; } $msg = ""; foreach($changes as $field => $values) { $msg .= "{$field} ----- n". "old: {$values[0]} n". "new: {$values[1]} nn"; } $this->mailMessage .= $msg; }

Advice:Treat your listeners like controllers

Keep it thin

Crazy Town

TPS RequestWrite the change messages to thedatabase instead of emailing them.

Model /** @Entity */ class ChangeLog { /** @Id @GeneratedValue * @Column(type="integer") */ protected $id; /** @Column(type="text") */ protected $description; }

Listener class ChangeLogger implements EventSubscriber { public function getSubscribedEvents() { return array(Events::onFlush); } public function onFlush($event) { } }

Listener::onFlush public function onFlush($event) { $em = $event->getEntityManager(); $uow = $em->getUnitOfWork(); foreach($uow->getScheduledEntityUpdates() as $model) { if (!$model instanceof Article) { continue; } $log = new ChangeLog(); $log->setDescription($this->meFormatPrettyOneDay()); $em->persist($log); $uow->computeChangeSet( $em->getClassMetadata(ChangeLog), $log ); }

Yes, I really used PHPMyAdmin there

Also, wow, it worked!

UnitOfWork API $uow->getScheduledEntityInsertions(); $uow->getScheduledEntityUpdates(); $uow->getScheduledEntityDeletions(); $uow->getScheduledCollectionUpdates(); $uow->getScheduledCollectionDeletions();

UnitOfWork API $uow->scheduleForInsert(); $uow->scheduleForUpdate(); $uow->scheduleExtraUpdate(); $uow->scheduleForDelete();

UnitOfWork API And many more...

postLoad

Model /** @Entity */ class Article { //... /** @Column(type="integer") */ protected $viewCount; }

+MySQL Redis

TPS RequestMove view counts out of the databaseinto a faster system.And dont break everything.

Controller $article = $em->find(Article, 1); echo $article->getViewCount();

Model /** @Entity */ class Article { //... /** @Column(type="integer") */ protected $viewCount; }

Listener class ViewCountListener implements EventSubscriber { public function getSubscribedEvents() { return DoctrineORMEvents::postLoad; } public function postLoad($event) { $model = $event->getEntity(); if (!$model instanceof Article) { return; } $currentRank = $this->getCountFromRedis($model); $model->setViewCount($currentRank); } }

Controller $article = $em->find(Article, 1); echo $article->getViewCount();

Many, many other uses.

Class Metadata

Model /** @Entity */ class Article { /** @Id @GeneratedValue * @Column(type="integer") */ protected $id; Where do /** @Column(type="string") */ they go? protected $title; /** @Column(type="datetime") */ protected $updatedAt; }

Model /** @Entity */ class Article { /** @Id @GeneratedValue * @Column(type="integer") */ protected $id; /** @Column(type="string") */ protected $title; /** @Column(type="datetime") */ protected $updatedAt; }

DoctrineORMMappingClassMetadata

??? $metadata = $em->getClassMetadata(Article);

??? $metadata = $em->getClassMetadata(Article); echo $metadata->getTableName();Output:Article

??? $metadata = $em->getClassMetadata(Article); echo $metadata->getTableName();Output:articles

Doctrine 2.3 will bring NamingStrategy

??? $conn = $em->getConnection(); $tableName = $metadata->getQuotedTableName($conn); $results = $conn->query(SELECT * FROM .$tableName);

Tip of the Iceberg

??? $metadata->getFieldMapping(title);array(8) { fieldName => "title" type => "string" length => NULL precision => 0 scale => 0 nullable => false unique => false columnName => "title"}

??? $metadata->getFieldMapping(title); $metadata->getFieldNames(); $metadata->getReflectionClass(); $metadata->getReflectionProperty(title); $metadata->getColumnName(title); $metadata->getTypeOfField(title);

Simple Example

Symple Example

Form in Symfony2 class ArticleType extends AbstractType { public function buildForm($builder, array $options) { $builder ->add(title) ->add(content); } }

Controller in Symfony2 $entity = new Article(); $form = $this->createForm(new ArticleType(), $entity);

Form in Symfony2 class ArticleType extends AbstractType { public function buildForm($builder, array $options) { $builder ->add(title) ->add(content); } }

Symfony Doctrine Bridge switch ($metadata->getTypeOfField($property)) { case string: return new TypeGuess(text, ...); case boolean: return new TypeGuess(checkbox, ...); case integer: case bigint: case smallint: return new TypeGuess(integer, ...); case text: return new TypeGuess(textarea, ...); default: return new TypeGuess(text, ...); }

Cool, huh?

??? $metadata->getAssociationMapping(comments);array(15) { fieldName => "comments" mappedBy => "article" targetEntity => "Comment" cascade => array(0) {} fetch => 2 type => 4 isOwningSide => false sourceEntity => "Article" ...

??? $metadata->getAssociationMapping(comments); $metadata->getAssociationMappings(); $metadata->isSingleValuedAssociation(comments); $metadata->isCollectionValuedAssociation(comments); $metadata->getAssociationTargetClass(comments);

Form in Symfony2 class ArticleType extends AbstractType { public function buildForm($builder, array $options) { $builder ->add(title) ->add(content) ->add(comments); } }

Oh yeah.

You can set all of this stuff.

100~ public functions

But is there a good reason?Unless youre writing a driver, probably not.

Listener class MyListener { public function loadClassMetadata($event) { echo $event->getClassMetadata()->getName(); } }

Wheres the manatee?

Youre the manatee.

Epilogue & Service Layers

ModelController View

ModelService Layer Controller View

Be smart.

Be simple

Dont overuse this.

Test test test

test test test test test test test test test testtest test test test test test test test test testtest test test test test test test test test testtest test test test test test test test test testtest test test test test test test test test testtest test test test test test test test test testtest test test test test test test test test testtest test test test test test test test test testtest test test test test test test test test testtest test test test test test test test test testtest test test test test test test test test test

Go forth and rock.

Youre the manatee.

Thanks to:@boekkooi#doctrine (freenode)

Wikipedia OwnMoment (sxc.hu)

https://joind.in/6251

Extending Doctrine 2 for your Domain Model

by Ross Tuck on Jun 09, 2012

Accessibility

Categories

Upload Details

Usage Rights

3 Embeds 9

Statistics

Extending Doctrine 2 for your Domain Model Presentation Transcript

https://twitter.com	6
http://www.php-talks.com	2
https://si0.twimg.com	1