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

Collaboration diagram for ilFeedWriter:

Public Member Functions
	__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)

Data Fields
string	$encoding = "UTF-8"
string	$ch_about = ""
string	$ch_title = ""
string	$ch_link = ""
string	$ch_description = ""
array	$items = array()

Protected Attributes
ilTree	$tree
ilLanguage	$lng
ilTemplate	$tpl

Private Attributes
string	$ch_desc = ""

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 class. how to make it "secure" alternative 1:

• hash for all objects
• feature "mail me rss link"
• link includes ref id, user id, combined hash (kind of password)
• combined hash = hash(user hash + object hash)
• ilias checks whether ref id / user id / combined hash match

  Author

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

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

Constructor & Destructor Documentation

__construct()

ilFeedWriter::__construct

(

)

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

References $DIC, and ILIAS\Repository\lng().

    {
        global $DIC;

        $this->tree = $DIC->repositoryTree();
        $this->lng = $DIC->language();
    }

Here is the call graph for this function:

Member Function Documentation

addItem()

ilFeedWriter::addItem

(

ilFeedItem

$a_item

)

Definition at line 101 of file class.ilFeedWriter.php.

Referenced by ilObjectFeedWriter\__construct(), and ilUserFeedWriter\__construct().

                                               : void
    {
        $this->items[] = $a_item;
    }

Here is the caller graph for this function:

getChannelAbout()

ilFeedWriter::getChannelAbout

(

)

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

References $ch_about.

Referenced by getFeed().

                                     : string
    {
        return $this->ch_about;
    }

Here is the caller graph for this function:

getChannelDescription()

ilFeedWriter::getChannelDescription

(

)

Definition at line 96 of file class.ilFeedWriter.php.

References $ch_desc.

Referenced by getFeed().

                                           : string
    {
        return $this->ch_desc;
    }

Here is the caller graph for this function:

getChannelLink()

ilFeedWriter::getChannelLink

(

)

Definition at line 86 of file class.ilFeedWriter.php.

References $ch_link.

Referenced by getFeed().

                                    : string
    {
        return $this->ch_link;
    }

Here is the caller graph for this function:

getChannelTitle()

ilFeedWriter::getChannelTitle

(

)

Definition at line 76 of file class.ilFeedWriter.php.

References $ch_title.

Referenced by getFeed().

                                     : string
    {
        return $this->ch_title;
    }

Here is the caller graph for this function:

getContextPath()

ilFeedWriter::getContextPath

(

int

$a_ref_id

)

Definition at line 177 of file class.ilFeedWriter.php.

References $lng, $path, $tree, ilTree\getPathFull(), and ilLanguage\txt().

