ILIAS\Repository\Modal\ModalAdapterGUI Class Reference

Collaboration diagram for ILIAS\Repository\Modal\ModalAdapterGUI:

Public Member Functions
	__construct (string $title, string $cancel_label, HTTPUtil $http_util)
	getTitle ()
	legacy (string $content)
	content (array $components)
	button (string $text, string $url, bool $replace_modal=true, $onclick="")
	form (\ILIAS\Repository\Form\FormAdapterGUI $form, string $on_form_submit_click="")
	send ()
	renderAsyncTriggerButton (string $button_title, string $url, $shy=true)
	getAsyncTriggerButtonComponents (string $button_title, string $url, $shy=true)
	getTriggerButtonComponents (string $button_title, $shy=true)

Protected Member Functions
	_send (string $output)
	getModalWithContent ()

Protected Attributes
HTTPUtil	$http_util
string	$cancel_label
ILIAS Repository Form FormAdapterGUI	$form = null
ILIAS Refinery Factory	$refinery
string	$title = ""
ILIAS HTTP Services	$http
ilCtrlInterface	$ctrl
ILIAS DI UIServices	$ui
array	$ui_content = null
array	$action_buttons = []

Detailed Description

Definition at line 27 of file class.ModalAdapterGUI.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Repository\Modal\ModalAdapterGUI::__construct	(	string	$title,
		string	$cancel_label,
		HTTPUtil	$http_util
	)

Parameters

string | array

$class_path

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

References ILIAS\Repository\Modal\ModalAdapterGUI\$cancel_label, $DIC, ILIAS\Repository\Modal\ModalAdapterGUI\$http_util, ILIAS\Repository\Modal\ModalAdapterGUI\$title, ILIAS\Repository\ctrl(), ILIAS\Repository\http(), ILIAS\Repository\refinery(), and ILIAS\Repository\ui().

      {
        global $DIC;
        $this->ui = $DIC->ui();
        $this->ctrl = $DIC->ctrl();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->title = $title;
        $this->cancel_label = $cancel_label;
        $this->http_util = $http_util;
    }

Here is the call graph for this function:

Member Function Documentation

_send()

ILIAS\Repository\Modal\ModalAdapterGUI::_send ( string  $output )

protected

Exceptions

Definition at line 61 of file class.ModalAdapterGUI.php.

Referenced by ILIAS\Repository\Modal\ModalAdapterGUI\send().

                                            : void
    {
        $this->http_util->sendString($output);
    }

Here is the caller graph for this function:

button()

ILIAS\Repository\Modal\ModalAdapterGUI::button	(	string	$text,
		string	$url,
		bool	$replace_modal = true,
			$onclick = ""
	)

Definition at line 85 of file class.ModalAdapterGUI.php.

References $id, $url, and ILIAS\Repository\ui().

                                                                                                : self
    {
        $target = $replace_modal
            ? "#"
            : $url;

        $button = $this->ui->factory()->button()->standard(
            $text,
            $target
        );

        if ($replace_modal) {
            $button = $button->withOnLoadCode(function ($id) use ($url, $onclick) {
                return
                    "$('#$id').click(function(event) { $onclick; il.repository.ui.redirect('$url'); return false;});";
            });
        } elseif ($onclick !== "") {
            $button = $button->withOnLoadCode(function ($id) use ($url, $onclick) {
                return "$('#$id').click(function(event) { $onclick });";
            });
        }
        $this->action_buttons[] = $button;
        return $this;
    }

Here is the call graph for this function:

content()

ILIAS\Repository\Modal\ModalAdapterGUI::content

(

array

$components

)

Definition at line 78 of file class.ModalAdapterGUI.php.

References ILIAS\Repository\Modal\ModalAdapterGUI\form().

                                              : self
    {
        $this->ui_content = $components;
        $this->form = null;
        return $this;
    }

Here is the call graph for this function:

form()

ILIAS\Repository\Modal\ModalAdapterGUI::form	(	\ILIAS\Repository\Form\FormAdapterGUI	$form,
		string	$on_form_submit_click = ""
	)

Definition at line 110 of file class.ModalAdapterGUI.php.

