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

Completed

Push — master ( eb01c6...9c2e72 )

by Alexey

created 2018-05-01 12:04 UTC

Slider::renderSlider() A

↳ Parent: Slider

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	7
cts	7
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	0
crap	2

<?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/
 *
 * Render 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' => [], // Set <ul> options
 *  'itemsOptions' => [], // Set options <li> all
 * ]); ?>
 *
 * 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
     * 'id' => 'myId',
     */
    public $id = '';

    /**
     * Set Items
     * @var array
     *
     * Example 1: Indexed items array
     * ---------------------------------
     * $items = [
     *  '<h1>Slide 1</h1><p>Text 1</p>',
     *  '<h1>Slide 2</h1><p>Text 2</p>',
     *  '...',
     * ]
     *
     * Example 2: Associative items array
     * ---------------------------------
     * $items = [
     *  [
     *      'item' => '<h1>Slide 1</h1><p>Text 1</p>',
     *      'options' => [
     *          'class' => 'text-success',
     *      ]
     *  ],
     *  [
     *      'item' => '<h1>Slide 2</h1><p>Text 2</p>',
     *      'options' => [
     *          'class' => 'text-danger',
     *      ]
     *  ],
     *  //...
     * ]
     */
    public $items = [];

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

    /**
     * List Options
     * @var array
     *
     * Usage:
     * 'listOptions' => ['class' => 'myListCssClass']
     * Result:
     * <ul class="myListCssClass">...</ul>
     */
    public $listOptions = [];

    /**
     * Global Items options
     * @var array
     *
     * Usage:
     * 'itemsOptions' => ['class' => 'myItemsCssClass']
     * Result:
     * <li class="myItemsCssClass">...</li>
     */
    public $itemsOptions = [];

    /**
     * @var string
     */
    private $_selector = '';

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

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

    /**
     * Renders widget
     * @return string|void
     */
    public function run()
    {
        if (!empty($this->items)) {
            $this->registerAssets();
            $this->renderSlider();
        }
    }

    /**
     * Render List
     */
    public function renderSlider()
    {
        echo PHP_EOL . Html::beginTag('ul', $this->listOptions) . PHP_EOL;
        if (ArrayHelper::isAssociative($this->items[0])) {
            $this->renderAssociativeItems();
        } else {
            $this->renderIndexedItems();
        }
        echo Html::endTag('ul') . PHP_EOL;
    }

    /**
     * Render Indexed array items
     */
    public function renderIndexedItems()
    {
        foreach ($this->items as $key => $item) {
            echo Html::tag('li', $item, $this->itemsOptions) . PHP_EOL;
        }
    }

    /**
     * Render Associative array items
     */
    public function renderAssociativeItems()
    {
        foreach ($this->items as $item) {
            $itemData = [];
            if (isset($item['options'])) {
                foreach ($item['options'] as $key => $data) {
                    $itemData[$key] = $data;
                }
            }
            $itemOptions = ArrayHelper::merge($itemData, $this->itemsOptions);
            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->_selector}').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		* Render 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' => [], // Set <ul> options
31		* 'itemsOptions' => [], // Set options <li> all
32		* ]); ?>
33		*
34		* Integrate with lightGallery (http://sachinchoolur.github.io/lightGallery/)
35		* -------------------------------------------------
36		* <?= \dominus77\lightslider\Slider::widget([
37		* 'id' => 'myGalleryID',
38		* 'items' => [
39		* [
40		* 'item' => \yii\helpers\Html::img(Yii::getAlias('@web/uploads/img/image1.jpg')),
41		* 'options' => [
42		* 'data-thumb' => \Yii::getAlias('@web/uploads/img/thumb/image1.jpg'),
43		* 'data-src' => \Yii::getAlias('@web/uploads/img/largeImage1.jpg'),
44		* //...
45		* ]
46		* ],
47		* [
48		* 'item' => \yii\helpers\Html::img(Yii::getAlias('@web/uploads/img/image2.jpg')),
49		* 'options' => [
50		* 'data' => [
51		* 'thumb' => \Yii::getAlias('@web/uploads/img/thumb/image2.jpg'),
52		* 'src' => \Yii::getAlias('@web/uploads/img/largeImage2.jpg'),
53		* ],
54		* //...
55		* ]
56		* ],
57		* //...
58		* ],
59		* 'clientOptions' => [
60		* 'gallery' => true,
61		* 'item' => 1,
62		* 'loop' => true,
63		* 'thumbItem' => 9,
64		* 'slideMargin' => 0,
65		* 'enableDrag' => false,
66		* 'currentPagerPosition' => 'left',
67		* 'onSliderLoad' => new \yii\web\JsExpression("function(el) {
68		* el.lightGallery({
69		* selector: '#myGalleryID .lslide'
70		* });
71		* }"),
72		* //...
73		* ],
74		* //...
75		* ]); ?>
76		*/
77		class Slider extends Widget
78		{
79		/**
80		* @var string
81		* 'id' => 'myId',
82		*/
83		public $id = '';
84
85		/**
86		* Set Items
87		* @var array
88		*
89		* Example 1: Indexed items array
90		* ---------------------------------
91		* $items = [
92		* '<h1>Slide 1</h1><p>Text 1</p>',
93		* '<h1>Slide 2</h1><p>Text 2</p>',
94		* '...',
95		* ]
96		*
97		* Example 2: Associative items array
98		* ---------------------------------
99		* $items = [
100		* [
101		* 'item' => '<h1>Slide 1</h1><p>Text 1</p>',
102		* 'options' => [
103		* 'class' => 'text-success',
104		* ]
105		* ],
106		* [
107		* 'item' => '<h1>Slide 2</h1><p>Text 2</p>',
108		* 'options' => [
109		* 'class' => 'text-danger',
110		* ]
111		* ],
112		* //...
113		* ]
114		*/
115		public $items = [];
116
117		/**
118		* @var array
119		* @see http://sachinchoolur.github.io/lightslider/
120		*/
121		public $clientOptions = [];
122
123		/**
124		* List Options
125		* @var array
126		*
127		* Usage:
128		* 'listOptions' => ['class' => 'myListCssClass']
129		* Result:
130		* <ul class="myListCssClass">...</ul>
131		*/
132		public $listOptions = [];
133
134		/**
135		* Global Items options
136		* @var array
137		*
138		* Usage:
139		* 'itemsOptions' => ['class' => 'myItemsCssClass']
140		* Result:
141		* <li class="myItemsCssClass">...</li>
142		*/
143		public $itemsOptions = [];
144
145		/**
146		* @var string
147		*/
148		private $_selector = '';
149
150		/**
151		* @var array
152		*/
153		private $_options = [];
154
155		/**
156		* Initializes the widget.
157		*/
158	3	public function init()
159		{
160	3	parent::init();
161	3	$this->_selector = $this->id ? $this->id : $this->getId();
162	3	$this->listOptions['id'] = $this->_selector;
163	3	$this->_options = $this->getOptions();
164	3	}
165
166		/**
167		* Renders widget
168		* @return string\|void
169		*/
170	2	public function run()
171		{
172	2	if (!empty($this->items)) {
173	2	$this->registerAssets();
174	2	$this->renderSlider();
175		}
176	2	}
177
178		/**
179		* Render List
180		*/
181	2	public function renderSlider()
182		{
183	2	echo PHP_EOL . Html::beginTag('ul', $this->listOptions) . PHP_EOL;
184	2	if (ArrayHelper::isAssociative($this->items[0])) {
185	1	$this->renderAssociativeItems();
186		} else {
187	1	$this->renderIndexedItems();
188		}
189	2	echo Html::endTag('ul') . PHP_EOL;
190	2	}
191
192		/**
193		* Render Indexed array items
194		*/
195	1	public function renderIndexedItems()
196		{
197	1	foreach ($this->items as $key => $item) {
198	1	echo Html::tag('li', $item, $this->itemsOptions) . PHP_EOL;
199		}
200	1	}
201
202		/**
203		* Render Associative array items
204		*/
205	1	public function renderAssociativeItems()
206		{
207	1	foreach ($this->items as $item) {
208	1	$itemData = [];
209	1	if (isset($item['options'])) {
210	1	foreach ($item['options'] as $key => $data) {
211	1	$itemData[$key] = $data;
212		}
213		}
214	1	$itemOptions = ArrayHelper::merge($itemData, $this->itemsOptions);
215	1	echo Html::tag('li', $item['item'], $itemOptions) . PHP_EOL;
216		}
217	1	}
218
219		/**
220		* Set client options
221		* @return array
222		*/
223	3	public function getOptions()
224		{
225	3	$options = [];
226	3	return ArrayHelper::merge($options, $this->clientOptions);
227		}
228
229		/**
230		* Register resource
231		*/
232	2	public function registerAssets()
233		{
234	2	$options = Json::encode($this->_options);
235	2	$view = $this->getView();
236	2	SliderAsset::register($view);
237	2	if (isset($this->_options['gallery']) && $this->_options['gallery'] === true) {
238	1	GalleryAsset::register($view);
239		}
240	2	$script = new JsExpression("
241	2	var slider = $('#{$this->_selector}').lightSlider({$options});
242		");
243	2	$view->registerJs($script, $view::POS_READY);
244	2	}
245		}
246

Dominus77 / yii2-light-slider-widget

Push — master ( eb01c6...9c2e72 )

Slider::renderSlider() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like