Yiisoft\Yii\Bulma\Modal

Complexity

Total Complexity

29

Size/Duplication

Total Lines	349
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	renderToggleButton()	0	21	3
A	contentClass()	0	5	1
A	renderCloseButton()	0	14	2
A	begin()	0	32	4
A	withoutToggleButton()	0	5	1
A	backgroundClass()	0	5	1
A	withoutCloseButton()	0	5	1
A	autoIdPrefix()	0	5	1
A	toggleButtonSize()	0	10	2
A	buttonClass()	0	5	1
A	closeButtonSize()	0	10	2
A	modalClass()	0	5	1
A	toggleButtonAttributes()	0	5	1
A	attributes()	0	5	1
A	id()	0	5	1
A	toggleButtonColor()	0	10	2
A	contentAttributes()	0	6	1
A	render()	0	6	1
A	toggleButtonLabel()	0	5	1
A	closeButtonAttributes()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Bulma;

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

use function array_key_exists;
use function implode;
use function in_array;

/**
 * Modal renders a modal window that can be toggled by clicking on a button.
 *
 * The following example will show the content enclosed between the {@see Widget::begin()} and {@see Widget::end()}
 * calls within the modal window:
 *
 * ```php
 * echo Modal::widget()->begin();
 *
 * echo 'Say hello...';
 *
 * echo Modal::end();
 * ```
 *
 * @link https://bulma.io/documentation/components/modal/
 */
final class Modal extends Widget
{
    public const SIZE_SMALL = 'is-small';
    public const SIZE_MEDIUM = 'is-medium';
    public const SIZE_LARGE = 'is-large';
    private const SIZE_ALL = [
        self::SIZE_SMALL,
        self::SIZE_MEDIUM,
        self::SIZE_LARGE,
    ];

    public const COLOR_PRIMARY = 'is-primary';
    public const COLOR_LINK = 'is-link';
    public const COLOR_INFO = 'is-info';
    public const COLOR_SUCCESS = 'is-success';
    public const COLOR_WARNING = 'is-warning';
    public const COLOR_DANGER = 'is-danger';
    public const COLOR_DARK = 'is-dark';
    private const COLOR_ALL = [
        self::COLOR_PRIMARY,
        self::COLOR_LINK,
        self::COLOR_INFO,
        self::COLOR_SUCCESS,
        self::COLOR_WARNING,
        self::COLOR_DANGER,
        self::COLOR_DARK,
    ];
    private array $attributes = [];
    private string $autoIdPrefix = 'w';
    private string $backgroundClass = 'modal-background';
    private string $buttonClass = 'button modal-button';
    private array $closeButtonAttributes = [];
    private string $closeButtonClass = 'modal-close';
    private string $closeButtonSize = '';
    private array $contentAttributes = [];
    private string $contentClass = 'modal-content';
    private string $modalClass = 'modal';
    private array $toggleButtonAttributes = [];
    private string $toggleButtonLabel = 'Toggle button';
    private string $toggleButtonSize = '';
    private string $toggleButtonColor = '';
    private bool $withoutCloseButton = false;
    private bool $withoutToggleButton = false;

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

