This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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)

	getNewsBlockForced ()

Protected Attributes
ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilSetting	$setting

ilObjectGUI	$parent_gui

ilObject	$object

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

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning News settings for containers

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

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerNewsSettingsGUI::__construct ( ilObjectGUI $a_parent_gui )

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

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

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule("news");
         $this->tpl = $DIC["tpl"];
         $this->setting = $DIC["ilSetting"];
         $this->parent_gui = $a_parent_gui;
         $this->object = $this->parent_gui->getObject();
 
         $this->initDefaultOptions();
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilContainerNewsSettingsGUI::executeCommand ( )

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ getCronNotifications()

ilContainerNewsSettingsGUI::getCronNotifications ( )

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

References $has_cron_notifications.

                                           : bool
     {
         return $this->has_cron_notifications;
     }

◆ getHideByDate()

ilContainerNewsSettingsGUI::getHideByDate ( )

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

References $has_hide_by_date.

                                    : bool
     {
         return $this->has_hide_by_date;
     }

◆ getNewsBlockForced()

ilContainerNewsSettingsGUI::getNewsBlockForced ( )

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

References $has_block_forced.

                                         : bool
     {
         return $this->has_block_forced;
     }

◆ getPublicNotification()

ilContainerNewsSettingsGUI::getPublicNotification ( )

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

References $has_public_notification.

                                            : bool
     {
         return $this->has_public_notification;
     }

◆ getTimeline()

ilContainerNewsSettingsGUI::getTimeline ( )

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

References $has_timeline.

                                  : bool
     {
         return $this->has_timeline;
     }

◆ initDefaultOptions()

ilContainerNewsSettingsGUI::initDefaultOptions ( )

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

Referenced by __construct().

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

Here is the caller graph for this function:

◆ initForm()

ilContainerNewsSettingsGUI::initForm ( )

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

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

Referenced by save(), and show().

                               : 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('news_news_block'), ilObjectServiceSettingsGUI::NEWS_VISIBILITY);
             $news->setValue('1');
             if ($this->has_block_forced) {
                 $news->setChecked(true);
                 $news->setDisabled(true);
             } else {
                 $news->setChecked($this->object->getNewsBlockActivated());
             }
             $news->setInfo($this->lng->txt('obj_tool_setting_news_info'));
             ilNewsForContextBlockGUI::addToSettingsForm($news);
             $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();
 
         // Visibility by date
         $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
         );
 
         if ($hide_news_date != "") {
             $hide_news_date = explode(" ", $hide_news_date);
         }
 
         // Hide news before a date (courses, groups and categories)
         if ($this->has_hide_by_date) {
             //Hide news per date
             $hnpd = new ilCheckboxInputGUI(
                 $this->lng->txt("news_hide_news_per_date"),
                 "hide_news_per_date"
             );
             $hnpd->setInfo($this->lng->txt("news_hide_news_per_date_info"));
             $hnpd->setChecked((bool) $hide_news_per_date);
 
             $dt_prop = new ilDateTimeInputGUI($this->lng->txt("news_hide_news_date"), "hide_news_date");
             $dt_prop->setRequired(true);
             if (is_array($hide_news_date)) {
                 $dt_prop->setDate(new ilDateTime($hide_news_date[0] . ' ' . ($hide_news_date[1] ?? "12:00:00"), IL_CAL_DATETIME));
             }
 
             $dt_prop->setShowTime(true);
 
             $hnpd->addSubItem($dt_prop);
 
             $form->addItem($hnpd);
         }
 
         // 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilContainerNewsSettingsGUI::save ( )

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

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

                           : 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"),
                     "hide_news_per_date" => $form->getInput("hide_news_per_date"),
                     "hide_news_date" => $form->getInput("hide_news_date")
                 ];
                 if ($this->has_public_notification) {
                     $context_block_settings["public_notifications"] =
                         $form->getInput('public_notifications');
                 }
 
                 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());
         }
     }

Here is the call graph for this function:

◆ setCronNotifications()

ilContainerNewsSettingsGUI::setCronNotifications ( bool $a_value )

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

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

◆ setHideByDate()

ilContainerNewsSettingsGUI::setHideByDate ( bool $a_value )

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

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

◆ setNewsBlockForced()

ilContainerNewsSettingsGUI::setNewsBlockForced ( bool $a_value )

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

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

◆ setPublicNotification()

ilContainerNewsSettingsGUI::setPublicNotification ( bool $a_value )

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

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

◆ setTimeline()

ilContainerNewsSettingsGUI::setTimeline ( bool $a_value )

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

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

◆ show()

ilContainerNewsSettingsGUI::show ( )

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

References initForm().

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

Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ilContainerNewsSettingsGUI::$ctrl

protected

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

◆ $has_block_forced

bool ilContainerNewsSettingsGUI::$has_block_forced = false

protected

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

Referenced by getNewsBlockForced().

◆ $has_cron_notifications

bool ilContainerNewsSettingsGUI::$has_cron_notifications = false

protected

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

Referenced by getCronNotifications().

◆ $has_hide_by_date

bool ilContainerNewsSettingsGUI::$has_hide_by_date = false

protected

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

Referenced by getHideByDate().

◆ $has_public_notification

bool ilContainerNewsSettingsGUI::$has_public_notification = false

protected

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

Referenced by getPublicNotification().

◆ $has_timeline

bool ilContainerNewsSettingsGUI::$has_timeline = false

protected

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

Referenced by getTimeline().

◆ $lng

ilLanguage ilContainerNewsSettingsGUI::$lng

protected

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

◆ $object

ilObject ilContainerNewsSettingsGUI::$object

protected

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

◆ $parent_gui

ilObjectGUI ilContainerNewsSettingsGUI::$parent_gui

protected

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

◆ $setting

ilSetting ilContainerNewsSettingsGUI::$setting

protected

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

◆ $tpl

ilGlobalTemplateInterface ilContainerNewsSettingsGUI::$tpl

protected

Definition at line 27 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 Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ getCronNotifications()

◆ getHideByDate()

◆ getNewsBlockForced()

◆ getPublicNotification()

◆ getTimeline()

◆ initDefaultOptions()

◆ initForm()

◆ save()

◆ setCronNotifications()

◆ setHideByDate()

◆ setNewsBlockForced()

◆ setPublicNotification()

◆ setTimeline()

◆ show()

Field Documentation

◆ $ctrl

◆ $has_block_forced

◆ $has_cron_notifications

◆ $has_hide_by_date

◆ $has_public_notification

◆ $has_timeline

◆ $lng

◆ $object

◆ $parent_gui

◆ $setting

◆ $tpl