Accordion::getHeaderId() - Code Metrics - Inspection of "Use reusables actions." - yiisoft/yii-bootstrap5 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#87)

by Wilmer

created 2022-05-16 10:55 UTC

Accordion::getHeaderId() A

↳ Parent: Accordion

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Bootstrap5;

use JsonException;
use RuntimeException;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Html\Html;
use function array_key_exists;
use function array_merge;
use function implode;
use function is_array;
use function is_numeric;
use function is_string;

/**
 * Accordion renders an accordion bootstrap JavaScript component.
 *
 * For example:
 *
 * ```php
 * echo Accordion::widget()
 *     ->items([
 *         [
 *             'label' => 'Accordion Item #1',
 *             'content' => [
 *                 'This is the first items accordion body. It is shown by default, until the collapse plugin ' .
 *                 'the appropriate classes that we use to style each element. These classes control the ' .
 *                 'overall appearance, as well as the showing and hiding via CSS transitions. You can  ' .
 *                 'modify any of this with custom CSS or overriding our default variables. Its also worth ' .
 *                 'noting that just about any HTML can go within the .accordion-body, though the transition ' .
 *                 'does limit overflow.',
 *             ],
 *         ],
 *         [
 *             'label' => 'Accordion Item #2',
 *             'content' => '<strong>This is the second items accordion body.</strong> It is hidden by default, ' .
 *                 'until the collapse plugin adds the appropriate classes that we use to style each element. ' .
 *                 'These classes control the overall appearance, as well as the showing and hiding via CSS ' .
 *                 'transitions. You can modify any of this with custom CSS or overriding our default ' .
 *                 'variables. Its also worth noting that just about any HTML can go within the ' .
 *                 '<code>.accordion-body</code>, though the transition does limit overflow.',
 *             'contentOptions' => [
 *                 'class' => 'testContentOptions',
 *             ],
 *             'options' => [
 *                 'class' => 'testClass',
 *                 'id' => 'testId',
 *             ],
 *         ],
 *         [
 *             'label' => '<b>Accordion Item #3</b>',
 *             'content' => [
 *                 '<b>test content1</b>',
 *                 '<strong>This is the third items accordion body.</strong> It is hidden by default, until the ' .
 *                 'collapse plugin adds the appropriate classes that we use to style each element. These ' .
 *                 'classes control the overall appearance, as well as the showing and hiding via CSS ' .
 *                 'transitions. You can modify any of this with custom CSS or overriding our default ' .
 *                 'variables. Its also worth noting that just about any HTML can go within the ' .
 *                 '<code>.accordion-body</code>, though the transition does limit overflow.',
 *             ],
 *             'contentOptions' => [
 *                 'class' => 'testContentOptions2',
 *             ],
 *             'options' => [
 *                 'class' => 'testClass2',
 *                 'id' => 'testId2',
 *             ],
 *             'encode' => false,
 *         ],
 *     ]);
 * ```
 *
 * @link https://getbootstrap.com/docs/5.0/components/accordion/
 */
final class Accordion extends Widget
{
    private array $items = [];
    private array $expands = [];
    private ?bool $defaultExpand = null;
    private bool $encodeLabels = true;
    private bool $encodeTags = false;
    private bool $autoCloseItems = true;
    private array $headerOptions = [];
    private array $itemToggleOptions = [];
    private array $contentOptions = [];
    private array $options = [];
    private bool $flush = false;

    public function getId(?string $suffix = '-accordion'): ?string
    {
        return $this->options['id'] ?? parent::getId($suffix);
    }

    private function getCollapseId(array $item, int $index): string
    {
        return ArrayHelper::getValueByPath($item, ['contentOptions', 'id'], $this->getId() . '-collapse' . $index);
    }

    private function getHeaderId(array $item, int $index): string
    {
        return ArrayHelper::getValueByPath($item, ['headerOptions', 'id'], $this->getCollapseId($item, $index) . '-heading');
    }

    public function beforeRun(): bool
    {
        Html::addCssClass($this->options, ['widget' => 'accordion']);

        if ($this->flush) {
            Html::addCssClass($this->options, ['flush' => 'accordion-flush']);
        }

        if (!isset($this->options['id'])) {
            $this->options['id'] = $this->getId();
        }

        return parent::beforeRun();
    }

