lagdo/laravel-facades

Call Laravel services using facades.

v1.0.0 2025-03-31 19:48 UTC

Requires

• illuminate/support: 7.*|8.*|9.*|10.*|11.*|12.*
• lagdo/facades: ^1.0

Requires (Dev)

• php-coveralls/php-coveralls: ^2.4
• phpunit/phpcov: ^8.2
• phpunit/phpunit: ^9.5

BSD-3-Clause

• Thierry Feuzeu

• framework
• php
• laravel
• services
• facades

README

Facades for Laravel services

With this package, Laravel services can be called using service facades, with static method syntax.

Note

It may be surprising to implement service facades for Laravel, since the same feature is already provided. Laravel even invented the service facades! But unlike Laravel, the service facades here are portable across different frameworks.

Facades definition

The base classes for service facade definitions are provided by the lagdo/facades package.

A service facade based on this package can be use without any change with other frameworks, if a package for this framework is available, or a PSR-11 container can be provided.

The following packages are also available:

• Symfony: https://github.com/lagdo/symfony-facades
• CakePHP: https://github.com/lagdo/cake-facades
• Yii: https://github.com/lagdo/yii-facades

Installation

Install the package with composer.

composer require lagdo/laravel-facades

Register the Lagdo\Laravel\Facades\FacadesBundle bundle in the config/bundles.php file.

Usage

A service facade inherits from the Lagdo\Facades\AbstractFacade abstract class, and implements the getServiceIdentifier() method, which must return the id of the corresponding service in the service container.

namespace App\Facades;

use App\Services\MyService;
use Lagdo\Facades\AbstractFacade;

/**
 * @extends AbstractFacade<MyService>
 */
class MyFacade extends AbstractFacade
{
    /**
     * @inheritDoc
     */
    protected static function getServiceIdentifier(): string
    {
        return MyService::class;
    }
}

The methods of the App\Services\MyService service can now be called using the App\Facades\MyFacade facade, like this.

class TheService
{
    public function theMethod()
    {
        MyFacade::myMethod();
    }
}

Instead of this.

class TheService
{
    /**
     * @var MyService
     */
    protected $myService;

    public function __construct(MyService $myService)
    {
        $this->myService = $myService;
    }

    public function theMethod()
    {
        $this->myService->myMethod();
    }
}

The @extends AbstractFacade<MyService> phpdoc will prevent errors during code analysis with PHPStan, and allow code completion on calls to service facades in editors.

Getting the service instance

The instance() method of a service facade returns the instance of the linked service.

class TheService
{
    public function theMethod()
    {
        $service = MyFacade::instance();
        $service->myMethod();
    }
}

The Lagdo\Facades\ServiceInstance trait

By default, each call to a service facade method will also call the service container. The service instance can be saved in the facade after the first call to the service container, using the Lagdo\Facades\ServiceInstance trait. The next calls with return the service instance without calling the service container.

namespace App\Facades;

use App\Services\MyService;
use Lagdo\Facades\AbstractFacade;
use Lagdo\Facades\ServiceInstance;

/**
 * @extends AbstractFacade<MyService>
 */
class MyFacade extends AbstractFacade
{
    use ServiceInstance;

    /**
     * @inheritDoc
     */
    protected static function getServiceIdentifier(): string
    {
        return MyService::class;
    }
}

Important

The Lagdo\Facades\ServiceInstance trait must be used in each service facade class, and not in a parent class. The same instance will be shared by all the classes inheriting the same base class using the trait, and the service facades will ot work as expected.

The service container is called only once in this example code.

    MyFacade::myMethod1(); // Calls the service container
    MyFacade::myMethod2(); // Doesn't call the service container
    MyFacade::myMethod1(); // Doesn't call the service container

Provided facades

Some service facades are included by default in this package.

Logger

This facade requires that the Psr\Log\LoggerInterface id is defined and bound to the logger in the service container.

use Lagdo\Facades\Logger;

Logger::info($message, $vars);

Contribute

• Issue Tracker: github.com/lagdo/laravel-facades/issues
• Source Code: github.com/lagdo/laravel-facades

License

The package is licensed under the 3-Clause BSD license.