AdjacencyFullTreeDataAction::run() - Code Metrics - Inspection of "Added a lost dependency" - DevGroup-ru/yii2-jstree-widget - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — prerelease ( 30729b...b0ba5c )

unknown

created 2016-07-11 07:19 UTC

AdjacencyFullTreeDataAction::run() C

↳ Parent: AdjacencyFullTreeDataAction

Complexity

Conditions	9
Paths	16

Size

Total Lines	59
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	59
rs	6.9133
cc	9
eloc	33
nc	16
nop	0

How to fix Long Method

<?php

namespace devgroup\JsTreeWidget;

use devgroup\TagDependencyHelper\ActiveRecordHelper;
use Yii;
use yii\base\Action;
use yii\base\InvalidConfigException;
use yii\caching\TagDependency;
use yii\web\Response;

/**
 * Helper action for retrieving tree data for jstree by ajax.
 * Example use in controller:
 *
 * ``` php
 * public function actions()
 * {
 *     return [
 *         'getTree' => [
 *             'class' => AdjacencyFullTreeDataAction::className(),
 *             'class_name' => Category::className(),
 *             'model_label_attribute' => 'name',
 *
 *         ],
 *         'upload' => [
 *             'class' => UploadAction::className(),
 *             'upload' => 'theme/resources/product-images',
 *         ],
 *         'remove' => [
 *             'class' => RemoveAction::className(),
 *             'uploadDir' => 'theme/resources/product-images',
 *         ],
 *         'save-info' => [
 *             'class' => SaveInfoAction::className(),
 *         ],
 *     ];
 * }
 * ```
 */
class AdjacencyFullTreeDataAction extends Action
{

    public $class_name = null;

    public $model_id_attribute = 'id';

    public $model_label_attribute = 'name';

    public $model_parent_attribute = 'parent_id';

    public $vary_by_type_attribute = null;

    public $query_parent_attribute = 'id';

    public $query_sort_order = 'sort_order';

    public $query_selected_attribute = 'selected_id';
    /**
     * Additional conditions for retrieving tree(ie. don't display nodes marked as deleted)
     * @var array
     */
    public $whereCondition = [];

    /**
     * Cache key prefix. Should be unique if you have multiple actions with different $whereCondition
     * @var string
     */
    public $cacheKey = 'FullTree';

    /**
     * Cache lifetime for the full tree
     * @var int
     */
    public $cacheLifeTime = 86400;

    public function init()
    {
        if (!isset($this->class_name)) {
            throw new InvalidConfigException("Model name should be set in controller actions");
        }
        if (!class_exists($this->class_name)) {
            throw new InvalidConfigException("Model class does not exists");
        }
    }

    public function run()
    {
        Yii::$app->response->format = Response::FORMAT_JSON;

        $class = $this->class_name;

        if (null === $current_selected_id = Yii::$app->request->get($this->query_selected_attribute)) {
            $current_selected_id = Yii::$app->request->get($this->query_parent_attribute);
        }

        $cacheKey = "AdjacencyFullTreeData:{$this->cacheKey}:{$class}:{$this->query_sort_order}";

        if (false === $result = Yii::$app->cache->get($cacheKey)) {
            $query = $class::find()
                ->orderBy([$this->query_sort_order => SORT_ASC]);

            if (count($this->whereCondition) > 0) {
                $query = $query->where($this->whereCondition);
            }

            if (null === $rows = $query->asArray()->all()) {
                return [];
            }

            $result = [];

            foreach ($rows as $row) {
                $item = [
                    'id' => $row[$this->model_id_attribute],
                    'parent' => ($row[$this->model_parent_attribute] > 0) ? $row[$this->model_parent_attribute] : '#',
                    'text' => $row[$this->model_label_attribute],
                    'a_attr' => ['data-id'=>$row[$this->model_id_attribute], 'data-parent_id'=>$row[$this->model_parent_attribute]],

                ];

                if (null !== $this->vary_by_type_attribute) {
                    $item['type'] = $row[$this->vary_by_type_attribute];
                }

                $result[$row[$this->model_id_attribute]] = $item;
            }

            Yii::$app->cache->set(
                $cacheKey,
                $result,
                86400,
                new TagDependency([
                    'tags' => [
                        ActiveRecordHelper::getCommonTag($class),
                    ],
                ])
            );
        }

        if (array_key_exists($current_selected_id, $result)) {
            $result[$current_selected_id] = array_merge($result[$current_selected_id], ['state' => ['opened' => true, 'selected' => true]]);

        }

        return array_values($result);
    }
} 


