ilAwarenessGUI Class Reference

Awareness GUI class. More...

Inheritance diagram for ilAwarenessGUI:

Collaboration diagram for ilAwarenessGUI:

Public Member Functions
	__construct (?InternalDataService $data_service=null, ?InternalDomainService $domain_service=null, ?InternalGUIService $gui_service=null)
	executeCommand ()
	initJS ()
	getAwarenessList (bool $return=false)
	Get awareness list (ajax) More...

Protected Attributes
InternalGUIService	$gui
ilGlobalTemplateInterface	$main_tpl
int	$ref_id
ILIAS Awareness StandardGUIRequest	$request
WidgetManager	$manager
ilObjUser	$user
ilCtrl	$ctrl
UIServices	$ui
ilLanguage	$lng
InternalDataService	$data_service
ilUserActionGUI	$user_action_gui

Detailed Description

Awareness GUI class.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilAwarenessGUI::__construct	(	?InternalDataService	$data_service = null,
		?InternalDomainService	$domain_service = null,
		?InternalGUIService	$gui_service = null
	)

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

References $DIC, $lng, $ref_id, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->data_service = $data_service
            ?? $DIC->awareness()->internal()->data();
        $domain_service = $domain_service
            ?? $DIC->awareness()->internal()->domain();
        $gui_service = $gui_service
            ?? $DIC->awareness()->internal()->gui();
        $this->user = $domain_service->user();
        $this->lng = $domain_service->lng();
        $this->ui = $gui_service->ui();
        $this->ctrl = $gui_service->ctrl();

        $this->lng->loadLanguageModule("awrn");
        $this->request = $gui_service->standardRequest();
        $this->main_tpl = $gui_service->mainTemplate();

        $this->ref_id = $this->request->getRefId();
        $this->manager = $domain_service->widget(
            $this->user->getId(),
            $this->ref_id
        );
        $this->gui = $DIC->awareness()->internal()->gui();
        $this->user_action_gui = new ilUserActionGUI(
            new ilUserActionProviderFactory(),
            new ilAwarenessUserActionContext(),
            $DIC['tpl'],
            $this->ui->factory(),
            $this->ui->renderer(),
            $this->lng,
            $DIC['ilDB'],
            $this->user->getId()
        );
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilAwarenessGUI::executeCommand

(

)

Definition at line 83 of file class.ilAwarenessGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        $cmd = $this->ctrl->getCmd();

        if (in_array($cmd, array("getAwarenessList"))) {
            $this->$cmd();
        }
    }

Here is the call graph for this function:

getAwarenessList()

ilAwarenessGUI::getAwarenessList

(

bool

$return = false

)

Get awareness list (ajax)

Returns

?array<string,string>

Exceptions

ilWACException

Definition at line 117 of file class.ilAwarenessGUI.php.

