Create and Use Custom Facade in Laravel 7.x

Published on August 18, 2020 1 min read

The Facade pattern is a software design pattern that is often used in object-oriented programming. A facade is, in fact, a class wrapping a complex library to provide a simpler and more readable interface to it.

Source: sitepoint.com

In this article, we’re going to create a custom Facade and use it. I’m testing on Laravel 7.17.2. Let’s start:

Table of Contents

  1. Create a Class
  2. Create Service Provider
  3. Create Facade Class
  4. Define Route and Test

Create a Class

Go to app folder and create a folder named CustomFacades. Under CustomFacades directory create a class called CustomClass.php. Then paste this code:

app/CustomFacades/CustomClass.php
<?php

namespace App\CustomFacades;

class CustomClass
{
    public static function greet($name)
    {
        return "Hello " . $name;
    }
}

Create Service Provider

We need a service prodiver for our custom facades. Let’s create by hitting this command:

php artisan make:provider CustomServiceProvider

After creating the service provider, open the file and paste this code:

app/Providers/CustomServiceProvider.php
<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class CustomServiceProvider extends ServiceProvider
{
    /**
     * Register services.
     *
     * @return void
     */
    public function register()
    {
        $this->app->bind('customClass', function () {
            return new \App\CustomFacades\CustomClass;
        });
    }

    /**
     * Bootstrap services.
     *
     * @return void
     */
    public function boot()
    {
    }
}

We’ve registered our CustomClass in the service provider.

Create Facade Class

Let’s now create a facade class to access our CustomClass. Create CustomClassFacade.php under app\CustomFacades folder & paste this code:

app/CustomFacades/CustomClassFacade.php
<?php

namespace App\CustomFacades;

use Illuminate\Support\Facades\Facade;

class CustomClassFacade extends Facade
{
    protected static function getFacadeAccessor()
    {
        return 'customClass';
    }
}

Define Route and Test

Open routes/web.php file and define a test route:

routes/web.php
<?php

use App\CustomFacades\CustomClass;
use Illuminate\Support\Facades\Route;

Route::get('test', function(){
    $result = CustomClass::greet('Obydul');
    dd($result);
});

Now visit the route and see the output.

That’s it. Thanks for reading. 🙂

Author

Hey, I'm Md Obydullah. I build open-source projects and write on Laravel, Linux server, modern JavaScript and more on web development.

Follow

Leave a Reply

Your email address will not be published. Required fields are marked *