Install::installFinish() - Code Metrics - Inspection of "Update" - gplcart/base - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 71cae1...dce477 )

by Iurii

created 2017-12-14 06:28 UTC

Install::installFinish() A

↳ Parent: Install

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	15
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	9
nc	2
nop	2

<?php

/**
 * @package Base
 * @author Iurii Makukh <[email protected]>
 * @copyright Copyright (c) 2015, Iurii Makukh
 * @license https://www.gnu.org/licenses/gpl.html GNU/GPLv3
 */

namespace gplcart\modules\base\handlers;

use gplcart\core\Module;
use gplcart\core\handlers\install\Base as BaseInstaller;
use gplcart\modules\base\models\Install as ModuleModel;

/**
 * Contains methods for installing Base profile
 */
class Install extends BaseInstaller
{

    /**
     * Base module installer model
     * @var \gplcart\modules\base\models\Installer $installer
     */
    protected $model;

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

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

        $this->model = $model;

        $this->module = $module;
    }

    /**
     * Performs initial system installation. Step 0
     * @param array $data
     * @param \gplcart\core\Database $db
     * @return array
     */
    public function install(array $data, $db)
    {
        $this->db = $db;
        $this->data = $data;
        $this->data['step'] = 0;

        if (GC_CLI) {
            return $this->installCli();
        }

        $this->start();
        $result = $this->process();

        if ($result !== true) {
            return $result;
        }

        return array(
            'message' => '',
            'severity' => 'success',
            'redirect' => 'install/' . ($this->data['step'] + 1)
        );
    }

    /**
     * Install in CLI mode
     * @return array
     */
    protected function installCli()
    {
        $result = $this->process();

        if ($result !== true) {
            return $result;
        }

        $result1 = $this->installCliStep1();

        if ($result1['severity'] !== 'success') {
            return $result1;
        }

        $this->installCliStep2();
        return $this->installCliStep3();
    }

    /**
     * Process step 1 in CLI mode
     * @return array
     */
    protected function installCliStep1()
    {
        $this->data['step'] = 1;
        $this->setCliMessage('Configuring modules...');
        return $this->installModules($this->data, $this->db);
    }

    /**
     * Process step 2 in CLI mode
     */
    protected function installCliStep2()
    {
        $title = $this->translation->text('Please select a demo content package (enter a number)');
        $this->data['demo_handler_id'] = $this->cli->menu($this->getDemoOptions(), '', $title);

        if (!empty($this->data['demo_handler_id'])) {

            $this->data['step'] = 2;
            $this->setCliMessage('Installing demo content...');
            $result = $this->installDemo($this->data, $this->db);

            if ($result['severity'] !== 'success') {
                $this->cli->error($result['message']);
            }
        }
    }

    /**
     * Precess step 3 in CLI mode
     * @return array
     */
    protected function installCliStep3()
    {
        $this->data['step'] = 3;
        return $this->installFinish($this->data, $this->db);
    }

    /**
     * Returns an array of demo content options
     * @return array
     */
    protected function getDemoOptions()
    {
        $options = array(
            '' => $this->translation->text('No demo'));

        foreach ($this->model->getDemoHandlers() as $id => $handler) {
            $options[$id] = $handler['title'];
        }

        return $options;
    }

    /**
     * Installs required modules. Step 1
     * @param array $data
     * @param \gplcart\core\Database $db
     * @return array
     */
    public function installModules(array $data, $db)
    {
        $this->db = $db;
        $this->data = $data;

        $result = $this->model->installModules();

        if ($result === true) {

            $this->configureModules();

            return array(
                'message' => '',
                'severity' => 'success',
                'redirect' => 'install/' . ($this->data['step'] + 1)
            );
        }

        $this->setContextError($this->data['step'], $result);

        return array(
            'redirect' => '',
            'severity' => 'danger',
            'message' => $result
        );
    }

    /**
     * Configure module settings
     */
    protected function configureModules()
    {
        $this->configureModuleDevice();
        $this->configureModuleGaReport();
    }

    /**
     * Configure Device module settings
     * @return bool
     */
    protected function configureModuleDevice()
    {
        $store_id = $this->getContext('store_id');

        $settings = array();
        $settings['theme'][$store_id]['mobile'] = 'mobile';
        $settings['theme'][$store_id]['tablet'] = 'mobile';

        return $this->module->setSettings('device', $settings);
    }

    /**
     * Configure Google Analytics Report module settings
     * @return bool
     */
    protected function configureModuleGaReport()
    {
        $info = $this->module->getInfo('ga_report');

        $info['settings']['dashboard'] = array(
            'visit_date',
            'pageview_date',
            'content_statistic',
            'top_pages',
            'source',
            'keyword',
            'audience'
        );

        return $this->module->setSettings('ga_report', $info['settings']);
    }

    /**
     * Install a demo-content. Step 2
     * @param array $data
     * @param \gplcart\core\Database $db
     * @return array
     */
    public function installDemo(array $data, $db)
    {
        set_time_limit(0);

        $this->db = $db;
        $this->data = $data;

        $success_result = array(
            'message' => '',
            'severity' => 'success',
            'redirect' => 'install/' . ($this->data['step'] + 1)
        );

        if (empty($data['demo_handler_id'])) {
            return $success_result;
        }

        $result = $this->model->getDemoModule()->create($this->getContext('store_id'), $data['demo_handler_id']);

        if ($result !== true) {
            $this->setContextError($this->data['step'], $result);
        }

        return $success_result;
    }

    /**
     * Performs final tasks. Step 3
     * @param array $data
     * @param \gplcart\core\Database $db
     * @return array
     */
    public function installFinish(array $data, $db)
    {
        $this->db = $db;
        $this->data = $data;

        $result = $this->finish();
        $errors = $this->getContextErrors();

        if (!empty($errors)) {
            $result['message'] = $errors;
            $result['severity'] = 'warning';
        }

        return $result;
    }

}


