TreeWidget::contextMenuOptions() - Code Metrics - Inspection of "add ability to dynamically create context menu ite..." - DevGroup-ru/yii2-jstree-widget - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — master ( c4ec06...c48ece )

unknown

created 2016-09-08 11:50 UTC

TreeWidget::contextMenuOptions() B

↳ Parent: TreeWidget

Complexity

Conditions	6
Paths	4

Size

Total Lines	38
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
c	3
b	0
f	1
dl	0
loc	38
rs	8.439
cc	6
eloc	28
nc	4
nop	1

<?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 = false;

    /**
     * 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;

    /** @var bool|array route to change parent action (applicable to Adjacency List only) */
    public $changeParentAction = false;

    /** @var bool|array route to reorder action */
    public $reorderAction = false;

    /** @var bool plugin config option for allow multiple nodes selections or not */
    public $multiSelect = false;

    /** @var string Default labels translation category */
    private $defaultTranslationCategory = 'jstw.defaults';

    /**
     * @inheritdoc
     */
    public function init()
    {
        if (false === $this->menuLabelsTranslationCategory) {
            $this->menuLabelsTranslationCategory = $this->defaultTranslationCategory;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        }
        self::registerTranslations();
        parent::init();
    }

    public static function registerTranslations()
    {
        Yii::$app->i18n->translations['jstw*'] = [
            'class' => 'yii\i18n\PhpMessageSource',
            'basePath' => dirname(__DIR__) . DIRECTORY_SEPARATOR . 'messages',
        ];
    }

    /**
     * @inheritdoc
     */
    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,
                'multiple' => $this->multiSelect,
                'data' => [
                    'url' => new JsExpression(
                        "function (node) {
                            return " . Json::encode(Url::to($this->treeDataRoute)) . ";
                        }"
                    ),
                    'success' => new JsExpression(
                        "function (node) {
                            return { 'id' : node.id };
                        }"
                    ),
                    'data' => new JsExpression(
                        "function (node) {
                        return { 'id' : node.id };
                        }"
                    ),
                    'error' => new JsExpression(
                        "function ( o, textStatus, errorThrown ) {
                            alert(o.responseText);
                        }"
                    )
                ]
            ]
        ];

        // merge with attribute-provided options
        $options = ArrayHelper::merge($options, $this->options);
        if (false === empty($this->contextMenuItems)) {
            if (!in_array('contextmenu', $this->plugins)) {
                // add missing contextmenu plugin
                $options['plugins'] = ['contextmenu'];
            }
            $functionName = $this->getId() . 'ContextMenu';
            $options['contextmenu'] = ['items' => new JsExpression($functionName)];
            $this->contextMenuOptions($functionName);
        }
        $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()]);
    }

    /**
     * @param $functionName
     * @return array

     */
    private function contextMenuOptions($functionName)
    {
        $items = [];
        $conditionItems = "";
        foreach ($this->contextMenuItems as $index => $item) {
            $item['label'] = Yii::t($this->menuLabelsTranslationCategory, $item['label']);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            if (false === empty($item['showWhen'])) {
                if (true === is_array($item['showWhen'])) {
                    $condition = [];
                    foreach ($item['showWhen'] as $key => $value) {
                        $key = (false !== strpos($key, 'data-')) ? $key : 'data-' . $key;
                        $condition[] = "node.hasOwnProperty('a_attr') && node.a_attr['$key'] == {$value}";
                    }
                    $condition = implode(' && ', $condition);
                } else {
                    $condition = $item['showWhen'];
                }
                unset($item['showWhen']);
                $item = Json::encode($item);
                $conditionItems .= new JsExpression("
                if ({$condition}) {
                    items.{$index} = $item;
                }
                ");
            } else {
                $items[$index] = $item;
            }
        }
        $items = Json::encode($items);
        $js = <<<JS
            function $functionName(node) {
                var items = $items;
                $conditionItems
                return items;
            }
JS;
        $this->view->registerJs($js, View::POS_HEAD);
    }

    /**
     * Prepares js according to given tree type
     *
     * @return string

     */
    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->adjacencyJs();
            case self::TREE_TYPE_NESTED_SET :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
                return $this->nestedSetJs();
        }
    }

    /**
     * @return string
     */
    private function adjacencyJs()
    {
        $changeParentJs = '';
        if ($this->changeParentAction !== false) {
            $changeParentUrl = is_array($this->changeParentAction) ? Url::to($this->changeParentAction) : $this->changeParentAction;

            $changeParentJs = <<<JS
             jsTree_{$this->getId()}.on('move_node.jstree', function(e, data) {
                var \$this = $(this);
                $.get('$changeParentUrl', {
                        'id': data.node.id,
                        'parent_id': data.parent
                    }, "json")
                    .done(function (data) {
                        if ('undefined' !== typeof(data.error)) {
                            alert(data.error);
                        }
                        \$this.jstree('refresh');
                    })
                    .fail(function ( o, textStatus, errorThrown ) {
                        alert(o.responseText);
                    });
                return false;
            });
JS;
        }

        $reorderJs = '';
        if ($this->reorderAction !== false) {
            $reorderUrl = is_array($this->reorderAction) ? Url::to($this->reorderAction) : $this->reorderAction;
            $reorderJs = <<<JS
            jsTree_{$this->getId()}.on('move_node.jstree', function(e, data) {
                var params = [];
                var \$this = $(this);
                $('.jstree-node').each(function(i, e) {
                    params[e.id] = i;
                });
                $.post('$reorderUrl', {
                    'order':params,
                    'id': data.node.id
                     },
                      "json")
                    .done(function (data) {
                        if ('undefined' !== typeof(data.error)) {
                            alert(data.error);
                        }
                        \$this.jstree('refresh');
                    })
                    .fail(function ( o, textStatus, errorThrown ) {
                        alert(o.responseText);
                    });
                return false;
            });
JS;
        }
        return $changeParentJs . "\n" . $reorderJs . "\n";
    }

    /**
     * @return string
     */
    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 = <<<JS
                jsTree_{$this->getId()}.on('move_node.jstree', function(e, data) {
                    var \$this = $(this),
                        \$parent = \$this.jstree(true).get_node(data.parent),
                        \$oldParent = \$this.jstree(true).get_node(data.old_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
                         }, "json")
                         .done(function (data) {
                            if ('undefined' !== typeof(data.error)) {
                                alert(data.error);
                            }
                            \$this.jstree('refresh');
                         })
                         .fail(function ( o, textStatus, errorThrown ) {
                            alert(o.responseText);
                         });
                    return false;
                });
