Collection::renderAvatar() - Code Metrics - Inspection of "Added collection widget" - DMGPage/yii2-materialize - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 73f50c...734467 )

by Dmitrijs

created 2021-03-09 20:19 UTC

Collection::renderAvatar() B

↳ Parent: Collection

Complexity

Conditions	10
Paths	34

Size

Total Lines	29
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	20
c	1
b	0
f	0
dl	0
loc	29
rs	7.6666
cc	10
nc	34
nop	1

How to fix Complexity

<?php
namespace dmgpage\yii2materialize\widgets;

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

/**
 * Collections allow you to group list objects together.
 *
 * ```php
 * echo Collection::widget([
 *     'items' => [
 *         [
 *             'label' => '<h5>Best Panda</h5>',
 *             'encode' => false,
 *             'header' => true
 *         ],
 *         [
 *             'label' => 'Kung Fu Panda',
 *             'secondary' => [
 *                 'icon' => [
 *                     'name' => 'favorite',
 *                     'options' =>  ['class' => 'red-text'],
 *                 ],
 *                 'url' => '#',
 *                 'options' => ['target' => '_blank']
 *             ]
 *         ],
 *         [
 *             'label' => 'Kung Fu Panda',
 *             'secondary' => ['icon' => 'favorite']
 *         ],
 *         [
 *             'label' => 'Kung Fu Panda',
 *             'secondary' => ['icon' => 'favorite']
 *         ],
 *         [
 *             'label' => 'Kung Fu Panda',
 *             'secondary' => ['icon' => 'favorite']
 *         ]
 *     ]
 * ]);
 * ```
 * @see https://materializecss.com/collections.html
 * @package widgets
 */
class Collection extends Widget
{
    /**
     * @var array list of items in the collection widget. Each array element represents a single
     * row with the following structure:
     *
     * - avatar: array, optional, options for creating avatar content. Available options are:
     *   - icon: string|array, optional, the options for the icon. See [[Html::icon()]]
     *   - image: string|array, optional, the options for the avatar image. See [[Html::img()]]
     *   - title: string, title for the item avatar. Value will be HTML-encoded.
     *   - titleOptions: array the HTML attributes for the title tag.
     * - label: string, required, the item label.
     * - header: boolean, optional, whether this label should be formatted as header.
     * - encode: boolean, optional, whether this label should be HTML-encoded. This param will override
     *   global `$this->encodeLabels` param.
     * - options: array, optional, the HTML attributes of the item container (LI).
     * - url: array|string, optional, the URL for the hyperlink tag. Defaults to "#".
     * - linkOptions: array, optional, the HTML attributes of the item's link.
     * - active: boolean, optional, whether this item should be active.
     * - visible: boolean, optional, whether the item tab header and pane should be visible or not. Defaults to true.
     * - secondary: array, optional, options for creating secondary content. Available options are:
     *   - icon: string|array, required, the options for the icon. See [[Html::icon()]]
     *   - options: array, optional, the HTML attributes of the icon link.
     *     for more description.
     *   - url: array|string, optional, the URL for the icon. Defaults to "#".
     */
    public $items = [];

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

    /**
     * @var boolean weather format each item as a link
     */
    public $asLinks = false;

    /**
     * Initializes the widget.
     */
    public function init()
    {
        parent::init();

        Html::addCssClass($this->options, ['widget' => 'collection']);

        if ($this->hasHeader()) {
            Html::addCssClass($this->options, ['header' => 'with-header']);
        }
    }

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

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

        foreach ($this->items as $item) {
            $rows[] = $this->renderItem($item);
        }

        $containerTag = $this->asLinks ? 'div' : 'ul';
        $html = Html::beginTag($containerTag, $this->options);
        $html .= implode("\n", $rows);
        $html .= Html::endTag($containerTag);

