ilPDNewsBlockGUI Class Reference

BlockGUI class for block NewsForContext. More...

Inheritance diagram for ilPDNewsBlockGUI:

Collaboration diagram for ilPDNewsBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	getNewsData ()
	Get news for context. More...
	getBlockType ()
	executeCommand ()
	execute command More...
	fillDataSection ()
	Fill data section. More...
	getHTML ()
	Get bloch HTML code. More...
	showFeedUrl ()
	Show feed URL. More...
	addCloseCommand ($a_content_block)
	showNews ()
	show news More...
	editSettings (ilPropertyFormGUI $a_private_form=null)
	Show settings screen. More...
	cancelSettings ()
	Cancel settings. More...
	saveSettings ()
	Save settings. More...
	changeFeedSettings ()
	change user password More...
Public Member Functions inherited from ilNewsForContextBlockGUI
	__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 ($news)
	get flat bookmark list for personal desktop More...
	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...
	fillFooter ()
	block footer More...
	showViewFooter ()
	Show additional footer for show/hide notifications. 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...
	addCloseCommand ($a_content_block)
	getDynamic ()
	getDynamicReload ()
	getJSEnabler ()
	disableJS ()
	enableJS ()
Public Member Functions inherited from ilBlockGUI
	getBlockType ()
	__construct ()
	Constructor. More...
	addHeaderLink ($a_href, $a_text, $status=true)
	getHeaderLinks ()
	setData ($a_data)
	Set Data. More...
	getData ()
	Get Data. More...
	setBigMode ($a_bigmode)
	Set Big Mode. More...
	getBigMode ()
	Get Big Mode. More...
	setBlockId ($a_block_id=0)
	Set Block Id. More...
	getBlockId ()
	Get Block Id. More...
	setAvailableDetailLevels ($a_max, $a_min=0)
	Set Available Detail Levels. More...
	setCurrentDetailLevel ($a_currentdetaillevel)
	Set Current Detail Level. More...
	setGuiObject (&$a_gui_object)
	Set GuiObject. More...
	getGuiObject ()
	Get GuiObject. More...
	getCurrentDetailLevel ()
	Get Current Detail Level. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setImage ($a_image)
	Set Image. More...
	getImage ()
	Get Image. 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...
	setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
	Set Footer Info. More...
	getFooterInfo ($a_hide_and_icon=false)
	Get Footer Info. 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 ($a_admincommands)
	Set Administration Commmands. More...
	getAdminCommands ()
	Get Administration Commmands. More...
	setColSpan ($a_colspan)
	Set Columns Span. More...
	getColSpan ()
	Get Columns Span. More...
	setEnableDetailRow ($a_enabledetailrow)
	Set EnableDetailRow. More...
	getEnableDetailRow ()
	Get EnableDetailRow. 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 ()
	getDetailParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	Get Row Template Name. More...
	getRowTemplateDir ()
	Get Row Template Directory. More...
	addBlockCommand ( $a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
	Add Block Command. More...
	getBlockCommands ()
	Get Block commands. More...
	addHeaderCommand ($a_href, $a_text, $a_as_close=false)
	Add Header Block Command. More...
	getHeaderCommands ()
	Get Header Block commands. More...
	addFooterLink ( $a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false, $a_checked=false)
	Add a footer text/link. More...
	getFooterLinks ()
	Get footer links. More...
	clearFooterLinks ()
	Clear footer links. More...
	handleDetailLevel ()
	Handle read/write current detail level. More...
	getHTML ()
	Handle config status. 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...
	fillFooterLinks ($a_top=false, $a_numinfo="")
	Fill footer links. More...
	fillDetailRow ()
	Fill Detail Setting Row. More...

Static Public Member Functions
static	getScreenMode ()
	Get Screen Mode for current command. More...
Static Public Member Functions inherited from ilNewsForContextBlockGUI
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...

Static Public Attributes
static	$block_type = "pdnews"
static	$st_data
Static Public Attributes inherited from ilNewsForContextBlockGUI
static	$block_type = "news"
static	$st_data

Protected Member Functions
	isRepositoryObject ()
	initPrivateSettingsForm ()
Protected Member Functions inherited from ilNewsForContextBlockGUI
	isRepositoryObject ()
	getMediaPath (int $mob_id)
Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	fillRowColor ($a_placeholder="CSS_ROW")
	preloadData (array $data)
	Can be overwritten in subclasses. More...

Protected Attributes
	$acc_results = false
Protected Attributes inherited from ilNewsForContextBlockGUI
	$help
	$settings
	$tabs
	$obj_definition
Protected Attributes inherited from ilBlockGUI
	$data = array()
	$colspan = 1
	$enablenuminfo = true
	$detail_min = 0
	$detail_max = 0
	$bigmode = false
	$footer_links = array()
	$block_id = 0
	$header_commands = array()
	$allow_moving = true
	$move = array("left" => false, "right" => false, "up" => false, "down" => false)
	$enabledetailrow = true
	$header_links = array()
	$footerinfo = false
	$footerinfo_icon = false
	$block_commands = array()
	$max_count = false
	$close_command = false
	$image = false
	$property = false
	$nav_value = ""
	$css_row = ""
	$dropdown
	$tpl
	$main_tpl
	$user
	$ctrl
	$access
	$lng
	$obj_def

Additional Inherited Members
Data Fields inherited from ilNewsForContextBlockGUI
const	OBJECTS_WITH_NEWS_SUBTAB = ["category", "course", "group", "forum"]
	object type names with settings->news settings subtab More...

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

class.ilNewsForContextBlockGUI.php 12920 2007-01-03 19:13:46Z akill

ilPDNewsBlockGUI: ilColumnGUI

Definition at line 16 of file class.ilPDNewsBlockGUI.php.

Constructor & Destructor Documentation

__construct()

ilPDNewsBlockGUI::__construct

(

)

Constructor.

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

References ilBlockGUI\$data, $DIC, $ilUser, ilBlockGUI\$lng, ilBlockGUI\__construct(), ilBlockGUI\getCurrentDetailLevel(), ilNewsForContextBlockGUI\getDynamic(), getNewsData(), ilNewsForContextBlockGUI\handleView(), ilNewsItem\prepareNewsDataFromCache(), ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setData(), ilBlockGUI\setLimit(), ilBlockGUI\setRowTemplate(), settings(), ilBlockGUI\setTitle(), and user().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $this->ctrl = $DIC->ctrl();
        $this->settings = $DIC->settings();
        $lng = $DIC->language();
        $ilUser = $DIC->user();
        $ilAccess = $DIC->access();
        $this->obj_definition = $DIC["objDefinition"];
        $this->ui = $DIC->ui();

        // NOT ilNewsForContextBlockGUI::__construct() !
        ilBlockGUI::__construct();
        
        $lng->loadLanguageModule("news");
        include_once("./Services/News/classes/class.ilNewsItem.php");

        $this->setLimit(5);
        $this->setAvailableDetailLevels(3);

        $this->dynamic = false;

        include_once("./Services/News/classes/class.ilNewsCache.php");
        $this->acache = new ilNewsCache();
        $cres = unserialize($this->acache->getEntry($ilUser->getId() . ":0"));
        $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();
        } elseif ($this->getCurrentDetailLevel() > 0) {
            // do not ask two times for the data (e.g. if user displays a
            // single item on the personal desktop and the news block is
            // displayed at the same time)
            if (empty(self::$st_data)) {
                self::$st_data = $this->getNewsData();
                $data = self::$st_data;
            } else {
                $data = self::$st_data;
            }
        } else {
            $data = array();
        }
        
        $this->setTitle($lng->txt("news_internal_news"));
        $this->setRowTemplate("tpl.block_row_news_for_context.html", "Services/News");
        
        $this->setData($data);
        
        $this->handleView();
        
        // reset access check results
        $ilAccess->setResults($this->acc_results);
    }

