DEV Community: Lathindu Pramduitha

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

Lathindu Pramduitha — Mon, 19 Apr 2021 17:52:37 +0000

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

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:users'],
            '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:users'],
            '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:users'],
            '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.

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

Lathindu Pramduitha — Sun, 21 Mar 2021 18:29:49 +0000

Hi guys, From this article I'm starting to describe you to about Laravel [PHP] coding Standards with PSR.

To make this tutorials much easier, I will divide full tutorial as number or articles. So this is first articles of them.

Article 1 : Naming Conventions. ✊

Here we will talk about naming conventions about PHP. Following conventions have accepted by Laravel community.

01.01 Controller 👈

Name should be in singular form.
Should use PascalCase.

Should Do	Should't Do
`CustomerController.php`	`CustomersController.php`

01.02 Route 👈

01.02.01 Route Url 👈

Url should be in plural form.
Can use kebab-case if there are two words in single part For best Practice.

Should Do	Should't Do
`/customers/25`	`customer/25`
`/customers/password-reset`	`/customers/password_reset`
`"`	`/customers/passwordReset`

01.02.02 Route Name 👈

Should use snake_case with dot notation.
Better to use same name like in URL.

Should Do	Should't Do
`->('customers.view')`	`->('customers-view')`
`"`	`->('customers_view')`
`->('customers.password_reset')`	`->('customers.password.reset')`
`"`	`->('customers.password-reset')`
`"`	`->('customer-password-reset')`

01.03 DataBase Related 👈

01.03.01 Migration 👈

Should use name as what you want to do with snake_case.

Should Do	Should't Do
`2021_03_19_033513_create_customers_table.php`	`2021_03_19_033513_customers.php`
`2021_03_19_033513_add_image_id_to_customers_table.php`	`2021_03_19_033513_add_image_id_customers.php`
`2021_03_19_033513_drop_image_id_from_customers_table.php`	`2021_03_19_033513_remove_image_id_customers.php`

01.03.02 Table 👈

Table name must be in plural form.
Should use snake_case.

Should Do	Should't Do
`customers`	`customer`
`cart_items`	`cartItems` , `CartItems` , `Cart_item`

01.03.03 Pivot Table 👈

Table name must be in singular form.
Should use snake_case
Names should be in alphabetical Order.

Should Do	Should't Do
`course_student`	`student_courses` , `students_courses` ,`course_students`

01.03.04 Table Columns 👈

Should use snake_case.
Should not use table name with column names.
Readable name can use for better practice.

Should Do	Should't Do
`first_name`	`user_first_name` , `FirstName`

01.03.05 Foreign key 👈

Should use snake_case.
Should use singular table name with id prefix.

Should Do	Should't Do
`course_id`	`courseId` , `id` ,`courses_id` ,`id_course`

01.03.06 Primary key 👈

only use name as id.

Should Do	Should't Do
`id`	`custom_name_id`

01.03.07 Model 👈

Model name must be in singular form.
Should Use PascalCase
Model name must be a singular form or table name.

Should Do	Should't Do
`Customer`	`Customers`,`customer`

01.03.08 Model Single relations [Has One, Belongs To] 👈

Method name must be in singular form.
Should Use camalCase

Should Do	Should't Do
`studentCourse`	`StudentCourse`,`student_course`,`studentCourses`

01.03.09 Model all other relations and methods [Has Many,other] 👈

Method name must be in plural form.
Should use camalCase

Should Do	Should't Do
`cartItems`	`CartItem`,`cart_item`,`cartItem`

01.04 Functions 👈

Should Use snake_case

Should Do	Should't Do
`show_route`	`showRoute`,`ShowRoute`

01.05 Methods in resources controller 👈

Should use camelCase
Must use singles words related to action

Should Do	Should't Do
`store`	`saveCustomer`
`show`	`viewCustomer`
`destroy`	`deleteCustomer`
`index`	`allCustomersPage`

01.06 Variables 👈

Should use camelCase
Must use readable words which are describe about value.

Should Do	Should't Do
`$customerMessages`	`$CustomerMessages` ,`$customer_messages` , `$c_messages` , `$c_m`

01.07 Collection 👈

Must described about the value.
Must be plural

Should Do	Should't Do
`$verifiedCustomers = $customer->verified()->get()`	`$verified` ,`$data` , `$resp` , `$v_c`

01.07 Object 👈

Must described about the value.
Must be singular

Should Do	Should't Do
`$verifiedCustomer = $customer->verified()->first()`	`$verified` ,`$data` , `$resp` , `$v_c`

01.08 Configs 👈

Should use snake_case
Must described about the value.

Should Do	Should't Do
`comments_enabled`	`CommentsEnabled` ,`comments` , `c_enabled` , `$ce`

