ilUserFeedWriter Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilUserFeedWriter:

Collaboration diagram for ilUserFeedWriter:

Public Member Functions
	__construct (int $a_user_id, string $a_hash, bool $privFeed=false)
Public Member Functions inherited from ilFeedWriter
	__construct ()
	setEncoding (string $a_enc)
	getEncoding ()
	setChannelAbout (string $a_ab)
	getChannelAbout ()
	setChannelTitle (string $a_title)
	getChannelTitle ()
	setChannelLink (string $a_link)
	getChannelLink ()
	setChannelDescription (string $a_desc)
	getChannelDescription ()
	addItem (ilFeedItem $a_item)
	getItems ()
	prepareStr (string $a_str)
	getFeed ()
	showFeed ()
	getContextPath (int $a_ref_id)

Protected Attributes
ilSetting	$settings
ilLanguage	$lng
Protected Attributes inherited from ilFeedWriter
ilTree	$tree
ilLanguage	$lng
ilTemplate	$tpl

Additional Inherited Members
Data Fields inherited from ilFeedWriter
string	$encoding = "UTF-8"
string	$ch_about = ""
string	$ch_title = ""
string	$ch_link = ""
string	$ch_description = ""
array	$items = array()

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Feed writer for personal user feeds.

Author

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

Definition at line 23 of file class.ilUserFeedWriter.php.

Constructor & Destructor Documentation

__construct()

ilUserFeedWriter::__construct	(	int	$a_user_id,
		string	$a_hash,
		bool	$privFeed = false
	)

Definition at line 28 of file class.ilUserFeedWriter.php.