Here is the call graph for this function:

Member Function Documentation

addCloseCommand()

ilPDNewsBlockGUI::addCloseCommand

(

$a_content_block

)

Definition at line 334 of file class.ilPDNewsBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, and ilBlockGUI\$lng.

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        $a_content_block->addHeaderCommand(
            $ilCtrl->getParentReturn($this),
            $lng->txt("selected_items_back")
        );
    }

cancelSettings()

ilPDNewsBlockGUI::cancelSettings

(

)

Cancel settings.

Definition at line 478 of file class.ilPDNewsBlockGUI.php.

References ilBlockGUI\$ctrl, and $ilCtrl.

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

changeFeedSettings()

ilPDNewsBlockGUI::changeFeedSettings

(

)

change user password

Definition at line 514 of file class.ilPDNewsBlockGUI.php.

References ilBlockGUI\$ctrl, $form, $ilCtrl, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$user, ilNewsForContextBlockGUI\editSettings(), ilUserPasswordManager\getInstance(), initPrivateSettingsForm(), and ilUtil\sendFailure().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
        
        $form = $this->initPrivateSettingsForm();
        if ($form->checkInput()) {
            // Deactivate private Feed - just delete the password
            if (!$form->getInput("enable_private_feed")) {
                $ilUser->_setFeedPass($ilUser->getId(), "");
                ilUtil::sendSuccess($lng->txt("priv_feed_disabled"), true);
                // $ilCtrl->returnToParent($this);
                $ilCtrl->redirect($this, "showFeedUrl");
            } else {
                $passwd = $form->getInput("desired_password");
                require_once 'Services/User/classes/class.ilUserPasswordManager.php';
                if (ilUserPasswordManager::getInstance()->verifyPassword($ilUser, $passwd)) {
                    $form->getItemByPostVar("desired_password")->setAlert($lng->txt("passwd_equals_ilpasswd"));
                    ilUtil::sendFailure($lng->txt("form_input_not_valid"));
                } else {
                    $ilUser->_setFeedPass($ilUser->getId(), $passwd);
                    ilUtil::sendSuccess($lng->txt("saved_successfully"), true);
                    // $ilCtrl->returnToParent($this);
                    $ilCtrl->redirect($this, "showFeedUrl");
                }
            }
        }
        
        $form->setValuesByPost();
        return $this->editSettings($form);
    }