JS;
        }
        return $js . "\n";
    }
}


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 = false;
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			/** @var bool\|array route to change parent action (applicable to Adjacency List only) */
83			public $changeParentAction = false;
84
85			/** @var bool\|array route to reorder action */
86			public $reorderAction = false;
87
88			/** @var bool plugin config option for allow multiple nodes selections or not */
89			public $multiSelect = false;
90
91			/** @var string Default labels translation category */
92			private $defaultTranslationCategory = 'jstw.defaults';
93
94			/**
95			* @inheritdoc
96			*/
97			public function init()
98			{
99			if (false === $this->menuLabelsTranslationCategory) {
100			$this->menuLabelsTranslationCategory = $this->defaultTranslationCategory;
			0 ignored issues – show Documentation Bug introduced 2016-08-19 08:06 UTC by Report Bug Copy Issue Report The property `$menuLabelsTranslationCategory` was declared of type `boolean`, but `$this->defaultTranslationCategory` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
101			}
102			self::registerTranslations();
103			parent::init();
104			}
105
106			public static function registerTranslations()
107			{
108			Yii::$app->i18n->translations['jstw*'] = [
109			'class' => 'yii\i18n\PhpMessageSource',
110			'basePath' => dirname(__DIR__) . DIRECTORY_SEPARATOR . 'messages',
111			];
112			}
113
114			/**
115			* @inheritdoc
116			*/
117			public function run()
118			{
119			if (!is_array($this->treeDataRoute)) {
120			throw new InvalidConfigException("Attribute treeDataRoute is required to use TreeWidget.");
121			}
122
123			$options = [
124			'plugins' => $this->plugins,
125			'core' => [
126			'check_callback' => true,
127			'multiple' => $this->multiSelect,
128			'data' => [
129			'url' => new JsExpression(
130			"function (node) {
131			return " . Json::encode(Url::to($this->treeDataRoute)) . ";
132			}"
133			),
134			'success' => new JsExpression(
135			"function (node) {
136			return { 'id' : node.id };
137			}"
138			),
139			'data' => new JsExpression(
140			"function (node) {
141			return { 'id' : node.id };
142			}"
143			),
144			'error' => new JsExpression(
145			"function ( o, textStatus, errorThrown ) {
146			alert(o.responseText);
147			}"
148			)
149			]
150			]
151			];
152
153			// merge with attribute-provided options
154			$options = ArrayHelper::merge($options, $this->options);
155			if (false === empty($this->contextMenuItems)) {
156			if (!in_array('contextmenu', $this->plugins)) {
157			// add missing contextmenu plugin
158			$options['plugins'] = ['contextmenu'];
159			}
160			$functionName = $this->getId() . 'ContextMenu';
161			$options['contextmenu'] = ['items' => new JsExpression($functionName)];
162			$this->contextMenuOptions($functionName);
163			}
164			$options = Json::encode($options);
165			$this->getView()->registerAssetBundle('devgroup\JsTreeWidget\widgets\JsTreeAssetBundle');
166
167			$doubleClick = '';
168			if ($this->doubleClickAction !== false) {
169			$doubleClick = "
170			jsTree_{$this->getId()}.on('dblclick.jstree', function (e) {
171			var node = $(e.target).closest('.jstree-node').children('.jstree-anchor');
172			var callback = " . $this->doubleClickAction . ";
173			callback(node);
174			return false;
175			});\n";
176			}
177			$treeJs = $this->prepareJs();
178			$this->getView()->registerJs("
179			var jsTree_{$this->getId()} = \$('#{$this->getId()}').jstree($options);
180			$doubleClick $treeJs", View::POS_READY);
181			return Html::tag('div', '', ['id' => $this->getId()]);
182			}
183
184			/**
185			* @param $functionName
186			* @return array
			0 ignored issues – show Documentation introduced 2016-09-08 11:52 UTC by Report Bug Copy Issue Report Should the return type not be `array\|null`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. If the return type contains the type array, this check recommends the use of a more specific type like `String[]` or `array<String>`. Loading history...
187			*/
188			private function contextMenuOptions($functionName)
189			{
190			$items = [];
191			$conditionItems = "";
192			foreach ($this->contextMenuItems as $index => $item) {
193			$item['label'] = Yii::t($this->menuLabelsTranslationCategory, $item['label']);
			0 ignored issues – show Documentation introduced 2016-08-19 08:06 UTC by Report Bug Copy Issue Report `$this->menuLabelsTranslationCategory` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
194			if (false === empty($item['showWhen'])) {
195			if (true === is_array($item['showWhen'])) {
196			$condition = [];
197			foreach ($item['showWhen'] as $key => $value) {
198			$key = (false !== strpos($key, 'data-')) ? $key : 'data-' . $key;
199			$condition[] = "node.hasOwnProperty('a_attr') && node.a_attr['$key'] == {$value}";
200			}
201			$condition = implode(' && ', $condition);
202			} else {
203			$condition = $item['showWhen'];
204			}
205			unset($item['showWhen']);
206			$item = Json::encode($item);
207			$conditionItems .= new JsExpression("
208			if ({$condition}) {
209			items.{$index} = $item;
210			}
211			");
212			} else {
213			$items[$index] = $item;
214			}
215			}
216			$items = Json::encode($items);
217			$js = <<<JS
218			function $functionName(node) {
219			var items = $items;
220			$conditionItems
221			return items;
222			}
223			JS;
224			$this->view->registerJs($js, View::POS_HEAD);
225			}
226
227			/**
228			* Prepares js according to given tree type
229			*
230			* @return string
			0 ignored issues – show Documentation introduced 2016-06-15 13:58 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
231			*/
232			private function prepareJs()
233			{
234			switch ($this->treeType) {
235			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...
236			return $this->adjacencyJs();
237			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...
238			return $this->nestedSetJs();
239			}
240			}
241
242			/**
243			* @return string
244			*/
245			private function adjacencyJs()
246			{
247			$changeParentJs = '';
248			if ($this->changeParentAction !== false) {
249			$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...
250			$changeParentJs = <<<JS
251			jsTree_{$this->getId()}.on('move_node.jstree', function(e, data) {
252			var \$this = $(this);
253			$.get('$changeParentUrl', {
254			'id': data.node.id,
255			'parent_id': data.parent
256			}, "json")
257			.done(function (data) {
258			if ('undefined' !== typeof(data.error)) {
259			alert(data.error);
260			}
261			\$this.jstree('refresh');
262			})
263			.fail(function ( o, textStatus, errorThrown ) {
264			alert(o.responseText);
265			});
266			return false;
267			});
268			JS;
269			}
270
271			$reorderJs = '';
272			if ($this->reorderAction !== false) {
273			$reorderUrl = is_array($this->reorderAction) ? Url::to($this->reorderAction) : $this->reorderAction;
274			$reorderJs = <<<JS
275			jsTree_{$this->getId()}.on('move_node.jstree', function(e, data) {
276			var params = [];
277			var \$this = $(this);
278			$('.jstree-node').each(function(i, e) {
279			params[e.id] = i;
280			});
281			$.post('$reorderUrl', {
282			'order':params,
283			'id': data.node.id
284			},
285			"json")
286			.done(function (data) {
287			if ('undefined' !== typeof(data.error)) {
288			alert(data.error);
289			}
290			\$this.jstree('refresh');
291			})
292			.fail(function ( o, textStatus, errorThrown ) {
293			alert(o.responseText);
294			});
295			return false;
296			});
297			JS;
298			}
299			return $changeParentJs . "\n" . $reorderJs . "\n";
300			}
301
302			/**
303			* @return string
304			*/
305			private function nestedSetJs()
306			{
307			$js = "";
308			if (false !== $this->reorderAction \|\| false !== $this->changeParentAction) {
309			$action = $this->reorderAction ?: $this->changeParentAction;
310			$url = is_array($action) ? Url::to($action) : $action;
311			$js = <<<JS
312			jsTree_{$this->getId()}.on('move_node.jstree', function(e, data) {
313			var \$this = $(this),
314			\$parent = \$this.jstree(true).get_node(data.parent),
315			\$oldParent = \$this.jstree(true).get_node(data.old_parent),
316			siblings = \$parent.children \|\| {};
317			$.post('$url', {
318			'node_id' : data.node.id,
319			'parent': data.parent,
320			'position': data.position,
321			'old_parent': data.old_parent,
322			'old_position': data.old_position,
323			'is_multi': data.is_multi,
324			'siblings': siblings
325			}, "json")
326			.done(function (data) {
327			if ('undefined' !== typeof(data.error)) {
328			alert(data.error);
329			}
330			\$this.jstree('refresh');
331			})
332			.fail(function ( o, textStatus, errorThrown ) {
333			alert(o.responseText);
334			});
335			return false;
336			});
337			JS;
338			}
339			return $js . "\n";
340			}
341			}
342

DevGroup-ru / yii2-jstree-widget

Push — master ( c4ec06...c48ece )

TreeWidget::contextMenuOptions() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like