Collaboration diagram for ilMassMailTaskProcessor:

Public Member Functions
	__construct (private readonly int $anonymous_user_id=ANONYMOUS_USER_ID, ?TaskManager $task_manager=null, ?TaskFactory $task_factory=null, ?ilLanguage $language=null, ?ilLogger $logger=null, ?Container $dic=null, ?ilMailValueObjectJsonService $object_json_service=null)

	run (array $value_objects, int $usr_id, string $context_id, array $context_parameters, int $mails_per_task=100)

Private Member Functions
	runTask (\ILIAS\BackgroundTasks\Task $task, int $usr_id)

	createInteraction (int $usr_id, string $context_id, array $context_parameters, $remaining_objects)

Private Attributes
readonly TaskManager	$task_manager

readonly TaskFactory	$task_factory

readonly ilLanguage	$language

readonly ilLogger	$logger

readonly ilMailValueObjectJsonService	$object_json_service

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilMassMailTaskProcessor::__construct	(	private readonly int	$anonymous_user_id = `ANONYMOUS_USER_ID`,
		?TaskManager	$task_manager = `null`,
		?TaskFactory	$task_factory = `null`,
		?ilLanguage	$language = `null`,
		?ilLogger	$logger = `null`,
		?Container	$dic = `null`,
		?ilMailValueObjectJsonService	$object_json_service = `null`
	)

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

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

       {
         if ($dic === null) {
             global $DIC;
             $dic = $DIC;
         }
 
         $this->task_manager = $task_manager ?? $dic->backgroundTasks()->taskManager();
         $this->task_factory = $task_factory ?? $dic->backgroundTasks()->taskFactory();
         $this->language = $language ?? $dic->language();
         $this->logger = $logger ?? ilLoggerFactory::getLogger('mail');
         $this->object_json_service = $object_json_service ?? new ilMailValueObjectJsonService();
     }

Here is the call graph for this function:

Member Function Documentation

◆ createInteraction()

ilMassMailTaskProcessor::createInteraction	(	int	$usr_id,
		string	$context_id,
		array	$context_parameters,
			$remaining_objects
	)

private

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

Referenced by run().

      : ILIAS\BackgroundTasks\Task {
         $json_string = $this->object_json_service->convertToJson($remaining_objects);
 
         $task = $this->task_factory->createTask(ilMassMailDeliveryJob::class, [
             $usr_id,
             $json_string,
             $context_id,
             serialize($context_parameters),
         ]);
 
         // 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, $usr_id];
 
         return $this->task_factory->createTask(
             ilMailDeliveryJobUserInteraction::class,
             $parameters
         );
     }

Here is the caller graph for this function:

◆ run()

ilMassMailTaskProcessor::run	(	array	$value_objects,
		int	$usr_id,
		string	$context_id,
		array	$context_parameters,
		int	$mails_per_task = `100`
	)

Parameters

	list<ilMailValueObject>	$value_objects - One MailValueObject = One Task
int	$usr_id	- User ID of the user who executes the background task
string	$context_id	- context ID of the Background task
array	$context_parameters	- context parameters for the background tasks
int	$mails_per_task	- Defines how many mails will be added before a background task is executed

Exceptions

ilMailException

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

References createInteraction(), and runTask().

      : void {
         $num_value_objects = count($value_objects);
 
         if ($num_value_objects <= 0) {
             throw new ilMailException('First parameter must contain at least 1 array element');
         }
 
         if ($mails_per_task <= 0) {
             throw new ilMailException(
                 sprintf(
                     'The mails per task MUST be a positive integer, "%s" given',
                     $mails_per_task
                 )
             );
         }
 
         foreach ($value_objects as $value_object) {
             if (!($value_object instanceof ilMailValueObject)) {
                 throw new ilMailException('Array MUST contain ilMailValueObjects ONLY');
             }
         }
 
         $task_counter = 0;
         $remaining_objects = [];
         foreach ($value_objects as $value_object) {
             $task_counter++;
 
             $remaining_objects[] = $value_object;
             if ($task_counter === $mails_per_task) {
                 $interaction = $this->createInteraction($usr_id, $context_id, $context_parameters, $remaining_objects);
 
                 $this->runTask($interaction, $usr_id);
 
                 $task_counter = 0;
                 $remaining_objects = [];
             }
         }
 
         if ([] !== $remaining_objects) {
             $interaction = $this->createInteraction($usr_id, $context_id, $context_parameters, $remaining_objects);
 
             $this->runTask($interaction, $usr_id);
         }
     }

Here is the call graph for this function:

◆ runTask()

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

private

Definition at line 114 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($usr_id);
 
         $bucket->setTask($task);
         $bucket->setTitle($this->language->txt('mail_bg_task_title'));
 
         $this->logger->info('Delegated delivery to background task');
         $this->task_manager->run($bucket);
     }