Tabs::renderItem() - Code Metrics - Inspection of "/ ‘src/widgets/Tabs.php’" - DMGPage/yii2-materialize - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (d57a25)

by Dmitrijs

created 2019-05-25 11:45 UTC

Tabs::renderItem() B

↳ Parent: Tabs

Complexity

Conditions	11
Paths	98

Size

Total Lines	47
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	29
dl	0
loc	47
rs	7.3166
c	0
b	0
f	0
cc	11
nc	98
nop	2

How to fix Complexity

<?php
/**
 * @link https://github.com/DMGPage/yii2-materialize
 * @copyright Copyright (c) 2018 Dmitrijs Reinmanis
 * @license https://github.com/DMGPage/yii2-materialize/blob/master/LICENSE
 */

namespace dmgpage\yii2materialize\widgets;

use yii\helpers\ArrayHelper;
use dmgpage\yii2materialize\helpers\Html;
use yii\base\InvalidConfigException;

/**
 * The tabs structure consists of an unordered list of tabs that have hashes corresponding to tab ids.
 * Then when you click on each tab, only the container with the corresponding tab id will become visible.
 *
 * You can use Tabs like this:
 *
 * ```php
 * echo Tabs::widget([
 *     'items' => [
 *         [
 *             'label' => 'Home',
 *             'content' => 'Home content...',
 *             'active' => true
 *         ],
 *         [
 *             'label' => 'Profile',
 *             'content' => 'Profile content...'
 *         ],
 *         [
 *             'label' => 'Messages',
 *             'content' => 'Messages content...',
 *             'disabled' => true
 *         ],
 *         [
 *             'label' => 'Google',
 *             'url' => 'http://www.google.lv'
 *         ],
 *         [
 *             'label' => 'Hidden',
 *             'content' => 'Hidden content...',
 *             'visible' => false
 *         ],
 *     ]
 * ]);
 * ```
 * @property bool $initializePlugin
 *
 * @see https://materializecss.com/tabs.html
 * @package widgets
 */
class Tabs extends Widget
{
    /**
     * @var array list of tabs in the tabs widget. Each array element represents a single
     * tab with the following structure:
     *
     * - label: string, required, the tab header label.
     * - encode: boolean, optional, whether this label should be HTML-encoded. This param will override
     *   global `$this->encodeLabels` param.
     * - headerOptions: array, optional, the HTML attributes of the tab header.
     * - linkOptions: array, optional, the HTML attributes of the tab header link tags.
     * - content: string, optional, the content (HTML) of the tab pane.
     * - url: string, optional, an external URL. When this is specified, clicking on this tab will bring
     *   the browser to this URL
     * - options: array, optional, the HTML attributes of the tab pane container.
     * - active: boolean, optional, whether this item tab header and pane should be active. If no item is marked as
     *   'active' explicitly - the first one will be activated.
     * - visible: boolean, optional, whether the item tab header and pane should be visible or not. Defaults to true.
     * - disabled: boolean, optional, whether the item tab header and pane should be disabled or not. Defaults to false.
     */
    public $items = [];

    /**
     * @var array list of HTML attributes for the header container tags. This will be overwritten
     * by the "headerOptions" set in individual [[items]].
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $headerOptions = [];

    /**
     * @var array list of HTML attributes for the tab header link tags. This will be overwritten
     * by the "linkOptions" set in individual [[items]].
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $linkOptions = [];

    /**
     * @var array list of HTML attributes for the item container tags. This will be overwritten
     * by the "options" set in individual [[items]]. The following special options are recognized:
     *
     * - tag: string, defaults to "div", the tag name of the item container tags.
     *
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $itemOptions = [];

    /**
     * @var boolean whether to render the `tab-content` container and its content. You may set this property
     * to be false so that you can manually render `tab-content` yourself in case your tab contents are complex.
     */
    public $renderTabContent = true;

    /**
     * @var boolean whether the labels for header items should be HTML-encoded.
     */
    public $encodeLabels = true;

    /**
     * @var boolean whether the tab width for header items should be fixed.
     */
    public $fixedWidth = false;

