ShopModule - Code Metrics - Inspection of "Introduce FloatPanelModule (#326)" - DevGroup-ru/dotplant2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d3bfca...80f711 )

by Alexander

created 2016-06-15 11:25 UTC

ShopModule A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	275
Duplicated Lines	5.09 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes	4
Bugs	0	Features	1

Metric	Value
wmc	15
lcom	2
cbo	2
dl	14
loc	275
rs	10
c	4
b	0
f	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	behaviors()	0	10	1
A	bootstrap()	0	20	1
A	init()	0	7	2
A	getBackendGrids()	0	15	1
C	attachEventsHandlers()	14	71	10

How to fix Duplicated Code

<?php

namespace app\modules\shop;

use app;
use app\backend\BackendModule;
use app\components\BaseModule;
use app\modules\shop\handlers\UserHandler;
use app\modules\shop\models\ConfigConfigurationModel;
use kartik\icons\Icon;
use Yii;
use yii\base\Application;
use yii\base\BootstrapInterface;
use yii\base\Event;
use yii\web\User;

/**
 * Shop module is the base core module of DotPlant2 CMS handling all common e-commerce features
 * @package app\modules\shop
 */
class ShopModule extends BaseModule implements BootstrapInterface, app\modules\event\interfaces\EventInterface
{
    const BACKEND_PRODUCT_GRID = 'productEditGrid';
    const BACKEND_CATEGORY_GRID = 'categoryEditGrid';

    /**
     * @inheritdoc
     */
    public $controllerMap = [
        'backend-filter-sets' => 'app\modules\shop\backend\FilterSetsController',
        'backend-addons' => 'app\modules\shop\backend\AddonsController',
    ];

    /**
     * @var int How much products per page to show
     */
    public $productsPerPage = 15;

    /**
     * @var string How show products in category
     */
    public $listViewType = 'blockView';
    /**
     * @var int How much products allow to compare at once
     */
    public $maxProductsToCompare = 3;

    /**
     * @var bool Should we show and query for products of subcategories
     */
    public $showProductsOfChildCategories = 1;

    /**
     * @var int How much products to show on search results page
     */
    public $searchResultsLimit = 9;

    /**
     * @var boolean Possible to search generated products
     */
    public $allowSearchGeneratedProducts = 0;

    /***
     * @var bool registration Guest User In Cart as new user and send data on e-mail
     */
    public $registrationGuestUserInCart = 0;

    /**
     * @var bool Show delete order in backend
     */
    public $deleteOrdersAbility = 0;

    /**
     * @var bool Filtration works only on parent products but not their children
     */
    public $filterOnlyByParentProduct = true;

    /**
     * @var string Filtration mode
     */
    public $multiFilterMode = ConfigConfigurationModel::MULTI_FILTER_MODE_INTERSECTION;

    /**
     * @var int How much last viewed products ID's to store in session
     */
    public $maxLastViewedProducts = 9;

    /**
     * @var bool Allow to add same product in the order
     */
    public $allowToAddSameProduct = 0;

    /**
     * @var bool Count only unique products in the order
     */
    public $countUniqueProductsOnly = 1;

    /**
     * @var bool Count children products in the order
     */
    public $countChildrenProducts = 1;

    /**
     * @var int Default measure ID
     */
    public $defaultMeasureId = 1;

    /**
     * @var int Final order stage leaf
     */
    public $finalOrderStageLeaf = 0;

    /**
     * @var int Default filter for Orders by stage in backend
     */
    public $defaultOrderStageFilterBackend = 0;

    /**
     * @var int
     */
    public $showDeletedOrders = 0;

    /**
     * @var array
     */
    public $ymlConfig = [];

    /**
     * @var array
     */
    public $googleFeedConfig = [];


    /**
     * @var bool Show filter links in breadcrumbs
     */
    public $showFiltersInBreadcrumbs = false;

    /**
     * @var bool Use method ceilQuantity of Measure model
     */
    public $useCeilQuantity = true;

    /**
     * @var string View file for render product item content block
     */
    public $itemView = '@app/modules/shop/views/product/item-row';

    /**
     * @var string View file for render product list content block
     */
    public $listView = '@app/modules/shop/views/product/item-list';

    /**
     * @inheritdoc
     */
    public function behaviors()
    {
        return [
            'configurableModule' => [
                'class' => 'app\modules\config\behaviors\ConfigurableModuleBehavior',
                'configurationView' => '@app/modules/shop/views/configurable/_config',
                'configurableModel' => 'app\modules\shop\models\ConfigConfigurationModel',
            ]
        ];
    }

