Collaboration diagram for ILIAS\Mail\Attachments\MailAttachments:

Public Member Functions
	isEmpty ()

	isIrss ()

	isLegacy ()

	rcid ()

	legacyFilenames ()

	toDb ()

	toBackgroundTask ()

	stageRcidOrNull ()

Static Public Member Functions
static	empty ()

static	fromIrss (ResourceCollectionIdentification $rcid)

static	fromLegacyFilenames (array $filenames)
	Legacy rows come from unserialize() and may contain non-strings. More...

static	fromDb (?string $raw)

static	fromBackgroundTask (string $serialized)

Data Fields
const string	SERIALIZED_RCID_KEY = '__irss_rcid'

Private Attributes
const string	RCID_PATTERN = '/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/'

Detailed Description

Definition at line 26 of file MailAttachments.php.

Member Function Documentation

◆ empty()

static ILIAS\Mail\Attachments\MailAttachments::empty ( )

static

Definition at line 38 of file MailAttachments.php.

                                  : self
    {
        return new self(null, []);
    }

Referenced by ILIAS\Mail\Attachments\MailAttachments\fromBackgroundTask(), ILIAS\Mail\Attachments\MailAttachments\fromLegacyFilenames(), ILIAS\Notifications\ilNotificationMailHandler\notify(), and ILIAS\EmployeeTalk\Notification\Notification\send().

Here is the caller graph for this function:

◆ fromBackgroundTask()

static ILIAS\Mail\Attachments\MailAttachments::fromBackgroundTask ( string $serialized )

static

Definition at line 99 of file MailAttachments.php.

                                                                 : self
    {
        $parsed = @unserialize($serialized, ['allowed_classes' => false]);
        if (!is_array($parsed)) {
            return self::empty();
        }
 
        if (isset($parsed[self::SERIALIZED_RCID_KEY])) {
            return self::fromIrss(
                new ResourceCollectionIdentification((string) $parsed[self::SERIALIZED_RCID_KEY])
            );
        }
 
        return self::fromLegacyFilenames($parsed);
    }

References ILIAS\Mail\Attachments\MailAttachments\empty(), ILIAS\Mail\Attachments\MailAttachments\fromIrss(), and ILIAS\Mail\Attachments\MailAttachments\fromLegacyFilenames().

Here is the call graph for this function:

◆ fromDb()

static ILIAS\Mail\Attachments\MailAttachments::fromDb ( ?string $raw )

static

Definition at line 70 of file MailAttachments.php.

                                               : ?self
    {
        if ($raw === null || $raw === '') {
            return null;
        }
 
        if (str_starts_with($raw, 'a:')) {
            $unserialized = @unserialize($raw, ['allowed_classes' => false]);
            if (!is_array($unserialized)) {
                return null;
            }
 
            if (isset($unserialized[self::SERIALIZED_RCID_KEY])) {
                return self::fromIrss(
                    new ResourceCollectionIdentification((string) $unserialized[self::SERIALIZED_RCID_KEY])
                );
            }
 
            return self::fromLegacyFilenames($unserialized);
        }
 
        // Very old rows may contain other serialized values (e.g. "N;"), which are no collection
        if (preg_match(self::RCID_PATTERN, $raw) !== 1) {
            return null;
        }
 
        return self::fromIrss(new ResourceCollectionIdentification($raw));
    }

References ILIAS\Mail\Attachments\MailAttachments\fromIrss(), and ILIAS\Mail\Attachments\MailAttachments\fromLegacyFilenames().

Referenced by ILIAS\Mail\Message\MailRecordMapper\normalizeRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromIrss()

static ILIAS\Mail\Attachments\MailAttachments::fromIrss ( ResourceCollectionIdentification $rcid )

static

Definition at line 43 of file MailAttachments.php.

                                                                           : self
    {
        return new self($rcid, []);
    }

Referenced by ILIAS\Mail\Attachments\MailAttachments\fromBackgroundTask(), ILIAS\Mail\Attachments\MailAttachments\fromDb(), and ILIAS\EmployeeTalk\Notification\Notification\send().

Here is the caller graph for this function:

◆ fromLegacyFilenames()

static ILIAS\Mail\Attachments\MailAttachments::fromLegacyFilenames ( array $filenames )

static

Legacy rows come from unserialize() and may contain non-strings.

Those entries are dropped so one bad value does not abort the migration.

Parameters

array<array-key,mixed> $filenames

Definition at line 54 of file MailAttachments.php.

                                                                : self
    {
        $names = [];
        foreach ($filenames as $filename) {
            if (is_string($filename)) {
                $names[] = $filename;
            }
        }
 
        if ($names === []) {
            return self::empty();
        }
 
        return new self(null, $names);
    }

References $filename, and ILIAS\Mail\Attachments\MailAttachments\empty().

Referenced by ILIAS\Mail\Attachments\MailAttachments\fromBackgroundTask(), and ILIAS\Mail\Attachments\MailAttachments\fromDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEmpty()

ILIAS\Mail\Attachments\MailAttachments::isEmpty ( )

Definition at line 115 of file MailAttachments.php.

                             : bool
    {
        return $this->rcid === null && $this->legacy_filenames === [];
    }

References ILIAS\Mail\Attachments\MailAttachments\rcid().

