ILIAS\User\Settings\NewAccountMail\SettingsGUI Class Reference

@ilCtrl_Calls ILIAS\User\Settings\NewAccountMail\SettingsGUI: ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI More...

Collaboration diagram for ILIAS\User\Settings\NewAccountMail\SettingsGUI:

Public Member Functions
	__construct (private readonly \ilLanguage $lng, private readonly \ilCtrl $ctrl, private readonly \ilAccess $access, private readonly \ilGlobalTemplateInterface $tpl, private readonly TemplateEngineFactoryInterface $mail_template_engine_factory, private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private readonly Refinery $refinery, private readonly ServerRequestInterface $request, private readonly ResourceStorage $irss, private readonly Repository $account_mail_repo)
	executeCommand ()

Private Member Functions
	showCmd (?StandardForm $form=null)
	saveCmd ()
	buildForm ()
	buildValidateMailBodyConstraint ()
	buildConvertCurlyBracesTrafo ()
	convertCurlyBracesForFormOutput (string $value)

Private Attributes
readonly UploadHandlerGUI	$upload_handler_gui
readonly Stakeholder	$stakeholder

Detailed Description

@ilCtrl_Calls ILIAS\User\Settings\NewAccountMail\SettingsGUI: ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI

Definition at line 37 of file class.SettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Settings\NewAccountMail\SettingsGUI::__construct	(	private readonly \ilLanguage	$lng,
		private readonly \ilCtrl	$ctrl,
		private readonly \ilAccess	$access,
		private readonly \ilGlobalTemplateInterface	$tpl,
		private readonly TemplateEngineFactoryInterface	$mail_template_engine_factory,
		private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private readonly Refinery	$refinery,
		private readonly ServerRequestInterface	$request,
		private readonly ResourceStorage	$irss,
		private readonly Repository	$account_mail_repo
	)

Definition at line 44 of file class.SettingsGUI.php.

      {
        $this->stakeholder = new Stakeholder();
        $this->upload_handler_gui = new UploadHandlerGUI(
            $this->irss,
            $this->stakeholder
        );
    }

Member Function Documentation

buildConvertCurlyBracesTrafo()

ILIAS\User\Settings\NewAccountMail\SettingsGUI::buildConvertCurlyBracesTrafo ( )

private

Definition at line 218 of file class.SettingsGUI.php.

                                                   : Transformation
    {
        return $this->refinery->custom()->transformation(
            static fn(string $v) => str_replace(['{{', '}}'], ['{{', '}}'], $v)
        );
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

buildForm()

ILIAS\User\Settings\NewAccountMail\SettingsGUI::buildForm ( )

private

Definition at line 150 of file class.SettingsGUI.php.

                                : StandardForm
    {
        $ff = $this->ui_factory->input()->field();
        $inputs = [];
        foreach ($this->lng->getInstalledLanguages() as $lang_code) {
            $account_mail = $this->account_mail_repo->getFor($lang_code);
 
            $title = $this->lng->txt('meta_l_' . $lang_code);
            if ($lang_code === $this->lng->getDefaultLanguage()) {
                $title .= ' (' . $this->lng->txt('default') . ')';
            }
 
            $inputs[$lang_code] = $ff->section(
                [
                    'subject' => $ff->text($this->lng->txt('subject'))
                        ->withAdditionalTransformation(
                            $this->buildConvertCurlyBracesTrafo()
                        )->withAdditionalTransformation(
                            $this->buildValidateMailBodyConstraint()
                        )->withValue($this->convertCurlyBracesForFormOutput($account_mail->getSubject())),
                    'salutation_none_specific' => $ff->text($this->lng->txt('mail_salutation_general'))
                        ->withValue($account_mail->getSalutationNoneSpecific()),
                    'salutation_female' => $ff->text($this->lng->txt('mail_salutation_female'))
                        ->withValue($account_mail->getSalutationFemale()),
                    'salutation_male' => $ff->text($this->lng->txt('mail_salutation_male'))
                        ->withValue($account_mail->getSalutationMale()),
                    'body' => $ff->textarea($this->lng->txt('message_content'))
                        ->withAdditionalTransformation(
                            $this->buildConvertCurlyBracesTrafo()
                        )->withAdditionalTransformation(
                            $this->buildValidateMailBodyConstraint()
                        )->withValue($account_mail->getBody()),
                    'attachment' => $ff->file($this->upload_handler_gui, $this->lng->txt('attachment'))
                        ->withValue(
                            $account_mail->getAttachmentRid() === null
                                ? []
                                : [$account_mail->getAttachmentRid()]
                        )
                ],
                $title
            );
        }
 
        return $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getFormActionByClass(self::class, 'save'),
            [$ff->section(
                $inputs,
                $this->lng->txt('user_new_account_mail'),
                $this->lng->txt('user_new_account_mail_desc')
            )]
        );
    }

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by ILIAS\User\Settings\NewAccountMail\SettingsGUI\saveCmd(), and ILIAS\User\Settings\NewAccountMail\SettingsGUI\showCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

buildValidateMailBodyConstraint()

ILIAS\User\Settings\NewAccountMail\SettingsGUI::buildValidateMailBodyConstraint ( )

private