1			<?php
2
3			namespace devgroup\JsTreeWidget;
4
5			use devgroup\TagDependencyHelper\ActiveRecordHelper;
6			use Yii;
7			use yii\base\Action;
8			use yii\base\InvalidConfigException;
9			use yii\caching\TagDependency;
10			use yii\web\Response;
11
12			/**
13			* Helper action for retrieving tree data for jstree by ajax.
14			* Example use in controller:
15			*
16			* ``` php
17			* public function actions()
18			* {
19			* return [
20			* 'getTree' => [
21			* 'class' => AdjacencyFullTreeDataAction::className(),
22			* 'class_name' => Category::className(),
23			* 'model_label_attribute' => 'name',
24			*
25			* ],
26			* 'upload' => [
27			* 'class' => UploadAction::className(),
28			* 'upload' => 'theme/resources/product-images',
29			* ],
30			* 'remove' => [
31			* 'class' => RemoveAction::className(),
32			* 'uploadDir' => 'theme/resources/product-images',
33			* ],
34			* 'save-info' => [
35			* 'class' => SaveInfoAction::className(),
36			* ],
37			* ];
38			* }
39			* ```
40			*/
41			class AdjacencyFullTreeDataAction extends Action
42			{
43
44			public $class_name = null;
45
46			public $model_id_attribute = 'id';
47
48			public $model_label_attribute = 'name';
49
50			public $model_parent_attribute = 'parent_id';
51
52			public $vary_by_type_attribute = null;
53
54			public $query_parent_attribute = 'id';
55
56			public $query_sort_order = 'sort_order';
57
58			public $query_selected_attribute = 'selected_id';
59			/**
60			* Additional conditions for retrieving tree(ie. don't display nodes marked as deleted)
61			* @var array
62			*/
63			public $whereCondition = [];
64
65			/**
66			* Cache key prefix. Should be unique if you have multiple actions with different $whereCondition
67			* @var string
68			*/
69			public $cacheKey = 'FullTree';
70
71			/**
72			* Cache lifetime for the full tree
73			* @var int
74			*/
75			public $cacheLifeTime = 86400;
76
77			public function init()
78			{
79			if (!isset($this->class_name)) {
80			throw new InvalidConfigException("Model name should be set in controller actions");
81			}
82			if (!class_exists($this->class_name)) {
83			throw new InvalidConfigException("Model class does not exists");
84			}
85			}
86
87			public function run()
88			{
89			Yii::$app->response->format = Response::FORMAT_JSON;
90
91			$class = $this->class_name;
92
93			if (null === $current_selected_id = Yii::$app->request->get($this->query_selected_attribute)) {
94			$current_selected_id = Yii::$app->request->get($this->query_parent_attribute);
95			}
96
97			$cacheKey = "AdjacencyFullTreeData:{$this->cacheKey}:{$class}:{$this->query_sort_order}";
98
99			if (false === $result = Yii::$app->cache->get($cacheKey)) {
100			$query = $class::find()
101			->orderBy([$this->query_sort_order => SORT_ASC]);
102
103			if (count($this->whereCondition) > 0) {
104			$query = $query->where($this->whereCondition);
105			}
106
107			if (null === $rows = $query->asArray()->all()) {
108			return [];
109			}
110
111			$result = [];
112
113			foreach ($rows as $row) {
114			$item = [
115			'id' => $row[$this->model_id_attribute],
116			'parent' => ($row[$this->model_parent_attribute] > 0) ? $row[$this->model_parent_attribute] : '#',
117			'text' => $row[$this->model_label_attribute],
118			'a_attr' => ['data-id'=>$row[$this->model_id_attribute], 'data-parent_id'=>$row[$this->model_parent_attribute]],
			0 ignored issues – show Coding Style introduced 2016-07-11 07:14 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 132 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...
119			];
120
121			if (null !== $this->vary_by_type_attribute) {
122			$item['type'] = $row[$this->vary_by_type_attribute];
123			}
124
125			$result[$row[$this->model_id_attribute]] = $item;
126			}
127
128			Yii::$app->cache->set(
129			$cacheKey,
130			$result,
131			86400,
132			new TagDependency([
133			'tags' => [
134			ActiveRecordHelper::getCommonTag($class),
135			],
136			])
137			);
138			}
139
140			if (array_key_exists($current_selected_id, $result)) {
141			$result[$current_selected_id] = array_merge($result[$current_selected_id], ['state' => ['opened' => true, 'selected' => true]]);
			0 ignored issues – show Coding Style introduced 2016-07-11 07:14 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 140 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...
142			}
143
144			return array_values($result);
145			}
146			}
147

DevGroup-ru / yii2-jstree-widget

Push — prerelease ( 30729b...b0ba5c )

AdjacencyFullTreeDataAction::run() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like