ilNewsForContextBlockGUI Class Reference

BlockGUI class for block NewsForContext. More...

Inheritance diagram for ilNewsForContextBlockGUI:

Collaboration diagram for ilNewsForContextBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	getNewsData ()
	Get news for context. More...
	getBlockType ()
	executeCommand ()
	execute command More...
	setEnableEdit ($a_enable_edit=0)
	Set EnableEdit. More...
	getEnableEdit ()
	Get EnableEdit. More...
	fillDataSection ()
	Fill data section. More...
	getHTML ()
	Get bloch HTML code. More...
	handleView ()
	Handles show/hide notification view and removes notifications if hidden. More...
	fillRow ($data)
	get flat list for personal desktop More...
	getInfoForData ($news)
	getOverview ()
	Get overview. More...
	showNews ()
	show news More...
	makeClickable ($a_str)
	Make clickable. More...
	unsubscribeNews ()
	Unsubscribe current user from news. More...
	subscribeNews ()
	Subscribe current user from news. More...
	showNotifications ()
	hideNotifications ()
	editSettings ()
	Show settings screen. More...
	initSettingsForm ()
	Init setting form. More...
	cancelSettings ()
	Cancel settings. More...
	saveSettings ()
	Save settings. More...
	showFeedUrl ()
	Show feed URL. More...
	getDynamic ()
	getDynamicReload ()
	getJSEnabler ()
	disableJS ()
	enableJS ()
Public Member Functions inherited from ilBlockGUI
	getBlockType ()
	__construct ()
	Constructor. More...
	setData ($a_data)
	Set Data. More...
	getData ()
	Get Data. More...
	setPresentation (int $type)
	Set presentation. More...
	getPresentation ()
	Get presentation type. More...
	setBlockId ($a_block_id=0)
	Set Block Id. More...
	getBlockId ()
	Get Block Id. More...
	setGuiObject (&$a_gui_object)
	Set GuiObject. More...
	getGuiObject ()
	Get GuiObject. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setOffset ($a_offset)
	Set Offset. More...
	getOffset ()
	Get Offset. More...
	correctOffset ()
	setLimit ($a_limit)
	Set Limit. More...
	getLimit ()
	Get Limit. More...
	setEnableEdit ($a_enableedit)
	Set EnableEdit. More...
	getEnableEdit ()
	Get EnableEdit. More...
	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode. More...
	getRepositoryMode ()
	Get RepositoryMode. More...
	setSubtitle ($a_subtitle)
	Set Subtitle. More...
	getSubtitle ()
	Get Subtitle. More...
	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...
	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true). More...
	setAdminCommands (bool $a_admincommands)
	Set Administration Commmands. More...
	getAdminCommands ()
	Get Administration Commmands. More...
	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info. More...
	getEnableNumInfo ()
	Get Enable Item Number Info. More...
	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
	getProperty ($a_property)
	setProperty ($a_property, $a_value)
	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name. More...
	getNavParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	Get Row Template Name. More...
	getRowTemplateDir ()
	Get Row Template Directory. More...
	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
	Add Block Command. More...
	getBlockCommands ()
	Get Block commands. More...
	getHTML ()
	Get HTML. More...
	fillHeaderCommands ()
	Fill header commands block. More...
	fillHeaderTitleBlock ()
	Fill header title block (title and. More...
	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used. More...
	fillDataSection ()
	Standard implementation for row based data. More...
	fillRow ($a_set)
	fillFooter ()
	fillPreviousNext ()
	Fill previous/next row. More...
	setPreviousNextLinks ()
	Get previous/next linkbar. More...
	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...
	getPaginationViewControl ()
	Fill previous/next row. More...
	getHTMLNew ()
	Get HTML. More...

Static Public Member Functions
static	getScreenMode ()
	Get Screen Mode for current command. More...
static	addToSettingsForm (ilFormPropertyGUI $a_input)
	Add inputs to the container news settings form to configure also the contextBlock options. More...
static	writeSettings ($a_values)
Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()
	Get Screen Mode for current command. More...

Data Fields
const	OBJECTS_WITH_NEWS_SUBTAB = ["category", "course", "group", "forum"]
	object type names with settings->news settings subtab More...
Data Fields inherited from ilBlockGUI
const	PRES_MAIN_LEG = 0
const	PRES_SEC_LEG = 1
const	PRES_SEC_LIST = 2
const	PRES_MAIN_LIST = 3

Static Public Attributes
static	$block_type = "news"
static	$st_data

Protected Member Functions
	isRepositoryObject ()
	getMediaPath (int $mob_id)
	getListItemForData (array $data)
	getNoItemFoundContent ()
	No item entry. More...
Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	initCommands ()
	Init commands. More...
	fillRowColor ($a_placeholder="CSS_ROW")
	preloadData (array $data)
	Can be overwritten in subclasses. More...
	getLegacyContent ()
	Get legacy content. More...
	getViewControls ()
	Get view controls. More...
	getListItemForData (array $data)
	Get list item for data array. More...
	handleNavigation ()
	Handle navigation. More...
	loadData ()
	Load data for current page. More...
	getListItemGroups ()
	Get items. More...
	addRepoCommands ()
	Add repo commands. More...
	getNoItemFoundContent ()
	No item entry. More...

Protected Attributes
	$help
	$settings
	$tabs
	$obj_definition
	$new_rendering = true
Protected Attributes inherited from ilBlockGUI
	$ui
	$data = array()
	$enablenuminfo = true
	$footer_links = array()
	$block_id = 0
	$allow_moving = true
	$move = array("left" => false, "right" => false, "up" => false, "down" => false)
	$block_commands = array()
	$max_count = false
	$close_command = false
	$image = false
	$property = false
	$nav_value = ""
	$css_row = ""
	$title = ""
	$admincommands = false
	$dropdown
	$tpl
	$main_tpl
	$user
	$ctrl
	$access
	$lng
	$obj_def
	$presentation
	$new_rendering = false

Detailed Description

BlockGUI class for block NewsForContext.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilNewsForContextBlockGUI: ilColumnGUI ilNewsForContextBlockGUI: ilNewsItemGUI

Definition at line 18 of file class.ilNewsForContextBlockGUI.php.

Constructor & Destructor Documentation

__construct()

ilNewsForContextBlockGUI::__construct

(

)

Constructor.

Definition at line 48 of file class.ilNewsForContextBlockGUI.php.

References $_GET, ilBlockGUI\$data, $DIC, $ilCtrl, $ilUser, ilBlockGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), getDynamic(), getNewsData(), handleView(), help(), ilNewsItem\prepareNewsDataFromCache(), ilBlockGUI\setBlockId(), ilBlockGUI\setData(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), ilBlockGUI\setRowTemplate(), settings(), ilBlockGUI\setTitle(), and user().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->help = $DIC["ilHelp"];
        $this->access = $DIC->access();
        $this->settings = $DIC->settings();
        $this->tabs = $DIC->tabs();
        $this->obj_definition = $DIC["objDefinition"];

        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();
        $ilUser = $DIC->user();
        $ilHelp = $DIC["ilHelp"];

        parent::__construct();
        
        $lng->loadLanguageModule("news");
        $ilHelp->addHelpSection("news_block");
        
        include_once("./Services/News/classes/class.ilNewsItem.php");
        $this->setBlockId($ilCtrl->getContextObjId());
        $this->setLimit(5);
        $this->setEnableNumInfo(true);
        
        $this->dynamic = false;
        include_once("./Services/News/classes/class.ilNewsCache.php");
        $this->acache = new ilNewsCache();
        $cres = unserialize($this->acache->getEntry($ilUser->getId() . ":" . $_GET["ref_id"]));
        $this->cache_hit = false;

        if ($this->acache->getLastAccessStatus() == "hit" && is_array($cres)) {
            self::$st_data = ilNewsItem::prepareNewsDataFromCache($cres);
            $this->cache_hit = true;
        }
        if ($this->getDynamic() && !$this->cache_hit) {
            $this->dynamic = true;
            $data = array();
        } else {
            if (!empty(self::$st_data)) {
                $data = self::$st_data;
            } else {
                $data = $this->getNewsData();
                self::$st_data = $data;
            }
        }

        $this->setTitle($lng->txt("news_internal_news"));
        $this->setRowTemplate("tpl.block_row_news_for_context.html", "Services/News");
        $this->setData($data);
        $this->allow_moving = false;
        $this->handleView();

        $this->setPresentation(self::PRES_SEC_LIST);
    }

