FormMailCodesGUI Class Reference

Class FormMailCodesGUI. More...

Inheritance diagram for FormMailCodesGUI:

Collaboration diagram for FormMailCodesGUI:

Public Member Functions
	__construct ($guiclass)
	getSavedMessages ()
	getMailMessage ()
Public Member Functions inherited from ilPropertyFormGUI
	ilPropertyFormGUI ()
	Constructor.
&	executeCommand ()
	Execute command.
	setTableWidth ($a_width)
	Set table width.
	getTableWidth ()
	get table width
	setMode ($a_mode)
	Set Mode ('std', 'subform').
	getMode ()
	Get Mode ('std', 'subform').
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setTitleIcon ($a_titleicon)
	Set TitleIcon.
	getTitleIcon ()
	Get TitleIcon.
	setDescription ($a_val)
	Set description.
	getDescription ()
	Get description.
	setTopAnchor ($a_val)
	Set top anchor.
	getTopAnchor ()
	Get top anchor.
	setShowTopButtons ($a_val)
	Get show top buttons.
	getShowTopButtons ()
	Set show top buttons.
	addItem ($a_item)
	Add Item (Property, SectionHeader).
	removeItemByPostVar ($a_post_var)
	Remove Item.
	getItemByPostVar ($a_post_var)
	Get Item by POST variable.
	setItems ($a_items)
	Set Items.
	getItems ()
	Get Items.
	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively
	setDisableStandardMessage ($a_val)
	Set disable standard message.
	getDisableStandardMessage ()
	Get disable standard message.
	getHideLabels ()
	Get a value indicating whether the labels should be hidden or not.
	setHideLabels ($a_value=true)
	Set a value indicating whether the labels should be hidden or not.
	setValuesByArray ($a_values, $a_restrict_to_value_keys=false)
	Set form values from an array.
	setValuesByPost ()
	Set form values from POST values.
	checkInput ()
	Check Post Input.
	getInput ($a_post_var, $ensureValidation=true)
	Returns the value of a HTTP-POST variable, identified by the passed id.
	addCustomProperty ($a_title, $a_html, $a_info="", $a_alert="", $a_required=false)
	Add a custom property.
	addCommandButton ($a_cmd, $a_text)
	Add Command button.
	clearCommandButtons ()
	Remove all command buttons.
	getContent ()
	Get Content.
	insertItem ($item, $a_sub_item=false)
	getHTML ()
	Get HTML.
	getFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Get file upload data.
	hasFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Was any file uploaded?
	moveFileUpload ($a_target_directory, $a_field, $a_target_name=null, $a_index=null, $a_sub_index=null)
	Move upload to target directory.
Public Member Functions inherited from ilFormGUI
	ilFormGUI ()
	Constructor.
	setFormAction ($a_formaction)
	Set FormAction.
	getFormAction ()
	Get FormAction.
	setTarget ($a_target)
	Set Target.
	getTarget ()
	Get Target.
	setMultipart ($a_multipart)
	Set Enctype Multipart/Formdata true/false.
	getMultipart ()
	Get Enctype Multipart/Formdata true/false.
	setId ($a_id)
	Set Id.
	getId ()
	Get Id.
	setName ($a_name)
	Set Name.
	getName ()
	Get Name.
	setKeepOpen ($a_keepopen)
	Set Keep Form Tag Open.
	getKeepOpen ()
	Get Keep Form Tag Open.
	setOpenTag ($a_open)
	Enable/Disable Open Form Tag.
	getOpenTag ()
	Get Open Form Tag Enabled.
	setCloseTag ($a_val)
	Set close tag.
	getCloseTag ()
	Get close tag.
	setPreventDoubleSubmission ($a_val)
	Set prevent double submission.
	getPreventDoubleSubmission ()
	Get prevent double submission.

Private Attributes
	$lng
	$guiclass
	$subject
	$messagetype
	$sendtype
	$savedmessages
	$mailmessage
	$savemessage
	$savemessagetitle

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	keepFileUpload ($a_hash, $a_field, $a_tmp_name, $a_name, $a_type, $a_index=null, $a_sub_index=null)
	Import upload into temp directory.
	rebuildUploadedFiles ()
	try to rebuild files
Protected Attributes inherited from ilPropertyFormGUI
	$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
	$reloaded_files
	$hide_labels = false

Detailed Description

Class FormMailCodesGUI.

Author

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

Version

$Id$

Definition at line 37 of file FormMailCodesGUI.php.

Constructor & Destructor Documentation

FormMailCodesGUI::__construct

(

$guiclass

)

Definition at line 49 of file FormMailCodesGUI.php.

References $_GET, $guiclass, $ilUser, $lng, $options, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilRadioGroupInputGUI\addOption(), ilFormGUI\setFormAction(), ilSelectInputGUI\setOptions(), ilFormPropertyGUI\setRequired(), ilTextInputGUI\setSize(), and ilPropertyFormGUI\setTitle().

        {
                parent::__construct();

                global $lng;
                global $ilAccess;
                
                $this->lng = &$lng;
                $this->guiclass = &$guiclass;
                
                $this->setFormAction($guiclass->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->object->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) array_push($existingcolumns, '[' . $key . ']');
                        }
                }

                global $ilUser;
                $settings = $this->guiclass->object->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'), join($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", "", $_GET["ref_id"])) $this->addCommandButton("deleteSavedMessage", $this->lng->txt("delete_saved_message"));
                        if ($ilAccess->checkAccess("write", "", $_GET["ref_id"])) $this->addCommandButton("insertSavedMessage", $this->lng->txt("insert_saved_message"));
                }
                if ($ilAccess->checkAccess("write", "", $_GET["ref_id"])) $this->addCommandButton("sendCodesMail", $this->lng->txt("send"));
        }

Here is the call graph for this function:

Member Function Documentation

FormMailCodesGUI::getMailMessage

(

)

Definition at line 130 of file FormMailCodesGUI.php.

References $mailmessage.

        {
                return $this->mailmessage;
        }

FormMailCodesGUI::getSavedMessages

(

)

Definition at line 125 of file FormMailCodesGUI.php.

References $savedmessages.

        {
                return $this->savedmessages;
        }

Field Documentation

FormMailCodesGUI::$guiclass

private

Definition at line 40 of file FormMailCodesGUI.php.

Referenced by __construct().

FormMailCodesGUI::$lng

private

Definition at line 39 of file FormMailCodesGUI.php.

Referenced by __construct().

FormMailCodesGUI::$mailmessage

private

Definition at line 45 of file FormMailCodesGUI.php.

Referenced by getMailMessage().

FormMailCodesGUI::$messagetype

private

Definition at line 42 of file FormMailCodesGUI.php.

FormMailCodesGUI::$savedmessages

private

Definition at line 44 of file FormMailCodesGUI.php.

Referenced by getSavedMessages().

FormMailCodesGUI::$savemessage

private

Definition at line 46 of file FormMailCodesGUI.php.

FormMailCodesGUI::$savemessagetitle

private

Definition at line 47 of file FormMailCodesGUI.php.

FormMailCodesGUI::$sendtype

private

Definition at line 43 of file FormMailCodesGUI.php.

FormMailCodesGUI::$subject

private

Definition at line 41 of file FormMailCodesGUI.php.

---

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

• Modules/Survey/classes/forms/FormMailCodesGUI.php