BlockGUI class for block NewsForContext. More...

Inheritance diagram for ilNewsForContextBlockGUI:

Collaboration diagram for ilNewsForContextBlockGUI:

Public Member Functions
	__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	addToSettingsForm (ilFormPropertyGUI $a_input, string $public_feed_info)
	Add inputs to the container news settings form to configure also the contextBlock options. More...

static	writeSettings (array $a_values)

static	getScreenMode ()

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

const	PRES_MAIN_TILE = 4

Static Public Attributes
static string	$block_type = "news"

Protected Member Functions
	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...

Protected Attributes
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

ilLogger	$logger

ILIAS Refinery Factory	$refinery

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

Private Member Functions
	loadNewsData ()

	getNewsForId (int $news_id)

Detailed Description

BlockGUI class for block NewsForContext.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_IsCalledBy ilNewsForContextBlockGUI: ilColumnGUI @ilCtrl_Calls ilNewsForContextBlockGUI: ilNewsItemGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilNewsForContextBlockGUI::__construct ( )

Reimplemented from ilBlockGUI.

Reimplemented in ilPDNewsBlockGUI.

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

    {
        global $DIC;
 
        parent::__construct();
 
        $this->logger = $DIC->logger()->news();
        $this->help = $DIC["ilHelp"];
        $this->settings = $DIC->settings();
        $this->tabs = $DIC->tabs();
        $this->logger = $DIC->logger()->news();
        $this->refinery = $DIC->refinery();
 
        $locator = $DIC->news()->internal();
        $this->std_request = $locator->gui()->standardRequest();
        $this->domain = $locator->domain();
        $this->gui = $locator->gui();
        $this->news_access = new NewsAccess($this->std_request->getRefId());
 
        $this->lng->loadLanguageModule("news");
        $DIC->help()->addHelpSection("news_block");
 
        $this->setBlockId((string) $this->ctrl->getContextObjId());
        $this->setLimit(5);
        $this->setEnableNumInfo(true);
 
        if (!$this->prevent_initial_loading) {
            $this->loadNewsData();
        }
 
        $this->setTitle($this->lng->txt("news_internal_news"));
        $this->setRowTemplate("tpl.block_row_news_for_context.html", "components/ILIAS/News");
        $this->allow_moving = false;
        $this->handleView();
 
        $this->setPresentation(self::PRES_SEC_LIST);
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), handleView(), ILIAS\Repository\help(), ILIAS\Repository\lng(), loadNewsData(), ILIAS\Repository\logger(), ILIAS\Repository\refinery(), ilBlockGUI\setBlockId(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), ilBlockGUI\setRowTemplate(), ILIAS\Repository\settings(), ilBlockGUI\setTitle(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

Member Function Documentation

◆ addToSettingsForm()

static ilNewsForContextBlockGUI::addToSettingsForm	(	ilFormPropertyGUI	$a_input,
		string	$public_feed_info
	)

static

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

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

     : void {
        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_feed = ilBlockSetting::_lookup(
            self::$block_type,
            "public_feed",
            0,
            $block_id
        );
 
        // extra rss feed
        if ($enable_internal_rss) {
            $radio_rss = new ilCheckboxInputGUI(
                $lng->txt("news_public_feed"),
                "notifications_public_feed"
            );
            $radio_rss->setInfo($lng->txt($public_feed_info));
            $radio_rss->setChecked((bool) $public_feed);
            $a_input->addSubItem($radio_rss);
        }
    }

Referenced by ilContainerNewsSettingsGUI\initForm().

Here is the caller graph for this function:

◆ cancelSettings()

ilNewsForContextBlockGUI::cancelSettings ( )

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

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

◆ disableJS()

ilNewsForContextBlockGUI::disableJS ( )

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

                               : void
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        ilSession::set("il_feed_js", "n");
        $ilUser->writePref("il_feed_js", "n");
        $ilCtrl->returnToParent($this);
    }

References ilSession\set().

Here is the call graph for this function:

◆ downloadMob()

ilNewsForContextBlockGUI::downloadMob ( )

protected

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

                                    : void
    {
        $news_id = $this->std_request->getNewsId();
        $news = new ilNewsItem($news_id);
        $news->deliverMobFile("Standard", true);
    }

◆ editSettings()

ilNewsForContextBlockGUI::editSettings ( )

Show settings screen.

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

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

