Advanced Eloquent - Avoiding Unified Data Models in Complex Applications

The traditional approach to data modeling is to create a single unified model for your entire application. We use one User model to represent users in each and every feature. As this relationship graph grows, the data model becomes increasingly difficult to change.

In this session we’ll explore ways to create useful Eloquent models that are smaller, more focused, and are much easier to change.

Transcript

1. avoiding unified data models in complex applications Advanced Eloquent By Shawn McCool
2. Who am I?
3. Why this talk?
4. Refactoring is Good
5. What is a Model?
8. controllers/ helpers/ models/ Invoice.php Member.php views/
9. “Essentially, all models are wrong, but some are useful.” - George E. P. Box
10. “Essentially, all models are wrong, but some are useful.” - George E. P. Box
11. “Essentially, all models are wrong, but some are useful.” - George E. P. Box
12. “Essentially, all models are wrong, but some are useful.” - George E. P. Box
13. “Essentially, all models are wrong, but some are useful.” - George E. P. Box
14. Data Modeling
15. A Bit of History
16. The Hierarchical Model
17. Departments Employees Projects Tasks Clocked Time
18. The Relational Model
19. Departments Employees Projects Tasks Clocked Time
20. Departments Employees Projects Tasks Clocked Time
21. Departments Employees Projects Tasks Clocked Time
22. class User extends Model { public function phone() { return $this->hasOne('App\Phone'); } } class Phone extends Model { public function user() { return $this->belongsTo('App\User'); } }
23. Data Modeling in Laravel
24. Eloquent
25. Eloquent ORM
26. Eloquent ORM ActiveRecord
27. Eloquent ORM ActiveRecord Relationships
28. Eloquent ORM ActiveRecord Relationships Direct Attribute Access
29. Other Data Access Models
30. Other Data Access Models Table Gateway
31. Other Data Access Models Table Gateway Key Value Store
32. Other Data Access Models Table Gateway Key Value Store Document Databases
33. Eloquent
34. Eloquent Small Effort
35. Eloquent Small Effort Tiny Code Footprint
36. Eloquent Small Effort Tiny Code Footprint Easily Access Related Data
37. Eloquent Small Effort Tiny Code Footprint Easily Access Related Data Quality of Life Features
38. Trade-offs
39. Trade-offs Impedance Mismatch
40. Trade-offs Impedance Mismatch Leaks Database Schema
41. Ways that We Leak Schema
43. Fields if ($user->isAdmin) {
44. Fields Models are Tables controllers/ helpers/ models/ Invoice.php Member.php views/
45. Fields Models are Tables Relationships $user->phone->number
47. Data Model
48. Data Model Eloquent Model
49. Controllers Data Model Eloquent Model
50. Controllers Templates Data Model Eloquent Model
51. Javascript Controllers Templates Data Model Eloquent Model
54. class MyClass { use MyTrait; } trait MyTrait {...}
55. class MyClass { use MyTrait; } trait MyTrait {...} MyClass MyTrait
56. class MyController { public function loginForm() { return response(...); } }
57. class MyController { public function loginForm() { return response(...); } } MyController response
58. class User extends Model {...} class Model {...}
59. class User extends Model {...} class Model {...} User Model
60. So, what's wrong with coupling?
61. {{ $post->author->name }}
62. {{ $post->author->name }}
63. {{ $post->author->name }}
64. {{ $post->author->name }}
65. {{ $post->author->name }}
66. {{ $post->author->name }}
67. {{ $post->author->name }}
68. {{ $post->author->name }}
69. {{ $post->author->name }}
70. User Model Model Model Model Model
71. User Model Model Model Model Model Model Model Model Model Model Model Model Model
72. User Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model
73. User Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Model Refactoring?
74. Decoupling Strategy 1 Reduce Leakage
75. Javascript Controllers Templates Data Model Eloquent Model
76. Javascript Controllers Templates Data Model Eloquent Model
77. Javascript Controllers Templates Data Model Eloquent Model
78. class User extends Model { protected $table = 'users'; protected $fillable = [ 'id', 'name', 'email', 'bloodType', 'worstFear', 'bestFriend', ]; }
79. Javascript Controllers Templates Data Model Eloquent Model
80. Javascript Controllers Templates Data Model Eloquent Model
81. class User extends Model { protected $table = 'users'; } echo $user->worstFear;
82. class User extends Model { protected $table = 'users'; public function worstFear() { return $this->attributes['worstFear']; } } echo $user->worstFear();
83. class User extends Model { protected $table = 'users'; public function worstFear() { return $this->attributes['worstFear']; } } echo $user->worstFear(); Why is this safer?
84. class User extends Model { protected $table = 'users'; public function worstFear() { return $this->attributes['worstFear']; } } echo $user->worstFear(); Why is this safer?
85. class User extends Model { protected $table = 'users'; public function worstFear() { return $this->attributes['fear']; } } echo $user->worstFear(); Why is this safer?
86. class User extends Model { protected $table = 'users'; public function worstFear() { return $this->attributes['fear']; } } echo $user->worstFear(); Why is this safer?
87. Decoupling Strategy 2 Reduce Scope
88. User Model Model Model Model Model Model Model Model Model Model Model Model Model
90. Feature
91. Feature Feature
92. Feature Feature Feature
93. Feature Feature Feature
94. Model Model Model Model Feature Feature
95. Model Model Model Model User Model Model Model Feature
96. Model Model Model Model Model Model Model Model User Model Model Model
97. Model Model Model Model Model Model Model Model User Model Model Model
98. Model Model Model Model Model Model Model User Model Model Model
99. Model Model Model Model Model Model Model User Model Model Model But.. how?
100. Events are Magic
102. Event
103. Listener Listener Listener Event
104. Listener Listener Listener Event
105. Event Listener Listener Listener
106. Event Listener Listener Listener
107. Domain Events vs Technical Events
108. Member Registered Send Welcome Email Preload Account with Credit Queue Up
109. Member Registered Send Welcome Email Preload Account with Credit Queue Up
110. Member Registered Send Welcome Email Preload Account with Credit Queue Up
111. Member Registered Send Welcome Email Preload Account with Credit Queue Up
112. Member Registered Send Welcome Email Preload Account with Credit Queue Up
114. Feature Feature Feature
115. Practical Application
117. Conference Management App
118. Conference Management App Speakers Submit Talk Ideas
119. Conference Management App Speakers Submit Talk Ideas Organizers Approve Talk Ideas
120. Conference Management App Speakers Submit Talk Ideas Organizers Approve Talk Ideas Organizers Create a Schedule
121. Feature 0 User Authentication
122. What's the point?
123. User Authentication Authentication Implementation Authentication Password Resets User Authentication
125. class CreateUserAuthenticationAndPasswordResetTables extends Migration { public function up() { Schema::create('user_authentication', function (Blueprint $table) { $table->increments('id'); $table->string('email')->unique(); $table->string('password'); $table->rememberToken(); $table->timestamps(); }); Schema::create('authentication_password_resets', function (Blueprint $table) { $table->string('email')->index(); $table->string('token'); $table->timestamp('created_at')->nullable(); }); } public function down() { Schema::dropIfExists('user_authentication'); Schema::dropIfExists('authentication_password_resets'); } }
126. class CreateUserAuthenticationAndPasswordResetTables extends Migration { public function up() { Schema::create('user_authentication', function (Blueprint $table) { $table->increments('id'); $table->string('email')->unique(); $table->string('password'); $table->rememberToken(); $table->timestamps(); }); Schema::create('authentication_password_resets', function (Blueprint $table) { $table->string('email')->index(); $table->string('token'); $table->timestamp('created_at')->nullable(); }); } public function down() { Schema::dropIfExists('user_authentication'); Schema::dropIfExists('authentication_password_resets'); } }
127. class CreateUserAuthenticationAndPasswordResetTables extends Migration { public function up() { Schema::create('user_authentication', function (Blueprint $table) { $table->increments('id'); $table->string('email')->unique(); $table->string('password'); $table->rememberToken(); $table->timestamps(); }); Schema::create('authentication_password_resets', function (Blueprint $table) { $table->string('email')->index(); $table->string('token'); $table->timestamp('created_at')->nullable(); }); } public function down() { Schema::dropIfExists('user_authentication'); Schema::dropIfExists('authentication_password_resets'); } }
128. class CreateUserAuthenticationAndPasswordResetTables extends Migration { public function up() { Schema::create('user_authentication', function (Blueprint $table) { $table->increments('id'); $table->string('email')->unique(); $table->string('password'); $table->rememberToken(); $table->timestamps(); }); Schema::create('authentication_password_resets', function (Blueprint $table) { $table->string('email')->index(); $table->string('token'); $table->timestamp('created_at')->nullable(); }); } public function down() { Schema::dropIfExists('user_authentication'); Schema::dropIfExists('authentication_password_resets'); } }
130. class UserAuthentication extends User implements ... { protected $table = 'user_authentication'; protected $fillable = [ 'email', 'password', ]; protected $hidden = [ 'password', 'remember_token', ]; public static function register($email, $password) { return static::create([ 'email' => $email, 'password' => Hash::make($password), ]); } }
131. class UserAuthentication extends User implements ... { protected $table = 'user_authentication'; protected $fillable = [ 'email', 'password', ]; protected $hidden = [ 'password', 'remember_token', ]; public static function register($email, $password) { return static::create([ 'email' => $email, 'password' => Hash::make($password), ]); } }
132. class UserAuthentication extends User implements ... { protected $table = 'user_authentication'; protected $fillable = [ 'email', 'password', ]; protected $hidden = [ 'password', 'remember_token', ]; public static function register($email, $password) { return static::create([ 'email' => $email, 'password' => Hash::make($password), ]); } }
133. class UserAuthentication extends User implements ... { protected $table = 'user_authentication'; protected $fillable = [ 'email', 'password', ]; protected $hidden = [ 'password', 'remember_token', ]; public static function register($email, $password) { return static::create([ 'email' => $email, 'password' => Hash::make($password), ]); } }
134. class UserAuthentication extends User implements ... { protected $table = 'user_authentication'; protected $fillable = [ 'email', 'password', ]; protected $hidden = [ 'password', 'remember_token', ]; public static function register($email, $password) { return static::create([ 'email' => $email, 'password' => Hash::make($password), ]); } }
135. Feature 1 Speakers Submit Talks
136. Talk Submission Implementation Talks Speaker User Authentication
138. class Welcome extends Controller { public function welcome() { return view('talk-submission.welcome'); } public function submitLogin(Request $request) { // form validation goes here if (\Auth::attempt([ 'email' => $request->get('email'), 'password' => $request->get('password'), ])) { return redirect()->intended('/submit-talks'); } return redirect('/submit-talks/welcome'); } ...
139. class Welcome extends Controller { public function welcome() { return view('talk-submission.welcome'); } public function submitLogin(Request $request) { // form validation goes here if (\Auth::attempt([ 'email' => $request->get('email'), 'password' => $request->get('password'), ])) { return redirect()->intended('/submit-talks'); } return redirect('/submit-talks/welcome'); } ...
140. class Welcome extends Controller { public function welcome() { return view('talk-submission.welcome'); } public function submitLogin(Request $request) { // form validation goes here if (\Auth::attempt([ 'email' => $request->get('email'), 'password' => $request->get('password'), ])) { return redirect()->intended('/submit-talks'); } return redirect('/submit-talks/welcome'); } ...
141. class Welcome extends Controller { public function welcome() { return view('talk-submission.welcome'); } public function submitLogin(Request $request) { // form validation goes here if (\Auth::attempt([ 'email' => $request->get('email'), 'password' => $request->get('password'), ])) { return redirect()->intended('/submit-talks'); } return redirect('/submit-talks/welcome'); } ...
142. ... public function submitRegistration(Request $request) { // form validation $user = UserAuthentication::register( $request->get('email'), $request->get('password') ); Speaker::register( $user, $request->get('name'), $request->get('email'), $request->get('bioText'), $request->get('imageUrl') ); return redirect('submit-talks'); } }
144. class Speaker extends Model { protected $table = 'talk_submission_speakers'; protected $fillable = ...; public static function register( UserAuthentication $user, $name, $contactEmail, $bioText, $imageUrl) { return static::create([ 'userId' => $user->id, 'name' => $name, 'contactEmail' => $contactEmail, 'bioText' => $bioText, 'imageUrl' => $imageUrl, ]); } public static function forUser(UserAuthentication $user) { return static::where('userId', '=', $user->id)->first(); } }
145. class Speaker extends Model { protected $table = 'talk_submission_speakers'; protected $fillable = ...; public static function register( UserAuthentication $user, $name, $contactEmail, $bioText, $imageUrl) { return static::create([ 'userId' => $user->id, 'name' => $name, 'contactEmail' => $contactEmail, 'bioText' => $bioText, 'imageUrl' => $imageUrl, ]); } public static function forUser(UserAuthentication $user) { return static::where('userId', '=', $user->id)->first(); } }
146. class Speaker extends Model { protected $table = 'talk_submission_speakers'; protected $fillable = ...; public static function register( UserAuthentication $user, $name, $contactEmail, $bioText, $imageUrl) { return static::create([ 'userId' => $user->id, 'name' => $name, 'contactEmail' => $contactEmail, 'bioText' => $bioText, 'imageUrl' => $imageUrl, ]); } public static function forUser(UserAuthentication $user) { return static::where('userId', '=', $user->id)->first(); } }
147. class Speaker extends Model { protected $table = 'talk_submission_speakers'; protected $fillable = ...; public static function register( UserAuthentication $user, $name, $contactEmail, $bioText, $imageUrl) { return static::create([ 'userId' => $user->id, 'name' => $name, 'contactEmail' => $contactEmail, 'bioText' => $bioText, 'imageUrl' => $imageUrl, ]); } public static function forUser(UserAuthentication $user) { return static::where('userId', '=', $user->id)->first(); } }
149. class SubmitTalks extends Controller { public function __construct() { $this->middleware('is-registered-speaker'); } private function speaker() { return Speaker::forUser(\Auth::user()); } public function viewSubmittedTalks() { return view('talk-submission.view-submitted-talks', [ 'talks' => Talk::AllBy($this->speaker()) ]); } public function submitTalkForm() { return view('talk-submission.submit-talk-form'); } ...
150. class SubmitTalks extends Controller { public function __construct() { $this->middleware('is-registered-speaker'); } private function speaker() { return Speaker::forUser(\Auth::user()); } public function viewSubmittedTalks() { return view('talk-submission.view-submitted-talks', [ 'talks' => Talk::AllBy($this->speaker()) ]); } public function submitTalkForm() { return view('talk-submission.submit-talk-form'); } ...
151. class SubmitTalks extends Controller { public function __construct() { $this->middleware('is-registered-speaker'); } private function speaker() { return Speaker::forUser(\Auth::user()); } public function viewSubmittedTalks() { return view('talk-submission.view-submitted-talks', [ 'talks' => Talk::AllBy($this->speaker()) ]); } public function submitTalkForm() { return view('talk-submission.submit-talk-form'); } ...
152. class SubmitTalks extends Controller { public function __construct() { $this->middleware('is-registered-speaker'); } private function speaker() { return Speaker::forUser(\Auth::user()); } public function viewSubmittedTalks() { return view('talk-submission.view-submitted-talks', [ 'talks' => Talk::AllBy($this->speaker()) ]); } public function submitTalkForm() { return view('talk-submission.submit-talk-form'); } ...
153. class SubmitTalks extends Controller { public function __construct() { $this->middleware('is-registered-speaker'); } private function speaker() { return Speaker::forUser(\Auth::user()); } public function viewSubmittedTalks() { return view('talk-submission.view-submitted-talks', [ 'talks' => Talk::AllBy($this->speaker()) ]); } public function submitTalkForm() { return view('talk-submission.submit-talk-form'); } ...
154. ... public function submitTalk(Request $request) { // form validation $talk = Talk::submit( $this->speaker(), $request->get('title'), $request->get('description'), $request->get('notesForOrganizers') ); return redirect('/submit-talks'); } public function viewTalk($talkId) { return view('talk-submission.view-talk', [ 'talk' => Talk::BySpeaker($this->speaker(), $talkId) ]); } }
155. ... public function submitTalk(Request $request) { // form validation $talk = Talk::submit( $this->speaker(), $request->get('title'), $request->get('description'), $request->get('notesForOrganizers') ); return redirect('/submit-talks'); } public function viewTalk($talkId) { return view('talk-submission.view-talk', [ 'talk' => Talk::BySpeaker($this->speaker(), $talkId) ]); } }
156. ... public function submitTalk(Request $request) { // form validation $talk = Talk::submit( $this->speaker(), $request->get('title'), $request->get('description'), $request->get('notesForOrganizers') ); return redirect('/submit-talks'); } public function viewTalk($talkId) { return view('talk-submission.view-talk', [ 'talk' => Talk::BySpeaker($this->speaker(), $talkId) ]); } }
157. Feature 2 Talk Approval
158. Talk Approval Implementation Talks Organizer User Authentication
159. Talk Approval Implementation Talks Organizer ?? User Authentication
160. Talk Approval Implementation Talks ?? Organizer User Authentication
161. Feature Feature Feature
162. Feature Feature Talk Submission
163. Talk Submission Talk Approval Feature
164. Talk Submissions Talk Speaker User Authentication Talk Approval Talk Organizer User Authentication
165. Talk Submissions Talk Speaker User Authentication Talk Approval Talk Organizer User Authentication ?
166. Talk Submissions Talk Speaker User Authentication Talk Approval Talk Organizer User Authentication ? EVENTS!
167. Talk Submissions Talk Approval
168. Talk Was Submitted Talk Submissions Talk Approval Register Submitted Talk
170. <?php namespace App\Events; class TalkWasSubmitted { private $talkId; private $title; private $description; private $notes; private $speakerId; private $speakerName; private $speakerEmail; private $speakerBio; private $speakerImage; public function __construct($talkId, $title, $description, $notes, $speakerId, $speakerName, $speakerEmail, $speakerBio, $speakerImage) { ... } public function talkId() { return $this->talkId; } ... }
172. class Talk extends Model { public static function submit(Speaker $speaker, $title, $description, $notesForOrganizers) { $talk = static::create([ 'speakerId' => $speaker->id, 'title' => $title, 'description' => $description, 'notesForOrganizers' => $notesForOrganizers, ]); event(new TalkWasSubmitted($talk->id, $talk->title, $talk->description, $talk->notesForOrganizers, $speaker->id, $speaker->name, $speaker->contactEmail, $speaker->bioText, $speaker->imageUrl)); return $talk; } }
173. class Talk extends Model { public static function submit(Speaker $speaker, $title, $description, $notesForOrganizers) { $talk = static::create([ 'speakerId' => $speaker->id, 'title' => $title, 'description' => $description, 'notesForOrganizers' => $notesForOrganizers, ]); event(new TalkWasSubmitted($talk->id, $talk->title, $talk->description, $talk->notesForOrganizers, $speaker->id, $speaker->name, $speaker->contactEmail, $speaker->bioText, $speaker->imageUrl)); return $talk; } }
174. class Talk extends Model { public static function submit(Speaker $speaker, $title, $description, $notesForOrganizers) { $talk = static::create([ 'speakerId' => $speaker->id, 'title' => $title, 'description' => $description, 'notesForOrganizers' => $notesForOrganizers, ]); event(new TalkWasSubmitted($talk->id, $talk->title, $talk->description, $talk->notesForOrganizers, $speaker->id, $speaker->name, $speaker->contactEmail, $speaker->bioText, $speaker->imageUrl)); return $talk; } }
175. class Talk extends Model { public static function submit(Speaker $speaker, $title, $description, $notesForOrganizers) { $talk = static::create([ 'speakerId' => $speaker->id, 'title' => $title, 'description' => $description, 'notesForOrganizers' => $notesForOrganizers, ]); event(new TalkWasSubmitted($talk->id, $talk->title, $talk->description, $talk->notesForOrganizers, $speaker->id, $speaker->name, $speaker->contactEmail, $speaker->bioText, $speaker->imageUrl)); return $talk; } }
177. class RegisterSubmittedTalk { // mappings are protection public function handle(TalkWasSubmitted $event) { SubmittedTalk::register( $event->talkId(), $event->title(), $event->description(), $event->notes(), $event->speakerId(), $event->speakerName(), $event->speakerEmail(), $event->speakerBio(), $event->speakerImage() ); } }
178. Talk Was Submitted Talk Submissions Talk Approval Register Submitted Talk
179. Feature 4 Schedule Talks
181. Talk Was Approved Talk Approval Scheduling Auto Schedule Approved Talk
182. Should you use these techniques?
183. Thank you, Laravel Live India 2018 Source Code at http://bit.ly/data-models Twitter @ShawnMcCool Do we have time for questions?