    protected function run(): string
    {
        return Html::div($this->renderItems(), $this->options)
            ->encode($this->encodeTags)
            ->render();
    }

    /**
     * Whether to close other items if an item is opened. Defaults to `true` which causes an accordion effect.
     *
     * Set this to `false` to allow keeping multiple items open at once.
     *
     * @return self
     */
    public function allowMultipleOpenedItems(): self
    {
        $new = clone $this;
        $new->autoCloseItems = false;

        return $new;
    }

    /**
     * When tags Labels HTML should not be encoded.
     *
     * @return self
     */
    public function withoutEncodeLabels(): self
    {
        $new = clone $this;
        $new->encodeLabels = false;

        return $new;
    }

    /**
     * List of groups in the collapse widget. Each array element represents a single group with the following structure:
     *
     * - label: string, required, the group header label.
     * - encode: bool, optional, whether this label should be HTML-encoded. This param will override global
     *   `$this->encodeLabels` param.
     * - content: array|string|object, required, the content (HTML) of the group
     * - options: array, optional, the HTML attributes of the group
     * - contentOptions: optional, the HTML attributes of the group's content
     *
     * You may also specify this property as key-value pairs, where the key refers to the `label` and the value refers
     * to `content`. If value is a string it is interpreted as label. If it is an array, it is interpreted as explained
     * above.
     *
     * For example:
     *
     * ```php
     * echo Accordion::widget()
     *     ->items(
     *         [
     *             [
     *                 'Introduction' => 'This is the first collapsible menu',
     *                 'Second panel' => [
     *                     'content' => 'This is the second collapsible menu',
     *                 ],
     *             ],
     *             [
     *                 'label' => 'Third panel',
     *                 'content' => 'This is the third collapsible menu',
     *             ],
     *         ],
     *     );
     * ```
     *
     * @param array $value
     *
     * @return self
     */
    public function items(array $value): self
    {
        $new = clone $this;
        $new->items = $value;
        $new->expands = array_map(fn ($item) => isset($item['expand']) ? (bool) $item['expand'] : $this->defaultExpand, $new->items);

        return $new;
    }

    /**
     * Set expand property for items without it
     *
     * @param bool|null $default
     *
     * @return self
     */
    public function defaultExpand(?bool $default): self
    {
        if ($default === $this->defaultExpand) {
            return $this;
        }

        $new = clone $this;
        $new->defaultExpand = $default;
        $new->expands = array_map(fn ($item) => isset($item['expand']) ? (bool) $item['expand'] : $new->defaultExpand, $new->items);

        return $new;
    }

    /**
     * Options for each header if not present in item
     *
     * @param array $options
     *
     * @return self
     */
    public function headerOptions(array $options): self
    {
        $new = clone $this;
        $new->headerOptions = $options;

        return $new;
    }

    /**
     * The HTML options for the item toggle tag. Key 'tag' might be used here for the tag name specification.
     *
     * For example:
     *
     * ```php
     * [
     *     'tag' => 'div',
     *     'class' => 'custom-toggle',
     * ]
     * ```
     *
     * @param array $value
     *
     * @return self
     */
    public function itemToggleOptions(array $value): self
    {
        $new = clone $this;
        $new->itemToggleOptions = $value;

        return $new;
    }

    /**
     * Content options for items if not present in current
     *
     * @param array $options
     *
     * @return self
     */
    public function contentOptions(array $options): self
    {
        $new = clone $this;
        $new->contentOptions = $options;

        return $new;
    }

    /**
     * The HTML attributes for the widget container tag. The following special options are recognized.
     *
     * {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
     *
     * @param array $value
     *
     * @return self
     */
    public function options(array $value): self
    {
        $new = clone $this;
        $new->options = $value;

        return $new;
    }

    /**
     * Remove the default background-color, some borders, and some rounded corners to render accordions
     * edge-to-edge with their parent container.
     *
     * @return self
     *
     * @link https://getbootstrap.com/docs/5.0/components/accordion/#flush
     */
    public function flush(): self
    {
        $new = clone $this;
        $new->flush = true;

        return $new;
    }