References initSettingsForm().

Referenced by ilPDNewsBlockGUI\changeFeedSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableJS()

ilNewsForContextBlockGUI::enableJS ( )

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

                              : void
    {
        $ilUser = $this->user;
        ilSession::set("il_feed_js", "y");
        $ilUser->writePref("il_feed_js", "y");
        $this->send($this->getHTML());
    }

References send(), and ilSession\set().

Here is the call graph for this function:

◆ executeCommand()

ilNewsForContextBlockGUI::executeCommand ( )

Reimplemented in ilPDNewsBlockGUI.

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

    {
        if (strcasecmp($this->ctrl->getNextClass(), ilNewsItemGUI::class) === 0) {
            $news_item_gui = new ilNewsItemGUI();
            $news_item_gui->setEnableEdit($this->getEnableEdit());
            return $this->ctrl->forwardCommand($news_item_gui);
        }
 
        $cmd = $this->ctrl->getCmd("getHTML");
        return $this->$cmd();
    }

References ILIAS\Repository\ctrl(), and ilBlockGUI\getEnableEdit().

Here is the call graph for this function:

◆ getBlockType()

ilNewsForContextBlockGUI::getBlockType ( )

Reimplemented from ilBlockGUI.

Reimplemented in ilPDNewsBlockGUI.

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

                                  : string
    {
        return self::$block_type;
    }

References $block_type.

Referenced by getHTML(), hideNotifications(), initSettingsForm(), and showNotifications().

Here is the caller graph for this function:

◆ getDynamicReload()

ilNewsForContextBlockGUI::getDynamicReload ( )

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

                                      : string
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $ilCtrl->setParameterByClass(
            ilColumnGUI::class,
            "block_id",
            "block_" . $this->getBlockType() . "_" . $this->getBlockId()
        );
 
        $rel_tpl = new ilTemplate("tpl.dynamic_reload.html", true, true, "components/ILIAS/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::class, "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->getLinkTarget($this, "disableJS")
        );
 
        return $rel_tpl->get();
    }

References $lng.

◆ getHTML()

ilNewsForContextBlockGUI::getHTML ( )

Reimplemented from ilBlockGUI.

Reimplemented in ilPDNewsBlockGUI.

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

                             : string
    {
        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,
            (int) $this->block_id
        );
 
        if ($this->getProperty("title") != "") {
            $this->setTitle($this->getProperty("title"));
        }
 
        $public_feed = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "public_feed",
            0,
            (int) $this->block_id
        );
        if ($public_feed && $enable_internal_rss) {
            // @todo: rss icon HTML: ilRSSButtonGUI::get(ilRSSButtonGUI::ICON_RSS)
            $this->addBlockCommand(
                ILIAS_HTTP_PATH . "/feed.php?client_id=" . rawurlencode(CLIENT_ID) . "&" .
                    "ref_id=" . $this->std_request->getRefId(),
                $lng->txt("news_feed_url")
            );
        }
 
        // add edit commands
        if ($this->news_access->canAdd()) {
            $this->addBlockCommand(
                $ilCtrl->getLinkTargetByClass(ilNewsItemGUI::class, "editNews"),
                $lng->txt("edit")
            );
 
            $ilCtrl->setParameter($this, "add_mode", "block");
            $this->addBlockCommand(
                $ilCtrl->getLinkTargetByClass(ilNewsItemGUI::class, "createNewsItem"),
                $lng->txt("add")
            );
            $ilCtrl->setParameter($this, "add_mode", "");
        }
 
        if ($this->getProperty("settings")) {
            $ref_id = $this->std_request->getRefId();
            $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::class, "ref_id", $ref_id);
 
            if (in_array($obj_class, self::OBJECTS_WITH_NEWS_SUBTAB)) {
                $this->addBlockCommand(
                    $ilCtrl->getLinkTargetByClass([ilRepositoryGUI::class, $parent_gui, ilContainerNewsSettingsGUI::class], "show"),
                    $lng->txt("settings")
                );
            } else {
                // not sure if this code is still used anywhere, see discussion at
                // https://mantis.ilias.de/view.php?id=31801
                // If ILIAS 8 beta phase does not throw this exception, we can remove this part.
                //throw new ilException("News settings are deprecated.");
                // the info screen will call this
                $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,
                (int) $this->block_id
            )) {
            return "";
        }
 
        // do not display empty news blocks for users
        // who do not have write permission
        if (!$this->dynamic && !$this->getEnableEdit() && $this->getRepositoryMode() && count($this->getData()) === 0 &&
            (
                !$news_set->get("enable_rss_for_internal") ||
                !ilBlockSetting::_lookup(
                    $this->getBlockType(),
                    "public_feed",
                    0,
                    (int) $this->block_id
                )
            )) {
            return "";
        }
 
        $en = "";
 
        return parent::getHTML() . $en;
    }

