ilObjectFeedWriter 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 ilObjectFeedWriter:

Collaboration diagram for ilObjectFeedWriter:

Public Member Functions
	__construct (int $a_ref_id, ?int $a_userid=null, string $a_purpose=null)
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 objects.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilObjectFeedWriter::__construct	(	int	$a_ref_id,
		?int	$a_userid = null,
		string	$a_purpose = null
	)

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

      {
        global $DIC;
 
        $this->settings = $DIC->settings();
        $this->lng = $DIC->language();
        $ilSetting = $DIC->settings();
        $lng = $DIC->language();
 
        parent::__construct();
 
        if ($a_ref_id <= 0) {
            return;
        }
 
        $news_set = new ilSetting("news");
        if (!$news_set->get("enable_rss_for_internal")) {
            return;
        }
        $obj_id = ilObject::_lookupObjId($a_ref_id);
        $obj_type = ilObject::_lookupType($obj_id);
        $obj_title = ilObject::_lookupTitle($obj_id);
 
        if (!ilBlockSetting::_lookup("news", "public_feed", 0, $obj_id)) {
            return;
        }
 
        // path
        $loc = $this->getContextPath($a_ref_id);
 
        if ($ilSetting->get('short_inst_name') != "") {
            $this->setChannelTitle($ilSetting->get('short_inst_name') . " - " .
                $this->prepareStr($loc . " " . $obj_title));
        } else {
            $this->setChannelTitle("ILIAS" . " - " .
                $this->prepareStr($loc . " " . $obj_title . ($a_purpose ? " - " . $a_purpose : "")));
        }
        $this->setChannelAbout(ILIAS_HTTP_PATH);
        $this->setChannelLink(ILIAS_HTTP_PATH);
        // not nice, to do: general solution
        if ($obj_type == "mcst") {
            if (!ilObjMediaCastAccess::_lookupOnline($obj_id)) {
                $lng->loadLanguageModule("mcst");
 
                $feed_item = new ilFeedItem();
                $feed_item->setTitle($lng->txt("mcst_media_cast_not_online"));
                $feed_item->setDescription($lng->txt("mcst_media_cast_not_online_text"));
                $feed_item->setLink(ILIAS_HTTP_PATH . "/goto.php?client_id=" . CLIENT_ID .
                    "&amp;target=mcst_" . $a_ref_id);
                $this->addItem($feed_item);
                return;
            }
        }
 
        $rss_period = ilNewsItem::_lookupRSSPeriod();
 
        ilNewsItem::setPrivateFeedId($a_userid);
        $news_item = new ilNewsItem();
        $news_item->setContextObjId($obj_id);
        $news_item->setContextObjType($obj_type);
        $items = $news_item->getNewsForRefId($a_ref_id, true, false, $rss_period, true);
 
        $i = 0;
        foreach ($items as $item) {
            $i++;
 
            if ($a_purpose != null && $obj_type == "mcst") {
                $mob = ilMediaItem::_getMediaItemsOfMObId($item["mob_id"], $a_purpose);
 
                if ($mob == false) {
                    continue;
                }
            }
 
            $obj_title = ilObject::_lookupTitle($item["context_obj_id"]);
 
            $feed_item = new ilFeedItem();
 
            $title = ilNewsItem::determineNewsTitle(
                $item["context_obj_type"],
                $item["title"],
                $item["content_is_lang_var"],
                (int) ($item["agg_ref_id"] ?? 0),
                $item["aggregation"] ?? []
            );
 
            $loc = "";
 
            if ($news_set->get("rss_title_format") == "news_obj") {
                $sep = (trim($this->prepareStr($loc)) == "")
                    ? ""
                    : " ";
                $feed_item->setTitle($this->prepareStr($title) . " (" . $this->prepareStr($loc) . $sep . $this->prepareStr($obj_title) .
                    ")");
            } else {
                $feed_item->setTitle($this->prepareStr($loc) . " " . $this->prepareStr($obj_title) .
                    ": " . $this->prepareStr($title));
            }
            $feed_item->setDescription($this->prepareStr(nl2br(
                ilNewsItem::determineNewsContent(
                    $item["context_obj_type"],
                    $item["content"],
                    $item["content_text_is_lang_var"]
                )
            )));
 
            // lm 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 = ilWikiUtil::makeUrlTitle(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"] . "_" . $wptitle);
            } 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"]);
                //echo "<br>".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"]);
 
            // Enclosure
            if ($item["content_type"] == NEWS_AUDIO &&
                $item["mob_id"] > 0 && ilObject::_exists($item["mob_id"])) {
                $go_on = true;
                if ($obj_type == "mcst") {
                    if (!ilObjMediaCastAccess::_lookupPublicFiles($obj_id)) {
                        $go_on = false;
                    }
                }
 
                if ($go_on && isset($mob)) {
                    $url = ilObjMediaObject::_lookupItemPath($item["mob_id"], true, true, $mob["purpose"]);
                    $file = ilObjMediaObject::_lookupItemPath($item["mob_id"], false, false, $mob["purpose"]);
                    $size = 0;
                    if (is_file($file)) {
                        $size = filesize($file);
                    }
                    $feed_item->setEnclosureUrl($url);
                    $feed_item->setEnclosureType((isset($mob["format"])) ? $mob["format"] : "audio/mpeg");
                    $feed_item->setEnclosureLength($size);
                }
            }
            $this->addItem($feed_item);
        }
    }

References $DIC, $i, $ilSetting, ilFeedWriter\$items, $lng, $url, ILIAS\GlobalScreen\Provider\__construct(), ilObject\_exists(), ilMediaItem\_getMediaItemsOfMObId(), ilObjForumAccess\_getThreadForPosting(), ilBlockSetting\_lookup(), ilObjMediaObject\_lookupItemPath(), ilObject\_lookupObjId(), ilObjMediaCastAccess\_lookupOnline(), ilObjMediaCastAccess\_lookupPublicFiles(), ilNewsItem\_lookupRSSPeriod(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilFeedWriter\addItem(), CLIENT_ID, ilNewsItem\determineNewsContent(), ilNewsItem\determineNewsTitle(), ilFeedWriter\getContextPath(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ilWikiPage\lookupTitle(), ilWikiUtil\makeUrlTitle(), NEWS_AUDIO, ilFeedWriter\prepareStr(), ilFeedWriter\setChannelAbout(), ilFeedWriter\setChannelLink(), ilFeedWriter\setChannelTitle(), ilNewsItem\setPrivateFeedId(), ILIAS\Repository\settings(), and ilLanguage\txt().

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ilObjectFeedWriter::$lng

protected

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

Referenced by __construct().

$settings

ilSetting ilObjectFeedWriter::$settings

protected

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

---

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

• Services/Feeds/classes/class.ilObjectFeedWriter.php