Here is the call graph for this function:

editSettings()

ilPDNewsBlockGUI::editSettings

(

ilPropertyFormGUI

$a_private_form = null

)

Show settings screen.

Definition at line 363 of file class.ilPDNewsBlockGUI.php.

References ilBlockGUI\$ctrl, $form, $ilCtrl, $ilSetting, $ilUser, ilBlockGUI\$lng, ilNewsForContextBlockGUI\$settings, ilBlockGUI\$user, ilNewsItem\_lookupDefaultPDPeriod(), ilNewsItem\_lookupUserPDPeriod(), initPrivateSettingsForm(), and ilSelectInputGUI\setOptions().

    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;
        
        $news_set = new ilSetting("news");
        $enable_internal_rss = $news_set->get("enable_rss_for_internal");
        $allow_shorter_periods = $news_set->get("allow_shorter_periods");
        $allow_longer_periods = $news_set->get("allow_longer_periods");
        $enable_private_feed = $news_set->get("enable_private_feed");
    
        if (!$a_private_form && ($allow_shorter_periods || $allow_longer_periods)) {
            include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
            $form = new ilPropertyFormGUI();
            $form->setFormAction($ilCtrl->getFormaction($this));
            $form->setTitle($lng->txt("news_settings"));

            include_once("./Services/News/classes/class.ilNewsItem.php");
            $default_per = ilNewsItem::_lookupDefaultPDPeriod();
            $per = ilNewsItem::_lookupUserPDPeriod($ilUser->getId());

            $form->setTableWidth("100%");

            $per_opts = array(
                2 => "2 " . $lng->txt("days"),
                3 => "3 " . $lng->txt("days"),
                5 => "5 " . $lng->txt("days"),
                7 => "1 " . $lng->txt("week"),
                14 => "2 " . $lng->txt("weeks"),
                30 => "1 " . $lng->txt("month"),
                60 => "2 " . $lng->txt("months"),
                120 => "4 " . $lng->txt("months"),
                180 => "6 " . $lng->txt("months"),
                366 => "1 " . $lng->txt("year"));

            $unset = array();
            foreach ($per_opts as $k => $opt) {
                if (!$allow_shorter_periods && ($k < $default_per)) {
                    $unset[$k] = $k;
                }
                if (!$allow_longer_periods && ($k > $default_per)) {
                    $unset[$k] = $k;
                }
            }
            foreach ($unset as $k) {
                unset($per_opts[$k]);
            }

            $per_sel = new ilSelectInputGUI(
                $lng->txt("news_pd_period"),
                "news_pd_period"
            );
            //$per_sel->setInfo($lng->txt("news_pd_period_info"));
            $per_sel->setOptions($per_opts);
            $per_sel->setValue((int) $per);
            $form->addItem($per_sel);
        
            //$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"))
            //{
            //  $form->addCheckboxProperty($lng->txt("news_notifications_public"), "notifications_public",
            //          "1", $public, $lng->txt("news_notifications_public_info"));
            //}
            $form->addCommandButton("saveSettings", $lng->txt("save"));
            $form->addCommandButton("cancelSettings", $lng->txt("cancel"));
            
            $returnForm = $form->getHTML();
        }

        if ($enable_private_feed) {
            if (!$a_private_form) {
                $a_private_form = $this->initPrivateSettingsForm();
            }
            $returnForm .= ($returnForm == "")
                ? $a_private_form->getHTML()
                : "<br>" . $a_private_form->getHTML();
        }
        
        return $returnForm;
    }

