Laravel Facades

When To Use Laravel Facades?

In the following example, a call is made to the Laravel Log class. Looking at this code, one could think that the static method get on the Log class is being called.

$value = Log::get('key');

But, if we examine the Illuminate\Support\Facades\Log class, we can find that there is no static method get:

class Log extends Facade {
  @return string
   protected static function getFacadeAccessor() { return 'Log'; }
}

Here, the class log extends the base Facade class and provides a method called getFacadeAccessor(). We need to remember that the purpose of this function is to return the name of an IoC binding.

When a user calls a static method on the log facade, Laravel resolves the log binding from the IoC container and executes the requested method (in this example, get) on that object.

So, our Log::get can also be written as:

$value = $app->make('log')->get('key');

How to Create Laravel Facades?

It is simple to create a façade for our own application or package. We simply need three items:

• An IoC binding.
• A facade class.
• An alias setup for a facade.

Below are the steps to understand this:

1. Make a PHP Class File.
2. Bind the class to Service Provider.
3. Add the ServiceProvider to Config\app.php as a provider.
4. Create a class that extends this class to lluminate\Support\Facades\Facade.
5. Add aliases to point 4 in Config\app.php.

Let us understand these steps through an example:

Consider the following example. We have a StudentRolls\Students class defined here.

namespace StudentRolls;
class Student {
    public function work() 
    {
        //
    }
}

This class might be in our app/models directory or any other location that Composer is aware of.

This class must be able to be resolved from the IoC container. So, let's include a binding:

App::bind('students', function()
{
    return new \StudentRolls\Student;
});

This binding may be registered by adding it to the register function of a new service provider named StudentMarksProvider. Then, in the app/config/app.php configuration file, you may instruct Laravel to load your service provider.

use Illuminate\Support\Facades\Facade;

Following that, we can write our own facade class:

class Student extends Facade {
 
    protected static function getFacadeAccessor() { return 'student'; }
}

Finally, in the app/config/app.php configuration file, we can add an alias for our facade to the aliases array. We can now invoke the work function on a Student class object.

Student::work();

How Facades in Laravel Work?

Facades work like friendly gatekeepers for complex systems. They provide a simplified and user-friendly interface, hiding the intricate details behind them. Think of a building with a beautiful entrance; you don't need to know the structure's complexity. Similarly, facades simplify interactions with software or machines. They bundle multiple operations into one easy-to-use function, shielding users from complexities. 

For example, when you start your computer, you click an icon, but behind the scenes, many tasks happen. Facades make it as simple as clicking that icon, making complicated things accessible to everyone.

Facade Class Reference

Each facade and its underlying class are listed in the above table. This is a handy tool for fast exploring the API documentation for a certain facade root. The IoC binding key is also given wherever needed.

Must Read CakePHP vs Laravel

Example of Laravel Facades

Database Interaction (DB Facade):

use Illuminate\Support\Facades\DB;

$users = DB::table('users')->where('status', 'active')->get();

Sending Emails (Mail Facade):

use Illuminate\Support\Facades\Mail;

Mail::to('aditya@coodingninjas.com')->send(new MyEmail());

File Handling (Storage Facade):

use Illuminate\Support\Facades\Storage;

$contents = Storage::get('aditya.txt');

Authentication (Auth Facade):

use Illuminate\Support\Facades\Auth;

if (Auth::check()) {
    // User is logged in
}

Frequently Asked Questions

Where is Facades folder in Laravel?

The Facades folder in Laravel is located under the vendor/laravel/framework/src/Illuminate/Support/Facades directory.

What is the difference between helper and facade in Laravel?

In Laravel, a helper is a simple, global function for common tasks, while a facade is a structured way to access Laravel services and classes, offering more features and flexibility.

Why are facades used?

Facades in Laravel provide a static interface to classes available in the application's service container, simplifying the usage of complex underlying classes through a readable, memorable syntax.

How to create new Facade in Laravel?

To create a new Facade in Laravel, extend the Illuminate\Support\Facades\Facade class, define an accessor method in your service provider, bind the facade to the service container, and specify the alias in the aliases array within config/app.php.

Conclusion

In this article, we discussed Laravel Facades, which provide a static interface to classes in the service container. Facades simplify the use of complex classes by offering a clean, concise syntax. They enhance readability and make the code more expressive. However, it's important to use Facades judiciously and understand the underlying classes to maintain a clear understanding of the application's architecture.

Recommended Reads

• Laravel interview questions, 
• Interview Questions for Design Pattern