References $id, ILIAS\Repository\ctrl(), ILIAS\Repository\ui(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

Referenced by ILIAS\Repository\Modal\ModalAdapterGUI\content(), ILIAS\Repository\Modal\ModalAdapterGUI\getModalWithContent(), and ILIAS\Repository\Modal\ModalAdapterGUI\legacy().

     : self {
        if ($this->ctrl->isAsynch()) {
            $this->form = $form->asyncModal();
        } else {
            $this->form = $form->syncModal();
        }

        $async = $this->form->isSentAsync()
            ? "true"
            : "false";
        if ($on_form_submit_click === "") {
            $on_form_submit_click = "il.repository.ui.submitModalForm(event,$async); return false;";
        }
        $button = $this->ui->factory()->button()->standard(
            $this->form->getSubmitLabel(),
            "#"
        )->withOnLoadCode(function ($id) use ($on_form_submit_click) {
            return
                "$('#$id').click(function(event) {" . $on_form_submit_click . "});";
        });
        $this->action_buttons[] = $button;
        $this->ui_content = null;
        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAsyncTriggerButtonComponents()

ILIAS\Repository\Modal\ModalAdapterGUI::getAsyncTriggerButtonComponents	(	string	$button_title,
		string	$url,
			$shy = true
	)

Definition at line 174 of file class.ModalAdapterGUI.php.

References ILIAS\Repository\Modal\ModalAdapterGUI\$ui.

Referenced by ILIAS\Repository\Modal\ModalAdapterGUI\renderAsyncTriggerButton().

                                                                                                   : array
    {
        $ui = $this->ui;
        $modal = $ui->factory()->modal()->roundtrip("", $ui->factory()->legacy(""));
        $url .= '&replaceSignal=' . $modal->getReplaceSignal()->getId();
        $modal = $modal->withAsyncRenderUrl($url);
        if ($shy) {
            $button = $ui->factory()->button()->shy($button_title, "#")
                         ->withOnClick($modal->getShowSignal());
        } else {
            $button = $ui->factory()->button()->standard($button_title, "#")
                         ->withOnClick($modal->getShowSignal());
        }
        return ["button" => $button, "modal" => $modal, "signal" => $modal->getShowSignal()->getId()];
    }

Here is the caller graph for this function:

getModalWithContent()

ILIAS\Repository\Modal\ModalAdapterGUI::getModalWithContent ( )

protected

Definition at line 138 of file class.ModalAdapterGUI.php.

References ILIAS\Repository\Modal\ModalAdapterGUI\form(), ILIAS\Repository\Modal\ModalAdapterGUI\getTitle(), and ILIAS\Repository\ui().

Referenced by ILIAS\Repository\Modal\ModalAdapterGUI\getTriggerButtonComponents(), and ILIAS\Repository\Modal\ModalAdapterGUI\send().

                                            : Modal\RoundTrip
    {
        $modal = [];
        if (!is_null($this->form)) {
            $this->ui_content = [$this->ui->factory()->legacy($this->form->render())];
        }
        $modal = $this->ui->factory()->modal()->roundtrip($this->getTitle(), $this->ui_content);
        if (count($this->action_buttons) > 0) {
            $modal = $modal->withActionButtons($this->action_buttons);
        }
        if ($this->cancel_label !== "") {
            $modal = $modal->withCancelButtonLabel($this->cancel_label);
        }
        return $modal;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTitle()

ILIAS\Repository\Modal\ModalAdapterGUI::getTitle

(

)

Definition at line 66 of file class.ModalAdapterGUI.php.

References ILIAS\Repository\Modal\ModalAdapterGUI\$title.

Referenced by ILIAS\Repository\Modal\ModalAdapterGUI\getModalWithContent().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getTriggerButtonComponents()

ILIAS\Repository\Modal\ModalAdapterGUI::getTriggerButtonComponents	(	string	$button_title,
			$shy = true
	)

Definition at line 190 of file class.ModalAdapterGUI.php.

References ILIAS\Repository\Modal\ModalAdapterGUI\$ui, and ILIAS\Repository\Modal\ModalAdapterGUI\getModalWithContent().

                                                                                 : array
    {
        $ui = $this->ui;

        $modal = $this->getModalWithContent();
        if ($shy) {
            $button = $ui->factory()->button()->shy($button_title, "#")
                         ->withOnClick($modal->getShowSignal());
        } else {
            $button = $ui->factory()->button()->standard($button_title, "#")
                         ->withOnClick($modal->getShowSignal());
        }
        return ["button" => $button, "modal" => $modal, "signal" => $modal->getShowSignal()->getId()];
    }

Here is the call graph for this function:

legacy()

ILIAS\Repository\Modal\ModalAdapterGUI::legacy

(

string

$content

)

Definition at line 71 of file class.ModalAdapterGUI.php.

References ILIAS\Repository\Modal\ModalAdapterGUI\form(), and ILIAS\Repository\ui().

                                           : self
    {
        $this->ui_content = [$this->ui->factory()->legacy($content)];
        $this->form = null;
        return $this;
    }

Here is the call graph for this function:

renderAsyncTriggerButton()

ILIAS\Repository\Modal\ModalAdapterGUI::renderAsyncTriggerButton	(	string	$button_title,
		string	$url,
			$shy = true
	)

Definition at line 163 of file class.ModalAdapterGUI.php.

References ILIAS\Repository\Modal\ModalAdapterGUI\$ui, and ILIAS\Repository\Modal\ModalAdapterGUI\getAsyncTriggerButtonComponents().

                                                                                            : string
    {
        $ui = $this->ui;
        $components = $this->getAsyncTriggerButtonComponents(
            $button_title,
            $url,
            $shy
        );
        return $ui->renderer()->render($components);
    }

Here is the call graph for this function:

send()

ILIAS\Repository\Modal\ModalAdapterGUI::send

(

)

Exceptions

Definition at line 157 of file class.ModalAdapterGUI.php.

References ILIAS\Repository\Modal\ModalAdapterGUI\_send(), ILIAS\Repository\Modal\ModalAdapterGUI\getModalWithContent(), and ILIAS\Repository\ui().

                          : void
    {
        $modal = $this->getModalWithContent();
        $this->_send($this->ui->renderer()->renderAsync($modal));
    }

Here is the call graph for this function:

Field Documentation

$action_buttons

array ILIAS\Repository\Modal\ModalAdapterGUI::$action_buttons = []

protected

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

$cancel_label

string ILIAS\Repository\Modal\ModalAdapterGUI::$cancel_label

protected

Definition at line 30 of file class.ModalAdapterGUI.php.

Referenced by ILIAS\Repository\Modal\ModalAdapterGUI\__construct().

$ctrl

ilCtrlInterface ILIAS\Repository\Modal\ModalAdapterGUI::$ctrl

protected

Definition at line 35 of file class.ModalAdapterGUI.php.

$form

ILIAS Repository Form FormAdapterGUI ILIAS\Repository\Modal\ModalAdapterGUI::$form = null

protected

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

$http

ILIAS HTTP Services ILIAS\Repository\Modal\ModalAdapterGUI::$http

protected

Definition at line 34 of file class.ModalAdapterGUI.php.

$http_util

HTTPUtil ILIAS\Repository\Modal\ModalAdapterGUI::$http_util

protected

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

Referenced by ILIAS\Repository\Modal\ModalAdapterGUI\__construct().

$refinery

ILIAS Refinery Factory ILIAS\Repository\Modal\ModalAdapterGUI::$refinery

protected

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

$title

string ILIAS\Repository\Modal\ModalAdapterGUI::$title = ""

protected

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

Referenced by ILIAS\Repository\Modal\ModalAdapterGUI\__construct(), and ILIAS\Repository\Modal\ModalAdapterGUI\getTitle().

$ui

ILIAS DI UIServices ILIAS\Repository\Modal\ModalAdapterGUI::$ui

protected

Definition at line 36 of file class.ModalAdapterGUI.php.

Referenced by ILIAS\Repository\Modal\ModalAdapterGUI\getAsyncTriggerButtonComponents(), ILIAS\Repository\Modal\ModalAdapterGUI\getTriggerButtonComponents(), and ILIAS\Repository\Modal\ModalAdapterGUI\renderAsyncTriggerButton().

$ui_content

array ILIAS\Repository\Modal\ModalAdapterGUI::$ui_content = null

protected

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

---

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

• Services/Repository/Service/Modal/class.ModalAdapterGUI.php