Yiisoft\Yii\Bootstrap5\Carousel

Complexity

Total Complexity

29

Size/Duplication

Total Lines	275
Duplicated Lines	0 %

Test Coverage

Coverage

73.91%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	run()	0	20	4
A	withCrossfade()	0	6	1
A	withEncodeTags()	0	6	1
A	withItems()	0	6	1
A	withControls()	0	6	1
A	renderItems()	0	15	3
A	withoutShowIndicators()	0	6	1
A	renderIndicators()	0	24	5
B	renderItem()	0	37	7
A	withOptions()	0	6	1
A	renderControls()	0	30	4

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Bootstrap5;

use JsonException;
use RuntimeException;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Html\Html;

use function count;
use function implode;
use function is_string;

/**
 * Carousel renders a carousel bootstrap javascript component.
 *
 * For example:
 *
 * ```php
 * echo Carousel::widget()
 *     ->withItems([
 *         // the item contains only the image
 *         '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-01.jpg"/>',
 *         // equivalent to the above
 *         ['content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-02.jpg"/>'],
 *         // the item contains both the image and the caption
 *         [
 *             'content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-03.jpg"/>',
 *             'caption' => '<h4>This is title</h4><p>This is the caption text</p>',
 *             'captionOptions' => ['class' => ['d-none', 'd-md-block']],
 *             'options' => [...],
 *         ],
 *     ]);
 * ```
 */
final class Carousel extends Widget
{
    private array $controls = [
        '<span class="carousel-control-prev-icon" aria-hidden="true"></span><span class="visually-hidden">Previous</span>',
        '<span class="carousel-control-next-icon" aria-hidden="true"></span><span class="visually-hidden">Next</span>',
    ];
    private bool $encodeTags = false;
    private bool $showIndicators = true;
    private array $items = [];
    private bool $crossfade = false;
    private array $options = ['data-bs-ride' => 'carousel'];

    public function run(): string
    {
        if (!isset($this->options['id'])) {
            $this->options['id'] = "{$this->getId()}-carousel";
        }

        /** @psalm-suppress InvalidArgument */
        Html::addCssClass($this->options, ['widget' => 'carousel', 'slide']);

        if ($this->crossfade) {
            Html::addCssClass($this->options, 'carousel-fade');
        }

        if ($this->encodeTags === false) {
            $this->options = array_merge($this->options, ['encode' => false]);
        }

        return Html::div(
            $this->renderIndicators() . $this->renderItems() . $this->renderControls(),
            $this->options
        );
    }

    /**
     * The labels for the previous and the next control buttons.
     *
     * If null, it means the previous and the next control buttons should not be displayed.
     *
     * @param array|null $value
     *
     * @return $this
     */
    public function withControls(array $value): self
    {
        $new = clone $this;
        $new->controls = $value;

        return $new;
    }

    /**
     * Animate slides with a fade transition instead of a slide. Defaults to `false`.
     *
     * @param bool $value
     *
     * @return $this
     */
    public function withCrossfade(bool $value): self
    {
        $new = clone $this;
        $new->crossfade = $value;

        return $new;
    }

    /**
     * List of slides in the carousel. Each array element represents a single slide with the following structure:
     *
     * ```php
     * [
     *     // required, slide content (HTML), such as an image tag
     *     'content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-01.jpg"/>',
     *     // optional, the caption (HTML) of the slide
     *     'caption' => '<h4>This is title</h4><p>This is the caption text</p>',
     *     // optional the HTML attributes of the slide container
     *     'options' => [],
     * ]
     * ```
     *
     * @param array $value
     *
     * @return $this
     */
    public function withItems(array $value): self
    {
        $new = clone $this;
        $new->items = $value;

        return $new;
    }

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

