TreeWidget::nestedSetJs() - Code Metrics - Inspection of "WIP NestedSet" - DevGroup-ru/yii2-jstree-widget - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — dev ( 61c8f1...460265 )

unknown

created 2016-06-08 06:19 UTC

TreeWidget::nestedSetJs() B

↳ Parent: TreeWidget

Complexity

Conditions	5
Paths	5

Size

Total Lines	28
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	28
rs	8.439
cc	5
eloc	9
nc	5
nop	0

<?php

namespace devgroup\JsTreeWidget\widgets;

use Yii;
use yii\base\InvalidConfigException;
use yii\base\Widget;
use yii\helpers\Html;
use yii\helpers\Json;
use yii\helpers\Url;
use yii\web\JsExpression;
use yii\helpers\ArrayHelper;
use yii\web\View;

/**
 * JsTree widget for Yii Framework 2
 */
class TreeWidget extends Widget
{

    const TREE_TYPE_ADJACENCY = 'adjacency';
    const TREE_TYPE_NESTED_SET = 'nested-set';

    public $treeType = self::TREE_TYPE_ADJACENCY;
    /**
     * @var array Enabled jsTree plugins
     * @see http://www.jstree.com/plugins/
     */
    public $plugins = [
        'wholerow',
        'contextmenu',
        'dnd',
        'types',
        'state',
    ];

    /**
     * @var array Configuration for types plugin
     * @see http://www.jstree.com/api/#/?f=$.jstree.defaults.types
     */
    public $types = [
        'show' => [
            'icon' => 'fa fa-file-o',
        ],
        'list' => [
            'icon' => 'fa fa-list',
        ],
    ];

    /**
     * Context menu actions configuration.
     * @var array
     */
    public $contextMenuItems = [];

    /**
     * Various options for jsTree plugin. Will be merged with default options.
     * @var array
     */
    public $options = [];

    /**
     * Route to action which returns json data for tree
     * @var array
     */
    public $treeDataRoute = null;

    /**
     * Translation category for Yii::t() which will be applied to labels.
     * If translation is not needed - use false.
     */
    public $menuLabelsTranslationCategory = 'app';

    /**
     * JsExpression for action(callback function) on double click. You can use JsExpression or make custom expression.
     * Warning! Callback function differs from native jsTree function - it consumes only one attribute - node(similar to contextmenu action).

     * Use false if no action needed.
     * @var bool|JsExpression
     */
    public $doubleClickAction = false;

    public $changeParentAction = false;

    public $reorderAction = false;

    public function run()
    {
        if (!is_array($this->treeDataRoute)) {
            throw new InvalidConfigException("Attribute treeDataRoute is required to use TreeWidget.");
        }

        $options = [
            'plugins' => $this->plugins,
            'core' => [
                'check_callback' => true,
                'data' => [
                    'url' => new JsExpression(
                        "function (node) {
                            return " . Json::encode(Url::to($this->treeDataRoute)) . ";
                        }"
                    ),
                    'data' => new JsExpression(
                        "function (node) {
                        return { 'id' : node.id };
                        }"
                    ),
                ]
            ]
        ];

        // merge with contextmenu configuration
        $options = ArrayHelper::merge($options, $this->contextMenuOptions());

        // merge with attribute-provided options
        $options = ArrayHelper::merge($options, $this->options);

        $options = Json::encode($options);

        $this->getView()->registerAssetBundle('devgroup\JsTreeWidget\widgets\JsTreeAssetBundle');

        $doubleClick = '';
        if ($this->doubleClickAction !== false) {
            $doubleClick = "
            jsTree_{$this->getId()}.on('dblclick.jstree', function (e) {
                var node = $(e.target).closest('.jstree-node').children('.jstree-anchor');
                var callback = " . $this->doubleClickAction . ";
                callback(node);
                return false;
            });\n";
        }
        $treeJs = $this->prepareJs();
        $this->getView()->registerJs("
        var jsTree_{$this->getId()} = \$('#{$this->getId()}').jstree($options);
        $doubleClick $treeJs", View::POS_READY);
        return Html::tag('div', '', ['id' => $this->getId()]);
    }

    private function contextMenuOptions()
    {
        $options = [];
        if (count($this->contextMenuItems) > 0) {
            if (!in_array('contextmenu', $this->plugins)) {
                // add missing contextmenu plugin
                $options['plugins'] = ['contextmenu'];
            }

            $options['contextmenu']['items'] = [];
            foreach ($this->contextMenuItems as $index => $item) {
                if ($this->menuLabelsTranslationCategory !== false) {
                    $item['label'] = Yii::t($this->menuLabelsTranslationCategory, $item['label']);
                }
                $options['contextmenu']['items'][$index] = $item;
            }
        }
        return $options;
    }

    private function prepareJs()
    {
        switch ($this->treeType) {
            case self::TREE_TYPE_ADJACENCY :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
                return $this->adjacecncyJs();
            case self::TREE_TYPE_NESTED_SET :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
                return $this->nestedSetJs();
        }
    }

    private function adjacecncyJs()
    {
        $changeParent = '';
        if ($this->changeParentAction !== false) {
            $changeParentUrl = is_array($this->changeParentAction) ? Url::to($this->changeParentAction) : $this->changeParentAction;

            $changeParent = "
             jsTree_{$this->getId()}.bind('move_node.jstree', function(e, data) {
                jQuery.get(
                    '" . $changeParentUrl . "',
                    {
                        'id': data.node.id,
                        'parent_id': data.parent
                    }
                );
                return false;
            });\n";
        }
        $reorder = '';
        if ($this->reorderAction !== false) {
            $reorderUrl = is_array($this->reorderAction) ? Url::to($this->reorderAction) : $this->reorderAction;
            $reorder = "
             jsTree_{$this->getId()}.bind('move_node.jstree', function(e, data) {
             var params = [];
                 jQuery('.jstree-node').each(function(i, e) {
                    params[e.id] = i;
                 });
                  jQuery.post(
                    '" . $reorderUrl . "',
                    {'order':params }
                );
                return false;
            });\n";
        }
        return $changeParent . $reorder;
    }

    private function nestedSetJs()
    {
        $js = "";
        if (false !== $this->reorderAction || false !== $this->changeParentAction) {
            $action = $this->reorderAction ?: $this->changeParentAction;
            $url = is_array($action) ? Url::to($action) : $action;
            $js = new JsExpression(
                "jsTree_{$this->getId()}.on('move_node.jstree', function(e, data) {
                    \$parent = $(this).jstree(true).get_node(data.parent);
                    siblings = \$parent.children || {};
                    $.post(
                        '{$url}',
                         {
                            'node_id' : data.node.id,
                            'parent': data.parent,
                            'position': data.position,
                            'old_parent': data.old_parent,
                            'old_position': data.old_position,
                            'is_multi': data.is_multi,
                            'siblings': siblings
                         }
                    );
                    return false;
                });\n"
            );
        }
        return $js;
    }
}


