Collaboration diagram for ILIAS\Repository\Button\ButtonAdapterGUI:

Public Member Functions
	__construct (string $caption, string $cmd)

	submit ()

	primary ()

	onClick (string $on_click)

	disabled (bool $disabled)

	toToolbar (bool $sticky=false, ?\ilToolbarGUI $toolbar=null)

	render (?array $data=null)

Protected Member Functions
	getSubmitButton ()

	getStandardButton ()

	getStdPrimaryButton ()

	getButton ()

Protected Attributes
const	TYPE_STD = 0

const	TYPE_SUBMIT = 1

const	TYPE_STD_PRIMARY = 2

bool	$is_primary = false

string	$on_click = ""

int	$type

Button	$button

ilToolbarGUI	$toolbar

ILIAS DI UIServices	$ui

string	$caption = ""

string	$cmd = ""

bool	$disabled = false

Detailed Description

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 29 of file class.ButtonAdapterGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Repository\Button\ButtonAdapterGUI::__construct	(	string	$caption,
		string	$cmd
	)

Definition at line 48 of file class.ButtonAdapterGUI.php.

      {
        global $DIC;
 
        $this->caption = $caption;
        $this->cmd = $cmd;
        $this->ui = $DIC->ui();
        $this->toolbar = $DIC->toolbar();
        $this->type = self::TYPE_STD;
        $this->on_click = "";
    }

References ILIAS\Repository\Button\ButtonAdapterGUI\$caption, ILIAS\Repository\Button\ButtonAdapterGUI\$cmd, $DIC, ILIAS\Repository\toolbar(), ILIAS\Repository\Button\ButtonAdapterGUI\TYPE_STD, and ILIAS\Repository\ui().

Here is the call graph for this function:

Member Function Documentation

◆ disabled()

ILIAS\Repository\Button\ButtonAdapterGUI::disabled ( bool $disabled )

Definition at line 81 of file class.ButtonAdapterGUI.php.

                                            : self
    {
        $this->disabled = $disabled;
        return $this;
    }

References ILIAS\Repository\Button\ButtonAdapterGUI\$disabled, and ILIAS\Repository\Button\ButtonAdapterGUI\disabled().

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\disabled(), and ILIAS\Repository\Button\ButtonAdapterGUI\getButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getButton()

ILIAS\Repository\Button\ButtonAdapterGUI::getButton ( )

protected

Definition at line 130 of file class.ButtonAdapterGUI.php.

                                  : \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;
    }

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\render(), and ILIAS\Repository\Button\ButtonAdapterGUI\toToolbar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStandardButton()

ILIAS\Repository\Button\ButtonAdapterGUI::getStandardButton ( )

protected

Definition at line 114 of file class.ButtonAdapterGUI.php.

                                          : \ILIAS\UI\Component\Button\Button
    {
        return $this->ui->factory()->button()->standard(
            $this->caption,
            $this->cmd
        );
    }

References ILIAS\Repository\ui().

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\getButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStdPrimaryButton()

ILIAS\Repository\Button\ButtonAdapterGUI::getStdPrimaryButton ( )

protected

Definition at line 122 of file class.ButtonAdapterGUI.php.

                                            : \ILIAS\UI\Component\Button\Button
    {
        return $this->ui->factory()->button()->primary(
            $this->caption,
            $this->cmd
        );
    }

References ILIAS\Repository\ui().

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\getButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubmitButton()

ILIAS\Repository\Button\ButtonAdapterGUI::getSubmitButton ( )

protected

Definition at line 87 of file class.ButtonAdapterGUI.php.

                                        : \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;
    }

References Vendor\Package\$b, ILIAS\Repository\Button\ButtonAdapterGUI\$cmd, $id, and ILIAS\Repository\ui().

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\getButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onClick()

ILIAS\Repository\Button\ButtonAdapterGUI::onClick ( string $on_click )

Definition at line 75 of file class.ButtonAdapterGUI.php.

                                             : self
    {
        $this->on_click = $on_click;
        return $this;
    }

References ILIAS\Repository\Button\ButtonAdapterGUI\$on_click.

◆ primary()

ILIAS\Repository\Button\ButtonAdapterGUI::primary ( )

Definition at line 68 of file class.ButtonAdapterGUI.php.

                             : self
    {
        $this->type = self::TYPE_STD_PRIMARY;
        $this->is_primary = true;
        return $this;
    }

References ILIAS\Repository\Button\ButtonAdapterGUI\TYPE_STD_PRIMARY.

◆ render()

ILIAS\Repository\Button\ButtonAdapterGUI::render ( ?array $data = null )

Definition at line 177 of file class.ButtonAdapterGUI.php.

                                               : string
    {
        $html = $this->ui->renderer()->render($this->getButton());
        $data_str = "";
        if (is_array($data)) {
            foreach ($data as $key => $value) {
                $data_str .= " data-$key=\"$value\" ";
            }
            $html = str_replace("<button", "<button $data_str", $html);
        }
        return $html;
    }

