Collaboration diagram for ILIAS\UI\Implementation\Component\Button\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 ()

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\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::__construct	(	string	$caption,
		string	$cmd
	)

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ disabled()

ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::disabled ( bool $disabled )

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

References ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\$disabled.

Referenced by ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getButton().

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

Here is the caller graph for this function:

◆ getButton()

ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::getButton ( )

protected

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

References ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\$button, $id, ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\$on_click, ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\disabled(), ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getStandardButton(), ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getStdPrimaryButton(), ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getSubmitButton(), and ILIAS\UI\Implementation\Component\Button\Button\withUnavailableAction().

Referenced by ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\render(), and ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\toToolbar().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStandardButton()

ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::getStandardButton ( )

protected

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

References ILIAS\Repository\ui().

Referenced by ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getButton().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStdPrimaryButton()

ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::getStdPrimaryButton ( )

protected

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

References ILIAS\Repository\ui().

Referenced by ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getButton().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubmitButton()

ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::getSubmitButton ( )

protected

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

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

Referenced by ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getButton().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onClick()

ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::onClick ( string $on_click )

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

References ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\$on_click.

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

◆ primary()

ILIAS\UI\Implementation\Component\Button\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;
     }

◆ render()

ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::render ( )

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

References ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getButton(), and ILIAS\Repository\ui().

                             : string
     {
         return $this->ui->renderer()->render($this->getButton());
     }

Here is the call graph for this function:

◆ submit()

ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::submit ( )

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

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

◆ toToolbar()

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

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

References ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\$toolbar, ilToolbarGUI\addStickyItem(), and ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getButton().

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

Here is the call graph for this function:

Field Documentation

◆ $button

Button ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::$button

protected

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

Referenced by ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getButton().

◆ $caption

string ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::$caption = ""

protected

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

Referenced by ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\__construct().

◆ $cmd

string ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::$cmd = ""

protected

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

Referenced by ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\__construct(), and ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getSubmitButton().

◆ $disabled

bool ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::$disabled = false

protected

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

Referenced by ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\disabled().

◆ $is_primary

bool ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::$is_primary = false

protected

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

◆ $on_click

string ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::$on_click = ""

protected

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

Referenced by ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\getButton(), and ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\onClick().

◆ $toolbar

ilToolbarGUI ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::$toolbar

protected

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

Referenced by ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\toToolbar().

◆ $type

int ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::$type

protected

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

◆ $ui

ILIAS DI UIServices ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::$ui

protected

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

◆ TYPE_STD

const ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::TYPE_STD = 0

protected

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

◆ TYPE_STD_PRIMARY

const ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::TYPE_STD_PRIMARY = 2

protected

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

◆ TYPE_SUBMIT

const ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI::TYPE_SUBMIT = 1

protected

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

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