Referenced by ilMailFormGUI\buildFormElements(), ilMail\createQueueSnapshot(), ilMailFolderGUI\getAttachmentHashes(), ilMail\getDeliveryAttachments(), ilMail\irssAttachmentsWereLost(), and ilMail\releaseSourceAttachments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isIrss()

ILIAS\Mail\Attachments\MailAttachments::isIrss ( )

Definition at line 120 of file MailAttachments.php.

                            : bool
    {
        return $this->rcid !== null;
    }

References ILIAS\Mail\Attachments\MailAttachments\rcid().

Referenced by ilMail\createQueueSnapshot(), ilMail\getDeliveryAttachments(), ilMail\irssAttachmentsWereLost(), ILIAS\Mail\Attachments\MailAttachments\legacyFilenames(), ilMail\releaseSourceAttachments(), ilMailAttachmentGUI\showAttachmentsCommand(), ilMailFormGUI\showForm(), ILIAS\Mail\Attachments\MailAttachments\toBackgroundTask(), and ILIAS\Mail\Attachments\MailAttachments\toDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLegacy()

ILIAS\Mail\Attachments\MailAttachments::isLegacy ( )

Definition at line 125 of file MailAttachments.php.

                              : bool
    {
        return $this->rcid === null && $this->legacy_filenames !== [];
    }

References ILIAS\Mail\Attachments\MailAttachments\rcid().

Referenced by ilFileDataMail\migrateLegacyPoolAttachments(), and ilMail\normalizeLegacyAttachments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ legacyFilenames()

ILIAS\Mail\Attachments\MailAttachments::legacyFilenames ( )

Returns: list<string>

Definition at line 142 of file MailAttachments.php.

                                     : array
    {
        if ($this->isIrss()) {
            throw new InvalidArgumentException('Mail attachments are not legacy filenames.');
        }
 
        return $this->legacy_filenames;
    }

References ILIAS\Mail\Attachments\MailAttachments\isIrss().

Referenced by ilFileDataMail\migrateLegacyPoolAttachments(), and ilMail\normalizeLegacyAttachments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rcid()

ILIAS\Mail\Attachments\MailAttachments::rcid ( )

Definition at line 130 of file MailAttachments.php.

                          : ResourceCollectionIdentification
    {
        if ($this->rcid === null) {
            throw new InvalidArgumentException('Mail attachments are not stored in IRSS.');
        }
 
        return $this->rcid;
    }

References ILIAS\Mail\Attachments\MailAttachments\rcid().

Referenced by ilMail\createDeliveryAttachments(), ilMail\createQueueSnapshot(), ILIAS\Mail\Attachments\MailAttachments\isEmpty(), ILIAS\Mail\Attachments\MailAttachments\isIrss(), ILIAS\Mail\Attachments\MailAttachments\isLegacy(), ILIAS\Mail\Attachments\MailAttachments\rcid(), ilMail\releaseSourceAttachments(), ILIAS\Mail\Attachments\MailAttachments\toBackgroundTask(), and ILIAS\Mail\Attachments\MailAttachments\toDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stageRcidOrNull()

ILIAS\Mail\Attachments\MailAttachments::stageRcidOrNull ( )

Definition at line 169 of file MailAttachments.php.

                                     : ?ResourceCollectionIdentification
    {
        return $this->rcid;
    }

◆ toBackgroundTask()

ILIAS\Mail\Attachments\MailAttachments::toBackgroundTask ( )

Definition at line 160 of file MailAttachments.php.

                                      : string
    {
        if ($this->isIrss()) {
            return serialize([self::SERIALIZED_RCID_KEY => $this->rcid->serialize()]);
        }
 
        return serialize($this->legacy_filenames);
    }

References ILIAS\Mail\Attachments\MailAttachments\isIrss(), and ILIAS\Mail\Attachments\MailAttachments\rcid().

Here is the call graph for this function:

◆ toDb()

ILIAS\Mail\Attachments\MailAttachments::toDb ( )

Definition at line 151 of file MailAttachments.php.

                          : string
    {
        if ($this->isIrss()) {
            return $this->rcid->serialize();
        }
 
        return serialize($this->legacy_filenames);
    }

References ILIAS\Mail\Attachments\MailAttachments\isIrss(), and ILIAS\Mail\Attachments\MailAttachments\rcid().

Referenced by ilMail\persistMailAttachmentsColumn().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ RCID_PATTERN

const string ILIAS\Mail\Attachments\MailAttachments::RCID_PATTERN = '/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/'

private

Definition at line 29 of file MailAttachments.php.

◆ SERIALIZED_RCID_KEY

const string ILIAS\Mail\Attachments\MailAttachments::SERIALIZED_RCID_KEY = '__irss_rcid'

Definition at line 28 of file MailAttachments.php.

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

components/ILIAS/Mail/src/Attachments/MailAttachments.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Attributes

Detailed Description

Member Function Documentation

◆ empty()

◆ fromBackgroundTask()

◆ fromDb()

◆ fromIrss()

◆ fromLegacyFilenames()

◆ isEmpty()

◆ isIrss()

◆ isLegacy()

◆ legacyFilenames()

◆ rcid()

◆ stageRcidOrNull()

◆ toBackgroundTask()

◆ toDb()

Field Documentation

◆ RCID_PATTERN

◆ SERIALIZED_RCID_KEY