        return $new;
    }

    /**
     * Whether carousel indicators (<ol> tag with anchors to items) should be displayed or not.
     *
     * @param bool $value
     *
     * @return $this
     */
    public function withoutShowIndicators(bool $value = false): self
    {
        $new = clone $this;
        $new->showIndicators = $value;

        return $new;
    }

    /**
     * Allows you to enable or disable the encoding tags html.
     *
     * @param bool $value
     *
     * @return self
     */
    public function withEncodeTags(bool $value = true): self
    {
        $new = clone $this;
        $new->encodeTags = $value;

        return $new;
    }

    /**
     * Renders carousel indicators.
     */
    private function renderIndicators(): string
    {
        if ($this->showIndicators === false) {
            return '';
        }

        $indicators = [];

        for ($i = 0, $count = count($this->items); $i < $count; $i++) {
            $options = ['data-bs-target' => '#' . $this->options['id'], 'data-bs-slide-to' => $i];
            if ($i === 0) {
                /** @psalm-suppress InvalidArgument */
                Html::addCssClass($options, 'active');
            }
            $indicators[] = Html::tag('li', '', $options);
        }

        $indicatorOptions = ['class' => ['carousel-indicators']];

        if ($this->encodeTags === false) {
            $indicatorOptions = array_merge($indicatorOptions, ['encode' => false]);
        }

        return Html::tag('ol', implode("\n", $indicators), $indicatorOptions);
    }

    /**
     * Renders carousel items as specified on {@see items}.
     */
    private function renderItems(): string
    {
        $items = [];

        foreach ($this->items as $i => $iValue) {
            $items[] = $this->renderItem($iValue, $i);
        }

        $itemOptions = ['class' => 'carousel-inner'];

        if ($this->encodeTags === false) {
            $itemOptions = array_merge($itemOptions, ['encode' => false]);
        }

        return Html::div(implode("\n", $items), $itemOptions);
    }

    /**
     * Renders a single carousel item
     *
     * @param array|string $item a single item from {@see items}
     * @param int $index the item index as the first item should be set to `active`
     *
     * @throws JsonException|RuntimeException if the item is invalid.
     *
     * @return string the rendering result.
     */
    private function renderItem($item, int $index): string
    {
        if (is_string($item)) {
            $content = $item;
            $caption = null;
            $options = [];
        } elseif (isset($item['content'])) {
            $content = $item['content'];
            $caption = ArrayHelper::getValue($item, 'caption');

            if ($caption !== null) {
                $captionOptions = ArrayHelper::remove($item, 'captionOptions', []);
                Html::addCssClass($captionOptions, ['widget' => 'carousel-caption']);

                if ($this->encodeTags === false) {
                    $captionOptions = array_merge($captionOptions, ['encode' => false]);
                }

                $caption = Html::div($caption, $captionOptions);
            }

            $options = ArrayHelper::getValue($item, 'options', []);
        } else {
            throw new RuntimeException('The "content" option is required.');
        }

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

        if ($this->encodeTags === false) {
            $options = array_merge($options, ['encode' => false]);
        }

        if ($index === 0) {
            Html::addCssClass($options, 'active');
        }

        return Html::div($content . "\n" . $caption, $options);
    }

    /**
     * Renders previous and next control buttons.
     *
     * @throws JsonException|RuntimeException if {@see controls} is invalid.
     *
     * @return string
     */
    private function renderControls(): string
    {
        $controlsOptions0 = [
            'class' => 'carousel-control-prev',
            'data-bs-slide' => 'prev',
            'role' => 'button',
        ];

        $controlsOptions1 = [
            'class' => 'carousel-control-next',
            'data-bs-slide' => 'next',
            'role' => 'button',
        ];

        if ($this->encodeTags === false) {
            $controlsOptions0 = array_merge($controlsOptions0, ['encode' => false]);
            $controlsOptions1 = array_merge($controlsOptions1, ['encode' => false]);
        }

        if (isset($this->controls[0], $this->controls[1])) {
            return Html::a($this->controls[0], '#' . $this->options['id'], $controlsOptions0) . "\n" .
                Html::a($this->controls[1], '#' . $this->options['id'], $controlsOptions1);
        }

        if ($this->controls === []) {
            return '';
        }

        throw new RuntimeException(
            'The "controls" property must be either null or an array of two elements.'
        );
    }
}