Inheritance diagram for ilMailOptionsFormGUI:

Collaboration diagram for ilMailOptionsFormGUI:

Public Member Functions
	__construct (protected ilMailOptions $options, object $parentGui, protected string $positiveCmd, ?AutoresponderRepository $autoResponderRepository=null)

	save ()

	populate ()

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 Member Functions
	init ()

Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()

	getFileHash ()

	hideRequired (string $a_type)

	appendOnloadCode (string $html)

	rebuildUploadedFiles ()

	checkForRequiredField ()

Protected Attributes
object	$parentGui

AutoResponderRepository	$autoResponderRepository

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

Private Attributes
readonly int	$default_auto_responder_absence_end_ts

Detailed Description

Class ilMailOptionsFormGUI.

Definition at line 28 of file class.ilMailOptionsFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMailOptionsFormGUI::__construct	(	protected ilMailOptions	$options,
		object	$parentGui,
		protected string	$positiveCmd,
		?AutoresponderRepository	$autoResponderRepository = `null`
	)

Definition at line 34 of file class.ilMailOptionsFormGUI.php.

References $DIC, $parentGui, ILIAS\GlobalScreen\Provider\__construct(), and init().

       {
         if (!method_exists($parentGui, 'executeCommand')) {
             throw new InvalidArgumentException(sprintf(
                 'Parameter $parentGui must be ilCtrlInterface enabled by implementing executeCommand(), %s given.',
                 $parentGui::class
             ));
         }
 
         parent::__construct();
         global $DIC;
         $this->parentGui = $parentGui;
         $this->positiveCmd = $positiveCmd;
         $this->autoResponderRepository = $autoResponderRepository ?? new AutoresponderDatabaseRepository($DIC->database());
         $this->default_auto_responder_absence_end_ts = time() + 8640;
 
         $this->init();
     }

Here is the call graph for this function:

Member Function Documentation

◆ init()

ilMailOptionsFormGUI::init ( )

protected

Definition at line 57 of file class.ilMailOptionsFormGUI.php.

References $duration, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), ilTextAreaInputGUI\setRows(), ILIAS\Repository\settings(), and ilPropertyFormGUI\setTitle().