    /**
     * Initializes the widget.
     */
    public function init()
    {
        parent::init();
        
        Html::addCssClass($this->options, ['widget' => 'tabs']);

        if ($this->fixedWidth) {
            Html::addCssClass($this->options, ['width' => 'tabs-fixed-width']);
        }
    }

    /**
     * Renders the widget.
     */
    public function run()
    {
        $this->initializePlugin = true;
        $this->registerPlugin('tabs');
        return $this->renderItems();
    }

    /**
     * Renders tab items as specified on [[items]].
     *
     * @return string the rendering result.
     * @throws InvalidConfigException.
     */
    protected function renderItems()
    {
        $headers = [];
        $panes = [];

        if (!$this->hasActiveTab() && !empty($this->items)) {
            $this->items[0]['active'] = true;
        }

        foreach ($this->items as $index => $item) {
            list($header, $content) = $this->renderItem($index, $item);

            $headers[] = $header;

            if (!empty($content)) {
                $panes[] = $content;
            }
        }

        $html = Html::tag('ul', implode("\n", $headers), $this->options);
        $html .= $this->renderTabContent
            ? "\n" . Html::tag('div', implode("\n", $panes), ['class' => 'tab-content'])
            : '';

        return $html;
    }

    /**
     * Renders single tab item as specified on [[items]].
     *
     * @param int $index tab serial number
     * @param array $item single tab element
     * @return array returns array containing tab header and content [header, content]
     * @throws InvalidConfigException.
     */
    protected function renderItem($index, $item)
    {
        if (!array_key_exists('label', $item)) {
            throw new InvalidConfigException("The 'label' option is required.");
        } elseif (ArrayHelper::remove($item, 'visible', true)) {
            $encodeLabel = isset($item['encode']) ? $item['encode'] : $this->encodeLabels;
            $label = $encodeLabel ? Html::encode($item['label']) : $item['label'];
            $headerOptions = array_merge($this->headerOptions, ArrayHelper::getValue($item, 'headerOptions', []));
            $linkOptions = array_merge($this->linkOptions, ArrayHelper::getValue($item, 'linkOptions', []));
            $options = array_merge($this->itemOptions, ArrayHelper::getValue($item, 'options', []));
            $options['id'] = ArrayHelper::getValue($options, 'id', $this->options['id'] . '-tab' . $index);

            Html::addCssClass($options, 'col s12');

            // Add active tab and content
            if (ArrayHelper::remove($item, 'active')) {
                Html::addCssClass($options, 'active');
                Html::addCssClass($headerOptions, ['active', 'tab']);
            } else {
                Html::addCssClass($headerOptions, 'tab');
            }

            // Add disabled tab and content
            if (ArrayHelper::remove($item, 'disabled')) {
                Html::addCssClass($headerOptions, 'disabled');
            }

            // Add tab header
            if (isset($item['url'])) {
                $linkOptions['target'] = isset($linkOptions['target']) ? $linkOptions['target'] : '_self';
                $header = Html::a($label, $item['url'], $linkOptions);
            } else {
                $header = Html::a($label, '#' . $options['id'], $linkOptions);
            }

            // Add tab content
            if ($this->renderTabContent) {
                $tag = ArrayHelper::remove($options, 'tag', 'div');
                $content = Html::tag($tag, isset($item['content']) ? $item['content'] : '', $options);
            } else {
                $content = null;
            }

            $header = Html::tag('li', $header, $headerOptions);
        }

        return [$header, $content];

    }

    /**
     * Searches for active tab value in [[items]]
     * @return boolean if there's active tab defined
     */
    protected function hasActiveTab()
    {
        foreach ($this->items as $item) {
            if (isset($item['active']) && $item['active'] === true) {
                return true;
            }
        }

        return false;
    }
}