    /**
     * Returns a new instance with the specified prefix to the automatically generated widget IDs.
     *
     * @param string $value The prefix to the automatically generated widget IDs.
     */
    public function autoIdPrefix(string $value): self
    {
        $new = clone $this;
        $new->autoIdPrefix = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified close button options.
     *
     * @param array $value The close button options.
     *
     * {@see Html::renderTagAttributes()} For details on how attributes are being rendered.
     */
    public function closeButtonAttributes(array $value): self
    {
        $new = clone $this;
        $new->closeButtonAttributes = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified close button size.
     *
     * @param string $value The close button size. Default setting empty normal.
     * Possible values: Modal::SIZE_SMALL, Modal::SIZE_MEDIUM, Model::SIZE_LARGE.
     */
    public function closeButtonSize(string $value): self
    {
        if (!in_array($value, self::SIZE_ALL, true)) {
            $values = implode('", "', self::SIZE_ALL);
            throw new InvalidArgumentException("Invalid size. Valid values are: \"$values\".");
        }

        $new = clone $this;
        $new->closeButtonSize = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified content options.
     *
     * @param array $value The content options.
     *
     * {@see Html::renderTagAttributes()} For details on how attributes are being rendered.
     */
    public function contentAttributes(array $value): self
    {
        $new = clone $this;
        $new->contentAttributes = $value;

        return $new;
    }

    /**
     * Returns a new instance with the specified ID of the widget.
     *
     * @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 specified modal background class.
     *
     * @param string $value The modal background class.
     */
    public function backgroundClass(string $value): self
    {
        $new = clone $this;
        $new->backgroundClass = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified modal button class.
     *
     * @param string $value The modal button class.
     */
    public function buttonClass(string $value): self
    {
        $new = clone $this;
        $new->buttonClass = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified modal class.
     *
     * @param string $value The modal class.
     */
    public function modalClass(string $value): self
    {
        $new = clone $this;
        $new->modalClass = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified modal content class.
     *
     * @param string $value The modal content class.
     */
    public function contentClass(string $value): self
    {
        $new = clone $this;
        $new->contentClass = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified toggle button options.
     *
     * @param array $values Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} For details on how attributes are being rendered.
     */
    public function toggleButtonAttributes(array $values): self
    {
        $new = clone $this;
        $new->toggleButtonAttributes = $values;
        return $new;
    }

    /**
     * Returns a new instance with the specified toggle button color.
     *
     * @param string $value The toggle button color. Default setting is empty without color.
     * Possible values: Modal::COLOR_PRIMARY, Modal::COLOR_LINK, Modal::COLOR_INFO, Modal::COLOR_SUCCESS,
     * Modal::COLOR_WARNING, Modal::COLOR_DANGER, Modal::COLOR_DARK.
     */
    public function toggleButtonColor(string $value): self
    {
        if (!in_array($value, self::COLOR_ALL, true)) {
            $values = implode('", "', self::COLOR_ALL);
            throw new InvalidArgumentException("Invalid color. Valid values are: \"$values\".");
        }

        $new = clone $this;
        $new->toggleButtonColor = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified toggle button label.
     *
     * @param string $value The toggle button label.
     */
    public function toggleButtonLabel(string $value): self
    {
        $new = clone $this;
        $new->toggleButtonLabel = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified toggle button size.
     *
     * @param string $value The toggle button size. Default setting empty normal.
     * Possible values: Modal::SIZE_SMALL, Modal::SIZE_MEDIUM, Model::SIZE_LARGE.
     */
    public function toggleButtonSize(string $value): self
    {
        if (!in_array($value, self::SIZE_ALL, true)) {
            $values = implode('", "', self::SIZE_ALL);
            throw new InvalidArgumentException("Invalid size. Valid values are: \"$values\".");
        }

        $new = clone $this;
        $new->toggleButtonSize = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified options for rendering the close button tag.
     *
     * @param bool $value Whether the close button is disabled.
     */
    public function withoutCloseButton(bool $value): self
    {
        $new = clone $this;
        $new->withoutCloseButton = $value;
        return $new;
    }

    /**
     * Returns a new instance with the disabled toggle button.
     *
     * @param bool $value Whether the toggle button is disabled.
     */
    public function withoutToggleButton(bool $value): self
    {
        $new = clone $this;
        $new->withoutToggleButton = $value;
        return $new;
    }

    public function begin(): ?string
    {
        parent::begin();

        $attributes = $this->attributes;
        $contentAttributes = $this->contentAttributes;
        $html = '';

        if (!array_key_exists('id', $attributes)) {
            $attributes['id'] = Html::generateId($this->autoIdPrefix) . '-modal';
        }

        /** @var string */
        $id = $attributes['id'];

        Html::addCssClass($attributes, $this->modalClass);
        Html::addCssClass($contentAttributes, $this->contentClass);

        if ($this->withoutToggleButton === false) {
            $html = $this->renderToggleButton($id) . PHP_EOL;
        }

        $html .= Html::openTag('div', $attributes) . PHP_EOL; // .modal
        $html .= Div::tag()->class($this->backgroundClass) . PHP_EOL;

        if ($this->withoutCloseButton === false) {
            $html .= $this->renderCloseButton() . PHP_EOL;
        }

        $html .= Html::openTag('div', $contentAttributes) . PHP_EOL; // .modal-content

        return $html;
    }

    public function render(): string
    {
        $html = Html::closeTag('div') . PHP_EOL; // .modal-content
        $html .= Html::closeTag('div'); // .modal

        return $html;
    }

    /**
     * Renders the toggle button.
     */
    private function renderToggleButton(string $id): string
    {
        $toggleButtonAttributes = $this->toggleButtonAttributes;

        $toggleButtonAttributes['data-target'] = '#' . $id;
        $toggleButtonAttributes['aria-haspopup'] = 'true';

        if ($this->toggleButtonSize !== '') {
            Html::addCssClass($toggleButtonAttributes, $this->toggleButtonSize);
        }

        if ($this->toggleButtonColor !== '') {
            Html::addCssClass($toggleButtonAttributes, $this->toggleButtonColor);
        }

        Html::addCssClass($toggleButtonAttributes, $this->buttonClass);

        return Button::tag()
            ->attributes($toggleButtonAttributes)
            ->content($this->toggleButtonLabel)
            ->render();
    }

    /**
     * Renders the close button.
     */
    private function renderCloseButton(): string
    {
        $closeButtonAttributes = $this->closeButtonAttributes;
        $closeButtonAttributes['aria-label'] = 'close';

        if ($this->closeButtonSize !== '') {
            Html::addCssClass($closeButtonAttributes, $this->closeButtonSize);
        }

        Html::addCssClass($closeButtonAttributes, $this->closeButtonClass);

        return Button::tag()
            ->attributes($closeButtonAttributes)
            ->render();
    }
}