References ilBlockGUI\$ctrl, $DIC, ilBlockGUI\$lng, ilBlockGUI\$obj_def, ilBlockGUI\$user, ilBlockSetting\_lookup(), ilObject\_lookupObjectId(), ilObject\_lookupType(), ilBlockGUI\addBlockCommand(), CLIENT_ID, getBlockType(), ilObjectDefinition\getClassName(), ilBlockGUI\getData(), ilBlockGUI\getEnableEdit(), ilBlockGUI\getProperty(), ilBlockGUI\getRepositoryMode(), ilBlockGUI\setTitle(), and ilLanguage\txt().

Referenced by hideNotifications(), and showNotifications().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getJSEnabler()

ilNewsForContextBlockGUI::getJSEnabler ( )

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

                                  : string
    {
        $ilCtrl = $this->ctrl;
 
        $ilCtrl->setParameterByClass(
            ilColumnGUI::class,
            "block_id",
            "block_" . $this->getBlockType() . "_" . $this->getBlockId()
        );
        //echo "hh";
        $rel_tpl = new ilTemplate("tpl.js_enabler.html", true, true, "components/ILIAS/News");
        $rel_tpl->setVariable("BLOCK_ID", "block_" . $this->getBlockType() . "_" . $this->getBlockId());
        $rel_tpl->setVariable(
            "TARGET",
            $ilCtrl->getLinkTarget($this, "enableJS", "", true, false)
        );
 
        return $rel_tpl->get();
    }

Referenced by ilPDNewsBlockGUI\getHTML().

Here is the caller graph for this function:

◆ getListItemForData()

ilNewsForContextBlockGUI::getListItemForData ( array $data )

protected

Get list item for data array.

Parameters

array $data

Returns: null|\ILIAS\UI\Component\Item\Item

Reimplemented from ilBlockGUI.

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

                                                      : ?\ILIAS\UI\Component\Item\Item
    {
        try {
            $info = $this->getNewsForId($data[0]);
        } catch (\Exception $e) {
            $this->logger->error($e->getMessage());
            return $this->ui->factory()->item()->standard($this->lng->txt('news_not_available'))
                ->withDescription($this->lng->txt('news_sorry_not_accessible_anymore'));
        }
 
        $item = $this->ui->factory()->item()->standard(
            $this->ui->factory()->link()->standard($info['news_title'] ?? '', $info['url'] ?? '')
        );
 
        $properties = [];
 
        if ($info['ref_id'] > 0) {
            $properties[$info['type_txt']] = $info['obj_title'];
        }
 
        $properties[$this->lng->txt('date')] = $info['creation_date'] ?? '';
 
        return $item->withProperties($properties);
    }

