FormMailCodesGUI Class Reference

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

Inheritance diagram for FormMailCodesGUI:

Collaboration diagram for FormMailCodesGUI:

Public Member Functions
	__construct (ilSurveyParticipantsGUI $guiclass)
	getSavedMessages ()
	getMailMessage ()
Public Member Functions inherited from ilPropertyFormGUI
	__construct ()
	executeCommand ()
	setTableWidth (string $a_width)
	getTableWidth ()
	setMode (string $a_mode)
	getMode ()
	setTitle (string $a_title)
	getTitle ()
	setTitleIcon (string $a_titleicon)
	getTitleIcon ()
	setDescription (string $a_val)
	getDescription ()
	setTopAnchor (string $a_val)
	getTopAnchor ()
	setShowTopButtons (bool $a_val)
	getShowTopButtons ()
	setForceTopButtons (bool $a_val)
	getForceTopButtons ()
	addItem ($a_item)
	removeItemByPostVar (string $a_post_var, bool $a_remove_unused_headers=false)
	getItemByPostVar (string $a_post_var)
	setItems (array $a_items)
	getItems ()
	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...
	setDisableStandardMessage (bool $a_val)
	getDisableStandardMessage ()
	getHideLabels ()
	setHideLabels (bool $a_value=true)
	setValuesByArray (array $a_values, bool $a_restrict_to_value_keys=false)
	setValuesByPost ()
	checkInput ()
	getInput (string $a_post_var, bool $ensureValidation=true)
	Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-POST variable, identified by the passed postvar. More...
	addCommandButton (string $a_cmd, string $a_text, string $a_id="")
	getCommandButtons ()
	clearCommandButtons ()
	getContent ()
	insertItem ( $item, bool $a_sub_item=false)
	addAsyncOnloadCode (string $code)
	getHTML ()
	getHTMLAsync ()
	getFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
	Get file upload data. More...
	hasFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
	moveFileUpload (string $a_target_directory, string $a_field, ?string $a_target_name=null, ?string $a_index=null, ?string $a_sub_index=null)
	Move upload to target directory. More...
Public Member Functions inherited from ilFormGUI
	setFormAction (string $a_formaction)
	getFormAction ()
	setTarget (string $a_target)
	getTarget ()
	setMultipart (bool $a_multipart)
	getMultipart ()
	setId (string $a_id)
	getId ()
	setName (string $a_name)
	getName ()
	setKeepOpen (bool $a_keepopen)
	getKeepOpen ()
	setOpenTag (bool $a_open)
	getOpenTag ()
	setCloseTag (bool $a_val)
	getCloseTag ()
	setPreventDoubleSubmission (bool $a_val)
	getPreventDoubleSubmission ()
	getHTML ()
	getContent ()

Protected Attributes
ILIAS Survey Editing EditingGUIRequest	$request
ilSurveyParticipantsGUI	$guiclass
ilTextInputGUI	$subject
ilRadioGroupInputGUI	$sendtype
ilSelectInputGUI	$savedmessages
ilTextAreaInputGUI	$mailmessage
ilCheckboxInputGUI	$savemessage
ilTextInputGUI	$savemessagetitle
Protected Attributes inherited from ilPropertyFormGUI
bool	$required_text = false
ilLanguage	$lng
ilCtrl	$ctrl
ilTemplate	$tpl
ilObjUser	$user = null
ilSetting	$settings = null
string	$mode = "std"
bool	$check_input_called = false
bool	$disable_standard_message = false
string	$top_anchor = "il_form_top"
string	$title = ''
string	$titleicon = ""
string	$description = ""
string	$tbl_width = ""
bool	$show_top_buttons = true
bool	$hide_labels = false
bool	$force_top_buttons = false
HTTP Services	$http
Refinery Factory	$refinery = null
ilGlobalTemplateInterface	$global_tpl = null
	$onload_code = []
Protected Attributes inherited from ilFormGUI
string	$formaction = ""
bool	$multipart = false
bool	$keepopen = false
bool	$opentag = true
string	$id = ''
string	$name = ''
string	$target = ''
bool	$prevent_double_submission = false

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()
	getFileHash ()
	hideRequired (string $a_type)
	appendOnloadCode (string $html)
	rebuildUploadedFiles ()
	checkForRequiredField ()

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 Class FormMailCodesGUI

Author

Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Definition at line 24 of file FormMailCodesGUI.php.

Constructor & Destructor Documentation

__construct()

FormMailCodesGUI::__construct

(

ilSurveyParticipantsGUI

$guiclass

)

