class.ButtonAdapterGUI.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Repository\Button;
 
use ILIAS\UI\Component\Button\Standard;
use ILIAS\UI\Component\Button\Button;
 
class ButtonAdapterGUI
{
    protected const TYPE_STD = 0;
    protected const TYPE_SUBMIT = 1;
    protected const TYPE_STD_PRIMARY = 2;
    protected bool $is_primary = false;
    protected string $on_click = "";
    protected int $type;
 
    protected Button $button;
    protected \ilToolbarGUI $toolbar;
    protected \ILIAS\DI\UIServices $ui;
    protected string $caption = "";
    protected string $cmd = "";
    protected bool $disabled = false;
 
    public function __construct(
        string $caption,
        string $cmd
    ) {
        global $DIC;
 
        $this->caption = $caption;
        $this->cmd = $cmd;
        $this->ui = $DIC->ui();
        $this->toolbar = $DIC->toolbar();
        $this->type = self::TYPE_STD;
        $this->on_click = "";
    }
 
    public function submit(): self
    {
        $this->type = self::TYPE_SUBMIT;
        return $this;
    }
 
    public function primary(): self
    {
        $this->type = self::TYPE_STD_PRIMARY;
        $this->is_primary = true;
        return $this;
    }
 
    public function onClick(string $on_click): self
    {
        $this->on_click = $on_click;
        return $this;
    }
 
    public function disabled(bool $disabled): self
    {
        $this->disabled = $disabled;
        return $this;
    }
 
    protected function getSubmitButton(): \ILIAS\UI\Component\Button\Button
    {
        $cmd = $this->cmd;
        if ($this->is_primary) {
            $b = $this->ui->factory()->button()->primary(
                $this->caption,
                ""
            );
        } else {
            $b = $this->ui->factory()->button()->standard(
                $this->caption,
                ""
            );
        }
        $b = $b->withOnLoadCode(function ($id) use ($cmd) {
            $code = <<<EOT
(function() {
    const el = document.getElementById('$id');
    el.name = "cmd[$cmd]";
    el.type = "submit";
}());
EOT;
            return $code;
        });
        return $b;
    }
 
    protected function getStandardButton(): \ILIAS\UI\Component\Button\Button
    {
        return $this->ui->factory()->button()->standard(
            $this->caption,
            $this->cmd
        );
    }
 
    protected function getStdPrimaryButton(): \ILIAS\UI\Component\Button\Button
    {
        return $this->ui->factory()->button()->primary(
            $this->caption,
            $this->cmd
        );
    }
 
    protected function getButton(): \ILIAS\UI\Component\Button\Button
    {
        switch ($this->type) {
            case self::TYPE_SUBMIT:
                $button = $this->getSubmitButton();
                break;
 
            case self::TYPE_STD_PRIMARY:
                $button = $this->getStdPrimaryButton();
                break;
 
            default:
                $button = $this->getStandardButton();
                break;
        }
        if ($this->on_click !== "") {
            $click = $this->on_click;
            $button = $button->withOnLoadCode(function ($id) use ($click) {
                $code = <<<EOT
(function() {
    const el = document.getElementById('$id').addEventListener('click', () => { $click });
}());
EOT;
                return $code;
            });
        }
 
        if ($this->disabled) {
            $button = $button->withUnavailableAction();
        }
 
        return $button;
    }
 
    public function toToolbar(bool $sticky = false, ?\ilToolbarGUI $toolbar = null): void
    {
        $button = $this->getButton();
        if (is_null($toolbar)) {
            $toolbar = $this->toolbar;
        }
        if ($sticky) {
            $toolbar->addStickyItem($button);
        } else {
            $toolbar->addComponent($button);
        }
    }
 
    public function render(): string
    {
        return $this->ui->renderer()->render($this->getButton());
    }
}