Forem: Kingsconsult

Laravel Credit Card Validation

Kingsconsult — Sat, 09 Jan 2021 10:15:12 +0000

Hello, Today we are going to be looking at validating credit card, adding a credit card to our app needs some level of validation before it will be store in the database.

Click on my profile to follow me to get more updates.

Step 1: Install the package required

We are going to be using a package Laravel Validator Rules - Credit Card, so we need to install it

composer require laravel-validation-rules/credit-card

Step 2: Create the Form Request

For a comprehensive explanation of this step, check out this material Laravel Form Validation

php artisan make:request CardVerificationRequest

Step 3: Write the Form Request Rules and Error Message

Open the file that is created in app/Http/Requests/, CardVerificationRequest.php and edit to this

<?php

namespace App\Http\Requests;

use LVR\CreditCard\CardCvc;
use LVR\CreditCard\CardNumber;
use LVR\CreditCard\CardExpirationYear;
use LVR\CreditCard\CardExpirationMonth;
use Illuminate\Foundation\Http\FormRequest;

class CardVerificationRequest 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 [
            'card_number' => ['required', 'unique:cards,cardNo', new CardNumber],
            'expiration_year' => ['required', new CardExpirationYear($this->get('expiration_month'))],
            'expiration_month' => ['required', new CardExpirationMonth($this->get('expiration_year'))],
            'cvc' => ['required', new CardCvc($this->get('card_number'))]
        ];
    }

    public function messages()
    {
        return [
            'card_number.required' => 'The card number is compulsory'
        ];
    }
}

Step 4: Type-hint the CardVerificationRequest in our Controller

Go to the controller method, where you want to use the validation and use my code as a guide

    /**
     * Store a newly created resource in storage.
     *
     * @param  \App\Http\Requests\CardVerificationRequest  $request
     * @return \Illuminate\Http\Response
     */
    public function store(CardVerificationRequest $request)
    {

        $validatedData = $request->validated();

        $newCard = new Card;

        $newCard->cardNo = $validatedData["card_number"];
        $newCard->cardExpiringMonth = $validatedData["expiration_month"];
        $newCard->cardExpiringYear = $validatedData["expiration_year"];
        $newCard->cardCVV = $validatedData["cvc"];

        $newCard->save();

        return response()->json([
            "status" => "success",
            "message" => "Card saved successfully.",
            "data" => $newCard
        ], StatusCodes::SUCCESS);
    }

Testing

Running the app with fields that violates the rules

When the fields are correct

Follow me for more of my articles, you can leave comments, suggestions, and reactions.
I am open to any vacancy as a PHP (Laravel) backend engineer, I am also available for any job.

click the link to view my profile and follow me

Thank you for your time

Laravel Form Validation

Kingsconsult — Sat, 02 Jan 2021 22:59:26 +0000

Hello, Happy New Year, Hope you are enjoying the yuletide period? Today, I am going to write on Form Validation in Laravel. When we are building an application that requires a user filling a form and the application storing the data in the database, there is always a need to validate, if not, a user can decide or mistakenly enter the wrong data in a field and summit and the application will process it, but if there are some validation rules before the storing method will process it, it will return an error to check the form input.
Laravel has some default validation rules out of the box, but there are some instances we will want to define our own set of rules. There might be a complex scenario so you will need to create a form request, also in programming, the SRP of SOLID principle states that a class should perform just one task, so our store method of controller needs to only handle storing of data and not validation.
Let's dive in, you will understand it better.

Click on my profile to follow me to get more updates.

Step 1: Create Form Request

To create a form request, we are going to use an artisan command

php artisan make:request StoreProjectRequest

A folder called Requests will be created in app/Http/ directory with the StoreProjectRequest.php file, open the file and let's write our validation rules.

Step 2: Write the Validation rules

Go to app/Http/Requests/StoreProjectRequest.php
All the fields that we want to validate should be written in a key-value pair in the return of the rules methods

    public function rules()
    {
        return [
            'name' => 'required|max:100',
            'introduction' => 'required|max:255',
            'location' => 'nullable',
            'cost' => 'required|integer'
        ];
    }

Step 3: Write the error messages

This is optional because Laravel has provided a set of error messages. However, we can decide to write our error messages for each error.
Create a method called message() and return an array of the error messages.

    public function messages()
    {
        return [
            'name.required' => 'You need to provide the name of the project',
            'name.max' => 'The name of the project should not be greater than 100 characters',
            'introduction.required' => 'Please provide the introduction of the project',
            'cost.integer' => 'The cost of the project must be a number'
        ];
    }

So, the StoreProjectRequest will now look like this

Step 4: Type-hint the Request in the Controller

Now go to our controller, and the store method where we want to validate, then type-hint the StoreProjectRequest replacing the usual Request

   public function store(StoreProjectRequest $request)
    {
        $request->validated();

        Project::create($request->all());

        return redirect()->route('projects.index')
            ->with('success', 'Project created successfully.');
    }

You can retrieved the validated request like this

$validated = $request->validated();

So you can use it like this

$projectName = $validated["name"];

If there is an error, the errors will be stored in the error bag and send back to the view or store in the session.

Testing

Run your app and go to create a page

Try to submit a form with values which violates the rules of our validation and try to submit

Follow me for more of my articles, you can leave comments, suggestions, and reactions.
I am open to any vacancy as a PHP (Laravel) backend engineer, I am also available for any job.

click the link to view my profile and follow me

Thank you for your time

Schedule a task to run at a specific time in laravel (CronJob)

Kingsconsult — Fri, 25 Dec 2020 14:23:32 +0000

Good day and Merry Xmas,
Today, I am going to teach you how to schedule a task that can run at a specific time, when building an app, sometimes we might want to automate a task like sending out a newsletter daily/weekly/monthly, sending a report to the admin through email at the end of the day etc. All these task cannot be done manually, so we need a way to schedule it to run at a specific time of the day, week, month, or even every minute, so just relax and let's dive into it

Click on my profile to follow me to get more updates.

Step 1: Setup a new Laravel App

1. Install laravel

composer create-project laravel/laravel laraveljobscheduler

2. Change into the directory

cd laraveljobscheduler/

Step 2: Setup Mail

For more explanation of this step, visit my previous article How to send email in Laravel 8 downwards using Gmail

Step 3: Setup our Gmail Mailable

For more explanation of this step, visit my previous article How to send email in Laravel 8 downwards using Gmail
1. Make the mail

php artisan make:mail Gmail



<?php

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;

class Gmail extends Mailable
{
    use Queueable, SerializesModels;

    public $details;

    /**
     * Create a new message instance.
     *
     * @return void
     */
    public function __construct($details)
    {
        $this->details = $details;
    }

    /**
     * Build the message.
     *
     * @return $this
     */
    public function build()
    {
        return $this->subject('Mail from Laravel Job Scheduler')
            ->view('emails.gmail')
            ->from('Kingsconsult001@gmail.com');
    }
}

2. Create the view



<!DOCTYPE html>
<html>
<head>
    <title>kings</title>
</head>
<body>
    <h1>{{ $details['title'] }}</h1>
    <p>{{ $details['body'] }}</p>

    <p>Thank you for subscribing</p>
</body>
</html>

Step 4: Create a Job to send the mail

We are going to use a Job to send the mail, so we are going to create a job

php artisan make:job SendEmailJob

A new folder called Jobs will be created at app/, so subsequently new jobs will be stored in this folder,

Let's modify it to send out our mail



<?php

namespace App\Jobs;

use App\Mail\Gmail;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldBeUnique;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Mail;

