Settings::validateGaProfileSettings() - Code Metrics - gplcart/ga_report - Measure and Improve Code Quality continuously with Scrutinizer

Settings::validateGaProfileSettings() B
last analyzed 2018-03-10 12:15 UTC

↳ Parent: Settings

Complexity

Conditions	5
Paths	5

Size

Total Lines	26
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	26
rs	8.439
c	0
b	0
f	0
cc	5
eloc	14
nc	5
nop	0

<?php

/**
 * @package Google Analytics Report
 * @author Iurii Makukh <[email protected]>
 * @copyright Copyright (c) 2017, Iurii Makukh <[email protected]>
 * @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
 */

namespace gplcart\modules\ga_report\controllers;

use gplcart\core\controllers\backend\Controller;
use gplcart\modules\ga_report\models\Report;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

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

    /**
     * Google Analytics Report Report model instance
     * @var \gplcart\modules\ga_report\models\Report $report_model
     */
    protected $report_model;

    /**
     * Settings constructor.
     * @param Report $report_model
     */
    public function __construct(Report $report_model)
    {
        parent::__construct();

        $this->report_model = $report_model;
    }

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

        $this->setData('stores', $this->store->getList());
        $this->setData('credentials', $this->getCredentialSettings());
        $this->setData('handlers', $this->report_model->getHandlers());
        $this->setData('settings', $this->module->getSettings('ga_report'));

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

    /**
     * Returns an array of Google API credentials
     * @return array
     */
    protected function getCredentialSettings()
    {
        /** @var \gplcart\modules\gapi\Main $instance */
        $instance = $this->module->getInstance('gapi');
        return $instance->getCredentials(array('type' => 'service'));
    }

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

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

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

        $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('clear_cache')) {
            $this->deleteCacheSettings();
        } else if ($this->isPosted('save') && $this->validateSettings()) {
            $this->updateSettings();
        }
    }

    /**
     * Deletes all Google Analytics cached data
     */
    protected function deleteCacheSettings()
    {
        $this->report_model->clearCache();
        $this->redirect('', $this->text('Cache has been deleted'), 'success');
    }

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

        $this->validateElement('limit', 'regexp', '/^[\d]{1,3}$/');
        $this->validateElement('cache', 'regexp', '/^[\d]{1,8}$/');
        $this->validateElement('credential_id', 'regexp', '/^[\d]{1,10}$/');

        $this->validateGaProfileSettings();

        return !$this->hasErrors();
    }

    /**
     * Validates Google Analytics profiles
     */
    protected function validateGaProfileSettings()
    {
        $profiles = $this->getSubmitted('ga_profile_id', array());

        if (empty($profiles)) {
            $this->setError('ga_profile_id', $this->text('Profile ID is required'));
            return false;
        }

        $stores = $this->store->getList();

        foreach ($profiles as $store_id => $profile_id) {

            if (empty($profile_id)) {
                $this->setError('ga_profile_id', $this->text('Profile ID is required'));
                return false;
            }

            if (empty($stores[$store_id])) {
                $this->setError('ga_profile_id', $this->text('Unknown store ID'));
                return false;
            }
        }

        return true;
    }

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

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

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

}


1			<?php
2
3			/**
4			* @package Google Analytics Report
5			* @author Iurii Makukh <[email protected]>
6			* @copyright Copyright (c) 2017, Iurii Makukh <[email protected]>
7			* @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
8			*/
9
10			namespace gplcart\modules\ga_report\controllers;
11
12			use gplcart\core\controllers\backend\Controller;
13			use gplcart\modules\ga_report\models\Report;
			0 ignored issues – show Bug introduced 2018-02-24 10:15 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `gplcart\modules\ga_report\controllers\Report`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
