Forum Administration Settings. More...

Inheritance diagram for ilObjForumAdministrationGUI:

Collaboration diagram for ilObjForumAdministrationGUI:

Public Member Functions
	executeCommand ()

	getAdminTabs ()

	editSettings (Form $form=null)

	saveSettings ()

	addToExternalSettingsForm (int $a_form_id)

Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)

	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	editAvailabilityPeriodObject ()

	saveAvailabilityPeriodObject ()

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Protected Member Functions
	settingsForm ()

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	createActionDispatcherGUI ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator (bool $omit=true)

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	initCreationForms (string $new_type)
	Init creation forms. More...

	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm (string $new_type)

	initDidacticTemplate (ilPropertyFormGUI $form)

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

	addAdoptContentLinkToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm (string $new_type)

	importFileObject (int $parent_id=null)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

Private Member Functions
	render ($x)

	cronMessage ()

	forumJobActive ()

	forumByLine (Component $component)

Private Attributes
const	PROP_SECTION_DEFAULTS = 'defaults'

const	PROP_SECTION_FEATURES = 'features'

const	PROP_SECTION_NOTIFICATIONS = 'notifications'

const	PROP_SECTION_DRAFTS = 'drafts'

ILIAS DI RBACServices	$rbac

ilCronManager	$cronManager

UIServices	$ui

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Detailed Description

Forum Administration Settings.

Author: Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de ilObjForumAdministrationGUI: ilPermissionGUI ilObjForumAdministrationGUI: ilAdministrationGUI

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

Member Function Documentation

◆ addToExternalSettingsForm()

ilObjForumAdministrationGUI::addToExternalSettingsForm ( int $a_form_id )

Definition at line 302 of file class.ilObjForumAdministrationGUI.php.

References ilAdministrationSettingsFormHandler\FORM_PRIVACY, ILIAS\Repository\settings(), and ilAdministrationSettingsFormHandler\VALUE_BOOL.

                                                              : array
     {
         if ($a_form_id === ilAdministrationSettingsFormHandler::FORM_PRIVACY) {
             $fields = [
                 'enable_fora_statistics' => [
                     (bool) $this->settings->get('enable_fora_statistics', '0'),
                     ilAdministrationSettingsFormHandler::VALUE_BOOL
                 ],
                 'enable_anonymous_fora' => [
                     (bool) $this->settings->get('enable_anonymous_fora', '0'),
                     ilAdministrationSettingsFormHandler::VALUE_BOOL
                 ]
             ];
             return [['editSettings', $fields]];
         }
 
         return [];
     }

Here is the call graph for this function:

◆ cronMessage()

ilObjForumAdministrationGUI::cronMessage ( )

private

Definition at line 321 of file class.ilObjForumAdministrationGUI.php.

