Slider::run() - Code Metrics - Inspection of "Refactoring and Integrate LightGallery" - Dominus77/yii2-light-slider-widget - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f419fa...392041 )

by Alexey

created 2018-04-30 23:33 UTC

Slider::run() A

↳ Parent: Slider

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3.0123

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	13
ccs	8
cts	9
cp	0.8889
rs	9.4285
cc	3
eloc	9
nc	3
nop	0
crap	3.0123

<?php

namespace dominus77\lightslider;

use yii\base\Widget;
use yii\helpers\Html;
use yii\helpers\Json;
use yii\helpers\ArrayHelper;
use yii\web\JsExpression;
use dominus77\lightslider\assets\SliderAsset;
use dominus77\lightslider\assets\GalleryAsset;

/**
 * Class Slider
 * Renders a JQuery LightSlider widget for Yii2.
 * @package dominus77\lightslider
 * @see http://sachinchoolur.github.io/lightslider/
 *
 * Slider
 * -------------------------------------------------
 * <?= \dominus77\lightslider\Slider::widget([
 *  'items' => ['Slide 1', 'Slide 2', 'Slide 3', 'Slide 4', 'Slide 5', 'Slide 6', 'Slide 7', '...'],
 *  'clientOptions' => [
 *      'item' => 3,
 *      'autoWidth' => false,
 *      'slideMove' => 1, // slidemove will be 1 if loop is true
 *      'slideMargin' => 10,
 *      //...
 *  ],
 *  'listOptions' => [],
 *  'itemOptions' => [],
 * ]); ?>
 *
 * Integrate with lightGallery (http://sachinchoolur.github.io/lightGallery/)
 *
 * -------------------------------------------------
 * <?= \dominus77\lightslider\Slider::widget([
 *  'id' => 'myGalleryID',
 *  'items' => [
 *      [
 *          'item' => \yii\helpers\Html::img(Yii::getAlias('@web/uploads/img/image1.jpg')),
 *          'options' => [
 *              'data-thumb' => \Yii::getAlias('@web/uploads/img/thumb/image1.jpg'),
 *              'data-src' => \Yii::getAlias('@web/uploads/img/largeImage1.jpg'),
 *              //...
 *          ]
 *      ],
 *      [
 *          'item' => \yii\helpers\Html::img(Yii::getAlias('@web/uploads/img/image2.jpg')),
 *          'options' => [
 *              'data' => [
 *                  'thumb' => \Yii::getAlias('@web/uploads/img/thumb/image2.jpg'),
 *                  'src' => \Yii::getAlias('@web/uploads/img/largeImage2.jpg'),
 *              ],
 *              //...
 *          ]
 *      ],
 *      //...
 *  ],
 *  'clientOptions' => [
 *      'gallery' => true,
 *      'item' => 1,
 *      'loop' => true,
 *      'thumbItem' => 9,
 *      'slideMargin' => 0,
 *      'enableDrag' => false,
 *      'currentPagerPosition' => 'left',
 *      'onSliderLoad' => new \yii\web\JsExpression("function(el) {
 *           el.lightGallery({
 *               selector: '#myGalleryID .lslide'
 *          });
 *      }"),
 *      //...
 *  ],
 *  //...
 * ]); ?>
 */
class Slider extends Widget
{
    /**
     * @var string|integer
     * 'id' => 'myId',
     */
    public $id = '';

    /**
     * Items
     * @var array
     *
     * [
     *  '<h1>Slide 1</h1><p>Text 1</p>',
     *  '<h1>Slide 2</h1><p>Text 2</p>',
     *  '...',
     * ]
     */
    public $items = [];

    /**
     * @var array
     * @see http://sachinchoolur.github.io/lightslider/
     */
    public $clientOptions = [];

    /**
     * List Options
     * @var array
     * 'listOptions' => ['class' => 'myListCssClass']
     */
    public $listOptions = [];

    /**
     * Items options
     * @var array
     * 'itemOptions' => ['class' => 'myItemsCssClass']
     */
    public $itemOptions = [];

    /**
     * @var integer|string
     */
    private $_id;


    /**
     * @var
     */
    private $_options = [];

    /**
     * Initializes the widget.
     */
    public function init()
    {
        parent::init();
        $this->_id = $this->id ? $this->id : $this->getId();
        $this->listOptions['id'] = $this->_id;
        $this->_options = $this->getOptions();
    }