class SendEmailJob implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    /**
     * Create a new job instance.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {

        $details = [
            'title' => 'Thank you for subscribing to my newsletter',
            'body' => 'You will receive a newsletter every Fourth Friday of the month'

        ];
        Mail::to('kingsconsult001@gmail.com')->send(new Gmail($details));
    }
}

When calling a Job, the code inside the handle() method will be the one to run, so that is why we write our code in the handle() method.
From the code above, we import our Mail and Gmail class, we then pass the details of our mail to the Gmail class, my article on Sending mail explains this.

Step 5: Schedule the job to run at the specific time

Lastly, We need to schedule when the job will be run, in order to do this, we are going to add the code in app/Console/Kernel.php, so let's modify the schedule() method
import these classes before the Kernel class

use App\Jobs\SendEmailJob;
use Carbon\Carbon;

protected function schedule(Schedule $schedule)
{
// $schedule->command('inspire')->hourly();
$now = Carbon::now();
$month = $now->format('F');
$year = $now->format('yy');

    $fourthFridayMonthly = new Carbon('fourth friday of ' . $month . ' ' . $year);

    $schedule->job(new SendEmailJob)->monthlyOn($fourthFridayMonthly->format('d'), '13:46');
}

From the code above, We want to send out the newsletter every fourth Fridays of the month at 13:46 GMT, I used that day and time so that I will be able to test if my code works, 
First, I initialize the present time and extract the month and year, then I assign it to a variable, from the variable I created a time that will run every fourth Friday of the present month and year. 
Finally, schedule the job which runs monthly at the day and time that we specified.
**Testing**
Run the scheduler on the terminal
> php artisan schedule:work

![php artisan schedule:work](https://res.cloudinary.com/kingsconsult/image/upload/v1608900618/Schedule%20Job/7_eggcgk.png)
This is the mail I got in my box
![inbox](https://res.cloudinary.com/kingsconsult/image/upload/v1608900625/Schedule%20Job/6_folv46.png)

The complete code can be found in this github repo [Kingsconsult/laravel-schedule-job](https://github.com/Kingsconsult/laravel-schedule-job)

Follow me for more of my articles, you can leave comments, suggestions, and reactions.
I am open to any vacancy as a PHP (Laravel) backend engineer, I am also available for any job. 

[click the link to view my profile and follow me] (https://dev.to/kingsconsult)

Thank you for your time

Customize Laravel Jetstream (Registration and Login)

Kingsconsult — Thu, 17 Dec 2020 00:15:44 +0000

Hello, welcome back to my series, previously, I wrote on how to Customize Laravel Auth (Laravel Breeze Registration and Login), this is for those that use Laravel breeze for Authentification, but some of my readers who used Laravel Jetstream are still finding it difficult to customize the Registration and Login process in order to suit their needs.
For those that did not read the previous article, what we are trying to achieve is to customize the Registration and Login whereby a developer can choose to use username and password for login different from the default email and password, this is because some of the users of your application might not be having email address, so the person might use username for the registration and be using it for login.
without further ado, let's dive into the stuff of the day, if you read Customize Laravel Auth (Laravel Breeze Registration and Login), most of the steps are similar.

Click on my profile to follow me to get more updates.

Step 1: Edit the CreateNewUser.php

If you scaffold your authentication using Laravel Jetstream and installed livewire or inertia, you will have an Action folder in your App directory, and also a Fortify directory inside the Action with some files.
Go to app/Actions/Fortify/CreateNewUser.php customize the create method to this



  public function create(array $input)
    {
        Validator::make($input, [
            'firstname' => ['required', 'string', 'max:255'],
            'lastname' => ['required', 'string', 'max:255'],
            'username' => ['required', 'string', 'max:255'],
            'password' => $this->passwordRules(),
        ])->validate();

        return User::create([
            'firstname' => $input['firstname'],
            'lastname' => $input['lastname'],
            'username' => $input['username'],
            'email' => $input['email'],
            'password' => Hash::make($input['password']),
        ]);
    }

In the validate( ) method, I removed email, and added firstname, lastname and username. Also in the User::create, I added the new fields.

Step 2: Create another migration file to add the new fields to the User table

php artisan make:migration add_more_fields_to_users_table --table=users

A migrations file will be created, go to database/migrations/

Step 3: Add the new fields and modify the name field

We are going to modify the existing name field with firstname and also add other fields, but to modify an existing fields, we need a package doctrine/dbal, The Doctrine DBAL library is used to determine the current state of the column and to create the SQL queries needed to make the requested changes to your column. Laravel docs

composer require doctrine/dbal

After this, update the composer, by running the command below

composer update

Then add the following fields to the up( ) method of the migration file created above



    public function up()
    {
        Schema::table('users', function (Blueprint $table) {
            $table->renameColumn('name', 'firstname');
            $table->string('lastname');
            $table->string('username')->unique();
            $table->string('email')->nullable()->change();
        });
    }

You will notice how we are going to rename our name field to firstname and added lastname and username, we made the username to be unique() and also modify email from mandatory to nullable().

Finally, run the migration command

php artisan migrate

Database

Step 4: Modify the Users Model

We need to add the fields to be fill in users model, go to app/Models/User.php and edit the protected $fillable to add the new fields



    protected $fillable = [
        'firstname',
        'email',
        'password',
        'username',
        'lastname'
    ];

Step 5: Modify the Registration view

Go to resources/views/auth/register.blade.php and modify to this



<x-guest-layout>
    <x-jet-authentication-card>
        <x-slot name="logo">
            <x-jet-authentication-card-logo />
        </x-slot>

        <x-jet-validation-errors class="mb-4" />

        <form method="POST" action="{{ route('register') }}">
            @csrf

            <div>
                <x-jet-label value="{{ __('First Name') }}" />
                <x-jet-input class="block mt-1 w-full" type="text" name="firstname" :value="old('firstname')" required autofocus autocomplete="firstname" />
            </div>

            <div>
                <x-jet-label value="{{ __('Last Name') }}" />
                <x-jet-input class="block mt-1 w-full" type="text" name="lastname" :value="old('lastname')" required autocomplete="lastname" />
            </div>

            <div>
                <x-jet-label value="{{ __('Username') }}" />
                <x-jet-input class="block mt-1 w-full" type="text" name="username" :value="old('username')" autocomplete="username" />
            </div>

            <div class="mt-4">
                <x-jet-label value="{{ __('Email') }}" />
                <x-jet-input class="block mt-1 w-full" type="email" name="email" :value="old('email')"  />
            </div>

            <div class="mt-4">
                <x-jet-label value="{{ __('Password') }}" />
                <x-jet-input class="block mt-1 w-full" type="password" name="password" required autocomplete="new-password" />
            </div>

            <div class="mt-4">
                <x-jet-label value="{{ __('Confirm Password') }}" />
                <x-jet-input class="block mt-1 w-full" type="password" name="password_confirmation" required autocomplete="new-password" />
            </div>

            <div class="flex items-center justify-end mt-4">
                <a class="underline text-sm text-gray-600 hover:text-gray-900" href="{{ route('login') }}">
                    {{ __('Already registered?') }}
                </a>

                <x-jet-button class="ml-4">
                    {{ __('Register') }}
                </x-jet-button>
            </div>
        </form>
    </x-jet-authentication-card>
</x-guest-layout>

Start our application with

php artisan serve

Click on Register, we are going to have this

Step 6: Modify the Login view

Go to resources/views/auth/login.blade.php and modify to this



<x-guest-layout>
    <x-jet-authentication-card>
        <x-slot name="logo">
            <x-jet-authentication-card-logo />
        </x-slot>

        <x-jet-validation-errors class="mb-4" />

        @if (session('status'))
        <div class="mb-4 font-medium text-sm text-green-600">
            {{ session('status') }}
        </div>
        @endif

        <form method="POST" action="{{ route('login') }}">
            @csrf

            <div>
                <x-jet-label value="{{ __('Username') }}" />
                <x-jet-input class="block mt-1 w-full" type="text" name="username" :value="old('username')" required autofocus />
            </div>

            <div class="mt-4">
                <x-jet-label value="{{ __('Password') }}" />
                <x-jet-input class="block mt-1 w-full" type="password" name="password" required autocomplete="current-password" />
            </div>

            <div class="block mt-4">
                <label class="flex items-center">
                    <input type="checkbox" class="form-checkbox" name="remember">
                    <span class="ml-2 text-sm text-gray-600">{{ __('Remember me') }}</span>
                </label>
            </div>

            <div class="flex items-center justify-end mt-4">
                @if (Route::has('password.request'))
                <a class="underline text-sm text-gray-600 hover:text-gray-900" href="{{ route('password.request') }}">
                    {{ __('Forgot your password?') }}
                </a>
                @endif

                <x-jet-button class="ml-4">
                    {{ __('Login') }}
                </x-jet-button>
            </div> 
        </form>
    </x-jet-authentication-card>
</x-guest-layout>

We removed email field and replace it with username field

Step 7: Modify the Fortify configuration file

We are going to specify what we are going to be using for the login, so go to config/fortify.php, you will see an array, find the username key and change it to username from email,



  'username' => 'username',

Then clear your config and cache

php artisan config:cache

Run your app in case it is down

php artisan serve

We can now login with username and password instead of email address. That is all
Follow me for more of my articles, you can leave comments, suggestions, and reactions.
I am open to any vacancy as a PHP backend engineer, my strength is in the Laravel framework.

click the link to view my profile and follow me

Customize Laravel Auth (Laravel Breeze Registration and Login)

Kingsconsult — Thu, 10 Dec 2020 22:36:42 +0000

Hello Artisans, after making a post on Basic Laravel Login and Registration using Laravel Breeze, I got a lot of private messages on how to customize the Registration and Login where a developer can be able to add more fields because the default Laravel User Registration fields are just limited to Name, Email and Password right from the time of the Legacy UI till the time of writing this report. But there are instances of where a developer might want to collect not just the name, but First Name, Last Name, Username, Password or even making the Email not mandatory for users who don't have email, so I decide to write this little piece.
For this article, I am going to use the app from this article Basic Laravel Login and Registration using Laravel Breeze

Click on my profile to follow me to get more updates.

Step 1: Edit the RegisteredUserController

Go to app/Http/Controllers/Auth/RegisteredUserController.php and customize the store method to this



    public function store(Request $request)
    {
        $request->validate([
            'firstname' => 'required|string|max:255',
            'lastname' => 'required|string|max:255',
            'password' => 'required|string|confirmed|min:8',
            'username' => 'required|string|max:255',
        ]);

        Auth::login($user = User::create([
            'firstname' => $request->firstname,
            'lastname' => $request->lastname,
            'username' => $request->username,
            'email' => $request->email,
            'password' => Hash::make($request->password),
        ]));

        event(new Registered($user));

        return redirect(RouteServiceProvider::HOME);
    }

In the validate( ) method, I removed email, and added firstname, lastname and username. Also in the User::create, I added the new fields.

Step 2: Create another migration file to add the new fields to the User and login_history table

This migration field will add the new fields to our existing users table, so run the command below

php artisan make:migration add_more_fields_to_users_table --table=users

Do the same for the login_history table.
The --table=users flag will specify the type of schema facade to use.
A migrations file will be created, go to database/migrations/

Step 3: Add the new fields and modify the name field

composer require doctrine/dbal

After this, update the composer, by running the command below

composer update

Then add the following fields to the up( ) method of the migration file created above



    public function up()
    {
        Schema::table('users', function (Blueprint $table) {
            $table->renameColumn('name', 'firstname');
            $table->string('lastname');
            $table->string('username');
            $table->string('email')->nullable()->change();
        });
    }

You will notice how we are going to rename our name field to firstname and added lastname and username, also we modify file email from mandatory to nullable().

Don't forget to do the same for the login_history.
Finally, run the migration command, but

php artisan migrate

Database

Step 4: Modify the Users Model

We need to add the fields to be fill in users model, go to app/Models/User.php and edit the protected $fillable to add the new fields



    protected $fillable = [
        'firstname',
        'email',
        'password',
        'username',
        'lastname'
    ];

Step 5: Modify the Registration view

Go to resources/views/auth/register.blade.php and modify to this



<x-guest-layout>
    <x-auth-card>
        <x-slot name="logo">
            <a href="/">
                <x-application-logo class="w-20 h-20 fill-current text-gray-500" />
            </a>
        </x-slot>

        <!-- Validation Errors -->
        <x-auth-validation-errors class="mb-4" :errors="$errors" />

        <form method="POST" action="{{ route('register') }}">
            @csrf

            <!-- Name -->
            <div>
                <x-label for="firstname" :value="__('First Name')" />

                <x-input id="firstname" class="block mt-1 w-full" type="text" name="firstname" required autofocus />
            </div>
            <!-- Name -->
            <div>
                <x-label for="lastname" :value="__('Last Name')" />

                <x-input id="lastname" class="block mt-1 w-full" type="text" name="lastname" required />
            </div>
            <!-- Name -->
            <div>
                <x-label for="username" :value="__('username')" />

                <x-input id="username" class="block mt-1 w-full" type="text" name="username" required />
            </div>

            <!-- Email Address -->
            <div class="mt-4">
                <x-label for="email" :value="__('Email')" />

                <x-input id="email" class="block mt-1 w-full" type="email" name="email"  />
            </div>

            <!-- Password -->
            <div class="mt-4">
                <x-label for="password" :value="__('Password')" />

                <x-input id="password" class="block mt-1 w-full" type="password" name="password" required autocomplete="new-password" />
            </div>

            <!-- Confirm Password -->
            <div class="mt-4">
                <x-label for="password_confirmation" :value="__('Confirm Password')" />

                <x-input id="password_confirmation" class="block mt-1 w-full" type="password" name="password_confirmation" required />
            </div>

            <div class="flex items-center justify-end mt-4">
                <x-button>
                    {{ __('Register') }}
                </x-button>
            </div>
        </form>
    </x-auth-card>
</x-guest-layout>

Start our application with

php artisan serve

Click on Register, we are going to have this

Step 6: Modify the Login view

Go to resources/views/auth/login.blade.php and modify to this



<x-guest-layout>
    <x-auth-card>
        <x-slot name="logo">
            <a href="/">
                <x-application-logo class="w-20 h-20 fill-current text-gray-500" />
            </a>
        </x-slot>

        <!-- Session Status -->
        <x-auth-session-status class="mb-4" :status="session('status')" />

        <!-- Validation Errors -->
        <x-auth-validation-errors class="mb-4" :errors="$errors" />

        <form method="POST" action="{{ route('login') }}">
            @csrf

            <!-- Email Address -->
            <div>
                <x-label for="username" :value="__('Username')" />

                <x-input id="username" class="block mt-1 w-full" type="text" name="username" required autofocus />
            </div>

            <!-- Password -->
            <div class="mt-4">
                <x-label for="password" :value="__('Password')" />

                <x-input id="password" class="block mt-1 w-full" type="password" name="password" required autocomplete="current-password" />
            </div>

            <!-- Remember Me -->
            <div class="block mt-4">
                <label for="remember_me" class="flex items-center">
                    <input id="remember_me" type="checkbox" class="form-checkbox" name="remember">
                    <span class="ml-2 text-sm text-gray-600">{{ __('Remember me') }}</span>
                </label>
            </div>

            <div class="flex items-center justify-end mt-4">
                @if (Route::has('password.request'))
                <a class="underline text-sm text-gray-600 hover:text-gray-900" href="{{ route('password.request') }}">
                    {{ __('Forgot your password?') }}
                </a>
                @endif

                <x-button class="ml-3">
                    {{ __('Login') }}
                </x-button>
            </div>
        </form>
    </x-auth-card>
</x-guest-layout>

This will change the login field from email to username

Step 7: Modify the Login Request Class

This is the class that replaces the LoginController class in the previous Laravel Authentication. Go to app/Requests/Auth/LoginRequest.php and change all the email string to username string, and also make sure the validating rules, you remove the email rule and replace it with username rule



<?php

namespace App\Http\Requests\Auth;

use Illuminate\Auth\Events\Lockout;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\RateLimiter;
use Illuminate\Support\Str;
use Illuminate\Validation\ValidationException;
use App\Events\LoginHistory;



class LoginRequest 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 [
            'username' => 'required|string',
            'password' => 'required|string',
        ];
    }

    /**
     * Attempt to authenticate the request's credentials.
     *
     * @return void
     *
     * @throws \Illuminate\Validation\ValidationException
     */
    public function authenticate()
    {
        $this->ensureIsNotRateLimited();

        if (! Auth::attempt($this->only('username', 'password'), $this->filled('remember'))) {
            RateLimiter::hit($this->throttleKey());

            throw ValidationException::withMessages([
                'username' => __('auth.failed'),
            ]);
        }

        $user = Auth::user();

        event(new LoginHistory($user));

        RateLimiter::clear($this->throttleKey());
    }

    /**
     * Ensure the login request is not rate limited.
     *
     * @return void
     *
     * @throws \Illuminate\Validation\ValidationException
     */
    public function ensureIsNotRateLimited()
    {
        if (! RateLimiter::tooManyAttempts($this->throttleKey(), 5)) {
            return;
        }

        event(new Lockout($this));

        $seconds = RateLimiter::availableIn($this->throttleKey());

        throw ValidationException::withMessages([
            'username' => trans('auth.throttle', [
                'seconds' => $seconds,
                'minutes' => ceil($seconds / 60),
            ]),
        ]);
    }

    /**
     * Get the rate limiting throttle key for the request.
     *
     * @return string
     */
    public function throttleKey()
    {
        return Str::lower($this->input('username')).'|'.$this->ip();
    }
}