References ilObjectGUI\$data, $url, ILIAS\Repository\ctrl(), ilAdministrationSettingsFormHandler\FORM_FORUM, ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by editSettings().

                                   : Component
     {
         $gui = new ilCronManagerGUI();
         $data = $gui->addToExternalSettingsForm(ilAdministrationSettingsFormHandler::FORM_FORUM);
         $data = $data['cron_jobs'][1];
 
         $url = $this->ctrl->getLinkTargetByClass(
             [ilAdministrationGUI::class, ilObjSystemFolderGUI::class],
             'jumpToCronJobs'
         );
 
         return $this->ui->factory()->messageBox()->info($this->lng->txt(key($data)) . ': ' . current($data))->withLinks(
             [
                 $this->ui->factory()->link()->standard($this->lng->txt('adm_external_setting_edit'), $url)
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editSettings()

ilObjForumAdministrationGUI::editSettings ( Form $form = null )

Definition at line 108 of file class.ilObjForumAdministrationGUI.php.

References cronMessage(), render(), and settingsForm().

Referenced by saveSettings().

                                                    : void
     {
         $this->tabs_gui->activateTab('settings');
 
         $this->tpl->setContent($this->render([
             $this->cronMessage(),
             $form ?? $this->settingsForm()
         ]));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjForumAdministrationGUI::executeCommand ( )

Definition at line 61 of file class.ilObjForumAdministrationGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilObjectGUI\prepareOutput(), and ILIAS\Repository\rbac().

                                     : void
     {
         if (!$this->rbac->system()->checkAccess('visible,read', $this->object->getRefId())) {
             $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
         }
 
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
 
         $this->prepareOutput();
 
         switch ($next_class) {
             case 'ilpermissiongui':
                 $this->tabs_gui->setTabActive('perm_settings');
                 $this->ctrl->forwardCommand(new ilPermissionGUI($this));
                 break;
 
             default:
                 if (!$cmd || $cmd === 'view') {
                     $cmd = 'editSettings';
                 }
 
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ forumByLine()

ilObjForumAdministrationGUI::forumByLine ( Component $component )

private

Definition at line 344 of file class.ilObjForumAdministrationGUI.php.

References forumJobActive(), and ILIAS\Repository\lng().

Referenced by settingsForm().

                                                       : string
     {
         return $this->forumJobActive() ?
             sprintf('%s<br/>%s', $component->getByLine(), $this->lng->txt('cron_forum_notification_disabled')) :
             $component->getByLine();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ forumJobActive()

ilObjForumAdministrationGUI::forumJobActive ( )

private

Definition at line 339 of file class.ilObjForumAdministrationGUI.php.

Referenced by forumByLine(), saveSettings(), and settingsForm().

                                      : bool
     {
         return $this->cronManager->isJobActive('frm_notification');
     }

Here is the caller graph for this function:

◆ getAdminTabs()

ilObjForumAdministrationGUI::getAdminTabs ( )

Definition at line 88 of file class.ilObjForumAdministrationGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\object(), and ILIAS\Repository\rbac().

                                   : void
     {
         if ($this->rbac->system()->checkAccess('visible,read', $this->object->getRefId())) {
             $this->tabs_gui->addTarget(
                 'settings',
                 $this->ctrl->getLinkTarget($this, 'editSettings'),
                 ['editSettings', 'view']
             );
         }
 
         if ($this->rbac->system()->checkAccess('edit_permission', $this->object->getRefId())) {
             $this->tabs_gui->addTarget(
                 'perm_settings',
                 $this->ctrl->getLinkTargetByClass(ilPermissionGUI::class, 'perm'),
                 [],
                 'ilpermissiongui'
             );
         }
     }

Here is the call graph for this function:

◆ render()

ilObjForumAdministrationGUI::render ( $x )

private

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

References ILIAS\Repository\ui().

Referenced by editSettings().

                                : string
     {
         return $this->ui->renderer()->render($x);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveSettings()

ilObjForumAdministrationGUI::saveSettings ( )

Definition at line 123 of file class.ilObjForumAdministrationGUI.php.

References ilObjectGUI\$data, ilObjectGUI\checkPermission(), editSettings(), forumJobActive(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and settingsForm().

                                   : void
     {
         $this->checkPermission('write');
 
         $form = $this->settingsForm()->withRequest($this->request);
         $data = $form->getData();
         if ($data === null || $this->request->getMethod() !== 'POST') {
             $this->editSettings($form);
             return;
         }
 
         $set_int = fn(string $field, string $section) => $this->settings->set(
             $field,
             (string) ((int) $data[$section][$field])
         );
 
         $data[self::PROP_SECTION_NOTIFICATIONS]['forum_notification'] = (
             $data[self::PROP_SECTION_NOTIFICATIONS]['forum_notification'] || $this->forumJobActive()
         );
 
         array_map($set_int, [
             'forum_default_view',
             'forum_enable_print',
             'enable_fora_statistics',
             'enable_anonymous_fora',
             'file_upload_allowed_fora',
             'forum_notification',
             'send_attachments_by_mail',
             'save_post_drafts',
         ], [
             self::PROP_SECTION_DEFAULTS,
             self::PROP_SECTION_FEATURES,
             self::PROP_SECTION_FEATURES,
             self::PROP_SECTION_FEATURES,
             self::PROP_SECTION_FEATURES,
             self::PROP_SECTION_NOTIFICATIONS,
             self::PROP_SECTION_NOTIFICATIONS,
             self::PROP_SECTION_DRAFTS
         ]);
 
         $drafts = $data[self::PROP_SECTION_DRAFTS]['autosave_drafts'] !== null;
         $this->settings->set('autosave_drafts', (string) ((int) $drafts));
         if ($drafts) {
             $this->settings->set(
                 'autosave_drafts_ival',
                 (string) ((int) $data[self::PROP_SECTION_DRAFTS]['autosave_drafts']['ival'])
             );
         }
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'));
         $this->editSettings($form);
     }

Here is the call graph for this function:

◆ settingsForm()

ilObjForumAdministrationGUI::settingsForm ( )

protected

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

References Vendor\Package\$f, ILIAS\UI\Implementation\Component\Input\$inputs, ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilForumProperties\FILE_UPLOAD_GLOBALLY_ALLOWED, ilForumProperties\FILE_UPLOAD_INDIVIDUAL, forumByLine(), forumJobActive(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), ILIAS\Repository\ui(), ilForumProperties\VIEW_DATE_ASC, ilForumProperties\VIEW_DATE_DESC, ilForumProperties\VIEW_TREE, and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by editSettings(), and saveSettings().

                                      : Form
     {
         $field = $this->ui->factory()->input()->field();
 
         $section = fn(string $label, array $inputs): \ILIAS\UI\Component\Input\Field\Section => $field->section(
             $inputs,
             $this->lng->txt($label)
         );
         $checkbox = fn(string $label): \ILIAS\UI\Component\Input\Field\Checkbox => $field->checkbox(
             $this->lng->txt($label),
             $this->lng->txt($label . '_desc')
         );
         $by_date_with_additional_info = fn(string $label): string => sprintf(
             '%s (%s)',
             $this->lng->txt('sort_by_date'),
             $this->lng->txt($label)
         );
         $to_string = static fn($value): string => (string) $value;
         $radio_with_options = static fn(
             \ILIAS\UI\Component\Input\Field\Radio $x,
             array $options
         ): \ILIAS\UI\Component\Input\Field\Radio => array_reduce(
             $options,
             static fn($field, array $option) => $field->withOption(...array_map($to_string, $option)),
             $x
         );
         $checkbox_with_func = function (string $name, ?string $label = null, $f = null) use (
             $checkbox
         ): \ILIAS\UI\Component\Input\Field\Checkbox {
             $f = $f ?? static fn($x) => $x;
             return $f($checkbox($label ?? $name)->withValue((bool) $this->settings->get($name)));
         };
         $disable_if_no_permission = $this->checkPermissionBool('write') ? static fn(
             array $fields
         ): array => $fields : static fn(
             array $fields
         ): array => array_map(
             static fn($x) => $x->withDisabled(true),
             $fields
         );
 
         return $this->ui->factory()->input()->container()->form()->standard(
             $this->ctrl->getFormAction($this, 'saveSettings'),
             [
                 self::PROP_SECTION_DEFAULTS => $section('frm_adm_sec_default_settings', $disable_if_no_permission([
                     'forum_default_view' => $radio_with_options($field->radio($this->lng->txt('frm_default_view')), [
                         [
                             ilForumProperties::VIEW_TREE,
                             $this->lng->txt('sort_by_posts'),
                             $this->lng->txt('sort_by_posts_desc')
                         ],
                         [
                             ilForumProperties::VIEW_DATE_ASC,
                             $by_date_with_additional_info('ascending_order'),
                             $this->lng->txt('sort_by_date_desc')
                         ],
                         [
                             ilForumProperties::VIEW_DATE_DESC,
                             $by_date_with_additional_info('descending_order'),
                             $this->lng->txt('sort_by_date_desc')
                         ],
                     ])->withValue($this->settings->get('forum_default_view', (string) ilForumProperties::VIEW_DATE_ASC))
                 ])),
                 self::PROP_SECTION_FEATURES => $section('frm_adm_sec_features', $disable_if_no_permission([
                     'forum_enable_print' => $checkbox_with_func('forum_enable_print', 'frm_enable_print_option'),
                     'enable_fora_statistics' => $checkbox_with_func('enable_fora_statistics'),
                     'enable_anonymous_fora' => $checkbox_with_func('enable_anonymous_fora'),
                     'file_upload_allowed_fora' => $radio_with_options(
                         $field->radio($this->lng->txt('file_upload_allowed_fora')),
                         [
                             [
                                 ilForumProperties::FILE_UPLOAD_GLOBALLY_ALLOWED,
                                 $this->lng->txt('file_upload_option_allow'),
                                 $this->lng->txt('file_upload_option_allow_info')
                             ],
                             [
                                 ilForumProperties::FILE_UPLOAD_INDIVIDUAL,
                                 $this->lng->txt('file_upload_option_disallow'),
                                 $this->lng->txt('file_upload_allowed_fora_desc')
                             ],
                         ]
                     )->withValue(
                         $this->settings->get(
                             'file_upload_allowed_fora',
                             (string) ilForumProperties::FILE_UPLOAD_GLOBALLY_ALLOWED
                         )
                     )
                 ])),
                 self::PROP_SECTION_NOTIFICATIONS => $section('frm_adm_sec_notifications', $disable_if_no_permission([
                     'forum_notification' => $checkbox_with_func(
                         'forum_notification',
                         'forums_forum_notification',
                         fn($field) => (
                             $field
                             ->withDisabled($this->forumJobActive())
                             ->withValue($field->getValue() || $this->forumJobActive())
                             ->withByLine($this->forumByLine($field))
                         )
                     ),
                     'send_attachments_by_mail' => $checkbox_with_func('send_attachments_by_mail', 'enable_send_attachments')
                 ])),
                 self::PROP_SECTION_DRAFTS => $section('frm_adm_sec_drafts', $disable_if_no_permission([
                     'save_post_drafts' => $checkbox_with_func('save_post_drafts', 'adm_save_drafts'),
                     'autosave_drafts' => $field->optionalGroup([
                         'ival' => $field
                             ->numeric($this->lng->txt('adm_autosave_ival'))
                             ->withRequired(true)
                             ->withAdditionalTransformation(
                                 $this->refinery->in()->series([
                                     $this->refinery->int()->isGreaterThanOrEqual(30),
                                     $this->refinery->int()->isLessThanOrEqual(60 * 60)
                                 ])
                             )
                     ], $this->lng->txt('adm_autosave_drafts'), $this->lng->txt('adm_autosave_drafts_desc'))->withValue(
                         $this->settings->get('autosave_drafts') ? [
                             'ival' => $this->settings->get(
                                 'autosave_drafts_ival',
                                 '30'
                             )
                         ] : null
                     )
                 ])),
             ]
         );
     }