Class ilPersonalChatSettingsFormGUI ilPersonalChatSettingsFormGUI: ilPersonalSettingsGUI. More...

Inheritance diagram for ilPersonalChatSettingsFormGUI:

Collaboration diagram for ilPersonalChatSettingsFormGUI:

Public Member Functions
	__construct ($init_form=true)
	ilPersonalChatSettingsFormGUI constructor. More...

	executeCommand ()
	{} More...

	isAccessible ()

Public Member Functions inherited from ilPropertyFormGUI
	__construct ()
	Constructor. More...

	executeCommand ()
	Execute command. More...

	setTableWidth ($a_width)
	Set table width. More...

	getTableWidth ()
	get table width More...

	setMode ($a_mode)
	Set Mode ('std', 'subform'). More...

	getMode ()
	Get Mode ('std', 'subform'). More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setTitleIcon ($a_titleicon)
	Set TitleIcon. More...

	getTitleIcon ()
	Get TitleIcon. More...

	setDescription ($a_val)
	Set description. More...

	getDescription ()
	Get description. More...

	setTopAnchor ($a_val)
	Set top anchor. More...

	getTopAnchor ()
	Get top anchor. More...

	setShowTopButtons ($a_val)
	Get show top buttons. More...

	getShowTopButtons ()
	Set show top buttons. More...

	addItem ($a_item)
	Add Item (Property, SectionHeader). More...

	removeItemByPostVar ($a_post_var, $a_remove_unused_headers=false)
	Remove Item. More...

	getItemByPostVar ($a_post_var)
	Get Item by POST variable. More...

	setItems ($a_items)
	Set Items. More...

	getItems ()
	Get Items. More...

	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...

	setDisableStandardMessage ($a_val)
	Set disable standard message. More...

	getDisableStandardMessage ()
	Get disable standard message. More...

	getHideLabels ()
	Get a value indicating whether the labels should be hidden or not. More...

	setHideLabels ($a_value=true)
	Set a value indicating whether the labels should be hidden or not. More...

	setValuesByArray ($a_values, $a_restrict_to_value_keys=false)
	Set form values from an array. More...

	setValuesByPost ()
	Set form values from POST values. More...

	checkInput ()
	Check Post Input. More...

	getInput ($a_post_var, $ensureValidation=true)
	Returns the value of a HTTP-POST variable, identified by the passed id. More...

	addCustomProperty ( $a_title, $a_html, $a_info="", $a_alert="", $a_required=false)
	Add a custom property. More...

	addCommandButton ($a_cmd, $a_text, $a_id="")
	Add Command button. More...

	getCommandButtons ()
	Return all Command buttons. More...

	clearCommandButtons ()
	Remove all command buttons. More...

	getContent ()
	Get Content. More...

	insertItem ($item, $a_sub_item=false)

	getHTML ()

	getFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Get file upload data. More...

	hasFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Was any file uploaded? More...

	moveFileUpload ($a_target_directory, $a_field, $a_target_name=null, $a_index=null, $a_sub_index=null)
	Move upload to target directory. More...

Public Member Functions inherited from ilFormGUI
	setFormAction ($a_formaction)
	Set FormAction. More...

	getFormAction ()
	Get FormAction. More...

	setTarget ($a_target)
	Set Target. More...

	getTarget ()
	Get Target. More...

	setMultipart ($a_multipart)
	Set Enctype Multipart/Formdata true/false. More...

	getMultipart ()
	Get Enctype Multipart/Formdata true/false. More...

	setId ($a_id)
	Set Id. More...

	getId ()
	Get Id. More...

	setName ($a_name)
	Set Name. More...

	getName ()
	Get Name. More...

	setKeepOpen ($a_keepopen)
	Set Keep Form Tag Open. More...

	getKeepOpen ()
	Get Keep Form Tag Open. More...

	setOpenTag ($a_open)
	Enable/Disable Open Form Tag. More...

	getOpenTag ()
	Get Open Form Tag Enabled. More...

	setCloseTag ($a_val)
	Set close tag. More...

	getCloseTag ()
	Get close tag. More...

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

	getHTML ()
	Get HTML. More...

	getContent ()
	Get Content. More...

