News settings for containers. More...

Collaboration diagram for ilContainerNewsSettingsGUI:

Public Member Functions
	__construct (ilObjectGUI $a_parent_gui)

	executeCommand ()

	show ()

	initForm ()

	save ()

	initDefaultOptions ()

	setTimeline (bool $a_value)

	getTimeline ()

	setCronNotifications (bool $a_value)

	getCronNotifications ()

	setHideByDate (bool $a_value)

	getHideByDate ()

	setPublicNotification (bool $a_value)

	getPublicNotification ()

	setNewsBlockForced (bool $a_value)

	setNewsBlockLabel (string $lang_key)

	setNewsBlockInfo (?string $lang_key)

	setPublicFeedInfo (string $lang_key)

	getNewsBlockForced ()

Protected Member Functions
	checkPermission (string $perm)

Protected Attributes
ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilSetting	$setting

ilAccessHandler	$access

ilTree	$tree

ilObjectGUI	$parent_gui

ilObject	$object

ilSetting	$news_settings

NewsPeriodInfo	$period_info

UIRenderer	$ui_renderer

UIFactory	$ui_factory

bool	$has_timeline = false

bool	$has_cron_notifications = false

bool	$has_hide_by_date = false

bool	$has_public_notification = false

bool	$has_block_forced = false

string	$news_block_label = 'news_news_block'

string	$news_block_info = 'obj_tool_setting_news_info'

string	$public_feed_info = 'news_public_feed_info_container'

Detailed Description

News settings for containers.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerNewsSettingsGUI::__construct ( ilObjectGUI $a_parent_gui )

Definition at line 51 of file class.ilContainerNewsSettingsGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule("news");
        $this->tpl = $DIC["tpl"];
        $this->setting = $DIC["ilSetting"];
        $this->access = $DIC->access();
        $this->tree = $DIC->repositoryTree();
        $this->parent_gui = $a_parent_gui;
        $this->object = $this->parent_gui->getObject();
        $this->news_settings = new ilSetting('news');
        $this->period_info = new NewsPeriodInfo($this->lng, $this->news_settings);
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->ui_factory = $DIC->ui()->factory();
 
        $this->initDefaultOptions();
    }

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObjectGUI\getObject(), initDefaultOptions(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ checkPermission()

ilContainerNewsSettingsGUI::checkPermission ( string $perm )

protected

Definition at line 86 of file class.ilContainerNewsSettingsGUI.php.

                                                    : void
    {
        if ($this->access->checkAccess($perm, '', $this->object->getRefId())) {
            return;
        }
 
        $this->tpl->setOnScreenMessage(
            ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
            $this->lng->txt('msg_no_perm_read'),
            true
        );
        $parent_ref_id = $this->tree->getParentId($this->object->getRefId());
        $this->ctrl->redirectToURL($parent_ref_id > 0 ? ilLink::_getLink($parent_ref_id) : 'login.php?cmd=force_login');
    }

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, and ILIAS\Repository\object().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilContainerNewsSettingsGUI::executeCommand ( )

Definition at line 72 of file class.ilContainerNewsSettingsGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("show");
 
        switch ($next_class) {
            default:
                if (in_array($cmd, ["show", "save"])) {
                    $this->checkPermission('write');
                    $this->$cmd();
                }
        }
    }

