ilPDNewsBlockGUI Class Reference

BlockGUI class for block NewsForContext. More...

Inheritance diagram for ilPDNewsBlockGUI:

Collaboration diagram for ilPDNewsBlockGUI:

Public Member Functions
	__construct ()
	getBlockType ()
	executeCommand ()
	getHTML ()
	showFeedUrl ()
	editSettings (?ilPropertyFormGUI $a_private_form=null)
	saveSettings ()
	changeFeedSettings ()
Public Member Functions inherited from ilNewsForContextBlockGUI
	__construct ()
	getBlockType ()
	executeCommand ()
	getHTML ()
	handleView ()
	Handles show/hide notification view and removes notifications if hidden. More...
	getOverview ()
	makeClickable (string $a_str)
	showNotifications ()
	hideNotifications ()
	editSettings ()
	Show settings screen. More...
	initSettingsForm ()
	Init setting form. More...
	cancelSettings ()
	saveSettings ()
	showFeedUrl ()
	getDynamicReload ()
	getJSEnabler ()
	disableJS ()
	enableJS ()
	getNoItemFoundContent ()
Public Member Functions inherited from ilBlockGUI
	__construct ()
	getBlockType ()
	setData (array $a_data)
	getData ()
	setPresentation (int $type)
	getPresentation ()
	setBlockId (string $a_block_id="0")
	getBlockId ()
	setGuiObject (object $a_gui_object)
	Set GuiObject. More...
	getGuiObject ()
	setTitle (string $a_title)
	getTitle ()
	setOffset (int $a_offset)
	getOffset ()
	checkOffset (int $offset)
	setLimit (int $a_limit)
	getLimit ()
	setEnableEdit (bool $a_enableedit)
	getEnableEdit ()
	setRepositoryMode (bool $a_repositorymode)
	getRepositoryMode ()
	setSubtitle (string $a_subtitle)
	getSubtitle ()
	setRefId (int $a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...
	getRefId ()
	setAdminCommands (bool $a_admincommands)
	getAdminCommands ()
	setEnableNumInfo (bool $a_enablenuminfo)
	getEnableNumInfo ()
	setProperties (array $a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
	getProperty (string $a_property)
	setProperty (string $a_property, string $a_value)
	setRowTemplate (string $a_rowtemplatename, string $a_rowtemplatedir="")
	Set Row Template Name. More...
	getNavParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	getRowTemplateDir ()
	addBlockCommand (string $a_href, string $a_text, string $a_onclick="", ?RoundTrip $modal=null)
	getBlockCommands ()
	getHTML ()
	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...
	getPaginationViewControl ()
	Fill previous/next row. More...
	getViewControlsForPanel ()
	sortObject ()
	addSortOption (string $option, string $label, bool $active)
	setSortTarget (string $target)
	addPresentation (string $label, string $target, bool $active)
	getNoItemFoundContent ()

Static Public Member Functions
static	getScreenMode ()
Static Public Member Functions inherited from ilNewsForContextBlockGUI
static	getScreenMode ()
static	addToSettingsForm (ilFormPropertyGUI $a_input)
	Add inputs to the container news settings form to configure also the contextBlock options. More...
static	writeSettings (array $a_values)
static	getScreenMode ()

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

Protected Member Functions
	initPrivateSettingsForm ()
Protected Member Functions inherited from ilNewsForContextBlockGUI
	initData (NewsCollection $collection)
	preloadData (array $data)
	Method will be called before rendering the block. More...
	getListItemForData (array $data)
	Get list item for data array. More...
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	getMediaPath (int $mob_id)
	downloadMob ()
Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	specialCharsAsEntities (string $string)
	initCommands ()
	preloadData (array $data)
	Can be overwritten in subclasses. More...
	getLegacyContent ()
	Get legacy content. 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...
	getActionsForPanel ()
	send (string $output)
	Send. More...

Private Member Functions
	loadNewsData ()

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...
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
const	PRES_MAIN_TILE = 4
Protected Attributes inherited from ilNewsForContextBlockGUI
NewsAccess	$news_access
bool	$dynamic = false
bool	$show_view_selection
string	$view
ilPropertyFormGUI	$settings_form
ilHelpGUI	$help
ilSetting	$settings
ilTabsGUI	$tabs
StandardGUIRequest	$std_request
InternalDomainService	$domain
InternalGUIService	$gui
bool	$prevent_initial_loading = false
NewsCollection	$collection
Protected Attributes inherited from ilBlockGUI
ILIAS UI Renderer	$renderer
Factory	$factory
object	$gui_object
ILIAS Container Block StandardGUIRequest	$request
ILIAS Container Block BlockManager	$block_manager
bool	$repositorymode = false
ILIAS DI UIServices	$ui
array	$data = array()
bool	$enablenuminfo = true
array	$footer_links = array()
string	$block_id = "0"
bool	$allow_moving = true
array	$move = array("left" => false, "right" => false, "up" => false, "down" => false)
array	$block_commands = array()
int	$max_count = 0
bool	$close_command = false
bool	$image = false
array	$property = []
string	$nav_value = ""
string	$css_row = ""
string	$title = ""
bool	$admincommands = false
array	$dropdown
ilTemplate	$tpl
ilGlobalTemplateInterface	$main_tpl
ilObjUser	$user
ilCtrl	$ctrl
ilAccessHandler	$access
ilLanguage	$lng
ilObjectDefinition	$obj_def
int	$presentation
int	$requested_ref_id

Detailed Description

BlockGUI class for block NewsForContext.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_IsCalledBy ilPDNewsBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

__construct()

ilPDNewsBlockGUI::__construct

(

)

Reimplemented from ilNewsForContextBlockGUI.

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

    {
        $this->prevent_initial_loading = true; // prevents loading in the parent constructor!
        parent::__construct();
 
        $this->dynamic = false;
        $this->setLimit(5);
        $this->setTitle($this->lng->txt("news_internal_news"));
        $this->setRowTemplate("tpl.block_row_news_for_context.html", "components/ILIAS/News");
 
        $this->loadNewsData();
        $this->handleView();
        $this->setPresentation(self::PRES_SEC_LIST);
    }

References ILIAS\GlobalScreen\Provider\__construct(), ilNewsForContextBlockGUI\handleView(), ILIAS\Repository\lng(), loadNewsData(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), ilBlockGUI\setRowTemplate(), and ilBlockGUI\setTitle().

Here is the call graph for this function:

Member Function Documentation

changeFeedSettings()

ilPDNewsBlockGUI::changeFeedSettings

(

)

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

                                        : string
    {
        $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("");
                $this->main_tpl->setOnScreenMessage('success', $lng->txt("priv_feed_disabled"), true);
                // $ilCtrl->returnToParent($this);
                $ilCtrl->redirect($this, "showFeedUrl");
            } else {
                $passwd = $form->getInput("desired_password");
                if (LocalUserPasswordManager::getInstance()->verifyPassword($ilUser, $passwd)) {
                    $form->getItemByPostVar("desired_password")->setAlert($lng->txt("passwd_equals_ilpasswd"));
                    $this->main_tpl->setOnScreenMessage('failure', $lng->txt("form_input_not_valid"));
                } else {
                    $ilUser->setFeedPass($passwd);
                    $this->main_tpl->setOnScreenMessage('success', $lng->txt("saved_successfully"), true);
                    $ilCtrl->redirect($this, "showFeedUrl");
                }
            }
        }
 
        $form->setValuesByPost();
        return $this->editSettings($form);
    }