References $data, ILIAS\Repository\Button\ButtonAdapterGUI\getButton(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ submit()

ILIAS\Repository\Button\ButtonAdapterGUI::submit ( )

Definition at line 62 of file class.ButtonAdapterGUI.php.

                            : self
    {
        $this->type = self::TYPE_SUBMIT;
        return $this;
    }

References ILIAS\Repository\Button\ButtonAdapterGUI\TYPE_SUBMIT.

◆ toToolbar()

ILIAS\Repository\Button\ButtonAdapterGUI::toToolbar	(	bool	$sticky = `false`,
		?\ilToolbarGUI	$toolbar = `null`
	)

Definition at line 164 of file class.ButtonAdapterGUI.php.

                                                                                   : void
    {
        $button = $this->getButton();
        if (is_null($toolbar)) {
            $toolbar = $this->toolbar;
        }
        if ($sticky) {
            $toolbar->addStickyItem($button);
        } else {
            $toolbar->addComponent($button);
        }
    }

References ILIAS\Repository\Button\ButtonAdapterGUI\$button, ILIAS\Repository\Button\ButtonAdapterGUI\$toolbar, ilToolbarGUI\addComponent(), ilToolbarGUI\addStickyItem(), and ILIAS\Repository\Button\ButtonAdapterGUI\getButton().

Here is the call graph for this function:

Field Documentation

◆ $button

Button ILIAS\Repository\Button\ButtonAdapterGUI::$button

protected

Definition at line 41 of file class.ButtonAdapterGUI.php.

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\getButton(), and ILIAS\Repository\Button\ButtonAdapterGUI\toToolbar().

◆ $caption

string ILIAS\Repository\Button\ButtonAdapterGUI::$caption = ""

protected

Definition at line 44 of file class.ButtonAdapterGUI.php.

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\__construct().

◆ $cmd

string ILIAS\Repository\Button\ButtonAdapterGUI::$cmd = ""

protected

Definition at line 45 of file class.ButtonAdapterGUI.php.

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\__construct(), and ILIAS\Repository\Button\ButtonAdapterGUI\getSubmitButton().

◆ $disabled

bool ILIAS\Repository\Button\ButtonAdapterGUI::$disabled = false

protected

Definition at line 46 of file class.ButtonAdapterGUI.php.

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\disabled().

◆ $is_primary

bool ILIAS\Repository\Button\ButtonAdapterGUI::$is_primary = false

protected

Definition at line 37 of file class.ButtonAdapterGUI.php.

◆ $on_click

string ILIAS\Repository\Button\ButtonAdapterGUI::$on_click = ""

protected

Definition at line 38 of file class.ButtonAdapterGUI.php.

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\getButton(), and ILIAS\Repository\Button\ButtonAdapterGUI\onClick().

◆ $toolbar

ilToolbarGUI ILIAS\Repository\Button\ButtonAdapterGUI::$toolbar

protected

Definition at line 42 of file class.ButtonAdapterGUI.php.

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\toToolbar().

◆ $type

int ILIAS\Repository\Button\ButtonAdapterGUI::$type

protected

Definition at line 39 of file class.ButtonAdapterGUI.php.

◆ $ui

ILIAS DI UIServices ILIAS\Repository\Button\ButtonAdapterGUI::$ui

protected

Definition at line 43 of file class.ButtonAdapterGUI.php.

◆ TYPE_STD

const ILIAS\Repository\Button\ButtonAdapterGUI::TYPE_STD = 0

protected

Definition at line 31 of file class.ButtonAdapterGUI.php.

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\__construct().

◆ TYPE_STD_PRIMARY

const ILIAS\Repository\Button\ButtonAdapterGUI::TYPE_STD_PRIMARY = 2

protected

Definition at line 33 of file class.ButtonAdapterGUI.php.

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\getButton(), and ILIAS\Repository\Button\ButtonAdapterGUI\primary().

◆ TYPE_SUBMIT

const ILIAS\Repository\Button\ButtonAdapterGUI::TYPE_SUBMIT = 1

protected

Definition at line 32 of file class.ButtonAdapterGUI.php.

Referenced by ILIAS\Repository\Button\ButtonAdapterGUI\getButton(), and ILIAS\Repository\Button\ButtonAdapterGUI\submit().

The documentation for this class was generated from the following file:

components/ILIAS/Repository/Service/Button/class.ButtonAdapterGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ disabled()

◆ getButton()

◆ getStandardButton()

◆ getStdPrimaryButton()

◆ getSubmitButton()

◆ onClick()

◆ primary()

◆ render()

◆ submit()

◆ toToolbar()

Field Documentation

◆ $button

◆ $caption

◆ $cmd

◆ $disabled

◆ $is_primary

◆ $on_click

◆ $toolbar

◆ $type

◆ $ui

◆ TYPE_STD

◆ TYPE_STD_PRIMARY

◆ TYPE_SUBMIT