        return $html;
    }

    /**
     * Renders single collection item as specified on [[items]].
     *
     * @param array $item single collection element
     * @return string the rendering result
     * @throws InvalidConfigException.
     */
    protected function renderItem($item)
    {
        if (!array_key_exists('label', $item)) {
            throw new InvalidConfigException("The 'label' option is required.");
        } elseif (ArrayHelper::remove($item, 'visible', true)) {
            $itemContent = null;
            $encodeLabel = isset($item['encode']) ? $item['encode'] : $this->encodeLabels;
            $label = $encodeLabel ? Html::encode($item['label']) : $item['label'];
            $isHeader = ArrayHelper::getValue($item, 'header', false);
            $avatar = ArrayHelper::remove($item, 'avatar', []);
            $defaultUrl = $this->asLinks ? '#' : null;
            $url = ArrayHelper::getValue($item, 'url', $defaultUrl);
            $linkOptions = ArrayHelper::getValue($item, 'linkOptions', []);
            $options = ArrayHelper::getValue($item, 'options', []);
            $isActive = ArrayHelper::getValue($item, 'active', false);
            $containerClass = $isHeader ? 'collection-header' : 'collection-item';
            $secondaryItem = ArrayHelper::getValue($item, 'secondary', []);
            Html::addCssClass($options, ['item' => $containerClass]);

            if ($isActive) {
                Html::addCssClass($options, ['active' => 'active']);
            }

            // Avatar
            if (!empty($avatar) && !$isHeader) {
                Html::addCssClass($options, ['avatar' => 'avatar']);
                $itemContent .= $this->renderAvatar($avatar);
            }

            // Main content
            if (!$this->asLinks && !empty($url)) {
                $itemContent .= Html::a($label, $url, $linkOptions);
            } else {
                $itemContent .= $label;
            }

            // Secondary content
            $itemContent .= $this->renderSecondary($secondaryItem, $isHeader);

            // Item container
            if ($this->asLinks) {
                $html = Html::a($itemContent, $url, $options);
            } else {
                $html = Html::tag('li', $itemContent, $options);
            }

            return $html;
        }
    }

    /**
     * Renders single avatar image or icon as specified on [[avatar]].
     *
     * @param array $avatar single avatar item
     * @param bool $isHeader whether this label should be formatted as header
     * @return string the rendering result
     *
     * @throws InvalidConfigException.
     * @see https://materializecss.com/collections.html#secondary
     */
    protected function renderAvatar($avatar)
    {
        $content = null;
        $image = ArrayHelper::getValue($avatar, 'image', []);
        $icon = ArrayHelper::getValue($avatar, 'icon', []);
        $title = ArrayHelper::getValue($avatar, 'title', null);
        $titleOptions = ArrayHelper::getValue($avatar, 'titleOptions', []);

        // Avatar
        if (!empty($image)) {
            $url = is_string($image) ? $image : ArrayHelper::remove($image, 'url', '#');
            $options = is_array($image) ? ArrayHelper::getValue($image, 'options', []) : [];
            $options['class'] = isset($options['class']) ? $options['class'] : 'circle';
            $content .= Html::img($url, $options);
        } elseif (!empty($icon)) {
            $name = is_string($icon) ? $icon : ArrayHelper::remove($icon, 'name', null);
            $options = is_array($icon) ? ArrayHelper::getValue($icon, 'options', []) : [];
            $options['class'] = isset($options['class']) ? $options['class'] : 'circle';
            $content .= Html::icon($name, $options);
        }

        // Title
        if (!empty($title)) {
            $title = Html::encode($title);
            Html::addCssClass($titleOptions, ['title' => 'title']);
            $content .= Html::tag('span', $title, $titleOptions);
        }

        return $content;
    }

    /**
     * Renders single secondary content item as specified on [[secondary]].
     *
     * @param array $item single secondary content element
     * @param bool $isHeader whether this label should be formatted as header
     * @return string the rendering result
     *
     * @throws InvalidConfigException.
     * @see https://materializecss.com/collections.html#secondary
     */
    protected function renderSecondary($item, $isHeader)
    {
        $content = null;

        if (!empty($item) && !$isHeader && !array_key_exists('icon', $item)) {
            throw new InvalidConfigException("The 'icon' option is required for secondary content.");
        } else if (!empty($item) && !$isHeader) {
            $url = ArrayHelper::getValue($item, 'url', '#');
            $options = ArrayHelper::getValue($item, 'options', []);

            Html::addCssClass($options, ['secondary' => 'secondary-content']);

            $icon = $this->renderIcon($item['icon']);
            $content = Html::a($icon, $url, $options);
        }

        return $content;
    }

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

        return false;
    }
}