Referenced by __construct().

                              : void
     {
         $this->setTitle($this->lng->txt('mail_settings'));
         $this->setFormAction($this->ctrl->getFormAction($this->parentGui, $this->positiveCmd));
 
         if ($this->options->maySeeIndividualTransportSettings()) {
             $incoming_mail_gui = new ilIncomingMailInputGUI(
                 $this->lng->txt('mail_incoming'),
                 'incoming_type',
                 false
             );
             $this->addItem($incoming_mail_gui);
         }
 
         $absence = new ilCheckboxInputGUI($this->lng->txt('mail_absence_status'), 'absence_status');
         $absence->setInfo($this->lng->txt('mail_absence_status_info'));
         $absence->setValue("1");
         $this->lng->loadLanguageModule('dateplaner');
         $duration = new ilDateDurationInputGUI($this->lng->txt('mail_absence_duration'), 'absence_duration');
         $duration->setRequired(true);
         $duration->setStartText($this->lng->txt('mail_absent_from'));
         $duration->setEndText($this->lng->txt('mail_absent_until'));
         $duration->setShowTime(true);
         $auto_responder_subject = new ilTextInputGUI($this->lng->txt('mail_absence_auto_responder_subject'), 'absence_auto_responder_subject');
         $auto_responder_subject->setMaxLength(200);
         $auto_responder_subject->setRequired(true);
         $auto_responder_body = new ilTextAreaInputGUI($this->lng->txt('mail_absence_auto_responder_body'), 'absence_auto_responder_body');
         $idle_time = (int) $this->settings->get('mail_auto_responder_idle_time', (string) AutoresponderService::AUTO_RESPONDER_DEFAULT_IDLE_TIME);
         if ($idle_time === 1) {
             $auto_responder_body->setInfo($this->lng->txt('mail_absence_auto_responder_body_info_single_day'));
         } else {
             $auto_responder_body->setInfo(sprintf($this->lng->txt('mail_absence_auto_responder_body_info'), $idle_time));
         }
         $auto_responder_body->setRequired(true);
         $auto_responder_body->setCols(60);
         $auto_responder_body->setRows(10);
         $absence->addSubItem($duration);
         $absence->addSubItem($auto_responder_subject);
         $absence->addSubItem($auto_responder_body);
         $this->addItem($absence);
 
         $ta = new ilTextAreaInputGUI($this->lng->txt('signature'), 'signature');
         $ta->setRows(10);
         $ta->setCols(60);
         $this->addItem($ta);
 
         if ($this->settings->get('mail_notification', '0')) {
             $cb = new ilCheckboxInputGUI(
                 $this->lng->txt('cron_mail_notification'),
                 'cronjob_notification'
             );
             $cb->setInfo($this->lng->txt('mail_cronjob_notification_info'));
             $cb->setValue('1');
             $this->addItem($cb);
         }
 
         $this->addCommandButton($this->positiveCmd, $this->lng->txt('save'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populate()

ilMailOptionsFormGUI::populate ( )

Definition at line 164 of file class.ilMailOptionsFormGUI.php.

References $data, $default_auto_responder_absence_end_ts, IL_CAL_DATETIME, IL_CAL_UNIX, and ilPropertyFormGUI\setValuesByArray().

Referenced by ilMailOptionsGUI\showOptions().

                               : void
     {
         $data = [
             'signature' => $this->options->getSignature(),
             'cronjob_notification' => $this->options->isCronJobNotificationEnabled(),
             'absence_status' => $this->options->getAbsenceStatus(),
             'absence_duration' => [
                 'start' => (new ilDateTime(($this->options->getAbsentFrom() ?: time()), IL_CAL_UNIX))->get(IL_CAL_DATETIME),
                 'end' => (new ilDateTime(($this->options->getAbsentUntil() ?: $this->default_auto_responder_absence_end_ts), IL_CAL_UNIX))->get(IL_CAL_DATETIME),
             ],
             'absence_auto_responder_subject' => $this->options->getAbsenceAutoresponderSubject(),
             'absence_auto_responder_body' => $this->options->getAbsenceAutoresponderBody(),
         ];
 
         if ($this->options->maySeeIndividualTransportSettings()) {
             $data['incoming_type'] = $this->options->getIncomingType();
 
             $mail_address_option = $this->options->getEmailAddressMode();
 
             $data['mail_address_option'] = $mail_address_option;
             $data['mail_address_option_both'] = $mail_address_option;
         }
 
         $this->setValuesByArray($data);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilMailOptionsFormGUI::save ( )

Definition at line 116 of file class.ilMailOptionsFormGUI.php.

References ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), IL_CAL_UNIX, ilMailOptions\INCOMING_BOTH, ilMailOptions\INCOMING_EMAIL, ILIAS\Repository\int(), and ILIAS\Repository\user().

Referenced by ilMailOptionsGUI\saveOptions().

                           : bool
     {
         if (!$this->checkInput()) {
             return false;
         }
 
         if ($this->options->mayModifyIndividualTransportSettings()) {
             $incoming_type = (int) $this->getInput('incoming_type');
 
             $mail_address_option = $this->options->getEmailAddressMode();
             switch ($incoming_type) {
                 case ilMailOptions::INCOMING_EMAIL:
                     $mail_address_option = (int) $this->getInput('mail_address_option');
                     break;
 
                 case ilMailOptions::INCOMING_BOTH:
                     $mail_address_option = (int) $this->getInput('mail_address_option_both');
                     break;
             }
         } else {
             $incoming_type = $this->options->getIncomingType();
             $mail_address_option = $this->options->getEmailAddressMode();
         }
 
         $absence_duration = $this->getItemByPostVar('absence_duration');
         $absence_status = (bool) $this->getInput('absence_status');
         $old_absence_status = $this->options->getAbsenceStatus();
         if (!$absence_status && $old_absence_status) {
             $this->autoResponderRepository->deleteBySenderId($this->user->getId());
         }
         $this->options->setAbsenceStatus((bool) $this->getInput('absence_status'));
         if ($absence_duration && $absence_duration->getStart() && $absence_duration->getEnd()) {
             $this->options->setAbsentFrom($absence_duration->getStart()->get(IL_CAL_UNIX));
             $this->options->setAbsentUntil($absence_duration->getEnd()->get(IL_CAL_UNIX));
         }
         $this->options->setAbsenceAutoresponderSubject($this->getInput('absence_auto_responder_subject'));
         $this->options->setAbsenceAutoresponderBody($this->getInput('absence_auto_responder_body'));
 
         $this->options->setSignature($this->getInput('signature'));
         $this->options->setIsCronJobNotificationStatus((bool) $this->getInput('cronjob_notification'));
         $this->options->setIncomingType($incoming_type);
         $this->options->setEmailAddressMode($mail_address_option);
 
         $this->options->updateOptions();
 
         return true;
     }