References ilBlockGUI\$ctrl, ilBlockGUI\$lng, ilBlockGUI\$user, ilNewsForContextBlockGUI\editSettings(), initPrivateSettingsForm(), and ilLanguage\txt().

Here is the call graph for this function:

editSettings()

ilPDNewsBlockGUI::editSettings

(

?ilPropertyFormGUI

$a_private_form = null

)

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

                                                                           : string
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $returnForm = "";
 
        $news_set = new ilSetting("news");
        $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)) {
            $form = new ilPropertyFormGUI();
            $form->setFormAction($ilCtrl->getFormAction($this));
            $form->setTitle($lng->txt("news_settings"));
 
            $default_per = ilNewsItem::_lookupDefaultPDPeriod();
            $per = ilNewsItem::_lookupUserPDPeriod($ilUser->getId());
 
            $form->setTableWidth("100%");
 
            $per_opts = [
                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 = [];
            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->setOptions($per_opts);
            $per_sel->setValue((string) $per);
            $form->addItem($per_sel);
 
            $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;
    }

References ilBlockGUI\$ctrl, ilBlockGUI\$lng, ilBlockGUI\$user, ilNewsItem\_lookupDefaultPDPeriod(), ilNewsItem\_lookupUserPDPeriod(), initPrivateSettingsForm(), and ilLanguage\txt().

Here is the call graph for this function:

executeCommand()

ilPDNewsBlockGUI::executeCommand

(

)

Reimplemented from ilNewsForContextBlockGUI.

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

    {
        $cmd = $this->ctrl->getCmd();
        return $this->$cmd();
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

getBlockType()

ilPDNewsBlockGUI::getBlockType

(

)

Reimplemented from ilNewsForContextBlockGUI.

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

                                  : string
    {
        return self::$block_type;
    }

References $block_type.

Referenced by saveSettings().

Here is the caller graph for this function:

getHTML()

ilPDNewsBlockGUI::getHTML

(

)

Reimplemented from ilNewsForContextBlockGUI.

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

                             : string
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
 
        // @todo: find another solution for this
        //$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");
        // show feed url
        if ($enable_internal_rss) {
            // @todo: rss icon html ilRSSButtonGUI::get(ilRSSButtonGUI::ICON_RSS)
            $this->addBlockCommand(
                $ilCtrl->getLinkTarget($this, "showFeedUrl"),
                $lng->txt("news_get_feed_url")
            );
        }
 
        if ($allow_shorter_periods || $allow_longer_periods || $enable_private_feed) {
            $this->addBlockCommand(
                $ilCtrl->getLinkTarget($this, "editSettings"),
                $lng->txt("settings")
            );
        }
 
        $en = "";
        if ($ilUser->getPref("il_feed_js") === "n") {
            $en = $this->getJSEnabler();
        }
 
        return ilBlockGUI::getHTML() . $en;
    }

References ilBlockGUI\$ctrl, ilBlockGUI\$lng, ilBlockGUI\$user, ilBlockGUI\addBlockCommand(), ilBlockGUI\getHTML(), ilNewsForContextBlockGUI\getJSEnabler(), and ilLanguage\txt().

Here is the call graph for this function:

getScreenMode()

static ilPDNewsBlockGUI::getScreenMode ( )

static

Reimplemented from ilNewsForContextBlockGUI.

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

                                          : string
    {
        global $DIC;
 
        return match($DIC->ctrl()->getCmd()) {
            'showNews', 'showFeedUrl', 'editSettings', 'saveSettings', 'changeFeedSettings' => IL_SCREEN_CENTER,
            default => IL_SCREEN_SIDE
        };
    }

References $DIC, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

initPrivateSettingsForm()

ilPDNewsBlockGUI::initPrivateSettingsForm ( )

protected

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

                                                : ilPropertyFormGUI
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
 
        $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((bool) ilObjUser::_getFeedPass($ilUser->getId()));
        $feed_form->addItem($enable_private_feed);
 
        $passwd = new ilPasswordInputGUI($lng->txt("password"), "desired_password");
        $passwd->setRequired(true);
        $passwd->setInfo(ilSecuritySettingsChecker::getPasswordRequirementsInfo());
        $enable_private_feed->addSubItem($passwd);
 
        $feed_form->addCommandButton("changeFeedSettings", $lng->txt("save"));
        $feed_form->addCommandButton("cancelSettings", $lng->txt("cancel"));
 
        return $feed_form;
    }