Here is the call graph for this function:

Member Function Documentation

addToSettingsForm()

static ilNewsForContextBlockGUI::addToSettingsForm ( ilFormPropertyGUI  $a_input )

static

Add inputs to the container news settings form to configure also the contextBlock options.

Parameters

ilFormPropertyGUI

$a_input

Definition at line 1166 of file class.ilNewsForContextBlockGUI.php.

References $_GET, ilBlockGUI\$block_id, $DIC, ilBlockGUI\$lng, ilNewsItem\_getDefaultVisibilityForRefId(), ilBlockSetting\_lookup(), ilRadioOption\setInfo(), and ilFormPropertyGUI\setInfo().

Referenced by ilContainerNewsSettingsGUI\initForm().

    {
        global $DIC;

        $lng = $DIC->language();
        $block_id = $DIC->ctrl()->getContextObjId();

        $news_set = new ilSetting("news");
        $enable_internal_rss = $news_set->get("enable_rss_for_internal");

        //$public_notification = ilBlockSetting::_lookup(self::$block_type, "public_notifications",0, $block_id);
        $public_feed = ilBlockSetting::_lookup(
            self::$block_type,
            "public_feed",
            0,
            $block_id
        );

        $default_visibility = ilBlockSetting::_lookup(self::$block_type, "default_visibility", 0, $block_id);
        if ($default_visibility == "") {
            $default_visibility =
                ilNewsItem::_getDefaultVisibilityForRefId($_GET["ref_id"]);
        }
        $radio_group = new ilRadioGroupInputGUI($lng->txt("news_default_visibility"), "default_visibility");
        $radio_option = new ilRadioOption($lng->txt("news_visibility_users"), "users");
        $radio_group->addOption($radio_option);
        $radio_option = new ilRadioOption($lng->txt("news_visibility_public"), "public");
        $radio_group->addOption($radio_option);
        $radio_group->setInfo($lng->txt("news_news_item_visibility_info"));
        $radio_group->setRequired(false);
        $radio_group->setValue($default_visibility);
        $a_input->addSubItem($radio_group);

        // extra rss feed
        if ($enable_internal_rss) {
            $radio_rss = new ilCheckboxInputGUI(
                $lng->txt("news_public_feed"),
                "notifications_public_feed"
            );
            $radio_rss->setInfo($lng->txt("news_public_feed_info"));
            $radio_rss->setChecked($public_feed);
            $a_input->addSubItem($radio_rss);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancelSettings()

ilNewsForContextBlockGUI::cancelSettings

(

)

Cancel settings.

Definition at line 1224 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$ctrl, and $ilCtrl.

    {
        $ilCtrl = $this->ctrl;
        
        $ilCtrl->returnToParent($this);
    }

disableJS()

ilNewsForContextBlockGUI::disableJS

(

)

Definition at line 1443 of file class.ilNewsForContextBlockGUI.php.

References $_SESSION, ilBlockGUI\$ctrl, $ilCtrl, $ilUser, and ilBlockGUI\$user.

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        $_SESSION["il_feed_js"] = "n";
        $ilUser->writePref("il_feed_js", "n");
        $ilCtrl->returnToParent($this);
    }

editSettings()

ilNewsForContextBlockGUI::editSettings

(

)

Show settings screen.

Definition at line 1005 of file class.ilNewsForContextBlockGUI.php.

References initSettingsForm().

Referenced by ilPDNewsBlockGUI\changeFeedSettings().

    {
        $this->initSettingsForm();
        return $this->settings_form->getHTML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

enableJS()

ilNewsForContextBlockGUI::enableJS

(

)

Definition at line 1453 of file class.ilNewsForContextBlockGUI.php.

References $_SESSION, $ilUser, ilBlockGUI\$user, exit, and getHTML().

    {
        $ilUser = $this->user;
        //echo "enableJS";
        $_SESSION["il_feed_js"] = "y";
        $ilUser->writePref("il_feed_js", "y");
        echo $this->getHTML();
        exit;
    }

Here is the call graph for this function:

executeCommand()

ilNewsForContextBlockGUI::executeCommand

(

)

execute command

Definition at line 206 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, and getEnableEdit().

    {
        $ilCtrl = $this->ctrl;

        $next_class = $ilCtrl->getNextClass();
        $cmd = $ilCtrl->getCmd("getHTML");

        switch ($next_class) {
            case "ilnewsitemgui":
                include_once("./Services/News/classes/class.ilNewsItemGUI.php");
                $news_item_gui = new ilNewsItemGUI();
                $news_item_gui->setEnableEdit($this->getEnableEdit());
                $html = $ilCtrl->forwardCommand($news_item_gui);
                return $html;
                
            default:
                return $this->$cmd();
        }
    }

Here is the call graph for this function:

fillDataSection()

ilNewsForContextBlockGUI::fillDataSection

(

)

Fill data section.

Definition at line 249 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\getData(), getDynamicReload(), getOverview(), and ilBlockGUI\setDataSection().

    {
        if ($this->dynamic) {
            $this->setDataSection($this->getDynamicReload());
        } elseif (count($this->getData()) > 0) {
            parent::fillDataSection();
        } else {
            $this->setDataSection($this->getOverview());
        }
    }

Here is the call graph for this function:

fillRow()

ilNewsForContextBlockGUI::fillRow

(

$data

)

get flat list for personal desktop

Definition at line 428 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$data, and getInfoForData().

    {
        $info = $this->getInfoForData($data);

        $this->tpl->setCurrentBlock("long");
        $this->tpl->setVariable("VAL_CREATION_DATE", $info["creation_date"]);
        $this->tpl->parseCurrentBlock();

        if ($info["ref_id"] > 0) {
            $this->tpl->setCurrentBlock("news_context");
            $this->tpl->setVariable("TYPE", $info["type_txt"]);
            $this->tpl->setVariable("IMG_TYPE", $info["type_icon"]);
            $this->tpl->setVariable("TITLE", $info["obj_title"]);
            if ($info["user_read"] > 0) {
                $this->tpl->setVariable("TITLE_CLASS", 'class="light"');
            }

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

        // title
        $this->tpl->setVariable("VAL_TITLE", $info["news_title"]);

        if ($info["user_read"] > 0) {
            $this->tpl->setVariable("A_CLASS", 'class="light"');
        }

        $this->tpl->setVariable("HREF_SHOW", $info["url"]);
    }

Here is the call graph for this function:

getBlockType()

ilNewsForContextBlockGUI::getBlockType

(

)

Definition at line 160 of file class.ilNewsForContextBlockGUI.php.

Referenced by getDynamicReload(), getHTML(), getJSEnabler(), handleView(), hideNotifications(), initSettingsForm(), saveSettings(), and showNotifications().

                                   : string
    {
        return self::$block_type;
    }

Here is the caller graph for this function:

getDynamic()

ilNewsForContextBlockGUI::getDynamic

(

)

Definition at line 1358 of file class.ilNewsForContextBlockGUI.php.

References $_SESSION, ilBlockGUI\$ctrl, $ilCtrl, $ilUser, and ilBlockGUI\$user.

Referenced by ilPDNewsBlockGUI\__construct(), and __construct().

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        // @todo: enable js loading
        if ($this->new_rendering) {
            return false;
        }

        if ($ilCtrl->getCmd() == "hideNotifications" ||
            $ilCtrl->getCmd() == "showNotifications") {
            return false;
        }
        
        if ($ilCtrl->getCmdClass() != "ilcolumngui" && $ilCtrl->getCmd() != "enableJS") {
            $sess_feed_js = "";
            if (isset($_SESSION["il_feed_js"])) {
                $sess_feed_js = $_SESSION["il_feed_js"];
            }
            
            if ($sess_feed_js != "n" &&
                ($ilUser->getPref("il_feed_js") != "n" || $sess_feed_js == "y")) {
                // do not get feed dynamically, if cache hit is given.
                //                              if (!$this->feed->checkCacheHit())
                //                              {
                return true;
                //                              }
            }
        }
        
        return false;
    }

Here is the caller graph for this function:

getDynamicReload()

ilNewsForContextBlockGUI::getDynamicReload

(

)

Definition at line 1392 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, ilBlockGUI\$lng, ilBlockGUI\getBlockId(), and getBlockType().

Referenced by ilPDNewsBlockGUI\fillDataSection(), and fillDataSection().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $ilCtrl->setParameterByClass(
            "ilcolumngui",
            "block_id",
            "block_" . $this->getBlockType() . "_" . $this->getBlockId()
        );

        $rel_tpl = new ilTemplate("tpl.dynamic_reload.html", true, true, "Services/News");
        $rel_tpl->setVariable("TXT_LOADING", $lng->txt("news_loading_news"));
        $rel_tpl->setVariable("BLOCK_ID", "block_" . $this->getBlockType() . "_" . $this->getBlockId());
        $rel_tpl->setVariable(
            "TARGET",
            $ilCtrl->getLinkTargetByClass("ilcolumngui", "updateBlock", "", true)
        );
            
        // no JS
        $rel_tpl->setVariable("TXT_NEWS_CLICK_HERE", $lng->txt("news_no_js_click_here"));
        $rel_tpl->setVariable(
            "TARGET_NO_JS",
            $ilCtrl->getLinkTargetByClass(strtolower(get_class($this)), "disableJS")
        );

        return $rel_tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEnableEdit()

ilNewsForContextBlockGUI::getEnableEdit

(

)

Get EnableEdit.

Returns

boolean Edit mode on/off

Definition at line 241 of file class.ilNewsForContextBlockGUI.php.

Referenced by executeCommand(), and getHTML().

    {
        return $this->enable_edit;
    }

Here is the caller graph for this function:

getHTML()

ilNewsForContextBlockGUI::getHTML

(

)

Get bloch HTML code.

Definition at line 263 of file class.ilNewsForContextBlockGUI.php.

References $_GET, ilBlockGUI\$ctrl, $DIC, $ilCtrl, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$obj_def, ilBlockGUI\$user, ilBlockSetting\_lookup(), ilObject\_lookupObjectId(), ilObject\_lookupType(), ilBlockGUI\addBlockCommand(), getBlockType(), ilBlockGUI\getData(), getEnableEdit(), ilBlockGUI\getProperty(), ilBlockGUI\getRepositoryMode(), ILIAS_HTTP_PATH, OBJECTS_WITH_NEWS_SUBTAB, and ilBlockGUI\setTitle().

Referenced by enableJS(), hideNotifications(), and showNotifications().

    {
        global $DIC;

        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
        
        $news_set = new ilSetting("news");
        $enable_internal_rss = $news_set->get("enable_rss_for_internal");

        $hide_block = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "hide_news_block",
            0,
            $this->block_id
        );

        if ($this->getProperty("title") != "") {
            $this->setTitle($this->getProperty("title"));
        }

        $public_feed = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "public_feed",
            0,
            $this->block_id
        );
        if ($public_feed) {
            if ($enable_internal_rss) {
                include_once("./Services/News/classes/class.ilRSSButtonGUI.php");
                // @todo: rss icon HTML: ilRSSButtonGUI::get(ilRSSButtonGUI::ICON_RSS)
                $this->addBlockCommand(
                    ILIAS_HTTP_PATH . "/feed.php?client_id=" . rawurlencode(CLIENT_ID) . "&" .
                        "ref_id=" . $_GET["ref_id"],
                    $lng->txt("news_feed_url")
                );
            }
        }

        // add edit commands
        if ($this->getEnableEdit()) {
            $this->addBlockCommand(
                $ilCtrl->getLinkTargetByClass("ilnewsitemgui", "editNews"),
                $lng->txt("edit")
            );

            $ilCtrl->setParameter($this, "add_mode", "block");
            $this->addBlockCommand(
                $ilCtrl->getLinkTargetByClass("ilnewsitemgui", "createNewsItem"),
                $lng->txt("add")
            );
            $ilCtrl->setParameter($this, "add_mode", "");
        }

        if ($this->getProperty("settings") == true) {
            $ref_id = $_GET["ref_id"];
            $obj_def = $DIC["objDefinition"];
            $obj_id = ilObject::_lookupObjectId($ref_id);
            $obj_type = ilObject::_lookupType($ref_id, true);
            $obj_class = strtolower($obj_def->getClassName($obj_type));
            $parent_gui = "ilobj" . $obj_class . "gui";

            $ilCtrl->setParameterByClass("ilcontainernewssettingsgui", "ref_id", $ref_id);

            if (in_array($obj_class, ilNewsForContextBlockGUI::OBJECTS_WITH_NEWS_SUBTAB)) {
                $this->addBlockCommand(
                    $ilCtrl->getLinkTargetByClass(array("ilrepositorygui", $parent_gui, "ilcontainernewssettingsgui"), "show"),
                    $lng->txt("settings")
                );
            } else {
                $this->addBlockCommand(
                    $ilCtrl->getLinkTarget($this, "editSettings"),
                    $lng->txt("settings")
                );
            }
        }
        
        // do not display hidden repository news blocks for users
        // who do not have write permission
        if (!$this->getEnableEdit() && $this->getRepositoryMode() &&
            ilBlockSetting::_lookup(
                $this->getBlockType(),
                "hide_news_block",
                0,
                $this->block_id
            )) {
            return "";
        }

        // do not display empty news blocks for users
        // who do not have write permission
        if (count($this->getData()) == 0 && !$this->getEnableEdit() &&
            $this->getRepositoryMode() && !$this->dynamic
            && (!$news_set->get("enable_rss_for_internal") ||
                !ilBlockSetting::_lookup(
                    $this->getBlockType(),
                    "public_feed",
                    0,
                    $this->block_id
                ))) {
            return "";
        }

        $en = "";
        if ($ilUser->getPref("il_feed_js") == "n") {
            //                  $en = getJSEnabler();
        }

        return parent::getHTML() . $en;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInfoForData()

ilNewsForContextBlockGUI::getInfoForData

(

$news

)

Definition at line 458 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, ilBlockGUI\$lng, $obj_definition, $type, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilNewsItem\determineNewsTitle(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, ilObjectPlugin\lookupTxtById(), and ilUtil\shortenWords().

Referenced by fillRow(), and getListItemForData().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $obj_definition = $this->obj_definition;

        $info = [];

        $info["ref_id"] = $news["ref_id"];
        $info["creation_date"] =
            ilDatePresentation::formatDate(new ilDateTime($news["creation_date"], IL_CAL_DATETIME));

        // title image type
        if ($news["ref_id"] > 0) {
            if ($news["agg_ref_id"] > 0) {
                $obj_id = ilObject::_lookupObjId($news["agg_ref_id"]);
                $type = ilObject::_lookupType($obj_id);
                $context_ref = $news["agg_ref_id"];
            } else {
                $obj_id = $news["context_obj_id"];
                $type = $news["context_obj_type"];
                $context_ref = $news["ref_id"];
            }
            
            $lang_type = in_array($type, array("sahs", "lm", "htlm"))
                ? "lres"
                : "obj_" . $type;

            $type_txt = ($obj_definition->isPlugin($news["context_obj_type"]))
                ? ilObjectPlugin::lookupTxtById($news["context_obj_type"], $lang_type)
                : $lng->txt($lang_type);


            $info["type_txt"] = $type_txt;
            $info["type_icon"] = ilObject::_getIcon($obj_id, "tiny", $type);
            $info["obj_title"] = ilUtil::shortenWords(ilObject::_lookupTitle($obj_id));
            $info["user_read"] = $news["user_read"];

            $ilCtrl->setParameter($this, "news_context", $context_ref);
        } else {
            $ilCtrl->setParameter($this, "news_context", "");
        }

        // title
        $info["news_title"] =
            ilUtil::shortenWords(ilNewsItem::determineNewsTitle(
                $news["context_obj_type"],
                $news["title"],
                $news["content_is_lang_var"],
                $news["agg_ref_id"],
                $news["aggregation"]
            ));
        

        $ilCtrl->setParameter($this, "news_id", $news["id"]);
        $info["url"] =
            $ilCtrl->getLinkTarget($this, "showNews");
        $ilCtrl->clearParameters($this);

        return $info;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getJSEnabler()

ilNewsForContextBlockGUI::getJSEnabler

(

)

Definition at line 1421 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, ilBlockGUI\$lng, ilBlockGUI\getBlockId(), and getBlockType().

Referenced by ilPDNewsBlockGUI\getHTML().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $ilCtrl->setParameterByClass(
            "ilcolumngui",
            "block_id",
            "block_" . $this->getBlockType() . "_" . $this->getBlockId()
        );
        //echo "hh";
        $rel_tpl = new ilTemplate("tpl.js_enabler.html", true, true, "Services/News");
        $rel_tpl->setVariable("BLOCK_ID", "block_" . $this->getBlockType() . "_" . $this->getBlockId());
        $rel_tpl->setVariable(
            "TARGET",
            $ilCtrl->getLinkTargetByClass(strtolower(get_class($this)), "enableJS", true, "", false)
        );
            
        return $rel_tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getListItemForData()

ilNewsForContextBlockGUI::getListItemForData ( array  $data )

protected

Definition at line 1473 of file class.ilNewsForContextBlockGUI.php.

References $factory, getInfoForData(), and ui().

                                                       : \ILIAS\UI\Component\Item\Item
    {
        $info = $this->getInfoForData($data);


        $props = [
            $this->lng->txt("news_date") => $info["creation_date"]
        ];


        // @todo: fix this
        // $info["user_read"]

        $factory = $this->ui->factory();
        $item = $factory->item()->standard($factory->link()->standard($info["news_title"], $info["url"]))
            ->withProperties($props);
        if ($info["ref_id"] > 0) {
            $item = $item->withDescription($info["type_txt"] . ": " . $info["obj_title"]);
        }
        return $item;
    }

Here is the call graph for this function:

getMediaPath()

ilNewsForContextBlockGUI::getMediaPath ( int  $mob_id )

protected

Parameters

int

$mob_id

Returns

string

Definition at line 888 of file class.ilNewsForContextBlockGUI.php.

References ilObjMediaObject\_getURL().

Referenced by showNews().

    {
        $media_path = "";
        if ($mob_id > 0) {
            $mob = new ilObjMediaObject($mob_id);
            $med = $mob->getMediaItem("Standard");
            if (strcasecmp("Reference", $med->getLocationType()) == 0) {
                $media_path = $med->getLocation();
            } else {
                $media_path = ilObjMediaObject::_getURL($mob->getId()) . "/" . $med->getLocation();
            }
        }
        return $media_path;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNewsData()

ilNewsForContextBlockGUI::getNewsData

(

)

Get news for context.

Definition at line 110 of file class.ilNewsForContextBlockGUI.php.

References $_GET, ilBlockGUI\$ctrl, $ilCtrl, $ilUser, and ilBlockGUI\$user.

Referenced by __construct(), hideNotifications(), showNews(), and showNotifications().

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        include_once("./Services/News/classes/class.ilNewsCache.php");
        $this->acache = new ilNewsCache();
        /*              $cres = $this->acache->getEntry($ilUser->getId().":".$_GET["ref_id"]);
                if ($this->acache->getLastAccessStatus() == "hit" && false)
                {
                    $news_data = unserialize($cres);
                }
                else
                {*/
        $news_item = new ilNewsItem();
        $news_item->setContextObjId($ilCtrl->getContextObjId());
        $news_item->setContextObjType($ilCtrl->getContextObjType());
            
        // workaround, better: reduce constructor and introduce
        //$prevent_aggregation = $this->getProperty("prevent_aggregation");
        $prevent_aggregation = true;
        if ($ilCtrl->getContextObjType() != "frm") {
            $forum_grouping = true;
        } else {
            $forum_grouping = false;
        }
    
            
        $news_data = $news_item->getNewsForRefId(
            $_GET["ref_id"],
            false,
            false,
            0,
            $prevent_aggregation,
            $forum_grouping
            );

        $this->acache->storeEntry(
            $ilUser->getId() . ":" . $_GET["ref_id"],
            serialize($news_data)
            );

        //              }
        //var_dump($news_data);
        return $news_data;
    }

Here is the caller graph for this function:

getNoItemFoundContent()

ilNewsForContextBlockGUI::getNoItemFoundContent ( )

protected

No item entry.

Returns

string

Definition at line 1500 of file class.ilNewsForContextBlockGUI.php.

                                               : string
    {
        return $this->lng->txt("news_no_news_items");
    }

getOverview()

ilNewsForContextBlockGUI::getOverview

(

)

Get overview.

Definition at line 523 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$user, and ilBlockGUI\getData().

Referenced by ilPDNewsBlockGUI\fillDataSection(), and fillDataSection().

    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
                
        return '<div class="small">' . ((int) count($this->getData())) . " " . $lng->txt("news_news_items") . "</div>";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getScreenMode()

static ilNewsForContextBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Definition at line 176 of file class.ilNewsForContextBlockGUI.php.

References $DIC, $ilCtrl, IL_SCREEN_CENTER, IL_SCREEN_FULL, and IL_SCREEN_SIDE.

    {
        global $DIC;

        $ilCtrl = $DIC->ctrl();
        
        if ($ilCtrl->getCmdClass() == "ilnewsitemgui") {
            return IL_SCREEN_FULL;
        }
        
        switch ($ilCtrl->getCmd()) {
            case "showNews":
            case "showFeedUrl":
                return IL_SCREEN_CENTER;
                break;
                
            case "editSettings":
            case "saveSettings":
                return IL_SCREEN_FULL;
                break;
            
            default:
                return IL_SCREEN_SIDE;
                break;
        }
    }

handleView()

ilNewsForContextBlockGUI::handleView

(

)

Handles show/hide notification view and removes notifications if hidden.

Definition at line 378 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$block_id, $ilUser, ilBlockGUI\$user, ilBlockSetting\_lookup(), and getBlockType().

Referenced by ilPDNewsBlockGUI\__construct(), __construct(), hideNotifications(), and showNotifications().

    {
        $ilUser = $this->user;
        
        include_once("Services/Block/classes/class.ilBlockSetting.php");
        $this->view = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "view",
            $ilUser->getId(),
            $this->block_id
        );

        // check whether notices and messages exist
        $got_notices = $got_messages = false;
        foreach ($this->data as $row) {
            if ($row["priority"] == 0) {
                $got_notices = true;
            }
            if ($row["priority"] == 1) {
                $got_messages = true;
            }
        }
        $this->show_view_selection = false;

        if ($got_notices && $got_messages) {
            $this->show_view_selection = true;
        } elseif ($got_notices) {
            $this->view = "";
        }
        
        // remove notifications if hidden
/*
        if (($this->view == "hide_notifications") && $this->show_view_selection)
        {
            $rset = array();
            foreach($this->data as $k => $row)
            {
                if ($row["priority"] == 1)
                {
                    $rset[$k] = $row;
                }
            }
            $this->data = $rset;
        }
*/
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hideNotifications()

ilNewsForContextBlockGUI::hideNotifications

(

)

Definition at line 975 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$block_id, ilBlockGUI\$ctrl, ilBlockGUI\$data, $ilCtrl, $ilUser, ilBlockGUI\$user, ilBlockSetting\_write(), exit, getBlockType(), getHTML(), getNewsData(), handleView(), and ilBlockGUI\setData().

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        include_once("Services/Block/classes/class.ilBlockSetting.php");
        ilBlockSetting::_write(
            $this->getBlockType(),
            "view",
            "hide_notifications",
            $ilUser->getId(),
            $this->block_id
        );

        // reload data
        $data = $this->getNewsData();
        $this->setData($data);
        $this->handleView();

        if ($ilCtrl->isAsynch()) {
            echo $this->getHTML();
            exit;
        } else {
            $ilCtrl->returnToParent($this);
        }
    }

Here is the call graph for this function:

initSettingsForm()

ilNewsForContextBlockGUI::initSettingsForm

(

)

Init setting form.

Definition at line 1014 of file class.ilNewsForContextBlockGUI.php.

References $_GET, ilBlockGUI\$ctrl, $ilCtrl, $ilSetting, $ilUser, ilBlockGUI\$lng, $settings, $tabs, ilBlockGUI\$user, ilNewsItem\_getDefaultVisibilityForRefId(), ilBlockSetting\_lookup(), getBlockType(), ilBlockGUI\getProperty(), IL_CAL_DATETIME, ilRadioOption\setInfo(), ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by editSettings(), and saveSettings().

    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;
        $ilTabs = $this->tabs;

        $ilTabs->clearTargets();

        $news_set = new ilSetting("news");
        $enable_internal_rss = $news_set->get("enable_rss_for_internal");

        $public = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "public_notifications",
            0,
            $this->block_id
        );
        $public_feed = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "public_feed",
            0,
            $this->block_id
        );
        $hide_block = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "hide_news_block",
            0,
            $this->block_id
        );
        $hide_news_per_date = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "hide_news_per_date",
            0,
            $this->block_id
        );
        $hide_news_date = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "hide_news_date",
            0,
            $this->block_id
        );

        if ($hide_news_date != "") {
            $hide_news_date = explode(" ", $hide_news_date);
        }

        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $this->settings_form = new ilPropertyFormGUI();
        $this->settings_form->setTitle($lng->txt("news_settings"));
        
        // hide news block for learners
        if ($this->getProperty("hide_news_block_option")) {
            $ch = new ilCheckboxInputGUI(
                $lng->txt("news_hide_news_block"),
                "hide_news_block"
            );
            $ch->setInfo($lng->txt("news_hide_news_block_info"));
            $ch->setChecked($hide_block);
            $this->settings_form->addItem($ch);
            
            $hnpd = new ilCheckboxInputGUI(
                $lng->txt("news_hide_news_per_date"),
                "hide_news_per_date"
            );
            $hnpd->setInfo($lng->txt("news_hide_news_per_date_info"));
            $hnpd->setChecked($hide_news_per_date);
            
            $dt_prop = new ilDateTimeInputGUI(
                $lng->txt("news_hide_news_date"),
                "hide_news_date"
                );
            $dt_prop->setRequired(true);
            if ($hide_news_date != "") {
                $dt_prop->setDate(new ilDateTime($hide_news_date[0] . ' ' . $hide_news_date[1], IL_CAL_DATETIME));
            }
            #$dt_prop->setDate($hide_news_date[0]);
            #$dt_prop->setTime($hide_news_date[1]);
            $dt_prop->setShowTime(true);
            //$dt_prop->setInfo($lng->txt("news_hide_news_date_info"));
            $hnpd->addSubItem($dt_prop);
                
            $this->settings_form->addItem($hnpd);
        }

        // default visibility
        if ($this->getProperty("default_visibility_option") &&
            $enable_internal_rss) {
            $default_visibility = ilBlockSetting::_lookup(
                $this->getBlockType(),
                "default_visibility",
                0,
                $this->block_id
            );
            if ($default_visibility == "") {
                $default_visibility =
                    ilNewsItem::_getDefaultVisibilityForRefId($_GET["ref_id"]);
            }

            // Default Visibility
            $radio_group = new ilRadioGroupInputGUI($lng->txt("news_default_visibility"), "default_visibility");
            $radio_option = new ilRadioOption($lng->txt("news_visibility_users"), "users");
            $radio_group->addOption($radio_option);
            $radio_option = new ilRadioOption($lng->txt("news_visibility_public"), "public");
            $radio_group->addOption($radio_option);
            $radio_group->setInfo($lng->txt("news_news_item_visibility_info"));
            $radio_group->setRequired(false);
            $radio_group->setValue($default_visibility);
            $this->settings_form->addItem($radio_group);
        }

        // public notifications
        if ($this->getProperty("public_notifications_option") &&
            $enable_internal_rss) {
            $ch = new ilCheckboxInputGUI(
                $lng->txt("news_notifications_public"),
                "notifications_public"
            );
            $ch->setInfo($lng->txt("news_notifications_public_info"));
            $ch->setChecked($public);
            $this->settings_form->addItem($ch);
        }

        // extra rss feed
        if ($enable_internal_rss) {
            $ch = new ilCheckboxInputGUI(
                $lng->txt("news_public_feed"),
                "notifications_public_feed"
            );
            $ch->setInfo($lng->txt("news_public_feed_info"));
            $ch->setChecked($public_feed);
            $this->settings_form->addItem($ch);
        }

        
        //$this->settings_form->addCheckboxProperty($lng->txt("news_public_feed"), "notifications_public_feed",
        //      "1", $public_feed, $lng->txt("news_public_feed_info"));
        //if ($this->getProperty("public_notifications_option"))
        //{
        //      $this->settings_form->addCheckboxProperty($lng->txt("news_notifications_public"), "notifications_public",
        //              "1", $public, $lng->txt("news_notifications_public_info"));
        //}
        $this->settings_form->addCommandButton("saveSettings", $lng->txt("save"));
        $this->settings_form->addCommandButton("cancelSettings", $lng->txt("cancel"));
        $this->settings_form->setFormAction($ilCtrl->getFormaction($this));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isRepositoryObject()

