BlockGUI class for block NewsForContext. More...

Inheritance diagram for ilPDNewsBlockGUI:

Collaboration diagram for ilPDNewsBlockGUI:

Public Member Functions
	ilPDNewsBlockGUI ()
	Constructor.
	getNewsData ()
	Get news for context.
&	executeCommand ()
	execute command
	fillDataSection ()
	Fill data section.
	getHTML ()
	Get bloch HTML code.
	showFeedUrl ()
	Show feed URL.
	addCloseCommand ($a_content_block)
	getDynamic ()
	getDynamicReload ()
	getJSEnabler ()
	disableJS ()
	enableJS ()
	showNews ()
	show news
	editSettings ()
	Show settings screen.
	cancelSettings ()
	Cancel settings.
	saveSettings ()
	Save settings.
Static Public Member Functions
static	getBlockType ()
	Get block type.
static	isRepositoryObject ()
	Is block used in repository object?
static	getScreenMode ()
	Get Screen Mode for current command.
Static Public Attributes
static	$block_type = "pdnews"
static	$st_data

Detailed Description

BlockGUI class for block NewsForContext.

Author:: Alex Killing <alex.killing@gmx.de>

Version:

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

ilPDNewsBlockGUI: ilColumnGUI

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

Member Function Documentation

ilPDNewsBlockGUI::addCloseCommand ( $ a_content_block )

Reimplemented from ilNewsForContextBlockGUI.

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

References $ilCtrl, and $lng.

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

ilPDNewsBlockGUI::cancelSettings ( )

Cancel settings.

Reimplemented from ilNewsForContextBlockGUI.

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

References $ilCtrl.

        {
                global $ilCtrl;
                
                $ilCtrl->returnToParent($this);
        }

ilPDNewsBlockGUI::disableJS ( )

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

References $_SESSION, and $ilCtrl.

        {
                global $ilCtrl, $ilUser;
                
                $_SESSION["il_feed_js"] = "n";
                $ilUser->writePref("il_feed_js", "n");
                $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
        }

ilPDNewsBlockGUI::editSettings ( )

Show settings screen.

Reimplemented from ilNewsForContextBlockGUI.

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

References $ilCtrl, $ilSetting, $lng, ilNewsItem::_lookupDefaultPDPeriod(), ilNewsItem::_lookupUserPDPeriod(), and ilUtil::getImagePath().

        {
                global $ilUser, $lng, $ilCtrl, $ilSetting;
                
                $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");

                include_once("./Services/News/classes/class.ilNewsItem.php");
                $default_per = ilNewsItem::_lookupDefaultPDPeriod();
                $per = ilNewsItem::_lookupUserPDPeriod($ilUser->getId());
                        
                include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setTitle($lng->txt("news_settings"));
                $form->setTitleIcon(ilUtil::getImagePath("icon_news.gif"));
                
                $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"));
                $form->setFormAction($ilCtrl->getFormaction($this));
                
                return $form->getHTML();
        }

Here is the call graph for this function:

ilPDNewsBlockGUI::enableJS ( )

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

References $_SESSION, exit, and getHTML().

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

Here is the call graph for this function:

& ilPDNewsBlockGUI::executeCommand ( )

execute command

Reimplemented from ilNewsForContextBlockGUI.

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