    /**
     * Renders collapsible items as specified on {@see items}.
     *
     * @throws JsonException|RuntimeException
     *
     * @return string the rendering result
     */
    private function renderItems(): string
    {
        $items = [];
        $index = 0;
        $expanded = in_array(true, $this->expands, true);
        $allClose = !$expanded && count($this->items) === count(array_filter($this->expands, fn ($expand) => $expand === false));

        foreach ($this->items as $item) {
            if (!is_array($item)) {
                $item = ['content' => $item];
            }

            if ($allClose === false && $expanded === false && $index === 0) {
                $item['expand'] = true;
            }

            if (!array_key_exists('label', $item)) {
                throw new RuntimeException('The "label" option is required.');
            }

            $options = ArrayHelper::getValue($item, 'options', []);
            $item = $this->renderItem($item, $index++);

            Html::addCssClass($options, ['panel' => 'accordion-item']);

            $items[] = Html::div($item, $options)->encode(false)->render();
        }

        return implode('', $items);
    }

    /**
     * Renders a single collapsible item group.
     *
     * @param string $label a label of the item group {@see items}
     * @param array $item a single item from {@see items}
     * @param int $index the item index as each item group content must have an id
     *
     * @throws JsonException|RuntimeException
     *
     * @return string the rendering result
     */
    private function renderItem(array $item, int $index): string
    {
        if (!array_key_exists('content', $item)) {
            throw new RuntimeException('The "content" option is required.');
        }

        $header = $this->renderHeader($item, $index);
        $collapse = $this->renderCollapse($item, $index);

        return $header . $collapse;
    }

    /**
     * Render collapse header
     *
     * @param array $item
     * @param int $index
     *
     * @return string
     */
    private function renderHeader(array $item, int $index): string
    {
        $options = ArrayHelper::getValue($item, 'headerOptions', $this->headerOptions);
        $tag = ArrayHelper::remove($options, 'tag', 'h2');
        $options['id'] = $this->getHeaderId($item, $index);
        $toggle = $this->renderToggle($item, $index);

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

        return Html::tag($tag, $toggle, $options)->encode(false)->render();
    }

    /**
     * Render collapse switcher
     *
     * @param array $item
     * @param int $index
     *
     * @return string
     */
    private function renderToggle(array $item, int $index): string
    {
        $label = $item['label'];
        $expand = $item['expand'] ?? false;
        $collapseId = $this->getCollapseId($item, $index);

        $options = array_merge(
            [
                'data-bs-toggle' => 'collapse',
                'aria-expanded' => $expand ? 'true' : 'false',
                'aria-controls' => $collapseId,
            ],
            $item['toggleOptions'] ?? $this->itemToggleOptions
        );
        $tag = ArrayHelper::remove($options, 'tag', 'button');
        $encode = ArrayHelper::remove($options, 'encode', $this->encodeLabels);

        Html::addCssClass($options, ['accordion-button']);

        if (!$expand) {
            Html::addCssClass($options, ['collapsed']);
        }

        if ($tag === 'a') {
            $options['href'] = '#' . $collapseId;
        } else {
            $options['data-bs-target'] = '#' . $collapseId;

            if ($tag === 'button' && !isset($options['type'])) {
                $options['type'] = 'button';
            }
        }

        return Html::tag($tag, $label, $options)->encode($encode)->render();
    }

    /**
     * Render collapse item
     *
     * @param array $item
     * @param int $index
     *
     * @return string
     */
    private function renderCollapse(array $item, int $index): string
    {
        $expand = $item['expand'] ?? false;
        $options = $item['contentOptions'] ?? $this->contentOptions;
        $tag = ArrayHelper::remove($options, 'tag', 'div');
        $body = $this->renderBody($item);
        $options['id'] = $this->getCollapseId($item, $index);

        Html::addCssClass($options, ['accordion-collapse collapse']);

        if ($expand) {
            Html::addCssClass($options, ['show']);
        }

        if (!isset($options['aria-label'], $options['aria-labelledby'])) {
            $options['aria-labelledby'] = $this->getHeaderId($item, $index);
        }

        if ($this->autoCloseItems) {
            $options['data-bs-parent'] = '#' . $this->getId();
        }

        return Html::tag($tag, $body, $options)->encode(false)->render();
    }

