ilBTPopOverGUI Class Reference

Class ilBTPopOverGUI. More...

Collaboration diagram for ilBTPopOverGUI:

Public Member Functions
	__construct (\ILIAS\DI\Container $dic)
	getNotificationItem (int $nr_buckets)
	Get the Notification Items. More...
	getItemForObserver (Bucket $observer)

Protected Member Functions
	getAggregateItems ()
	getItemWithOnCloseDecoration (ILIAS\UI\Component\Item\Notification $item)

Protected Attributes
	$dic

Private Member Functions
	getDefaultCardContent (Bucket $observer)
	getProgressbar (Bucket $observer)
	getCloseButtonAction (UserInteraction\Option $option, $redirect_uri, Bucket $observer)
	getRefreshUrl (Bucket $observer)
	addFromUrlToNextRequest (string $redirect_uri)
	txt (string $id)

Detailed Description

Class ilBTPopOverGUI.

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 18 of file class.ilBTPopOverGUI.php.

Constructor & Destructor Documentation

__construct()

ilBTPopOverGUI::__construct

(

\ILIAS\DI\Container

$dic

)

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

References $dic.

    {
        $this->dic = $dic;
    }

Member Function Documentation

addFromUrlToNextRequest()

ilBTPopOverGUI::addFromUrlToNextRequest ( string  $redirect_uri )

private

Definition at line 264 of file class.ilBTPopOverGUI.php.

References ilBTControllerGUI\FROM_URL, and ilBTControllerGUI\hash().

