michaeljennings/utilities

Utilities

This package contains a series of utility classes that I use frequently in projects, most of the utilities are built with laravel in mind., _(*1)

Installation

Install using composer require michaeljennings/utilities., _(*2)

Refinery Caching

Occasionally when using the refinery package you may have templates that are quite intensive to run., _(*3)

To fix this you can use the CachesTemplates trait., _(*4)

Firstly, you need to install the michaeljennings/broker package., _(*5)

Then on the class you want to refine implement the Cacheable interface. See the broker documentation for more information., _(*6)

// Item being refined
class ToRefine implements Michaeljennings\Broker\Contracts\Cacheable
{
    /**
     * Get the key to cache the attributes against.
     *
     * @return string
     */
    public function getCacheKey()
    {
        return 'test';
    }

    /**
     * Get the unique key for the cacheable item.
     *
     * @return int|string
     */
    public function getKey()
    {
        return 1;    
    }
}

Finally implement the CachesTemplates trait on your refinery., _(*7)

class Example extends Michaeljennings\Refinery\Refinery
{
    use CachesTemplates;

    public function setTemplate($item)
    {
        //
    }
}

Domain Builder

Very frequently I build projects that use multiple subdomains. I also find I need to create links between subdomains quite frequently but I don't want to hard code the links., _(*8)

This class allows you to create links between multiple domains, but use the same API throughout your application., _(*9)

Firstly you need to define the domains in the utilities.php config file., _(*10)

'domains' => [
  'app' => 'http://app.example.com',
  'api' => 'http://api.example.com',
]

Then you can either hit the get method, or dynamically hit the key you have set., _(*11)

$url = $domainBuilder->get('app'); // http://app.example.com
$url = $domainBuilder->app(); // http://app.example.com

You can also pass anything you want to be appended to the url as an argument., _(*12)

$url = $domainBuilder->get('app', 'foo/bar'); // http://app.example.com/foo/bar
$url = $domainBuilder->get('app', 'foo', 'bar'); // http://app.example.com/foo/bar
$url = $domainBuilder->app('foo/bar'); // http://app.example.com/foo/bar
$url = $domainBuilder->app('foo', 'bar'); // http://app.example.com/foo/bar

I usually resolve class using laravel's IOC container, but if you want to new it up yourself you just need to pass the config to the constructor., _(*13)

$domainBuilder = new MichaelJennings\Utilities\DomainBuilder(config('utilities.domains'));