References checkPermission(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getCronNotifications()

ilContainerNewsSettingsGUI::getCronNotifications ( )

Definition at line 353 of file class.ilContainerNewsSettingsGUI.php.

                                          : bool
    {
        return $this->has_cron_notifications;
    }

References $has_cron_notifications.

◆ getHideByDate()

ilContainerNewsSettingsGUI::getHideByDate ( )

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

                                   : bool
    {
        return $this->has_hide_by_date;
    }

References $has_hide_by_date.

◆ getNewsBlockForced()

ilContainerNewsSettingsGUI::getNewsBlockForced ( )

Definition at line 399 of file class.ilContainerNewsSettingsGUI.php.

                                        : bool
    {
        return $this->has_block_forced;
    }

References $has_block_forced.

◆ getPublicNotification()

ilContainerNewsSettingsGUI::getPublicNotification ( )

Definition at line 373 of file class.ilContainerNewsSettingsGUI.php.

                                           : bool
    {
        return $this->has_public_notification;
    }

References $has_public_notification.

◆ getTimeline()

ilContainerNewsSettingsGUI::getTimeline ( )

Definition at line 343 of file class.ilContainerNewsSettingsGUI.php.

                                 : bool
    {
        return $this->has_timeline;
    }

References $has_timeline.

◆ initDefaultOptions()

ilContainerNewsSettingsGUI::initDefaultOptions ( )

Definition at line 330 of file class.ilContainerNewsSettingsGUI.php.

                                        : void
    {
        $this->has_timeline = false;
        $this->has_cron_notifications = false;
        $this->has_hide_by_date = false;
        $this->has_block_forced = false;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ initForm()

ilContainerNewsSettingsGUI::initForm ( )

Definition at line 107 of file class.ilContainerNewsSettingsGUI.php.

                              : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        //from crs/grp/cat settings - additional feature - news
 
        if ($this->setting->get('block_activated_news')) {
            $news = new ilCheckboxInputGUI(
                $this->lng->txt($this->news_block_label),
                ilObjectServiceSettingsGUI::NEWS_VISIBILITY
            );
            $news->setValue('1');
            if ($this->has_block_forced) {
                $news->setChecked(true);
                $news->setDisabled(true);
            } else {
                $news->setChecked($this->object->getNewsBlockActivated());
            }
            if ($this->news_block_info !== null) {
                $news->setInfo($this->lng->txt($this->news_block_info));
            }
            ilNewsForContextBlockGUI::addToSettingsForm($news, $this->public_feed_info);
            $form->addItem($news);
        }
 
        // Timeline (courses and groups)
        if ($this->has_timeline) {
            // timeline
            $cb = new ilCheckboxInputGUI($this->lng->txt("cont_news_timeline"), "news_timeline");
            $cb->setInfo($this->lng->txt("cont_news_timeline_info"));
            $cb->setChecked($this->object->getNewsTimeline());
            $form->addItem($cb);
 
            // ...timeline: auto entries
            $cb2 = new ilCheckboxInputGUI($this->lng->txt("cont_news_timeline_auto_entries"), "news_timeline_auto_entries");
            $cb2->setInfo($this->lng->txt("cont_news_timeline_auto_entries_info"));
            $cb2->setChecked($this->object->getNewsTimelineAutoEntries());
            $cb->addSubItem($cb2);
 
            // ...timeline: landing page
            $cb2 = new ilCheckboxInputGUI($this->lng->txt("cont_news_timeline_landing_page"), "news_timeline_landing_page");
            $cb2->setInfo($this->lng->txt("cont_news_timeline_landing_page_info"));
            $cb2->setChecked($this->object->getNewsTimelineLandingPage());
            $cb->addSubItem($cb2);
        }
 
        // Cron Notifications (courses and groups)
        if ($this->has_cron_notifications && in_array(ilObject::_lookupType($this->object->getId()), ['crs', 'grp'])) {
            $ref_ids = ilObject::_getAllReferences($this->object->getId());
            $ref_id = array_pop($ref_ids);
            ilMembershipNotifications::addToSettingsForm($ref_id, $form, null);
        }
 
        $block_id = $this->ctrl->getContextObjId();
 
        $hide_news_per_date = ilBlockSetting::_lookup(
            ilNewsForContextBlockGUI::$block_type,
            "hide_news_per_date",
            0,
            $block_id
        );
        $hide_news_date = ilBlockSetting::_lookup(
            ilNewsForContextBlockGUI::$block_type,
            "hide_news_date",
            0,
            $block_id
        );
        $hide_news_mode = ilBlockSetting::_lookup(
            ilNewsForContextBlockGUI::$block_type,
            "hide_news_mode",
            0,
            $block_id
        ) ?? ((is_string($hide_news_date) && $hide_news_date !== "") ? "per_date" : "global");
        $news_co_period = ilBlockSetting::_lookup(
            ilNewsForContextBlockGUI::$block_type,
            "news_co_period",
            0,
            $block_id
        ) ?? "";
 
        if (is_string($hide_news_date) && $hide_news_date !== "") {
            $hide_news_date = explode(" ", $hide_news_date);
        }
 
        // Hide news: none, per date, or by period (courses, groups and categories)
        if ($this->has_hide_by_date) {
            $radio = new ilRadioGroupInputGUI($this->lng->txt("news_hide_news_mode"), "hide_news_mode");
            $radio->setInfo(
                $this->ui_renderer->render(
                    $this->ui_factory->messageBox()->info(
                        $this->period_info->getPeriodInfo()
                    )
                )
            );
            $radio->setValue($hide_news_mode);
 
            $opt_global = new ilRadioOption($this->lng->txt("news_hide_news_global"), "global");
            $radio->addOption($opt_global);
 
            $opt_none = new ilRadioOption($this->lng->txt("news_hide_news_none"), "none");
            $radio->addOption($opt_none);
 
            $opt_per_date = new ilRadioOption($this->lng->txt("news_hide_news_per_date"), "per_date");
            $dt_prop = new ilDateTimeInputGUI($this->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);
            $opt_per_date->addSubItem($dt_prop);
            $radio->addOption($opt_per_date);
 
            $opt_by_period = new ilRadioOption($this->lng->txt("news_hide_news_by_period"), "by_period");
            $per_sel = new ilSelectInputGUI($this->lng->txt("news_co_period"), "news_co_period");
            $per_sel->setRequired(true);
            $per_sel->setInfo($this->lng->txt("news_co_period_info"));
            $per_sel->setOptions([
                7 => "1 {$this->lng->txt("week")}",
                30 => "1 {$this->lng->txt("month")}",
                366 => "1 {$this->lng->txt("year")}"
            ]);
            $per_sel->setValue($news_co_period);
            $opt_by_period->addSubItem($per_sel);
            $radio->addOption($opt_by_period);
 
            $form->addItem($radio);
        }
 
        // public notifications (forums)
        if ($this->has_public_notification) {
            $public = ilBlockSetting::_lookup("news", "public_notifications", 0, $block_id);
 
            $ch = new ilCheckboxInputGUI(
                $this->lng->txt("news_notifications_public"),
                "public_notifications"
            );
            $ch->setInfo($this->lng->txt("news_notifications_public_info"));
            $ch->setChecked((bool) $public);
            $form->addItem($ch);
        }
 
        $form->setTitle($this->lng->txt("cont_news_settings"));
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->addCommandButton("save", $this->lng->txt("save"));
 
        return $form;
    }

References ilNewsForContextBlockGUI\$block_type, ilObject\_getAllReferences(), ilBlockSetting\_lookup(), ilObject\_lookupType(), ilNewsForContextBlockGUI\addToSettingsForm(), ilMembershipNotifications\addToSettingsForm(), ILIAS\Repository\ctrl(), IL_CAL_DATETIME, ILIAS\Repository\lng(), ilObjectServiceSettingsGUI\NEWS_VISIBILITY, and ILIAS\Repository\object().

Referenced by save(), and show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilContainerNewsSettingsGUI::save ( )

Definition at line 254 of file class.ilContainerNewsSettingsGUI.php.

                          : void
    {
        $form = $this->initForm();
        if ($form->checkInput()) {
            //non container objects force this news block (forums etc.)
            if (!$this->has_block_forced) {
                $this->object->setNewsBlockActivated($form->getInput(ilObjectServiceSettingsGUI::NEWS_VISIBILITY));
            }
            if ($this->has_timeline) {
                $this->object->setNewsTimeline($form->getInput("news_timeline"));
                $this->object->setNewsTimelineAutoEntries($form->getInput("news_timeline_auto_entries"));
                $this->object->setNewsTimelineLandingPage($form->getInput("news_timeline_landing_page"));
            }
            if ($this->setting->get('block_activated_news')) {
                //save contextblock settings
                $context_block_settings = [
                    "public_feed" => $form->getInput("notifications_public_feed") ?? "",
                    "default_visibility" => $form->getInput("default_visibility")
                ];
                if ($this->has_public_notification) {
                    $context_block_settings["public_notifications"] =
                        $form->getInput('public_notifications');
                }
 
                if ($this->has_hide_by_date) {
                    $context_block_settings["hide_news_mode"] = $form->getInput("hide_news_mode");
                    switch ($context_block_settings["hide_news_mode"]) {
                        case "per_date":
                            $hd = $form->getItemByPostVar("hide_news_date");
                            if ($hd instanceof ilDateTimeInputGUI) {
                                $hide_date = $hd->getDate();
                                if (!$hide_date instanceof ilDateTime) {
                                    $hd->setAlert($this->lng->txt("msg_input_is_required"));
                                    $form->setValuesByPost();
                                    $this->tpl->setContent($form->getHTML());
                                    return;
                                }
                                $context_block_settings["hide_news_per_date"] = "1";
                                $context_block_settings["hide_news_date"] = $hide_date->get(IL_CAL_DATETIME);
                            }
                            $context_block_settings["news_co_period"] = "";
                            break;
                        case "by_period":
                            $context_block_settings["hide_news_per_date"] = "0";
                            $context_block_settings["hide_news_date"] = "";
                            $context_block_settings["news_co_period"] = $form->getInput("news_co_period");
                            break;
                        case "global":
                        default:
                            $context_block_settings["hide_news_per_date"] = "0";
                            $context_block_settings["hide_news_date"] = "";
                            $context_block_settings["news_co_period"] = "";
                            break;
                    }
                }
 
                ilNewsForContextBlockGUI::writeSettings($context_block_settings);
 
                if (in_array(ilObject::_lookupType($this->object->getId()), ['crs', 'grp'])) {
                    $ref_ids = ilObject::_getAllReferences($this->object->getId());
                    $ref_id = array_pop($ref_ids);
 
                    ilMembershipNotifications::importFromForm($ref_id, $form);
                }
            }
 
            $this->object->update();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
            $this->ctrl->redirect($this, "");
        } else {
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());
        }
    }