1			<?php
2
3			namespace devgroup\JsTreeWidget\widgets;
4
5			use Yii;
6			use yii\base\InvalidConfigException;
7			use yii\base\Widget;
8			use yii\helpers\Html;
9			use yii\helpers\Json;
10			use yii\helpers\Url;
11			use yii\web\JsExpression;
12			use yii\helpers\ArrayHelper;
13			use yii\web\View;
14
15			/**
16			* JsTree widget for Yii Framework 2
17			*/
18			class TreeWidget extends Widget
19			{
20
21			const TREE_TYPE_ADJACENCY = 'adjacency';
22			const TREE_TYPE_NESTED_SET = 'nested-set';
23
24			public $treeType = self::TREE_TYPE_ADJACENCY;
25			/**
26			* @var array Enabled jsTree plugins
27			* @see http://www.jstree.com/plugins/
28			*/
29			public $plugins = [
30			'wholerow',
31			'contextmenu',
32			'dnd',
33			'types',
34			'state',
35			];
36
37			/**
38			* @var array Configuration for types plugin
39			* @see http://www.jstree.com/api/#/?f=$.jstree.defaults.types
40			*/
41			public $types = [
42			'show' => [
43			'icon' => 'fa fa-file-o',
44			],
45			'list' => [
46			'icon' => 'fa fa-list',
47			],
48			];
49
50			/**
51			* Context menu actions configuration.
52			* @var array
53			*/
54			public $contextMenuItems = [];
55
56			/**
57			* Various options for jsTree plugin. Will be merged with default options.
58			* @var array
59			*/
60			public $options = [];
61
62			/**
63			* Route to action which returns json data for tree
64			* @var array
65			*/
66			public $treeDataRoute = null;
67
68			/**
69			* Translation category for Yii::t() which will be applied to labels.
70			* If translation is not needed - use false.
71			*/
72			public $menuLabelsTranslationCategory = 'app';
73
74			/**
75			* JsExpression for action(callback function) on double click. You can use JsExpression or make custom expression.
76			* Warning! Callback function differs from native jsTree function - it consumes only one attribute - node(similar to contextmenu action).
			0 ignored issues – show Coding Style introduced 2016-06-01 08:48 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 141 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...
77			* Use false if no action needed.
78			* @var bool\|JsExpression
79			*/
80			public $doubleClickAction = false;
81
82			public $changeParentAction = false;
83
84			public $reorderAction = false;
85
86			public function run()
87			{
88			if (!is_array($this->treeDataRoute)) {
89			throw new InvalidConfigException("Attribute treeDataRoute is required to use TreeWidget.");
90			}
91
92			$options = [
93			'plugins' => $this->plugins,
94			'core' => [
95			'check_callback' => true,
96			'data' => [
97			'url' => new JsExpression(
98			"function (node) {
99			return " . Json::encode(Url::to($this->treeDataRoute)) . ";
100			}"
101			),
102			'data' => new JsExpression(
103			"function (node) {
104			return { 'id' : node.id };
105			}"
106			),
107			]
108			]
109			];
110
111			// merge with contextmenu configuration
112			$options = ArrayHelper::merge($options, $this->contextMenuOptions());
113
114			// merge with attribute-provided options
115			$options = ArrayHelper::merge($options, $this->options);
116
117			$options = Json::encode($options);
118
119			$this->getView()->registerAssetBundle('devgroup\JsTreeWidget\widgets\JsTreeAssetBundle');
120
121			$doubleClick = '';
122			if ($this->doubleClickAction !== false) {
123			$doubleClick = "
124			jsTree_{$this->getId()}.on('dblclick.jstree', function (e) {
125			var node = $(e.target).closest('.jstree-node').children('.jstree-anchor');
126			var callback = " . $this->doubleClickAction . ";
127			callback(node);
128			return false;
129			});\n";
130			}
131			$treeJs = $this->prepareJs();
132			$this->getView()->registerJs("
133			var jsTree_{$this->getId()} = \$('#{$this->getId()}').jstree($options);
134			$doubleClick $treeJs", View::POS_READY);
135			return Html::tag('div', '', ['id' => $this->getId()]);
136			}
137
138			private function contextMenuOptions()
139			{
140			$options = [];
141			if (count($this->contextMenuItems) > 0) {
142			if (!in_array('contextmenu', $this->plugins)) {
143			// add missing contextmenu plugin
144			$options['plugins'] = ['contextmenu'];
145			}
146
147			$options['contextmenu']['items'] = [];
148			foreach ($this->contextMenuItems as $index => $item) {
149			if ($this->menuLabelsTranslationCategory !== false) {
150			$item['label'] = Yii::t($this->menuLabelsTranslationCategory, $item['label']);
151			}
152			$options['contextmenu']['items'][$index] = $item;
153			}
154			}
155			return $options;
156			}
157
158			private function prepareJs()
159			{
160			switch ($this->treeType) {
161			case self::TREE_TYPE_ADJACENCY :
			0 ignored issues – show Coding Style introduced 2016-06-08 06:21 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
162			return $this->adjacecncyJs();
163			case self::TREE_TYPE_NESTED_SET :
			0 ignored issues – show Coding Style introduced 2016-06-08 06:21 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
164			return $this->nestedSetJs();
165			}
166			}
167
168			private function adjacecncyJs()
169			{
170			$changeParent = '';
171			if ($this->changeParentAction !== false) {
172			$changeParentUrl = is_array($this->changeParentAction) ? Url::to($this->changeParentAction) : $this->changeParentAction;
			0 ignored issues – show Coding Style introduced 2016-06-08 06:21 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...
173			$changeParent = "
174			jsTree_{$this->getId()}.bind('move_node.jstree', function(e, data) {
175			jQuery.get(
176			'" . $changeParentUrl . "',
177			{
178			'id': data.node.id,
179			'parent_id': data.parent
180			}
181			);
182			return false;
183			});\n";
184			}
185			$reorder = '';
186			if ($this->reorderAction !== false) {
187			$reorderUrl = is_array($this->reorderAction) ? Url::to($this->reorderAction) : $this->reorderAction;
188			$reorder = "
189			jsTree_{$this->getId()}.bind('move_node.jstree', function(e, data) {
190			var params = [];
191			jQuery('.jstree-node').each(function(i, e) {
192			params[e.id] = i;
193			});
194			jQuery.post(
195			'" . $reorderUrl . "',
196			{'order':params }
197			);
198			return false;
199			});\n";
200			}
201			return $changeParent . $reorder;
202			}
203
204			private function nestedSetJs()
205			{
206			$js = "";
207			if (false !== $this->reorderAction \|\| false !== $this->changeParentAction) {
208			$action = $this->reorderAction ?: $this->changeParentAction;
209			$url = is_array($action) ? Url::to($action) : $action;
210			$js = new JsExpression(
211			"jsTree_{$this->getId()}.on('move_node.jstree', function(e, data) {
212			\$parent = $(this).jstree(true).get_node(data.parent);
213			siblings = \$parent.children \|\| {};
214			$.post(
215			'{$url}',
216			{
217			'node_id' : data.node.id,
218			'parent': data.parent,
219			'position': data.position,
220			'old_parent': data.old_parent,
221			'old_position': data.old_position,
222			'is_multi': data.is_multi,
223			'siblings': siblings
224			}
225			);
226			return false;
227			});\n"
228			);
229			}
230			return $js;
231			}
232			}
233

DevGroup-ru / yii2-jstree-widget

Push — dev ( 61c8f1...460265 )

TreeWidget::nestedSetJs() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like