Inheritance diagram for ilIncomingMailInputGUI:

Collaboration diagram for ilIncomingMailInputGUI:

Public Member Functions
	__construct (string $title='', string $post_var='', bool $free_option_choice=true)

	getOptions ()

	setValueByArray ($a_values)

	checkInput ()

	render ()

	getItemByPostVar (string $a_post_var)

	getSubInputItemsRecursive ()

	isFreeOptionChoice ()

	setFreeOptionChoice (bool $free_option_choice)

Public Member Functions inherited from ilRadioGroupInputGUI
	__construct (string $a_title="", string $a_postvar="")

	addOption (ilRadioOption $a_option)

	getOptions ()

	setValue (string $a_value)

	getValue ()

	setValueByArray (array $a_values)

	checkInput ()

	getInput ()

	insert (ilTemplate $a_tpl)

	render ()

	getItemByPostVar (string $a_post_var)

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

	getFormLabelFor ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

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

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

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

	stripSlashesAddSpaceFallback (string $a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Protected Member Functions
	initializeOptions ()

Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()

	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Protected Attributes
bool	$free_option_choice = true

bool	$options_initialized = false

Protected Attributes inherited from ilRadioGroupInputGUI
array	$options = array()

string	$value = ""

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

Private Member Functions
	addSubOptions ()

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

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilIncomingMailInputGUI::__construct	(	string	$title = `''`,
		string	$post_var = `''`,
		bool	$free_option_choice = `true`
	)

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

References ilFormPropertyGUI\$title, ILIAS\GlobalScreen\Provider\__construct(), and setFreeOptionChoice().

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

Here is the call graph for this function:

Member Function Documentation

◆ addSubOptions()

ilIncomingMailInputGUI::addSubOptions ( )

private

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

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().

                                     : void
     {
         global $DIC;
 
         $incoming_local = new ilRadioOption(
             $DIC->language()->txt('mail_incoming_local'),
             (string) ilMailOptions::INCOMING_LOCAL
         );
         $incoming_local->setDisabled($this->getDisabled());
 
         $incoming_external = new ilRadioOption(
             $DIC->language()->txt('mail_incoming_smtp'),
             (string) ilMailOptions::INCOMING_EMAIL
         );
         $incoming_external->setDisabled($this->getDisabled());
 
         $incoming_both = new ilRadioOption(
             $DIC->language()->txt('mail_incoming_both'),
             (string) ilMailOptions::INCOMING_BOTH
         );
         $incoming_both->setDisabled($this->getDisabled());
 
         $this->addOption($incoming_local);
         $this->addOption($incoming_external);
         $this->addOption($incoming_both);
 
         $incoming_external_address_choice = new ilRadioGroupInputGUI('', 'mail_address_option');
         $incoming_external_address_choice->setDisabled($this->getDisabled());
 
         $sub_mail_opt1 = new ilRadioOption(
             $DIC->language()->txt('mail_first_email'),
             (string) ilMailOptions::FIRST_EMAIL
         );
         $sub_mail_opt1->setDisabled($this->getDisabled());
 
         $sub_mail_opt2 = new ilRadioOption(
             $DIC->language()->txt('mail_second_email'),
             (string) ilMailOptions::SECOND_EMAIL
         );
         $sub_mail_opt2->setDisabled($this->getDisabled());
         $sub_mail_opt3 = new ilRadioOption(
             $DIC->language()->txt('mail_both_email'),
             (string) ilMailOptions::BOTH_EMAIL
         );
         $sub_mail_opt3->setDisabled($this->getDisabled());
 
         $incoming_both_address_choice = new ilRadioGroupInputGUI('', 'mail_address_option_both');
         $incoming_both_address_choice->setDisabled($this->getDisabled());
         $sub_both_opt1 = new ilRadioOption(
             $DIC->language()->txt('mail_first_email'),
             (string) ilMailOptions::FIRST_EMAIL
         );
         $sub_both_opt1->setDisabled($this->getDisabled());
 
         $sub_both_opt2 = new ilRadioOption(
             $DIC->language()->txt('mail_second_email'),
             (string) ilMailOptions::SECOND_EMAIL
         );
         $sub_both_opt2->setDisabled($this->getDisabled());
         $sub_both_opt3 = new ilRadioOption(
             $DIC->language()->txt('mail_both_email'),
             (string) ilMailOptions::BOTH_EMAIL
         );
         $sub_both_opt3->setDisabled($this->getDisabled());
         if ($this->isFreeOptionChoice()) {
             $incoming_external_address_choice->addOption($sub_mail_opt1);
             $incoming_external_address_choice->addOption($sub_mail_opt2);
             $incoming_external_address_choice->addOption($sub_mail_opt3);
             $incoming_both_address_choice->addOption($sub_both_opt1);
             $incoming_both_address_choice->addOption($sub_both_opt2);
             $incoming_both_address_choice->addOption($sub_both_opt3);
 
             $incoming_external->addSubItem($incoming_external_address_choice);
             $incoming_both->addSubItem($incoming_both_address_choice);
         } else {
             $email_info = [];
             if (
                 $DIC->settings()->get('usr_settings_disable_mail_incoming_mail') === '1') {
                 $this->setDisabled(true);
             }
 
             if ($DIC->user()->getEmail() === '') {
                 $sub_mail_opt1->setInfo($DIC->language()->txt('first_email_missing_info'));
                 $sub_mail_opt3->setInfo($DIC->language()->txt('first_email_missing_info'));
                 $sub_both_opt1->setInfo($DIC->language()->txt('first_email_missing_info'));
                 $sub_both_opt3->setInfo($DIC->language()->txt('first_email_missing_info'));
             } else {
                 $email_info[] = $DIC->user()->getEmail();
             }
             if ($DIC->settings()->get('usr_settings_disable_mail_incoming_mail') === '1') {
                 $sub_mail_opt1->setDisabled(true);
                 $sub_mail_opt3->setDisabled(true);
                 $sub_both_opt1->setDisabled(true);
                 $sub_both_opt3->setDisabled(true);
             }
 
             if ($DIC->user()->getSecondEmail() === '') {
                 $sub_mail_opt2->setInfo($DIC->language()->txt('second_email_missing_info'));
                 $sub_mail_opt3->setInfo($DIC->language()->txt('second_email_missing_info'));
                 $sub_both_opt2->setInfo($DIC->language()->txt('second_email_missing_info'));
                 $sub_both_opt3->setInfo($DIC->language()->txt('second_email_missing_info'));
             } else {
                 $email_info[] = $DIC->user()->getSecondEmail();
             }
             if ($DIC->settings()->get('usr_settings_disable_mail_incoming_mail') === '1') {
                 $sub_mail_opt2->setDisabled(true);
                 $sub_mail_opt3->setDisabled(true);
                 $sub_both_opt2->setDisabled(true);
                 $sub_both_opt3->setDisabled(true);
             }
 
             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) {
                 $incoming_external->setInfo($email_info[0]);
                 $incoming_both->setInfo($email_info[0]);
             } else {
                 $incoming_external_address_choice->addOption($sub_mail_opt1);
                 $incoming_external_address_choice->addOption($sub_mail_opt2);
                 $incoming_external_address_choice->addOption($sub_mail_opt3);
 
                 $incoming_both_address_choice->addOption($sub_both_opt1);
                 $incoming_both_address_choice->addOption($sub_both_opt2);
                 $incoming_both_address_choice->addOption($sub_both_opt3);
 
                 $incoming_external->addSubItem($incoming_external_address_choice);
                 $incoming_both->addSubItem($incoming_both_address_choice);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkInput()

ilIncomingMailInputGUI::checkInput ( )

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

References initializeOptions().

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

Here is the call graph for this function:

◆ getItemByPostVar()

ilIncomingMailInputGUI::getItemByPostVar ( string $a_post_var )

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

References initializeOptions().

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

Here is the call graph for this function:

◆ getOptions()

ilIncomingMailInputGUI::getOptions ( )

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

References initializeOptions().

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

Here is the call graph for this function:

◆ getSubInputItemsRecursive()

ilIncomingMailInputGUI::getSubInputItemsRecursive ( )

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

References initializeOptions().

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

Here is the call graph for this function:

◆ initializeOptions()

ilIncomingMailInputGUI::initializeOptions ( )

protected

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

References addSubOptions().

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

                                           : void
     {
         if (!$this->options_initialized) {
             $this->addSubOptions();
             $this->options_initialized = true;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isFreeOptionChoice()

ilIncomingMailInputGUI::isFreeOptionChoice ( )

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

References $free_option_choice.

Referenced by addSubOptions().

                                         : bool
     {
         return $this->free_option_choice;
     }

Here is the caller graph for this function:

◆ render()

ilIncomingMailInputGUI::render ( )

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

References initializeOptions().

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

Here is the call graph for this function:

◆ setFreeOptionChoice()

ilIncomingMailInputGUI::setFreeOptionChoice ( bool $free_option_choice )

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

References $free_option_choice.

Referenced by __construct().

                                                                  : void
     {
         $this->free_option_choice = $free_option_choice;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilIncomingMailInputGUI::setValueByArray ( $a_values )

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

References initializeOptions().

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

Here is the call graph for this function:

Field Documentation

◆ $free_option_choice

bool ilIncomingMailInputGUI::$free_option_choice = true

protected

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

Referenced by isFreeOptionChoice(), and setFreeOptionChoice().

◆ $options_initialized

bool ilIncomingMailInputGUI::$options_initialized = false

protected

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

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

components/ILIAS/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

◆ $free_option_choice

◆ $options_initialized