14
15			/**
16			* Handles incoming requests and outputs data related to Google Analytics Report module
17			*/
18			class Settings extends Controller
19			{
20
21			/**
22			* Google Analytics Report Report model instance
23			* @var \gplcart\modules\ga_report\models\Report $report_model
24			*/
25			protected $report_model;
26
27			/**
28			* Settings constructor.
29			* @param Report $report_model
30			*/
31			public function __construct(Report $report_model)
32			{
33			parent::__construct();
34
35			$this->report_model = $report_model;
36			}
37
38			/**
39			* Route page callback
40			* Displays the module settings page
41			*/
42			public function editSettings()
43			{
44			$this->setTitleEditSettings();
45			$this->setBreadcrumbEditSettings();
46
47			$this->setData('stores', $this->store->getList());
48			$this->setData('credentials', $this->getCredentialSettings());
49			$this->setData('handlers', $this->report_model->getHandlers());
50			$this->setData('settings', $this->module->getSettings('ga_report'));
51
52			$this->submitSettings();
53			$this->outputEditSettings();
54			}
55
56			/**
57			* Returns an array of Google API credentials
58			* @return array
59			*/
60			protected function getCredentialSettings()
61			{
62			/** @var \gplcart\modules\gapi\Main $instance */
63			$instance = $this->module->getInstance('gapi');
64			return $instance->getCredentials(array('type' => 'service'));
65			}
66
67			/**
68			* Set title on the module settings page
69			*/
70			protected function setTitleEditSettings()
71			{
72			$title = $this->text('Edit %name settings', array('%name' => $this->text('Google Analytics Report')));
73			$this->setTitle($title);
74			}
75
76			/**
77			* Set breadcrumbs on the module settings page
78			*/
79			protected function setBreadcrumbEditSettings()
80			{
81			$breadcrumbs = array();
82
83			$breadcrumbs[] = array(
84			'url' => $this->url('admin'),
85			'text' => $this->text('Dashboard')
86			);
87
88			$breadcrumbs[] = array(
89			'text' => $this->text('Modules'),
90			'url' => $this->url('admin/module/list')
91			);
92
93			$this->setBreadcrumbs($breadcrumbs);
94			}
95
96			/**
97			* Saves the submitted settings
98			*/
99			protected function submitSettings()
100			{
101			if ($this->isPosted('clear_cache')) {
102			$this->deleteCacheSettings();
103			} else if ($this->isPosted('save') && $this->validateSettings()) {
104			$this->updateSettings();
105			}
106			}
107
108			/**
109			* Deletes all Google Analytics cached data
110			*/
111			protected function deleteCacheSettings()
112			{
113			$this->report_model->clearCache();
114			$this->redirect('', $this->text('Cache has been deleted'), 'success');
115			}
116
117			/**
118			* Validate submitted module settings
119			*/
120			protected function validateSettings()
121			{
122			$this->setSubmitted('settings');
123
124			$this->validateElement('limit', 'regexp', '/^[\d]{1,3}$/');
125			$this->validateElement('cache', 'regexp', '/^[\d]{1,8}$/');
126			$this->validateElement('credential_id', 'regexp', '/^[\d]{1,10}$/');
127
128			$this->validateGaProfileSettings();
129
130			return !$this->hasErrors();
131			}
132
133			/**
134			* Validates Google Analytics profiles
135			*/
136			protected function validateGaProfileSettings()
137			{
138			$profiles = $this->getSubmitted('ga_profile_id', array());
139
140			if (empty($profiles)) {
141			$this->setError('ga_profile_id', $this->text('Profile ID is required'));
142			return false;
143			}
144
145			$stores = $this->store->getList();
146
147			foreach ($profiles as $store_id => $profile_id) {
148
149			if (empty($profile_id)) {
150			$this->setError('ga_profile_id', $this->text('Profile ID is required'));
151			return false;
152			}
153
154			if (empty($stores[$store_id])) {
155			$this->setError('ga_profile_id', $this->text('Unknown store ID'));
156			return false;
157			}
158			}
159
160			return true;
161			}
162
163			/**
164			* Update module settings
165			*/
166			protected function updateSettings()
167			{
168			$this->controlAccess('module_edit');
169
170			$this->module->setSettings('ga_report', $this->getSubmitted());
171			$this->redirect('', $this->text('Settings have been updated'), 'success');
172			}
173
174			/**
175			* Render and output the module settings page
176			*/
177			protected function outputEditSettings()
178			{
179			$this->output('ga_report\|settings');
180			}
181
182			}
183

gplcart / ga_report

Settings::validateGaProfileSettings() B last analyzed 2018-03-10 12:15 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Settings::validateGaProfileSettings() B
last analyzed 2018-03-10 12:15 UTC