    /**
     * Renders widget
     * @inheritdoc
     */
    public function run()
    {
        if ($this->items) {

            $this->registerAssets();
            echo Html::beginTag('ul', $this->listOptions) . PHP_EOL;
            if (ArrayHelper::isAssociative($this->items[0])) {
                $this->renderGalleryItems();
            } else {
                $this->renderSliderItems();
            }
            echo Html::endTag('ul') . PHP_EOL;
        }
    }

    /**
     * Render Slider Items
     */
    public function renderSliderItems()
    {
        foreach ($this->items as $key => $item) {
            echo Html::tag('li', $item, $this->itemOptions) . PHP_EOL;
        }
    }

    /**
     * Render Gallery Items
     */
    public function renderGalleryItems()
    {
        foreach ($this->items as $item) {
            $itemData = [];
            if (isset($item['options'])) {
                foreach ($item['options'] as $key => $data) {
                    $itemData[$key] = $data;
                }
            }
            $itemOptions = ArrayHelper::merge($itemData, $this->itemOptions);
            echo Html::tag('li', $item['item'], $itemOptions) . PHP_EOL;
        }
    }

    /**
     * Set client options
     * @return array
     */
    public function getOptions()
    {
        $options = [];
        return ArrayHelper::merge($options, $this->clientOptions);
    }