01.09 Traits 👈

Should be adjective.

Should Do	Should't Do
`Utility`	`UtilityTrait` ,`Utilities`

01.10 Interface 👈

Should be adjective or a noun.

Should Do	Should't Do
`Authenticable`	`AuthenticationInterface` ,`Authenticate`

So above I have talked about naming convetion in Laravel projects. not only Laravel you guys can use this rules with any other PHP framework.

With next article I will talk about another main topic of coding standards.

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

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

You may Find my Fiver Gig Here.

https://www.fiverr.com/s2/0c68721323

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

Lathindu Pramduitha — Tue, 16 Feb 2021 20:07:15 +0000

Welcome to second article of Metamask integration with Laravel.

This document is related to my 1st document. which I explained about Metamask integration with Laravel.

you may read it here ->

Metamask Integration With Laravel

Lathindu Pramduitha ・ Feb 10 '21

#laravel #metamask #etherium #javascript

Okay, Let's start second part of the article now.

How to validate transactions which are made with Metamask

here I'm using images instead of pasting codes here, it's easy to write document.
and what a wonderful, you can copy or refer full code in repository which I'm mentioned end of the document. 😊

For the validate transactions very easy and free method is a EtherScan API.

First of all, Let's create Etherscan account.

Now we need to create API key

step 01

step 02

step 03

Now you may copy the key and store in somewhere for use in our application.

Next we need to create command in Laravel for add to shedular.

I have created a Command called MetamaskValidationCommand

You may open the command file in your editor [ My favourite is VSCode 😊 ]

App->Console->Commands->MetamaskValidationCommand.php

How To Validate?

For validate a transaction we can use EtherScan 's Free API.

You can see number of methods in EtherScan API.

Here we use eth_getTransactionByHash method only.

we have to send 2 parameter with this simple get request.

API Key => We already made a one 🎉
Transaction Id => It's we already stored in database as txHash 🥳

above we created a command called MetamaskValidationCommand

it's time to code.🧑🏻‍💻

code step 01

Create a function to get transaction information from EtherScan. inside MetamaskValidationCommand.php

code step 02

Now we need to get pending transactions from database.
here we need to add some delay to get transactions. because some time Etherium transactions may take more time to be a successful transaction. so here we get transactions which are older than 20 minuets and status = pending from database.

To call Transaction Model we need call modal inside our constructor.

Now we need to create get function inside Transaction Model.

Then we can create a function for validate transactions inside MetamaskValidationCommand.php

Here we first get all the pending [older than 20min] transactions and loop them inside foreach.

then we get them one by one and send transaction id (txHash) to EtherScan by using function which we mede above ( code step 01 ).

so our functions are ready to use.

Now we need to modify our command with custom command params.

finally we need to add our command to kernel.php

app => Console => kernel.php

here I'm adding schedule to run command every Minuit. You are free to change for any time range --> References.

Now we are ready to test.

01 make a transaction like I described in Article 01.

02 Wait At least 20 Minuit (You may change the delay value inside TransactionModel.php).

03 You can see it's marked as success. if its success payment.

I think your transaction also succeeded without an error. any error please comment below I will help you guys to success.

Important

In these both tutorials I have described as very basic methods. we don't write codes like that in production sites. we need to think more about security and durability. I guest you may got help from my article.

You may Find my Fiver Gig Here.

https://www.fiverr.com/s2/0c68721323

here You may read article one

Metamask Integration With Laravel

Lathindu Pramduitha ・ Feb 10 '21

#laravel #metamask #etherium #javascript

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

View on GitHub

Thank You Very much.

Lathindu Pramuditha.
GitHub Profile -> https://github.com/lathindu1

Metamask Integration With Laravel

Lathindu Pramduitha — Wed, 10 Feb 2021 18:48:53 +0000

What Is MetaMask ?

MetaMask is a cryptocurrency wallet which can be install in several browsers such as Chrome, FireFox and Brave Browser [ Unfortunately you can’t install in Safari 🤪 ]. That mean you can use Metamask as a bridge between ETH blockchain and browser.

And what is the amazing one, You can store ERCi20 token also in Metamask like ETH.
So you can build custom token and use it inside your platform.

So How To Integrate ?

Let’s go with Metamask integration process.

Here I’m use simple Laravel application to show entire integration process.
And I'm using screen shots of my code to make this article much easier.

🪄 Don't Worry End Of the Document I will mention the GitHub repository and also Codepen link. then you can get entire code 😊.

So let’s divide process as a two sections.

How To Integrate Metamask.
How To Validate Transactions.

In this article I will describe the step 01.

01 How To Integrate Metamask

Here I’m using Chrome as my browser.