References $DIC, $ilSetting, ilFeedWriter\$items, ILIAS\GlobalScreen\Provider\__construct(), ilNewsItem\_getNewsItemsOfUser(), ilObjForumAccess\_getThreadForPosting(), ilObjUser\_lookupFeedHash(), ilObject\_lookupObjId(), ilObjMediaCastAccess\_lookupOnline(), ilNewsItem\_lookupRSSPeriod(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilFeedWriter\addItem(), CLIENT_ID, ilNewsItem\determineNewsContent(), ilNewsItem\determineNewsTitle(), ilFeedWriter\getContextPath(), ILIAS\Repository\lng(), ilWikiPage\lookupTitle(), ilFeedWriter\prepareStr(), ilFeedWriter\setChannelAbout(), ilFeedWriter\setChannelLink(), ilFeedWriter\setChannelTitle(), and ILIAS\Repository\settings().

      {
        global $DIC;

        $this->settings = $DIC->settings();
        $this->lng = $DIC->language();
        $ilSetting = $DIC->settings();

        parent::__construct();

        if ($a_user_id == "" || $a_hash == "") {
            return;
        }

        $news_set = new ilSetting("news");
        if (!$news_set->get("enable_rss_for_internal")) {
            return;
        }

        $hash = ilObjUser::_lookupFeedHash($a_user_id);

        $rss_period = ilNewsItem::_lookupRSSPeriod();

        if ($a_hash == $hash) {
            if ($privFeed) {
                //ilNewsItem::setPrivateFeedId($a_user_id);
                $items = ilNewsItem::_getNewsItemsOfUser($a_user_id, false, true, $rss_period);
            } else {
                $items = ilNewsItem::_getNewsItemsOfUser($a_user_id, true, true, $rss_period);
            }

            if ($ilSetting->get('short_inst_name') != "") {
                $this->setChannelTitle($ilSetting->get('short_inst_name'));
            } else {
                $this->setChannelTitle("ILIAS");
            }

            $this->setChannelAbout(ILIAS_HTTP_PATH);
            $this->setChannelLink(ILIAS_HTTP_PATH);
            //$this->setChannelDescription("ILIAS Channel Description");
            foreach ($items as $item) {
                $obj_id = ilObject::_lookupObjId($item["ref_id"]);
                $obj_type = ilObject::_lookupType($obj_id);
                $obj_title = ilObject::_lookupTitle($obj_id);

                // not nice, to do: general solution
                if ($obj_type == "mcst") {
                    if (!ilObjMediaCastAccess::_lookupOnline($obj_id)) {
                        continue;
                    }
                }

                $feed_item = new ilFeedItem();
                $title = ilNewsItem::determineNewsTitle(
                    $item["context_obj_type"],
                    $item["title"],
                    (bool) $item["content_is_lang_var"],
                    (int) ($item["agg_ref_id"] ?? 0),
                    $item["aggregation"] ?? []
                );

                // path
                $loc = $this->getContextPath($item["ref_id"]);

                // title
                if ($news_set->get("rss_title_format") == "news_obj") {
                    $feed_item->setTitle($this->prepareStr(str_replace("<br />", " ", $title)) .
                        " (" . $this->prepareStr($loc) . " " . $this->prepareStr($obj_title) .
                        ")");
                } else {
                    $feed_item->setTitle($this->prepareStr($loc) . " " . $this->prepareStr($obj_title) .
                        ": " . $this->prepareStr(str_replace("<br />", " ", $title)));
                }

                // description
                $content = $this->prepareStr(nl2br(
                    ilNewsItem::determineNewsContent(
                        $item["context_obj_type"],
                        $item["content"],
                        $item["content_text_is_lang_var"]
                    )
                ));
                $feed_item->setDescription($content);

                // lm page hack, not nice
                if ($item["context_obj_type"] == "lm" && $item["context_sub_obj_type"] == "pg"
                    && $item["context_sub_obj_id"] > 0) {
                    $feed_item->setLink(ILIAS_HTTP_PATH . "/goto.php?client_id=" . CLIENT_ID .
                        "&amp;target=pg_" . $item["context_sub_obj_id"] . "_" . $item["ref_id"]);
                } elseif ($item["context_obj_type"] == "wiki" && $item["context_sub_obj_type"] == "wpg"
                    && $item["context_sub_obj_id"] > 0) {
                    $wptitle = ilWikiPage::lookupTitle($item["context_sub_obj_id"]);
                    $feed_item->setLink(ILIAS_HTTP_PATH . "/goto.php?client_id=" . CLIENT_ID .
                        "&amp;target=" . $item["context_obj_type"] . "_" . $item["ref_id"] . "_" . urlencode($wptitle)); // #14629
                } elseif ($item["context_obj_type"] == "frm" && $item["context_sub_obj_type"] == "pos"
                    && $item["context_sub_obj_id"] > 0) {
                    // frm hack, not nice
                    $thread_id = ilObjForumAccess::_getThreadForPosting($item["context_sub_obj_id"]);
                    if ($thread_id > 0) {
                        $feed_item->setLink(ILIAS_HTTP_PATH . "/goto.php?client_id=" . CLIENT_ID .
                            "&amp;target=" . $item["context_obj_type"] . "_" . $item["ref_id"] . "_" . $thread_id . "_" . $item["context_sub_obj_id"]);
                    } else {
                        $feed_item->setLink(ILIAS_HTTP_PATH . "/goto.php?client_id=" . CLIENT_ID .
                            "&amp;target=" . $item["context_obj_type"] . "_" . $item["ref_id"]);
                    }
                } else {
                    $feed_item->setLink(ILIAS_HTTP_PATH . "/goto.php?client_id=" . CLIENT_ID .
                        "&amp;target=" . $item["context_obj_type"] . "_" . $item["ref_id"]);
                }
                $feed_item->setAbout($feed_item->getLink() . "&amp;il_about_feed=" . $item["id"]);
                $feed_item->setDate($item["creation_date"]);
                $this->addItem($feed_item);
            }
        }
    }

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ilUserFeedWriter::$lng

protected

Definition at line 26 of file class.ilUserFeedWriter.php.

$settings

ilSetting ilUserFeedWriter::$settings

protected

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

---

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

• components/ILIAS/Feeds/classes/class.ilUserFeedWriter.php