    /**
     * Bootstrap method to be called during application bootstrap stage.
     * @param Application $app the application currently running
     */
    public function bootstrap($app)
    {
        /**
         * Move orders/order params from guest to logged/signed user
         */
        Event::on(
            User::className(),
            User::EVENT_AFTER_LOGIN,
            [UserHandler::className(), 'moveOrdersGuestToRegistered']
        );

        /**
         * Move wishlists/wishlist params from guest to logged/signed user
         */
        Event::on(
            User::className(),
            User::EVENT_AFTER_LOGIN,
            [UserHandler::className(), 'moveWishlistsGuestToRegistered']
        );
    }

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();
        if (Yii::$app instanceof \yii\console\Application) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $this->controllerMap = [];
        }
    }

    /** @inheritdoc */
    public function getBackendGrids()
    {
        return [
            [
                'defaultValue' => BackendModule::BACKEND_GRID_ONE_TO_ONE,
                'key' => self::BACKEND_PRODUCT_GRID,
                'label' => Yii::t('app', 'Product edit'),
            ],
            [
                'defaultValue' => BackendModule::BACKEND_GRID_ONE_TO_ONE,
                'key' => self::BACKEND_CATEGORY_GRID,
                'label' => Yii::t('app', 'Category edit'),
            ],
        ];
    }

    /**
     * @return void
     */
    public static function attachEventsHandlers()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        Event::on(
            app\modules\floatPanel\widgets\FloatingPanel::class,
            app\modules\floatPanel\widgets\FloatingPanel::EVENT_BEFORE_RENDER,
            function ($event) {
                switch (Yii::$app->requestedRoute) {
                    case 'shop/product/list':
                        if (isset($_GET['properties'])) {
                            $apply_if_params = [];
                            foreach ($_GET['properties'] as $property_id => $values) {
                                if (isset($values[0])) {
                                    $apply_if_params[$property_id] = $values[0];
                                }
                            }
                            if (Yii::$app->response->dynamic_content_trait === true) {
                                $event->items[] = [
                                    'label' => Icon::show('puzzle') . ' ' . Yii::t('app', 'Edit Dynamic Content'),
                                    'url' => [
                                        '/backend/dynamic-content/edit',
                                        'id' => Yii::$app->response->matched_dynamic_content_trait_model->id,
                                    ],
                                ];
                            } else {
                                if (isset($_GET['properties'], $_GET['last_category_id'])) {
                                    $event->items[] = [
                                        'label' => Icon::show('puzzle') . ' ' . Yii::t('app', 'Add Dynamic Content'),
                                        'url' => [
                                            '/backend/dynamic-content/edit',
                                            'DynamicContent' => [
                                                'apply_if_params' => Json::encode($apply_if_params),
                                                'apply_if_last_category_id' => $_GET['last_category_id'],
                                                'object_id' => Object::getForClass(app\modules\shop\models\Product::className())->id,

                                                'route' => 'shop/product/list',
                                            ]
                                        ],
                                    ];

                                }

                            }
                        } else {
                            // no properties selected - go to category edit page
                            if (isset($_GET['last_category_id'])) {
                                $cat = app\modules\shop\models\Category::findById($_GET['last_category_id']);
                                $event->items[] = [
                                    'label' => Icon::show('pencil') . ' ' . Yii::t('app', 'Edit category'),
                                    'url' => [
                                        '/shop/backend-category/edit',
                                        'id' => $cat->id,
                                        'parent_id' => $cat->parent_id,
                                    ],
                                ];
                            }
                        }
                        break;
                    case 'shop/product/show':
                        if (isset($_GET['model_id'])) {
                            $event->items[] = [
                                'label' => Icon::show('pencil') . ' ' . Yii::t('app', 'Edit product'),
                                'url' => [
                                    '/shop/backend-product/edit',
                                    'id' => intval($_GET['model_id'])
                                ],
                            ];
                        }
                        break;
                }
            }
        );
    }
}


GitHub Access Token became invalid

Push — master ( d3bfca...80f711 )

ShopModule A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

1. Missing dependencies

2. Missing use statement