1			<?php
2
3			/**
4			* @package Base
5			* @author Iurii Makukh <[email protected]>
6			* @copyright Copyright (c) 2015, Iurii Makukh
7			* @license https://www.gnu.org/licenses/gpl.html GNU/GPLv3
8			*/
9
10			namespace gplcart\modules\base\handlers;
11
12			use gplcart\core\Module;
13			use gplcart\core\handlers\install\Base as BaseInstaller;
14			use gplcart\modules\base\models\Install as ModuleModel;
15
16			/**
17			* Contains methods for installing Base profile
18			*/
19			class Install extends BaseInstaller
20			{
21
22			/**
23			* Base module installer model
24			* @var \gplcart\modules\base\models\Installer $installer
25			*/
26			protected $model;
27
28			/**
29			* Module class instance
30			* @var \gplcart\core\Module $module
31			*/
32			protected $module;
33
34			/**
35			* @param Module $module
36			* @param ModuleModel $model
37			*/
38			public function __construct(Module $module, ModuleModel $model)
39			{
40			parent::__construct();
41
42			$this->model = $model;
			0 ignored issues – show Documentation Bug introduced 2017-12-14 06:29 UTC by Report Bug Copy Issue Report It seems like `$model` of type `object<gplcart\modules\base\models\Install>` is incompatible with the declared type `object<gplcart\modules\base\models\Installer>` of property `$model`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
43			$this->module = $module;
44			}
45
46			/**
47			* Performs initial system installation. Step 0
48			* @param array $data
49			* @param \gplcart\core\Database $db
50			* @return array
51			*/
52			public function install(array $data, $db)
53			{
54			$this->db = $db;
55			$this->data = $data;
56			$this->data['step'] = 0;
57
58			if (GC_CLI) {
59			return $this->installCli();
60			}
61
62			$this->start();
63			$result = $this->process();
64
65			if ($result !== true) {
66			return $result;
67			}
68
69			return array(
70			'message' => '',
71			'severity' => 'success',
72			'redirect' => 'install/' . ($this->data['step'] + 1)
73			);
74			}
75
76			/**
77			* Install in CLI mode
78			* @return array
79			*/
80			protected function installCli()
81			{
82			$result = $this->process();
83
84			if ($result !== true) {
85			return $result;
86			}
87
88			$result1 = $this->installCliStep1();
89
90			if ($result1['severity'] !== 'success') {
91			return $result1;
92			}
93
94			$this->installCliStep2();
95			return $this->installCliStep3();
96			}
97
98			/**
99			* Process step 1 in CLI mode
100			* @return array
101			*/
102			protected function installCliStep1()
103			{
104			$this->data['step'] = 1;
105			$this->setCliMessage('Configuring modules...');
106			return $this->installModules($this->data, $this->db);
107			}
108
109			/**
110			* Process step 2 in CLI mode
111			*/
112			protected function installCliStep2()
113			{
114			$title = $this->translation->text('Please select a demo content package (enter a number)');
115			$this->data['demo_handler_id'] = $this->cli->menu($this->getDemoOptions(), '', $title);
116
117			if (!empty($this->data['demo_handler_id'])) {
118
119			$this->data['step'] = 2;
120			$this->setCliMessage('Installing demo content...');
121			$result = $this->installDemo($this->data, $this->db);
122
123			if ($result['severity'] !== 'success') {
124			$this->cli->error($result['message']);
125			}
126			}
127			}
128
129			/**
130			* Precess step 3 in CLI mode
131			* @return array
132			*/
133			protected function installCliStep3()
134			{
135			$this->data['step'] = 3;
136			return $this->installFinish($this->data, $this->db);
137			}
138
139			/**
140			* Returns an array of demo content options
141			* @return array
142			*/
143			protected function getDemoOptions()
144			{
145			$options = array(
146			'' => $this->translation->text('No demo'));
147
148			foreach ($this->model->getDemoHandlers() as $id => $handler) {
149			$options[$id] = $handler['title'];
150			}
151
152			return $options;
153			}
154
155			/**
156			* Installs required modules. Step 1
157			* @param array $data
158			* @param \gplcart\core\Database $db
159			* @return array
160			*/
161			public function installModules(array $data, $db)
162			{
163			$this->db = $db;
164			$this->data = $data;
165
166			$result = $this->model->installModules();
167
168			if ($result === true) {
169
170			$this->configureModules();
171
172			return array(
173			'message' => '',
174			'severity' => 'success',
175			'redirect' => 'install/' . ($this->data['step'] + 1)
176			);
177			}
178
179			$this->setContextError($this->data['step'], $result);
180
181			return array(
182			'redirect' => '',
183			'severity' => 'danger',
184			'message' => $result
185			);
186			}
187
188			/**
189			* Configure module settings
190			*/
191			protected function configureModules()
192			{
193			$this->configureModuleDevice();
194			$this->configureModuleGaReport();
195			}
196
197			/**
198			* Configure Device module settings
199			* @return bool
200			*/
201			protected function configureModuleDevice()
202			{
203			$store_id = $this->getContext('store_id');
204
205			$settings = array();
206			$settings['theme'][$store_id]['mobile'] = 'mobile';
207			$settings['theme'][$store_id]['tablet'] = 'mobile';
208
209			return $this->module->setSettings('device', $settings);
210			}
211
212			/**
213			* Configure Google Analytics Report module settings
214			* @return bool
215			*/
216			protected function configureModuleGaReport()
217			{
218			$info = $this->module->getInfo('ga_report');
219
220			$info['settings']['dashboard'] = array(
221			'visit_date',
222			'pageview_date',
223			'content_statistic',
224			'top_pages',
225			'source',
226			'keyword',
227			'audience'
228			);
229
230			return $this->module->setSettings('ga_report', $info['settings']);
231			}
232
233			/**
234			* Install a demo-content. Step 2
235			* @param array $data
236			* @param \gplcart\core\Database $db
237			* @return array
238			*/
239			public function installDemo(array $data, $db)
240			{
241			set_time_limit(0);
242
243			$this->db = $db;
244			$this->data = $data;
245
246			$success_result = array(
247			'message' => '',
248			'severity' => 'success',
249			'redirect' => 'install/' . ($this->data['step'] + 1)
250			);
251
252			if (empty($data['demo_handler_id'])) {
253			return $success_result;
254			}
255
256			$result = $this->model->getDemoModule()->create($this->getContext('store_id'), $data['demo_handler_id']);
257
258			if ($result !== true) {
259			$this->setContextError($this->data['step'], $result);
260			}
261
262			return $success_result;
263			}
264
265			/**
266			* Performs final tasks. Step 3
267			* @param array $data
268			* @param \gplcart\core\Database $db
269			* @return array
270			*/
271			public function installFinish(array $data, $db)
272			{
273			$this->db = $db;
274			$this->data = $data;
275
276			$result = $this->finish();
277			$errors = $this->getContextErrors();
278
279			if (!empty($errors)) {
280			$result['message'] = $errors;
281			$result['severity'] = 'warning';
282			}
283
284			return $result;
285			}
286
287			}
288

gplcart / base

Push — master ( 71cae1...dce477 )

Install::installFinish() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like