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
	__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 ()
	Get HTML. More...
	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 Attributes
	$guiclass
	$subject
	$sendtype
	$savedmessages
	$mailmessage
	$savemessage
	$savemessagetitle
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

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	hideRequired ($a_type)
	rebuildUploadedFiles ()
	try to rebuild files More...

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

__construct()

FormMailCodesGUI::__construct

(

$guiclass

)

Definition at line 47 of file FormMailCodesGUI.php.

    {
        global $DIC;
 
        parent::__construct();
 
        $ilAccess = $DIC->access();
        $ilSetting =  $DIC->settings();
        $ilUser = $DIC->user();
        $rbacsystem = $DIC->rbac()->system();
 
        $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) {
                    array_push($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'), 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"]) && $rbacsystem->checkAccess('smtp_mail', ilMailGlobalServices::getMailObjectRefId())) {
            if ((int) $ilSetting->get('mail_allow_external')) {
                $this->addCommandButton("sendCodesMail", $this->lng->txt("send"));
            } else {
                ilUtil::sendInfo($lng->txt("cant_send_email_smtp_disabled"));
            }
        } else {
            ilUtil::sendInfo($lng->txt("cannot_send_emails"));
        }
    }

References $_GET, $DIC, $guiclass, $ilSetting, $ilUser, $key, ilPropertyFormGUI\$lng, $options, ilPropertyFormGUI\$settings, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilMailGlobalServices\getMailObjectRefId(), ilUtil\sendInfo(), ilFormGUI\setFormAction(), ilPropertyFormGUI\setTitle(), and sprintf.

Here is the call graph for this function:

Member Function Documentation

getMailMessage()

FormMailCodesGUI::getMailMessage

(

)

Definition at line 143 of file FormMailCodesGUI.php.

    {
        return $this->mailmessage;
    }

References $mailmessage.

getSavedMessages()

FormMailCodesGUI::getSavedMessages

(

)

Definition at line 138 of file FormMailCodesGUI.php.

    {
        return $this->savedmessages;
    }

References $savedmessages.

Field Documentation

$guiclass

FormMailCodesGUI::$guiclass

protected

Definition at line 39 of file FormMailCodesGUI.php.

Referenced by __construct().

$mailmessage

FormMailCodesGUI::$mailmessage

protected

Definition at line 43 of file FormMailCodesGUI.php.

Referenced by getMailMessage().

$savedmessages

FormMailCodesGUI::$savedmessages

protected

Definition at line 42 of file FormMailCodesGUI.php.

Referenced by getSavedMessages().

$savemessage

FormMailCodesGUI::$savemessage

protected

Definition at line 44 of file FormMailCodesGUI.php.

$savemessagetitle

FormMailCodesGUI::$savemessagetitle

protected

Definition at line 45 of file FormMailCodesGUI.php.

$sendtype

FormMailCodesGUI::$sendtype

protected

Definition at line 41 of file FormMailCodesGUI.php.

$subject

FormMailCodesGUI::$subject

protected

Definition at line 40 of file FormMailCodesGUI.php.

---

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

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