gplcart\modules\dev\controllers\Settings

Complexity

Total Complexity

11

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	submitSettings()	0	6	3
A	validateSettings()	0	5	1
A	__construct()	0	4	1
A	editSettings()	0	10	1
A	getDevModuleSettings()	0	6	1
A	setTitleEditSettings()	0	4	1
A	setBreadcrumbEditSettings()	0	16	1
A	updateSettings()	0	11	1
A	outputEditSettings()	0	4	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\controllers;

use gplcart\core\controllers\backend\Controller as BackendController;

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

    /**
     * Constructor
     */
    public function __construct()
    {
        parent::__construct();
    }

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

        $this->setData('settings', $this->getDevModuleSettings());

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

    /**
     * Returns an array of module settings
     * @return array
     */
    protected function getDevModuleSettings()
    {
        $settings = $this->getModuleSettings('dev');
        $settings['exception'] = $this->config('error_to_exception', false);
        return $settings;
    }

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

    /**
     * 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);
    }

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

    /**
     * Validate submitted module settings
     */
    protected function validateSettings()
    {
        $this->setSubmitted('settings');
        return !$this->hasErrors();
    }

    /**
     * Update module settings
     */
    protected function updateSettings()
    {
        $this->controlAccess('module_edit');

        $submitted = $this->getSubmitted();
        $this->config->set('error_to_exception', !empty($submitted['exception']));
        unset($submitted['exception']);

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

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

}