    /**
     * Register resource
     */
    public function registerAssets()
    {
        $options = Json::encode($this->_options);
        $view = $this->getView();
        SliderAsset::register($view);
        if (isset($this->_options['gallery']) && $this->_options['gallery'] === true) {
            GalleryAsset::register($view);
        }
        $script = new JsExpression("
            var slider = $('#{$this->_id}').lightSlider({$options});
        ");
        $view->registerJs($script, $view::POS_READY);
    }
}


1		<?php
2
3		namespace dominus77\lightslider;
4
5		use yii\base\Widget;
6		use yii\helpers\Html;
7		use yii\helpers\Json;
8		use yii\helpers\ArrayHelper;
9		use yii\web\JsExpression;
10		use dominus77\lightslider\assets\SliderAsset;
11		use dominus77\lightslider\assets\GalleryAsset;
12
13		/**
14		* Class Slider
15		* Renders a JQuery LightSlider widget for Yii2.
16		* @package dominus77\lightslider
17		* @see http://sachinchoolur.github.io/lightslider/
18		*
19		* Slider
20		* -------------------------------------------------
21		* <?= \dominus77\lightslider\Slider::widget([
22		* 'items' => ['Slide 1', 'Slide 2', 'Slide 3', 'Slide 4', 'Slide 5', 'Slide 6', 'Slide 7', '...'],
23		* 'clientOptions' => [
24		* 'item' => 3,
25		* 'autoWidth' => false,
26		* 'slideMove' => 1, // slidemove will be 1 if loop is true
27		* 'slideMargin' => 10,
28		* //...
29		* ],
30		* 'listOptions' => [],
31		* 'itemOptions' => [],
32		* ]); ?>
33		*
34		* Integrate with lightGallery (http://sachinchoolur.github.io/lightGallery/)
35		*
36		* -------------------------------------------------
37		* <?= \dominus77\lightslider\Slider::widget([
38		* 'id' => 'myGalleryID',
39		* 'items' => [
40		* [
41		* 'item' => \yii\helpers\Html::img(Yii::getAlias('@web/uploads/img/image1.jpg')),
42		* 'options' => [
43		* 'data-thumb' => \Yii::getAlias('@web/uploads/img/thumb/image1.jpg'),
44		* 'data-src' => \Yii::getAlias('@web/uploads/img/largeImage1.jpg'),
45		* //...
46		* ]
47		* ],
48		* [
49		* 'item' => \yii\helpers\Html::img(Yii::getAlias('@web/uploads/img/image2.jpg')),
50		* 'options' => [
51		* 'data' => [
52		* 'thumb' => \Yii::getAlias('@web/uploads/img/thumb/image2.jpg'),
53		* 'src' => \Yii::getAlias('@web/uploads/img/largeImage2.jpg'),
54		* ],
55		* //...
56		* ]
57		* ],
58		* //...
59		* ],
60		* 'clientOptions' => [
61		* 'gallery' => true,
62		* 'item' => 1,
63		* 'loop' => true,
64		* 'thumbItem' => 9,
65		* 'slideMargin' => 0,
66		* 'enableDrag' => false,
67		* 'currentPagerPosition' => 'left',
68		* 'onSliderLoad' => new \yii\web\JsExpression("function(el) {
69		* el.lightGallery({
70		* selector: '#myGalleryID .lslide'
71		* });
72		* }"),
73		* //...
74		* ],
75		* //...
76		* ]); ?>
77		*/
78		class Slider extends Widget
79		{
80		/**
81		* @var string\|integer
82		* 'id' => 'myId',
83		*/
84		public $id = '';
85
86		/**
87		* Items
88		* @var array
89		*
90		* [
91		* '<h1>Slide 1</h1><p>Text 1</p>',
92		* '<h1>Slide 2</h1><p>Text 2</p>',
93		* '...',
94		* ]
95		*/
96		public $items = [];
97
98		/**
99		* @var array
100		* @see http://sachinchoolur.github.io/lightslider/
101		*/
102		public $clientOptions = [];
103
104		/**
105		* List Options
106		* @var array
107		* 'listOptions' => ['class' => 'myListCssClass']
108		*/
109		public $listOptions = [];
110
111		/**
112		* Items options
113		* @var array
114		* 'itemOptions' => ['class' => 'myItemsCssClass']
115		*/
116		public $itemOptions = [];
117
118		/**
119		* @var integer\|string
120		*/
121		private $_id;
		0 ignored issues – show Comprehensibility introduced 2018-04-30 23:36 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
122
123		/**
124		* @var
125		*/
126		private $_options = [];
127
128		/**
129		* Initializes the widget.
130		*/
131	2	public function init()
132		{
133	2	parent::init();
134	2	$this->_id = $this->id ? $this->id : $this->getId();
135	2	$this->listOptions['id'] = $this->_id;
136	2	$this->_options = $this->getOptions();
137	2	}
138
139		/**
140		* Renders widget
141		* @inheritdoc
142		*/
143	1	public function run()
144		{
145	1	if ($this->items) {
		0 ignored issues – show Bug Best Practice introduced 2018-04-30 17:25 UTC by Report Bug Copy Issue Report The expression `$this->items` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
146	1	$this->registerAssets();
147	1	echo Html::beginTag('ul', $this->listOptions) . PHP_EOL;
148	1	if (ArrayHelper::isAssociative($this->items[0])) {
149		$this->renderGalleryItems();
150		} else {
151	1	$this->renderSliderItems();
152		}
153	1	echo Html::endTag('ul') . PHP_EOL;
154		}
155	1	}
156
157		/**
158		* Render Slider Items
159		*/
160	1	public function renderSliderItems()
161		{
162	1	foreach ($this->items as $key => $item) {
163	1	echo Html::tag('li', $item, $this->itemOptions) . PHP_EOL;
164		}
165	1	}
166
167		/**
168		* Render Gallery Items
169		*/
170		public function renderGalleryItems()
171		{
172		foreach ($this->items as $item) {
173		$itemData = [];
174		if (isset($item['options'])) {
175		foreach ($item['options'] as $key => $data) {
176		$itemData[$key] = $data;
177		}
178		}
179		$itemOptions = ArrayHelper::merge($itemData, $this->itemOptions);
180		echo Html::tag('li', $item['item'], $itemOptions) . PHP_EOL;
181		}
182		}
183
184		/**
185		* Set client options
186		* @return array
187		*/
188	2	public function getOptions()
189		{
190	2	$options = [];
191	2	return ArrayHelper::merge($options, $this->clientOptions);
192		}
193
194		/**
195		* Register resource
196		*/
197	1	public function registerAssets()
198		{
199	1	$options = Json::encode($this->_options);
200	1	$view = $this->getView();
201	1	SliderAsset::register($view);
202	1	if (isset($this->_options['gallery']) && $this->_options['gallery'] === true) {
203		GalleryAsset::register($view);
204		}
205	1	$script = new JsExpression("
206	1	var slider = $('#{$this->_id}').lightSlider({$options});
207		");
208	1	$view->registerJs($script, $view::POS_READY);
209	1	}
210		}
211

Dominus77 / yii2-light-slider-widget

Push — master ( f419fa...392041 )

Slider::run() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like