Laravel Aware Of Helpers

Getters and Setters helpers for some of Laravel's core packages.

These components allow you to manually set and retrieve a Laravel component, e.g. a configuration Repository. Additionally, when no component instance has been specified, it will automatically default to whatever Laravel has bound in the IoC.

You can think of these helpers as alternatives, or supplements to Laravel's native Facades.

Usage

Imagine that you have a component that depends on Laravel's configuration Repository. To ensure that your component is able to gain access to it, use the ConfigTrait.

use Aedart\Support\Helpers\Config\ConfigTrait;

class Box
{
    use ConfigTrait;
    
    // ... remaining not shown ... //
}

When you use your component, you will automatically have the configuration Repository available, when your are working inside a typical Laravel Application.

$box = new Box();

$config = $box->getConfig();

You can also specify a custom Repository, should you wish it.

$box->setConfig($myCustomRepository);

Enforce Via Interface

For each available aware-of helper, there is a complementary interface, so that you can enforce your dependencies.

use Aedart\Support\Helpers\Config\ConfigTrait;
use Aedart\Contracts\Support\Helpers\Config\ConfigAware;

class Box implements ConfigAware 
{
    use ConfigTrait;
    
    // ... remaining not shown ... //
}

Custom Default

You can also easily overwrite the default instance provided, by overwriting the getDefault[Dependency] method, which exists inside each aware-of trait.

<?php
use Aedart\Support\Helpers\Config\ConfigTrait;
use Illuminate\Contracts\Config\Repository;
use Illuminate\Config\Repository as Config;

class Box
{
    use ConfigTrait;
    
    public function getDefaultConfig(): ?Repository
    {
        return new Config([
            'width'     => 25,
            'height'    => 25
        ]);
    }
    
    // ... remaining not shown ... //
}

Outside Laravel Usage

If you wish to use these helpers outside a typical Laravel Application, then you must ensure that the required services have been registered in the IoC.

Pros and Cons

If you are a regular Laravel user, then you most likely have your own desired way to obtain dependencies. Most likely, you either resolve these via the Service Container or rely on Facades. There is absolutely nothing wrong with that and you should continue to do so, if it feels right.

As previously mentioned, these components are alternatives or supplementary - either they make sense for you to use or they do not. In other words, you have to decide for yourself when and how to use these, if at all. Should you do, then remember that they do add a bit of additional complexity to your components.

Available Aware Of Helpers

These are the available aware-of helpers for Laravel components. The Defaults to binding column illustrates what Service Container binding a given trait defaults to, if no custom has been set or overwritten. See Facade Class Reference for additional information.

Auth

Broadcasting

Bus

Cache

Config

Console

Container

Cookie

Database

Encryption

Events

Filesystem

Foundation

Hashing

Http

Logging

Mail

Notifications

Queue

Redis

Routing

Session

Translation

Validation

View