References Vendor\Package\$e, $info, getNewsForId(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ getMediaPath()

ilNewsForContextBlockGUI::getMediaPath ( int $mob_id )

protected

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

                                                : string
    {
        $media_path = "";
        if ($mob_id > 0) {
            $mob = new ilObjMediaObject($mob_id);
            $media_path = $mob->getStandardSrc();
        }
        return $media_path;
    }

◆ getNewsForId()

ilNewsForContextBlockGUI::getNewsForId ( int $news_id )

private

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

                                               : array
    {
        $item = $this->collection->getById($news_id);
        if ($item === null) {
            throw new \InvalidArgumentException("News item with id {$news_id} not found.");
        }
 
        $grouping = $this->collection->getGroupingFor($item);
 
        $creation_date = new ilDateTime($item->getCreationDate()->format('c'), IL_CAL_DATETIME);
        $title = ilStr::shortenWords(
            ilNewsItem::determineNewsTitle(
                $item->getContextObjType(),
                $item->getTitle(),
                $item->isContentIsLangVar(),
                $grouping ? $grouping['agg_ref_id'] : 0,
                $grouping ? $grouping['aggregation'] : [],
            )
        );
 
        $info = [
            'ref_id' => $item->getContextRefId(),
            'creation_date' => ilDatePresentation::formatDate($creation_date),
            'news_title' => $title,
        ];
 
        // title image type
        if ($item->getContextRefId() > 0) {
            $obj_id = $item->getContextObjId();
            $type = $item->getContextObjType();
 
            $lang_type = in_array($type, ['sahs', 'lm', 'htlm']) ? 'lres' : 'obj_' . $type;
 
            $type_txt = ($this->obj_def->isPlugin($item->getContextObjType()))
                ? ilObjectPlugin::lookupTxtById($item->getContextObjType(), $lang_type)
                : $this->lng->txt($lang_type);
 
            $info['type_txt'] = $type_txt;
            $info['type_icon'] = ilObject::_getIcon($obj_id, 'tiny', $type);
            $info['obj_title'] = ilStr::shortenWords(ilObject::_lookupTitle($obj_id));
            $info['user_read'] = $this->collection->isReadByUser($this->user->getId(), $news_id);
 
            $this->ctrl->setParameter($this, 'news_context', $item->getContextRefId());
        } else {
            $this->ctrl->setParameter($this, 'news_context', '');
        }
 
        $this->ctrl->setParameter($this, 'news_id', $item->getId());
        $info['url'] = $this->ctrl->getLinkTarget($this, 'showNews');
        $this->ctrl->clearParameters($this);
 
        return $info;
    }

References $info, ilBlockGUI\$title, ilObject\_getIcon(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), ilNewsItem\determineNewsTitle(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, ILIAS\Repository\lng(), ilObjectPlugin\lookupTxtById(), ilStr\shortenWords(), and ILIAS\Repository\user().

Referenced by getListItemForData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNoItemFoundContent()

ilNewsForContextBlockGUI::getNoItemFoundContent ( )

Reimplemented from ilBlockGUI.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getOverview()

ilNewsForContextBlockGUI::getOverview ( )

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

                                 : string
    {
        $lng = $this->lng;
 
        return '<div class="small">' . (count($this->getData())) . " " . $lng->txt("news_news_items") . "</div>";
    }

References ilBlockGUI\$lng, ilBlockGUI\getData(), and ilLanguage\txt().

Here is the call graph for this function:

◆ getScreenMode()

static ilNewsForContextBlockGUI::getScreenMode ( )

static

Reimplemented from ilBlockGUI.

Reimplemented in ilPDNewsBlockGUI.

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

                                          : string
    {
        global $DIC;
 
        $ilCtrl = $DIC->ctrl();
 
        if (strcasecmp($ilCtrl->getCmdClass(), ilNewsItemGUI::class) === 0) {
            return IL_SCREEN_FULL;
        }
 
        switch ($ilCtrl->getCmd()) {
            case "showNews":
            case "showFeedUrl":
                return IL_SCREEN_CENTER;
 
            case "editSettings":
            case "saveSettings":
                return IL_SCREEN_FULL;
 
            default:
                return IL_SCREEN_SIDE;
        }
    }

References $DIC, IL_SCREEN_CENTER, IL_SCREEN_FULL, and IL_SCREEN_SIDE.

◆ handleView()

ilNewsForContextBlockGUI::handleView ( )

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

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

                                : void
    {
        // it seems like this method does not change any state, so it may be removed in the future
 
        /*$ilUser = $this->user;
 
        $this->view = (string) ilBlockSetting::_lookup(
            $this->getBlockType(),
            "view",
            $ilUser->getId(),
            (int) $this->block_id
        );
 
        // check whether notices and messages exist
        $got_notices = $got_messages = false;
        foreach ($this->data as $row) {
            if ((int) ($row["priority"] ?? 0) === 0) {
                $got_notices = true;
            }
            if ((int) ($row["priority"] ?? 0) === 1) {
                $got_messages = true;
            }
        }
        $this->show_view_selection = false;
 
        if ($got_notices && $got_messages) {
            $this->show_view_selection = true;
        } elseif ($got_notices) {
            $this->view = "";
        }*/
    }

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

Here is the caller graph for this function:

◆ hideNotifications()

ilNewsForContextBlockGUI::hideNotifications ( )

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

                                       : void
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        ilBlockSetting::_write(
            $this->getBlockType(),
            "view",
            "hide_notifications",
            $ilUser->getId(),
            (int) $this->block_id
        );
 
        // reload data
        $this->loadNewsData();
        $this->handleView();
 
        if ($ilCtrl->isAsynch()) {
            $this->send($this->getHTML());
        }
 
        $ilCtrl->returnToParent($this);
    }

References ilBlockGUI\$ctrl, ilBlockGUI\$user, ilBlockSetting\_write(), getBlockType(), getHTML(), handleView(), loadNewsData(), and ilBlockGUI\send().

Here is the call graph for this function:

◆ initData()

ilNewsForContextBlockGUI::initData ( NewsCollection $collection )

protected

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

                                                           : void
    {
        $this->collection = $collection;
        $this->data = $collection->pluck('id', true);
    }

References $collection, and ILIAS\News\Data\NewsCollection\pluck().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSettingsForm()

ilNewsForContextBlockGUI::initSettingsForm ( )

Init setting form.

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

                                      : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $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,
            (int) $this->block_id
        );
        $public_feed = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "public_feed",
            0,
            (int) $this->block_id
        );
        $hide_block = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "hide_news_block",
            0,
            (int) $this->block_id
        );
        $hide_news_per_date = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "hide_news_per_date",
            0,
            (int) $this->block_id
        );
        $hide_news_date = ilBlockSetting::_lookup(
            $this->getBlockType(),
            "hide_news_date",
            0,
            (int) $this->block_id
        );
        if (is_string($hide_news_date) && $hide_news_date !== "") {
            $hide_news_date = explode(" ", $hide_news_date);
        }
 
        $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((bool) $hide_block);
            $this->settings_form->addItem($ch);
 
            $hnpd = new ilCheckboxInputGUI(
                $lng->txt("news_hide_news_per_date"),
                "hide_news_per_date"
            );
            $hnpd->setChecked((bool) $hide_news_per_date);
 
            $dt_prop = new ilDateTimeInputGUI(
                $lng->txt("news_hide_news_date"),
                "hide_news_date"
            );
            $dt_prop->setRequired(true);
            if (isset($hide_news_date[0], $hide_news_date[1])) {
                $dt_prop->setDate(new ilDateTime($hide_news_date[0] . " " . $hide_news_date[1], IL_CAL_DATETIME));
            }
            $dt_prop->setShowTime(true);
            $hnpd->addSubItem($dt_prop);
 
            $this->settings_form->addItem($hnpd);
        }
 
        // public notifications
        if ($enable_internal_rss && $this->getProperty("public_notifications_option")) {
            $ch = new ilCheckboxInputGUI(
                $lng->txt("news_notifications_public"),
                "notifications_public"
            );
            $ch->setInfo($lng->txt("news_notifications_public_info"));
            $ch->setChecked((bool) $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((bool) $public_feed);
            $this->settings_form->addItem($ch);
        }
 
        $this->settings_form->addCommandButton("saveSettings", $lng->txt("save"));
        $this->settings_form->addCommandButton("cancelSettings", $lng->txt("cancel"));
        $this->settings_form->setFormAction($ilCtrl->getFormAction($this));
    }