    /**
     * Render collapse body
     *
     * @param array $item
     *
     * @return string
     */
    private function renderBody(array $item): string
    {
        $items = '';

        if ($this->isStringableObject($item['content'])) {
            $content = [$item['content']];
        } else {
            $content = (array) $item['content'];
        }

        foreach ($content as $value) {
            if (!is_string($value) && !is_numeric($value) && !$this->isStringableObject($value)) {
                throw new RuntimeException('The "content" option should be a string, array or object.');
            }

            $items .= (string) $value;
        }

        return Html::div($items, ['class' => 'accordion-body'])
            ->encode($this->encodeTags)
            ->render();
    }

    private function isStringableObject($value): bool
    {
        return is_object($value) && method_exists($value, '__toString');
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Yii\Bootstrap5;
6
7		use JsonException;
8		use RuntimeException;
9		use Yiisoft\Arrays\ArrayHelper;
10		use Yiisoft\Html\Html;
11		use function array_key_exists;
12		use function array_merge;
13		use function implode;
14		use function is_array;
15		use function is_numeric;
16		use function is_string;
17
18		/**
19		* Accordion renders an accordion bootstrap JavaScript component.
20		*
21		* For example:
22		*
23		* ```php
24		* echo Accordion::widget()
25		* ->items([
26		* [
27		* 'label' => 'Accordion Item #1',
28		* 'content' => [
29		* 'This is the first items accordion body. It is shown by default, until the collapse plugin ' .
30		* 'the appropriate classes that we use to style each element. These classes control the ' .
31		* 'overall appearance, as well as the showing and hiding via CSS transitions. You can ' .
32		* 'modify any of this with custom CSS or overriding our default variables. Its also worth ' .
33		* 'noting that just about any HTML can go within the .accordion-body, though the transition ' .
34		* 'does limit overflow.',
35		* ],
36		* ],
37		* [
38		* 'label' => 'Accordion Item #2',
39		* 'content' => '<strong>This is the second items accordion body.</strong> It is hidden by default, ' .
40		* 'until the collapse plugin adds the appropriate classes that we use to style each element. ' .
41		* 'These classes control the overall appearance, as well as the showing and hiding via CSS ' .
42		* 'transitions. You can modify any of this with custom CSS or overriding our default ' .
43		* 'variables. Its also worth noting that just about any HTML can go within the ' .
44		* '<code>.accordion-body</code>, though the transition does limit overflow.',
45		* 'contentOptions' => [
46		* 'class' => 'testContentOptions',
47		* ],
48		* 'options' => [
49		* 'class' => 'testClass',
50		* 'id' => 'testId',
51		* ],
52		* ],
53		* [
54		* 'label' => '<b>Accordion Item #3</b>',
55		* 'content' => [
56		* '<b>test content1</b>',
57		* '<strong>This is the third items accordion body.</strong> It is hidden by default, until the ' .
58		* 'collapse plugin adds the appropriate classes that we use to style each element. These ' .
59		* 'classes control the overall appearance, as well as the showing and hiding via CSS ' .
60		* 'transitions. You can modify any of this with custom CSS or overriding our default ' .
61		* 'variables. Its also worth noting that just about any HTML can go within the ' .
62		* '<code>.accordion-body</code>, though the transition does limit overflow.',
63		* ],
64		* 'contentOptions' => [
65		* 'class' => 'testContentOptions2',
66		* ],
67		* 'options' => [
68		* 'class' => 'testClass2',
69		* 'id' => 'testId2',
70		* ],
71		* 'encode' => false,
72		* ],
73		* ]);
74		* ```
75		*
76		* @link https://getbootstrap.com/docs/5.0/components/accordion/
77		*/
78		final class Accordion extends Widget
79		{
80		private array $items = [];
81		private array $expands = [];
82		private ?bool $defaultExpand = null;
83		private bool $encodeLabels = true;
84		private bool $encodeTags = false;
85		private bool $autoCloseItems = true;
86		private array $headerOptions = [];
87		private array $itemToggleOptions = [];
88		private array $contentOptions = [];
89		private array $options = [];
90		private bool $flush = false;
91
92	13	public function getId(?string $suffix = '-accordion'): ?string
93		{
94	13	return $this->options['id'] ?? parent::getId($suffix);
95		}
96
97	9	private function getCollapseId(array $item, int $index): string
98		{
99	9	return ArrayHelper::getValueByPath($item, ['contentOptions', 'id'], $this->getId() . '-collapse' . $index);
100		}
101
102	9	private function getHeaderId(array $item, int $index): string
103		{
104	9	return ArrayHelper::getValueByPath($item, ['headerOptions', 'id'], $this->getCollapseId($item, $index) . '-heading');
105		}
106
107	13	public function beforeRun(): bool
108		{
109	13	Html::addCssClass($this->options, ['widget' => 'accordion']);
110
111	13	if ($this->flush) {
112	1	Html::addCssClass($this->options, ['flush' => 'accordion-flush']);
113		}
114
115	13	if (!isset($this->options['id'])) {
116	13	$this->options['id'] = $this->getId();
117		}
118
119	13	return parent::beforeRun();
120		}
121
122	13	protected function run(): string
123		{
124	13	return Html::div($this->renderItems(), $this->options)
125	8	->encode($this->encodeTags)
126	8	->render();
127		}
128
129		/**
130		* Whether to close other items if an item is opened. Defaults to `true` which causes an accordion effect.
131		*
132		* Set this to `false` to allow keeping multiple items open at once.
133		*
134		* @return self
135		*/
136	1	public function allowMultipleOpenedItems(): self
137		{
138	1	$new = clone $this;
139	1	$new->autoCloseItems = false;
140
141	1	return $new;
142		}
143
144		/**
145		* When tags Labels HTML should not be encoded.
146		*
147		* @return self
148		*/
149	1	public function withoutEncodeLabels(): self
150		{
151	1	$new = clone $this;
152	1	$new->encodeLabels = false;
153
154	1	return $new;
155		}
156
157		/**
158		* List of groups in the collapse widget. Each array element represents a single group with the following structure:
159		*
160		* - label: string, required, the group header label.
161		* - encode: bool, optional, whether this label should be HTML-encoded. This param will override global
162		* `$this->encodeLabels` param.
163		* - content: array\|string\|object, required, the content (HTML) of the group
164		* - options: array, optional, the HTML attributes of the group
165		* - contentOptions: optional, the HTML attributes of the group's content
166		*
167		* You may also specify this property as key-value pairs, where the key refers to the `label` and the value refers
168		* to `content`. If value is a string it is interpreted as label. If it is an array, it is interpreted as explained
169		* above.
170		*
171		* For example:
172		*
173		* ```php
174		* echo Accordion::widget()
175		* ->items(
176		* [
177		* [
178		* 'Introduction' => 'This is the first collapsible menu',
179		* 'Second panel' => [
180		* 'content' => 'This is the second collapsible menu',
181		* ],
182		* ],
183		* [
184		* 'label' => 'Third panel',
185		* 'content' => 'This is the third collapsible menu',
186		* ],
187		* ],
188		* );
189		* ```
190		*
191		* @param array $value
192		*
193		* @return self
194		*/
195	13	public function items(array $value): self
196		{
197	13	$new = clone $this;
198	13	$new->items = $value;
199	13	$new->expands = array_map(fn ($item) => isset($item['expand']) ? (bool) $item['expand'] : $this->defaultExpand, $new->items);
200
201	13	return $new;
202		}
203
204		/**
205		* Set expand property for items without it
206		*
207		* @param bool\|null $default
208		*
209		* @return self
210		*/
211	1	public function defaultExpand(?bool $default): self
212		{
213	1	if ($default === $this->defaultExpand) {
214		return $this;
215		}
216
217	1	$new = clone $this;
218	1	$new->defaultExpand = $default;
219	1	$new->expands = array_map(fn ($item) => isset($item['expand']) ? (bool) $item['expand'] : $new->defaultExpand, $new->items);
220
221	1	return $new;
222		}
223
224		/**
225		* Options for each header if not present in item
226		*
227		* @param array $options
228		*
229		* @return self
230		*/
231		public function headerOptions(array $options): self
232		{
233		$new = clone $this;
234		$new->headerOptions = $options;
235
236		return $new;
237		}
238
239		/**
240		* The HTML options for the item toggle tag. Key 'tag' might be used here for the tag name specification.
241		*
242		* For example:
243		*
244		* ```php
245		* [
246		* 'tag' => 'div',
247		* 'class' => 'custom-toggle',
248		* ]
249		* ```
250		*
251		* @param array $value
252		*
253		* @return self
254		*/
255	1	public function itemToggleOptions(array $value): self
256		{
257	1	$new = clone $this;
258	1	$new->itemToggleOptions = $value;
259
260	1	return $new;
261		}
262
263		/**
264		* Content options for items if not present in current
265		*
266		* @param array $options
267		*
268		* @return self
269		*/
270		public function contentOptions(array $options): self
271		{
272		$new = clone $this;
273		$new->contentOptions = $options;
274
275		return $new;
276		}
277
278		/**
279		* The HTML attributes for the widget container tag. The following special options are recognized.
280		*
281		* {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
282		*
283		* @param array $value
284		*
285		* @return self
286		*/
287	1	public function options(array $value): self
288		{
289	1	$new = clone $this;
290	1	$new->options = $value;
291
292	1	return $new;
293		}
294
295		/**
296		* Remove the default background-color, some borders, and some rounded corners to render accordions
297		* edge-to-edge with their parent container.
298		*
299		* @return self
300		*
301		* @link https://getbootstrap.com/docs/5.0/components/accordion/#flush
302		*/
303	1	public function flush(): self
304		{
305	1	$new = clone $this;
306	1	$new->flush = true;
307
308	1	return $new;
309		}
310
311		/**
312		* Renders collapsible items as specified on {@see items}.
313		*
314		* @throws JsonException\|RuntimeException
315		*
316		* @return string the rendering result
317		*/
318	13	private function renderItems(): string
319		{
320	13	$items = [];
321	13	$index = 0;
322	13	$expanded = in_array(true, $this->expands, true);
323	13	$allClose = !$expanded && count($this->items) === count(array_filter($this->expands, fn ($expand) => $expand === false));
324
325	13	foreach ($this->items as $item) {
326	13	if (!is_array($item)) {
327	1	$item = ['content' => $item];
328		}
329
330	13	if ($allClose === false && $expanded === false && $index === 0) {
331	11	$item['expand'] = true;
332		}
333
334	13	if (!array_key_exists('label', $item)) {
335	3	throw new RuntimeException('The "label" option is required.');
336		}
337
338	10	$options = ArrayHelper::getValue($item, 'options', []);
339	10	$item = $this->renderItem($item, $index++);
340
341	8	Html::addCssClass($options, ['panel' => 'accordion-item']);
342
343	8	$items[] = Html::div($item, $options)->encode(false)->render();
344		}
345
346	8	return implode('', $items);
347		}
348
349		/**
350		* Renders a single collapsible item group.
351		*
352		* @param string $label a label of the item group {@see items}
353		* @param array $item a single item from {@see items}
354		* @param int $index the item index as each item group content must have an id
355		*
356		* @throws JsonException\|RuntimeException
357		*
358		* @return string the rendering result
359		*/
360	10	private function renderItem(array $item, int $index): string
361		{
362	10	if (!array_key_exists('content', $item)) {
363	1	throw new RuntimeException('The "content" option is required.');
364		}
365
366	9	$header = $this->renderHeader($item, $index);
367	9	$collapse = $this->renderCollapse($item, $index);
368
369	8	return $header . $collapse;
370		}
371
372		/**
373		* Render collapse header
374		*
375		* @param array $item
376		* @param int $index
377		*
378		* @return string
379		*/
380	9	private function renderHeader(array $item, int $index): string
381		{
382	9	$options = ArrayHelper::getValue($item, 'headerOptions', $this->headerOptions);
383	9	$tag = ArrayHelper::remove($options, 'tag', 'h2');
384	9	$options['id'] = $this->getHeaderId($item, $index);
385	9	$toggle = $this->renderToggle($item, $index);
386
387	9	Html::addCssClass($options, ['widget' => 'accordion-header']);
388
389	9	return Html::tag($tag, $toggle, $options)->encode(false)->render();
390		}
391
392		/**
393		* Render collapse switcher
394		*
395		* @param array $item
396		* @param int $index
397		*
398		* @return string
399		*/
400	9	private function renderToggle(array $item, int $index): string
401		{
402	9	$label = $item['label'];
403	9	$expand = $item['expand'] ?? false;
404	9	$collapseId = $this->getCollapseId($item, $index);
405
406	9	$options = array_merge(
407		[
408	9	'data-bs-toggle' => 'collapse',
409	9	'aria-expanded' => $expand ? 'true' : 'false',
410		'aria-controls' => $collapseId,
411		],
412	9	$item['toggleOptions'] ?? $this->itemToggleOptions
413		);
414	9	$tag = ArrayHelper::remove($options, 'tag', 'button');
415	9	$encode = ArrayHelper::remove($options, 'encode', $this->encodeLabels);
416
417	9	Html::addCssClass($options, ['accordion-button']);
418
419	9	if (!$expand) {
420	8	Html::addCssClass($options, ['collapsed']);
421		}
422
423	9	if ($tag === 'a') {
424	1	$options['href'] = '#' . $collapseId;
425		} else {
426	8	$options['data-bs-target'] = '#' . $collapseId;
427
428	8	if ($tag === 'button' && !isset($options['type'])) {
429	8	$options['type'] = 'button';
430		}
431		}
432
433	9	return Html::tag($tag, $label, $options)->encode($encode)->render();
434		}
435
436		/**
437		* Render collapse item
438		*
439		* @param array $item
440		* @param int $index
441		*
442		* @return string
443		*/
444	9	private function renderCollapse(array $item, int $index): string
445		{
446	9	$expand = $item['expand'] ?? false;
447	9	$options = $item['contentOptions'] ?? $this->contentOptions;
448	9	$tag = ArrayHelper::remove($options, 'tag', 'div');
449	9	$body = $this->renderBody($item);
450	8	$options['id'] = $this->getCollapseId($item, $index);
451
452	8	Html::addCssClass($options, ['accordion-collapse collapse']);
453
454	8	if ($expand) {
455	7	Html::addCssClass($options, ['show']);
456		}
457
458	8	if (!isset($options['aria-label'], $options['aria-labelledby'])) {
459	8	$options['aria-labelledby'] = $this->getHeaderId($item, $index);
460		}
461
462	8	if ($this->autoCloseItems) {
463	8	$options['data-bs-parent'] = '#' . $this->getId();
464		}
465
466	8	return Html::tag($tag, $body, $options)->encode(false)->render();
467		}
468
469		/**
470		* Render collapse body
471		*
472		* @param array $item
473		*
474		* @return string
475		*/
476	9	private function renderBody(array $item): string
477		{
478	9	$items = '';
479
480	9	if ($this->isStringableObject($item['content'])) {
481	1	$content = [$item['content']];
482		} else {
483	9	$content = (array) $item['content'];
484		}
485
486	9	foreach ($content as $value) {
487	9	if (!is_string($value) && !is_numeric($value) && !$this->isStringableObject($value)) {
488	1	throw new RuntimeException('The "content" option should be a string, array or object.');
489		}
490
491	8	$items .= (string) $value;
492		}
493
494	8	return Html::div($items, ['class' => 'accordion-body'])
495	8	->encode($this->encodeTags)
496	8	->render();
497		}
498
499	9	private function isStringableObject($value): bool
500		{
501	9	return is_object($value) && method_exists($value, '__toString');
502		}
503		}
504

yiisoft / yii-bootstrap5

Pull Request — master (#87)

Accordion::getHeaderId() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like