gplcart\modules\summernote\controllers\Settings

Complexity

Total Complexity

12

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

9 Methods

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

<?php

/**
 * @package Summernote
 * @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\summernote\controllers;

use gplcart\core\models\Module as ModuleModel;
use gplcart\core\controllers\backend\Controller as BackendController;

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

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

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

        $this->module = $module;
    }

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

        $this->setDataModuleSettings();

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

    /**
     * Sets module settings
     */
    protected function setDataModuleSettings()
    {
        $settings = $this->config->getFromModule('summernote');
        $settings['selector'] = implode("\n", $settings['selector']);
        $settings['config'] = gplcart_json_encode($settings['config'], true);

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

    /**
     * Set title on the module settings page
     */
    protected function setTitleEditSettings()
    {
        $vars = array('%name' => $this->text('Summernote'));
        $title = $this->text('Edit %name settings', $vars);
        $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);
    }

    /**
     * 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', null, false);

        $this->validateElement('selector', 'required');
        $this->validateElement('config', 'json_encoded');

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

        $this->setSubmittedArray('selector');
        $this->setSubmitted('config', json_decode($this->getSubmitted('config'), true));
        return true;
    }

    /**
     * Update module settings
     */
    protected function updateSettings()
    {
        $this->controlAccess('module_edit');
        $this->module->setSettings('summernote', $this->getSubmitted());
        $this->redirect('', $this->text('Settings have been updated'), 'success');
    }

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

}