References ilBlockGUI\$ctrl, ilBlockGUI\$lng, $tabs, ilBlockSetting\_lookup(), ilTabsGUI\clearTargets(), getBlockType(), ilBlockGUI\getProperty(), IL_CAL_DATETIME, and ilLanguage\txt().

Referenced by editSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRepositoryObject()

ilNewsForContextBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Reimplemented from ilBlockGUI.

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

                                           : bool
    {
        return false;
    }

◆ loadNewsData()

ilNewsForContextBlockGUI::loadNewsData ( )

private

Reimplemented in ilPDNewsBlockGUI.

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

                                   : void
    {
        if ($this->std_request->getRefId() === 0) {
            $this->initData(new NewsCollection());
            return;
        }
 
        $collection = $this->domain->collection()->getNewsForContext(
            new NewsContext($this->std_request->getRefId(), $this->ctrl->getContextObjId(), $this->ctrl->getContextObjType()),
            new NewsCriteria(read_user_id: $this->user->getId()),
            $this->user->getId(),
            true
        );
 
        if ($this->ctrl->getContextObjType() !== 'frm') {
            $collection = $collection->groupForums(true);
        }
        $this->initData($collection->groupFiles());
    }

References $collection, ILIAS\Repository\ctrl(), ILIAS\News\Data\NewsCollection\getNewsForContext(), ILIAS\News\Data\NewsCollection\groupFiles(), ILIAS\News\Data\NewsCollection\groupForums(), initData(), and ILIAS\Repository\user().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeClickable()