ilNewsForContextBlockGUI::isRepositoryObject ( )

protected

Definition at line 168 of file class.ilNewsForContextBlockGUI.php.

                                            : bool
    {
        return false;
    }

makeClickable()

ilNewsForContextBlockGUI::makeClickable

(

$a_str

)

Make clickable.

Parameters

Definition at line 909 of file class.ilNewsForContextBlockGUI.php.

References ilUtil\makeClickable().

    {
        // this fixes bug 8744. We assume that strings that contain < and >
        // already contain html, we do not handle these
        if (is_int(strpos($a_str, ">")) && is_int(strpos($a_str, "<"))) {
            return $a_str;
        }
        
        return ilUtil::makeClickable($a_str);
    }

Here is the call graph for this function:

saveSettings()

ilNewsForContextBlockGUI::saveSettings

(

)

Save settings.

Definition at line 1234 of file class.ilNewsForContextBlockGUI.php.

References $_GET, $_POST, ilBlockGUI\$block_id, ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$user, ilBlockSetting\_write(), getBlockType(), ilBlockGUI\getProperty(), IL_CAL_DATETIME, and initSettingsForm().

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        
        $this->initSettingsForm();
        if ($this->settings_form->checkInput()) {
            $news_set = new ilSetting("news");
            $enable_internal_rss = $news_set->get("enable_rss_for_internal");
            
            if ($enable_internal_rss) {
                ilBlockSetting::_write(
                    $this->getBlockType(),
                    "public_notifications",
                    $_POST["notifications_public"],
                    0,
                    $this->block_id
                );
                ilBlockSetting::_write(
                    $this->getBlockType(),
                    "public_feed",
                    $_POST["notifications_public_feed"],
                    0,
                    $this->block_id
                );
                ilBlockSetting::_write(
                    $this->getBlockType(),
                    "default_visibility",
                    $_POST["default_visibility"],
                    0,
                    $this->block_id
                );
            }
            
            if ($this->getProperty("hide_news_block_option")) {
                ilBlockSetting::_write(
                    $this->getBlockType(),
                    "hide_news_block",
                    $_POST["hide_news_block"],
                    0,
                    $this->block_id
                );
                ilBlockSetting::_write(
                    $this->getBlockType(),
                    "hide_news_per_date",
                    $_POST["hide_news_per_date"],
                    0,
                    $this->block_id
                );

                // hide date
                $hd = $this->settings_form->getItemByPostVar("hide_news_date");
                $hide_date = $hd->getDate();
                if ($_POST["hide_news_per_date"] && $hide_date != null) {
                    ilBlockSetting::_write(
                        $this->getBlockType(),
                        "hide_news_date",
                        $hide_date->get(IL_CAL_DATETIME),
                        0,
                        $this->block_id
                    );
                } else {
                    ilBlockSetting::_write(
                        $this->getBlockType(),
                        "hide_news_date",
                        "",
                        0,
                        $this->block_id
                    );
                }
            }
            
            include_once("./Services/News/classes/class.ilNewsCache.php");
            $cache = new ilNewsCache();
            $cache->deleteEntry($ilUser->getId() . ":" . $_GET["ref_id"]);

            $ilCtrl->returnToParent($this);
        } else {
            $this->settings_form->setValuesByPost();
            return $this->settings_form->getHtml();
        }
    }

