Collaboration diagram for ilBTControllerGUI:

Public Member Functions
	executeCommand ()

Static Public Member Functions
static	hash ($url)

static	unhash ($url)

Data Fields
const	FROM_URL = 'from_url'

const	OBSERVER_ID = 'observer_id'

const	SELECTED_OPTION = 'selected_option'

const	CMD_ABORT = 'abortBucket'

const	CMD_REMOVE = 'abortBucket'

const	CMD_USER_INTERACTION = 'userInteraction'

const	IS_ASYNC = 'bt_task_is_async'

const	CMD_GET_REPLACEMENT_ITEM = "getAsyncReplacementItem"

Protected Member Functions
	userInteraction ()

	abortBucket ()

	getAsyncReplacementItem ()
	Loads one single aggregate notification item representing a button async to replace an existing one. More...

	getFromURL ()

Detailed Description

Class ilBTControllerGUI.

Author: Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 12 of file class.ilBTControllerGUI.php.

Member Function Documentation

◆ abortBucket()

ilBTControllerGUI::abortBucket ( )

protected

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

    {
        $observer_id = (int) $this->http()->request()->getQueryParams()[self::OBSERVER_ID];
        $from_url = $this->getFromURL();
 
        $bucket = $this->dic()->backgroundTasks()->persistence()->loadBucket($observer_id);
 
        $this->dic()->backgroundTasks()->taskManager()->quitBucket($bucket);
        if ($this->http()->request()->getQueryParams()[self::IS_ASYNC] === "true") {
            exit;
        }
        $this->ctrl()->redirectToURL($from_url);
    }

References exit, getFromURL(), ILIAS\FileDelivery\http(), and OBSERVER_ID.

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilBTControllerGUI::executeCommand ( )

Definition at line 25 of file class.ilBTControllerGUI.php.

                                     : void
    {
        $cmd = $this->ctrl()->getCmd();
        switch ($cmd) {
            case self::CMD_GET_REPLACEMENT_ITEM:
                $this->getAsyncReplacementItem();
                break;
            case self::CMD_USER_INTERACTION:
                $this->userInteraction();
                break;
            case self::CMD_ABORT:
            case self::CMD_REMOVE:
                $this->abortBucket();
                break;
            default:
                break;
        }
    }

References abortBucket(), CMD_ABORT, CMD_GET_REPLACEMENT_ITEM, CMD_REMOVE, CMD_USER_INTERACTION, getAsyncReplacementItem(), and userInteraction().

Here is the call graph for this function:

◆ getAsyncReplacementItem()

ilBTControllerGUI::getAsyncReplacementItem ( )

protected

Loads one single aggregate notification item representing a button async to replace an existing one.

Definition at line 80 of file class.ilBTControllerGUI.php.

    {
        $observer_id = (int) $this->http()->request()->getQueryParams()[self::OBSERVER_ID];
        $bucket = $this->dic()->backgroundTasks()->persistence()->loadBucket($observer_id);
 
        $item_source = new ilBTPopOverGUI($this->dic());
        $this->dic()->language()->loadLanguageModule('background_tasks');
        $item = $item_source->getItemForObserver($bucket);
        echo $this->dic()->ui()->renderer()->renderAsync($item);
        exit;
    }

References exit, ILIAS\FileDelivery\http(), and OBSERVER_ID.

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFromURL()

ilBTControllerGUI::getFromURL ( )

protected

Returns: string

Definition at line 96 of file class.ilBTControllerGUI.php.

    {
        $from_url = self::unhash($this->http()->request()->getQueryParams()[self::FROM_URL]);
 
        return $from_url;
    }

References ILIAS\FileDelivery\http(), and unhash().

Referenced by abortBucket(), and userInteraction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hash()

static ilBTControllerGUI::hash ( $url )

static

Parameters

$url

Returns: string

Definition at line 109 of file class.ilBTControllerGUI.php.

    {
        return base64_encode($url);
    }

References $url.

Referenced by ilBTPopOverGUI\addFromUrlToNextRequest(), and ilMainMenuGUI\renderBackgroundTasks().

Here is the caller graph for this function:

◆ unhash()

static ilBTControllerGUI::unhash ( $url )

static

Parameters

$url

Returns: string

Definition at line 120 of file class.ilBTControllerGUI.php.

    {
        return base64_decode($url);
    }

References $url.

Referenced by getFromURL().

Here is the caller graph for this function:

◆ userInteraction()

ilBTControllerGUI::userInteraction ( )

protected

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

                                         : void
    {
        $observer_id = (int) $this->http()->request()->getQueryParams()[self::OBSERVER_ID];
        $selected_option = $this->http()->request()->getQueryParams()[self::SELECTED_OPTION];
        $from_url = $this->getFromURL();
 
        $observer = $this->dic()->backgroundTasks()->persistence()->loadBucket($observer_id);
        $option = new UserInteractionOption("", $selected_option);
        $this->dic()->backgroundTasks()->taskManager()->continueTask($observer, $option);
        if ($this->http()->request()->getQueryParams()[self::IS_ASYNC] === "true") {
            exit;
        }
        $this->ctrl()->redirectToURL($from_url);
    }