Logout from the app and click on login

click the link to view my profile and follow me

Pagination from Array in Laravel 8

Kingsconsult — Thu, 03 Dec 2020 22:56:01 +0000

Hello, Today I am going to be showing you how to create pagination in laravel from an array, sometimes we might find ourselves in a situation where we need to do some manipulation from the query result we got from the database or from an API before sending it to the view, if the array contains so many data, it might be cumbersome and messy to just populate it on a single page.
Laravel has a built-in function for pagination that is already integrated to Query builder and Eloquent ORM results of database which can be easily called like

$users = DB::table('users')->paginate(15);

But it cannot be applied to an array, so sit tight, we are going to be creating our own pagination from an array collection.

Click on my profile to follow me to get more updates.

For this article, I will be using code from my previous article on How to consume RESTful APIs in Laravel 8, what I want to do is grab the contents of an API (Github public API), extract some data, and store it in an array, then paginate the array and send it to the view (frontend).

Step 1: Setup your app

In case you don't have a laravel app running, you can click on this Link, and checkout step one on how to set up a laravel app.

Step 2: Add route

Go to routes/web.php and add the route to view our paginated array

Route::get('createpagination', [ProjectController::class, 'createPagination'])->name('createPagination');

Step 3: Create Controller Methods

Add the following methods to the app/Http/Controllers/ProjectController.php
Call the class at the top before the ProjectController Class

