Collaboration diagram for ilChatroomFormFactory:

Public Member Functions
	__construct ()
	Constructor. More...

	getCreationForm ()
	Instantiates and returns ilPropertyFormGUI containing ilTextInputGUI and ilTextAreaInputGUI. More...

	getSettingsForm (ilObjectService $objectService, ilObjChatroom $chatroom)

	getFileUploadForm ()
	Prepares Fileupload form and returns it. More...

	getPeriodForm ()
	Returns period form. More...

	getUserChatNameSelectionForm (array $name_options)
	Returns chatname selection form. More...

	getSessionForm (array $sessions)
	Returns session form with period set by given $sessions. More...

	getClientSettingsForm ()

Static Public Member Functions
static	applyValues (ilPropertyFormGUI $form, array $values)
	Applies given values to field in given form. More...

Protected Attributes
ilLanguage	$lng

ilObjUser	$user

ILIAS HTTP Services	$http

Private Member Functions
	addDefaultBehaviour (ilPropertyFormGUI $form)
	Adds 'create-save' and 'cancel' button to given $form and returns it. More...

Detailed Description

Class ilChatroomFormFactory.

Author: Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version: $Id$

Definition at line 27 of file class.ilChatroomFormFactory.php.

Constructor & Destructor Documentation

◆ __construct()

ilChatroomFormFactory::__construct ( )

Constructor.

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

References $DIC, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->http = $DIC->http();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addDefaultBehaviour()

ilChatroomFormFactory::addDefaultBehaviour ( ilPropertyFormGUI $form )

private

Adds 'create-save' and 'cancel' button to given $form and returns it.

Parameters

ilPropertyFormGUI $form

Returns: ilPropertyFormGUI

Definition at line 82 of file class.ilChatroomFormFactory.php.

References ilPropertyFormGUI\addCommandButton(), and ILIAS\Repository\lng().

