Gbowo\Traits\Pluggable

Complexity

Total Complexity

6

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

76.47%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	addPlugin()	0	6	1
A	__call()	0	6	1
A	callPlugin()	0	16	2
A	getPlugin()	0	10	2

<?php

namespace Gbowo\Traits;

use LogicException;
use Gbowo\Contract\Plugin\PluginInterface;
use Gbowo\Contract\Adapter\AdapterInterface;
use Gbowo\Exception\PluginNotFoundException;

trait Pluggable
{

    /**
     * @var PluginInterface[]
     */
    protected $plugins = [];

    /**
     * Add a plugin
     * @param \Gbowo\Contract\Plugin\PluginInterface $plugin
     * @return $this
     */
    public function addPlugin(PluginInterface $plugin)
    {
        $this->plugins[$plugin->getPluginAccessor()] = $plugin;

        return $this;
    }

    /**
     * Magic method to allow for a plugin call
     * @param string $pluginAccessor
     * @param array  $argument
     * @return mixed
     */
    public function __call(
        string $pluginAccessor,
        array $argument
    ) {
        return $this->callPlugin($pluginAccessor, $argument, $this);
    }

    /**
     * @param string                                   $accessor The plugin accessor
     * @param array                                    $argument Args to pass to the plugin's `handle` method
     * @param \Gbowo\Contract\Adapter\AdapterInterface $adapter  The adapter in use.
     * @throws \LogicException if the plugin does not have an handle method
     * @return mixed
     */
    public function callPlugin(
        string $accessor,
        array $argument,
        AdapterInterface $adapter
    ) {
        $plugin = $this->getPlugin($accessor);
        $plugin->setAdapter($adapter);

        if (method_exists($plugin, "handle")) {
            return $plugin->handle(...$argument);
        }

        throw new LogicException(
            "A Plugin MUST have an handle method"
        );
    }

    /**
     * @param string $accessor
     * @return \Gbowo\Contract\Plugin\PluginInterface
     * @throws \Gbowo\Exception\PluginNotFoundException If the plugin cannot be found
     */
    public function getPlugin(string $accessor)
    {
        if (!isset($this->plugins[$accessor])) {
            throw new PluginNotFoundException(
                "Plugin with accessor, {$accessor} not found"
            );
        }

        return $this->plugins[$accessor];
    }
}