use Illuminate\Pagination\Paginator;
use Illuminate\Support\Collection;
use Illuminate\Pagination\LengthAwarePaginator;

Then add this inside the class


    private function paginate($items, $perPage = 5, $page = null, $options = [])
    {
        $page = $page ?: (Paginator::resolveCurrentPage() ?: 1);
        $items = $items instanceof Collection ? $items : Collection::make($items);

        return new LengthAwarePaginator($items->forPage($page, $perPage), $items->count(), $perPage, $page, $options);
    }

    public function createPagination() 
    {
        $client = new Client(); //GuzzleHttp\Client
        // Github public API to view my public Repositories
        $url = "https://api.github.com/users/kingsconsult/repos";


        $response = $client->request('GET', $url, [
            'verify'  => false,
        ]);
        $responseBody = json_decode($response->getBody());

        // Extract key, name, URL and date the repo was created
        // and store it in an array
        $responseArray = [];
        foreach ($responseBody as $key => $views) {
            $array = array('id' => $key, 'name' => $views->name, 'url' => $views->url, 'created_at' => $views->created_at);
            array_push($responseArray, $array);
        }

        // use the paginate method that we created to paginate the array and also 
        // add the URL for the other pages using setPath() method
        $githubRepo = $this->paginate($responseArray)->setPath('/projects/createpagination');

        return view('projects.createpagination', compact('githubRepo'))
        ->with('i', (request()->input('page', 1) - 1) * 5)
        ;
    }

Step 4: Create View

Go to resources/views/projects and create a blade file called createpagination.blade.php and add the following code

@extends('layouts.app')

@section('content')

<style>

</style>
<div class="row mb-3">
    <div class="col-lg-12 margin-tb">
        <div class="text-center">
            <h2>Github Public Repository</h2>
            <a class="btn btn-primary" href="{{ route('projects.index') }}" title="Go back"> <i class="fas fa-backward fa-2x"></i> </a>
        </div>
    </div>
</div>

<div class="container-fluid mb-5" style="margin-bottom: 150px !important">
    <div class="row mr-4">

 <table class="table table-bordered table-responsive-lg">
    <tr>
        <th>No</th>
        <th>Name</th>
        <th>Url</th>
        <th>Date Created</th> 
    </tr>
    @foreach ($githubRepo as $repo)
    <tr>
        <td>{{ ++$i }}</td>
        <td>{{ $repo['name'] }}</td>
        <td>{{ $repo['url'] }}</td>
        <td>{{ $repo['created_at'] }}</td>
    </tr>
    @endforeach
</table>
{!! $githubRepo->links() !!}
    </div>
</div>


@endsection

Step 5: Use Bootstrap for the pagination links

If we don't indicate that we are going to use Boostrap for the pagination, the pagination links will be displaying weird arrows, so to style our pagination links, go to app/Providers/AppServiceProvider.php and tell the app to use Bootstrap in pagination, add this to the boot method

Paginator::useBootstrap();

and at the top, add this also

use Illuminate\Pagination\Paginator;

Result

Follow me for more of my articles, you can leave comments, suggestions, and reactions

Laravel 8 Events and Listeners with Practical Example

Kingsconsult — Wed, 25 Nov 2020 22:38:33 +0000

Hello, today I want to talk about Events and Listeners in Laravel, in programming to write a scalable, reusable and clean code, you need to follow some programming principles, one of which is SOLID, I will not be going deep into explaining that today, but I will just highlight one, the S which stands for Single Responsibility Principle, this principle states that

A class should have one and only one reason to change, meaning that a class should have only one job.

What this means is that, A class should only perform one task, many times, we always load our class with some many functionalities, so if the class changes, a lot of things will break in our application, which is not a good practice.
So I will introduce Events and Listeners to help in making our class perform just one task.

Click on my profile to follow me and get more updates.

What is An Event?

Events are the ways we hook into the activities of our application, it is just a way to observe an activity, for instance, login, a class can be created to monitor the activity of login, when a user logs in, the event class can execute some functions.

What is A Listener?

A Listener is a class that listens to the events that they are mapped to and execute a task, that is they are the ones that perform a given task for an event.
Let me illustrate, you might want to send a welcome email to a new user of your application, and also assign a role to the user based on the information provided in the registration, etc, you would not want to do all those in the RegisterController because that we violate the first principle of SOLID, where the Controller will perform more than one task, the RegisterController needs to only perform the activity of registration of a new user. so an event needs to be carried out in the process of registration, where assigning a role, sending an email, etc are the individual listeners under the event.
For this article, I will write one listener in an event, what the listener will do is to store the login of each user of the app in a table, this is just an illustration that will show you how it works.
If you have a laravel project that has auth already, you can follow immediately, or you can follow my article Basic Laravel Login and Registration using Laravel Breeze, I will be using the project on that article from my system.

Step 1: Register the event and listeners in the EventServiceProvider

For our events and listeners to work, we must register them in the EventServiceProvider class that has already been set up for us at the time of installing our laravel project. So go to app/Providers/EventServiceProvider.php and click

