Lathindu Pramduitha

Posted on Apr 19, 2021 • Updated on Jul 16, 2022

25 6

🧑‍🦰👩‍🦰
Laravel Best Practice [Coding Standards Part 02]

#laravel #beginners #php #codequality

Hello friends, This is the second article of Laravel coding standards article series.

If you didn't see the first article, I recommend to read it for best practice.

Laravel Best Practice Article 01 => Click Here To Open Article

 GIF

Article 02: Principles should adhere. ✊

Here I will talk about some principles which are developer should follow.

01 Don't Use Validations Inside Controller 👈

When I review my junior developer's code, I have seen there are bunch of validators in
the controller. Some time they just google the issue and copy things from
Stackowerflow or some where and put in the code without investigating about it. so
that's the main problem which I seen with them.

Here You may see some Bad code which are used validator in controller.
 public function store(Request $request){
Validator::make($request, [
'first_name' => ['required', 'string', 'max:255'],
'last_name' => ['required', 'string', 'max:255'],
'email' => ['required', 'string', 'email', 'max:255', 'unique:us
'password' =>['required', 'string', new Password, 'confirmed']
])->validate();
return User::store($request->all());
}

so this is not a correct way to put validator.

we should use Customer Request to handle Validators.

01 Create Custom Request. 👈

php artisan make:request UserCreateRequest

above as a request name. you may use actual scenario . ex-: if you want to handle
user update form request. You may create Request as UserUpdateRequest.

Once Created Request from the command. you can see UserCreateRequest inside
your project root -> app -> Http -> Requests .

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class UserCreateRequest extends FormRequest

{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return false;
}

/**
* Get the validation rules that apply to the request.
*
* @return array
*/
 public function rules()
{
return [
//
];
}
}

In the class you may see two prebuilt functions called

authorize() and rules() .

02 Allow CSRF 👈
in authorize() function you need to change return as true .

otherwise your request will not work.

03 Add Validation Rules. 👈

You can add validation methods inside rules() function.

public function rules()

{
return [
'first_name' => ['required', 'string', 'max:255'],
'last_name' => ['required', 'string', 'max:255'],
'email' => ['required', 'string', 'email', 'max:255', 'unique:us
'password' =>['required', 'string', new Password, 'confirmed']
];
}

04 Add Custom Validation Messages. 👈

Then you can add custom validation messages for every input, every validation
methods. here you need to override message() function from formRequest Trait.

and add messages by mentioning inputs and rules separating by dots.

public function messages()

{
return [
"first_name.required" => "User first name is required",
"first_name.string" => "User first name type must be a string",
"email.unique" => "This email is already used.",
];
}
Finally UserCreateRequest may be like this.

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class UserCreateRequest extends FormRequest

{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}

/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'first_name' => ['required', 'string', 'max:255'],
'last_name' => ['required', 'string', 'max:255'],
'email' => ['required', 'string', 'email', 'max:255', 'unique:us
'password' =>['required', 'string', new Password, 'confirmed']
];
}
/**
* Get custom messages for validator errors.
*
* @return array
*/
public function messages()
{
return [
"first_name.required" => "User first name is required",
"first_name.string" => "User first name type must be a string",
"email.unique" => "This email is already used.",
];
}
 }

Now You Can use UserCreateRequest inside controller

function.

/**
* Store Customer
*
* @param UserCreateRequest $request
* @return User
*/
public function store(UserCreateRequest $request){
return User::store($request->all());
}

With this custom request you can have lot's of complex logics, rules inside it.

👈
02 Use Config, Constants, Language Files without
complexing code.
let's say you are adding users to database with number of status.

like ApprovalPending , Approved , Declined , ReSubmitted

This the Bad way which lot's of juniors are doing.

