ilBTPopOverGUI Class Reference

Class ilBTPopOverGUI. More...

Collaboration diagram for ilBTPopOverGUI:

Public Member Functions
	__construct (Factory $uiFactory, Persistence $btPersistence, \ilLanguage $lng, ilCtrl $ctrl)
	ilBTPopOverGUI constructor. More...
	getPopOverContent ($user_id, $redirect_uri, $replace_url='')
	Get the content for the popover as ui element. More...
	getDefaultCardContent (Bucket $observer)

Protected Member Functions
	getProgressbar (Bucket $observer)
	addButton (UserInteraction\Option $option, $redirect_uri, ilTemplate $bucket, Bucket $observer)
	addFromUrlToNextRequest ($redirect_uri)

Protected Attributes
	$btPersistence

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

Constructor & Destructor Documentation

__construct()

ilBTPopOverGUI::__construct	(	Factory	$uiFactory,
		Persistence	$btPersistence,
		\ilLanguage	$lng,
		ilCtrl	$ctrl
	)

ilBTPopOverGUI constructor.

Parameters

\ILIAS\UI\Factory	$uiFactory
\ILIAS\BackgroundTasks\Persistence	$btPersistence
\ilLanguage	$lng
\ilCtrl	$ctrl

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

References $btPersistence.

    {
        $this->btPersistence = $btPersistence;
        $this->lng()->loadLanguageModule('background_tasks');
    }

Member Function Documentation

addButton()

ilBTPopOverGUI::addButton ( UserInteraction\Option  $option,   $redirect_uri, ilTemplate  $bucket, Bucket  $observer  )

protected

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

References $action, $r, addFromUrlToNextRequest(), ilBTControllerGUI\CMD_ABORT, ilBTControllerGUI\CMD_REMOVE, ilBTControllerGUI\CMD_USER_INTERACTION, ilBTControllerGUI\OBSERVER_ID, ilTemplate\parseCurrentBlock(), ilBTControllerGUI\SELECTED_OPTION, ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by getPopOverContent().

    {
        $r = $this->ui()->renderer();
        $f = $this->ui()->factory();
        $persistence = $this->dic()->backgroundTasks()->persistence();
        // Close Action
        $bucket->setCurrentBlock('close_button');

        $this->ctrl()
             ->setParameterByClass(ilBTControllerGUI::class, ilBTControllerGUI::OBSERVER_ID, $persistence->getBucketContainerId($observer));
        $this->addFromUrlToNextRequest($redirect_uri);

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

        $label = $this->lng()->txt($option->getLangVar());

        $remove = $r->render($f->button()->standard($label, $action));

        $bucket->setVariable("CLOSE_BUTTON", $remove);
        $bucket->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addFromUrlToNextRequest()

ilBTPopOverGUI::addFromUrlToNextRequest (   $redirect_uri )

protected

Parameters

$redirect_uri

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

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

Referenced by addButton(), and getDefaultCardContent().

    {
        $this->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:

getDefaultCardContent()

ilBTPopOverGUI::getDefaultCardContent

(

Bucket

$observer

)

Parameters

\ILIAS\BackgroundTasks\Bucket

$observer

Returns

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

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

    {
        $progressbar = $this->getProgressbar($observer);

        return $progressbar;
    }

Here is the call graph for this function:

getPopOverContent()

ilBTPopOverGUI::getPopOverContent	(		$user_id,
			$redirect_uri,
			$replace_url = ''
	)

Get the content for the popover as ui element.

DOES NOT DO ANY PERMISSION CHECKS.

Parameters

int	$user_id
null	$redirect_uri

Returns

[]

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

References $r, $state, addButton(), ILIAS\BackgroundTasks\BucketMeta\getState(), time, and user().

    {
        $r = $this->ui()->renderer();
        $f = $this->ui()->factory();
        $persistence = $this->dic()->backgroundTasks()->persistence();

        $observer_ids = $this->btPersistence->getBucketIdsOfUser($user_id, 'id', 'DESC');
        $observers = $this->btPersistence->loadBuckets($observer_ids);

        $metas = $persistence->getBucketMetaOfUser($this->user()->getId());
        $user_inter = count(array_filter($metas, function (BucketMeta $meta) {
            return $meta->getState() == State::USER_INTERACTION;
        }));

        $po_content = new ilTemplate("tpl.popover_content.html", true, true, "Services/BackgroundTasks");
        $po_content->setVariable("BACKGROUND_TASKS_TOTAL", count($metas));
        $po_content->setVariable("BACKGROUND_TASKS_USER_INTERACTION", $user_inter);

        $bucket = new ilTemplate("tpl.bucket.html", true, true, "Services/BackgroundTasks");

        foreach ($observers as $observer) {
            $state = (int) $observer->getState();
            $current_task = $observer->getCurrentTask();

            switch ($state) {
                case State::USER_INTERACTION:
                    $bucket->setVariable("CONTENT", $r->render($this->getProgressbar($observer)));
                    $bucket->setVariable("INTERACTIONS", $r->render([
                        $this->getUserInteractionContent($observer, $redirect_uri),
                    ]));
                    break;
                case State::RUNNING:
                    $expected = (int) $current_task->getExpectedTimeOfTaskInSeconds();
                    $possibly_failed = (bool) ($observer->getLastHeartbeat() < (time() - $expected));

                    if ($possibly_failed) {
                        $bucket->setCurrentBlock('failed');
                        $bucket->setVariable("ALERT", $this->lng()->txt('task_might_be_failed'));
                        $bucket->parseCurrentBlock();
                        $this->addButton($current_task->getAbortOption(), $redirect_uri, $bucket, $observer);
                    }
                    $bucket->setVariable("CONTENT", $r->render($this->getDefaultCardContent($observer)));
                    break;
                default:
                    $bucket->setVariable("CONTENT", $r->render($this->getDefaultCardContent($observer)));
                    break;
            }

            if ($state === State::USER_INTERACTION) {
                $this->addButton($current_task->getRemoveOption(), $redirect_uri, $bucket, $observer);
            }

            $bucket->setCurrentBlock("bucket");
            $bucket_title = $observer->getTitle() . ($state
                                                     == State::SCHEDULED ? " ({$this->lng()->txt("scheduled")})" : "");
            $bucket->setVariable("BUCKET_TITLE", $bucket_title);
            if ($observer->getDescription()) {
                $bucket->setVariable("BUCKET_DESCRIPTION", $observer->getDescription());
            }
            $bucket->parseCurrentBlock();
        }
        $po_content->setVariable("CONTENT", $bucket->get());
        $uiElement = $f->legacy($po_content->get());

        return $uiElement;
    }

Here is the call graph for this function:

getProgressbar()

ilBTPopOverGUI::getProgressbar ( Bucket  $observer )

protected

Parameters

\ILIAS\BackgroundTasks\Bucket

$observer

Returns

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

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

Referenced by getDefaultCardContent().

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

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

        return $this->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:

Field Documentation

$btPersistence

ilBTPopOverGUI::$btPersistence

protected

Definition at line 26 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