Events and Listeners are registered as key => value pair in the protected $listen, from the picture above, an event and a listener is already registered Registered::class is the event, while SendEmailVerificationNotification::class is the listener, so we are going to add our own



<?php

namespace App\Providers;

use Illuminate\Auth\Events\Registered;
use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Event;
use App\Events\LoginHistory;
use App\Listeners\storeUserLoginHistory;

class EventServiceProvider extends ServiceProvider
{
    /**
     * The event listener mappings for the application.
     *
     * @var array
     */
    protected $listen = [
        Registered::class => [
            SendEmailVerificationNotification::class,
        ],
        LoginHistory::class => [
            StoreUserLoginHistory::class,
        ]
    ];

    /**
     * Register any events for your application.
     *
     * @return void
     */
    public function boot()
    {
        //
    }
}

We added another event class called LoginHistory and also a listener called StoreUserLoginHistory, and noticed up that we called the class here in this way use App\Events\LoginHistory; and use App\Listeners\storeUserLoginHistory;, don't worry, I know you are wondering that the class does not exist in our application, we are going to generate it in the next step, you can add as many events and listeners as possible like this and even more



 protected $listen = [
        Event1::class => [
            Listener1::class,
            Listener2::class
        ],
        Event2::class => [
            Listener5::class,
            Listener7::class
        ],
        Event3::class => [
            Listener4::class,
            Listener7::class,
            Listener9::class
        ],
 ];

Step 2: Generate Events & Listeners

Previously, we write classes of events and listeners in the EventServiceProvider, so to generate it at once, we run this command

php artisan event:generate

That command will automatically generate all the events and listeners found in the event provider,

Step 3: Write the Events and Listener class

Remember what we are trying to achieve was to store all the login of our app in a table, so click on the app/Events/LoginHistory.php and edit as follows



class LoginHistory
{
    use Dispatchable, InteractsWithSockets, SerializesModels;

    public $user;

    /**
     * Create a new event instance.
     *
     * @return void
     */
    public function __construct($user)
    {
        $this->user = $user;
    }

    /**
     * Get the channels the event should broadcast on.
     *
     * @return \Illuminate\Broadcasting\Channel|array
     */
    public function broadcastOn()
    {
        return new PrivateChannel('channel-name');
    }
}

from the code above, the event accepts the $user which is the information of the user, and it will pass it to the listener.
Click on app/Listeners/storeUserLoginHistory.php, this is where we are going to be writing the main logic of the storing of the login history, inside the handle method, add the following code



    public function handle(LoginHistory $event)
    {
        $current_timestamp = Carbon::now()->toDateTimeString();

        $userinfo = $event->user;

        $saveHistory = DB::table('login_history')->insert(
            ['name' => $userinfo->name, 'email' => $userinfo->email, 'created_at' => $current_timestamp, 'updated_at' => $current_timestamp]
        );
        return $saveHistory;
    }

Also remember to call the Carbon and DB facade before the class



use Illuminate\Support\Facades\DB;
use Carbon\Carbon;

Our listener now looks like this

From the listener, we are trying to add the name, email, time created and time updated to a table login_history, that is when any user logs in, it will grab that information and store it in the table.

Step 4: Create the Table and Migrate

I am not going to explain deep on this step, I have some of my articles that explain them, check them out from my profile,
Create migration file

Add your columns to the migration files

Then migrate

We now have our table in the database

Step 5: Dispatch the Event

This is the last step, we need to call the event in the LoginController, if you are using laravel 7, or below, you can create a method in the LoginController.php like this



    protected function authenticated() {

        $user = Auth::user();

        event(new LoginHistory($user));
    }

but for this article, I am using Laravel Breeze, a simple UI scaffolding that was released 16 days ago, so I will go to LoginRequest.php found in app/Http/Requests/Auth/LoginRequest.php and inside the authenticate() method, I will call my event and pass the $user to the class



  public function authenticate()
    {
        $this->ensureIsNotRateLimited();

        if (! Auth::attempt($this->only('email', 'password'), $this->filled('remember'))) {
            RateLimiter::hit($this->throttleKey());

            throw ValidationException::withMessages([
                'email' => __('auth.failed'),
            ]);
        }

        $user = Auth::user();

        event(new LoginHistory($user));

        RateLimiter::clear($this->throttleKey());
    }

I only added $user = Auth::user(); and event(new LoginHistory($user));, notice how I dispatched my event, you can use that or you use this EventClass::dispatch();, but we are using event(new LoginHistory($user));.
So when a user attempts to sign in, if the user is authenticated, the event will then be fired, and the listener will save the history
This is the result, when I sign in twice

Follow me for more of my articles, you can leave comments, suggestions, and reactions.
I am open to any vacancy as a PHP backend engineer, my strength is in the Laravel framework

click the link to view my profile and follow me

Thank you for your time

Laravel Login and Registration using Laravel Breeze

Kingsconsult — Mon, 16 Nov 2020 22:40:36 +0000

Basic Laravel Login and Registration using Laravel Breeze

Kingsconsult — Sat, 14 Nov 2020 02:17:12 +0000

Hello, How are you doing, I want to introduce Laravel Breeze to you, in the course of the week Taylor Otwell (creator of Laravel) tweeted about a new package released (Laravel Breeze). This is because of the uproar about Jetstream where some thought that Laravel have abandoned their legacy UI, but Taylor cleared the air on that, and have to release another package that is not complicated like the Jetstream and in which one can customize to his/her desire.
This comes with basic Authentication like, User registration and user Login, change of password, email setup, send email for change of password, tailwind and blade etc. Let's create our first app with Laravel breeze.

If you prefer to watch videos, this is the video Youtube Video link

Click on my profile to follow me to get more updates.

Step 1: Install a new Laravel app

You can use

laravel new breeze

but in using this, you must make sure laravel is installed on your system, you can install laravel globally using

composer global require laravel/installer

or you can install laravel using composer without Laravel using

composer create-project laravel/laravel breeze --prefer-dist

Step 2: Require Laravel Breeze

After installing Laravel, then change into the directory cd breeze/ and require Laravel Breeze with composer using the command below

composer require laravel/breeze --dev

Step 3: Install Laravel Breeze

php artisan breeze:install

Step 4: Install the JavaScript pacakges

After installing Laravel Breeze, it will prompt you to run

npm install && npm run dev

Step 5: Setup Database

Open your .env file that was created and you will see that the name of the project has automatically be entered as the database name, you can change it to the name of the database you want to use, or you leave it and create a new database with the name

Step 6: Run migration

After setting up our database and editing it in the .env file, we need to run the migration, but before that, we need to set the default string length, if not, this will throw errors in the course of migrations.
Go to app/Providers/AppServiceProvider.php and add the schema for the default string length in the boot method.

Schema::defaultstringLength(191);

remember to call the schema class at the top

use Illuminate\Support\Facades\Schema;

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Facades\Schema;


class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     *
     * @return void
     */
    public function register()
    {
        //
    }

    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        Schema::defaultstringLength(191);
    }
}

then run the migration

php artisan migrate

Step 7: Add your email login details

This is so we can be able to reset our password and other email features

Step 8: Start the App

php artisan serve

http://127.0.0.1:8000/

http://127.0.0.1:8000/register

http://127.0.0.1:8000/dashboard

http://127.0.0.1:8000/login

Now you have your basic laravel app with Auth setup.
Follow me for more of my articles, you can leave comments, suggestions, and reactions.
I am open to any vacancy as a PHP backend engineer, my strength is in the Laravel framework

Watch the video on Youtube
click the link to view my profile and follow me

How to create Recycle Bin with Soft Delete in Laravel 8 and 7

Kingsconsult — Fri, 06 Nov 2020 23:01:05 +0000

Hello guys, I want to treat some Laravel concepts about deleting, sometimes we may want to design our application so that even though the user deletes a data, it is not permanently deleted, it will still remain in the database but will not show up in the view. Laravel has provided this functionality out of the box for us called softDelete, so I am going to illustrate how to delete data and view the deleted data and also how to restore the deleted data, and finally, how to permanently delete the data, I called this concept Recycle Bin.
We are going to be using the code from my previous article Laravel 8 CRUD App, A simple guide, the repo