Referenced by getCreationForm().

                                                                  : ilPropertyFormGUI
     {
         $form->addCommandButton('create-save', $this->lng->txt('create'));
         $form->addCommandButton('cancel', $this->lng->txt('cancel'));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyValues()

static ilChatroomFormFactory::applyValues	(	ilPropertyFormGUI	$form,
		array	$values
	)

static

Applies given values to field in given form.

Parameters

ilPropertyFormGUI	$form
array	$values

Definition at line 50 of file class.ilChatroomFormFactory.php.

References ilPropertyFormGUI\setValuesByArray().

Referenced by ilChatroomSettingsGUI\general().

                                                                               : void
     {
         $form->setValuesByArray(array_map(
             static fn ($value) => is_int($value) ? (string) $value : $value,
             $values
         ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClientSettingsForm()

ilChatroomFormFactory::getClientSettingsForm ( )

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

References $auth, $http, $name, ilNumberInputGUI\allowDecimals(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setInfo().

                                            : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
 
         $enable_chat = new ilCheckboxInputGUI($this->lng->txt('chat_enabled'), 'chat_enabled');
         $form->addItem($enable_chat);
 
         $enable_osc = new ilCheckboxInputGUI($this->lng->txt('chatroom_enable_osc'), 'enable_osc');
         $enable_osc->setInfo($this->lng->txt('chatroom_enable_osc_info'));
         $enable_chat->addSubItem($enable_osc);
 
         $oscBrowserNotificationStatus = new ilCheckboxInputGUI(
             $this->lng->txt('osc_adm_browser_noti_label'),
             'enable_browser_notifications'
         );
         $oscBrowserNotificationStatus->setInfo($this->lng->txt('osc_adm_browser_noti_info'));
         $oscBrowserNotificationStatus->setValue('1');
         $enable_osc->addSubItem($oscBrowserNotificationStatus);
 
         $oscBrowserNotificationIdleTime = new ilNumberInputGUI(
             $this->lng->txt('osc_adm_conv_idle_state_threshold_label'),
             'conversation_idle_state_in_minutes'
         );
         $oscBrowserNotificationIdleTime->allowDecimals(false);
         $oscBrowserNotificationIdleTime->setSuffix($this->lng->txt('minutes'));
         $oscBrowserNotificationIdleTime->setMinValue(1);
         $oscBrowserNotificationIdleTime->setSize(5);
         $oscBrowserNotificationIdleTime->setInfo($this->lng->txt('osc_adm_conv_idle_state_threshold_info'));
         $enable_osc->addSubItem($oscBrowserNotificationIdleTime);
 
         $enable_smilies = new ilCheckboxInputGUI($this->lng->txt('enable_smilies'), 'enable_smilies');
         $enable_smilies->setInfo($this->lng->txt('hint_enable_smilies'));
         $enable_chat->addSubItem($enable_smilies);
 
         $name = new ilTextInputGUI($this->lng->txt('chatroom_client_name'), 'client_name');
         $name->setInfo($this->lng->txt('chatroom_client_name_info'));
         $name->setRequired(true);
         $name->setMaxLength(100);
         $enable_chat->addSubItem($name);
 
         $auth = new ilChatroomAuthInputGUI(
             $this->lng->txt('chatroom_auth'),
             'auth',
             $this->http
         );
         $auth->setInfo($this->lng->txt('chat_auth_token_info'));
         $auth->setCtrlPath(
             [
                 ilAdministrationGUI::class,
                 ilObjChatroomGUI::class,
                 ilPropertyFormGUI::class,
                 ilFormPropertyDispatchGUI::class,
                 ilChatroomAuthInputGUI::class,
             ]
         );
         $auth->setRequired(true);
         $enable_chat->addSubItem($auth);
 
         return $form;
     }

Here is the call graph for this function:

◆ getCreationForm()

ilChatroomFormFactory::getCreationForm ( )

Instantiates and returns ilPropertyFormGUI containing ilTextInputGUI and ilTextAreaInputGUI.

Returns: ilPropertyFormGUI

Deprecated:: replaced by default creation screens

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

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

                                      : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
         $title->setRequired(true);
         $form->addItem($title);
 
         $description = new ilTextAreaInputGUI($this->lng->txt('description'), 'desc');
         $form->addItem($description);
 
         return $this->addDefaultBehaviour($form);
     }

Here is the call graph for this function:

◆ getFileUploadForm()

ilChatroomFormFactory::getFileUploadForm ( )

Prepares Fileupload form and returns it.

Returns: ilPropertyFormGUI

Definition at line 167 of file class.ilChatroomFormFactory.php.

References ILIAS\Repository\lng().

                                        : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $file_input = new ilFileInputGUI();
 
         $file_input->setPostVar('file_to_upload');
         $file_input->setTitle($this->lng->txt('upload'));
         $form->addItem($file_input);
         $form->addCommandButton('UploadFile-uploadFile', $this->lng->txt('submit'));
 
         $form->setTarget('_blank');
 
         return $form;
     }

Here is the call graph for this function:

◆ getPeriodForm()

ilChatroomFormFactory::getPeriodForm ( )

Returns period form.

Returns: ilPropertyFormGUI

Definition at line 186 of file class.ilChatroomFormFactory.php.

References ILIAS\Repository\lng(), and ilDateDurationInputGUI\setStartText().

                                    : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setPreventDoubleSubmission(false);
 
         $duration = new ilDateDurationInputGUI($this->lng->txt('period'), 'timeperiod');
 
         $duration->setStartText($this->lng->txt('duration_from'));
         $duration->setEndText($this->lng->txt('duration_to'));
         $duration->setShowTime(true);
         $duration->setRequired(true);
         $form->addItem($duration);
 
         return $form;
     }

Here is the call graph for this function:

◆ getSessionForm()

ilChatroomFormFactory::getSessionForm ( array $sessions )

Returns session form with period set by given $sessions.

Parameters

array $sessions

Returns: ilPropertyFormGUI

Definition at line 239 of file class.ilChatroomFormFactory.php.

References $session, ilDatePresentation\formatPeriod(), IL_CAL_UNIX, and ILIAS\Repository\lng().

                                                    : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setPreventDoubleSubmission(false);
         $list = new ilSelectInputGUI($this->lng->txt('session'), 'session');
 
         $options = [];
 
         foreach ($sessions as $session) {
             $start = new ilDateTime($session['connected'], IL_CAL_UNIX);
             $end = new ilDateTime($session['disconnected'], IL_CAL_UNIX);
 
             $options[$session['connected'] . ',' .
             $session['disconnected']] = ilDatePresentation::formatPeriod($start, $end);
         }
 
         $list->setOptions($options);
         $list->setRequired(true);
 
         $form->addItem($list);
 
         return $form;
     }

Here is the call graph for this function:

◆ getSettingsForm()

ilChatroomFormFactory::getSettingsForm	(	ilObjectService	$objectService,
		ilObjChatroom	$chatroom
	)

Definition at line 90 of file class.ilChatroomFormFactory.php.