Definition at line 35 of file FormMailCodesGUI.php.

      {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
 
        parent::__construct();
 
        $ilAccess = $DIC->access();
        $ilSetting = $DIC->settings();
        $ilUser = $DIC->user();
        $this->request = $DIC->survey()
            ->internal()
            ->gui()
            ->editing()
            ->request();
 
        $lng = $this->lng;
 
        $this->guiclass = $guiclass;
 
        $this->setFormAction($this->ctrl->getFormAction($this->guiclass));
        $this->setTitle($this->lng->txt('compose'));
 
        $this->subject = new ilTextInputGUI($this->lng->txt('subject'), 'm_subject');
        $this->subject->setSize(50);
        $this->subject->setRequired(true);
        $this->addItem($this->subject);
 
        $this->sendtype = new ilRadioGroupInputGUI($this->lng->txt('recipients'), "m_notsent");
        $this->sendtype->addOption(new ilCheckboxOption($this->lng->txt("send_to_all"), 0, ''));
        $this->sendtype->addOption(new ilCheckboxOption($this->lng->txt("not_sent_only"), 1, ''));
        $this->sendtype->addOption(new ilCheckboxOption($this->lng->txt("send_to_unanswered"), 3, ''));
        $this->sendtype->addOption(new ilCheckboxOption($this->lng->txt("send_to_answered"), 2, ''));
        $this->addItem($this->sendtype);
 
        $existingdata = $this->guiclass->getObject()->getExternalCodeRecipients();
 
        $existingcolumns = array();
        if (count($existingdata)) {
            $first = array_shift($existingdata);
            foreach ($first as $key => $value) {
                if (strcmp($key, 'code') !== 0 && strcmp($key, 'email') !== 0 && strcmp($key, 'sent') !== 0) {
                    $existingcolumns[] = '[' . $key . ']';
                }
            }
        }
 
        $settings = $this->guiclass->getObject()->getUserSettings($ilUser->getId(), 'savemessage');
        if (count($settings)) {
            $options = array(0 => $this->lng->txt('please_select'));
            foreach ($settings as $setting) {
                $options[$setting['settings_id']] = $setting['title'];
            }
            $this->savedmessages = new ilSelectInputGUI($this->lng->txt("saved_messages"), "savedmessage");
            $this->savedmessages->setOptions($options);
            $this->addItem($this->savedmessages);
        }
 
        $this->mailmessage = new ilTextAreaInputGUI($this->lng->txt('message_content'), 'm_message');
        $this->mailmessage->setRequired(true);
        $this->mailmessage->setCols(80);
        $this->mailmessage->setRows(10);
        $this->mailmessage->setInfo(sprintf($this->lng->txt('message_content_info'), implode(', ', $existingcolumns)));
        $this->addItem($this->mailmessage);
 
        // save message
        $this->savemessage = new ilCheckboxInputGUI('', "savemessage");
        $this->savemessage->setOptionTitle($this->lng->txt("save_reuse_message"));
        $this->savemessage->setValue(1);
 
        $this->savemessagetitle = new ilTextInputGUI($this->lng->txt('save_reuse_title'), 'savemessagetitle');
        $this->savemessagetitle->setSize(60);
        $this->savemessage->addSubItem($this->savemessagetitle);
 
        $this->addItem($this->savemessage);
 
        if (count($settings)) {
            if ($ilAccess->checkAccess("write", "", $this->request->getRefId())) {
                $this->addCommandButton("deleteSavedMessage", $this->lng->txt("delete_saved_message"));
            }
            if ($ilAccess->checkAccess("write", "", $this->request->getRefId())) {
                $this->addCommandButton("insertSavedMessage", $this->lng->txt("insert_saved_message"));
            }
        }
 
        if ((int) $ilSetting->get('mail_allow_external')) {
            $this->addCommandButton("sendCodesMail", $this->lng->txt("send"));
        } else {
            $main_tpl->setOnScreenMessage('info', $lng->txt("cant_send_email_smtp_disabled"));
        }
    }

References $DIC, $guiclass, $ilSetting, ilPropertyFormGUI\$lng, ilPropertyFormGUI\$settings, ILIAS\GlobalScreen\Provider\__construct(), ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), ilPropertyFormGUI\setTitle(), and ilLanguage\txt().

Here is the call graph for this function:

Member Function Documentation

getMailMessage()

FormMailCodesGUI::getMailMessage

(

)

Definition at line 133 of file FormMailCodesGUI.php.

                                    : ilTextAreaInputGUI
    {
        return $this->mailmessage;
    }

References $mailmessage.

getSavedMessages()

FormMailCodesGUI::getSavedMessages

(

)

Definition at line 128 of file FormMailCodesGUI.php.

                                      : ilSelectInputGUI
    {
        return $this->savedmessages;
    }

References $savedmessages.

Field Documentation

$guiclass

ilSurveyParticipantsGUI FormMailCodesGUI::$guiclass

protected

Definition at line 27 of file FormMailCodesGUI.php.

Referenced by __construct().

$mailmessage

ilTextAreaInputGUI FormMailCodesGUI::$mailmessage

protected

Definition at line 31 of file FormMailCodesGUI.php.

Referenced by getMailMessage().

$request

ILIAS Survey Editing EditingGUIRequest FormMailCodesGUI::$request

protected

Definition at line 26 of file FormMailCodesGUI.php.

$savedmessages

ilSelectInputGUI FormMailCodesGUI::$savedmessages

protected

Definition at line 30 of file FormMailCodesGUI.php.

Referenced by getSavedMessages().

$savemessage

ilCheckboxInputGUI FormMailCodesGUI::$savemessage

protected

Definition at line 32 of file FormMailCodesGUI.php.

$savemessagetitle

ilTextInputGUI FormMailCodesGUI::$savemessagetitle

protected

Definition at line 33 of file FormMailCodesGUI.php.

$sendtype

ilRadioGroupInputGUI FormMailCodesGUI::$sendtype

protected

Definition at line 29 of file FormMailCodesGUI.php.

$subject

ilTextInputGUI FormMailCodesGUI::$subject

protected

Definition at line 28 of file FormMailCodesGUI.php.

---

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

• components/ILIAS/Survey/Mail/FormMailCodesGUI.php