Here is the call graph for this function:

setEnableEdit()

ilNewsForContextBlockGUI::setEnableEdit

(

$a_enable_edit = 0

)

Set EnableEdit.

Parameters

boolean

$a_enable_edit

Edit mode on/off

Definition at line 231 of file class.ilNewsForContextBlockGUI.php.

    {
        $this->enable_edit = $a_enable_edit;
    }

showFeedUrl()

ilNewsForContextBlockGUI::showFeedUrl

(

)

Show feed URL.

Definition at line 1320 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$title, ilBlockGUI\$tpl, ilBlockGUI\$user, ilObjUser\_lookupFeedHash(), ilObject\_lookupTitle(), and ILIAS_HTTP_PATH.

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        
        include_once("./Services/News/classes/class.ilNewsItem.php");
        
        $title = ilObject::_lookupTitle($this->block_id);
        
        $tpl = new ilTemplate("tpl.show_feed_url.html", true, true, "Services/News");
        $tpl->setVariable(
            "TXT_TITLE",
            sprintf($lng->txt("news_feed_url_for"), $title)
        );
        $tpl->setVariable("TXT_INFO", $lng->txt("news_get_feed_info"));
        $tpl->setVariable("TXT_FEED_URL", $lng->txt("news_feed_url"));
        $tpl->setVariable(
            "VAL_FEED_URL",
            ILIAS_HTTP_PATH . "/feed.php?client_id=" . rawurlencode(CLIENT_ID) . "&user_id=" . $ilUser->getId() .
                "&obj_id=" . $this->block_id .
                "&hash=" . ilObjUser::_lookupFeedHash($ilUser->getId(), true)
        );
        $tpl->setVariable(
            "VAL_FEED_URL_TXT",
            ILIAS_HTTP_PATH . "/feed.php?client_id=" . rawurlencode(CLIENT_ID) . "&<br />user_id=" . $ilUser->getId() .
                "&obj_id=" . $this->block_id .
                "&hash=" . ilObjUser::_lookupFeedHash($ilUser->getId(), true)
        );
        
        $content_block = new ilDashboardContentBlockGUI();
        $content_block->setContent($tpl->get());
        $content_block->setTitle($lng->txt("news_internal_news"));

        return $content_block->getHTML();
    }

