Collaboration diagram for ilMassMailTaskProcessor:

Public Member Functions
	__construct (TaskManager $taskManager=null, TaskFactory $taskFactory=null, ilLanguage $language=null, ilLogger $logger=null, Container $dic=null, ilMailValueObjectJsonService $objectJsonService=null, int $anonymousUserId=ANONYMOUS_USER_ID)

	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
TaskManager	$taskManager

TaskFactory	$taskFactory

ilLanguage	$language

ilLogger	$logger

ilMailValueObjectJsonService	$objectJsonService

int	$anonymousUserId

Detailed Description

Author: Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilMassMailTaskProcessor::__construct	(	TaskManager	$taskManager = `null`,
		TaskFactory	$taskFactory = `null`,
		ilLanguage	$language = `null`,
		ilLogger	$logger = `null`,
		Container	$dic = `null`,
		ilMailValueObjectJsonService	$objectJsonService = `null`,
		int	$anonymousUserId = `ANONYMOUS_USER_ID`
	)

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

      {
        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 (null === $objectJsonService) {
            $objectJsonService = new ilMailValueObjectJsonService();
        }
        $this->objectJsonService = $objectJsonService;
 
        $this->anonymousUserId = $anonymousUserId;
    }

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

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 153 of file class.ilMassMailTaskProcessor.php.

     : ILIAS\BackgroundTasks\Task {
        $jsonString = $this->objectJsonService->convertToJson($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
        );
    }

◆ 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

ilException

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

     : void {
        $objectsServiceSize = count($mailValueObjects);
 
        if ($objectsServiceSize <= 0) {
            throw new ilException('First parameter must contain at least 1 array element');
        }
 
        if ($mailsPerTask <= 0) {
            throw new ilException(
                sprintf(
                    'The mails per task MUST be a positive integer, "%s" given',
                    $mailsPerTask
                )
            );
        }
 
        foreach ($mailValueObjects as $mailValueObject) {
            if (!($mailValueObject instanceof ilMailValueObject)) {
                throw new ilException('Array MUST contain ilMailValueObjects ONLY');
            }
        }
 
        $lastTask = null;
        $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);
        }
    }

◆ runTask()

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

private

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

                                                                            : 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);
    }