References exit, initJS(), ILIAS\Repository\lng(), and ilLegacyFormElementsUtil\prepareFormOutput().

                                                          : ?array
    {
        $filter = $this->request->getFilter();

        $tpl = new ilTemplate("tpl.awareness_list.html", true, true, "components/ILIAS/Awareness");

        $ad = $this->manager->getListData($filter);

        $users = $ad["data"];

        $ucnt = 0;
        $last_uc_title = "";
        foreach ($users as $u) {
            if ($u->collector != $last_uc_title) {
                if ($u->highlighted) {
                    $tpl->touchBlock("highlighted");
                }
                $tpl->setCurrentBlock("uc_title");
                $tpl->setVariable("UC_TITLE", $u->collector);
                $tpl->parseCurrentBlock();
                $tpl->setCurrentBlock("item");
                $tpl->parseCurrentBlock();
            }
            $last_uc_title = $u->collector;

            $ucnt++;

            $fcnt = 0;
            foreach ($u->actions as $act) {
                $fcnt++;
                if ($fcnt == 1) {
                    $tpl->touchBlock("arrow");
                    //$tpl->setCurrentBlock("arrow");
                    //$tpl->parseCurrentBlock();
                }
                if (is_array($act->data) && count($act->data) > 0) {
                    foreach ($act->data as $k => $v) {
                        $tpl->setCurrentBlock("f_data");
                        $tpl->setVariable("DATA_KEY", $k);
                        $tpl->setVariable("DATA_VAL", ilLegacyFormElementsUtil::prepareFormOutput($v));
                        $tpl->parseCurrentBlock();
                    }
                }
                $tpl->setCurrentBlock("feature");
                $tpl->setVariable("FEATURE_HREF", $act->href);
                $tpl->setVariable("FEATURE_TEXT", $act->text);
                $tpl->parseCurrentBlock();
            }

            if ($u->online) {
                $tpl->touchBlock("uonline");
                $tpl->setCurrentBlock("uonline_text");
                $tpl->setVariable("TXT_ONLINE", $this->lng->txt("awrn_online"));
                $tpl->parseCurrentBlock();
            }

            $tpl->setCurrentBlock("user");
            if ($u->public_profile) {
                $tpl->setVariable("UNAME", $u->lastname . ", " . $u->firstname);
            } else {
                $tpl->setVariable("UNAME", "-");
            }
            $tpl->setVariable("UACCOUNT", $u->login);

            $tpl->setVariable("USERIMAGE", $u->img);
            $tpl->setVariable("CNT", $ucnt);
            $tpl->parseCurrentBlock();
            $tpl->setCurrentBlock("item");
            $tpl->parseCurrentBlock();
        }

        $tpl->setCurrentBlock("filter");
        $tpl->setVariable("GL_FILTER", $this->gui->symbol()->glyph("filter")->render());
        $tpl->setVariable("FILTER_INPUT_LABEL", $this->lng->txt("awrn_filter"));
        $tpl->parseCurrentBlock();


        $result = ["html" => $tpl->get(),
                   "filter_val" => ilLegacyFormElementsUtil::prepareFormOutput($filter),
                   "cnt" => $ad["cnt"]];

        if ($return) {
            $this->initJS();
            return $result;
        }

        echo json_encode($result, JSON_THROW_ON_ERROR);
        exit;
    }

Here is the call graph for this function:

initJS()

ilAwarenessGUI::initJS

(

)

Definition at line 92 of file class.ilAwarenessGUI.php.

References $user, ILIAS\Repository\ctrl(), and ilUtil\getImagePath().

Referenced by getAwarenessList().

                            : void
    {
        $ilUser = $this->user;
        // init js
        //$this->main_tpl->addJavaScript("../components/ILIAS/Awareness/resources/Awareness.js");
        $this->main_tpl->addJavaScript("./assets/js/Awareness.js");
        $this->ctrl->setParameter($this, "ref_id", $this->ref_id);
        $this->main_tpl->addOnLoadCode("il.Awareness.setBaseUrl('" . $this->ctrl->getLinkTarget(
            $this,
            "",
            "",
            true,
            false
        ) . "');");
        $this->main_tpl->addOnLoadCode("il.Awareness.setLoaderSrc('" . ilUtil::getImagePath("media/loader.svg") . "');");
        $this->main_tpl->addOnLoadCode("il.Awareness.init();");

        $this->user_action_gui->init();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ilAwarenessGUI::$ctrl

protected

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

$data_service

InternalDataService ilAwarenessGUI::$data_service

protected

Definition at line 40 of file class.ilAwarenessGUI.php.

$gui

InternalGUIService ilAwarenessGUI::$gui

protected

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

$lng

ilLanguage ilAwarenessGUI::$lng

protected

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

Referenced by __construct().

$main_tpl

ilGlobalTemplateInterface ilAwarenessGUI::$main_tpl

protected

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

$manager

WidgetManager ilAwarenessGUI::$manager

protected

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

$ref_id

int ilAwarenessGUI::$ref_id

protected

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

Referenced by __construct().

$request

ILIAS Awareness StandardGUIRequest ilAwarenessGUI::$request

protected

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

$ui

UIServices ilAwarenessGUI::$ui

protected

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

$user

ilObjUser ilAwarenessGUI::$user

protected

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

Referenced by initJS().

$user_action_gui

ilUserActionGUI ilAwarenessGUI::$user_action_gui

protected

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

---

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

• components/ILIAS/Awareness/classes/class.ilAwarenessGUI.php