UPDATE: My thoughts have changed a bit since I originally presented this talk. It's could still be a useful intro to some of Doctrine's intermediate features (although the docs continue to improve. However, I would recommend you take a look at a new talk I've done since then "Models & Service Layers; Hemoglobin & Hobgoblins" which I think does a better job of actually talking about architecture and domain models than this talk does. Thanks! http://www.slideshare.net/rosstuck/models-and-service-layers-hemoglobin-and-hobgoblins As presented at the Dutch PHP Conference 2012. Sure, it can save models and do relations but Doctrine 2 can do a whole lot more. This talk introduces features like Events and Filters that can keep your code clean and organized. If you like the idea of automatically updating your solr index or adding audit logs without changing any existing code, this is the talk for you. The emphasis is on practical application of the lesser known but powerful features. The talk is geared toward people who are curious what Doctrine 2 can offer over a standard database layer or have used it previously.

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

3. Who Am I?

4. Ross Tuck

5. Team Lead at Ibuildings
Codemonkey
REST nut
Hat guy
Token Foreigner America,
&@* ! Yeah

6. @rosstuck
#dashinglyHandsome

7. Quick But Necessary

8. Doctrine 101

9. Doctrine 102

10. Doctrine 102.5

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

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

13. Filters

15. TPS Request
We need a way to approve comments
before they appear to all users.

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

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

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

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

20. Filters
New in 2.2

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

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

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

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

25. Controller
$comments = $em->getRepository('Comment')->findAll();
foreach($comments as $comment) {
echo $comment->getContent()."n";
}
al User
Output: A s Norm
Doug is the best

26. Controller
$comments = $em->getRepository('Comment')->findAll();
foreach($comments as $comment) {
echo $comment->getContent()."n";
}
in
Output:
As the Adm
Doug isn't human
Doug is the best

27. Parameters

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

29. 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";
}
}

30. 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;
}
}

31. 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;
}
}

32. Limitations

33. Events

34. Inser
t
prePersist postLoad
postPersist loadClassMetadata
preUpdate preFlush
postUpdate onFlush
preRemove postFlush
postRemove onClear

35. Callbacks Listeners
On the model External objects

36. Lifecycle Callbacks

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

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

40. TPS Request
Articles must record the last date they
were modified in any way.

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

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

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

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

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

46. 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

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

48. What else can I do?

49. prePersist postLoad
postPersist loadClassMetadata
preUpdate preFlush
postUpdate onFlush
preRemove postFlush
postRemove onClear

50. prePersist postLoad
postPersist loadClassMetadata
preUpdate preFlush
postUpdate onFlush
preRemove postFlush
postRemove onClear

51. Protip:
Only fires if you're dirty

52. new MudWrestling();

53. 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

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

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

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

57. So, here's the thing.

58. The Thing

59. Events are cool.

60. Callbacks?

61. Eeeeeeeeeeeeeeeeeeh.

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

63. Listeners

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

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

66. Invert

67. Invert

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

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

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

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

72. Functionally? No difference
Design? Subscriber

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

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

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

76. 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
);
}

77. 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

78. Whoopity-doo

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

80. 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
);
}

81. 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
);
}

82. 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
);
}

83. The POWAH

84. Flushing And Multiple Events

85. OnFlush

87. TPS Request
After every update to an article, I want
an email of the changes sent to me.
Also, bring me more lettuce.

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

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

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

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

92. 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);
}

93. That's really all there is to it.

94. 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;
}

95. Advice:
Treat your listeners like controllers

96. Keep it thin

97. Crazy Town

99. TPS Request
Write the change messages to the
database instead of emailing them.

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

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

102. 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
);
}

103. Shiny

104. Yes, I really used PHPMyAdmin there

105. Shiny

106. Also, wow, it worked!

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

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

110. UnitOfWork API
And many more...

111. postLoad

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

115. +
MySQL Redis

116. TPS Request
Move view counts out of the database
into a faster system.
And don't break everything.

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

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

119. 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);
}
}

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

121. Many, many other uses.

122. Class Metadata

123. 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;
}

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

125. DoctrineORMMappingClassMetadata

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

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

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

129. Doctrine 2.3 will bring NamingStrategy

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

131. Tip of the Iceberg

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

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

134. Simple Example

135. Symple Example

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

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

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

141. 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', ...);
}

142. Cool, huh?

143. Cool, huh?

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

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

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

148. Oh yeah.

149. You can set all of this stuff.

150. 100~ public functions

151. But is there a good reason?
Unless you're writing a driver, probably not.

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

153. Where's the manatee?

154. You're the manatee.

155. Epilogue & Service Layers

156. Model
Controller
View

157. Model
Service Layer
Controller
View

158. Be smart.

159. Be smart.

160. Be simple

161. Don't overuse this.

162. Test

163. Test test test

164. test test test test test test test test test test
test test test test test test test test test test
test test test test test test test test test test
test test test test test test test test test test
test test test test test test test test test test
test test test test test test test test test test
test test test test test test test test test test
test test test test test test test test test test
test test test test test test test test test test
test test test test test test test test test test
test test test test test test test test test test

165. RTFM.

166. Go forth and rock.

168. You're the manatee.

169. Thanks to:
@boekkooi
#doctrine (freenode)

170. Wikipedia
OwnMoment (sxc.hu)

171. https://joind.in/6251