Here is the call graph for this function:

showNews()

ilNewsForContextBlockGUI::showNews

(

)

show news

Definition at line 535 of file class.ilNewsForContextBlockGUI.php.

References $_GET, ilBlockGUI\$access, Vendor\Package\$c, ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$title, ilBlockGUI\$tpl, $url, ilBlockGUI\$user, ilObject\_exists(), ilObjForumAccess\_getThreadForPosting(), ilBlockSetting\_lookup(), ilNewsItem\_lookupContextObjId(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilNewsItem\_setRead(), ilNewsItem\determineNewsTitle(), ilDatePresentation\formatDate(), ilBlockGUI\getData(), ilLinkButton\getInstance(), getMediaPath(), ilObjMediaObject\getMimeType(), getNewsData(), ilBlockGUI\getProperty(), ilNewsRendererFactory\getRenderer(), IL_CAL_DATETIME, ilWikiPage\lookupTitle(), ilWikiUtil\makeUrlTitle(), NEWS_PUBLIC, ilBlockGUI\setData(), and ui().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        $ilAccess = $this->access;
        
        // workaround for dynamic mode (if cache is disabled, showNews has no data)
        if (empty(self::$st_data)) {
            $this->setData($this->getNewsData());
        }
        
        $news_set = new ilSetting("news");
        $enable_internal_rss = $news_set->get("enable_rss_for_internal");

        include_once("./Services/News/classes/class.ilNewsItem.php");
        $news = new ilNewsItem((int) $_GET["news_id"]);
        
        $tpl = new ilTemplate("tpl.show_news.html", true, true, "Services/News");

        // get current item in data set
        $previous = $next = "";
        reset($this->data);
        $c = current($this->data);
        $curr_cnt = 1;

        while ($c["id"] > 0 &&
             $c["id"] != $_GET["news_id"]) {
            $previous = $c;
            $c = next($this->data);
            $curr_cnt++;
        }

        if (!is_array($c) && is_object($news) && $news->getId() > 0
            && ilNewsItem::_lookupContextObjId($news->getId()) != $ilCtrl->getContextObjId()) {
            throw new ilException("News ID does not match object context.");
        }


        // collect news items to show
        $news_list = array();
        if (is_array($c["aggregation"])) {      // we have an aggregation
            $news_list[] = array("ref_id" => $c["agg_ref_id"],
                "agg_ref_id" => $c["agg_ref_id"],
                "aggregation" => $c["aggregation"],
                "user_id" => "",
                "content_type" => "text",
                "mob_id" => 0,
                "visibility" => "",
                "content" => "",
                "content_long" => "",
                "update_date" => $news->getUpdateDate(),
                "creation_date" => "",
                "content_is_lang_var" => false,
                "loc_context" => $_GET["news_context"],
                "context_obj_type" => $news->getContextObjType(),
                "title" => "");

            foreach ($c["aggregation"] as $c_item) {
                ilNewsItem::_setRead($ilUser->getId(), $c_item["id"]);
                $c_item["loc_context"] = $c_item["ref_id"];
                $c_item["loc_stop"] = $_GET["news_context"];
                $news_list[] = $c_item;
            }
        } else {                                                                // no aggregation, simple news item
            $news_list[] = array(
                "id" => $news->getId(),
                "ref_id" => $_GET["news_context"],
                "user_id" => $news->getUserId(),
                "content_type" => $news->getContentType(),
                "mob_id" => $news->getMobId(),
                "visibility" => $news->getVisibility(),
                "priority" => $news->getPriority(),
                "content" => $news->getContent(),
                "content_long" => $news->getContentLong(),
                "update_date" => $news->getUpdateDate(),
                "creation_date" => $news->getCreationDate(),
                "context_sub_obj_type" => $news->getContextSubObjType(),
                "context_obj_type" => $news->getContextObjType(),
                "context_sub_obj_id" => $news->getContextSubObjId(),
                "content_is_lang_var" => $news->getContentIsLangVar(),
                "content_text_is_lang_var" => $news->getContentTextIsLangVar(),
                "loc_context" => $_GET["news_context"],
                "title" => $news->getTitle());
            ilNewsItem::_setRead($ilUser->getId(), $_GET["news_id"]);
        }

        $row_css = "";
        $cache_deleted = false;
        foreach ($news_list as $item) {
            $row_css = ($row_css != "tblrow1")
                    ? "tblrow1"
                    : "tblrow2";

            if ($item["ref_id"] > 0 && !$ilAccess->checkAccess("read", "", $item["ref_id"])) {
                $tpl->setCurrentBlock("content");
                $tpl->setVariable("VAL_CONTENT", $lng->txt("news_sorry_not_accessible_anymore"));
                $tpl->parseCurrentBlock();
                $tpl->setCurrentBlock("item");
                $tpl->setVariable("ITEM_ROW_CSS", $row_css);
                $tpl->parseCurrentBlock();
                if (!$cache_deleted) {
                    $this->acache->deleteEntry($ilUser->getId() . ":" . $_GET["ref_id"]);
                    $cache_deleted = true;
                }
                continue;
            }

            // user
            if ($item["user_id"] > 0 && ilObject::_exists($item["user_id"])) {
                // get login
                if (ilObjUser::_exists($item["user_id"])) {
                    $user = new ilObjUser($item["user_id"]);
                    $displayname = $user->getLogin();
                } else {
                    // this should actually not happen, since news entries
                    // should be deleted when the user is going to be removed
                    $displayname = "<" . strtolower($lng->txt("deleted")) . ">";
                }
            
                $tpl->setCurrentBlock("user_info");
                $tpl->setVariable("VAL_AUTHOR", $displayname);
                $tpl->setVariable("TXT_AUTHOR", $lng->txt("author"));
                $tpl->parseCurrentBlock();
            }
                        
            // media player
            $ui_renderer = $this->ui->renderer();
            $ui_factory = $this->ui->factory();
            $this->ui->factory();
            if ($item["mob_id"] > 0 && ilObject::_exists($item["mob_id"])) {
                $media_path = $this->getMediaPath($item["mob_id"]);
                $mime = ilObjMediaObject::getMimeType($media_path);
                if (in_array($mime, array("image/jpeg", "image/svg+xml", "image/gif", "image/png"))) {
                    $title = basename($media_path);
                    $html = $ui_renderer->render($ui_factory->image()->responsive($media_path, $title));
                } elseif (in_array($mime, array("audio/mpeg", "audio/ogg", "video/mp4", "video/x-flv", "video/webm"))) {
                    $mp = new ilMediaPlayerGUI();
                    $mp->setFile($media_path);
                    $mp->setDisplayHeight(200);
                    $html = $mp->getMediaPlayerHtml();
                } else {
                    // download?
                    $html = "";
                }


                $tpl->setCurrentBlock("player");
                $tpl->setVariable(
                    "PLAYER",
                    $html
                );
                $tpl->parseCurrentBlock();
            }
            
            // access
            if ($enable_internal_rss && $item["visibility"] != "") {
                $obj_id = ilObject::_lookupObjId($item["ref_id"]);
                $tpl->setCurrentBlock("access");
                $tpl->setVariable("TXT_ACCESS", $lng->txt("news_news_item_visibility"));
                if ($item["visibility"] == NEWS_PUBLIC ||
                    ($item["priority"] == 0 &&
                    ilBlockSetting::_lookup(
                        "news",
                        "public_notifications",
                        0,
                        $obj_id
                    ))) {
                    $tpl->setVariable("VAL_ACCESS", $lng->txt("news_visibility_public"));
                } else {
                    $tpl->setVariable("VAL_ACCESS", $lng->txt("news_visibility_users"));
                }
                $tpl->parseCurrentBlock();
            }

            // content
            include_once("./Services/News/classes/class.ilNewsRendererFactory.php");
            $renderer = ilNewsRendererFactory::getRenderer($item["context_obj_type"]);
            if (trim($item["content"]) != "") {         // content
                $it = new ilNewsItem($item["id"]);
                $renderer->setNewsItem($it, $item["ref_id"]);
                $tpl->setCurrentBlock("content");
                $tpl->setVariable("VAL_CONTENT", $renderer->getDetailContent());
                $tpl->parseCurrentBlock();
            }
            if ($item["update_date"] != $item["creation_date"]) {               // update date
                $tpl->setCurrentBlock("ni_update");
                $tpl->setVariable("TXT_LAST_UPDATE", $lng->txt("last_update"));
                $tpl->setVariable(
                    "VAL_LAST_UPDATE",
                    ilDatePresentation::formatDate(new ilDateTime($item["update_date"], IL_CAL_DATETIME))
                );
                $tpl->parseCurrentBlock();
            }
            
            // creation date
            if ($item["creation_date"] != "") {
                $tpl->setCurrentBlock("ni_update");
                $tpl->setVariable(
                    "VAL_CREATION_DATE",
                    ilDatePresentation::formatDate(new ilDateTime($item["creation_date"], IL_CAL_DATETIME))
                    );
                $tpl->setVariable("TXT_CREATED", $lng->txt("created"));
                $tpl->parseCurrentBlock();
            }


            // context / title
            if ($_GET["news_context"] > 0) {
                //$obj_id = ilObject::_lookupObjId($_GET["news_context"]);
                $obj_id = ilObject::_lookupObjId($item["ref_id"]);
                $obj_type = ilObject::_lookupType($obj_id);
                $obj_title = ilObject::_lookupTitle($obj_id);
                
                // file hack, not nice
                if ($obj_type == "file") {
                    $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $item["ref_id"]);
                    $url = $ilCtrl->getLinkTargetByClass("ilrepositorygui", "sendfile");
                    $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $_GET["ref_id"]);
                    
                    include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
                    $button = ilLinkButton::getInstance();
                    $button->setUrl($url);
                    $button->setCaption("download");
                    
                    $tpl->setCurrentBlock("download");
                    $tpl->setVariable("BUTTON_DOWNLOAD", $button->render());
                    $tpl->parseCurrentBlock();
                }
                
                // forum hack, not nice
                $add = "";
                if ($obj_type == "frm" && $item["context_sub_obj_type"] == "pos"
                    && $item["context_sub_obj_id"] > 0) {
                    include_once("./Modules/Forum/classes/class.ilObjForumAccess.php");
                    $pos = $item["context_sub_obj_id"];
                    $thread = ilObjForumAccess::_getThreadForPosting($pos);
                    if ($thread > 0) {
                        $add = "_" . $thread . "_" . $pos;
                    }
                }

                // wiki hack, not nice
                if ($obj_type == "wiki" && $item["context_sub_obj_type"] == "wpg"
                    && $item["context_sub_obj_id"] > 0) {
                    include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
                    $wptitle = ilWikiPage::lookupTitle($item["context_sub_obj_id"]);
                    if ($wptitle != "") {
                        $add = "_" . ilWikiUtil::makeUrlTitle($wptitle);
                    }
                }

                $url_target = "./goto.php?client_id=" . rawurlencode(CLIENT_ID) . "&target=" .
                    $obj_type . "_" . $item["ref_id"] . $add;

                // lm page hack, not nice
                if (in_array($obj_type, array("lm")) && $item["context_sub_obj_type"] == "pg"
                    && $item["context_sub_obj_id"] > 0) {
                    $url_target = "./goto.php?client_id=" . rawurlencode(CLIENT_ID) . "&target=" .
                        "pg_" . $item["context_sub_obj_id"] . "_" . $item["ref_id"];
                }
                
                // blog posting hack, not nice
                if ($obj_type == "blog" && $item["context_sub_obj_type"] == "blp"
                    && $item["context_sub_obj_id"] > 0) {
                    $url_target = "./goto.php?client_id=" . rawurlencode(CLIENT_ID) . "&target=" .
                        "blog_" . $item["ref_id"] . "_" . $item["context_sub_obj_id"];
                }
    
                $context_opened = false;
                if ($item["loc_context"] != null && $item["loc_context"] != $item["loc_stop"]) {
                    $tpl->setCurrentBlock("context");
                    $context_opened = true;
                    $cont_loc = new ilLocatorGUI();
                    $cont_loc->addContextItems($item["loc_context"], true, $item["loc_stop"]);
                    $tpl->setVariable("CONTEXT_LOCATOR", $cont_loc->getHTML());
                }
                
                //var_dump($item);
                if ($item["no_context_title"] !== true) {
                    if (!$context_opened) {
                        $tpl->setCurrentBlock("context");
                    }
                    $tpl->setVariable("HREF_CONTEXT_TITLE", $url_target);
                    $tpl->setVariable("CONTEXT_TITLE", $obj_title);
                    $tpl->setVariable("IMG_CONTEXT_TITLE", ilObject::_getIcon($obj_id, "big", $obj_type));
                }
                if ($context_opened) {
                    $tpl->parseCurrentBlock();
                }
    
                $tpl->setVariable("HREF_TITLE", $url_target);
            }
            
            // title
            $tpl->setVariable(
                "VAL_TITLE",
                ilNewsItem::determineNewsTitle(
                    $item["context_obj_type"],
                    $item["title"],
                    $item["content_is_lang_var"],
                    $item["agg_ref_id"],
                    $item["aggregation"]
                )
            );
            

            $tpl->setCurrentBlock("item");
            $tpl->setVariable("ITEM_ROW_CSS", $row_css);
            $tpl->parseCurrentBlock();
        }
        
        $content_block = new ilDashboardContentBlockGUI();
        $content_block->setContent($tpl->get());
        if ($this->getProperty("title") != "") {
            $content_block->setTitle($this->getProperty("title"));
        } else {
            $content_block->setTitle($lng->txt("news_internal_news"));
        }

        // previous
        if ($previous != "") {
            if ($previous["ref_id"] > 0) {
                $ilCtrl->setParameter($this, "news_context", $previous["ref_id"]);
            }
            $ilCtrl->setParameter($this, "news_id", $previous["id"]);
            // @todo: make this a view control
            $content_block->addBlockCommand($ilCtrl->getLinkTarget($this, "showNews"), $lng->txt("previous"));
            $ilCtrl->setParameter($this, "news_context", "");
        }
        
        // next
        if ($c = next($this->data)) {
            if ($c["ref_id"] > 0) {
                $ilCtrl->setParameter($this, "news_context", $c["ref_id"]);
            }
            $ilCtrl->setParameter($this, "news_id", $c["id"]);
            // @todo: make this a view control
            $content_block->addBlockCommand($ilCtrl->getLinkTarget($this, "showNews"), $lng->txt("next"));
        }
        $ilCtrl->setParameter($this, "news_context", "");
        $ilCtrl->setParameter($this, "news_id", "");
        $content_block->setCurrentItemNumber($curr_cnt);
        $content_block->setEnableNumInfo(true);
        $content_block->setData($this->getData());

        return $content_block->getHTML();
    }

