ilMassMailTaskProcessor Class Reference

Collaboration diagram for ilMassMailTaskProcessor:

Public Member Functions
	__construct (private readonly int $anonymousUserId=ANONYMOUS_USER_ID, TaskManager $taskManager=null, TaskFactory $taskFactory=null, ilLanguage $language=null, ilLogger $logger=null, Container $dic=null, \ILIAS\Mail\Object\MailPayloadEncoder $payload_encoder=null)
	run (array $mailValueObjects, int $userId, string $contextId, array $contextParameters, int $mailsPerTask=100)

Private Member Functions
	runTask (\ILIAS\BackgroundTasks\Task $task, int $userId)
	createInteraction (int $userId, string $contextId, array $contextParameters, $remainingObjects)

Private Attributes
readonly TaskManager	$taskManager
readonly TaskFactory	$taskFactory
readonly ilLanguage	$language
readonly ilLogger	$logger
readonly ILIAS Mail Object MailPayloadEncoder	$payload_encoder

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMassMailTaskProcessor::__construct	(	private readonly int	$anonymousUserId = ANONYMOUS_USER_ID,
		TaskManager	$taskManager = null,
		TaskFactory	$taskFactory = null,
		ilLanguage	$language = null,
		ilLogger	$logger = null,
		Container	$dic = null,
		\ILIAS\Mail\Object\MailPayloadEncoder	$payload_encoder = null
	)

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

References $DIC, $dic, $language, $logger, $payload_encoder, $taskFactory, $taskManager, ilLoggerFactory\getLogger(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\logger().

      {
        if (null === $dic) {
            global $DIC;
            $dic = $DIC;
        }

        if (null === $taskManager) {
            $taskManager = $dic->backgroundTasks()->taskManager();
        }
        $this->taskManager = $taskManager;

        if (null === $taskFactory) {
            $taskFactory = $dic->backgroundTasks()->taskFactory();
        }
        $this->taskFactory = $taskFactory;

        if (null === $language) {
            $language = $dic->language();
        }
        $this->language = $language;

        if (null === $logger) {
            $logger = ilLoggerFactory::getLogger('mail');
        }
        $this->logger = $logger;

        if ($payload_encoder === null) {
            $payload_encoder = new ILIAS\Mail\Object\Mb3SafeMailEncoder(
                new ILIAS\Mail\Object\PureJsonMailEncoder(
                    new ilMailValueObjectJsonService()
                ),
                new ILIAS\Mail\Transformation\Utf8Mb4Sanitizer()
            );
        }
        $this->payload_encoder = $payload_encoder;
    }

Here is the call graph for this function:

Member Function Documentation

createInteraction()

ilMassMailTaskProcessor::createInteraction ( int  $userId, string  $contextId, array  $contextParameters,   $remainingObjects  )

private

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

Referenced by run().

     : ILIAS\BackgroundTasks\Task {
        $jsonString = $this->payload_encoder->encode($remainingObjects);

        $task = $this->taskFactory->createTask(ilMassMailDeliveryJob::class, [
            $userId,
            $jsonString,
            $contextId,
            serialize($contextParameters),
        ]);

        // Important: Don't return the task (e.g. as an early return for anonymous user id) https://mantis.ilias.de/view.php?id=33618

        $parameters = [$task, $userId];

        return $this->taskFactory->createTask(
            ilMailDeliveryJobUserInteraction::class,
            $parameters
        );
    }

Here is the caller graph for this function:

run()

ilMassMailTaskProcessor::run	(	array	$mailValueObjects,
		int	$userId,
		string	$contextId,
		array	$contextParameters,
		int	$mailsPerTask = 100
	)

Parameters

	ilMailValueObject[]	$mailValueObjects - One MailValueObject = One Task
int	$userId	- User ID of the user who executes the background task
string	$contextId	- context ID of the Background task
array	$contextParameters	- context parameters for the background tasks
int	$mailsPerTask	- Defines how many mails will be added before a background task is executed

Exceptions

ilMailException

Definition at line 87 of file class.ilMassMailTaskProcessor.php.

References createInteraction(), and runTask().

     : void {
        $objectsServiceSize = count($mailValueObjects);

        if ($objectsServiceSize <= 0) {
            throw new ilMailException('First parameter must contain at least 1 array element');
        }

        if ($mailsPerTask <= 0) {
            throw new ilMailException(
                sprintf(
                    'The mails per task MUST be a positive integer, "%s" given',
                    $mailsPerTask
                )
            );
        }

        foreach ($mailValueObjects as $mailValueObject) {
            if (!($mailValueObject instanceof ilMailValueObject)) {
                throw new ilMailException('Array MUST contain ilMailValueObjects ONLY');
            }
        }
        $taskCounter = 0;

        $remainingObjects = [];
        foreach ($mailValueObjects as $mailValueObject) {
            $taskCounter++;

            $remainingObjects[] = $mailValueObject;
            if ($taskCounter === $mailsPerTask) {
                $interaction = $this->createInteraction($userId, $contextId, $contextParameters, $remainingObjects);

                $this->runTask($interaction, $userId);

                $taskCounter = 0;
                $remainingObjects = [];
            }
        }

        if ([] !== $remainingObjects) {
            $interaction = $this->createInteraction($userId, $contextId, $contextParameters, $remainingObjects);

            $this->runTask($interaction, $userId);
        }
    }

Here is the call graph for this function:

runTask()

ilMassMailTaskProcessor::runTask ( \ILIAS\BackgroundTasks\Task  $task, int  $userId  )

private

Definition at line 138 of file class.ilMassMailTaskProcessor.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\logger().

Referenced by run().

                                                                            : void
    {
        $bucket = new BasicBucket();
        $bucket->setUserId($userId);

        $bucket->setTask($task);
        $bucket->setTitle($this->language->txt('mail_bg_task_title'));

        $this->logger->info('Delegated delivery to background task');
        $this->taskManager->run($bucket);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$language

readonly ilLanguage ilMassMailTaskProcessor::$language

private

Definition at line 30 of file class.ilMassMailTaskProcessor.php.

Referenced by __construct().

$logger

readonly ilLogger ilMassMailTaskProcessor::$logger

private

Definition at line 31 of file class.ilMassMailTaskProcessor.php.

Referenced by __construct().

$payload_encoder

readonly ILIAS Mail Object MailPayloadEncoder ilMassMailTaskProcessor::$payload_encoder

private

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

Referenced by __construct().

$taskFactory

readonly TaskFactory ilMassMailTaskProcessor::$taskFactory

private

Definition at line 29 of file class.ilMassMailTaskProcessor.php.

Referenced by __construct().

$taskManager

readonly TaskManager ilMassMailTaskProcessor::$taskManager

private

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

Referenced by __construct().

---

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

• Services/Mail/classes/BackgroundTask/class.ilMassMailTaskProcessor.php