gplcart\modules\dev\Module

Complexity

Total Complexity

19

Size/Duplication

Total Lines	209
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	hookConstruct()	0	5	1
A	hookConstructController()	0	4	1
A	hookTemplateOutput()	0	4	1
A	hookLibraryList()	0	15	1
A	hookRouteList()	0	9	1
A	hookModuleEnableAfter()	0	4	1
A	hookModuleDisableAfter()	0	4	1
A	hookModuleInstallAfter()	0	4	1
A	hookModuleUninstallAfter()	0	4	1
A	getKintFile()	0	10	2
A	setModuleAssets()	0	11	3
A	setDevToolbar()	0	17	3
A	setLogger()	0	8	1

<?php

/**
 * @package Dev
 * @author Iurii Makukh
 * @copyright Copyright (c) 2017, Iurii Makukh
 * @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
 */

namespace gplcart\modules\dev;

use gplcart\core\Logger,
    gplcart\core\Config,
    gplcart\core\Library,
    gplcart\core\Module as CoreModule;
use gplcart\core\exceptions\Dependency as DependencyException;

/**
 * Main class for Dev module
 */
class Module
{

    /**
     * Config class instance
     * @var \gplcart\core\Config
     */
    protected $config;

    /**
     * Database class instance
     * @var \gplcart\core\Database $db
     */
    protected $db;

    /**
     * Module class instance
     * @var \gplcart\core\Module $module
     */
    protected $module;

    /**
     * Library class instance
     * @var \gplcart\core\Library $library
     */
    protected $library;

    /**
     * Logger class instance
     * @var \gplcart\core\Logger $logger
     */
    protected $logger;

    /**
     * @param Logger $logger
     * @param Config $config
     * @param Library $library
     * @param CoreModule $module
     */
    public function __construct(Logger $logger, Config $config, Library $library, CoreModule $module)
    {
        $this->module = $module;
        $this->logger = $logger;
        $this->config = $config;
        $this->library = $library;
        $this->db = $this->config->getDb();
    }

    /**
     * Implements hook "construct"
     */
    public function hookConstruct()
    {
        $this->setLogger();
        require_once $this->getKintFile();
    }

    /**
     * Implements hook "construct.controller"
     * @param \gplcart\core\Controller $controller
     */
    public function hookConstructController($controller)
    {
        $this->setModuleAssets($controller);
    }

    /**
     * Implements hook "template.output"
     * @param string $html
     * @param \gplcart\core\Controller $controller
     */
    public function hookTemplateOutput(&$html, $controller)
    {
        $this->setDevToolbar($html, $controller);
    }

    /**
     * Implements hook "library.list"
     * @param array $libraries
     */
    public function hookLibraryList(array &$libraries)
    {
        $libraries['kint'] = array(
            'name' => 'Kint',
            'description' => 'A powerful and modern PHP debugging tool',
            'url' => 'https://github.com/raveren/kint',
            'download' => 'https://github.com/kint-php/kint/archive/2.0-alpha4.zip',
            'type' => 'php',
            'version' => '2.0-alpha4',
            'module' => 'dev',
            'files' => array(
                'vendor/kint-php/kint/init.php'
            )
        );
    }

    /**
     * Implements hook "route.list"
     * @param array $routes
     */
    public function hookRouteList(array &$routes)
    {
        $routes['admin/module/settings/dev'] = array(
            'access' => '__superadmin',
            'handlers' => array(
                'controller' => array('gplcart\\modules\\dev\\controllers\\Settings', 'editSettings')
            )
        );
    }

    /**
     * Implements hook "module.enable.after"
     */
    public function hookModuleEnableAfter()
    {
        $this->library->clearCache();
    }

    /**
     * Implements hook "module.disable.after"
     */
    public function hookModuleDisableAfter()
    {
        $this->library->clearCache();
    }

    /**
     * Implements hook "module.install.after"
     */
    public function hookModuleInstallAfter()
    {
        $this->library->clearCache();
    }

    /**
     * Implements hook "module.uninstall.after"
     */
    public function hookModuleUninstallAfter()
    {
        $this->library->clearCache();
    }

    /**
     * Returns a path to Kint's init file
     * @return string
     */
    public function getKintFile()
    {
        $file = __DIR__ . '/vendor/kint-php/kint/init.php';

        if (is_file($file)) {
            return $file;
        }

        throw new DependencyException("Kint file $file not found");
    }

    /**
     * Sets module specific assets
     * @param \gplcart\core\Controller $controller
     */
    protected function setModuleAssets($controller)
    {
        if (!$controller->isInternalRoute()) {
            $settings = $this->module->getSettings('dev');
            if (!empty($settings['status'])) {
                $controller->setJsSettings('dev', array('key' => $settings['key']));
                $controller->setJs(__DIR__ . '/js/common.js', array('position' => 'bottom'));
                $controller->setCss(__DIR__ . '/css/common.css');
            }
        }
    }

    /**
     * Adds toolbar
     * @param string $html
     * @param \gplcart\core\Controller $controller
     */
    protected function setDevToolbar(&$html, $controller)
    {
        if (!$controller->isInternalRoute()) {
            $settings = $this->module->getSettings('dev');
            if (!empty($settings['status'])) {

                $data = array(
                    'key' => $settings['key'],
                    'time' => microtime(true) - GC_START,
                    'queries' => $this->db->getLogs()
                );

                $toolbar = $controller->render('dev|toolbar', $data);
                $html = substr_replace($html, $toolbar, strpos($html, '</body>'), 0);
            }
        }
    }

    /**
     * Configure system logger
     */
    protected function setLogger()
    {
        $settings = $this->module->getSettings('dev');

        $this->logger->printError(!empty($settings['print_error']))
                ->errorToException(!empty($settings['error_to_exception']))
                ->printBacktrace(!empty($settings['print_error_backtrace']));
    }

}