References ilObject\_getAllReferences(), ilObject\_lookupType(), ILIAS\Repository\ctrl(), IL_CAL_DATETIME, ilMembershipNotifications\importFromForm(), initForm(), ILIAS\Repository\lng(), ilObjectServiceSettingsGUI\NEWS_VISIBILITY, ILIAS\Repository\object(), and ilNewsForContextBlockGUI\writeSettings().

Here is the call graph for this function:

◆ setCronNotifications()

ilContainerNewsSettingsGUI::setCronNotifications ( bool $a_value )

Definition at line 348 of file class.ilContainerNewsSettingsGUI.php.

                                                       : void
    {
        $this->has_cron_notifications = $a_value;
    }

◆ setHideByDate()

ilContainerNewsSettingsGUI::setHideByDate ( bool $a_value )

Definition at line 358 of file class.ilContainerNewsSettingsGUI.php.

                                                : void
    {
        $this->has_hide_by_date = $a_value;
    }

◆ setNewsBlockForced()

ilContainerNewsSettingsGUI::setNewsBlockForced ( bool $a_value )

Definition at line 379 of file class.ilContainerNewsSettingsGUI.php.

                                                     : void
    {
        $this->has_block_forced = $a_value;
    }

◆ setNewsBlockInfo()

ilContainerNewsSettingsGUI::setNewsBlockInfo ( ?string $lang_key )