1			<?php
2			namespace dmgpage\yii2materialize\widgets;
3
4			use dmgpage\yii2materialize\helpers\Html;
5			use yii\helpers\ArrayHelper;
6			use yii\base\InvalidConfigException;
7
8			/**
9			* Collections allow you to group list objects together.
10			*
11			* ```php
12			* echo Collection::widget([
13			* 'items' => [
14			* [
15			* 'label' => '<h5>Best Panda</h5>',
16			* 'encode' => false,
17			* 'header' => true
18			* ],
19			* [
20			* 'label' => 'Kung Fu Panda',
21			* 'secondary' => [
22			* 'icon' => [
23			* 'name' => 'favorite',
24			* 'options' => ['class' => 'red-text'],
25			* ],
26			* 'url' => '#',
27			* 'options' => ['target' => '_blank']
28			* ]
29			* ],
30			* [
31			* 'label' => 'Kung Fu Panda',
32			* 'secondary' => ['icon' => 'favorite']
33			* ],
34			* [
35			* 'label' => 'Kung Fu Panda',
36			* 'secondary' => ['icon' => 'favorite']
37			* ],
38			* [
39			* 'label' => 'Kung Fu Panda',
40			* 'secondary' => ['icon' => 'favorite']
41			* ]
42			* ]
43			* ]);
44			* ```
45			* @see https://materializecss.com/collections.html
46			* @package widgets
47			*/
48			class Collection extends Widget
49			{
50			/**
51			* @var array list of items in the collection widget. Each array element represents a single
52			* row with the following structure:
53			*
54			* - avatar: array, optional, options for creating avatar content. Available options are:
55			* - icon: string\|array, optional, the options for the icon. See [[Html::icon()]]
56			* - image: string\|array, optional, the options for the avatar image. See [[Html::img()]]
57			* - title: string, title for the item avatar. Value will be HTML-encoded.
58			* - titleOptions: array the HTML attributes for the title tag.
59			* - label: string, required, the item label.
60			* - header: boolean, optional, whether this label should be formatted as header.
61			* - encode: boolean, optional, whether this label should be HTML-encoded. This param will override
62			* global `$this->encodeLabels` param.
63			* - options: array, optional, the HTML attributes of the item container (LI).
64			* - url: array\|string, optional, the URL for the hyperlink tag. Defaults to "#".
65			* - linkOptions: array, optional, the HTML attributes of the item's link.
66			* - active: boolean, optional, whether this item should be active.
67			* - visible: boolean, optional, whether the item tab header and pane should be visible or not. Defaults to true.
68			* - secondary: array, optional, options for creating secondary content. Available options are:
69			* - icon: string\|array, required, the options for the icon. See [[Html::icon()]]
70			* - options: array, optional, the HTML attributes of the icon link.
71			* for more description.
72			* - url: array\|string, optional, the URL for the icon. Defaults to "#".
73			*/
74			public $items = [];
75
76			/**
77			* @var boolean whether the labels for items should be HTML-encoded.
78			*/
79			public $encodeLabels = true;
80
81			/**
82			* @var boolean weather format each item as a link
83			*/
84			public $asLinks = false;
85
86			/**
87			* Initializes the widget.
88			*/
89			public function init()
90			{
91			parent::init();
92
93			Html::addCssClass($this->options, ['widget' => 'collection']);
94
95			if ($this->hasHeader()) {
96			Html::addCssClass($this->options, ['header' => 'with-header']);
97			}
98			}
99
100			/**
101			* Renders the widget.
102			*/
103			public function run()
104			{
105			$this->initializePlugin = true;
106			$this->registerPlugin('collection');
107			return $this->renderItems();
108			}
109
110			/**
111			* Renders tab items as specified on [[items]].
112			*
113			* @return string the rendering result.
114			* @throws InvalidConfigException.
115			*/
116			protected function renderItems()
117			{
118			$rows = [];
119
120			foreach ($this->items as $item) {
121			$rows[] = $this->renderItem($item);
122			}
123
124			$containerTag = $this->asLinks ? 'div' : 'ul';
125			$html = Html::beginTag($containerTag, $this->options);
126			$html .= implode("\n", $rows);
127			$html .= Html::endTag($containerTag);
128
129			return $html;
130			}
131
132			/**
133			* Renders single collection item as specified on [[items]].
134			*
135			* @param array $item single collection element
136			* @return string the rendering result
137			* @throws InvalidConfigException.
138			*/
139			protected function renderItem($item)
140			{
141			if (!array_key_exists('label', $item)) {
142			throw new InvalidConfigException("The 'label' option is required.");
143			} elseif (ArrayHelper::remove($item, 'visible', true)) {
144			$itemContent = null;
145			$encodeLabel = isset($item['encode']) ? $item['encode'] : $this->encodeLabels;
146			$label = $encodeLabel ? Html::encode($item['label']) : $item['label'];
147			$isHeader = ArrayHelper::getValue($item, 'header', false);
148			$avatar = ArrayHelper::remove($item, 'avatar', []);
149			$defaultUrl = $this->asLinks ? '#' : null;
150			$url = ArrayHelper::getValue($item, 'url', $defaultUrl);
151			$linkOptions = ArrayHelper::getValue($item, 'linkOptions', []);
152			$options = ArrayHelper::getValue($item, 'options', []);
153			$isActive = ArrayHelper::getValue($item, 'active', false);
154			$containerClass = $isHeader ? 'collection-header' : 'collection-item';
155			$secondaryItem = ArrayHelper::getValue($item, 'secondary', []);
156			Html::addCssClass($options, ['item' => $containerClass]);
157
158			if ($isActive) {
159			Html::addCssClass($options, ['active' => 'active']);
160			}
161
162			// Avatar
163			if (!empty($avatar) && !$isHeader) {
164			Html::addCssClass($options, ['avatar' => 'avatar']);
165			$itemContent .= $this->renderAvatar($avatar);
166			}
167
168			// Main content
169			if (!$this->asLinks && !empty($url)) {
170			$itemContent .= Html::a($label, $url, $linkOptions);
171			} else {
172			$itemContent .= $label;
173			}
174
175			// Secondary content
176			$itemContent .= $this->renderSecondary($secondaryItem, $isHeader);
177
178			// Item container
179			if ($this->asLinks) {
180			$html = Html::a($itemContent, $url, $options);
181			} else {
182			$html = Html::tag('li', $itemContent, $options);
183			}
184
185			return $html;
186			}
187			}
188
189			/**
190			* Renders single avatar image or icon as specified on [[avatar]].
191			*
192			* @param array $avatar single avatar item
193			* @param bool $isHeader whether this label should be formatted as header
194			* @return string the rendering result
195			*
196			* @throws InvalidConfigException.
197			* @see https://materializecss.com/collections.html#secondary
198			*/
199			protected function renderAvatar($avatar)
200			{
201			$content = null;
202			$image = ArrayHelper::getValue($avatar, 'image', []);
203			$icon = ArrayHelper::getValue($avatar, 'icon', []);
204			$title = ArrayHelper::getValue($avatar, 'title', null);
205			$titleOptions = ArrayHelper::getValue($avatar, 'titleOptions', []);
206
207			// Avatar
208			if (!empty($image)) {
209			$url = is_string($image) ? $image : ArrayHelper::remove($image, 'url', '#');
210			$options = is_array($image) ? ArrayHelper::getValue($image, 'options', []) : [];
211			$options['class'] = isset($options['class']) ? $options['class'] : 'circle';
212			$content .= Html::img($url, $options);
213			} elseif (!empty($icon)) {
214			$name = is_string($icon) ? $icon : ArrayHelper::remove($icon, 'name', null);
215			$options = is_array($icon) ? ArrayHelper::getValue($icon, 'options', []) : [];
216			$options['class'] = isset($options['class']) ? $options['class'] : 'circle';
217			$content .= Html::icon($name, $options);
218			}
219
220			// Title
221			if (!empty($title)) {
222			$title = Html::encode($title);
223			Html::addCssClass($titleOptions, ['title' => 'title']);
224			$content .= Html::tag('span', $title, $titleOptions);
225			}
226
227			return $content;
228			}
229
230			/**
231			* Renders single secondary content item as specified on [[secondary]].
232			*
233			* @param array $item single secondary content element
234			* @param bool $isHeader whether this label should be formatted as header
235			* @return string the rendering result
236			*
237			* @throws InvalidConfigException.
238			* @see https://materializecss.com/collections.html#secondary
239			*/
240			protected function renderSecondary($item, $isHeader)
241			{
242			$content = null;
243
244			if (!empty($item) && !$isHeader && !array_key_exists('icon', $item)) {
245			throw new InvalidConfigException("The 'icon' option is required for secondary content.");
246			} else if (!empty($item) && !$isHeader) {
247			$url = ArrayHelper::getValue($item, 'url', '#');
248			$options = ArrayHelper::getValue($item, 'options', []);
249
250			Html::addCssClass($options, ['secondary' => 'secondary-content']);
251
252			$icon = $this->renderIcon($item['icon']);
253			$content = Html::a($icon, $url, $options);
254			}
255
256			return $content;
257			}
258
259			/**
260			* Searches for header value in [[items]]
261			* @return boolean if there's header defined
262			*/
263			protected function hasHeader()
264			{
265			foreach ($this->items as $item) {
266			if (isset($item['header']) && $item['header'] === true) {
267			return true;
268			}
269			}
270
271			return false;
272			}
273			}
274

DMGPage / yii2-materialize

Push — master ( 73f50c...734467 )

Collection::renderAvatar() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like