Here is the call graph for this function:

executeCommand()

ilPDNewsBlockGUI::executeCommand

(

)

execute command

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

References ilBlockGUI\$ctrl, and $ilCtrl.

    {
        $ilCtrl = $this->ctrl;

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

        switch ($next_class) {
            default:
                return $this->$cmd();
        }
    }

fillDataSection()

ilPDNewsBlockGUI::fillDataSection

(

)

Fill data section.

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

References ilBlockGUI\getCurrentDetailLevel(), ilBlockGUI\getData(), ilNewsForContextBlockGUI\getDynamicReload(), ilNewsForContextBlockGUI\getOverview(), ilBlockGUI\setDataSection(), ilBlockGUI\setEnableDetailRow(), and ilBlockGUI\setEnableNumInfo().

    {
        if ($this->dynamic) {
            $this->setDataSection($this->getDynamicReload());
        } elseif ($this->getCurrentDetailLevel() > 1 && count($this->getData()) > 0) {
            parent::fillDataSection();
        } else {
            $this->setEnableNumInfo(false);
            if (count($this->getData()) == 0) {
                $this->setEnableDetailRow(false);
            }
            $this->setDataSection($this->getOverview());
        }
    }

Here is the call graph for this function:

getBlockType()

ilPDNewsBlockGUI::getBlockType

(

)

Definition at line 118 of file class.ilPDNewsBlockGUI.php.

Referenced by saveSettings().

                                   : string
    {
        return self::$block_type;
    }

Here is the caller graph for this function:

getHTML()

ilPDNewsBlockGUI::getHTML

(

)

Get bloch HTML code.

Definition at line 194 of file class.ilPDNewsBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$user, ilNewsItem\_lookupUserPDPeriod(), ilBlockGUI\addBlockCommand(), ilRSSButtonGUI\get(), ilBlockGUI\getCurrentDetailLevel(), ilBlockGUI\getHTML(), ilNewsForContextBlockGUI\getJSEnabler(), ilBlockGUI\getTitle(), ilRSSButtonGUI\ICON_RSS, ilBlockGUI\setFooterInfo(), and ilBlockGUI\setTitle().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
        
        // set footer info
        $this->setFooterInfo($lng->txt("news_block_information"), true);
        
        $news_set = new ilSetting("news");
        $enable_internal_rss = $news_set->get("enable_rss_for_internal");
        $allow_shorter_periods = $news_set->get("allow_shorter_periods");
        $allow_longer_periods = $news_set->get("allow_longer_periods");
        $enable_private_feed = $news_set->get("enable_private_feed");

        // subscribe/unsibscribe link
        include_once("./Services/News/classes/class.ilNewsSubscription.php");
        
        // show feed url
        if ($enable_internal_rss) {
            include_once("./Services/News/classes/class.ilRSSButtonGUI.php");
            $this->addBlockCommand(
                $ilCtrl->getLinkTarget($this, "showFeedUrl"),
                $lng->txt("news_get_feed_url"),
                "",
                "",
                true,
                false,
                ilRSSButtonGUI::get(ilRSSButtonGUI::ICON_RSS)
            );
        }

        if ($allow_shorter_periods || $allow_longer_periods || $enable_private_feed) {
            $this->addBlockCommand(
                $ilCtrl->getLinkTarget($this, "editSettings"),
                $lng->txt("settings")
            );
        }
            
        $per = ilNewsItem::_lookupUserPDPeriod($ilUser->getId());

        if ($per > 0) {
            switch ($per) {
                case 2:
                case 3:
                case 5: $per_str = sprintf($lng->txt("news_period_x_days"), $per); break;
                case 7: $per_str = $lng->txt("news_period_1_week"); break;
                case 14: $per_str = sprintf($lng->txt("news_period_x_weeks"), 2); break;
                case 30: $per_str = $lng->txt("news_period_1_month"); break;
                case 60: $per_str = sprintf($lng->txt("news_period_x_months"), 2); break;
                case 120: $per_str = sprintf($lng->txt("news_period_x_months"), 4); break;
                case 180: $per_str = sprintf($lng->txt("news_period_x_months"), 6); break;
                case 366: $per_str = $lng->txt("news_period_1_year"); break;
            }
            if ($per_str != "") {
                $this->setTitle($this->getTitle() . ' <span style="font-weight:normal;">- ' . $per_str . "</span>");
            }
        }

        if ($this->getCurrentDetailLevel() == 0) {
            return "";
        }

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

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