1			<?php
2			/**
3			* @link https://github.com/DMGPage/yii2-materialize
4			* @copyright Copyright (c) 2018 Dmitrijs Reinmanis
5			* @license https://github.com/DMGPage/yii2-materialize/blob/master/LICENSE
6			*/
7
8			namespace dmgpage\yii2materialize\widgets;
9
10			use yii\helpers\ArrayHelper;
11			use dmgpage\yii2materialize\helpers\Html;
12			use yii\base\InvalidConfigException;
13
14			/**
15			* The tabs structure consists of an unordered list of tabs that have hashes corresponding to tab ids.
16			* Then when you click on each tab, only the container with the corresponding tab id will become visible.
17			*
18			* You can use Tabs like this:
19			*
20			* ```php
21			* echo Tabs::widget([
22			* 'items' => [
23			* [
24			* 'label' => 'Home',
25			* 'content' => 'Home content...',
26			* 'active' => true
27			* ],
28			* [
29			* 'label' => 'Profile',
30			* 'content' => 'Profile content...'
31			* ],
32			* [
33			* 'label' => 'Messages',
34			* 'content' => 'Messages content...',
35			* 'disabled' => true
36			* ],
37			* [
38			* 'label' => 'Google',
39			* 'url' => 'http://www.google.lv'
40			* ],
41			* [
42			* 'label' => 'Hidden',
43			* 'content' => 'Hidden content...',
44			* 'visible' => false
45			* ],
46			* ]
47			* ]);
48			* ```
49			* @property bool $initializePlugin
50			*
51			* @see https://materializecss.com/tabs.html
52			* @package widgets
53			*/
54			class Tabs extends Widget
55			{
56			/**
57			* @var array list of tabs in the tabs widget. Each array element represents a single
58			* tab with the following structure:
59			*
60			* - label: string, required, the tab header label.
61			* - encode: boolean, optional, whether this label should be HTML-encoded. This param will override
62			* global `$this->encodeLabels` param.
63			* - headerOptions: array, optional, the HTML attributes of the tab header.
64			* - linkOptions: array, optional, the HTML attributes of the tab header link tags.
65			* - content: string, optional, the content (HTML) of the tab pane.
66			* - url: string, optional, an external URL. When this is specified, clicking on this tab will bring
67			* the browser to this URL
68			* - options: array, optional, the HTML attributes of the tab pane container.
69			* - active: boolean, optional, whether this item tab header and pane should be active. If no item is marked as
70			* 'active' explicitly - the first one will be activated.
71			* - visible: boolean, optional, whether the item tab header and pane should be visible or not. Defaults to true.
72			* - disabled: boolean, optional, whether the item tab header and pane should be disabled or not. Defaults to false.
73			*/
74			public $items = [];
75
76			/**
77			* @var array list of HTML attributes for the header container tags. This will be overwritten
78			* by the "headerOptions" set in individual [[items]].
79			* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
80			*/
81			public $headerOptions = [];
82
83			/**
84			* @var array list of HTML attributes for the tab header link tags. This will be overwritten
85			* by the "linkOptions" set in individual [[items]].
86			* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
87			*/
88			public $linkOptions = [];
89
90			/**
91			* @var array list of HTML attributes for the item container tags. This will be overwritten
92			* by the "options" set in individual [[items]]. The following special options are recognized:
93			*
94			* - tag: string, defaults to "div", the tag name of the item container tags.
95			*
96			* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
97			*/
98			public $itemOptions = [];
99
100			/**
101			* @var boolean whether to render the `tab-content` container and its content. You may set this property
102			* to be false so that you can manually render `tab-content` yourself in case your tab contents are complex.
103			*/
104			public $renderTabContent = true;
105
106			/**
107			* @var boolean whether the labels for header items should be HTML-encoded.
108			*/
109			public $encodeLabels = true;
110
111			/**
112			* @var boolean whether the tab width for header items should be fixed.
113			*/
114			public $fixedWidth = false;
115
116			/**
117			* Initializes the widget.
118			*/
119			public function init()
120			{
121			parent::init();
122
123			Html::addCssClass($this->options, ['widget' => 'tabs']);
124
125			if ($this->fixedWidth) {
126			Html::addCssClass($this->options, ['width' => 'tabs-fixed-width']);
127			}
128			}
129
130			/**
131			* Renders the widget.
132			*/
133			public function run()
134			{
135			$this->initializePlugin = true;
136			$this->registerPlugin('tabs');
137			return $this->renderItems();
138			}
139
140			/**
141			* Renders tab items as specified on [[items]].
142			*
143			* @return string the rendering result.
144			* @throws InvalidConfigException.
145			*/
146			protected function renderItems()
147			{
148			$headers = [];
149			$panes = [];
150
151			if (!$this->hasActiveTab() && !empty($this->items)) {
152			$this->items[0]['active'] = true;
153			}
154
155			foreach ($this->items as $index => $item) {
156			list($header, $content) = $this->renderItem($index, $item);
157
158			$headers[] = $header;
159
160			if (!empty($content)) {
161			$panes[] = $content;
162			}
163			}
164
165			$html = Html::tag('ul', implode("\n", $headers), $this->options);
166			$html .= $this->renderTabContent
167			? "\n" . Html::tag('div', implode("\n", $panes), ['class' => 'tab-content'])
168			: '';
169
170			return $html;
171			}
172
173			/**
174			* Renders single tab item as specified on [[items]].
175			*
176			* @param int $index tab serial number
177			* @param array $item single tab element
178			* @return array returns array containing tab header and content [header, content]
179			* @throws InvalidConfigException.
180			*/
181			protected function renderItem($index, $item)
182			{
183			if (!array_key_exists('label', $item)) {
184			throw new InvalidConfigException("The 'label' option is required.");
185			} elseif (ArrayHelper::remove($item, 'visible', true)) {
186			$encodeLabel = isset($item['encode']) ? $item['encode'] : $this->encodeLabels;
187			$label = $encodeLabel ? Html::encode($item['label']) : $item['label'];
188			$headerOptions = array_merge($this->headerOptions, ArrayHelper::getValue($item, 'headerOptions', []));
189			$linkOptions = array_merge($this->linkOptions, ArrayHelper::getValue($item, 'linkOptions', []));
190			$options = array_merge($this->itemOptions, ArrayHelper::getValue($item, 'options', []));
191			$options['id'] = ArrayHelper::getValue($options, 'id', $this->options['id'] . '-tab' . $index);
192
193			Html::addCssClass($options, 'col s12');
194
195			// Add active tab and content
196			if (ArrayHelper::remove($item, 'active')) {
197			Html::addCssClass($options, 'active');
198			Html::addCssClass($headerOptions, ['active', 'tab']);
199			} else {
200			Html::addCssClass($headerOptions, 'tab');
201			}
202
203			// Add disabled tab and content
204			if (ArrayHelper::remove($item, 'disabled')) {
205			Html::addCssClass($headerOptions, 'disabled');
206			}
207
208			// Add tab header
209			if (isset($item['url'])) {
210			$linkOptions['target'] = isset($linkOptions['target']) ? $linkOptions['target'] : '_self';
211			$header = Html::a($label, $item['url'], $linkOptions);
212			} else {
213			$header = Html::a($label, '#' . $options['id'], $linkOptions);
214			}
215
216			// Add tab content
217			if ($this->renderTabContent) {
218			$tag = ArrayHelper::remove($options, 'tag', 'div');
219			$content = Html::tag($tag, isset($item['content']) ? $item['content'] : '', $options);
220			} else {
221			$content = null;
222			}
223
224			$header = Html::tag('li', $header, $headerOptions);
225			}
226
227			return [$header, $content];
			0 ignored issues – show Comprehensibility Best Practice introduced 2019-05-25 11:46 UTC by Report Bug Copy Issue Report The variable `$header` does not seem to be defined for all execution paths leading up to this point. Loading history... Comprehensibility Best Practice introduced 2019-05-25 11:46 UTC by Report Bug Copy Issue Report The variable `$content` does not seem to be defined for all execution paths leading up to this point. Loading history...
228			}
229
230			/**
231			* Searches for active tab value in [[items]]
232			* @return boolean if there's active tab defined
233			*/
234			protected function hasActiveTab()
235			{
236			foreach ($this->items as $item) {
237			if (isset($item['active']) && $item['active'] === true) {
238			return true;
239			}
240			}
241
242			return false;
243			}
244			}
245

DMGPage / yii2-materialize

Branch — master (d57a25)

Tabs::renderItem() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like