References $cmd, and $ilCtrl.

        {
                global $ilCtrl;

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

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

ilPDNewsBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilNewsForContextBlockGUI.

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

References $ilBench, ilBlockGUI::getCurrentDetailLevel(), ilBlockGUI::getData(), getDynamicReload(), ilNewsForContextBlockGUI::getOverview(), ilBlockGUI::setDataSection(), ilBlockGUI::setEnableDetailRow(), and ilBlockGUI::setEnableNumInfo().

        {
                global $ilBench;
                
                if ($this->dynamic)
                {
                        $this->setDataSection($this->getDynamicReload());
                }
                else if ($this->getCurrentDetailLevel() > 1 && count($this->getData()) > 0)
                {
                        $ilBench->start("News", "ilPDNewsBlockGUI_fillDataSection");
                        parent::fillDataSection();
                        $ilBench->stop("News", "ilPDNewsBlockGUI_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:

static ilPDNewsBlockGUI::getBlockType ( ) [static]

Get block type.

Returns:: string Block type.

Reimplemented from ilNewsForContextBlockGUI.

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

Referenced by saveSettings().

        {
                return self::$block_type;
        }

Here is the caller graph for this function:

ilPDNewsBlockGUI::getDynamic ( )

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

References $_SESSION, and $ilCtrl.

Referenced by ilPDNewsBlockGUI().

        {
                global $ilCtrl, $ilUser;
                
                if ($ilCtrl->getCmd() == "hideNotifications" ||
                        $ilCtrl->getCmd() == "showNotifications")
                {
                        return false;
                }
                
                if ($ilCtrl->getCmdClass() != "ilcolumngui" && $ilCtrl->getCmd() != "enableJS")
                {
                        if ($_SESSION["il_feed_js"] != "n" &&
                                ($ilUser->getPref("il_feed_js") != "n" || $_SESSION["il_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:

ilPDNewsBlockGUI::getDynamicReload ( )

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

References $ilCtrl, $lng, and ilBlockGUI::getBlockId().

Referenced by fillDataSection().

        {
                global $ilCtrl, $lng;
                
                $ilCtrl->setParameterByClass("ilcolumngui", "block_id",
                        "block_pdnews_".$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_pdnews_".$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("ilpdnewsblockgui", "disableJS"));

                return $rel_tpl->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilPDNewsBlockGUI::getHTML ( )

Get bloch HTML code.

Reimplemented from ilNewsForContextBlockGUI.

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

References $ilCtrl, $lng, ilNewsItem::_lookupUserPDPeriod(), ilBlockGUI::addBlockCommand(), ilBlockGUI::getCurrentDetailLevel(), ilUtil::getImagePath(), ilBlockGUI::getTitle(), ilBlockGUI::setFooterInfo(), and ilBlockGUI::setTitle().

Referenced by enableJS().

        {
                global $ilCtrl, $lng, $ilUser;
                
                // 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");
                
                // subscribe/unsibscribe link
                include_once("./Services/News/classes/class.ilNewsSubscription.php");
                
                // show feed url
                if ($enable_internal_rss)
                {
                        $this->addBlockCommand(
                                $ilCtrl->getLinkTarget($this, "showFeedUrl"),
                                $lng->txt("news_get_feed_url"), "", ilUtil::getImagePath("rss.gif"), true);
                }

                if ($allow_shorter_periods || $allow_longer_periods)
                {
                        $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 "";
                }

                return ilBlockGUI::getHTML();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilPDNewsBlockGUI::getJSEnabler ( )

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

References $ilCtrl, $lng, and ilBlockGUI::getBlockId().

        {
                global $ilCtrl, $lng;
                
                $ilCtrl->setParameterByClass("ilcolumngui", "block_id",
                        "block_pdnews_".$this->getBlockId());

                $rel_tpl = new ilTemplate("tpl.js_enabler.html", true, true, "Services/News");
                $rel_tpl->setVariable("BLOCK_ID", "block_pdnews_".$this->getBlockId());
                $rel_tpl->setVariable("TARGET", 
                        $ilCtrl->getLinkTargetByClass("ilpdnewsblockgui", "enableJS", true));
                        
                return $rel_tpl->get();
        }

Here is the call graph for this function:

ilPDNewsBlockGUI::getNewsData ( )

Get news for context.

Reimplemented from ilNewsForContextBlockGUI.

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

References ilBlockGUI::$data, ilNewsItem::_getNewsItemsOfUser(), and ilNewsItem::_lookupUserPDPeriod().

Referenced by ilPDNewsBlockGUI(), and showNews().

        {
                global $ilUser, $ilAccess;
                
                $per = ilNewsItem::_lookupUserPDPeriod($ilUser->getId());
                $data = ilNewsItem::_getNewsItemsOfUser($ilUser->getId(), false,
                        false, $per);
                if (!$this->acc_cache_hit)
                {
                        $ilAccess->storeCache();
                }
                return $data;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

static ilPDNewsBlockGUI::getScreenMode ( ) [static]

Get Screen Mode for current command.

Reimplemented from ilNewsForContextBlockGUI.

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

References $_GET, and $ilCtrl.

        {
                global $ilCtrl;
                
                switch($_GET["cmd"])
                {
                        case "showNews":
                        case "showFeedUrl":
                        case "editSettings":
                                return IL_SCREEN_CENTER;
                                break;
                        
                        default:
                                return IL_SCREEN_SIDE;
                                break;
                }
        }

ilPDNewsBlockGUI::ilPDNewsBlockGUI ( )

Constructor.

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

References ilBlockGUI::$data, $ilBench, $ilCtrl, $lng, ilBlockGUI::getCurrentDetailLevel(), getDynamic(), ilUtil::getImagePath(), getNewsData(), ilNewsForContextBlockGUI::handleView(), ilBlockGUI::ilBlockGUI(), ilBlockGUI::setAvailableDetailLevels(), ilBlockGUI::setData(), ilBlockGUI::setImage(), ilBlockGUI::setLimit(), ilBlockGUI::setRowTemplate(), and ilBlockGUI::setTitle().

        {
                global $ilCtrl, $lng, $ilUser, $ilBench, $ilAccess, $ilCtrl;
                
                $ilBench->start("News", "ilPDNewsBlockGUI_Constructor");
                $news_set = new ilSetting("news");
                
                parent::ilBlockGUI();
                
                $this->setImage(ilUtil::getImagePath("icon_news_s.gif"));

                $lng->loadLanguageModule("news");
                include_once("./Services/News/classes/class.ilNewsItem.php");

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

                $this->dynamic = false;
                
                // store current access check results
                $this->acc_results = $ilAccess->getResults();
                
                // read access cache
                $this->acc_cache_hit = $ilAccess->readCache(
                        ((int) $news_set->get("acc_cache_mins")) * 60);

                if ($this->getDynamic() && !$this->acc_cache_hit)
                {
                        $this->dynamic = true;
                        $data = array();
                }
                else if ($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);
                
                $ilBench->stop("News", "ilPDNewsBlockGUI_Constructor");
        }

Here is the call graph for this function:

static ilPDNewsBlockGUI::isRepositoryObject ( ) [static]

Is block used in repository object?

Returns:: string Block type.

Reimplemented from ilNewsForContextBlockGUI.

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

        {
                return false;
        }

ilPDNewsBlockGUI::saveSettings ( )

Save settings.

Reimplemented from ilNewsForContextBlockGUI.

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

References $ilCtrl, ilBlockSetting::_write(), and getBlockType().

        {
                global $ilCtrl, $ilUser;
                
                $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);
                        
                $ilCtrl->returnToParent($this);
        }

Here is the call graph for this function:

ilPDNewsBlockGUI::showFeedUrl ( )

Show feed URL.

Reimplemented from ilNewsForContextBlockGUI.

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

References $ilCtrl, $lng, $tpl, and ilUtil::getImagePath().

        {
                global $lng, $ilCtrl, $ilUser;
                
                include_once("./Services/News/classes/class.ilNewsItem.php");
                
                $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->setImage(ilUtil::getImagePath("icon_news.gif"));
                $content_block->addHeaderCommand($ilCtrl->getParentReturn($this),
                        $lng->txt("selected_items_back"));

                return $content_block->getHTML();
        }

Here is the call graph for this function:

ilPDNewsBlockGUI::showNews ( )

show news

Reimplemented from ilNewsForContextBlockGUI.

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

References getNewsData(), and ilBlockGUI::setData().

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

                return parent::showNews();
        }

Here is the call graph for this function: