Class ilIncomingMailInputGUI. More...

Inheritance diagram for ilIncomingMailInputGUI:

Collaboration diagram for ilIncomingMailInputGUI:

Public Member Functions

__construct ($title='', $post_var='', $freeOptionChoice=true)

ilIncomingMailInputGUI constructor. More...

getOptions ()

Get Options.

Returns: array Array of RadioOption objects

More...

setValueByArray ($a_values)

Set value by array.

Parameters

array $a_values value array

More...

checkInput ()

Check input, strip slashes etc.set alert, if input is not ok.

Returns: boolean Input ok, true/false

More...

render ()

Insert property html. More...

getItemByPostVar ($a_post_var)

Get item by post var.

Returns: mixed false or item object

More...

getSubInputItemsRecursive ()

returns a flat array of possibly existing subitems recursively

Returns: array

More...

isFreeOptionChoice ()

setFreeOptionChoice ($freeOptionChoice)

Public Member Functions inherited from ilRadioGroupInputGUI

__construct ($a_title="", $a_postvar="")

Constructor. More...

addOption ($a_option)

Add Option. More...

getOptions ()

Get Options. More...

setValue ($a_value)

Set Value. More...

getValue ()

Get Value. More...

setValueByArray ($a_values)

Set value by array. More...

checkInput ()

Check input, strip slashes etc. More...

insert ($a_tpl)

Insert property html. More...

render ()

Insert property html. More...

getItemByPostVar ($a_post_var)

Get item by post var. More...

getTableFilterHTML ()

Get input item HTML to be inserted into table filters. More...

Public Member Functions inherited from ilSubEnabledFormPropertyGUI

addSubItem ($a_item)

Add Subitem. More...

getSubItems ()

Get Subitems. More...

getSubInputItemsRecursive ()

returns a flat array of possibly existing subitems recursively More...

checkSubItemsInput ()

Check SubItems. More...

getSubForm ()

Get sub form html. More...

getItemByPostVar ($a_post_var)

Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI

__construct ($a_title="", $a_postvar="")

Constructor. More...

executeCommand ()

Execute command. More...

getType ()

Get Type. More...

setTitle ($a_title)

Set Title. More...

getTitle ()

Get Title. More...

setPostVar ($a_postvar)

Set Post Variable. More...

getPostVar ()

Get Post Variable. More...

getFieldId ()

Get Post Variable. More...

setInfo ($a_info)

Set Information Text. More...

getInfo ()

Get Information Text. More...

setAlert ($a_alert)

Set Alert Text. More...

getAlert ()

Get Alert Text. More...

setRequired ($a_required)

Set Required. More...

getRequired ()

Get Required. More...

setDisabled ($a_disabled)

Set Disabled. More...

getDisabled ()

Get Disabled. More...

checkInput ()

Check input, strip slashes etc. More...

setParentForm ($a_parentform)

Set Parent Form. More...

getParentForm ()

Get Parent Form. More...

setParent ($a_val)

Set Parent GUI object. More...

getParent ()

Get Parent GUI object. More...

getSubForm ()

Get sub form html. More...

hideSubForm ()

Sub form hidden on init? More...

setHiddenTitle ($a_val)

Set hidden title (for screenreaders) More...

getHiddenTitle ()

Get hidden title. More...

getItemByPostVar ($a_post_var)

Get item by post var. More...

serializeData ()

serialize data More...

unserializeData ($a_data)

unserialize data More...

writeToSession ()

Write to session. More...

clearFromSession ()

Clear session value. More...

readFromSession ()

Read from session. More...

getHiddenTag ($a_post_var, $a_value)

Get hidden tag (used for disabled properties) More...

setMulti ($a_multi, $a_sortable=false, $a_addremove=true)

Set Multi. More...

getMulti ()

Get Multi. More...

setMultiValues (array $a_values)

Set multi values. More...

getMultiValues ()

Get multi values. More...

getContentOutsideFormTag ()

Get content that has to reside outside of the parent form tag, e.g. More...

stripSlashesAddSpaceFallback ($a_str)

Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

getTableFilterHTML ()

Get input item HTML to be inserted into table filters. More...

Protected Member Functions
	initializeOptions ()

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Protected Attributes
	$freeOptionChoice = true

	$optionsInitialized = false

Protected Attributes inherited from ilRadioGroupInputGUI
	$options = array()

	$value

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
	$ctrl

	$lng

	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Private Member Functions
	addSubOptions ()

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Detailed Description

Class ilIncomingMailInputGUI.

Author: Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Definition at line 12 of file class.ilIncomingMailInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilIncomingMailInputGUI::__construct	(	$title = `''`,
		$post_var = `''`,
		$freeOptionChoice = `true`
	)

ilIncomingMailInputGUI constructor.

Parameters

string	$title
string	$post_var
bool	$freeOptionChoice

Definition at line 30 of file class.ilIncomingMailInputGUI.php.

        {
            parent::__construct($title, $post_var);
            $this->setFreeOptionChoice($freeOptionChoice);
        }

References $freeOptionChoice, ilFormPropertyGUI\$title, and setFreeOptionChoice().

Here is the call graph for this function:

Member Function Documentation

◆ addSubOptions()

ilIncomingMailInputGUI::addSubOptions ( )

private

Definition at line 120 of file class.ilIncomingMailInputGUI.php.

        {
            global $DIC;
            
            $incomingLocal = new ilRadioOption($DIC->language()->txt('mail_incoming_local'),
                ilMailOptions::INCOMING_LOCAL);
            $incomingLocal->setDisabled($this->getDisabled());
            
            $incomingExternal = new ilRadioOption($DIC->language()->txt('mail_incoming_smtp'),
                ilMailOptions::INCOMING_EMAIL);
            $incomingExternal->setDisabled($this->getDisabled());
            
            $incomingBoth = new ilRadioOption($DIC->language()->txt('mail_incoming_both'),
                ilMailOptions::INCOMING_BOTH);
            $incomingBoth->setDisabled($this->getDisabled());
            
            $this->addOption($incomingLocal);
            $this->addOption($incomingExternal);
            $this->addOption($incomingBoth);
            
            $incomingExternalAddressChoice = new ilRadioGroupInputGUI('', 'mail_address_option');
            $incomingExternalAddressChoice->setDisabled($this->getDisabled());
            
            $sub_mail_opt1 = new ilRadioOption($DIC->language()->txt('mail_first_email'), ilMailOptions::FIRST_EMAIL);
            $sub_mail_opt1->setDisabled($this->getDisabled());
            
            $sub_mail_opt2 = new ilRadioOption($DIC->language()->txt('mail_second_email'), ilMailOptions::SECOND_EMAIL);
            $sub_mail_opt2->setDisabled($this->getDisabled());
            $sub_mail_opt3 = new ilRadioOption($DIC->language()->txt('mail_both_email'), ilMailOptions::BOTH_EMAIL);
            $sub_mail_opt3->setDisabled($this->getDisabled());
            
            $incomingBothAddressChoice = new ilRadioGroupInputGUI('', 'mail_address_option_both');
            $incomingBothAddressChoice->setDisabled($this->getDisabled());
            $sub_both_opt1 = new ilRadioOption($DIC->language()->txt('mail_first_email'), ilMailOptions::FIRST_EMAIL);
            $sub_both_opt1->setDisabled($this->getDisabled());
            
            $sub_both_opt2 = new ilRadioOption($DIC->language()->txt('mail_second_email'), ilMailOptions::SECOND_EMAIL);
            $sub_both_opt2->setDisabled($this->getDisabled());
            $sub_both_opt3 = new ilRadioOption($DIC->language()->txt('mail_both_email'), ilMailOptions::BOTH_EMAIL);
            $sub_both_opt3->setDisabled($this->getDisabled());
            $email_info = array();
            if (!$this->isFreeOptionChoice()) {
                $email_info = array();
                if (
//                              !strlen(ilObjUser::_lookupEmail($DIC->user()->getId())) ||
                    $DIC->settings()->get('usr_settings_disable_mail_incoming_mail') == '1') {
                    $this->setDisabled(true);
                }
                
                if (!strlen($DIC->user()->getEmail()) || $DIC->settings()->get('usr_settings_disable_mail_incoming_mail') == '1') {
                    $sub_mail_opt1->setDisabled(true);
                    $sub_mail_opt1->setInfo($DIC->language()->txt('first_email_missing_info'));
                    $sub_mail_opt3->setDisabled(true);
                    $sub_mail_opt3->setInfo($DIC->language()->txt('first_email_missing_info'));
                    $sub_both_opt1->setDisabled(true);
                    $sub_both_opt1->setInfo($DIC->language()->txt('first_email_missing_info'));
                    $sub_both_opt3->setDisabled(true);
                    $sub_both_opt3->setInfo($DIC->language()->txt('first_email_missing_info'));
                } else {
                    $email_info[] = $DIC->user()->getEmail();
                }
                
                if (!strlen($DIC->user()->getSecondEmail()) || $DIC->settings()->get('usr_settings_disable_mail_incoming_mail') == '1') {
                    $sub_mail_opt2->setDisabled(true);
                    $sub_mail_opt2->setInfo($DIC->language()->txt('second_email_missing_info'));
                    $sub_mail_opt3->setDisabled(true);
                    $sub_mail_opt3->setInfo($DIC->language()->txt('second_email_missing_info'));
                    $sub_both_opt2->setDisabled(true);
                    $sub_both_opt2->setInfo($DIC->language()->txt('second_email_missing_info'));
                    $sub_both_opt3->setDisabled(true);
                    $sub_both_opt3->setInfo($DIC->language()->txt('second_email_missing_info'));
                } else {
                    $email_info[] = $DIC->user()->getSecondEmail();
                }
                
                if (count($email_info) > 1) {
                    $sub_mail_opt1->setInfo($email_info[0]);
                    $sub_both_opt1->setInfo($email_info[0]);
                    $sub_mail_opt2->setInfo($email_info[1]);
                    $sub_both_opt2->setInfo($email_info[1]);
                    $sub_mail_opt3->setInfo(implode(', ', $email_info));
                    $sub_both_opt3->setInfo(implode(', ', $email_info));
                }
                
                if (count($email_info) == 1) {
                    $incomingExternal->setInfo($email_info[0]);
                    $incomingBoth->setInfo($email_info[0]);
                } else {
                    $incomingExternalAddressChoice->addOption($sub_mail_opt1);
                    $incomingExternalAddressChoice->addOption($sub_mail_opt2);
                    $incomingExternalAddressChoice->addOption($sub_mail_opt3);
                    
                    $incomingBothAddressChoice->addOption($sub_both_opt1);
                    $incomingBothAddressChoice->addOption($sub_both_opt2);
                    $incomingBothAddressChoice->addOption($sub_both_opt3);
                    
                    $incomingExternal->addSubItem($incomingExternalAddressChoice);
                    $incomingBoth->addSubItem($incomingBothAddressChoice);
                }
            } else {
                $incomingExternalAddressChoice->addOption($sub_mail_opt1);
                $incomingExternalAddressChoice->addOption($sub_mail_opt2);
                $incomingExternalAddressChoice->addOption($sub_mail_opt3);
                $incomingBothAddressChoice->addOption($sub_both_opt1);
                $incomingBothAddressChoice->addOption($sub_both_opt2);
                $incomingBothAddressChoice->addOption($sub_both_opt3);
                
                $incomingExternal->addSubItem($incomingExternalAddressChoice);
                $incomingBoth->addSubItem($incomingBothAddressChoice);
            }
        }

References $DIC, ilRadioGroupInputGUI\addOption(), ilMailOptions\BOTH_EMAIL, ilMailOptions\FIRST_EMAIL, ilFormPropertyGUI\getDisabled(), ilMailOptions\INCOMING_BOTH, ilMailOptions\INCOMING_EMAIL, ilMailOptions\INCOMING_LOCAL, isFreeOptionChoice(), ilMailOptions\SECOND_EMAIL, and ilFormPropertyGUI\setDisabled().

Referenced by initializeOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkInput()

ilIncomingMailInputGUI::checkInput ( )

Check input, strip slashes etc.set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilRadioGroupInputGUI.

Definition at line 68 of file class.ilIncomingMailInputGUI.php.

        {
            $this->initializeOptions();
            return parent::checkInput();
        }

References initializeOptions().

Here is the call graph for this function:

◆ getItemByPostVar()

ilIncomingMailInputGUI::getItemByPostVar ( $a_post_var )

Get item by post var.

Returns: mixed false or item object

Reimplemented from ilRadioGroupInputGUI.

Definition at line 86 of file class.ilIncomingMailInputGUI.php.

        {
            $this->initializeOptions();
            return parent::getItemByPostVar($a_post_var);
        }

References initializeOptions().

Here is the call graph for this function:

◆ getOptions()

ilIncomingMailInputGUI::getOptions ( )

Get Options.

Returns: array Array of RadioOption objects

Reimplemented from ilRadioGroupInputGUI.

Definition at line 50 of file class.ilIncomingMailInputGUI.php.

        {
            $this->initializeOptions();
            return parent::getOptions();
        }

References initializeOptions().

Here is the call graph for this function:

◆ getSubInputItemsRecursive()

ilIncomingMailInputGUI::getSubInputItemsRecursive ( )

returns a flat array of possibly existing subitems recursively

Returns: array

Reimplemented from ilSubEnabledFormPropertyGUI.

Definition at line 95 of file class.ilIncomingMailInputGUI.php.

        {
            $this->initializeOptions();
            return parent::getSubInputItemsRecursive();
        }

References initializeOptions().

Here is the call graph for this function:

◆ initializeOptions()

ilIncomingMailInputGUI::initializeOptions ( )

protected

Definition at line 39 of file class.ilIncomingMailInputGUI.php.

        {
            if (!$this->optionsInitialized) {
                $this->addSubOptions();
                $this->optionsInitialized = true;
            }
        }

References addSubOptions().

Referenced by checkInput(), getItemByPostVar(), getOptions(), getSubInputItemsRecursive(), render(), and setValueByArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isFreeOptionChoice()

ilIncomingMailInputGUI::isFreeOptionChoice ( )

Returns: bool

Definition at line 104 of file class.ilIncomingMailInputGUI.php.

        {
            return $this->freeOptionChoice;
        }

References $freeOptionChoice.

Referenced by addSubOptions().

Here is the caller graph for this function:

◆ render()

ilIncomingMailInputGUI::render ( )

Insert property html.

Reimplemented from ilRadioGroupInputGUI.

Definition at line 77 of file class.ilIncomingMailInputGUI.php.

        {
            $this->initializeOptions();
            return parent::render();
        }

References initializeOptions().

Here is the call graph for this function:

◆ setFreeOptionChoice()

ilIncomingMailInputGUI::setFreeOptionChoice ( $freeOptionChoice )

Parameters

bool $freeOptionChoice

Definition at line 112 of file class.ilIncomingMailInputGUI.php.

        {
            $this->freeOptionChoice = $freeOptionChoice;
        }

References $freeOptionChoice.

Referenced by __construct().

Here is the caller graph for this function:

◆ setValueByArray()

ilIncomingMailInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Reimplemented from ilRadioGroupInputGUI.

Definition at line 59 of file class.ilIncomingMailInputGUI.php.

        {
            $this->initializeOptions();
            parent::setValueByArray($a_values);
        }

References initializeOptions().

Here is the call graph for this function:

Field Documentation

◆ $freeOptionChoice

ilIncomingMailInputGUI::$freeOptionChoice = true

protected

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

Referenced by __construct(), isFreeOptionChoice(), and setFreeOptionChoice().

◆ $optionsInitialized

ilIncomingMailInputGUI::$optionsInitialized = false

protected

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

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

Services/Mail/classes/Form/class.ilIncomingMailInputGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addSubOptions()

◆ checkInput()

◆ getItemByPostVar()

◆ getOptions()

◆ getSubInputItemsRecursive()

◆ initializeOptions()

◆ isFreeOptionChoice()

◆ render()

◆ setFreeOptionChoice()

◆ setValueByArray()

Field Documentation

◆ $freeOptionChoice

◆ $optionsInitialized