Protected Member Functions
	shouldShowNotificationOptions ()

	shouldShowOnScreenChatOptions ()

	initForm ()

	showChatOptions ()

	saveChatOptions ()

Protected Member Functions inherited from ilPropertyFormGUI
	hideRequired ($a_type)

	rebuildUploadedFiles ()
	try to rebuild files More...

Protected Attributes
	$lng

	$ctrl

	$user

	$mainTpl

	$settings

	$chatSettings = array()

	$notificationSettings = array()

	$event

Protected Attributes inherited from ilPropertyFormGUI
	$lng

	$ctrl

	$tpl

	$user

	$settings

	$mode = "std"

	$check_input_called = false

	$disable_standard_message = false

	$top_anchor = "il_form_top"

	$titleicon = false

	$description = ""

	$tbl_width = false

	$show_top_buttons = true

	$hide_labels = false

Protected Attributes inherited from ilFormGUI
	$formaction

	$multipart = false

	$keepopen = false

	$opentag = true

	$id

	$name

	$prevent_double_submission = false

Detailed Description

Class ilPersonalChatSettingsFormGUI ilPersonalChatSettingsFormGUI: ilPersonalSettingsGUI.

Definition at line 9 of file class.ilPersonalChatSettingsFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPersonalChatSettingsFormGUI::__construct ( $init_form = true )

ilPersonalChatSettingsFormGUI constructor.

Parameters

bool $init_form

Definition at line 55 of file class.ilPersonalChatSettingsFormGUI.php.