Here is the call graph for this function:

getNewsData()

ilPDNewsBlockGUI::getNewsData

(

)

Get news for context.

Definition at line 92 of file class.ilPDNewsBlockGUI.php.

References ilBlockGUI\$data, $ilUser, ilBlockGUI\$user, ilNewsItem\_getNewsItemsOfUser(), and ilNewsItem\_lookupUserPDPeriod().

Referenced by __construct().

    {
        $ilUser = $this->user;

        include_once("./Services/News/classes/class.ilNewsCache.php");
        $this->acache = new ilNewsCache();
        
        $per = ilNewsItem::_lookupUserPDPeriod($ilUser->getId());
        $data = ilNewsItem::_getNewsItemsOfUser(
            $ilUser->getId(),
            false,
            false,
            $per
        );

        $this->acache->storeEntry(
            $ilUser->getId() . ":0",
            serialize($data)
        );

        return $data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getScreenMode()

static ilPDNewsBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Definition at line 134 of file class.ilPDNewsBlockGUI.php.

References $_GET, $_POST, $DIC, $ilCtrl, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

    {
        global $DIC;

        $ilCtrl = $DIC->ctrl();
        
        $cmd = $_GET["cmd"];
        if ($cmd == "post" && is_array($_POST["cmd"])) {
            $cmd = array_pop(array_keys($_POST["cmd"]));
        }
        
        switch ($cmd) {
            case "showNews":
            case "showFeedUrl":
            case "editSettings":
            case "changeFeedSettings":
                return IL_SCREEN_CENTER;
            
            default:
                return IL_SCREEN_SIDE;
        }
    }

initPrivateSettingsForm()

ilPDNewsBlockGUI::initPrivateSettingsForm ( )

protected

Definition at line 447 of file class.ilPDNewsBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$user, ilUtil\getPasswordRequirementsInfo(), ilCheckboxInputGUI\setChecked(), and ilFormPropertyGUI\setRequired().

Referenced by changeFeedSettings(), and editSettings().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
        
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $feed_form = new ilPropertyFormGUI();
        $feed_form->setFormAction($ilCtrl->getFormaction($this));
        $feed_form->setTitle($lng->txt("priv_feed_settings"));

        $feed_form->setTableWidth("100%");

        $enable_private_feed = new ilCheckboxInputGUI($lng->txt("news_enable_private_feed"), "enable_private_feed");
        $enable_private_feed->setChecked($ilUser->_getFeedPass($ilUser->getId()));
        $feed_form->addItem($enable_private_feed);

        $passwd = new ilPasswordInputGUI($lng->txt("password"), "desired_password");
        $passwd->setRequired(true);
        $passwd->setInfo(ilUtil::getPasswordRequirementsInfo());
        $enable_private_feed->addSubItem($passwd);

        $feed_form->addCommandButton("changeFeedSettings", $lng->txt("save"));
        $feed_form->addCommandButton("cancelSettings", $lng->txt("cancel"));
        
        return $feed_form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isRepositoryObject()

ilPDNewsBlockGUI::isRepositoryObject ( )

protected

Definition at line 126 of file class.ilPDNewsBlockGUI.php.

                                            : bool
    {
        return false;
    }

saveSettings()

ilPDNewsBlockGUI::saveSettings

(

)

Save settings.

Definition at line 488 of file class.ilPDNewsBlockGUI.php.

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

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        
        $news_set = new ilSetting("news");
        $enable_internal_rss = $news_set->get("enable_rss_for_internal");
        
        ilBlockSetting::_write(
            $this->getBlockType(),
            "news_pd_period",
            $_POST["news_pd_period"],
            $ilUser->getId(),
            $this->block_id
        );
        
        include_once("./Services/News/classes/class.ilNewsCache.php");
        $cache = new ilNewsCache();
        $cache->deleteEntry($ilUser->getId() . ":0");
            
        $ilCtrl->returnToParent($this);
    }

