gplcart\modules\mail\controllers\Settings

Complexity

Total Complexity

11

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	editSettings()	0	11	1
A	setDataEditSettings()	0	8	2
A	setTitleEditSettings()	0	5	1
A	setBreadcrumbEditSettings()	0	16	1
A	submitSettings()	0	6	3
A	validateSettings()	0	14	1
A	updateSettings()	0	6	1
A	outputEditSettings()	0	4	1

<?php

/**
 * @package Mail
 * @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\mail\controllers;

use gplcart\core\controllers\backend\Controller;

/**
 * Handles incoming requests and outputs data related to Mail module
 */
class Settings extends Controller
{

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

        $this->setData('settings', $this->module->getSettings('mail'));

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

    /**
     * Prepare data before passing to templates
     */
    protected function setDataEditSettings()
    {
        $smtp_host = $this->getData('settings.host');

        if (is_array($smtp_host)) {
            $this->setData('settings.host', implode(PHP_EOL, (array) $smtp_host));
        }
    }

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

        $this->validateElement('port', 'numeric');
        $this->validateElement('host', 'required');
        $this->validateElement('user', 'required');
        $this->validateElement('password', 'required');

        $this->setSubmittedBool('auth');
        $this->setSubmittedArray('host');

        return !$this->hasErrors();
    }

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

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

}