Yiisoft\Yii\Widgets\Alert

Complexity

Total Complexity

43

Size/Duplication

Total Lines	521
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

35 Methods

Rating	Name	Duplication	Size	Complexity
A	body()	0	6	1
A	bodyContainerAttributes()	0	6	1
A	bodyContainerClass()	0	6	1
A	headerClass()	0	6	1
A	headerTag()	0	10	2
A	class()	0	6	1
A	headerContainerClass()	0	6	1
A	buttonLabel()	0	6	1
A	renderHeaderContainer()	0	11	3
A	bodyAttributes()	0	6	1
A	renderBodyContainer()	0	11	2
A	renderBody()	0	5	2
A	iconClass()	0	6	1
A	id()	0	6	1
A	renderIcon()	0	9	1
A	iconContainerClass()	0	6	1
A	bodyClass()	0	6	1
A	renderHeader()	0	3	1
A	headerContainer()	0	6	1
A	attributes()	0	6	1
A	layoutBody()	0	6	1
A	layoutHeader()	0	6	1
A	renderButton()	0	9	1
A	buttonOnClick()	0	6	1
A	buttonClass()	0	6	1
A	header()	0	6	1
A	iconText()	0	6	1
A	buttonAttributes()	0	6	1
A	headerContainerAttributes()	0	6	1
A	headerAttributes()	0	6	1
A	iconAttributes()	0	6	1
A	iconContainerAttributes()	0	6	1
A	bodyContainer()	0	6	1
A	bodyTag()	0	10	2
A	render()	0	24	3

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Widgets;

use InvalidArgumentException;
use Yiisoft\Html\Html;
use Yiisoft\Html\Tag\Button;
use Yiisoft\Html\Tag\Div;
use Yiisoft\Html\Tag\I;
use Yiisoft\Widget\Widget;

use function array_key_exists;
use function strtr;
use function trim;

/**
 * Alert renders an alert component.
 *
 * @link https://getbootstrap.com/docs/5.0/components/alerts/
 * @link https://bulma.io/documentation/elements/notification/
 * @link https://tailwindui.com/components/application-ui/feedback/alerts
 */
final class Alert extends Widget
{
    private array $attributes = [];
    private array $buttonAttributes = [];
    private string $buttonLabel = '&times;';
    private string $body = '';
    private array $bodyAttributes = [];
    /** @psalm-var non-empty-string */
    private ?string $bodyTag = 'span';
    private bool $bodyContainer = false;
    private array $bodyContainerAttributes = [];
    private string $header = '';
    private array $headerAttributes = [];
    private bool $headerContainer = false;
    private array $headerContainerAttributes = [];
    /** @psalm-var non-empty-string */
    private string $headerTag = 'span';
    private array $iconAttributes = [];
    private array $iconContainerAttributes = [];
    private string $iconText = '';
    private string $layoutHeader = '';
    private string $layoutBody = '{body}{button}';

    /**
     * Returns a new instance with the HTML attributes.
     *
     * @param array $valuesMap Attribute values indexed by attribute names.
     */
    public function attributes(array $valuesMap): self
    {
        $new = clone $this;
        $new->attributes = $valuesMap;

        return $new;
    }

    /**
     * Returns a new instance with changed message body.
     *
     * @param string $value The message body.
     */
    public function body(string $value): self
    {
        $new = clone $this;
        $new->body = $value;

        return $new;
    }

    /**
     * Returns a new instance with the HTML attributes for the message body tag.
     *
     * @param array $valuesMap Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
     */
    public function bodyAttributes(array $valuesMap): self
    {
        $new = clone $this;
        $new->bodyAttributes = $valuesMap;

        return $new;
    }

    /**
     * Returns a new instance with CSS class for the message body tag.
     *
     * @param string $value The CSS class name.
     */
    public function bodyClass(string $value): self
    {
        $new = clone $this;
        Html::addCssClass($new->bodyAttributes, $value);

        return $new;
    }

    /**
     * Returns a new instance specifying when allows you to add an extra wrapper for the panel body.
     *
     * @param bool $value Whether to add an extra wrapper for the panel body.
     */
    public function bodyContainer(bool $value): self
    {
        $new = clone $this;
        $new->bodyContainer = $value;

        return $new;
    }

    /**
     * Returns a new instance with the HTML attributes for rendering extra message wrapper.
     *
     * @param array $valuesMap Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
     */
    public function bodyContainerAttributes(array $valuesMap): self
    {
        $new = clone $this;
        $new->bodyContainerAttributes = $valuesMap;

        return $new;
    }