If you prefer videos, you can watch the video from Youtube

Click on my profile to follow me to get more updates.

Step 1: Setup the app

git clone https://github.com/Kingsconsult/laravel_8_crud.git
cd laravel_8_crud/
composer install
npm install
cp .env.example .env
php artisan key:generate
Add your database config in the .env file (you can check my articles on how to achieve that)
php artisan migrate
php artisan serve (if the server opens up, http://127.0.0.1:8000, then we are good to go)
Navigate to http://127.0.0.1:8000/projects

Step 2: Add delete_at column to projects table

In Laravel Soft Delete, data are not actually deleted from the database but a deleted_at attribute is added to the data, so when we are querying data from the database, Eloquent looks for data with null deleted_at value and give out, but when a data has non-null deleted_at value, it treats it as a deleted data.
So we need to add it and run our migration again.

Step 3: Add the delete_at column to the migration file

Running the command in step 2 will create a migration file in database/migrations/, edit the file and add $table->softDeletes(); to the up() function and also $table->dropSoftDeletes(); to the down() function, our migration file looks like this

Step 4: Run migration again

We need to run the migration again so that the new column will be added to the existing table

php artisan migrate

Going to our database, you will see the new column created with values Null

Step 5: Enable the softdelete trait on the model

Go to app/Models/Project.php and add the soft delete trait, this trait will tell the model to only add a date to the model that is deleted, but not deleting it permanently.

use SoftDeletes;

Also, add the path of the trait at the top

use Illuminate\Database\Eloquent\SoftDeletes;

Step 6: Create the routes to get all deleted projects

Go to routes/web.php and add the route to get all deleted projects

Route::get('projects/deletedprojects', [ProjectController::class, 'getDeleteProjects'])->name('getDeleteProjects');

Step 7: Create the Controller Method

In our route above, we specified a getDeletedProjects methods in the ProjectController class, so we create that method. Go to app/Http/Controllers/ProjectController.php and add this method

    public function getDeleteProjects() {
        $projects = Project::onlyTrashed()->paginate(10);

        return view('projects.deletedprojects', compact('projects'))
            ->with('i', (request()->input('page', 1) - 1) * 10);
    }

From the method above, we used an eloquent function onlyTrashed(), this function only fetches the model with non-null deleted_at values, so it will fetch just the projects that are deleted.

Step 8: Create the blade file to view all deleted project

From our getDeletedProjects() method above, we return to deletedprojects view, so we need to create that, go to resources/views/projects/ and create the file deletedprojects.blade.php and copy the index page and edit to this

@extends('layouts.app')

@section('content')
    <div class="row">
        <div class="col-lg-12 margin-tb">
            <div class="pull-left">
                <h2>Laravel 8 CRUD </h2>
            </div>
        </div>
    </div>

    <div class="pull-left ">
        <a class="btn btn-success" href="{{ route('projects.index') }}" title="Back to Index"> <i class="fas fa-home"></i> </a>
    </div>
    <div class="">
        <div class="mx-auto pull-right">
            <div class="">
                <form action="{{ route('projects.index') }}" method="GET" role="search">

                    <div class="input-group">
                        <span class="input-group-btn mr-5 mt-1">
                            <button class="btn btn-info" type="submit" title="Search projects">
                                <span class="fas fa-search"></span>
                            </button>
                        </span>
                        <input type="text" class="form-control mr-2" name="term" placeholder="Search projects" id="term">
                        <a href="{{ route('projects.index') }}" class=" mt-1">
                            <span class="input-group-btn">
                                <button class="btn btn-danger" type="button" title="Refresh page">
                                    <span class="fas fa-sync-alt"></span>
                                </button>
                            </span>
                        </a>
                    </div>
                </form>
            </div>
        </div>
    </div>

    @if ($message = Session::get('success'))
        <div class="alert alert-success">
            <p>{{ $message }}</p>
        </div>
    @endif

    <table class="table table-bordered table-responsive-lg">
        <tr>
            <th>No</th>
            <th>Name</th>
            <th>Introduction</th>
            <th>Location</th>
            <th>Cost</th>
            <th>Date Deleted</th>
            <th>Action</th>
        </tr>
        @foreach ($projects as $project)
            <tr>
                <td>{{ ++$i }}</td>
                <td>{{ $project->name }}</td>
                <td>{{ $project->introduction }}</td>
                <td>{{ $project->location }}</td>
                <td>{{ $project->cost }}</td>
                <td>{{ date_format($project->deleted_at, 'jS M Y') }}</td>
                <td>
                    <a href="{{ route('restoreDeletedProjects', $project->id) }}" title="restore project">
                        <i class="fas fa-window-restore text-success  fa-lg"></i>
                    </a>
                    <a href="{{ route('deletePermanently', $project->id) }}" title="Permanently delete">
                        <i class="fas fa-trash text-danger  fa-lg"></i>
                    </a>
                </td>
            </tr>
        @endforeach
    </table>

    {!! $projects->links() !!}


@endsection

In the action column of a project from the code above, we added an icon to restore a deleted file, this will remove the value in the deleted_at in the table and we also added another icon to delete a project permanently, this will permanently delete the project from the database.
Next, we need to create a function to restore the deleted project.

Step 9: Create Route to Restore Deleted Project

Route::get('projects/deletedprojects/{id}', [ProjectController::class, 'restoreDeletedProjects'])->name('restoreDeletedProjects');

In our route, we also specify a controller method restoreDeletedProjects, so we head to ProjectController and create the method

Step 10: Create Controller Method to Restore Deleted Project

Go to app/Http/Controllers/ProjectController.php and add this method

    public function restoreDeletedProjects($id) 
    {

        $project = Project::where('id', $id)->withTrashed()->first();

        $project->restore();

        return redirect()->route('projects.index')
            ->with('success', 'You successfully restored the project');
    }

Step 11: Create Route to permanently delete Project

We need to also create a functionality, to permanently delete a project that we don't want to leave in the database, so let's create the route

Route::get('projects/retoreprojects/{id}', [ProjectController::class, 'deletePermanently'])->name('deletePermanently');

Step 12: Create the Controller Method

    public function deletePermanently($id)
    {
        $project = Project::where('id', $id)->withTrashed()->first();

        $project->forceDelete();

        return redirect()->route('projects.index')
            ->with('success', 'You successfully deleted the project fromt the Recycle Bin');

    }

That is all, let's test our work
We created some projects,

We also added a recycle icon that will take us to the page that we display all deleted projects, then we deleted two of the projects and going to the recycle page

These are the projects we deleted from the index page, here we have two icons, one to restore deleted projects and the other to permanently delete the project from the database
We restored a project, and it returns to the index, then finally, we deleted the other permanently

You can get the complete code from the Github repo.
Follow me for more of my articles, you can leave comments, suggestions, and reactions.
I am open to any vacancy as a PHP backend engineer, my strength is in the Laravel framework

click the link to view my profile and follow me

How to implement Delete Confirmation in Laravel 8, 7,6 with Modal

Kingsconsult — Sun, 01 Nov 2020 05:16:26 +0000

Hello devs, How are you doing? I am going to be showing you a little trick on how to implement delete confirmation using bootstrap modal.
In designing an application, we need to take into consideration that the user might not be that careful in using our application or unconsciously be pressing something on their phone or with the mouse and can accidentally click the delete button, so we need to make sure that in terms of delicate activities like deleting a data, there should be some level of confirmation, there are many ways to achieve this, you can use alert or confirm in JavaScript with jQuery, but we are going to be using bootstrap, this way it will look better and give us more chances of customizing how the confirmation will look.
Let's get into the business, We are going to be using the code from my previous article Laravel 8 CRUD App, A simple guide, the repo

Click on my profile to follow me to get more updates.

Step 1: Setup the app

git clone https://github.com/Kingsconsult/laravel_8_crud.git
cd laravel_8_crud/
composer install
npm install
cp .env.example .env
php artisan key:generate
Add your database config in the .env file (you can check my articles on how to achieve that)
php artisan migrate
php artisan serve (if the server opens up, http://127.0.0.1:8000, then we are good to go)
Navigate to http://127.0.0.1:8000/projects

Step 2: add delete route

Laravel resources route provides us with seven (7) methods that handle the CRUD operation, which means we have the delete method called destroy method already created. But we are going to add a new route called delete, what this route will do is redirect us to the modal that will execute the destroy method. So add the code below before the resource route for project



Route::get('projects/delete/{id}', [ProjectController::class, 'delete'])->name('delete');

Step 3: Create delete method

In our route, we indicate that we have a delete method in the project controller, so we need to create that, go to app/Http/Controllers/ProjectController.php and add the following method



public function delete($id)
{
    $project = Project::find($id);

    return view('projects.delete', compact('project'));
}

The delete function accepts an id, which is the id of the item we want to delete, and return the delete view in our projects directory along with the id of the item.

Step 4: Create Delete view

In our delete method, we return the delete view, so we need to create that, go to resources/views/projects/ and create a delete blade file delete.blade.php and copy the code below and paste.



{{-- !-- Delete Warning Modal -->  --}}
<form action="{{ route('projects.destroy', $project->id) }}" method="post">
    <div class="modal-body">
        @csrf
        @method('DELETE')
        <h5 class="text-center">Are you sure you want to delete {{ $project->name }} ?</h5>
    </div>
    <div class="modal-footer">
        <button type="button" class="btn btn-secondary" data-dismiss="modal">Cancel</button>
        <button type="submit" class="btn btn-danger">Yes, Delete Project</button>
    </div>
</form>

From the code above, we need to pass an id to the destroy method, the id of the item to be deleted, we also customize the delete message, so that the user will be sure what to delete.
The form will be the modal that will display for confirmation before deleting, the submit button will be the button that will execute the deleting, while the button with type button will cancel the form which will not delete the item.

Step 5: Edit the index.blade.php



@extends('layouts.app')

@section('content')

<div class="row">
    <div class="col-lg-12 margin-tb">
        <div class="pull-left">
            <h2>Laravel 8 CRUD </h2>
        </div>
    </div>
</div>

<div class="pull-left ">
    <a class="btn btn-success" href="{{ route('projects.create') }}" title="Create a project"> <i class="fas fa-plus-circle"></i>
    </a>
</div>
<div class="d-flex">
    <div class="mx-auto">

        <form action="{{ route('projects.index') }}" method="GET" role="search">

            <div class="d-flex">

                <button class="btn btn-info t" type="submit" title="Search projects">
                    <span class="fas fa-search"></span>
                </button>
                <input type="text" class="form-control mr-2" name="term" placeholder="Search projects" id="term">
                <a href="{{ route('projects.index') }}" class="">
                    <button class="btn btn-danger" type="button" title="Refresh page">
                        <span class="fas fa-sync-alt"></span>
                    </button>

                </a>
            </div>
        </form>
    </div>
</div>

@if ($message = Session::get('success'))
<div class="alert alert-success">
    <p>{{ $message }}</p>
</div>
@endif

<table class="table table-bordered table-responsive table-hover">
    <thead class="thead-dark">
        <tr>
            <th scope="col">No</th>
            <th scope="col">Name</th>
            <th scope="col">Introduction</th>
            <th scope="col">Location</th>
            <th scope="col">Cost</th>
            <th scope="col">Date Created</th>
            <th scope="col">Action</th>
        </tr>
    </thead>
    <tbody>
        @foreach ($projects as $project)
        <tr>
            <td scope="row">{{ ++$i }}</td>
            <td>{{ $project->name }}</td>
            <td>{{ $project->introduction }}</td>
            <td>{{ $project->location }}</td>
            <td>{{ $project->cost }}</td>
            <td>{{ date_format($project->created_at, 'jS M Y') }}</td>
            <td>

                <a href="{{ route('projects.show', $project->id) }}" title="show">
                    <i class="fas fa-eye text-success  fa-lg"></i>
                </a>

                <a href="{{ route('projects.edit', $project->id) }}">
                    <i class="fas fa-edit  fa-lg"></i>

                </a>
                <a data-toggle="modal" id="smallButton" data-target="#smallModal" data-attr="{{ route('delete', $project->id) }}" title="Delete Project">
                    <i class="fas fa-trash text-danger  fa-lg"></i>
                </a>
            </td>
        </tr>
        @endforeach
    </tbody>

</table>

{!! $projects->links() !!}

<!-- small modal -->
<div class="modal fade" id="smallModal" tabindex="-1" role="dialog" aria-labelledby="smallModalLabel" aria-hidden="true">
    <div class="modal-dialog modal-sm" role="document">
        <div class="modal-content">
            <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal" aria-label="Close">
                    <span aria-hidden="true">&times;</span>
                </button>
            </div>
            <div class="modal-body" id="smallBody">
                <div>
                    <!-- the result to be displayed apply here -->
                </div>
            </div>
        </div>
    </div>
</div>

<script>
    // display a modal (small modal)
    $(document).on('click', '#smallButton', function(event) {
        event.preventDefault();
        let href = $(this).attr('data-attr');
        $.ajax({
            url: href
            , beforeSend: function() {
                $('#loader').show();
            },
            // return the result
            success: function(result) {
                $('#smallModal').modal("show");
                $('#smallBody').html(result).show();
            }
            , complete: function() {
                $('#loader').hide();
            }
            , error: function(jqXHR, testStatus, error) {
                console.log(error);
                alert("Page " + href + " cannot open. Error:" + error);
                $('#loader').hide();
            }
            , timeout: 8000
        })
    });

</script>

@endsection

For the explanation of how I implement the modal functionality above, visit my previous article How to create modal in Laravel 8 and Laravel 6/7 with AJax

Edit the base layout of our app to add the jquery, ajax and bootstrap needed, go to resources/views/layouts/app.blade.php, copy and paste the code below.



<html>

<head>
    <title>App Name - @yield('title')</title>

    <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.0.0-alpha/css/bootstrap.css"
        rel="stylesheet">

    <!-- Font Awesome JS -->
    <script defer src="https://use.fontawesome.com/releases/v5.0.13/js/solid.js"
        integrity="sha384-tzzSw1/Vo+0N5UhStP3bvwWPq+uvzCMfrN1fEFe+xBmv1C/AtVX5K0uZtmcHitFZ" crossorigin="anonymous">
    </script>
    <script defer src="https://use.fontawesome.com/releases/v5.0.13/js/fontawesome.js"
        integrity="sha384-6OIrr52G08NpOFSZdxxz1xdNSndlD4vdcf/q2myIUVO0VsqaGHJsB0RaBE01VTOY" crossorigin="anonymous">
    </script>

    <link href="//maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" rel="stylesheet" id="bootstrap-css">

    <link href='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css' rel='stylesheet' type='text/css'>



  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
    <script src='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js' type='text/javascript'></script>


    <style>
        .footer {
            position: fixed;
            left: 0;
            bottom: 0;
            width: 100%;
            background-color: #9C27B0;
            color: white;
            text-align: center;
        }

        body {
            background-color: #EDF7EF
        }

    </style>

</head>

<body>
    @section('sidebar')

    @show

    <div class="container">
        @yield('content')
    </div>
    <div class="text-center footer">

        <h4>The writer needs a job</h4>
        <h4>+234 806 605 6233</h4>
        <h4>kingsconsult001@gmail.com</h4>
        <h4>Github: www.github.com/kingsconsult</h4>

    </div>


</body>

</html>

Testing
Restarting our server in case, it is not running and going to projects

php artisan serve

http://127.0.0.1:8000/projects , create some projects to test

Click on the trash icon to delete a project

click the link to view my profile and follow me

Visit my other posts

How to Create a Secure CRUD RESTful API in Laravel 8 and 7 Using Laravel Passport

Kingsconsult ・ Oct 15 '20

#php #laravel #webdev #beginners

How to consume RESTful APIs in Laravel 8 and Laravel 7

Kingsconsult ・ Oct 28 '20

#php #laravel #beginners #webdev

How to consume RESTful APIs in Laravel 8 and Laravel 7

Kingsconsult — Wed, 28 Oct 2020 03:50:55 +0000

Today, I am going to show you how to consume RESTful APIs, in my previous post I discuss How to Create a Secure CRUD RESTful API in Laravel 8 and 7 Using Laravel Passport, the article teaches you how to create a RESTful API and also securing the API with Passport, Laravel Passport is the official OAuth2 server for Laravel apps. It provides you with a full OAuth2 server implementation.
But in this article, we are only going to be discussing how to consume external API. Why some APIs are authenticated which will require providing a token in order to access the API, others are not authenticated, which means you can access the API without a token.
This article will show you how to implement the two instances. We are going to be using the code from my previous article Laravel 8 CRUD App, A simple guide, this is the GitHub repo for the code snippets.

Click on my profile to follow me to get more updates.

Step 1: Setup the app

git clone https://github.com/Kingsconsult/laravel_8_crud.git
cd laravel_8_crud/
composer install
npm install
cp .env.example .env
php artisan key:generate
Add your database config in the .env file (you can check my articles on how to achieve that)
php artisan migrate
php artisan serve (if the server opens up, http://127.0.0.1:8000, then we are good to go)
Navigate to http://127.0.0.1:8000/projects

Step 2: Make sure Guzzle package is installed

By default, Laravel automatically includes this Guzzle as a dependency when you install Laravel, check your composer.json, if it is one of the required dependency, if you did not see it, or you want to update

composer require guzzlehttp/guzzle

Step 3: Create routes

Modify the routes/web.php file to this



<?php

use Illuminate\Support\Facades\Route;
use App\Http\Controllers\ProjectController;

/*
|--------------------------------------------------------------------------
| Web Routes
|--------------------------------------------------------------------------
|
| Here is where you can register web routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| contains the "web" middleware group. Now create something great!
|
*/

Route::get('/', function () {
    return view('welcome');
});

Route::prefix('projects')->group(function () {
    Route::get('apiwithoutkey', [ProjectController::class, 'apiWithoutKey'])->name('apiWithoutKey');
    Route::get('apiwithkey', [ProjectController::class, 'apiWithKey'])->name('apiWithKey');
});


Route::resource('projects', ProjectController::class);

We added two get routes, one for an API without key (unauthorized) and another with key (authorized).

Step 4: Create Controller methods

In our routes, we indicate that we have two more routes, so we need to write the methods, go to app/Http/Controller/ProjectController.php, and add the following methods
First, call the Guzzle class before the controller class, directly under the namespace

use GuzzleHttp\Client;




    public function apiWithoutKey()
    {
        $client = new Client(); //GuzzleHttp\Client
        $url = "https://api.github.com/users/kingsconsult/repos";


        $response = $client->request('GET', $url, [
            'verify'  => false,
        ]);

        $responseBody = json_decode($response->getBody());

        return view('projects.apiwithoutkey', compact('responseBody'));
    }

    public function apiWithKey()
    {
        $client = new Client();
        $url = "https://dev.to/api/articles/me/published";

        $params = [
            //If you have any Params Pass here
        ];

        $headers = [
            'api-key' => 'k3Hy5qr73QhXrmHLXhpEh6CQ'
        ];

        $response = $client->request('GET', $url, [
            // 'json' => $params,
            'headers' => $headers,
            'verify'  => false,
        ]);

        $responseBody = json_decode($response->getBody());

        return view('projects.apiwithkey', compact('responseBody'));
    }

Explanation

I instantiate the client class from guzzle.
I assign the API URL to a variable (I used GitHub API for my public repositories, this is a public API that fetches one's public GitHub repositories), this API does not require a token for authorization.
I use the request method of the client, it accepts 3 parameters ($method, $url, $options), the $options is where we pass our token if the API requires one, also I passed another option, verify, to be false.
Finally, I convert my response to a json format, so I can pass it to the view.

The second method is for an API that requires authorization, I used dev.to API, this API fetches all my published articles and also all the stats for each article, I passed the api key to the options, I assigned it to a variable call headers.

Step 5: Create the views

I created separate views for the two API

resources/views/projects/apiwithoutkey.blade.php



@extends('layouts.app')

@section('content')

<style>


</style>
<div class="row mb-3">
    <div class="col-lg-12 margin-tb">
        <div class="text-center">
            <h2>Github Public Repository</h2>
            <a class="btn btn-primary" href="{{ route('projects.index') }}" title="Go back"> <i class="fas fa-backward fa-2x"></i> </a>
        </div>
    </div>
</div>



<div class="container-fluid mb-5" style="margin-bottom: 150px !important">
    <div class="row mr-4">
        @foreach ($responseBody as $response)

        <div class="col-xl-3 col-md-6 mb-4 hvr-grow ">
            <a href="{{ $response->html_url }}" class="text-muted">
                <div class="card shadow  py-0 rounded-lg ">
                    <div class="card-body py-2 px-2">
                        <div class="row no-gutters align-items-center">
                            <div class="col mr-2">
                                <div class=" font-weight-bold mb-4 mt- 2 text-primary text-center text-uppercase mb-1">
                                    {{ $response->name }}
                                </div>
                                <div class="h6 mb-0 text-gray-800 text-center">{{ $response->description }}
                                    @if ($response->description == null)
                                    {{ $response->name }}
                                    @endif
                                </div>
                            </div>
                        </div>

                        <div style="position: absolute; bottom: 0" class="mb-2"> <strong>
                                <hi>Language : {{ $response->language }}
                            </strong></hi>
                        </div>
                    </div>
                </div>
            </a>
        </div>
        @endforeach
    </div>
</div>

@endsection

resources/views/projects/apiwithkey.blade.php



@extends('layouts.app')

@section('content')

<style>


</style>
<div class="row mb-3">
    <div class="col-lg-12 margin-tb">
        <div class="text-center">
            <h2>Dev.to Article stats</h2>
            <a class="btn btn-primary" href="{{ route('projects.index') }}" title="Go back"> <i class="fas fa-backward fa-2x"></i> </a>
        </div>
    </div>
</div>



<div class="container-fluid mb-5" style="margin-bottom: 150px !important">
    <div class="row mr-4">
        @foreach ($responseBody as $response)

        <div class="col-xl-3 col-md-6 mb-4 hvr-grow ">
            <div class="card shadow  py-0 rounded-lg ">
                <div class="card-body py-2">
                    <div class="row no-gutters align-items-center">
                        <div class="col mr-2">
                            <a href="{{ $response->url }}" class="text-muted">
                                <div class=" font-weight-bold mb-2 mt-2 text-primary text-center text-uppercase mb-1">
                                    {{ Str::limit($response->title, 45) }}

                                </div>
                            </a>
                            <div class="h6 mb-0 text-gray-800 text-center">
                                {{ Str::limit($response->description, 100) }}
                            </div>
                        </div>
                    </div>
                    <div style="position: absolute; bottom: 0" class="mb-2">
                        <hi>Page Views: <strong>{{ number_format($response->page_views_count) }}</strong></hi>
                        <hi class="ml-3"> Reactions: <strong>{{ $response->positive_reactions_count }} </strong></hi>
                    </div>
                </div>
            </div>
        </div>
        @endforeach
    </div>
</div>

@endsection

Testing
Go to the index page of projects http://127.0.0.1:8000/projects

http://127.0.0.1:8000/projects/apiwithkey

http://127.0.0.1:8000/projects/apiwithoutkey

You can get the complete code from the repo.
Follow me for more of my articles, you can leave comments, suggestions, and reactions

click the link to view my profile and follow me

Visit my other posts