Definition at line 203 of file class.SettingsGUI.php.

                                                      : Constraint
    {
        return $this->refinery->custom()->constraint(
            function ($v): bool {
                try {
                    $this->mail_template_engine_factory->getBasicEngine()->render($v, []);
                    return true;
                } catch (\Exception) {
                    return false;
                }
            },
            $this->lng->txt('mail_template_invalid_tpl_syntax')
        );
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

convertCurlyBracesForFormOutput()

ILIAS\User\Settings\NewAccountMail\SettingsGUI::convertCurlyBracesForFormOutput ( string  $value )

private

Definition at line 225 of file class.SettingsGUI.php.

                                                                   : string
    {
        return str_replace(['{{', '}}'], ['{{', '}}'], $value);
    }

executeCommand()

ILIAS\User\Settings\NewAccountMail\SettingsGUI::executeCommand

(

)

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

                                    : void
    {
        $this->redirectOnMissingWrite($this->access, $this->ctrl, $this->tpl, $this->lng);
        if ($this->ctrl->getNextClass() === strtolower(UploadHandlerGUI::class)) {
            $this->ctrl->forwardCommand($this->upload_handler_gui);
            return;
        }
        $cmd = $this->ctrl->getCmd() . 'Cmd';
        $this->$cmd();
    }

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

saveCmd()

ILIAS\User\Settings\NewAccountMail\SettingsGUI::saveCmd ( )

private

Definition at line 106 of file class.SettingsGUI.php.

                              : void
    {
        $form = $this->buildForm()->withRequest($this->request);
        $data = $form ->getData();
        if ($data === null) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            $this->showCmd($form);
            return;
        }
 
        foreach ($data[0] as $lang_code => $new_account_mail) {
            $old_account_mail = $this->account_mail_repo->getFor($lang_code);
 
            $new_attachment_rid = $new_account_mail['attachment'] === []
                ? null
                : $new_account_mail['attachment'][0];
 
            if ($old_account_mail->getAttachmentRid() !== null
                && $old_account_mail->getAttachmentRid() !== $new_attachment_rid
                && ($rid = $this->irss->manage()->find($old_account_mail->getAttachmentRid())) !== null) {
                $this->irss->manage()->remove(
                    $rid,
                    $this->stakeholder
                );
                $old_account_mail->deleteAttachmentTempFile();
            }
 
            $this->account_mail_repo->store(
                new MailImplementation(
                    $lang_code,
                    trim($new_account_mail['subject']),
                    trim($new_account_mail['body']),
                    trim($new_account_mail['salutation_none_specific']),
                    trim($new_account_mail['salutation_male']),
                    trim($new_account_mail['salutation_female']),
                    $new_attachment_rid
                )
            );
        }
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
        $this->showCmd();
    }

References $data, ILIAS\User\Settings\NewAccountMail\SettingsGUI\buildForm(), ILIAS\Repository\lng(), and ILIAS\User\Settings\NewAccountMail\SettingsGUI\showCmd().

Here is the call graph for this function:

showCmd()

ILIAS\User\Settings\NewAccountMail\SettingsGUI::showCmd ( ?StandardForm  $form = null )

private

Definition at line 75 of file class.SettingsGUI.php.

                                                        : void
    {
        $content = [
            $form ?? $this->buildForm(),
            $this->ui_factory->panel()->standard(
                $this->lng->txt('mail_nacc_use_placeholder'),
                $this->ui_factory->listing()->characteristicValue()->text([
                    '{{MAIL_SALUTATION}}' => $this->lng->txt('mail_nacc_salutation'),
                    '{{FIRST_NAME}}' => $this->lng->txt('firstname'),
                    '{{LAST_NAME}}' => $this->lng->txt('lastname'),
                    '{{EMAIL}}' => $this->lng->txt('email'),
                    '{{LOGIN}}' => $this->lng->txt('mail_nacc_login'),
                    '{{PASSWORD}}' => $this->lng->txt('password'),
                    '{{#IF_PASSWORD}}...{{/IF_PASSWORD}}' => $this->lng->txt('mail_nacc_pw_block'),
                    '{{#IF_NO_PASSWORD}}...{{/IF_NO_PASSWORD}}' => $this->lng->txt('mail_nacc_no_pw_block'),
                    '{{ADMIN_MAIL}}' => $this->lng->txt('mail_nacc_admin_mail'),
                    '{{ILIAS_URL}}' => $this->lng->txt('mail_nacc_ilias_url'),
                    '{{INSTALLATION_NAME}}' => $this->lng->txt('mail_nacc_installation_name'),
                    '{{TARGET}}' => $this->lng->txt('mail_nacc_target'),
                    '{{TARGET_TITLE}}' => $this->lng->txt('mail_nacc_target_title'),
                    '{{TARGET_TYPE}}' => $this->lng->txt('mail_nacc_target_type'),
                    '{{#IF_TARGET}}...{{/IF_TARGET}}' => $this->lng->txt('mail_nacc_target_block'),
                    '{{#IF_TIMELIMIT}}...{{/IF_TIMELIMIT}}' => $this->lng->txt('mail_nacc_if_timelimit'),
                    '{{TIMELIMIT}}' => $this->lng->txt('mail_nacc_timelimit')
                ])
            )
        ];
 
        $this->tpl->setContent($this->ui_renderer->render($content));
    }

References ILIAS\User\Settings\NewAccountMail\SettingsGUI\buildForm(), and ILIAS\Repository\lng().

Referenced by ILIAS\User\Settings\NewAccountMail\SettingsGUI\saveCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$stakeholder

readonly Stakeholder ILIAS\User\Settings\NewAccountMail\SettingsGUI::$stakeholder

private

Definition at line 42 of file class.SettingsGUI.php.

$upload_handler_gui

readonly UploadHandlerGUI ILIAS\User\Settings\NewAccountMail\SettingsGUI::$upload_handler_gui

private

Definition at line 41 of file class.SettingsGUI.php.

---

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

• components/ILIAS/User/src/Settings/NewAccountMail/class.SettingsGUI.php