    /**
     * Returns a new instance with the CSS class for extra message wrapper.
     *
     * @param string $value The CSS class name.
     */
    public function bodyContainerClass(string $value): self
    {
        $new = clone $this;
        Html::addCssClass($new->bodyContainerAttributes, $value);

        return $new;
    }

    /**
     * Returns a new instance specifying when allows you to add an extra wrapper for the message body.
     *
     * @param string|null $tag The tag name.
     */
    public function bodyTag(?string $tag = null): self
    {
        if ($tag === '') {
            throw new InvalidArgumentException('Body tag must be a string and cannot be empty.');
        }

        $new = clone $this;
        $new->bodyTag = $tag;

        return $new;
    }

    /**
     * Returns a new instance with the HTML the attributes for rendering the button tag.
     *
     * The button is displayed in the header of the modal window. Clicking on the button will hide the modal.
     *
     * If {@see buttonEnabled} is `false`, no button will be rendered.
     *
     * The rest of the options will be rendered as the HTML attributes of the button tag.
     *
     * @param array $valuesMap Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
     */
    public function buttonAttributes(array $valuesMap): self
    {
        $new = clone $this;
        $new->buttonAttributes = $valuesMap;

        return $new;
    }

    /**
     * Returns a new instance with the CSS class for the button.
     *
     * @param string $value The CSS class name.
     */
    public function buttonClass(string $value): self
    {
        $new = clone $this;
        Html::addCssClass($new->buttonAttributes, $value);

        return $new;
    }

    /**
     * Returns a new instance with the label for the button.
     *
     * @param string $value The label for the button.
     */
    public function buttonLabel(string $value = ''): self
    {
        $new = clone $this;
        $new->buttonLabel = $value;

        return $new;
    }

    /**
     * Returns a new instance with the `onclick` JavaScript for the button.
     *
     * @param string $value The `onclick` JavaScript for the button.
     */
    public function buttonOnClick(string $value): self
    {
        $new = clone $this;
        $new->buttonAttributes['onclick'] = $value;

        return $new;
    }

    /**
     * Returns a new instance with the CSS class for the widget.
     *
     * @param string $value The CSS class name.
     */
    public function class(string $value): self
    {
        $new = clone $this;
        Html::addCssClass($new->attributes, $value);

        return $new;
    }

    /**
     * Returns a new instance with the header content.
     *
     * @param string $value The header content in the message.
     */
    public function header(string $value): self
    {
        $new = clone $this;
        $new->header = $value;

        return $new;
    }

    /**
     * Returns a new instance with the HTML attributes for rendering the header content.
     *
     * @param array $valuesMap Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
     */
    public function headerAttributes(array $valuesMap): self
    {
        $new = clone $this;
        $new->headerAttributes = $valuesMap;

        return $new;
    }

    /**
     * Returns a new instance with the CSS class for the header.
     *
     * @param string $value The CSS class name.
     */
    public function headerClass(string $value): self
    {
        $new = clone $this;
        Html::addCssClass($new->headerAttributes, $value);

        return $new;
    }

    /**
     * Returns a new instance specifying when allows you to add a div tag to the header extra wrapper.
     *
     * @param bool $value The value indicating whether to add a div tag to the header extra wrapper.
     */
    public function headerContainer(bool $value = true): self
    {
        $new = clone $this;
        $new->headerContainer = $value;

        return $new;
    }

    /**
     * Returns a new instance with the HTML attributes for rendering the header.
     *
     * @param array $valuesMap Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
     */
    public function headerContainerAttributes(array $valuesMap): self
    {
        $new = clone $this;
        $new->headerContainerAttributes = $valuesMap;

        return $new;
    }

    /**
     * Returns a new instance with the CSS class for the header extra wrapper.
     *
     * @param string $value The CSS class name.
     */
    public function headerContainerClass(string $value): self
    {
        $new = clone $this;
        Html::addCssClass($new->headerContainerAttributes, $value);

        return $new;
    }

    /**
     * Returns a new instance with the tag name for the header.
     *
     * @param string $value The tag name for the header.
     *
     * @throws InvalidArgumentException
     */
    public function headerTag(string $value): self
    {
        if (empty($value)) {
            throw new InvalidArgumentException('Header tag must be a string and cannot be empty.');
        }

        $new = clone $this;
        $new->headerTag = $value;

        return $new;
    }

    /**
     * Returns a new instance with the HTML attributes for rendering the `<i>` tag for the icon.
     *
     * @param array $valuesMap Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
     */
    public function iconAttributes(array $valuesMap): self
    {
        $new = clone $this;
        $new->iconAttributes = $valuesMap;

        return $new;
    }

