├── README.md
├── images
    ├── logo-english.png
    └── logo-russian.png
└── russian.md


/README.md:
--------------------------------------------------------------------------------
  1 | ![Laravel best practices](/images/logo-english.png?raw=true)
  2 | 
  3 | Translations:
  4 | 
  5 | [Русский](russian.md)
  6 | 
  7 | 
  8 | 
  9 | It's not a Laravel adaptation of SOLID principles, patterns etc. Here you'll find the best practices which are usually ignored in real life Laravel projects.
 10 | 
 11 | ## Contents
 12 | 
 13 | [Single responsibility principle](#single-responsibility-principle)
 14 | 
 15 | [Fat models, skinny controllers](#fat-models-skinny-controllers)
 16 | 
 17 | [Validation](#validation)
 18 | 
 19 | [Business logic should be in service class](#business-logic-should-be-in-service-class)
 20 | 
 21 | [Don't repeat yourself (DRY)](#dont-repeat-yourself-dry)
 22 | 
 23 | [Prefer to use Eloquent over using Query Builder and raw SQL queries. Prefer collections over arrays](#prefer-to-use-eloquent-over-using-query-builder-and-raw-sql-queries-prefer-collections-over-arrays)
 24 | 
 25 | [Mass assignment](#mass-assignment)
 26 | 
 27 | [Do not execute queries in Blade templates and use eager loading (N + 1 problem)](#do-not-execute-queries-in-blade-templates-and-use-eager-loading-n--1-problem)
 28 | 
 29 | [Comment your code, but prefer descriptive method and variable names over comments](#comment-your-code-but-prefer-descriptive-method-and-variable-names-over-comments)
 30 | 
 31 | [Do not put JS and CSS in Blade templates and do not put any HTML in PHP classes](#do-not-put-js-and-css-in-blade-templates-and-do-not-put-any-html-in-php-classes)
 32 | 
 33 | [Use config and language files, constants instead of text in the code](#use-config-and-language-files-constants-instead-of-text-in-the-code)
 34 | 
 35 | [Use standard Laravel tools accepted by community](#use-standard-laravel-tools-accepted-by-community)
 36 | 
 37 | [Follow Laravel naming conventions](#follow-laravel-naming-conventions)
 38 | 
 39 | [Use shorter and more readable syntax where possible](#use-shorter-and-more-readable-syntax-where-possible)
 40 | 
 41 | [Use IoC container or facades instead of new Class](#use-ioc-container-or-facades-instead-of-new-class)
 42 | 
 43 | [Do not get data from the `.env` file directly](#do-not-get-data-from-the-env-file-directly)
 44 | 
 45 | [Store dates in the standard format. Use accessors and mutators to modify date format](#store-dates-in-the-standard-format-use-accessors-and-mutators-to-modify-date-format)
 46 | 
 47 | [Other good practices](#other-good-practices)
 48 | 
 49 | ### **Single responsibility principle**
 50 | 
 51 | A class and a method should have only one responsibility.
 52 | 
 53 | Bad:
 54 | 
 55 | ```php
 56 | public function getFullNameAttribute()
 57 | {
 58 |     if (auth()->user() && auth()->user()->hasRole('client') && auth()->user()->isVerified()) {
 59 |         return 'Mr. ' . $this->first_name . ' ' . $this->middle_name . ' ' $this->last_name;
 60 |     } else {
 61 |         return $this->first_name[0] . '. ' . $this->last_name;
 62 |     }
 63 | }
 64 | ```
 65 | 
 66 | Good:
 67 | 
 68 | ```php
 69 | public function getFullNameAttribute()
 70 | {
 71 |     return $this->isVerifiedClient() ? $this->getFullNameLong() : $this->getFullNameShort();
 72 | }
 73 | 
 74 | public function isVerfiedClient()
 75 | {
 76 |     return auth()->user() && auth()->user()->hasRole('client') && auth()->user()->isVerified();
 77 | }
 78 | 
 79 | public function getFullNameLong()
 80 | {
 81 |     return 'Mr. ' . $this->first_name . ' ' . $this->middle_name . ' ' . $this->last_name;
 82 | }
 83 | 
 84 | public function getFullNameShort()
 85 | {
 86 |     return $this->first_name[0] . '. ' . $this->last_name;
 87 | }
 88 | ```
 89 | 
 90 | [🔝 Back to contents](#contents)
 91 | 
 92 | ### **Fat models, skinny controllers**
 93 | 
 94 | Put all DB related logic into Eloquent models or into Repository classes if you're using Query Builder or raw SQL queries.
 95 | 
 96 | Bad:
 97 | 
 98 | ```php
 99 | public function index()
100 | {
101 |     $clients = Client::verified()
102 |         ->with(['orders' => function ($q) {
103 |             $q->where('created_at', '>', Carbon::today()->subWeek());
104 |         }])
105 |         ->get();
106 | 
107 |     return view('index', ['clients' => $clients]);
108 | }
109 | ```
110 | 
111 | Good:
112 | 
113 | ```php
114 | public function index()
115 | {
116 |     return view('index', ['clients' => $this->client->getWithNewOrders()]);
117 | }
118 | 
119 | Class Client extends Model
120 | {
121 |     public function getWithNewOrders()
122 |     {
123 |         return $this->verified()
124 |             ->with(['orders' => function ($q) {
125 |                 $q->where('created_at', '>', Carbon::today()->subWeek());
126 |             }])
127 |             ->get();
128 |     }
129 | }
130 | ```
131 | 
132 | [🔝 Back to contents](#contents)
133 | 
134 | ### **Validation**
135 | 
136 | Move validation from controllers to Request classes.
137 | 
138 | Bad:
139 | 
140 | ```php
141 | public function store(Request $request)
142 | {
143 |     $request->validate([
144 |         'title' => 'required|unique:posts|max:255',
145 |         'body' => 'required',
146 |         'publish_at' => 'nullable|date',
147 |     ]);
148 | 
149 |     ....
150 | }
151 | ```
152 | 
153 | Good:
154 | 
155 | ```php
156 | public function store(PostRequest $request)
157 | {    
158 |     ....
159 | }
160 | 
161 | class PostRequest extends Request
162 | {
163 |     public function rules()
164 |     {
165 |         return [
166 |             'title' => 'required|unique:posts|max:255',
167 |             'body' => 'required',
168 |             'publish_at' => 'nullable|date',
169 |         ];
170 |     }
171 | }
172 | ```
173 | 
174 | [🔝 Back to contents](#contents)
175 | 
176 | ### **Business logic should be in service class**
177 | 
178 | A controller must have only one responsibility, so move business logic from controllers to service classes.
179 | 
180 | Bad:
181 | 
182 | ```php
183 | public function store(Request $request)
184 | {
185 |     if ($request->hasFile('image')) {
186 |         $request->file('image')->move(public_path('images') . 'temp');
187 |     }
188 |     
189 |     ....
190 | }
191 | ```
192 | 
193 | Good:
194 | 
195 | ```php
196 | public function store(Request $request)
197 | {
198 |     $this->articleService->handleUploadedImage($request->file('image'));
199 | 
200 |     ....
201 | }
202 | 
203 | class ArticleService
204 | {
205 |     public function handleUploadedImage($image)
206 |     {
207 |         if (!is_null($image)) {
208 |             $image->move(public_path('images') . 'temp');
209 |         }
210 |     }
211 | }
212 | ```
213 | 
214 | [🔝 Back to contents](#contents)
215 | 
216 | ### **Don't repeat yourself (DRY)**
217 | 
218 | Reuse code when you can. SRP is helping you to avoid duplication. Also, reuse Blade templates, use Eloquent scopes etc.
219 | 
220 | Bad:
221 | 
222 | ```php
223 | public function getActive()
224 | {
225 |     return $this->where('verified', 1)->whereNotNull('deleted_at')->get();
226 | }
227 | 
228 | public function getArticles()
229 | {
230 |     return $this->whereHas('user', function ($q) {
231 |             $q->where('verified', 1)->whereNotNull('deleted_at');
232 |         })->get();
233 | }
234 | ```
235 | 
236 | Good:
237 | 
238 | ```php
239 | public function scopeActive($q)
240 | {
241 |     return $q->where('verified', 1)->whereNotNull('deleted_at');
242 | }
243 | 
244 | public function getActive()
245 | {
246 |     return $this->active()->get();
247 | }
248 | 
249 | public function getArticles()
250 | {
251 |     return $this->whereHas('user', function ($q) {
252 |             $q->active();
253 |         })->get();
254 | }
255 | ```
256 | 
257 | [🔝 Back to contents](#contents)
258 | 
259 | ### **Prefer to use Eloquent over using Query Builder and raw SQL queries. Prefer collections over arrays**
260 | 
261 | Eloquent allows you to write readable and maintainable code. Also, Eloquent has great built-in tools like soft deletes, events, scopes etc.
262 | 
263 | Bad:
264 | 
265 | ```sql
266 | SELECT *
267 | FROM `articles`
268 | WHERE EXISTS (SELECT *
269 |               FROM `users`
270 |               WHERE `articles`.`user_id` = `users`.`id`
271 |               AND EXISTS (SELECT *
272 |                           FROM `profiles`
273 |                           WHERE `profiles`.`user_id` = `users`.`id`) 
274 |               AND `users`.`deleted_at` IS NULL)
275 | AND `verified` = '1'
276 | AND `active` = '1'
277 | ORDER BY `created_at` DESC
278 | ```
279 | 
280 | Good:
281 | 
282 | ```php
283 | Article::has('user.profile')->verified()->latest()->get();
284 | ```
285 | 
286 | [🔝 Back to contents](#contents)
287 | 
288 | ### **Mass assignment**
289 | 
290 | Bad:
291 | 
292 | ```php
293 | $article = new Article;
294 | $article->title = $request->title;
295 | $article->content = $request->content;
296 | $article->verified = $request->verified;
297 | // Add category to article
298 | $article->category_id = $category->id;
299 | $article->save();
300 | ```
301 | 
302 | Good:
303 | 
304 | ```php
305 | $category->article()->create($request->all());
306 | ```
307 | 
308 | [🔝 Back to contents](#contents)
309 | 
310 | ### **Do not execute queries in Blade templates and use eager loading (N + 1 problem)**
311 | 
312 | Bad (for 100 users, 101 DB queries will be executed):
313 | 
314 | ```php
315 | @foreach (User::all() as $user)
316 |     {{ $user->profile->name }}
317 | @endforeach
318 | ```
319 | 
320 | Good (for 100 users, 2 DB queries will be executed):
321 | 
322 | ```php
323 | $users = User::with('profile')->get();
324 | 
325 | ...
326 | 
327 | @foreach ($users as $user)
328 |     {{ $user->profile->name }}
329 | @endforeach
330 | ```
331 | 
332 | [🔝 Back to contents](#contents)
333 | 
334 | ### **Comment your code, but prefer descriptive method and variable names over comments**
335 | 
336 | Bad:
337 | 
338 | ```php
339 | if (count((array) $builder->getQuery()->joins) > 0)
340 | ```
341 | 
342 | Better:
343 | 
344 | ```php
345 | // Determine if there are any joins.
346 | if (count((array) $builder->getQuery()->joins) > 0)
347 | ```
348 | 
349 | Good:
350 | 
351 | ```php
352 | if ($this->hasJoins())
353 | ```
354 | 
355 | [🔝 Back to contents](#contents)
356 | 
357 | ### **Do not put JS and CSS in Blade templates and do not put any HTML in PHP classes**
358 | 
359 | Bad:
360 | 
361 | ```php
362 | let article = `{{ json_encode($article) }}`;
363 | ```
364 | 
365 | Better:
366 | 
367 | ```php
368 | <input id="article" type="hidden" value="{{ json_encode($article) }}">
369 | 
370 | Or
371 | 
372 | <button class="js-fav-article" data-article="{{ json_encode($article) }}">{{ $article->name }}<button>
373 | ```
374 | 
375 | In a Javascript file:
376 | 
377 | ```php
378 | let article = $('#article').val();
379 | ```
380 | 
381 | The best way is to use specialized PHP to JS package to transfer the data.
382 | 
383 | [🔝 Back to contents](#contents)
384 | 
385 | ### **Use config and language files, constants instead of text in the code**
386 | 
387 | Bad:
388 | 
389 | ```php
390 | public function isNormal()
391 | {
392 |     return $article->type === 'normal';
393 | }
394 | 
395 | return back()->with('message', 'Your article has been added!');
396 | ```
397 | 
398 | Good:
399 | 
400 | ```php
401 | public function isNormal()
402 | {
403 |     return $article->type === Article::TYPE_NORMAL;
404 | }
405 | 
406 | return back()->with('message', __('app.article_added'));
407 | ```
408 | 
409 | [🔝 Back to contents](#contents)
410 | 
411 | ### **Use standard Laravel tools accepted by community**
412 | 
413 | Prefer to use built-in Laravel functionality and community packages instead of using 3rd party packages and tools. Any developer who will work with your app in the future will need to learn new tools. Also, chances to get help from the Laravel community are significantly lower when you're using a 3rd party package or tool. Do not make your client pay for that.
414 | 
415 | Task | Standard tools | 3rd party tools
416 | ------------ | ------------- | -------------
417 | Authorization | Policies | Entrust, Sentinel and other packages
418 | Compiling assets | Laravel Mix | Grunt, Gulp, 3rd party packages
419 | Development Environment | Homestead | Docker
420 | Deployment | Laravel Forge | Deployer and other solutions
421 | Unit testing | PHPUnit, Mockery | Phpspec
422 | Browser testing | Laravel Dusk | Codeception
423 | DB | Eloquent | SQL, Doctrine
424 | Templates | Blade | Twig
425 | Working with data | Laravel collections | Arrays
426 | Form validation | Request classes | 3rd party packages, validation in controller
427 | Authentication | Built-in | 3rd party packages, your own solution
428 | API authentication | Laravel Passport | 3rd party JWT and OAuth packages
429 | Creating API | Built-in | Dingo API and similar packages
430 | Working with DB structure | Migrations | Working with DB structure directly
431 | Localization | Built-in | 3rd party packages
432 | Realtime user interfaces | Laravel Echo, Pusher | 3rd party packages and working with WebSockets directly
433 | Generating testing data | Seeder classes, Model Factories, Faker | Creating testing data manually
434 | Task scheduling | Laravel Task Scheduler | Scripts and 3rd party packages
435 | DB | MySQL, PostgreSQL, SQLite, SQL Server | MongoDB
436 | 
437 | [🔝 Back to contents](#contents)
438 | 
439 | ### **Follow Laravel naming conventions**
440 | 
441 |  Follow [PSR standards](http://www.php-fig.org/psr/psr-2/).
442 |  
443 |  Also, follow naming conventions accepted by Laravel community:
444 | 
445 | What | How | Good | Bad
446 | ------------ | ------------- | ------------- | -------------
447 | Controller | singular | ArticleController | ~~ArticlesController~~
448 | Route | plural | articles/1 | ~~article/1~~
449 | Named route | snake_case with dot notation | users.show_active | ~~users.show-active, show-active-users~~
450 | Model | singular | User | ~~Users~~
451 | hasOne or belongsTo relationship | singular | articleComment | ~~articleComments, article_comment~~
452 | All other relationships | plural | articleComments | ~~articleComment, article_comments~~
453 | Table | plural | article_comments | ~~article_comment, articleComments~~
454 | Pivot table | singular model names in alphabetical order | article_user | ~~user_article, articles_users~~
455 | Table column | snake_case without model name | meta_title | ~~MetaTitle; article_meta_title~~
456 | Foreign key | singular model name with _id suffix | article_id | ~~ArticleId, id_article, articles_id~~
457 | Primary key | - | id | ~~custom_id~~
458 | Migration | - | 2017_01_01_000000_create_articles_table | ~~2017_01_01_000000_articles~~
459 | Method | camelCase | getAll | ~~get_all~~
460 | Method in resource controller | [table](https://laravel.com/docs/master/controllers#resource-controllers) | store | ~~saveArticle~~
461 | Method in test class | camelCase | testGuestCannotSeeArticle | ~~test_guest_cannot_see_article~~
462 | Variable | camelCase | $articlesWithAuthor | ~~$articles_with_author~~
463 | Collection | descriptive, plural | $activeUsers = User::active()->get() | ~~$active, $data~~
464 | Object | descriptive, singular | $activeUser = User::active()->first() | ~~$users, $obj~~
465 | Config and language files index | snake_case | articles_enabled | ~~ArticlesEnabled; articles-enabled~~
466 | View | snake_case | show_filtered.blade.php | ~~showFiltered.blade.php, show-filtered.blade.php~~
467 | Config | snake_case | google_calendar.php | ~~googleCalendar.php, google-calendar.php~~
468 | Contract (interface) | adjective or noun | Authenticatable | ~~AuthenticationInterface, IAuthentication~~
469 | Trait | adjective | Notifiable | ~~NotificationTrait~~
470 | 
471 | [🔝 Back to contents](#contents)
472 | 
473 | ### **Use shorter and more readable syntax where possible**
474 | 
475 | Bad:
476 | 
477 | ```php
478 | $request->session()->get('cart');
479 | $request->input('name');
480 | ```
481 | 
482 | Good:
483 | 
484 | ```php
485 | session('cart');
486 | $request->name;
487 | ```
488 | 
489 | More examples:
490 | 
491 | Common syntax | Shorter and more readable syntax
492 | ------------ | -------------
493 | `Session::get('cart')` | `session('cart')`
494 | `$request->session()->get('cart')` | `session('cart')`
495 | `Session::put('cart', $data)` | `session(['cart' => $data])`
496 | `$request->input('name'), Request::get('name')` | `$request->name, request('name')`
497 | `return Redirect::back()` | `return back()`
498 | `is_null($object->relation) ? $object->relation->id : null }` | `optional($object->relation)->id`
499 | `return view('index')->with('title', $title)->with('client', $client)` | `return view('index', compact('title', 'client'))`
500 | `$request->has('value') ? $request->value : 'default';` | `$request->get('value', 'default')`
501 | `Carbon::now(), Carbon::today()` | `now(), today()`
502 | `App::make('Class')` | `app('Class')`
503 | `->where('column', '=', 1)` | `->where('column', 1)`
504 | `->orderBy('created_at', 'desc')` | `->latest()`
505 | `->orderBy('age', 'desc')` | `->latest('age')`
506 | `->orderBy('created_at', 'asc')` | `->oldest()`
507 | `->select('id', 'name')->get()` | `->get(['id', 'name'])`
508 | `->first()->name` | `->value('name')`
509 | 
510 | [🔝 Back to contents](#contents)
511 | 
512 | ### **Use IoC container or facades instead of new Class**
513 | 
514 | new Class syntax creates tight coupling between classes and complicates testing. Use IoC container or facades instead.
515 | 
516 | Bad:
517 | 
518 | ```php
519 | $user = new User;
520 | $user->create($request->all());
521 | ```
522 | 
523 | Good:
524 | 
525 | ```php
526 | public function __construct(User $user)
527 | {
528 |     $this->user = $user;
529 | }
530 | 
531 | ....
532 | 
533 | $this->user->create($request->all());
534 | ```
535 | 
536 | [🔝 Back to contents](#contents)
537 | 
538 | ### **Do not get data from the `.env` file directly**
539 | 
540 | Pass the data to config files instead and then use the `config()` helper function to use the data in an application.
541 | 
542 | Bad:
543 | 
544 | ```php
545 | $apiKey = env('API_KEY');
546 | ```
547 | 
548 | Good:
549 | 
550 | ```php
551 | // config/api.php
552 | 'key' => env('API_KEY'),
553 | 
554 | // Use the data
555 | $apiKey = config('api.key');
556 | ```
557 | 
558 | [🔝 Back to contents](#contents)
559 | 
560 | ### **Store dates in the standard format. Use accessors and mutators to modify date format**
561 | 
562 | Bad:
563 | 
564 | ```php
565 | {{ Carbon::createFromFormat('Y-d-m H-i', $object->ordered_at)->toDateString() }}
566 | {{ Carbon::createFromFormat('Y-d-m H-i', $object->ordered_at)->format('m-d') }}
567 | ```
568 | 
569 | Good:
570 | 
571 | ```php
572 | // Model
573 | protected $dates = ['ordered_at', 'created_at', 'updated_at']
574 | public function getMonthDayAttribute($date)
575 | {
576 |     return $date->format('m-d');
577 | }
578 | 
579 | // View
580 | {{ $object->ordered_at->toDateString() }}
581 | {{ $object->ordered_at->monthDay }}
582 | ```
583 | 
584 | [🔝 Back to contents](#contents)
585 | 
586 | ### **Other good practices**
587 | 
588 | Never put any logic in routes files.
589 | 
590 | Minimize usage of vanilla PHP in Blade templates.
591 | 
592 | [🔝 Back to contents](#contents)
593 | 


--------------------------------------------------------------------------------
/images/logo-english.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/rizwansaleem70/laravel-best-practices/8a91520a30a3c0903e841205a4ddae287301f289/images/logo-english.png


--------------------------------------------------------------------------------
/images/logo-russian.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/rizwansaleem70/laravel-best-practices/8a91520a30a3c0903e841205a4ddae287301f289/images/logo-russian.png


--------------------------------------------------------------------------------
/russian.md:
--------------------------------------------------------------------------------
  1 | ![Хорошие практики Laravel](/images/logo-russian.png?raw=true)
  2 | 
  3 | Это не пересказ лучших практик вроде SOLID, паттернов и пр. с адаптацией под Laravel. Здесь собраны именно практики, которые игнорируются в реальных Laravel проектах. Также, рекомендую ознакомитсья с [хорошими практиками в контексте PHP](https://github.com/jupeter/clean-code-php). Смотрите также [обсуждение хороших практик Laravel](https://laravel.ru/forum/viewforum.php?id=17).
  4 | 
  5 | ## Содержание
  6 | 
  7 | [Принцип единственной ответственности (Single responsibility principle)](#Принцип-единственной-ответственности-single-responsibility-principle)
  8 | 
  9 | [Тонкие контроллеры, толстые модели](#Тонкие-контроллеры-толстые-модели)
 10 | 
 11 | [Валидация](#Валидация)
 12 | 
 13 | [Бизнес логика в сервис-классах](#Бизнес-логика-в-сервис-классах)
 14 | 
 15 | [Не повторяйся (DRY)](#Не-повторяйся-dry)
 16 | 
 17 | [Предпочитайте Eloquent конструктору запросов (query builder) и сырым запросам в БД. Предпочитайте работу с коллекциями работе с массивами](#Предпочитайте-eloquent-конструктору-запросов-query-builder-и-сырым-запросам-в-БД-Предпочитайте-работу-с-коллекциями-работе-с-массивами)
 18 | 
 19 | [Используйте массовое заполнение (mass assignment)](#Используйте-массовое-заполнение-mass-assignment)
 20 | 
 21 | [Не выполняйте запросы в представлениях и используйте нетерпеливую загрузку (проблема N + 1)](#Не-выполняйте-запросы-в-представлениях-и-используйте-нетерпеливую-загрузку-проблема-n--1)
 22 | 
 23 | [Комментируйте код, предпочитайте читаемые имена методов комментариям](#Комментируйте-код-предпочитайте-читаемые-имена-методов-комментариям)
 24 | 
 25 | [Выносите JS и CSS из шаблонов Blade и HTML из PHP кода](#Выносите-js-и-css-из-шаблонов-blade-и-html-из-php-кода)
 26 | 
 27 | [Используйте инструменты и практики принятые сообществом](#Используйте-инструменты-и-практики-принятые-сообществом)
 28 | 
 29 | [Соблюдайте соглашения сообщества об именовании](#Соблюдайте-соглашения-сообщества-об-именовании)
 30 | 
 31 | [Конфиги, языковые файлы и константы вместо текста в коде](#Конфиги-языковые-файлы-и-константы-вместо-текста-в-коде)
 32 | 
 33 | [Короткий и читаемый синтаксис там, где это возможно](#Короткий-и-читаемый-синтаксис-там-где-это-возможно)
 34 | 
 35 | [Используйте IoC или фасады вместо new Class](#Используйте-ioc-или-фасады-вместо-new-class)
 36 | 
 37 | [Не работайте с данными из файла `.env` напрямую](#Не-работайте-с-данными-из-файла-env-напрямую)
 38 | 
 39 | [Храните даты в стандартном формате. Используйте читатели и преобразователи для преобразования формата](#Храните-даты-в-стандартном-формате-Используйте-читатели-и-преобразователи-для-преобразования-формата)
 40 | 
 41 | [Другие советы и практики](#Другие-советы-и-практики)
 42 | 
 43 | ### **Принцип единственной ответственности (Single responsibility principle)**
 44 | 
 45 | Каждый класс и метод должны выполнять лишь одну функцию.
 46 | 
 47 | Плохо:
 48 | 
 49 | ```
 50 | public function getFullNameAttribute()
 51 | {
 52 |     if (auth()->user() && auth()->user()->hasRole('client') && auth()->user()->isVerified()) {
 53 |         return 'Mr. ' . $this->first_name . ' ' . $this->middle_name . ' ' $this->last_name;
 54 |     } else {
 55 |         return $this->first_name[0] . '. ' . $this->last_name;
 56 |     }
 57 | }
 58 | ```
 59 | 
 60 | Хорошо:
 61 | 
 62 | ```
 63 | public function getFullNameAttribute()
 64 | {
 65 |     return $this->isVerifiedClient() ? $this->getFullNameLong() : $this->getFullNameShort();
 66 | }
 67 | 
 68 | public function isVerfiedClient()
 69 | {
 70 |     return auth()->user() && auth()->user()->hasRole('client') && auth()->user()->isVerified();
 71 | }
 72 | 
 73 | public function getFullNameLong()
 74 | {
 75 |     return 'Mr. ' . $this->first_name . ' ' . $this->middle_name . ' ' . $this->last_name;
 76 | }
 77 | 
 78 | public function getFullNameShort()
 79 | {
 80 |     return $this->first_name[0] . '. ' . $this->last_name;
 81 | }
 82 | ```
 83 | 
 84 | [🔝 Наверх](#Содержание)
 85 | 
 86 | ### **Тонкие контроллеры, толстые модели**
 87 | 
 88 | По своей сути, это лишь один из частных случаев принципа единой ответственности. Выносите работу с данными в модели при работе с Eloquent или в репозитории при работе с Query Builder или "сырыми" SQL запросами.
 89 | 
 90 | Плохо:
 91 | 
 92 | ```
 93 | public function index()
 94 | {
 95 |     $clients = Client::verified()
 96 |         ->with(['orders' => function ($q) {
 97 |             $q->where('created_at', '>', Carbon::today()->subWeek());
 98 |         }])
 99 |         ->get();
100 | 
101 |     return view('index', ['clients' => $clients]);
102 | }
103 | ```
104 | 
105 | Хорошо:
106 | 
107 | ```
108 | public function index()
109 | {
110 |     return view('index', ['clients' => $this->client->getWithNewOrders()]);
111 | }
112 | 
113 | Class Client extends Model
114 | {
115 |     public function getWithNewOrders()
116 |     {
117 |         return $this->verified()
118 |             ->with(['orders' => function ($q) {
119 |                 $q->where('created_at', '>', Carbon::today()->subWeek());
120 |             }])
121 |             ->get();
122 |     }
123 | }
124 | ```
125 | 
126 | [🔝 Наверх](#Содержание)
127 | 
128 | ### **Валидация**
129 | 
130 | Следуя принципам тонкого контроллера и SRP, выносите валидацию из контроллера в Request классы.
131 | 
132 | Плохо:
133 | 
134 | ```
135 | public function store(Request $request)
136 | {
137 |     $request->validate([
138 |         'title' => 'required|unique:posts|max:255',
139 |         'body' => 'required',
140 |         'publish_at' => 'nullable|date',
141 |     ]);
142 | 
143 |     ....
144 | }
145 | ```
146 | 
147 | Хорошо:
148 | 
149 | ```
150 | public function store(PostRequest $request)
151 | {    
152 |     ....
153 | }
154 | 
155 | class PostRequest extends Request
156 | {
157 |     public function rules()
158 |     {
159 |         return [
160 |             'title' => 'required|unique:posts|max:255',
161 |             'body' => 'required',
162 |             'publish_at' => 'nullable|date',
163 |         ];
164 |     }
165 | }
166 | ```
167 | 
168 | [🔝 Наверх](#Содержание)
169 | 
170 | ### **Бизнес логика в сервис-классах**
171 | 
172 | Контроллер должен выполнять только свои прямые обязанности, поэтому выносите всю бизнес логику в отдельные классы и сервис классы.
173 | 
174 | Плохо:
175 | 
176 | ```
177 | public function store(Request $request)
178 | {
179 |     if ($request->hasFile('image')) {
180 |         $request->file('image')->move(public_path('images') . 'temp');
181 |     }
182 |     
183 |     ....
184 | }
185 | ```
186 | 
187 | Хорошо:
188 | 
189 | ```
190 | public function store(Request $request)
191 | {
192 |     $this->articleService->handleUploadedImage($request->file('image'));
193 | 
194 |     ....
195 | }
196 | 
197 | class ArticleService
198 | {
199 |     public function handleUploadedImage($image)
200 |     {
201 |         if (!is_null($image)) {
202 |             $image->move(public_path('images') . 'temp');
203 |         }
204 |     }
205 | }
206 | ```
207 | 
208 | [🔝 Наверх](#Содержание)
209 | 
210 | ### **Не повторяйся (DRY)**
211 | 
212 | Этот принцип призывает вас переиспользовать код везде, где это возможно. Если вы следуете принципу SRP, вы уже избегаете повторений, но Laravel позволяет вам также переиспользовать представления, части Eloquent запросов и т.д.
213 | 
214 | Плохо:
215 | 
216 | ```
217 | public function getActive()
218 | {
219 |     return $this->where('verified', 1)->whereNotNull('deleted_at')->get();
220 | }
221 | 
222 | public function getArticles()
223 | {
224 |     return $this->whereHas('user', function ($q) {
225 |             $q->where('verified', 1)->whereNotNull('deleted_at');
226 |         })->get();
227 | }
228 | ```
229 | 
230 | Хорошо:
231 | 
232 | ```
233 | public function scopeActive($q)
234 | {
235 |     return $q->where('verified', 1)->whereNotNull('deleted_at');
236 | }
237 | 
238 | public function getActive()
239 | {
240 |     return $this->active()->get();
241 | }
242 | 
243 | public function getArticles()
244 | {
245 |     return $this->whereHas('user', function ($q) {
246 |             $q->active();
247 |         })->get();
248 | }
249 | ```
250 | 
251 | [🔝 Наверх](#Содержание)
252 | 
253 | ### **Предпочитайте Eloquent конструктору запросов (query builder) и сырым запросам в БД. Предпочитайте работу с коллекциями работе с массивами**
254 | 
255 | Eloquent позволяет писать максимально читаемый код, а изменять функционал приложения несоизмеримо легче. У Eloquent также есть ряд удобных и мощных инструментов.
256 | 
257 | Плохо:
258 | 
259 | ```
260 | SELECT *
261 | FROM `articles`
262 | WHERE EXISTS (SELECT *
263 |               FROM `users`
264 |               WHERE `articles`.`user_id` = `users`.`id`
265 |               AND EXISTS (SELECT *
266 |                           FROM `profiles`
267 |                           WHERE `profiles`.`user_id` = `users`.`id`) 
268 |               AND `users`.`deleted_at` IS NULL)
269 | AND `verified` = '1'
270 | AND `active` = '1'
271 | ORDER BY `created_at` DESC
272 | ```
273 | 
274 | Хорошо:
275 | 
276 | ```
277 | Article::has('user.profile')->verified()->latest()->get();
278 | ```
279 | 
280 | [🔝 Наверх](#Содержание)
281 | 
282 | ### **Используйте массовое заполнение (mass assignment)**
283 | 
284 | Плохо:
285 | 
286 | ```
287 | $article = new Article;
288 | $article->title = $request->title;
289 | $article->content = $request->content;
290 | $article->verified = $request->verified;
291 | // Привязать статью к категории.
292 | $article->category_id = $category->id;
293 | $article->save();
294 | ```
295 | 
296 | Хорошо:
297 | 
298 | ```
299 | $category->article()->create($request->all());
300 | ```
301 | 
302 | [🔝 Наверх](#Содержание)
303 | 
304 | ### **Не выполняйте запросы в представлениях и используйте нетерпеливую загрузку (проблема N + 1)**
305 | 
306 | Плохо (будет выполнен 101 запрос в БД для 100 пользователей):
307 | 
308 | ```
309 | @foreach (User::all() as $user)
310 |     {{ $user->profile->name }}
311 | @endforeach
312 | ```
313 | 
314 | Хорошо (будет выполнено 2 запроса в БД для 100 пользователей):
315 | 
316 | ```
317 | $users = User::with('profile')->get();
318 | 
319 | ...
320 | 
321 | @foreach ($users as $user)
322 |     {{ $user->profile->name }}
323 | @endforeach
324 | ```
325 | 
326 | [🔝 Наверх](#Содержание)
327 | 
328 | ### **Комментируйте код, предпочитайте читаемые имена методов комментариям**
329 | 
330 | Плохо:
331 | 
332 | ```
333 | if (count((array) $builder->getQuery()->joins) > 0)
334 | ```
335 | 
336 | Лучше:
337 | 
338 | ```
339 | // Determine if there are any joins.
340 | if (count((array) $builder->getQuery()->joins) > 0)
341 | ```
342 | 
343 | Хорошо:
344 | 
345 | ```
346 | if ($this->hasJoins())
347 | ```
348 | 
349 | [🔝 Наверх](#Содержание)
350 | 
351 | ### **Выносите JS и CSS из шаблонов Blade и HTML из PHP кода**
352 | 
353 | Плохо:
354 | 
355 | ```
356 | let article = `{{ json_encode($article) }}`;
357 | ```
358 | 
359 | Лучше:
360 | 
361 | ```
362 | <input id="article" type="hidden" value="{{ json_encode($article) }}">
363 | 
364 | Или
365 | 
366 | <button class="js-fav-article" data-article="{{ json_encode($article) }}">{{ $article->name }}<button>
367 | ```
368 | 
369 | В Javascript файле:
370 | 
371 | ```
372 | let article = $('#article').val();
373 | ```
374 | 
375 | Еще лучше использовать специализированный пакет для передачи данных из бэкенда во фронтенд.
376 | 
377 | [🔝 Наверх](#Содержание)
378 | 
379 | ### **Конфиги, языковые файлы и константы вместо текста в коде**
380 | 
381 | Непосредственно в коде не должно быть никакого текста.
382 | 
383 | Плохо:
384 | 
385 | ```
386 | public function isNormal()
387 | {
388 |     return $article->type === 'normal';
389 | }
390 | 
391 | return back()->with('message', 'Ваша статья была успешно добавлена');
392 | ```
393 | 
394 | Хорошо:
395 | 
396 | ```
397 | public function isNormal()
398 | {
399 |     return $article->type === Article::TYPE_NORMAL;
400 | }
401 | 
402 | return back()->with('message', __('app.article_added'));
403 | ```
404 | 
405 | [🔝 Наверх](#Содержание)
406 | 
407 | ### **Используйте инструменты и практики принятые сообществом**
408 | 
409 | Laravel имеет встроенные инструменты для решения часто встречаемых задач. Предпочитайте пользоваться ими использованию сторонних пакетов и инструментов. Laravel разработчику, пришедшему в проект после вас, придется изучать и работать с новым для него инструментом, со всеми вытекающими последствиями. Получить помощь от сообщества будет также гораздо труднее. Не заставляйте клиента или работодателя платить за ваши велосипеды.
410 | 
411 | Задача | Стандартные инструмент | Нестандартные инструмент
412 | ------------ | ------------- | -------------
413 | Авторизация | Политики | Entrust, Sentinel и др. пакеты, собственное решение
414 | Работа с JS, CSS и пр. | Laravel Mix | Grunt, Gulp, сторонние пакеты
415 | Среда разработки | Homestead | Docker
416 | Разворачивание приложений | Laravel Forge | Deployer и многие другие
417 | Тестирование | Phpunit, Mockery | Phpspec
418 | e2e тестирование | Laravel Dusk | Codeception
419 | Работа с БД | Eloquent | SQL, построитель запросов, Doctrine
420 | Шаблоны | Blade | Twig
421 | Работа с данными | Коллекции Laravel | Массивы
422 | Валидация форм | Request классы | Сторонние пакеты, валидация в контроллере
423 | Аутентификация | Встроенный функционал | Сторонние пакеты, собственное решение
424 | Аутентификация API | Laravel Passport | Сторонние пакеты, использующие JWT, OAuth
425 | Создание API | Встроенный функционал | Dingo API и другие пакеты
426 | Работа со структурой БД | Миграции | Работа с БД напрямую
427 | Локализация | Встроенный функционал | Сторонние пакеты
428 | Обмен данными в реальном времени | Laravel Echo, Pusher | Пакеты и работа с веб сокетами напрямую
429 | Генерация тестовых данных | Seeder классы, фабрики моделей, Faker | Ручное заполнение и пакеты
430 | Планирование задач | Планировщик задач Laravel | Скрипты и сторонние пакеты
431 | БД | MySQL, PostgreSQL, SQLite, SQL Server | MongoDb
432 | 
433 | [🔝 Наверх](#Содержание)
434 | 
435 | ### **Соблюдайте соглашения сообщества об именовании**
436 | 
437 |  Следуйте [стандартам PSR](http://www.php-fig.org/psr/psr-2/) при написании кода.
438 |  
439 |  Также, соблюдайте другие cоглашения об именовании:
440 | 
441 | Что | Правило | Принято | Не принято
442 | ------------ | ------------- | ------------- | -------------
443 | Контроллер | ед. ч. | ArticleController | ~~ArticlesController~~
444 | Маршруты | мн. ч. | articles/1 | ~~article/1~~
445 | Имена маршрутов | snake_case | users.show_active | ~~users.show-active, show-active-users~~
446 | Модель | ед. ч. | User | ~~Users~~
447 | Отношения hasOne и belongsTo | ед. ч. | articleComment | ~~articleComments, article_comment~~
448 | Все остальные отношения | мн. ч. | articleComments | ~~articleComment, article_comments~~
449 | Таблица | мн. ч. | article_comments | ~~article_comment, articleComments~~
450 | Pivot таблица | имена моделей в алфавитном порядке в ед. ч. | article_user | ~~user_article, articles_users~~
451 | Столбец в таблице | snake_case без имени модели | meta_title | ~~MetaTitle; article_meta_title~~
452 | Внешний ключ | имя модели ед. ч. и _id | article_id | ~~ArticleId, id_article, articles_id~~
453 | Первичный ключ | - | id | ~~custom_id~~
454 | Миграция | - | 2017_01_01_000000_create_articles_table | ~~2017_01_01_000000_articles~~
455 | Метод | camelCase | getAll | ~~get_all~~
456 | Метод в контроллере ресурсов | [таблица](https://laravel.com/docs/master/controllers#resource-controllers) | store | ~~saveArticle~~
457 | Метод в тесте | camelCase | testGuestCannotSeeArticle | ~~test_guest_cannot_see_article~~
458 | Переменные | camelCase | $articlesWithAuthor | ~~$articles_with_author~~
459 | Коллекция | описательное, мн. ч. | $activeUsers = User::active()->get() | ~~$active, $data~~
460 | Объект | описательное, ед. ч. | $activeUser = User::active()->first() | ~~$users, $obj~~
461 | Индексы в конфиге и языковых файлах | snake_case | articles_enabled | ~~ArticlesEnabled; articles-enabled~~
462 | Представление | snake_case | show_filtered.blade.php | ~~showFiltered.blade.php, show-filtered.blade.php~~
463 | Конфигурационный файл | snake_case | google_calendar.php | ~~googleCalendar.php, google-calendar.php~~
464 | Контракт (интерфейс) | прилагательное или существительное | Authenticatable | ~~AuthenticationInterface, IAuthentication~~
465 | Трейт | прилагательное | Notifiable | ~~NotificationTrait~~
466 | 
467 | [🔝 Наверх](#Содержание)
468 | 
469 | ### **Короткий и читаемый синтаксис там, где это возможно**
470 | 
471 | Плохо:
472 | 
473 | ```
474 | $request->session()->get('cart');
475 | $request->input('name');
476 | ```
477 | 
478 | Хорошо:
479 | 
480 | ```
481 | session('cart');
482 | $request->name;
483 | ```
484 | 
485 | Еще примеры:
486 | 
487 | Часто используемый синтаксис | Более короткий и читаемый синтаксис
488 | ------------ | -------------
489 | `Session::get('cart')` | `session('cart')`
490 | `$request->session()->get('cart')` | `session('cart')`
491 | `Session::put('cart', $data)` | `session(['cart' => $data])`
492 | `$request->input('name'), Request::get('name')` | `$request->name, request('name')`
493 | `return Redirect::back()` | `return back()`
494 | `is_null($object->relation) ? $object->relation->id : null }` | `optional($object->relation)->id`
495 | `return view('index')->with('title', $title)->with('client', $client)` | `return view('index', compact('title', 'client'))`
496 | `$request->has('value') ? $request->value : 'default';` | `$request->get('value', 'default')`
497 | `Carbon::now(), Carbon::today()` | `now(), today()`
498 | `App::make('Class')` | `app('Class')`
499 | `->where('column', '=', 1)` | `->where('column', 1)`
500 | `->orderBy('created_at', 'desc')` | `->latest()`
501 | `->orderBy('age', 'desc')` | `->latest('age')`
502 | `->orderBy('created_at', 'asc')` | `->oldest()`
503 | `->select('id', 'name')->get()` | `->get(['id', 'name'])`
504 | `->first()->name` | `->value('name')`
505 | 
506 | [🔝 Наверх](#Содержание)
507 | 
508 | ### **Используйте IoC или фасады вместо new Class**
509 | 
510 | Внедрение классов через синтаксис new Class создает сильное сопряжение между частями приложения и усложняет тестирование. Используйте контейнер или фасады.
511 | 
512 | Плохо:
513 | 
514 | ```
515 | $user = new User;
516 | $user->create($request->all());
517 | ```
518 | 
519 | Хорошо:
520 | 
521 | ```
522 | public function __construct(User $user)
523 | {
524 |     $this->user = $user;
525 | }
526 | 
527 | ....
528 | 
529 | $this->user->create($request->all());
530 | ```
531 | 
532 | [🔝 Наверх](#Содержание)
533 | 
534 | ### **Не работайте с данными из файла `.env` напрямую**
535 | 
536 | Передайте данные из `.env` файла в кофигурационный файл и используйте `config()` в приложении, чтобы использовать эти данными.
537 | 
538 | Плохо:
539 | 
540 | ```
541 | $apiKey = env('API_KEY');
542 | ```
543 | 
544 | Хорошо:
545 | 
546 | ```
547 | // config/api.php
548 | 'key' => env('API_KEY'),
549 | 
550 | // Используйте данные в приложении
551 | $apiKey = config('api.key');
552 | ```
553 | 
554 | [🔝 Наверх](#Содержание)
555 | 
556 | ### **Храните даты в стандартном формате. Используйте читатели и преобразователи для преобразования формата**
557 | 
558 | Плохо:
559 | 
560 | ```
561 | {{ Carbon::createFromFormat('Y-d-m H-i', $object->ordered_at)->toDateString() }}
562 | {{ Carbon::createFromFormat('Y-d-m H-i', $object->ordered_at)->format('m-d') }}
563 | ```
564 | 
565 | Хорошо:
566 | 
567 | ```
568 | // Модель
569 | protected $dates = ['ordered_at', 'created_at', 'updated_at']
570 | // Читатель (accessor)
571 | public function getMonthDayAttribute($date)
572 | {
573 |     return $date->format('m-d');
574 | }
575 | 
576 | // Шаблон
577 | {{ $object->ordered_at->toDateString() }}
578 | {{ $object->ordered_at->monthDay }}
579 | ```
580 | 
581 | [🔝 Наверх](#Содержание)
582 | 
583 | ### **Другие советы и практики**
584 | 
585 | Не размещайте логику в маршрутах.
586 | 
587 | Старайтесь не использовать "сырой" PHP в шаблонах Blade.
588 | 
589 | [🔝 Наверх](#Содержание)
590 | 


--------------------------------------------------------------------------------