ilNewsForContextBlockGUI::makeClickable ( string $a_str )

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

                                                : string
    {
        // 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);
    }

References ilUtil\makeClickable().

Here is the call graph for this function:

◆ preloadData()

ilNewsForContextBlockGUI::preloadData ( array $data )

protected

Method will be called before rendering the block.

It lazily loads the required news items.

Reimplemented from ilBlockGUI.

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

                                               : void
    {
        parent::preloadData($data);
        $this->collection->load(array_column($data, 0));
    }

References ilBlockGUI\$data.

◆ saveSettings()

ilNewsForContextBlockGUI::saveSettings ( )

Reimplemented in ilPDNewsBlockGUI.

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

                                  : string
    {
        $ilCtrl = $this->ctrl;
 
        $this->initSettingsForm();
        $form = $this->settings_form;
        if ($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",
                    $form->getInput("notifications_public"),
                    0,
                    (int) $this->block_id
                );
                ilBlockSetting::_write(
                    $this->getBlockType(),
                    "public_feed",
                    $form->getInput("notifications_public_feed"),
                    0,
                    (int) $this->block_id
                );
            }
 
            if ($this->getProperty("hide_news_block_option")) {
                ilBlockSetting::_write(
                    $this->getBlockType(),
                    "hide_news_block",
                    $form->getInput("hide_news_block"),
                    0,
                    (int) $this->block_id
                );
                ilBlockSetting::_write(
                    $this->getBlockType(),
                    "hide_news_per_date",
                    $form->getInput("hide_news_per_date"),
                    0,
                    (int) $this->block_id
                );
 
                // hide date
                $hd = $this->settings_form->getItemByPostVar("hide_news_date");
                $hide_date = $hd->getDate();
                if ($hide_date instanceof ilDateTime && $form->getInput("hide_news_per_date")) {
                    ilBlockSetting::_write(
                        $this->getBlockType(),
                        "hide_news_date",
                        $hide_date->get(IL_CAL_DATETIME),
                        0,
                        (int) $this->block_id
                    );
                } else {
                    ilBlockSetting::_write(
                        $this->getBlockType(),
                        "hide_news_date",
                        "",
                        0,
                        (int) $this->block_id
                    );
                }
            }
 
            $this->domain->collection()->invalidateCache($this->user->getId());
 
            $ilCtrl->returnToParent($this);
        } else {
            $this->settings_form->setValuesByPost();
            return $this->settings_form->getHTML();
        }
        return "";
    }

References ilBlockSetting\_write(), IL_CAL_DATETIME, and ILIAS\Repository\user().

Here is the call graph for this function:

◆ showFeedUrl()

ilNewsForContextBlockGUI::showFeedUrl ( )

Reimplemented in ilPDNewsBlockGUI.

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

                                 : string
    {
        $lng = $this->lng;
        $ilUser = $this->user;
 
        $title = ilObject::_lookupTitle((int) $this->block_id);
 
        $tpl = new ilTemplate("tpl.show_feed_url.html", true, true, "components/ILIAS/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)
        );
 
        $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 $lng, ILIAS\News\Common\Table\$tpl, ilObjUser\_lookupFeedHash(), ilObject\_lookupTitle(), CLIENT_ID, ILIAS\UICore\GlobalTemplate\get(), ILIAS\UICore\GlobalTemplate\setVariable(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ showNotifications()

ilNewsForContextBlockGUI::showNotifications ( )

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

                                       : void
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        ilBlockSetting::_write(
            $this->getBlockType(),
            "view",
            "",
            $ilUser->getId(),
            (int) $this->block_id
        );
 
        // reload data
        $this->loadNewsData();
        $this->handleView();
 
        if ($ilCtrl->isAsynch()) {
            $this->send($this->getHTML());
        }
 
        $ilCtrl->returnToParent($this);
    }

References ilBlockGUI\$ctrl, ilBlockGUI\$user, ilBlockSetting\_write(), getBlockType(), getHTML(), handleView(), loadNewsData(), and ilBlockGUI\send().

Here is the call graph for this function:

◆ writeSettings()

static ilNewsForContextBlockGUI::writeSettings ( array $a_values )

static

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

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