sebastiaanluca/laravel-conditional-providers

Load Laravel service providers based on the current environment.

5.0.0 2020-04-24 17:15 UTC

This package is auto-updated.

Last update: 2021-07-24 21:39:07 UTC


README

Latest stable release Software license Build status Total downloads Total stars

Read my blog View my other packages and projects Follow @sebastiaanluca on Twitter Share this package on Twitter

Load Laravel service providers and facades based on the current environment.

Specify the service providers and facades to load per environment directly in your configuration file. No more need to add lengthy blocks of conditionals to your AppServiceProvider, do it all in the app configuration file like you would with any service provider and facade!

Inspired by Matt Staufer, Sven Luijten, and others.

Table of contents

What does it solve?

Say you're using a package like barryvdh/laravel-ide-helper in your project. If you've followed its installation instructions and require it only in development environments (like you should), you'd do the following:

composer require barryvdh/laravel-ide-helper --dev

And then add the service provider to your app's config providers array:

'providers' => [

    Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,

]

Now when you run composer install --no-dev in your production environment to install all but development packages, this will throw an exception. Laravel will try to load the registered service provider class which it can't find, because the package is not installed.

[Symfony\Component\Debug\Exception\FatalThrowableError]
Class 'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider' not found

Of course you can —per the instructions— conditionally load the provider manually in the register method of the app/Providers/AppServiceProvider.php file:

public function register()
{
    if ($this->app->environment() !== 'production') {
        $this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
    }
}

But you'd have to do this for each development package and each environment you don't want it loaded in, which is hardly maintainable and pollutes your application-specific code.

Enter Laravel conditional providers to easily do all of this in your main application config file!

Requirements

  • PHP 7.3 or higher
  • Laravel 6.0 or higher

How to install

composer require sebastiaanluca/laravel-conditional-providers

How to use

Conditional providers

Disable auto-discovery of the package's service provider by adding it to your composer.json's relevant section:

"extra": {
    "laravel": {
        "dont-discover": [
            "barryvdh/laravel-debugbar"
        ]
    }
},

Once you're set up, simply add a providers array per environment to your config/app.php file:

'providers' => [

    // Contains your global providers which will load in any environment

],

'local_providers' => [

    // Contains your 'local' environment providers

    // Mostly used to load debug helpers, optimization tools, et cetera

    Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
    Barryvdh\Debugbar\ServiceProvider::class,

],

'production_providers' => [

    // Contains your 'production' environment providers

    // Great for when you only want to get analytics or
    // bug reports in production and disable the provider
    // entirely when developing.

],

Each providers key is optional and can be empty —so you could just use the local_providers array or none at all.

The example above will do the following in a local environment:

  • Load every provider from providers
  • Load every provider from local_providers
  • Ignore everything in production_providers

All done! Now your app service provider is clean and you get a better view on what's loaded and when, with the added benefit of enabling or disabling packages based on environment.

Conditional aliases

In addition to conditionally loading providers, this workflow is also available for aliases/facades. Add a facades/aliases array per environment to your config/app.php file like so:

'aliases' => [

    // Contains your global aliases which will load in any environment

],

'local_aliases' => [

    // Contains your 'local' environment aliases/facades

    'Debugbar' => Barryvdh\Debugbar\Facade::class,

],

'production_aliases' => [

    // Contains your 'production' environment aliases/facades

],

That's it! This will load the Debugbar facade only in the local environment.

License

This package operates under the MIT License (MIT). Please see LICENSE for more information.

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

composer install
composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email hello@sebastiaanluca.com instead of using the issue tracker.

Credits

About

My name is Sebastiaan and I'm a freelance Laravel developer specializing in building custom Laravel applications. Check out my portfolio for more information, my blog for the latest tips and tricks, and my other packages to kick-start your next project.

Have a project that could use some guidance? Send me an e-mail at hello@sebastiaanluca.com!