ILIAS\User\Settings\NewAccountMail\MailImplementation Class Reference

Inheritance diagram for ILIAS\User\Settings\NewAccountMail\MailImplementation:

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

Public Member Functions
	__construct (private readonly string $lang_code, private readonly string $subject='', private readonly string $body='', private readonly string $salutation_none_specific='', private readonly string $salutation_male='', private readonly string $salutation_female='', private readonly ?string $attachment_rid=null, private readonly ?string $legacy_attachment_filename=null)
	getLangCode ()
	getSubject ()
	getBody ()
	getSalutationNoneSpecific ()
	getSalutationMale ()
	getSalutationFemale ()
	getAttachmentRid ()
	getAttachment (ResourceStorage $irss)
	deleteAttachmentTempFile ()
	toStorage ()
	getLangCode ()
	getSubject ()
	getBody ()
	getSalutationNoneSpecific ()
	getSalutationMale ()
	getSalutationFemale ()
	getAttachment (ResourceStorage $irss)

Private Member Functions
	ensureAttachmentFileExists (ResourceStorage $irss, ResourceIdentification $rid)

Private Attributes
string	$temp_file_path

Detailed Description

Definition at line 26 of file MailImplementation.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Settings\NewAccountMail\MailImplementation::__construct	(	private readonly string	$lang_code,
		private readonly string	$subject = '',
		private readonly string	$body = '',
		private readonly string	$salutation_none_specific = '',
		private readonly string	$salutation_male = '',
		private readonly string	$salutation_female = '',
		private readonly ?string	$attachment_rid = null,
		private readonly ?string	$legacy_attachment_filename = null
	)

Definition at line 29 of file MailImplementation.php.

      {
        $this->temp_file_path = CLIENT_DATA_DIR . '/temp/namas/';
    }

References CLIENT_DATA_DIR.

Member Function Documentation

deleteAttachmentTempFile()

ILIAS\User\Settings\NewAccountMail\MailImplementation::deleteAttachmentTempFile

(

)

Definition at line 109 of file MailImplementation.php.

                                              : void
    {
        if (file_exists($this->temp_file_path . $this->lang_code)) {
            unlink($this->temp_file_path . $this->lang_code);
        }
    }

ensureAttachmentFileExists()

ILIAS\User\Settings\NewAccountMail\MailImplementation::ensureAttachmentFileExists ( ResourceStorage  $irss, ResourceIdentification  $rid  )

private

Definition at line 128 of file MailImplementation.php.

     : void {
        if (file_exists($this->temp_file_path . $this->lang_code)) {
            return;
        }
 
        if (!file_exists($this->temp_file_path)) {
            mkdir($this->temp_file_path);
        }
 
        file_put_contents(
            $this->temp_file_path . $this->lang_code,
            $irss->consume()->stream($rid)->getStream()->getContents()
        );
    }

Referenced by ILIAS\User\Settings\NewAccountMail\MailImplementation\getAttachment().

Here is the caller graph for this function:

getAttachment()

ILIAS\User\Settings\NewAccountMail\MailImplementation::getAttachment

(

ResourceStorage

$irss

)

Implements ILIAS\User\Settings\NewAccountMail\Mail.

Definition at line 77 of file MailImplementation.php.

                                                        : ?array
    {
        if ($this->attachment_rid !== null) {
            $rid = $irss->manage()->find($this->attachment_rid);
            if ($rid === null) {
                return null;
            }
            $this->ensureAttachmentFileExists($irss, $rid);
            return [
                $this->temp_file_path . $this->lang_code,
                $irss->manage()->getCurrentRevision($rid)->getTitle()
            ];
        }
 
        if ($this->legacy_attachment_filename !== null) {
            $path = '/' . implode(
                '/',
                array_map(
                    static fn(string $path_part): string => trim($path_part, '/'),
                    [
                        CLIENT_DATA_DIR . '/ilReg/reg_' . USER_FOLDER_ID,
                        $this->lang_code,
                    ]
                )
            );
 
            return [$path, $this->legacy_attachment_filename];
        }
 
        return null;
    }

References $path, CLIENT_DATA_DIR, ILIAS\User\Settings\NewAccountMail\MailImplementation\ensureAttachmentFileExists(), and USER_FOLDER_ID.

Here is the call graph for this function:

getAttachmentRid()

ILIAS\User\Settings\NewAccountMail\MailImplementation::getAttachmentRid

(

)

Definition at line 72 of file MailImplementation.php.

                                      : ?string
    {
        return $this->attachment_rid;
    }

getBody()

ILIAS\User\Settings\NewAccountMail\MailImplementation::getBody

(

)

Implements ILIAS\User\Settings\NewAccountMail\Mail.

Definition at line 52 of file MailImplementation.php.

                             : string
    {
        return $this->body;
    }

getLangCode()

ILIAS\User\Settings\NewAccountMail\MailImplementation::getLangCode

(

)

Implements ILIAS\User\Settings\NewAccountMail\Mail.

Definition at line 42 of file MailImplementation.php.

                                 : string
    {
        return $this->lang_code;
    }

getSalutationFemale()

ILIAS\User\Settings\NewAccountMail\MailImplementation::getSalutationFemale

(

)

Implements ILIAS\User\Settings\NewAccountMail\Mail.

Definition at line 67 of file MailImplementation.php.

                                         : string
    {
        return $this->salutation_female;
    }

getSalutationMale()

ILIAS\User\Settings\NewAccountMail\MailImplementation::getSalutationMale

(

)

Implements ILIAS\User\Settings\NewAccountMail\Mail.

Definition at line 62 of file MailImplementation.php.

                                       : string
    {
        return $this->salutation_male;
    }

getSalutationNoneSpecific()

ILIAS\User\Settings\NewAccountMail\MailImplementation::getSalutationNoneSpecific

(

)

Implements ILIAS\User\Settings\NewAccountMail\Mail.

Definition at line 57 of file MailImplementation.php.

                                               : string
    {
        return $this->salutation_none_specific;
    }

getSubject()

ILIAS\User\Settings\NewAccountMail\MailImplementation::getSubject

(

)

Implements ILIAS\User\Settings\NewAccountMail\Mail.

Definition at line 47 of file MailImplementation.php.

                                : string
    {
        return $this->subject;
    }

toStorage()

ILIAS\User\Settings\NewAccountMail\MailImplementation::toStorage

(

)

Definition at line 116 of file MailImplementation.php.

                               : array
    {
        return [
            'subject' => [\ilDBConstants::T_TEXT, $this->subject],
            'body' => [\ilDBConstants::T_TEXT, $this->body],
            'sal_f' => [\ilDBConstants::T_TEXT, $this->salutation_female],
            'sal_m' => [\ilDBConstants::T_TEXT, $this->salutation_male],
            'sal_g' => [\ilDBConstants::T_TEXT, $this->salutation_none_specific],
            'att_rid' => [\ilDBConstants::T_TEXT, $this->attachment_rid]
        ];
    }

References ilDBConstants\T_TEXT.

Field Documentation

$temp_file_path

string ILIAS\User\Settings\NewAccountMail\MailImplementation::$temp_file_path

private

Definition at line 28 of file MailImplementation.php.

---

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

• components/ILIAS/User/src/Settings/NewAccountMail/MailImplementation.php