    /**
     * Returns a new instance with the icon CSS class.
     *
     * @param string $value The icon CSS class.
     */
    public function iconClass(string $value): self
    {
        $new = clone $this;
        Html::addCssClass($new->iconAttributes, $value);

        return $new;
    }

    /**
     * Returns a new instance with the HTML attributes for rendering icon container.
     *
     * The rest of the options will be rendered as the HTML attributes of the icon container.
     *
     * @param array $valuesMap Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
     */
    public function iconContainerAttributes(array $valuesMap): self
    {
        $new = clone $this;
        $new->iconContainerAttributes = $valuesMap;

        return $new;
    }

    /**
     * Returns a new instance with the CSS class for the icon container.
     *
     * @param string $value The CSS class name.
     */
    public function iconContainerClass(string $value): self
    {
        $new = clone $this;
        Html::addCssClass($new->iconContainerAttributes, $value);

        return $new;
    }

    /**
     * Returns a new instance with the icon text.
     *
     * @param string $value The icon text.
     */
    public function iconText(string $value): self
    {
        $new = clone $this;
        $new->iconText = $value;

        return $new;
    }

    /**
     * Returns a new instance with the specified Widget ID.
     *
     * @param string $value The id of the widget.
     */
    public function id(string $value): self
    {
        $new = clone $this;
        $new->attributes['id'] = $value;

        return $new;
    }

    /**
     * Returns a new instance with the config layout body.
     *
     * @param string $value The config layout body.
     */
    public function layoutBody(string $value): self
    {
        $new = clone $this;
        $new->layoutBody = $value;

        return $new;
    }

    /**
     * Returns a new instance with the config layout header.
     *
     * @param string $value The config layout header.
     */
    public function layoutHeader(string $value): self
    {
        $new = clone $this;
        $new->layoutHeader = $value;

        return $new;
    }

    public function render(): string
    {
        $div = Div::tag();
        $parts = [];

        if (!array_key_exists('id', $this->attributes)) {
            $div = $div->id(Html::generateId('alert-'));
        }

        $parts['{button}'] = $this->renderButton();
        $parts['{icon}'] = $this->renderIcon();
        $parts['{body}'] = $this->renderBody();
        $parts['{header}'] = $this->renderHeader();

        $contentAlert = $this->renderHeaderContainer($parts) . PHP_EOL . $this->renderBodyContainer($parts);

        return $this->body !== ''
            ? $div
                ->attribute('role', 'alert')
                ->addAttributes($this->attributes)
                ->content(PHP_EOL . trim($contentAlert) . PHP_EOL)
                ->encode(false)
                ->render()
            : '';
    }

    /**
     * Renders close button.
     */
    private function renderButton(): string
    {
        return PHP_EOL .
            Button::tag()
                ->attributes($this->buttonAttributes)
                ->content($this->buttonLabel)
                ->encode(false)
                ->type('button')
                ->render();
    }

    /**
     * Render icon.
     */
    private function renderIcon(): string
    {
        return PHP_EOL .
            Div::tag()
                ->attributes($this->iconContainerAttributes)
                ->content(I::tag()->attributes($this->iconAttributes)->content($this->iconText)->render())
                ->encode(false)
                ->render() .
            PHP_EOL;
    }

    /**
     * Render the alert message body.
     */
    private function renderBody(): string
    {
        return $this->bodyTag !== null
            ? Html::normalTag($this->bodyTag, $this->body, $this->bodyAttributes)->encode(false)->render()
            : $this->body;
    }

    /**
     * Render the header.
     */
    private function renderHeader(): string
    {
        return Html::normalTag($this->headerTag, $this->header, $this->headerAttributes)->encode(false)->render();
    }

    /**
     * Render the header container.
     */
    private function renderHeaderContainer(array $parts): string
    {
        $headerHtml = trim(strtr($this->layoutHeader, $parts));

        return $this->headerContainer && $headerHtml !== ''
            ? Div::tag()
                ->attributes($this->headerContainerAttributes)
                ->content(PHP_EOL . $headerHtml . PHP_EOL)
                ->encode(false)
                ->render()
            : $headerHtml;
    }

    /**
     * Render the panel body.
     */
    private function renderBodyContainer(array $parts): string
    {
        $bodyHtml = trim(strtr($this->layoutBody, $parts));

        return $this->bodyContainer
            ? Div::tag()
                ->attributes($this->bodyContainerAttributes)
                ->content(PHP_EOL . $bodyHtml . PHP_EOL)
                ->encode(false)
                ->render()
            : $bodyHtml;
    }
}