switch ($user->status) {
case 1:
// do the things for Pending status
break;
case 2:
// do the things for Approved status
break;
case 3:
// do the things for Declined status
 break;
case 4:
// do the things for Resubmitted status
break;

above you may see if we changed integer for related status, we must change the
switch function also for correct the status, and also if comments deleted by some
how, you don't know what happened in case 1, what happened in case 2 like this.

to avoid this we can use Constant Variable which is defined inside related model.

CONST STATUS =[
"ApprovalPending"=>1,
"Approved"=>2,
"Declined"=>3,
"ReSubmitted"=>4,
];

Then you can use STATUS variable inside the switch case anywhere.

switch ($user->status) {
case User::STATUS['ApprovalPending']:
// do the things for Pending status
break;
case User::STATUS['Approved']:
// do the things for Approved status
break;
case User::STATUS['Declined']:
// do the things for Declined status
break;
case User::STATUS['ReSubmitted']:
// do the things for Resubmitted status
break;
}
03 Don't Execute Queries inside blade files. 👈
lot's of junior developers are doing this thing without looking about it.

@foreach (Customer::all() as $customer)

{{ $customer->address->street_address }}
@endforeach

This code is fine there no any issue. but let's look in to deep. This will execute 1001
queries for 1000 customers .

$customers = Customer::with('address')->get();

@foreach ($customers as $customer)

{{ $customer->address->street_address }}
@endforeach

This is perfect. This will execute only 2 queries for 1000 of customers .

Above I talked about 3 main issues which junior developers are doing mostly.

I hope you find my post useful! Any feedback is greatly appreciated!

You may Find my Upwork Profile Here.

https://www.upwork.com/freelancers/lathindu

below I mentioned my other articles. you may also read them.

Other Articles 👈👈👈
Laravel Best Practice Coding Standards Part 01
MetaMask Integration With Laravel Part2 Click Here
MetaMask Integration With Laravel Part1 Click Here

Here I'm Adding Public GitHub Repository which will store all of my tutorials. you may
clone it and see every tutorials what I will publish . 🤗
GitHub Repository

lathindu1 / tutorials

Tutorials
Here I will show all the code blocks of my tutorials. you can copy anything or learn anything.

Articles
How To Connect Metamask With Laravel(Part 01 Connect And Make A Transaction) .
How To Connect Metamask With Laravel(Part 02 Validate Transactions) .

View on GitHub

Thank You Very much.

--Lathindu Pramuditha--

GitHub Profile

lathindu1 / lathindu1
It's About Lathindu Pramuditha's Account

ආයුබෝවන් (Welcome) 🙏🏻, I'm Lathindu Pramuditha Amarasekara!

Software Engineer at Speralabs

Linkedin: lathindu-pramuditha GitHub followers

A little more about me...

namespace App\Models
use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Life;

class ProfileOfLathindu extends Life

{
View on GitHub

Top comments (12)

bravemaster619 • Apr 20 '21

I'd like to add a thing to 02.

I've seen many devs use env function.

Please avoid env and use config instead.

Because .env files can be cached via php artisan config:cache and you
can't use env function after that. (it will return null)

So if any of the code uses env function, you can't config cache in the future.

Lathindu Pramduitha • Apr 20 '21

great @bravemaster619 it's better to use config instep of env. and also we
can use both.

we can use real content inside config file and. if we have local only thing
we can use them inside .env .
 like

"paypal_secret" = env("PAYPAL_SECRET" ,
'asdfthdnejs323jn23nk3jn2njk3n2'),

and for our sandbox in local we can use key's inside .env

PAYPAL_SECRET = "kjansjnaknjsnalhjsbljhslhjlhjsla"

otherwise we don't want to use env anyware.

bravemaster619 • Apr 21 '21

This.

Ion Bazan • Apr 21 '21

Using is worst thing you can do. You should always use
$request->all()
$request->validated() .

bravemaster619 • Apr 20 '21

03 is more like: Avoid N+1 query problem.

Shaquil Maria • Apr 19 '21

Thank you for this post! 🙏

I am about to start developing a project in Laravel and these tips will come in
handy!

Lathindu Pramduitha • Apr 20 '21

Thank you very much

Thu Htet Tun • Apr 20 '21

Nice laravel tips, Lathindu.

 Lathindu Pramduitha • Apr 20 '21

Thank you very much.

Bobby Iliev • Apr 20 '21

Great post! Well done! Awesome to see some high-quality Laravel content on
here!

Sajad DP • Oct 13 '21

Thanks man :)

Some comments may only be visible to logged-in visitors. Sign in to view all comments.

Code of Conduct • Report abuse

🤯 The mind-blowing way to learn to code

DEV Partners PROMOTED

Explore free courses on CSS, JS, React, AI Engineering, and UI Design.

 Start learning

Lathindu Pramduitha

Founder, CEO at Axcertro

LOCATION
Sri Lanka
WORK
Founder, CEO At Axcertro
JOINED
Feb 9, 2021

More from Lathindu Pramduitha

Laravel Best Practice [Coding Standards Part 01 ] 🧑‍🦰👩‍🦰

#laravel #beginners #php #codequality

Metamask Integration With Laravel Part 2[ Validate Transactions With EtherScan ]

#laravel #php #metamask #etherscan

Metamask Integration With Laravel

#laravel #metamask #etherium #javascript

DEV Community

🌚 Pro Tip
You can set dark mode, and make other customizations, by creating a DEV
account.
Sign up now