References ilBlockGUI\$ctrl, ilBlockGUI\$lng, ilBlockGUI\$user, ilObjUser\_getFeedPass(), ilSecuritySettingsChecker\getPasswordRequirementsInfo(), and ilLanguage\txt().

Referenced by changeFeedSettings(), and editSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

loadNewsData()

ilPDNewsBlockGUI::loadNewsData ( )

private

Reimplemented from ilNewsForContextBlockGUI.

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

                                   : void
    {
        $news_period = ilNewsItem::_lookupUserPDPeriod($this->user->getId());
        $collection = $this->domain->collection()->getNewsForUser(
            $this->user,
            new NewsCriteria(period: $news_period, only_public: false),
            true
        );
        $this->initData($collection->groupFiles()->groupForums(false));
    }

References ilNewsForContextBlockGUI\$collection, ilNewsItem\_lookupUserPDPeriod(), ilNewsForContextBlockGUI\initData(), and ILIAS\Repository\user().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

saveSettings()

ilPDNewsBlockGUI::saveSettings

(

)

Reimplemented from ilNewsForContextBlockGUI.

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

                                  : string
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        $news_set = new ilSetting("news");
 
        ilBlockSetting::_write(
            $this->getBlockType(),
            "news_pd_period",
            $this->std_request->getDashboardPeriod(),
            $ilUser->getId(),
            0
        );
 
        $this->domain->collection()->invalidateCache($this->user->getId());
 
        $ilCtrl->returnToParent($this);
        return "";
    }

References ilBlockGUI\$ctrl, ilBlockGUI\$user, ilBlockSetting\_write(), getBlockType(), and ILIAS\Repository\user().

Here is the call graph for this function:

showFeedUrl()

ilPDNewsBlockGUI::showFeedUrl

(

)

Reimplemented from ilNewsForContextBlockGUI.

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

                                 : string
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        $news_set = new ilSetting("news");
 
        if ($news_set->get("enable_private_feed")) {
            $tpl = new ilTemplate("tpl.show_priv_feed_url.html", true, true, "components/ILIAS/News");
 
            $tpl->setVariable("TXT_PRIV_TITLE", $lng->txt("news_get_priv_feed_title"));
 
            // #14365
            if (ilObjUser::_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, "components/ILIAS/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)
        );
 
 
        $panel = $this->ui->factory()->panel()->standard(
            $lng->txt("news_internal_news"),
            $this->ui->factory()->legacy()->content($tpl->get())
        );
 
        return $this->ui->renderer()->render($panel);
    }

References ilBlockGUI\$ctrl, $GLOBALS, ilBlockGUI\$lng, ilBlockGUI\$tpl, ilBlockGUI\$user, ilObjUser\_getFeedPass(), ilObjUser\_lookupFeedHash(), CLIENT_ID, ilTemplate\get(), ILIAS\Survey\Mode\getId(), HTML_Template_IT\setVariable(), ilLanguage\txt(), and ILIAS\Repository\ui().

Here is the call graph for this function:

Field Documentation

$block_type

string ilPDNewsBlockGUI::$block_type = "pdnews"

static

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

Referenced by getBlockType().

---

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

• components/ILIAS/News/classes/class.ilPDNewsBlockGUI.php