Here is the call graph for this function:

showNotifications()

ilNewsForContextBlockGUI::showNotifications

(

)

Definition at line 948 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$block_id, ilBlockGUI\$ctrl, ilBlockGUI\$data, $ilCtrl, $ilUser, ilBlockGUI\$user, ilBlockSetting\_write(), exit, getBlockType(), getHTML(), getNewsData(), handleView(), and ilBlockGUI\setData().

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        
        include_once("Services/Block/classes/class.ilBlockSetting.php");
        ilBlockSetting::_write(
            $this->getBlockType(),
            "view",
            "",
            $ilUser->getId(),
            $this->block_id
        );

        // reload data
        $data = $this->getNewsData();
        $this->setData($data);
        $this->handleView();

        if ($ilCtrl->isAsynch()) {
            echo $this->getHTML();
            exit;
        } else {
            $ilCtrl->returnToParent($this);
        }
    }

Here is the call graph for this function:

subscribeNews()

ilNewsForContextBlockGUI::subscribeNews

(

)

Subscribe current user from news.

Definition at line 937 of file class.ilNewsForContextBlockGUI.php.

References $_GET, ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$user, and ilNewsSubscription\_subscribe().

    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;

        include_once("./Services/News/classes/class.ilNewsSubscription.php");
        ilNewsSubscription::_subscribe($_GET["ref_id"], $ilUser->getId());
        $ilCtrl->returnToParent($this);
    }