Referenced by getCloseButtonAction(), and getDefaultCardContent().

                                                                   : void
    {
        $this->dic->ctrl()->setParameterByClass(ilBTControllerGUI::class, ilBTControllerGUI::FROM_URL, ilBTControllerGUI::hash($redirect_uri));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAggregateItems()

ilBTPopOverGUI::getAggregateItems ( )

protected

Returns

ILIAS[]

Definition at line 54 of file class.ilBTPopOverGUI.php.

References getItemForObserver().

Referenced by getNotificationItem().

                                           : array
    {
        $persistence = $this->dic->backgroundTasks()->persistence();
        $items = [];
        $observer_ids = $persistence->getBucketIdsOfUser($this->dic->user()->getId(), 'id', 'DESC');
        foreach ($persistence->loadBuckets($observer_ids) as $observer) {
            $items[] = $this->getItemForObserver($observer);
        }

        return $items;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCloseButtonAction()

ilBTPopOverGUI::getCloseButtonAction ( UserInteraction\Option  $option,   $redirect_uri, Bucket  $observer  )

private

Definition at line 229 of file class.ilBTPopOverGUI.php.

References addFromUrlToNextRequest(), ilBTControllerGUI\CMD_ABORT, ilBTControllerGUI\CMD_REMOVE, ilBTControllerGUI\CMD_USER_INTERACTION, ilBTControllerGUI\IS_ASYNC, ilBTControllerGUI\OBSERVER_ID, and ilBTControllerGUI\SELECTED_OPTION.

Referenced by getItemForObserver().

                                                                                                           : string
    {
        $ctrl = $this->dic->ctrl();
        $persistence = $this->dic->backgroundTasks()->persistence();
        $ctrl->setParameterByClass(ilBTControllerGUI::class, ilBTControllerGUI::OBSERVER_ID, $persistence->getBucketContainerId($observer));
        $this->addFromUrlToNextRequest($redirect_uri);
        $ctrl->setParameterByClass(ilBTControllerGUI::class, ilBTControllerGUI::IS_ASYNC, "true");

        switch ($option->getValue()) {
            case AbstractTask::MAIN_ABORT:
                $action = $ctrl->getLinkTargetByClass([ilBTControllerGUI::class], ilBTControllerGUI::CMD_ABORT);
                break;
            case AbstractTask::MAIN_REMOVE:
                $action = $ctrl->getLinkTargetByClass([ilBTControllerGUI::class], ilBTControllerGUI::CMD_REMOVE);
                break;
            default:
                $ctrl->setParameterByClass(ilBTControllerGUI::class, ilBTControllerGUI::SELECTED_OPTION, $option->getValue());
                $action = $ctrl->getLinkTargetByClass([ilBTControllerGUI::class], ilBTControllerGUI::CMD_USER_INTERACTION);
                break;
        }

        return $action;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultCardContent()

ilBTPopOverGUI::getDefaultCardContent ( Bucket  $observer )

private

Definition at line 146 of file class.ilBTPopOverGUI.php.

References $factory, addFromUrlToNextRequest(), ilBTControllerGUI\CMD_USER_INTERACTION, ilBTControllerGUI\FROM_URL, ILIAS\BackgroundTasks\Bucket\getCurrentTask(), getProgressbar(), ilBTControllerGUI\hash(), ilBTControllerGUI\OBSERVER_ID, and ilBTControllerGUI\SELECTED_OPTION.

Referenced by getItemForObserver().

                                                             : Legacy
    {
        return $this->getProgressbar($observer);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getItemForObserver()

ilBTPopOverGUI::getItemForObserver

(

Bucket

$observer

)

Definition at line 67 of file class.ilBTPopOverGUI.php.

References Vendor\Package\$f, $message, $url, getCloseButtonAction(), ILIAS\BackgroundTasks\Bucket\getCurrentTask(), getDefaultCardContent(), getItemWithOnCloseDecoration(), ILIAS\BackgroundTasks\Bucket\getLastHeartbeat(), getProgressbar(), getRefreshUrl(), ILIAS\BackgroundTasks\Bucket\getState(), ILIAS\BackgroundTasks\Bucket\getTitle(), and txt().

Referenced by getAggregateItems().

                                                         : ILIAS\UI\Component\Item\Notification
    {
        $redirect_uri = "//{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}";

        $f = $this->dic->ui()->factory();

        $state = (int) $observer->getState();
        $current_task = $observer->getCurrentTask();

        $icon = $f->symbol()->icon()->standard("bgtk", $this->txt("bg_task"));
        $title = $observer->getTitle() . ($state === State::SCHEDULED ? " ({$this->txt('scheduled')})" : "");


        $description_text = $this->txt('background_tasks');

        if ($state === State::USER_INTERACTION) {
            $actions = $this->getUserInteractionContent($observer, $redirect_uri);
            $primary_action = array_pop($actions);
            if ($primary_action instanceof Button) {
                $title = $primary_action->withLabel($title);
            }

            $item = $f->item()->notification($title, $icon);
            $item = $this->getItemWithOnCloseDecoration($item);

//            $item = $item->withProperties([
//                $this->dic->language()->txt('nc_mail_prop_time') => \ilDatePresentation::formatDate(
//                    new \ilDateTime(time(), IL_CAL_UNIX)
//                )
//            ]);

            $item = $item->withActions($f->dropdown()->standard($actions));
            $input = $current_task->getInput();
            $message = $current_task->getMessage($input);

            if ((!empty($message)) and ($message != null)) {
                $item = $item->withDescription($message);
            } else {
                $item = $item->withAdditionalContent($this->getProgressbar($observer));
            }

            return $item->withCloseAction(
                $this->getCloseButtonAction($current_task->getRemoveOption(), $redirect_uri, $observer)
            );
        }

        $item = $f->item()->notification($title, $icon);
        $item = $this->getItemWithOnCloseDecoration($item);

        if ($state === State::RUNNING) {
            $url = $this->getRefreshUrl($observer);
            //Running Items probably need to refresh themselves, right?
            $item = $item->withAdditionalOnLoadCode(function ($id) use ($url) {
                //Note this is only for demo purposes, adapt as needed.
                return "var notification_item = il.UI.item.notification.getNotificationItemObject($('#$id'));
                    il.BGTask.refreshItem(notification_item,'$url');";
            });

            $expected = $current_task->getExpectedTimeOfTaskInSeconds();
            $possibly_failed = ($observer->getLastHeartbeat() < (time() - $expected));
            if ($possibly_failed === true) {
                $item = $item->withDescription($this->txt('task_might_be_failed'));
                $item = $item->withCloseAction(
                    $this->getCloseButtonAction($current_task->getAbortOption(), $redirect_uri, $observer)
                );
            }
        }

        return $item->withAdditionalContent($this->getDefaultCardContent($observer));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getItemWithOnCloseDecoration()

ilBTPopOverGUI::getItemWithOnCloseDecoration ( ILIAS\UI\Component\Item\Notification  $item )

protected

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

References txt().

Referenced by getItemForObserver().

                                                                                                : ILIAS\UI\Component\Item\Notification
    {
        $description_text = $this->txt('background_tasks');
        return $item->withAdditionalOnLoadCode(function ($id) use ($description_text) {
            return "il.BGTask.updateDescriptionOnClose('#$id','$description_text');";
        });
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNotificationItem()

ilBTPopOverGUI::getNotificationItem

(

int

$nr_buckets

)

Get the Notification Items.

DOES NOT DO ANY PERMISSION CHECKS.

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

References getAggregateItems(), and txt().

                                                         : ILIAS\UI\Component\Item\Notification
    {
        $ui_factory = $this->dic->ui()->factory();

        $title = $ui_factory->link()->standard($this->txt('background_tasks'), '#');
        $icon = $ui_factory->symbol()->icon()->standard('bgtk', $this->txt('background_tasks'));

        return $this->dic->ui()->factory()
            ->item()
            ->notification($title, $icon)
            ->withDescription("$nr_buckets {$this->txt('background_tasks')}")
            ->withAggregateNotifications($this->getAggregateItems());
    }

Here is the call graph for this function:

getProgressbar()

ilBTPopOverGUI::getProgressbar ( Bucket  $observer )

private

Definition at line 201 of file class.ilBTPopOverGUI.php.

References ILIAS\BackgroundTasks\Bucket\getOverallPercentage(), and ILIAS\BackgroundTasks\Bucket\getState().

Referenced by getDefaultCardContent(), and getItemForObserver().

                                                      : Legacy
    {
        $percentage = $observer->getOverallPercentage();

        switch (true) {
            case ((int) $percentage === 100):
                $running = "";
                $content = $this->dic->language()->txt("completed");
                break;
            case ((int) $observer->getState() === State::USER_INTERACTION):
                $running = "";
                $content = $this->dic->language()->txt("waiting");
                break;
            default:
                $running = "active";
                $content = "{$percentage}%";
                break;
        }

        return $this->dic->ui()->factory()->legacy(" <div class='progress'>
                    <div class='progress-bar progress-bar-striped {$running}' role='progressbar' aria-valuenow='{$percentage}'
                        aria-valuemin='0' aria-valuemax='100' style='width:{$percentage}%'>
                        {$content}
                    </div>
                                </div> ");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRefreshUrl()

ilBTPopOverGUI::getRefreshUrl ( Bucket  $observer )

private

Definition at line 254 of file class.ilBTPopOverGUI.php.

References ilBTControllerGUI\CMD_GET_REPLACEMENT_ITEM, and ilBTControllerGUI\OBSERVER_ID.

Referenced by getItemForObserver().

                                                     : string
    {
        $ctrl = $this->dic->ctrl();
        $persistence = $this->dic->backgroundTasks()->persistence();
        $ctrl->setParameterByClass(ilBTControllerGUI::class, ilBTControllerGUI::OBSERVER_ID, $persistence->getBucketContainerId($observer));

        return $ctrl->getLinkTargetByClass([ilBTControllerGUI::class], ilBTControllerGUI::CMD_GET_REPLACEMENT_ITEM);
    }

Here is the caller graph for this function:

txt()

ilBTPopOverGUI::txt ( string  $id )

private

Definition at line 270 of file class.ilBTPopOverGUI.php.

Referenced by getItemForObserver(), getItemWithOnCloseDecoration(), and getNotificationItem().

                                     : string
    {
        return $this->dic->language()->txt($id);
    }

Here is the caller graph for this function:

Field Documentation

$dic

ilBTPopOverGUI::$dic

protected

Definition at line 24 of file class.ilBTPopOverGUI.php.

Referenced by __construct().

---

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

• Services/BackgroundTasks/classes/class.ilBTPopOverGUI.php