Definition at line 389 of file class.ilContainerNewsSettingsGUI.php.

                                                       : void
    {
        $this->news_block_info = $lang_key;
    }

◆ setNewsBlockLabel()

ilContainerNewsSettingsGUI::setNewsBlockLabel ( string $lang_key )

Definition at line 384 of file class.ilContainerNewsSettingsGUI.php.

                                                       : void
    {
        $this->news_block_label = $lang_key;
    }

◆ setPublicFeedInfo()

ilContainerNewsSettingsGUI::setPublicFeedInfo ( string $lang_key )

Definition at line 394 of file class.ilContainerNewsSettingsGUI.php.

                                                       : void
    {
        $this->public_feed_info = $lang_key;
    }

◆ setPublicNotification()

ilContainerNewsSettingsGUI::setPublicNotification ( bool $a_value )

Definition at line 368 of file class.ilContainerNewsSettingsGUI.php.

                                                        : void
    {
        $this->has_public_notification = $a_value;
    }

◆ setTimeline()

ilContainerNewsSettingsGUI::setTimeline ( bool $a_value )

Definition at line 338 of file class.ilContainerNewsSettingsGUI.php.

                                              : void
    {
        $this->has_timeline = $a_value;
    }

◆ show()

ilContainerNewsSettingsGUI::show ( )

