Phile\Plugin\AbstractPlugin

Complexity

Total Complexity

10

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

94.44%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	initializePlugin()	0	43	5
A	injectSettings()	0	3	1
A	on()	0	15	3
A	getPluginPath()	0	4	1

<?php
/**
 * Plugin class
 */
namespace Phile\Plugin;

use Phile\Core\Container;
use Phile\Core\Utility;
use Phile\Gateway\EventObserverInterface;

/**
 * the AbstractPlugin class for implementing a plugin for PhileCMS
 *
 * @author  PhileCMS
 * @link    https://philecms.com
 * @license http://opensource.org/licenses/MIT
 * @package Phile\Plugin
 */
abstract class AbstractPlugin implements EventObserverInterface
{

    /**
 * @var string plugin attributes
*/
    private $plugin = [];

    /**
 * @var array subscribed Phile events ['eventName' => 'classMethodToCall']
*/
    protected $events = [];

    /**
 * @var array the plugin settings
*/
    protected $settings = [];

    /**
     * initialize plugin
     *
     * try to keep all initialization in one method to have a clean class
     * for the plugin-user
     *
     * @param      string $pluginKey
     * @deprecated since 1.5.1 will be declared 'final'
     */
    public function initializePlugin($pluginKey)
    {
        /**
         * init $plugin property
         */
        $this->plugin['key'] = $pluginKey;
        list($vendor, $name) = explode('\\', $this->plugin['key']);
        $DS = DIRECTORY_SEPARATOR;
        $this->plugin['dir'] = PLUGINS_DIR . $vendor . $DS . $name . $DS;

        /**
         * init events
         */
        foreach ($this->events as $event => $method) {
            Container::getInstance()->get('Phile_EventBus')->register($event, $this);
        }

        /**
         * init plugin settings
         */
        $defaults = Utility::load($this->getPluginPath('config.php'));
        if (empty($defaults) || !is_array($defaults)) {
            $defaults = [];
        }

        $globals = Container::getInstance()->get('Phile_Config')->toArray();
        if (!isset($globals['plugins'][$pluginKey])) {
            $globals['plugins'][$pluginKey] = [];
        }

        // settings precedence: global > default > class
        $this->settings = array_replace_recursive(
            $this->settings,
            $defaults,
            $globals['plugins'][$pluginKey]
        );

        // backwards compatibility to Phile 1.4
        $this->injectSettings($this->settings);

The method Phile\Plugin\AbstractPlugin::injectSettings() has been deprecated with message: since 1.5.1 will be removed

        $globals['plugins'][$pluginKey]['settings'] = $this->settings;
        Container::getInstance()->get('Phile_Config')->set($globals);
    }

    /**
     * inject settings
     *
     * backwards compatibility to Phile 1.4
     *
     * @param      array $settings
     * @deprecated since 1.5.1 will be removed
     */
    public function injectSettings(array $settings = null)

The parameter $settings is not used and could be removed.

    {
    }

    /**
     * implements EventObserverInterface
     *
     * @param  string $eventKey
     * @param  null   $data
     * @return void
     */
    public function on($eventKey, $data = null)
    {
        if (!isset($this->events[$eventKey])) {
            return;
        }
        $method = $this->events[$eventKey];
        if (!is_callable([$this, $method])) {
            $class = get_class($this);
            throw new \RuntimeException(
                "Event $eventKey can't invoke $class::$method(). Not callable.",
                1428564865
            );
        }
        $this->{$this->events[$eventKey]}($data);
    }

    /**
     * get file path to plugin root (trailing slash) or to a sub-item
     *
     * @param  string $subPath
     * @return null|string null if item does not exist
     */
    protected function getPluginPath($subPath = '')
    {
        return $this->plugin['dir'] . ltrim($subPath, DIRECTORY_SEPARATOR);
    }
}