ilPDNewsGUI Class Reference

News on PD. More...

Collaboration diagram for ilPDNewsGUI:

Public Member Functions
	__construct ()
	executeCommand ()
	displayHeader ()
	view ()
	applyFilter ()
	resetFilter ()

Protected Attributes
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilHelpGUI	$help
ilObjUser	$user
ilFavouritesManager	$fav_manager
StandardGUIRequest	$std_request

Detailed Description

News on PD.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilPDNewsGUI:

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

Constructor & Destructor Documentation

__construct()

ilPDNewsGUI::__construct

(

)

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

    {
        global $DIC;
 
        $this->help = $DIC["ilHelp"];
        $this->user = $DIC->user();
        $tpl = $DIC->ui()->mainTemplate();
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $ilHelp = $DIC["ilHelp"];
 
        $ilHelp->setScreenIdComponent("news");
 
        $this->std_request = new StandardGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );
 
        // initiate variables
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->ctrl = $ilCtrl;
 
        $lng->loadLanguageModule("news");
 
        $this->ctrl->saveParameter($this, "news_ref_id");
        $this->fav_manager = new ilFavouritesManager();
    }

References $DIC, $lng, $tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

applyFilter()

ilPDNewsGUI::applyFilter

(

)

Definition at line 167 of file class.ilPDNewsGUI.php.

                                 : void
    {
        $ilUser = $this->user;
 
        $news_ref_id = $this->std_request->getNewsRefId();
        $news_per = $this->std_request->getNewsPer();
 
        $this->ctrl->setParameter($this, "news_ref_id", $news_ref_id);
        $ilUser->writePref("news_sel_ref_id", (string) $news_ref_id);
        if ($news_per > 0) {
            ilSession::set("news_pd_news_per", $news_per);
        }
        $this->ctrl->redirect($this, "view");
    }

References $ilUser, $user, ILIAS\Repository\ctrl(), and ilSession\set().

Here is the call graph for this function:

displayHeader()

ilPDNewsGUI::displayHeader

(

)

Definition at line 82 of file class.ilPDNewsGUI.php.

                                   : void
    {
        $this->tpl->setTitle($this->lng->txt("news"));
        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_nwss.svg"));
    }

References ilUtil\getImagePath(), and ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPDNewsGUI::executeCommand

(

)

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

                                    : bool
    {
        $next_class = $this->ctrl->getNextClass();
 
        switch ($next_class) {
 
            default:
                $cmd = $this->ctrl->getCmd("view");
                $this->displayHeader();
                $this->$cmd();
                break;
        }
        $this->tpl->printToStdout();
        return true;
    }

References ILIAS\Repository\ctrl(), and displayHeader().

Here is the call graph for this function:

resetFilter()

ilPDNewsGUI::resetFilter

(

)

Definition at line 182 of file class.ilPDNewsGUI.php.

                                 : void
    {
        $ilUser = $this->user;
        $this->ctrl->setParameter($this, "news_ref_id", 0);
        $ilUser->writePref("news_sel_ref_id", '0');
        ilSession::clear("news_pd_news_per");
        $this->ctrl->redirect($this, "view");
    }

References $ilUser, $user, ilSession\clear(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

view()

ilPDNewsGUI::view

(

)

Definition at line 88 of file class.ilPDNewsGUI.php.

                          : void
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $tpl = $this->tpl;
 
        $ref_ids = [];
        $obj_ids = [];
        $pd_items = $this->fav_manager->getFavouritesOfUser($ilUser->getId());
        foreach ($pd_items as $item) {
            $ref_ids[] = (int) $item["ref_id"];
            $obj_ids[] = (int) $item["obj_id"];
        }
 
        $sel_ref_id = ($this->std_request->getNewsRefId() > 0)
            ? $this->std_request->getNewsRefId()
            : $ilUser->getPref("news_sel_ref_id");
 
        $per = (ilSession::get("news_pd_news_per") != "")
            ? ilSession::get("news_pd_news_per")
            : ilNewsItem::_lookupUserPDPeriod($ilUser->getId());
        $news_obj_ids = ilNewsItem::filterObjIdsPerNews($obj_ids, $per);
 
        // related objects (contexts) of news
        $contexts[0] = $lng->txt("news_all_items");
 
        $conts = [];
        $sel_has_news = false;
        foreach ($ref_ids as $ref_id) {
            $obj_id = ilObject::_lookupObjId($ref_id);
            $title = ilObject::_lookupTitle($obj_id);
 
            $conts[$ref_id] = $title;
            if ((int) $sel_ref_id === $ref_id) {
                $sel_has_news = true;
            }
        }
 
        $cnt = [];
        $nitem = new ilNewsItem();
        $news_items = ilNewsItem::_getNewsItemsOfUser(
            $ilUser->getId(),
            false,
            true,
            $per,
            $cnt
        );
 
        // reset selected news ref id, if no news are given for id
        if (!$sel_has_news) {
            $sel_ref_id = "";
        }
        asort($conts);
        foreach ($conts as $ref_id => $title) {
            $contexts[$ref_id] = $title . " (" . (int) ($cnt[$ref_id] ?? 0) . ")";
        }
 
 
        if ($sel_ref_id > 0) {
            $obj_id = ilObject::_lookupObjId((int) $sel_ref_id);
            $obj_type = ilObject::_lookupType($obj_id);
            $nitem->setContextObjId($obj_id);
            $nitem->setContextObjType($obj_type);
            $news_items = $nitem->getNewsForRefId(
                $sel_ref_id,
                false,
                false,
                $per,
                true
            );
        }
 
        $pd_news_table = new ilPDNewsTableGUI($this, "view", $contexts, $sel_ref_id);
        $pd_news_table->setData($news_items);
        $pd_news_table->setNoEntriesText($lng->txt("news_no_news_items"));
 
        $tpl->setContent($pd_news_table->getHTML());
    }

References $ilUser, $lng, $ref_id, $tpl, $user, ilNewsItem\_getNewsItemsOfUser(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilNewsItem\_lookupUserPDPeriod(), ilNewsItem\filterObjIdsPerNews(), ilSession\get(), ILIAS\Repository\int(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrl ilPDNewsGUI::$ctrl

protected

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

$fav_manager

ilFavouritesManager ilPDNewsGUI::$fav_manager

protected

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

$help

ilHelpGUI ilPDNewsGUI::$help

protected

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

$lng

ilLanguage ilPDNewsGUI::$lng

protected

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

Referenced by __construct(), and view().

$std_request

StandardGUIRequest ilPDNewsGUI::$std_request

protected

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

$tpl

ilGlobalTemplateInterface ilPDNewsGUI::$tpl

protected

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

Referenced by __construct(), and view().

$user

ilObjUser ilPDNewsGUI::$user

protected

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

Referenced by applyFilter(), resetFilter(), and view().

---

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

• Services/News/classes/class.ilPDNewsGUI.php