Definition at line 101 of file class.ilContainerNewsSettingsGUI.php.

                          : void
    {
        $form = $this->initForm();
        $this->tpl->setContent($form->getHTML());
    }

References initForm().

Here is the call graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilContainerNewsSettingsGUI::$access

protected

Definition at line 34 of file class.ilContainerNewsSettingsGUI.php.

◆ $ctrl

ilCtrl ilContainerNewsSettingsGUI::$ctrl

protected

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

◆ $has_block_forced

bool ilContainerNewsSettingsGUI::$has_block_forced = false

protected

Definition at line 46 of file class.ilContainerNewsSettingsGUI.php.

Referenced by getNewsBlockForced().

◆ $has_cron_notifications

bool ilContainerNewsSettingsGUI::$has_cron_notifications = false

protected

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

Referenced by getCronNotifications().

◆ $has_hide_by_date

bool ilContainerNewsSettingsGUI::$has_hide_by_date = false

protected

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

Referenced by getHideByDate().

◆ $has_public_notification

bool ilContainerNewsSettingsGUI::$has_public_notification = false

protected

Definition at line 45 of file class.ilContainerNewsSettingsGUI.php.

Referenced by getPublicNotification().

◆ $has_timeline

bool ilContainerNewsSettingsGUI::$has_timeline = false

protected

Definition at line 42 of file class.ilContainerNewsSettingsGUI.php.

Referenced by getTimeline().

◆ $lng

ilLanguage ilContainerNewsSettingsGUI::$lng

protected

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

◆ $news_block_info

string ilContainerNewsSettingsGUI::$news_block_info = 'obj_tool_setting_news_info'

protected

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

◆ $news_block_label

string ilContainerNewsSettingsGUI::$news_block_label = 'news_news_block'

protected

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

◆ $news_settings

ilSetting ilContainerNewsSettingsGUI::$news_settings

protected

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

◆ $object

ilObject ilContainerNewsSettingsGUI::$object

protected

Definition at line 37 of file class.ilContainerNewsSettingsGUI.php.

◆ $parent_gui

ilObjectGUI ilContainerNewsSettingsGUI::$parent_gui

protected

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

◆ $period_info

NewsPeriodInfo ilContainerNewsSettingsGUI::$period_info

protected

Definition at line 39 of file class.ilContainerNewsSettingsGUI.php.

◆ $public_feed_info

string ilContainerNewsSettingsGUI::$public_feed_info = 'news_public_feed_info_container'

protected

Definition at line 49 of file class.ilContainerNewsSettingsGUI.php.

◆ $setting

ilSetting ilContainerNewsSettingsGUI::$setting

protected

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

◆ $tpl

ilGlobalTemplateInterface ilContainerNewsSettingsGUI::$tpl

protected

Definition at line 31 of file class.ilContainerNewsSettingsGUI.php.

◆ $tree

ilTree ilContainerNewsSettingsGUI::$tree

protected

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

◆ $ui_factory

UIFactory ilContainerNewsSettingsGUI::$ui_factory

protected

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

◆ $ui_renderer

UIRenderer ilContainerNewsSettingsGUI::$ui_renderer

protected

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

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

components/ILIAS/Container/News/class.ilContainerNewsSettingsGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkPermission()

◆ executeCommand()

◆ getCronNotifications()

◆ getHideByDate()

◆ getNewsBlockForced()

◆ getPublicNotification()

◆ getTimeline()

◆ initDefaultOptions()

◆ initForm()

◆ save()

◆ setCronNotifications()

◆ setHideByDate()

◆ setNewsBlockForced()

◆ setNewsBlockInfo()

◆ setNewsBlockLabel()

◆ setPublicFeedInfo()

◆ setPublicNotification()

◆ setTimeline()

◆ show()

Field Documentation

◆ $access

◆ $ctrl

◆ $has_block_forced

◆ $has_cron_notifications

◆ $has_hide_by_date

◆ $has_public_notification

◆ $has_timeline

◆ $lng

◆ $news_block_info

◆ $news_block_label

◆ $news_settings

◆ $object

◆ $parent_gui

◆ $period_info

◆ $public_feed_info

◆ $setting

◆ $tpl

◆ $tree

◆ $ui_factory

◆ $ui_renderer