References $DIC, initForm(), settings(), and user().

     {
         global $DIC;
         
         parent::__construct();
 
         $this->user     = $DIC->user();
         $this->ctrl     = $DIC->ctrl();
         $this->settings = $DIC['ilSetting'];
         $this->mainTpl  = $DIC['tpl'];
         $this->lng      = $DIC['lng'];
         $this->event    = $DIC->event();
 
         $this->chatSettings         = new ilSetting('chatroom');
         $this->notificationSettings = new ilSetting('notifications');
 
         if ($init_form) {
             $this->initForm();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilPersonalChatSettingsFormGUI::executeCommand ( )

{}

Definition at line 79 of file class.ilPersonalChatSettingsFormGUI.php.

References saveChatOptions(), and showChatOptions().

     {
         switch ($this->ctrl->getCmd()) {
             case 'saveChatOptions':
                 $this->saveChatOptions();
                 break;
 
             case 'showChatOptions':
             default:
                 $this->showChatOptions();
                 break;
         }
     }

Here is the call graph for this function:

◆ initForm()

ilPersonalChatSettingsFormGUI::initForm ( )

protected

Definition at line 127 of file class.ilPersonalChatSettingsFormGUI.php.

References ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilFormGUI\setFormAction(), ilFormPropertyGUI\setInfo(), settings(), ilPropertyFormGUI\setTitle(), shouldShowNotificationOptions(), and shouldShowOnScreenChatOptions().

Referenced by __construct().

     {
         $this->lng->loadLanguageModule('chatroom');
 
         $this->setFormAction($this->ctrl->getFormAction($this, 'saveChatOptions'));
         $this->setTitle($this->lng->txt("chat_settings"));
 
         if ($this->shouldShowNotificationOptions()) {
             $chb = new ilCheckboxInputGUI($this->lng->txt('play_invitation_sound'), 'play_invitation_sound');
             $chb->setInfo($this->lng->txt('play_invitation_sound_info'));
             $this->addItem($chb);
         }
 
         if ($this->shouldShowOnScreenChatOptions()) {
             $chb = new ilCheckboxInputGUI($this->lng->txt('chat_osc_accept_msg'), 'chat_osc_accept_msg');
             $chb->setInfo($this->lng->txt('chat_osc_accept_msg_info'));
             $chb->setDisabled((bool) $this->settings->get('usr_settings_disable_chat_osc_accept_msg', false));
             $this->addItem($chb);
         }
 
         $this->addCommandButton('saveChatOptions', $this->lng->txt('save'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAccessible()

ilPersonalChatSettingsFormGUI::isAccessible ( )

Returns: bool

Definition at line 96 of file class.ilPersonalChatSettingsFormGUI.php.

References shouldShowNotificationOptions(), and shouldShowOnScreenChatOptions().

Referenced by saveChatOptions(), and showChatOptions().

     {
         return (
             $this->chatSettings->get('chat_enabled', false) && (
                 $this->shouldShowNotificationOptions() || $this->shouldShowOnScreenChatOptions()
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveChatOptions()

ilPersonalChatSettingsFormGUI::saveChatOptions ( )

protected

Definition at line 171 of file class.ilPersonalChatSettingsFormGUI.php.

References ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), isAccessible(), ilUtil\sendSuccess(), settings(), shouldShowNotificationOptions(), shouldShowOnScreenChatOptions(), showChatOptions(), ilUtil\tf2yn(), and user().

Referenced by executeCommand().

     {
         if (!$this->isAccessible()) {
             $this->ctrl->returnToParent($this);
         }
 
         if (!$this->checkInput()) {
             $this->showChatOptions();
             return;
         }
 
         if ($this->shouldShowNotificationOptions()) {
             $this->user->setPref('chat_play_invitation_sound', (int) $this->getInput('play_invitation_sound'));
         }
 
         if ($this->shouldShowOnScreenChatOptions() && !(bool) $this->settings->get('usr_settings_disable_chat_osc_accept_msg', false)) {
             $this->user->setPref('chat_osc_accept_msg', ilUtil::tf2yn((bool) $this->getInput('chat_osc_accept_msg')));
         }
 
         $this->user->writePrefs();
 
         $this->event->raise(
             'Modules/Chatroom',
             'chatSettingsChanged',
             [
                 'user' => $this->user
             ]
         );
 
         ilUtil::sendSuccess($this->lng->txt('saved_successfully'));
         $this->showChatOptions();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shouldShowNotificationOptions()

ilPersonalChatSettingsFormGUI::shouldShowNotificationOptions ( )

protected

Returns: bool

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

Referenced by initForm(), isAccessible(), and saveChatOptions().

     {
         return $this->notificationSettings->get('enable_osd', false) && $this->chatSettings->get('play_invitation_sound', false);
     }

Here is the caller graph for this function:

◆ shouldShowOnScreenChatOptions()

ilPersonalChatSettingsFormGUI::shouldShowOnScreenChatOptions ( )

protected

Returns: bool

Definition at line 116 of file class.ilPersonalChatSettingsFormGUI.php.

References settings().

Referenced by initForm(), isAccessible(), and saveChatOptions().

     {
         return (
             $this->chatSettings->get('enable_osc', false) &&
             !(bool) $this->settings->get('usr_settings_hide_chat_osc_accept_msg', false)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showChatOptions()

ilPersonalChatSettingsFormGUI::showChatOptions ( )

protected

Definition at line 153 of file class.ilPersonalChatSettingsFormGUI.php.

References array, ilPropertyFormGUI\getHTML(), isAccessible(), ilPropertyFormGUI\setValuesByArray(), user(), and ilUtil\yn2tf().

Referenced by executeCommand(), and saveChatOptions().

     {
         if (!$this->isAccessible()) {
             $this->ctrl->returnToParent($this);
         }
 
         $this->setValuesByArray(array(
             'play_invitation_sound' => $this->user->getPref('chat_play_invitation_sound'),
             'chat_osc_accept_msg'   => ilUtil::yn2tf($this->user->getPref('chat_osc_accept_msg'))
         ));
 
         $this->mainTpl->setContent($this->getHTML());
         $this->mainTpl->show();
     }