Here is the call graph for this function:

unsubscribeNews()

ilNewsForContextBlockGUI::unsubscribeNews

(

)

Unsubscribe current user from news.

Definition at line 924 of file class.ilNewsForContextBlockGUI.php.

References $_GET, ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$user, and ilNewsSubscription\_unsubscribe().

    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        
        include_once("./Services/News/classes/class.ilNewsSubscription.php");
        ilNewsSubscription::_unsubscribe($_GET["ref_id"], $ilUser->getId());
        $ilCtrl->returnToParent($this);
    }

Here is the call graph for this function:

writeSettings()

static ilNewsForContextBlockGUI::writeSettings (   $a_values )

static

Definition at line 1211 of file class.ilNewsForContextBlockGUI.php.

References ilBlockGUI\$block_id, $DIC, and ilBlockSetting\_write().

Referenced by ilContainerNewsSettingsGUI\save().

    {
        global $DIC;

        $block_id = $DIC->ctrl()->getContextObjId();
        foreach ($a_values as $key => $value) {
            ilBlockSetting::_write(self::$block_type, $key, $value, 0, $block_id);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$block_type

ilNewsForContextBlockGUI::$block_type = "news"

static

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

Referenced by ilContainerNewsSettingsGUI\initForm().

$help

ilNewsForContextBlockGUI::$help

protected

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

$new_rendering

ilNewsForContextBlockGUI::$new_rendering = true

protected

Definition at line 1467 of file class.ilNewsForContextBlockGUI.php.

$obj_definition

ilNewsForContextBlockGUI::$obj_definition

protected

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

Referenced by getInfoForData().

$settings

ilNewsForContextBlockGUI::$settings

protected

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

Referenced by ilPDNewsBlockGUI\editSettings(), initSettingsForm(), and ilPDNewsBlockGUI\showFeedUrl().

$st_data

ilNewsForContextBlockGUI::$st_data

static

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

$tabs

ilNewsForContextBlockGUI::$tabs

protected

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

Referenced by initSettingsForm().

OBJECTS_WITH_NEWS_SUBTAB

const ilNewsForContextBlockGUI::OBJECTS_WITH_NEWS_SUBTAB = ["category", "course", "group", "forum"]

object type names with settings->news settings subtab

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

Referenced by getHTML().

---

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

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