gplcart\modules\base\Module

Complexity

Total Complexity

15

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	hookRouteList()	0	8	1
A	hookInstallHandlers()	0	4	1
A	hookInstallBefore()	0	4	1
A	hookTemplateRender()	0	4	1
A	setInstallHandlers()	0	20	1
A	checkRequiredModules()	0	10	4
A	replaceTemplates()	0	6	3
A	getModel()	0	4	1
A	getTranslationModel()	0	4	1

<?php

/**
 * @package Base
 * @author Iurii Makukh <gplcart.software@gmail.com>
 * @copyright Copyright (c) 2017, Iurii Makukh <gplcart.software@gmail.com>
 * @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
 */

namespace gplcart\modules\base;

use gplcart\core\Config,
    gplcart\core\Container;

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

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

    /**
     * @param Config $config
     */
    public function __construct(Config $config)
    {
        $this->config = $config;
    }

    /**
     * Implements hook "route.list"
     * @param array $routes
     */
    public function hookRouteList(array &$routes)
    {
        $routes['install/(\d+)'] = array(
            'handlers' => array(
                'controller' => array('gplcart\\modules\\base\\controllers\\Install', 'stepInstall')
            )
        );
    }

    /**
     * Implements hook "install.handlers"
     * @param array $handlers
     */
    public function hookInstallHandlers(array &$handlers)
    {
        $this->setInstallHandlers($handlers);
    }

    /**
     * Implements hook "install.before"
     * @param array $data
     * @param mixed $result
     */
    public function hookInstallBefore(array $data, &$result)
    {
        $this->checkRequiredModules($data, $result);
    }

    /**
     * Implements hook "template.render"
     * @param array $templates
     */
    public function hookTemplateRender(array &$templates)
    {
        $this->replaceTemplates($templates);
    }

    /**
     * Adds installation handlers
     * @param array $handlers
     */
    protected function setInstallHandlers(array &$handlers)
    {
        $language = $this->getTranslationModel();

        $handlers['base'] = array(
            'module' => 'base',
            'title' => $language->text('Base'),
            'steps' => array(
                1 => array('title' => $language->text('Configure modules')),
                2 => array('title' => $language->text('Create demo')),
                3 => array('title' => $language->text('Finish installation'))
            ),
            'handlers' => array(
                'install' => array('gplcart\\modules\\base\\handlers\\Install', 'install'),
                'install_1' => array('gplcart\\modules\\base\\handlers\\Install', 'installModules'),
                'install_2' => array('gplcart\\modules\\base\\handlers\\Install', 'installDemo'),
                'install_3' => array('gplcart\\modules\\base\\handlers\\Install', 'installFinish')
            )
        );
    }

    /**
     * Check if all required modules in place
     * @param array $data
     * @param array $result
     */
    protected function checkRequiredModules(array $data, &$result)
    {
        if ($data['installer'] === 'base' && empty($data['step']) && !$this->getModel()->hasAllRequiredModules()) {
            $result = array(
                'redirect' => '',
                'severity' => 'warning',
                'message' => $this->getTranslationModel()->text('You cannot use this installer because some modules are missed in your distribution')
            );
        }
    }

    /**
     * Replace system templates
     * @param array $templates
     */
    protected function replaceTemplates(array &$templates)
    {
        if (substr($templates[0], -15) === 'dashboard/intro' && $this->config->get('installer') === 'base') {
            $templates[0] = __DIR__ . '/templates/intro';
        }
    }

    /**
     * Returns the module model
     * @return \gplcart\modules\base\models\Installer
     */
    protected function getModel()
    {
        return Container::get('gplcart\\modules\\base\\models\\Install');
    }

    /**
     * Translation UI model instance
     * @return \gplcart\core\models\Translation
     */
    protected function getTranslationModel()
    {
        return Container::get('gplcart\\core\\models\\Translation');
    }

}