src/Js/JsModal.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

declare(strict_types=1);

namespace Atk4\Ui\Js;

use Atk4\Ui\VirtualPage;

/**
 * Create Fomantic-UI Modal using JS.
 */
class JsModal extends JsExpression
{
    /**
     * @param string|null        $title when empty, header will be removed in modal
     * @param string|VirtualPage $url
     */
    public function __construct($title, $url, array $args = [], string $dataType = 'json')
    {
        if ($url instanceof VirtualPage) {
            $url = $url->getJsUrl('cut');
        }

        parent::__construct('$(this).atkCreateModal([arg])', ['arg' => ['url' => $url, 'title' => $title, 'dataType' => $dataType, 'urlOptions' => $args]]);

        if (!$title) {
            $this->removeHeader();
        }
    }

    /**
     * Set additional option for this JsModal.
     *
     * Valuable option are headerClass and label:
     *  'headerClass' -> customize CSS class name for the header.
     *      ex: changing color text for header
     *      $jsModal->setOption('headerClass', 'ui blue header');
     *
     *  'loadingLabel' -> set the text loader value.
     *      ex: changing default 'Loading...' for no text
     *      $jsModal->setOption('loadingLabel', '');
     *
     *   'modalCss' -> customize CSS class name for the entire modal.
     *      ex: making modal fullscreen
     *      $jsModal->setOption('modalCss', 'fullscreen');
     *
     *   'contentClass' -> customize CSS class name for Modal content.
     *       ex: making content scrollable
     *       $jsModal->setOption('contentClass', 'scrolling');
     *       Note: Default to 'image' for backward compatibility.
     *
     * You can set option individually or supply an array.
     *
     * @param string|array                        $options
     * @param ($options is array ? never : mixed) $value
     *
     * @return $this
     */
    public function setOption($options, $value = null)
    {
        if (is_array($options)) {
            foreach ($options as $k => $v) {
                $this->args['arg'][$k] = $v;
            }
        } else {
            $this->args['arg'][$options] = $value;
        }

        return $this;
    }

    /**
     * Clear header class and title.
     *
     * @return $this
     */
    public function removeHeader()
    {
        $this->args['arg']['headerClass'] = '';
        $this->args['arg']['title'] = '';

        return $this;
    }
}