Referenced by ilObjectFeedWriter\__construct(), and ilUserFeedWriter\__construct().

                                                 : string
    {
        $tree = $this->tree;
        $lng = $this->lng;

        $items = array();

        if ($a_ref_id > 0) {
            $path = $tree->getPathFull($a_ref_id);

            // we want to show the full path, from the major container to the item
            // (folders are not! treated as containers here), at least one parent item
            $r_path = array_reverse($path);
            $first = "";
            $omit = array();
            $do_omit = false;
            foreach ($r_path as $key => $row) {
                if ($first == "") {
                    if (in_array($row["type"], array("root", "cat", "grp", "crs"))) {
                        $first = $row["child"];
                    }
                }
                $omit[$row["child"]] = $do_omit;
            }

            $add_it = false;
            foreach ($path as $key => $row) {
                if ($first == $row["child"]) {
                    $add_it = true;
                }

                if ($add_it && !$omit[$row["child"]] &&
                    (($row["child"] != $a_ref_id))) {
                    if ($row["title"] == "ILIAS" && $row["type"] == "root") {
                        $row["title"] = $lng->txt("repository");
                    }
                    $items[] = $row["title"];
                }
            }
        }

        if (count($items) > 0) {
            return "[" . implode(" > ", $items) . "]";
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEncoding()

ilFeedWriter::getEncoding

(

)

Definition at line 56 of file class.ilFeedWriter.php.

References $encoding.

Referenced by getFeed().

                                 : string
    {
        return $this->encoding;
    }

Here is the caller graph for this function:

getFeed()

ilFeedWriter::getFeed

(

)

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

References Vendor\Package\$d, getChannelAbout(), getChannelDescription(), getChannelLink(), getChannelTitle(), and getEncoding().

Referenced by showFeed().

                             : string
    {
        $this->tpl = new ilTemplate("tpl.rss_2_0.xml", true, true, "components/ILIAS/Feeds");

        $this->tpl->setVariable("XML", "xml");
        $this->tpl->setVariable("CONTENT_ENCODING", $this->getEncoding());
        $this->tpl->setVariable("CHANNEL_ABOUT", $this->getChannelAbout());
        $this->tpl->setVariable("CHANNEL_TITLE", $this->getChannelTitle());
        $this->tpl->setVariable("CHANNEL_LINK", $this->getChannelLink());
        $this->tpl->setVariable("CHANNEL_DESCRIPTION", $this->getChannelDescription());

        foreach ($this->items as $item) {
            $this->tpl->setCurrentBlock("rdf_seq");
            $this->tpl->setVariable("RESOURCE", $item->getAbout());
            $this->tpl->parseCurrentBlock();

            // Date
            if ($item->getDate() != "") {
                $this->tpl->setCurrentBlock("date");
                $d = $item->getDate();
                $yyyy = substr($d, 0, 4);
                $mm = substr($d, 5, 2);
                $dd = substr($d, 8, 2);
                $h = substr($d, 11, 2);
                $m = substr($d, 14, 2);
                $s = substr($d, 17, 2);
                $this->tpl->setVariable(
                    "ITEM_DATE",
                    date("r", mktime($h, $m, $s, $mm, $dd, $yyyy))
                );
                $this->tpl->parseCurrentBlock();
            }

            // Enclosure
            if ($item->getEnclosureUrl() != "") {
                $this->tpl->setCurrentBlock("enclosure");
                $this->tpl->setVariable("ENC_URL", $item->getEnclosureUrl());
                $this->tpl->setVariable("ENC_LENGTH", $item->getEnclosureLength());
                $this->tpl->setVariable("ENC_TYPE", $item->getEnclosureType());
                $this->tpl->parseCurrentBlock();
            }

            $this->tpl->setCurrentBlock("item");
            $this->tpl->setVariable("ITEM_ABOUT", $item->getAbout());
            $this->tpl->setVariable("ITEM_TITLE", $item->getTitle());
            $this->tpl->setVariable("ITEM_DESCRIPTION", $item->getDescription());
            $this->tpl->setVariable("ITEM_LINK", $item->getLink());
            $this->tpl->parseCurrentBlock();
        }

        $this->tpl->parseCurrentBlock();
        return $this->tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getItems()

ilFeedWriter::getItems

(

)

Definition at line 106 of file class.ilFeedWriter.php.

References $items.

                              : array
    {
        return $this->items;
    }

prepareStr()

ilFeedWriter::prepareStr

(

string

$a_str

)

Definition at line 111 of file class.ilFeedWriter.php.

Referenced by ilObjectFeedWriter\__construct(), and ilUserFeedWriter\__construct().

                                             : string
    {
        $a_str = str_replace(["&", "<", ">"], ["&amp;", "&lt;", "&gt;"], $a_str);
        return $a_str;
    }

Here is the caller graph for this function:

setChannelAbout()

ilFeedWriter::setChannelAbout

(

string

$a_ab

)

Definition at line 61 of file class.ilFeedWriter.php.

Referenced by ilObjectFeedWriter\__construct(), and ilUserFeedWriter\__construct().

                                                 : void
    {
        $this->ch_about = $a_ab;
    }

Here is the caller graph for this function:

setChannelDescription()

ilFeedWriter::setChannelDescription

(

string

$a_desc

)

Definition at line 91 of file class.ilFeedWriter.php.

                                                         : void
    {
        $this->ch_desc = $a_desc;
    }

setChannelLink()

ilFeedWriter::setChannelLink

(

string

$a_link

)

Definition at line 81 of file class.ilFeedWriter.php.

Referenced by ilObjectFeedWriter\__construct(), and ilUserFeedWriter\__construct().

                                                  : void
    {
        $this->ch_link = $a_link;
    }

Here is the caller graph for this function:

setChannelTitle()

ilFeedWriter::setChannelTitle

(

string

$a_title

)

Definition at line 71 of file class.ilFeedWriter.php.

Referenced by ilObjectFeedWriter\__construct(), and ilUserFeedWriter\__construct().

                                                    : void
    {
        $this->ch_title = $a_title;
    }

Here is the caller graph for this function:

setEncoding()

ilFeedWriter::setEncoding

(

string

$a_enc

)

Definition at line 51 of file class.ilFeedWriter.php.

                                              : void
    {
        $this->encoding = $a_enc;
    }

showFeed()

ilFeedWriter::showFeed

(

)

Definition at line 171 of file class.ilFeedWriter.php.

References getFeed(), and ILIAS\UI\examples\Symbol\Glyph\Header\header().

                              : void
    {
        header("Content-Type: text/xml; charset=UTF-8;");
        echo $this->getFeed();
    }

Here is the call graph for this function:

Field Documentation

$ch_about

string ilFeedWriter::$ch_about = ""

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

Referenced by getChannelAbout().

$ch_desc

string ilFeedWriter::$ch_desc = ""

private

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

Referenced by getChannelDescription().

$ch_description

string ilFeedWriter::$ch_description = ""

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

$ch_link

string ilFeedWriter::$ch_link = ""

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

Referenced by getChannelLink().

$ch_title

string ilFeedWriter::$ch_title = ""

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

Referenced by getChannelTitle().

$encoding

string ilFeedWriter::$encoding = "UTF-8"

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

Referenced by getEncoding().

$items

array ilFeedWriter::$items = array()

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

Referenced by ilObjectFeedWriter\__construct(), ilUserFeedWriter\__construct(), and getItems().

$lng

ilLanguage ilFeedWriter::$lng

protected

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

Referenced by getContextPath().

$tpl

ilTemplate ilFeedWriter::$tpl

protected

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

$tree

ilTree ilFeedWriter::$tree

protected

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

Referenced by getContextPath().

---

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

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