Contents

Single responsibility principle

publicfunctionupdate(Request$request):string{$validated =$request->validate(['title' =>'required|max:255','events' =>'required|array:date,type'    ]);foreach ($request->eventsas$event) {$date =$this->carbon->parse($event['date'])->toString();$this->logger->log('Update event' .$date .' ::' .$);    }$this->event->updateGeneralEvent($request->validated());returnback();}

publicfunctionupdate(UpdateRequest$request):string{$this->logService->logEvents($request->events);$this->event->updateGeneralEvent($request->validated());returnback();}

Methods should do just one thing

publicfunctiongetFullNameAttribute():string{if (auth()->user() &&auth()->user()->hasRole('client') &&auth()->user()->isVerified()) {return'Mr.' .$this->first_name .'' .$this->middle_name .'' .$this->last_name;    }else {return$this->first_name[0] .'.' .$this->last_name;    }}

publicfunctiongetFullNameAttribute():string{return$this->isVerifiedClient() ?$this->getFullNameLong() :$this->getFullNameShort();}publicfunctionisVerifiedClient():bool{returnauth()->user() &&auth()->user()->hasRole('client') &&auth()->user()->isVerified();}publicfunctiongetFullNameLong():string{return'Mr.' .$this->first_name .'' .$this->middle_name .'' .$this->last_name;}publicfunctiongetFullNameShort():string{return$this->first_name[0] .'.' .$this->last_name;}

Fat models, skinny controllers

publicfunctionindex(){$clients = Client::verified()        ->with(['orders' =>function ($q) {$q->where('created_at','>', Carbon::today()->subWeek());        }])        ->get();returnview('index', ['clients' =>$clients]);}

publicfunctionindex(){returnview('index', ['clients' =>$this->client->getWithNewOrders()]);}class Clientextends Model{publicfunctiongetWithNewOrders():Collection    {return$this->verified()            ->with(['orders' =>function ($q) {$q->where('created_at','>', Carbon::today()->subWeek());            }])            ->get();    }}

Validation

publicfunctionstore(Request$request){$request->validate(['title' =>'required|unique:posts|max:255','body' =>'required','publish_at' =>'nullable|date',    ]);...}

publicfunctionstore(PostRequest$request){...}class PostRequestextends Request{publicfunctionrules():array    {return ['title' =>'required|unique:posts|max:255','body' =>'required','publish_at' =>'nullable|date',        ];    }}

Business logic should be in service class

publicfunctionstore(Request$request){if ($request->hasFile('image')) {$request->file('image')->move(public_path('images') .'temp');    }...}

publicfunctionstore(Request$request){$this->articleService->handleUploadedImage($request->file('image'));...}class ArticleService{publicfunctionhandleUploadedImage($image):void    {if (!is_null($image)) {$image->move(public_path('images') .'temp');        }    }}

Don't repeat yourself (DRY)

publicfunctiongetActive(){return$this->where('verified',1)->whereNotNull('deleted_at')->get();}publicfunctiongetArticles(){return$this->whereHas('user',function ($q) {$q->where('verified',1)->whereNotNull('deleted_at');        })->get();}

publicfunctionscopeActive($q){return$q->where('verified',true)->whereNotNull('deleted_at');}publicfunctiongetActive():Collection{return$this->active()->get();}publicfunctiongetArticles():Collection{return$this->whereHas('user',function ($q) {$q->active();        })->get();}

Prefer to use Eloquent over using Query Builder and raw SQL queries. Prefer collections over arrays

SELECT*FROM`articles`WHERE EXISTS (SELECT*FROM`users`WHERE`articles`.`user_id`=`users`.`id`AND EXISTS (SELECT*FROM`profiles`WHERE`profiles`.`user_id`=`users`.`id`)AND`users`.`deleted_at` ISNULL)AND`verified`='1'AND`active`='1'ORDER BY`created_at`DESC

Article::has('user.profile')->verified()->latest()->get();

Mass assignment

$article =newArticle;$article->title =$request->title;$article->content =$request->content;$article->verified =$request->verified;// Add category to article$article->category_id =$category->id;$article->save();

$category->article()->create($request->validated());

Do not execute queries in Blade templates and use eager loading (N + 1 problem)

@foreach(User::all()as$user){{$user->profile->name}}@endforeach

$users = User::with('profile')->get();@foreach ($usersas$user)    {{$user->profile->name }}@endforeach

Chunk data for data-heavy tasks

$users =$this->get();foreach ($usersas$user) {...}

$this->chunk(500,function ($users) {foreach ($usersas$user) {...    }});

Prefer descriptive method and variable names over comments

// Determine if there are any joinsif (count((array)$builder->getQuery()->joins) >0)

if ($this->hasJoins())

Do not put JS and CSS in Blade templates and do not put any HTML in PHP classes

letarticle=`{{ json_encode($article) }}`;

<input type="hidden" value='@json($article)'>Or<button data-article='@json($article)'>{{ $article->name }}<button>

letarticle=$('#article').val();

Use config and language files, constants instead of text in the code

publicfunctionisNormal():bool{return$article->type ==='normal';}returnback()->with('message','Your article has been added!');

publicfunctionisNormal(){return$article->type === Article::TYPE_NORMAL;}returnback()->with('message',__('app.article_added'));

Use standard Laravel tools accepted by community

Follow Laravel naming conventions

Convention over configuration

// Table name 'Customer'// Primary key 'customer_id'class Customerextends Model{constCREATED_AT ='created_at';constUPDATED_AT ='updated_at';protected$table ='Customer';protected$primaryKey ='customer_id';publicfunctionroles():BelongsToMany    {return$this->belongsToMany(Role::class,'role_customer','customer_id','role_id');    }}

// Table name 'customers'// Primary key 'id'class Customerextends Model{publicfunctionroles():BelongsToMany    {return$this->belongsToMany(Role::class);    }}

Use shorter and more readable syntax where possible

$request->session()->get('cart');$request->input('name');

session('cart');$request->name;

Use IoC / Service container instead of new Class

$user =newUser;$user->create($request->validated());

publicfunction__construct(protectedUser$user) {}...$this->user->create($request->validated());

Do not get data from the.env file directly

$apiKey =env('API_KEY');

// config/api.php'key' =>env('API_KEY'),// Use the data$apiKey =config('api.key');

Store dates in the standard format. Use accessors and mutators to modify date format

{{ Carbon::createFromFormat('Y-d-m H-i',$object->ordered_at)->toDateString() }}{{ Carbon::createFromFormat('Y-d-m H-i',$object->ordered_at)->format('m-d') }}

// Modelprotected$casts = ['ordered_at' =>'datetime',];// Blade view{{$object->ordered_at->toDateString() }}{{$object->ordered_at->format('m-d') }}

Do not use DocBlocks

/** * The function checks if given string is a valid ASCII string * * @param string $string String we get from frontend which might contain *                       illegal characters. Returns True is the string *                       is valid. * * @return bool * @author  John Smith * * @license GPL */publicfunctioncheckString($string){}

publicfunctionisValidAsciiString(string$string):bool{}

Other good practices