Producer

, _(*1)

A small class factory., _(*2)

Getting Started

Run the following to add Producer to your project's composer.json. See Packagist for specific versions., _(*3)

composer require deefour/producer

>=PHP5.5.0 is required., _(*4)

Overview

A Producer is a class that resolves the FQCN of related Producible classes. The Factory accepts a Producer and "type", and can instantiate a concrete Producible class based on the resolved FQCN returned., _(*5)

Producers and Producibles

The production factory only accepts classes that implement Deefour\Producer\Contracts\Producer. An exception will be thrown if the resolved class does not implement Deefour\Producer\Contracts\Producible., _(*6)

Given the following classes, _(*7)

use Deefour\Producer\Contracts\Producer;
use Deefour\Producer\Contracts\Producible;

class Podcast implements Producer
{
    // ...
}

class PodcastPolicy implements Producible
{
    // ...
}

class PodcastScope implements Producible
{
    // ...
}

the production factory can produce an instance of each producible above when given a podcast and "type"., _(*8)

use Deefour\Producer\Factory;

$podcast = new Podcast();
$factory = new Factory();

$factory->resolve($podcast, 'policy'); //=> 'PodcastPolicy`
$factory->resolve($podcast, 'scope'); //=> 'PodcastScope`

$factory->make($podcast, 'policy'); //=> instance of PodcastPolicy

Resolving Producibles

The default producible resolver on the produciton factory looks like this, _(*9)

get_class($producer) . ucfirst($type)

This can be customized by implementing a resolve() method on the producer passed into the factory., _(*10)

use Deefour\Producer\Contracts\Producer;

class Podcast implements Producer
{
    public function resolve($type)
    {
        // return FQCN string here
    }
}

This deefour/producer package also comes with a more opinionated resolver at Deefour\Producer\ResolvesProducibles., _(*11)

namespace App;

use Deefour\Producer\ResolvesProducibles;
use Deefour\Producer\Contracts\Producer;

class Podcast implements Producer
{
    use ResolvesProducibles;
}

this will pluralize the "type" passed in and append that to the namespace of the producer doing the class resolution., _(*12)

use App\Podcast;
use Deefour\Producer\Factory;

$podcast = new Podcast();
$factory = new Factory();

$factory->resolve($podcast, 'policy'); //=> 'App\Policies\PodcastPolicy`

Making Producibles

The default producible instantiator on the production factory looks like this, _(*13)

new $producible($producer);

This can be customized by implementing a make() method on the producer passed into the factory., _(*14)

use Deefour\Producer\Contracts\Producer;

class Podcast implements Producer
{
    public function make($producible)
    {
        // instantiate the passed $producible (an FQCN)
    }
}

Note: The Deefour\Producer\ResolvesProducibles trait does not implement the make() method., _(*15)