References $txt, ilObjectService\commonSettings(), ILIAS\Repository\lng(), ilFormPropertyGUI\setInfo(), ilFormPropertyGUI\setRequired(), ilDateDurationInputGUI\setShowTime(), ilNumberInputGUI\setSuffix(), and ilCheckboxInputGUI\setValue().

                                                                                             : ilPropertyFormGUI
     {
         $this->lng->loadLanguageModule('rep');
 
         $form = new ilPropertyFormGUI();
         $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
         $title->setRequired(true);
         $form->addItem($title);
 
         $description = new ilTextAreaInputGUI($this->lng->txt('description'), 'desc');
         $form->addItem($description);
 
         $section = new ilFormSectionHeaderGUI();
         $section->setTitle($this->lng->txt('rep_activation_availability'));
         $form->addItem($section);
 
         $online = new ilCheckboxInputGUI($this->lng->txt('rep_activation_online'), 'online_status');
         $online->setInfo($this->lng->txt('chtr_activation_online_info'));
         $form->addItem($online);
 
         $dur = new ilDateDurationInputGUI($this->lng->txt('rep_time_period'), 'access_period');
         $dur->setShowTime(true);
         $form->addItem($dur);
 
         $visible = new ilCheckboxInputGUI($this->lng->txt('rep_activation_limited_visibility'), 'access_visibility');
         $visible->setValue('1');
         $visible->setInfo($this->lng->txt('chtr_activation_limited_visibility_info'));
         $dur->addSubItem($visible);
 
         $presentationHeader = new ilFormSectionHeaderGUI();
         $presentationHeader->setTitle($this->lng->txt('settings_presentation_header'));
         $form->addItem($presentationHeader);
 
         $objectService->commonSettings()->legacyForm(
             $form,
             $chatroom
         )->addTileImage();
 
         $num_msg_history = new ilNumberInputGUI($this->lng->txt('display_past_msgs'), 'display_past_msgs');
         $num_msg_history->setSuffix($this->lng->txt('display_past_msgs_suffix'));
         $num_msg_history->allowDecimals(false);
         $num_msg_history->setSize(5);
         $num_msg_history->setInfo($this->lng->txt('hint_display_past_msgs'));
         $num_msg_history->setMinValue(0);
         $num_msg_history->setMaxValue(100);
         $form->addItem($num_msg_history);
 
         $cb_history = new ilCheckboxInputGUI($this->lng->txt('chat_enable_history'), 'enable_history');
         $cb_history->setInfo($this->lng->txt('chat_enable_history_info'));
         $form->addItem($cb_history);
 
         $functionsnHeader = new ilFormSectionHeaderGUI();
         $functionsnHeader->setTitle($this->lng->txt('chat_settings_functions_header'));
         $form->addItem($functionsnHeader);
 
         $cb = new ilCheckboxInputGUI($this->lng->txt('allow_anonymous'), 'allow_anonymous');
         $cb->setInfo($this->lng->txt('anonymous_hint'));
         $form->addItem($cb);
 
         $cb = new ilCheckboxInputGUI($this->lng->txt('allow_custom_usernames'), 'allow_custom_usernames');
         $txt = new ilTextInputGUI($this->lng->txt('autogen_usernames'), 'autogen_usernames');
         $txt->setRequired(true);
         $txt->setInfo($this->lng->txt('autogen_usernames_info'));
         $cb->addSubItem($txt);
         $form->addItem($cb);
 
         $cb = new ilCheckboxInputGUI($this->lng->txt('private_rooms_enabled'), 'private_rooms_enabled');
         $cb->setInfo($this->lng->txt('private_rooms_enabled_info'));
         $form->addItem($cb);
 
         return $form;
     }

Here is the call graph for this function:

◆ getUserChatNameSelectionForm()

ilChatroomFormFactory::getUserChatNameSelectionForm ( array $name_options )

Returns chatname selection form.

Parameters

array<string,string> $name_options

Returns: ilPropertyFormGUI

Definition at line 207 of file class.ilChatroomFormFactory.php.

References ILIAS\LTI\ToolProvider\$key, $txt, ILIAS\Repository\lng(), and ILIAS\Repository\user().

                                                                      : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
 
         $radio = new ilRadioGroupInputGUI($this->lng->txt('select_custom_username'), 'custom_username_radio');
 
         foreach ($name_options as $key => $option) {
             $opt = new ilRadioOption($option, $key);
             $radio->addOption($opt);
         }
 
         $custom_opt = new ilRadioOption($this->lng->txt('custom_username'), 'custom_username');
         $radio->addOption($custom_opt);
 
         $txt = new ilTextInputGUI($this->lng->txt('preferred_chatname'), 'custom_username_text');
         $custom_opt->addSubItem($txt);
         $form->addItem($radio);
 
         if ($this->user->isAnonymous()) {
             $radio->setValue('anonymousName');
         } else {
             $radio->setValue('fullname');
         }
 
         return $form;
     }