ilChatroomFormFactory Class Reference

Class ilChatroomFormFactory. More...

Collaboration diagram for ilChatroomFormFactory:

Public Member Functions
	__construct ()
	Constructor. More...
	getCreationForm ()
	Instantiates and returns ilPropertyFormGUI containing ilTextInputGUI and ilTextAreaInputGUI. More...
	getSettingsForm ()
	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...
	getGeneralSettingsForm ()
	Returns general settings form. More...
	getClientSettingsForm ()

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

Protected Attributes
	$lng
	$user

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 12 of file class.ilChatroomFormFactory.php.

Constructor & Destructor Documentation

__construct()

ilChatroomFormFactory::__construct

(

)

Constructor.

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

References $DIC, and user().

    {
        global $DIC;

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

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 69 of file class.ilChatroomFormFactory.php.

References ilPropertyFormGUI\addCommandButton().

Referenced by getCreationForm().

    {
        $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 40 of file class.ilChatroomFormFactory.php.

References ilPropertyFormGUI\setValuesByArray().

Referenced by ilChatroomSettingsGUI\general().

    {
        $form->setValuesByArray($values);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getClientSettingsForm()

ilChatroomFormFactory::getClientSettingsForm

(

)

Returns

ilPropertyFormGUI

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

References $auth, $name, ilFormPropertyGUI\setInfo(), and ilNumberInputGUI\setMinValue().

    {
        $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);

        $osd = new ilCheckboxInputGUI($this->lng->txt('enable_osd'), 'enable_osd');
        $osd->setInfo($this->lng->txt('hint_osd'));
        $enable_chat->addSubItem($osd);

        $interval = new ilNumberInputGUI($this->lng->txt('osd_intervall'), 'osd_intervall');
        $interval->setMinValue(1);
        $interval->setRequired(true);
        $interval->setSuffix($this->lng->txt('seconds'));
        $interval->setSize(5);
        $interval->setInfo($this->lng->txt('hint_osd_interval'));
        $osd->addSubItem($interval);

        $play_sound = new ilCheckboxInputGUI($this->lng->txt('play_invitation_sound'), 'play_invitation_sound');
        $play_sound->setInfo($this->lng->txt('play_invitation_sound_info'));
        $osd->addSubItem($play_sound);

        $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);

        require_once 'Modules/Chatroom/classes/class.ilChatroomAuthInputGUI.php';
        $auth = new ilChatroomAuthInputGUI($this->lng->txt('chatroom_auth'), 'auth');
        $auth->setInfo($this->lng->txt('chat_auth_token_info'));
        $auth->setCtrlPath(array('iladministrationgui', 'ilobjchatroomgui', 'ilpropertyformgui', 'ilformpropertydispatchgui', 'ilchatroomauthinputgui'));
        $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.

Deprecated:

replaced by default creation screens

Returns

ilPropertyFormGUI

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

References addDefaultBehaviour().

    {
        $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 142 of file class.ilChatroomFormFactory.php.

    {
        $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;
    }

getGeneralSettingsForm()

ilChatroomFormFactory::getGeneralSettingsForm

(

)

Returns general settings form.

Returns

ilPropertyFormGUI

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

References $http, $https, ilNumberInputGUI\allowDecimals(), ilRadioOption\setInfo(), ilNumberInputGUI\setMinValue(), and ilFormPropertyGUI\setRequired().

    {
        $form = new ilPropertyFormGUI();

        $address = new ilTextInputGUI($this->lng->txt('chatserver_address'), 'address');
        $address->setRequired(true);
        $form->addItem($address);

        $port = new ilNumberInputGUI($this->lng->txt('chatserver_port'), 'port');
        $port->setMinValue(1);
        $port->setMaxValue(65535);
        $port->setRequired(true);
        $port->setInfo($this->lng->txt('port_info'));
        $port->setSize(6);
        $form->addItem($port);

        $subDirectory = new ilTextInputGUI($this->lng->txt('chat_osc_no_sub_directory'), 'sub_directory');
        $subDirectory->setRequired(false);
        $subDirectory->setInfo($this->lng->txt('chat_osc_no_sub_directory_info'));
        $form->addItem($subDirectory);

        $protocol = new ilRadioGroupInputGUI($this->lng->txt('protocol'), 'protocol');
        $form->addItem($protocol);

        $http = new ilRadioOption($this->lng->txt('http'), 'http');
        $protocol->addOption($http);

        $https = new ilRadioOption($this->lng->txt('https'), 'https');
        $protocol->addOption($https);

        $certificate = new ilTextInputGUI($this->lng->txt('certificate'), 'cert');
        $certificate->setInfo($this->lng->txt('chat_https_cert_info'));
        $certificate->setRequired(true);
        $https->addSubItem($certificate);

        $key = new ilTextInputGUI($this->lng->txt('key'), 'key');
        $key->setInfo($this->lng->txt('chat_https_key_info'));
        $key->setRequired(true);
        $https->addSubItem($key);

        $dhparam = new ilTextInputGUI($this->lng->txt('dhparam'), 'dhparam');
        $dhparam->setInfo($this->lng->txt('chat_https_dhparam_info'));
        $dhparam->setRequired(true);
        $https->addSubItem($dhparam);

        $chatLog = new ilTextInputGUI($this->lng->txt('chatroom_log'), 'log');
        $chatLog->setInfo($this->lng->txt('chat_log_info'));
        $chatLog->setRequired(false);
        $form->addItem($chatLog);

        $chatLogLevel = new ilSelectInputGUI($this->lng->txt('chat_log_level'), 'log_level');
        $chatLogLevel->setOptions([
            'emerg' => 'emerg',
            'alert' => 'alert',
            'crit' => 'crit',
            'error' => 'error',
            'warning' => 'warning',
            'notice' => 'notice',
            'info' => 'info',
            'debug' => 'debug',
            'silly' => 'silly',
        ]);
        $form->addItem($chatLogLevel);

        $chatErrorLog = new ilTextInputGUI($this->lng->txt('error_log'), 'error_log');
        $chatErrorLog->setInfo($this->lng->txt('chat_error_log_info'));
        $chatErrorLog->setRequired(false);
        $form->addItem($chatErrorLog);

        $iliasSection = new ilFormSectionHeaderGUI();
        $iliasSection->setTitle($this->lng->txt('ilias_chatserver_connection'));
        $form->addItem($iliasSection);

        $iliasProxy = new ilCheckboxInputGUI($this->lng->txt('proxy'), 'ilias_proxy');
        $iliasProxy->setRequired(false);
        $iliasProxy->setInfo($this->lng->txt('ilias_proxy_info'));
        $form->addItem($iliasProxy);

        $chatServerILIASUrl = new ilTextInputGUI($this->lng->txt('url'), 'ilias_url');
        $chatServerILIASUrl->setRequired(true);
        $chatServerILIASUrl->setInfo($this->lng->txt('connection_url_info'));
        $iliasProxy->addSubItem($chatServerILIASUrl);

        $clientSection = new ilFormSectionHeaderGUI();
        $clientSection->setTitle($this->lng->txt('client_chatserver_connection'));
        $form->addItem($clientSection);

        $clientProxy = new ilCheckboxInputGUI($this->lng->txt('proxy'), 'client_proxy');
        $clientProxy->setRequired(false);
        $clientProxy->setInfo($this->lng->txt('client_proxy_info'));
        $form->addItem($clientProxy);

        $chatServerClientUrl = new ilTextInputGUI($this->lng->txt('url'), 'client_url');
        $chatServerClientUrl->setRequired(true);
        $chatServerClientUrl->setInfo($this->lng->txt('connection_url_info'));
        $clientProxy->addSubItem($chatServerClientUrl);
        
        $deletion_section = new ilFormSectionHeaderGUI();
        $deletion_section->setTitle($this->lng->txt('chat_deletion_section_head'));
        $form->addItem($deletion_section);

        $deletion_options = new ilRadioGroupInputGUI($this->lng->txt('chat_deletion_section_head'), 'deletion_mode');

        $deletion_mode_deactivated = new ilRadioOption($this->lng->txt('chat_deletion_disabled'), 0);
        $deletion_options->addOption($deletion_mode_deactivated);

        $chat_deletion_interval = new ilRadioOption($this->lng->txt('chat_deletion_interval'), 1);
        $chat_deletion_interval->setInfo($this->lng->txt('chat_deletion_interval_info'));
        $interval_unit = new ilSelectInputGUI($this->lng->txt('chat_deletion_interval_unit'), 'deletion_unit');
        $interval_unit->setRequired(true);
        $interval_unit->setOptions(array(
            'days' => $this->lng->txt('days'),
            'weeks' => $this->lng->txt('weeks'),
            'months' => $this->lng->txt('months'),
            'years' => $this->lng->txt('years'),
        ));
        $chat_deletion_interval->addSubItem($interval_unit);

        require_once 'Modules/Chatroom/classes/form/class.ilChatroomMessageDeletionThresholdInputGUI.php';
        $interval_value = new ilChatroomMessageDeletionThresholdInputGUI($this->lng->txt('chat_deletion_interval_value'), 'deletion_value', $interval_unit);
        $interval_value->allowDecimals(false);
        $interval_value->setMinValue(1);
        $interval_value->setRequired(true);
        $chat_deletion_interval->addSubItem($interval_value);

        $runAtTime = new ilTextInputGUI($this->lng->txt('chat_deletion_interval_run_at'), 'deletion_time');
        $runAtTime->setInfo($this->lng->txt('chat_deletion_interval_run_at_info'));
        $runAtTime->setRequired(true);
        $runAtTime->setValidationRegexp('/([01][0-9]|[2][0-3]):[0-5][0-9]/');
        $chat_deletion_interval->addSubItem($runAtTime);

        $deletion_options->addOption($chat_deletion_interval);

        $form->addItem($deletion_options);

        return $form;
    }

Here is the call graph for this function:

getPeriodForm()

ilChatroomFormFactory::getPeriodForm

(

)

Returns period form.

Returns

ilPropertyFormGUI

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

References ilDateDurationInputGUI\setStartText().

    {
        $form = new ilPropertyFormGUI();
        $form->setPreventDoubleSubmission(false);

        require_once 'Services/Form/classes/class.ilDateDurationInputGUI.php';
        $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 215 of file class.ilChatroomFormFactory.php.

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

    {
        $form = new ilPropertyFormGUI();
        $form->setPreventDoubleSubmission(false);
        $list = new ilSelectInputGUI($this->lng->txt('session'), 'session');

        $options = array();

        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

(

)

Returns

ilPropertyFormGUI

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

References $section, $txt, ilFormPropertyGUI\setInfo(), ilDateDurationInputGUI\setShowTime(), and ilCheckboxInputGUI\setValue().

    {
        $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);

        $cb = new ilCheckboxInputGUI($this->lng->txt('allow_anonymous'), 'allow_anonymous');
        $cb->setInfo($this->lng->txt('anonymous_hint'));

        $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('allow_custom_usernames'), 'allow_custom_usernames');
        $form->addItem($cb);

        $cb_history = new ilCheckboxInputGUI($this->lng->txt('enable_history'), 'enable_history');
        $form->addItem($cb_history);

        $num_msg_history = new ilNumberInputGUI($this->lng->txt('display_past_msgs'), 'display_past_msgs');
        $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 = new ilCheckboxInputGUI($this->lng->txt('private_rooms_enabled'), 'private_rooms_enabled');
        $cb->setInfo($this->lng->txt('private_rooms_enabled_info'));
        $form->addItem($cb);

        $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);

        require_once 'Services/Form/classes/class.ilDateDurationInputGUI.php';
        $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);

        return $form;
    }

Here is the call graph for this function:

getUserChatNameSelectionForm()

ilChatroomFormFactory::getUserChatNameSelectionForm

(

array

$name_options

)

Returns chatname selection form.

Parameters

array

$name_options

Returns

ilPropertyFormGUI

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

References $txt, and user().

    {
        $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('custom_username'), 'custom_username_text');
        $custom_opt->addSubItem($txt);
        $form->addItem($radio);

        if ($this->user->isAnonymous()) {
            $radio->setValue('anonymousName');
        } else {
            $radio->setValue('fullname');
        }

        return $form;
    }

Here is the call graph for this function:

Field Documentation

$lng

ilChatroomFormFactory::$lng

protected

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

$user

ilChatroomFormFactory::$user

protected

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

---

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

• Modules/Chatroom/classes/class.ilChatroomFormFactory.php