Here is the call graph for this function:

showFeedUrl()

ilPDNewsBlockGUI::showFeedUrl

(

)

Show feed URL.

Definition at line 269 of file class.ilPDNewsBlockGUI.php.

References ilBlockGUI\$ctrl, $GLOBALS, $ilCtrl, $ilSetting, $ilUser, ilBlockGUI\$lng, ilNewsForContextBlockGUI\$settings, ilBlockGUI\$tpl, ilBlockGUI\$user, and ilObjUser\_lookupFeedHash().

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

        $news_set = new ilSetting("news");
        
        
        include_once("./Services/News/classes/class.ilNewsItem.php");

        if ($news_set->get("enable_private_feed")) {
            $tpl = new ilTemplate("tpl.show_priv_feed_url.html", true, true, "Services/News");

            $tpl->setVariable("TXT_PRIV_TITLE", $lng->txt("news_get_priv_feed_title"));
            
            // #14365
            if ($ilUser->_getFeedPass($GLOBALS['DIC']['ilUser']->getId())) {
                $tpl->setVariable("TXT_PRIV_INFO", $lng->txt("news_get_priv_feed_info"));
                $tpl->setVariable("TXT_PRIV_FEED_URL", $lng->txt("news_feed_url"));
                $tpl->setVariable(
                    "VAL_PRIV_FEED_URL",
                    str_replace("://", "://" . $ilUser->getLogin() . ":-password-@", ILIAS_HTTP_PATH) . "/privfeed.php?client_id=" . rawurlencode(CLIENT_ID) . "&user_id=" . $ilUser->getId() .
                        "&hash=" . ilObjUser::_lookupFeedHash($ilUser->getId(), true)
                );
                $tpl->setVariable(
                    "VAL_PRIV_FEED_URL_TXT",
                    str_replace("://", "://" . $ilUser->getLogin() . ":-password-@", ILIAS_HTTP_PATH) . "/privfeed.php?client_id=" . rawurlencode(CLIENT_ID) . "&<br />user_id=" . $ilUser->getId() .
                        "&hash=" . ilObjUser::_lookupFeedHash($ilUser->getId(), true)
                );
            } else {
                $tpl->setVariable("TXT_PRIV_INFO", $lng->txt("news_inactive_private_feed_info"));
                $tpl->setVariable("EDIT_SETTINGS_URL", $ilCtrl->getLinkTarget($this, "editSettings"));
                $tpl->setVariable("EDIT_SETTINGS_TXT", $lng->txt("news_edit_news_settings"));
            }
        } else {
            $tpl = new ilTemplate("tpl.show_feed_url.html", true, true, "Services/News");
        }
        $tpl->setVariable("TXT_TITLE", $lng->txt("news_get_feed_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() .
                "&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() .
                "&hash=" . ilObjUser::_lookupFeedHash($ilUser->getId(), true)
        );
        
        include_once("./Services/PersonalDesktop/classes/class.ilPDContentBlockGUI.php");
        $content_block = new ilPDContentBlockGUI();
        $content_block->setContent($tpl->get());
        $content_block->setTitle($lng->txt("news_internal_news"));
        $content_block->addHeaderCommand(
            $ilCtrl->getParentReturn($this),
            $lng->txt("selected_items_back")
        );

        return $content_block->getHTML();
    }

Here is the call graph for this function:

showNews()

ilPDNewsBlockGUI::showNews

(

)

show news

Definition at line 349 of file class.ilPDNewsBlockGUI.php.

    {
        // workaround for dynamic mode (if cache is disabled, showNews has no data)
        //              if (empty(self::$st_data))
        //              {
        //                      $this->setData($this->getNewsData());
        //              }

        return parent::showNews();
    }

Field Documentation

$acc_results

ilPDNewsBlockGUI::$acc_results = false

protected

Definition at line 20 of file class.ilPDNewsBlockGUI.php.

$block_type

ilPDNewsBlockGUI::$block_type = "pdnews"

static

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

$st_data

ilPDNewsBlockGUI::$st_data

static

Definition at line 19 of file class.ilPDNewsBlockGUI.php.

---

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

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