Step 01

Let’s create simple input with button for enter the amount.

Step 02

Now we need to create javascript function to submit payment. Here I add function with onClick event of the button.

Step 03

Now we need to create javascript function to initialise, metamask and run payment.

Before that let's simplify the process which we need to do here.

1 Web3 Browser Detection

2 Connect to MetaMask Account

3 Do A Payment

so here I'm adding some major validations to make process more creative. and also we must use javascript await expression because of async process.

1 Detect Web3

2 Connect With Metamask Account

3 Do Payment

here you can see I mentioned a place where you should enter the payments receive address. for testings you can simply create two accounts in metamask and use one account for receive payments and second account for make payments.

after this step we can do a payments with Metamask , without an issue.

Then we need to store transaction in the database.

for that I will use simple Ajax Request for send data to TransactionController.

In TransactionsController

Now we need to show all the transactions to user.

first get transactions from the transactions table.

Now we can show all the transaction in simple bootstrap table.

finally transactions page will looks like this.

Okay Grate 🎉 Now all the steps are completed.

** When you try to make a transaction. In Very first attempt Metamask will ask to connect your one of account. So here you must connect your account with your website [This process need only first attempt]. Then you can send payments. but if you have already connected account you can pay directly**

let's try to make a transaction.

Enter The amount

Click Pay Now Button

Next And Connect With Account

Do A Payment

success Payment

Then Verify Our Payment With Etherscan.

Simply copy transaction id and put in Etherscan transaction id box.

or you can use Link Like this.

https://ropsten.etherscan.io/tx/{Your_Transaction_Id}

Here ropsten is our network.

for the testings we can use ropsten network. and make sure when you go live you must use Mainnet as your network.

Test Transaction Example in Etherscan.

In Next Article I will guid You To Make Validator to validate transactions.

I think if you read carefully you may learn something new.

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

You may Find my Fiver Gig Here.

https://www.fiverr.com/s2/0c68721323

You may read second Article Here

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

Lathindu Pramduitha ・ Feb 16 '21

#laravel #php #metamask #etherscan

GitHub Repository

lathindu1 / tutorials

Tutorials

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

Articles

View on GitHub

CodePen

Thank You Very much.

Lathindu Pramuditha.
GitHub Profile -> https://github.com/lathindu1

DEV Community: Lathindu Pramduitha

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

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

Article 02: Principles should adhere.✊

01 Don't Use Validations Inside Controller 👈

01 Create Custom Request. 👈

02 Allow CSRF 👈

03 Add Validation Rules. 👈

04 Add Custom Validation Messages. 👈

02 Use Config, Constants, Language Files without complexing code. 👈

03 Don't Execute Queries inside blade files. 👈

You may Find my Upwork Profile Here.

Other Articles 👈👈👈

lathindu1 / tutorials

Tutorials

Articles

lathindu1 / lathindu1

It's About Lathindu Pramuditha's Account

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

A little more about me...

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

Article 1 : Naming Conventions. ✊

01.01 Controller 👈

01.02 Route 👈

01.02.01 Route Url 👈

01.02.02 Route Name 👈

01.03 DataBase Related 👈

01.03.01 Migration 👈

01.03.02 Table 👈

01.03.03 Pivot Table 👈

01.03.04 Table Columns 👈

01.03.05 Foreign key 👈

01.03.06 Primary key 👈

01.03.07 Model 👈

01.03.08 Model Single relations [Has One, Belongs To] 👈

01.03.09 Model all other relations and methods [Has Many,other] 👈

01.04 Functions 👈

01.05 Methods in resources controller 👈

01.06 Variables 👈

01.07 Collection 👈

01.07 Object 👈

01.08 Configs 👈

01.09 Traits 👈

01.10 Interface 👈

You may Find my Fiver Gig Here.

Other Articles

lathindu1 / tutorials

Tutorials

Articles

lathindu1 / lathindu1

It's About Lathindu Pramuditha's Account

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

A little more about me...

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

Welcome to second article of Metamask integration with Laravel.

Metamask Integration With Laravel

Lathindu Pramduitha ・ Feb 10 '21

How to validate transactions which are made with Metamask

First of all, Let's create Etherscan account.

Now we need to create API key

step 01

step 02

step 03

Next we need to create command in Laravel for add to shedular.

How To Validate?

it's time to code.🧑🏻‍💻

code step 01

code step 02

Important

You may Find my Fiver Gig Here.

Metamask Integration With Laravel

Lathindu Pramduitha ・ Feb 10 '21

lathindu1 / tutorials

Tutorials

Articles

Metamask Integration With Laravel

What Is MetaMask ?

So How To Integrate ?

01 How To Integrate Metamask

Step 01