1		<?php
2
3		namespace app\modules\shop;
4
5		use app;
6		use app\backend\BackendModule;
7		use app\components\BaseModule;
8		use app\modules\shop\handlers\UserHandler;
9		use app\modules\shop\models\ConfigConfigurationModel;
10		use kartik\icons\Icon;
11		use Yii;
12		use yii\base\Application;
13		use yii\base\BootstrapInterface;
14		use yii\base\Event;
15		use yii\web\User;
16
17		/**
18		* Shop module is the base core module of DotPlant2 CMS handling all common e-commerce features
19		* @package app\modules\shop
20		*/
21		class ShopModule extends BaseModule implements BootstrapInterface, app\modules\event\interfaces\EventInterface
22		{
23		const BACKEND_PRODUCT_GRID = 'productEditGrid';
24		const BACKEND_CATEGORY_GRID = 'categoryEditGrid';
25
26		/**
27		* @inheritdoc
28		*/
29		public $controllerMap = [
30		'backend-filter-sets' => 'app\modules\shop\backend\FilterSetsController',
31		'backend-addons' => 'app\modules\shop\backend\AddonsController',
32		];
33
34		/**
35		* @var int How much products per page to show
36		*/
37		public $productsPerPage = 15;
38
39		/**
40		* @var string How show products in category
41		*/
42		public $listViewType = 'blockView';
43		/**
44		* @var int How much products allow to compare at once
45		*/
46		public $maxProductsToCompare = 3;
47
48		/**
49		* @var bool Should we show and query for products of subcategories
50		*/
51		public $showProductsOfChildCategories = 1;
52
53		/**
54		* @var int How much products to show on search results page
55		*/
56		public $searchResultsLimit = 9;
57
58		/**
59		* @var boolean Possible to search generated products
60		*/
61		public $allowSearchGeneratedProducts = 0;
62
63		/***
64		* @var bool registration Guest User In Cart as new user and send data on e-mail
65		*/
66		public $registrationGuestUserInCart = 0;
67
68		/**
69		* @var bool Show delete order in backend
70		*/
71		public $deleteOrdersAbility = 0;
72
73		/**
74		* @var bool Filtration works only on parent products but not their children
75		*/
76		public $filterOnlyByParentProduct = true;
77
78		/**
79		* @var string Filtration mode
80		*/
81		public $multiFilterMode = ConfigConfigurationModel::MULTI_FILTER_MODE_INTERSECTION;
82
83		/**
84		* @var int How much last viewed products ID's to store in session
85		*/
86		public $maxLastViewedProducts = 9;
87
88		/**
89		* @var bool Allow to add same product in the order
90		*/
91		public $allowToAddSameProduct = 0;
92
93		/**
94		* @var bool Count only unique products in the order
95		*/
96		public $countUniqueProductsOnly = 1;
97
98		/**
99		* @var bool Count children products in the order
100		*/
101		public $countChildrenProducts = 1;
102
103		/**
104		* @var int Default measure ID
105		*/
106		public $defaultMeasureId = 1;
107
108		/**
109		* @var int Final order stage leaf
110		*/
111		public $finalOrderStageLeaf = 0;
112
113		/**
114		* @var int Default filter for Orders by stage in backend
115		*/
116		public $defaultOrderStageFilterBackend = 0;
117
118		/**
119		* @var int
120		*/
121		public $showDeletedOrders = 0;
122
123		/**
124		* @var array
125		*/
126		public $ymlConfig = [];
127
128		/**
129		* @var array
130		*/
131		public $googleFeedConfig = [];
132
133
134		/**
135		* @var bool Show filter links in breadcrumbs
136		*/
137		public $showFiltersInBreadcrumbs = false;
138
139		/**
140		* @var bool Use method ceilQuantity of Measure model
141		*/
142		public $useCeilQuantity = true;
143
144		/**
145		* @var string View file for render product item content block
146		*/
147		public $itemView = '@app/modules/shop/views/product/item-row';
148
149		/**
150		* @var string View file for render product list content block
151		*/
152		public $listView = '@app/modules/shop/views/product/item-list';
153
154		/**
155		* @inheritdoc
156		*/
157		public function behaviors()
158		{
159		return [
160		'configurableModule' => [
161		'class' => 'app\modules\config\behaviors\ConfigurableModuleBehavior',
162		'configurationView' => '@app/modules/shop/views/configurable/_config',
163		'configurableModel' => 'app\modules\shop\models\ConfigConfigurationModel',
164		]
165		];
166		}
167
168		/**
169		* Bootstrap method to be called during application bootstrap stage.
170		* @param Application $app the application currently running
171		*/
172		public function bootstrap($app)
173		{
174		/**
175		* Move orders/order params from guest to logged/signed user
176		*/
177		Event::on(
178		User::className(),
179		User::EVENT_AFTER_LOGIN,
180		[UserHandler::className(), 'moveOrdersGuestToRegistered']
181		);
182
183		/**
184		* Move wishlists/wishlist params from guest to logged/signed user
185		*/
186		Event::on(
187		User::className(),
188		User::EVENT_AFTER_LOGIN,
189		[UserHandler::className(), 'moveWishlistsGuestToRegistered']
190		);
191		}
192
193		/**
194		* @inheritdoc
195		*/
196		public function init()
197		{
198		parent::init();
199		if (Yii::$app instanceof \yii\console\Application) {
		0 ignored issues – show Bug introduced 2015-12-02 18:30 UTC by Report Bug Copy Issue Report The class `yii\console\Application` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
200		$this->controllerMap = [];
201		}
202		}
203
204		/** @inheritdoc */
205		public function getBackendGrids()
206		{
207		return [
208		[
209		'defaultValue' => BackendModule::BACKEND_GRID_ONE_TO_ONE,
210		'key' => self::BACKEND_PRODUCT_GRID,
211		'label' => Yii::t('app', 'Product edit'),
212		],
213		[
214		'defaultValue' => BackendModule::BACKEND_GRID_ONE_TO_ONE,
215		'key' => self::BACKEND_CATEGORY_GRID,
216		'label' => Yii::t('app', 'Category edit'),
217		],
218		];
219		}
220
221		/**
222		* @return void
223		*/
224		public static function attachEventsHandlers()
		0 ignored issues – show Coding Style introduced 2016-05-29 11:01 UTC by Report Bug Copy Issue Report `attachEventsHandlers` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
225		{
226		Event::on(
227		app\modules\floatPanel\widgets\FloatingPanel::class,
228		app\modules\floatPanel\widgets\FloatingPanel::EVENT_BEFORE_RENDER,
229		function ($event) {
230		switch (Yii::$app->requestedRoute) {
231		case 'shop/product/list':
232		if (isset($_GET['properties'])) {
233		$apply_if_params = [];
234		foreach ($_GET['properties'] as $property_id => $values) {
235		if (isset($values[0])) {
236		$apply_if_params[$property_id] = $values[0];
237		}
238		}
239		if (Yii::$app->response->dynamic_content_trait === true) {
240		$event->items[] = [
241		'label' => Icon::show('puzzle') . ' ' . Yii::t('app', 'Edit Dynamic Content'),
242		'url' => [
243		'/backend/dynamic-content/edit',
244		'id' => Yii::$app->response->matched_dynamic_content_trait_model->id,
245		],
246		];
247		} else {
248		if (isset($_GET['properties'], $_GET['last_category_id'])) {
249		$event->items[] = [
250		'label' => Icon::show('puzzle') . ' ' . Yii::t('app', 'Add Dynamic Content'),
251		'url' => [
252		'/backend/dynamic-content/edit',
253		'DynamicContent' => [
254		'apply_if_params' => Json::encode($apply_if_params),
255		'apply_if_last_category_id' => $_GET['last_category_id'],
256		'object_id' => Object::getForClass(app\modules\shop\models\Product::className())->id,
		0 ignored issues – show Coding Style introduced 2016-05-29 11:01 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 133 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
257		'route' => 'shop/product/list',
258		]
259		],
260		];
261
262		}
263
264		}
265	View Code Duplication	} else {
266		// no properties selected - go to category edit page
267		if (isset($_GET['last_category_id'])) {
268		$cat = app\modules\shop\models\Category::findById($_GET['last_category_id']);
269		$event->items[] = [
270		'label' => Icon::show('pencil') . ' ' . Yii::t('app', 'Edit category'),
271		'url' => [
272		'/shop/backend-category/edit',
273		'id' => $cat->id,
274		'parent_id' => $cat->parent_id,
275		],
276		];
277		}
278		}
279		break;
280		case 'shop/product/show':
281		if (isset($_GET['model_id'])) {
282		$event->items[] = [
283		'label' => Icon::show('pencil') . ' ' . Yii::t('app', 'Edit product'),
284		'url' => [
285		'/shop/backend-product/edit',
286		'id' => intval($_GET['model_id'])
287		],
288		];
289		}
290		break;
291		}
292		}
293		);
294		}
295		}
296

DevGroup-ru / dotplant2

GitHub Access Token became invalid

Push — master ( d3bfca...80f711 )

ShopModule A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like