gplcart\modules\currency\controllers\Settings

Complexity

Total Complexity

16

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	editSettings()	0	10	1
A	submitSettings()	0	6	3
A	validateSettings()	0	21	4
A	updateSettings()	0	16	3
A	updateRateSettings()	0	5	1
A	setTitleEditSettings()	0	5	1
A	setBreadcrumbEditSettings()	0	16	1
A	outputEditSettings()	0	4	1

<?php

/**
 * @package Currency 
 * @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 GNU General Public License 3.0 
 */

namespace gplcart\modules\currency\controllers;

use gplcart\core\models\Module as ModuleModel;
use gplcart\core\controllers\backend\Controller as BackendController;
use gplcart\modules\currency\models\Currency as CurrencyModuleCurrencyModel;

/**
 * Handles incoming requests and outputs data related to Currency module settings
 */
class Settings extends BackendController
{

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

    /**
     * Currency model instance
     * @var \gplcart\modules\currency\models\Currency $currency_module_model
     */
    protected $currency_module_model;

    /**
     * @param ModuleModel $module
     * @param CurrencyModuleCurrencyModel $currency
     */
    public function __construct(ModuleModel $module,
            CurrencyModuleCurrencyModel $currency)
    {
        parent::__construct();

        $this->module = $module;
        $this->currency_module_model = $currency;
    }

    /**
     * Route page callback to display the module settings page
     */
    public function editSettings()
    {
        $this->setTitleEditSettings();
        $this->setBreadcrumbEditSettings();

        $this->setData('settings', $this->config->module('currency'));

        $this->submitSettings();
        $this->outputEditSettings();
    }

    /**
     * Saves the submitted settings
     */
    protected function submitSettings()
    {
        if ($this->isPosted('save') && $this->validateSettings()) {
            $this->updateSettings();
        }
    }

    /**
     * Validates an array of submitted values
     * @return array
     */
    protected function validateSettings()
    {
        $this->setSubmitted('settings');
        $this->setSubmittedBool('status');

        $this->validateElement('interval', 'integer');
        $this->validateElement('correction', 'numeric');

        $parts = array_map('trim', explode(',', $this->getSubmitted('derivation')));

        if (count($parts) != count(array_filter($parts, 'is_numeric')) || count($parts) != 4) {
            $this->setError('derivation', $this->text('Derivation must contain exactly 4 positive numbers separated by comma'));
        }

        if ($this->hasErrors()) {
            return false;
        }

        $this->setSubmitted('derivation', $parts);
        return true;
    }

    /**
     * Updates module settings
     */
    protected function updateSettings()
    {
        $this->controlAccess('module_edit');
        $this->module->setSettings('currency', $this->getSubmitted());

        if ($this->getSubmitted('update')) {
            $results = $this->updateRateSettings();
            if (!empty($results)) {
                $vars = array('@list' => implode(',', array_keys($results)));
                $message = $this->text('Updated the following currencies: @list', $vars);
                $this->setMessage($message, 'success', true);
            }
        }

        $this->redirect('', $this->text('Settings have been updated'), 'success');
    }

    /**
     * Updates currency rates
     * @return array
     */
    protected function updateRateSettings()
    {
        $this->currency_module_model->setSettings($this->getSubmitted());
        return $this->currency_module_model->update();
    }

    /**
     * Set title on the module settings page
     */
    protected function setTitleEditSettings()
    {
        $title = $this->text('Edit %name settings', array('%name' => $this->text('Currency')));
        $this->setTitle($title);
    }

    /**
     * Set breadcrumbs on the module settings page
     */
    protected function setBreadcrumbEditSettings()
    {
        $breadcrumbs = array();

        $breadcrumbs[] = array(
            'text' => $this->text('Dashboard'),
            'url' => $this->url('admin')
        );

        $breadcrumbs[] = array(
            'text' => $this->text('Modules'),
            'url' => $this->url('admin/module/list')
        );

        $this->setBreadcrumbs($breadcrumbs);
    }

    /**
     * Render and output the module settings page
     */
    protected function outputEditSettings()
    {
        $this->output('currency|settings');
    }

}