Yiisoft\Yii\Bootstrap5\Alert

Complexity

Total Complexity

16

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Test Coverage

Coverage

80.56%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	withCloseButtonDisabled()	0	6	1
A	run()	0	11	2
A	renderCloseButton()	0	14	4
A	initOptions()	0	24	4
A	renderBodyEnd()	0	3	1
A	withEncodeTags()	0	6	1
A	withOptions()	0	6	1
A	withBody()	0	6	1
A	withCloseButton()	0	6	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Bootstrap5;

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

/**
 * Alert renders an alert bootstrap component.
 *
 * For example,
 *
 * ```php
 * echo Alert::widget()
 *     ->withOptions([
 *         'class' => 'alert-info',
 *     ])
 *     ->withBody('Say hello...');
 * ```
 */
final class Alert extends Widget
{
    private ?string $body = null;
    private array $closeButton = [];
    private bool $closeButtonEnabled = true;
    private bool $encodeTags = false;
    private array $options = [];

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

        $this->initOptions();

        $this->registerPlugin('alert', $this->options);

        return Html::div($this->renderBodyEnd(), $this->options);
    }

    /**
     * Renders the alert body and the close button (if any).
     *
     * @throws JsonException
     *
     * @return string the rendering result
     */
    protected function renderBodyEnd(): string
    {
        return $this->body . "\n" . $this->renderCloseButton() . "\n";
    }

    /**
     * Renders the close button.
     *
     * @throws JsonException
     *
     * @return string the rendering result
     */
    protected function renderCloseButton(): ?string
    {
        if ($this->closeButtonEnabled === false) {
            return null;
        }

        $tag = ArrayHelper::remove($this->closeButton, 'tag', 'button');
        $label = ArrayHelper::remove($this->closeButton, 'label', '');

        if ($tag === 'button' && !isset($this->closeButton['type'])) {
            $this->closeButton['type'] = 'button';
        }

        return Html::tag($tag, $label, $this->closeButton);
    }

    /**
     * Initializes the widget options.
     *
     * This method sets the default values for various options.
     */
    protected function initOptions(): void
    {
        Html::addCssClass($this->options, ['widget' => 'alert']);

        if ($this->closeButtonEnabled !== false) {
            $this->closeButton = array_merge(
                $this->closeButton,
                [
                    'aria-label' => 'Close',
                    'data-bs-dismiss' => 'alert',
                ],
            );

            Html::addCssclass($this->closeButton, 'btn-close');
            Html::addCssClass($this->options, ['alert-dismissible']);
        }

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

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

    /**
     * The body content in the alert component. Alert widget will also be treated as the body content, and will be
     * rendered before this.
     *
     * @param string|null $value
     *
     * @return $this
     */
    public function withBody(?string $value): self
    {
        $new = clone $this;
        $new->body = $value;

        return $new;
    }

    /**
     * The options for rendering the close button tag.
     *
     * The close button is displayed in the header of the modal window. Clicking on the button will hide the modal
     * window. If {@see closeButtonEnabled} is false, no close button will be rendered.
     *
     * The following special options are supported:
     *
     * - tag: string, the tag name of the button. Defaults to 'button'.
     * - label: string, the label of the button. Defaults to '&times;'.
     *
     * The rest of the options will be rendered as the HTML attributes of the button tag.
     *
     * Please refer to the [Alert documentation](http://getbootstrap.com/components/#alerts) for the supported HTML
     * attributes.
     *
     * @param array $value
     *
     * @return $this
     */
    public function withCloseButton(array $value): self
    {
        $new = clone $this;
        $new->closeButton = $value;

        return $new;
    }

    /**
     * Disable close button.
     *
     * @param bool $value
     *
     * @return $this
     */
    public function withCloseButtonDisabled(bool $value = false): self
    {
        $new = clone $this;
        $new->closeButtonEnabled = $value;

        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 $this
     */
    public function withOptions(array $value): self
    {
        $new = clone $this;
        $new->options = $value;

        return $new;
    }

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

        return $new;
    }
}