Inheritance diagram for ILIAS\Mail\Autoresponder\AutoresponderServiceImpl:

Collaboration diagram for ILIAS\Mail\Autoresponder\AutoresponderServiceImpl:

Public Member Functions
	__construct (int $global_idle_time_interval, private bool $auto_responder_status, private readonly AutoresponderRepository $auto_responder_repository, private readonly ClockInterface $clock, ?callable $mail_action=null)

	isAutoresponderEnabled ()

	enableAutoresponder ()

	disableAutoresponder ()

	handleAutoresponderMails (int $auto_responder_receiver_usr_id)

	enqueueAutoresponderIfEnabled (int $sender_id, ilMailOptions $mail_receiver_options, ilMailOptions $mail_sender_options)

	emptyAutoresponderData ()

Protected Attributes
array	$auto_responder_data = []

Private Member Functions
	normalizeDateTimezone (DateTimeImmutable $date_time)

	shouldSendAutoresponder (AutoresponderDto $auto_responder)

Private Attributes
	$mail_action

readonly DateInterval	$idle_time_interval

Additional Inherited Members
Data Fields inherited from ILIAS\Mail\Autoresponder\AutoresponderService
const int	AUTO_RESPONDER_DEFAULT_IDLE_TIME = 3

Detailed Description

Definition at line 29 of file AutoresponderServiceImpl.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::__construct	(	int	$global_idle_time_interval,
		private bool	$auto_responder_status,
		private readonly AutoresponderRepository	$auto_responder_repository,
		private readonly ClockInterface	$clock,
		?callable	$mail_action = `null`
	)

Parameters

callable(int,ilMailOptions,DateTimeImmutable) void|null $mail_action

Definition at line 41 of file AutoresponderServiceImpl.php.

References ILIAS\Mail\Autoresponder\AutoresponderServiceImpl\$mail_action.

       {
         $this->mail_action = $mail_action;
         $this->idle_time_interval = new DateInterval('P' . $global_idle_time_interval . 'D');
     }

Member Function Documentation

◆ disableAutoresponder()

ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::disableAutoresponder ( )

Implements ILIAS\Mail\Autoresponder\AutoresponderService.

Definition at line 62 of file AutoresponderServiceImpl.php.

                                           : void
     {
         $this->auto_responder_status = false;
     }

◆ emptyAutoresponderData()

ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::emptyAutoresponderData ( )

Implements ILIAS\Mail\Autoresponder\AutoresponderService.

Definition at line 143 of file AutoresponderServiceImpl.php.

                                             : void
     {
         $this->auto_responder_data = [];
     }

◆ enableAutoresponder()

ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::enableAutoresponder ( )

Implements ILIAS\Mail\Autoresponder\AutoresponderService.

Definition at line 57 of file AutoresponderServiceImpl.php.

                                          : void
     {
         $this->auto_responder_status = true;
     }

◆ enqueueAutoresponderIfEnabled()

ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::enqueueAutoresponderIfEnabled	(	int	$sender_id,
		ilMailOptions	$mail_receiver_options,
		ilMailOptions	$mail_sender_options
	)

Implements ILIAS\Mail\Autoresponder\AutoresponderService.

Definition at line 133 of file AutoresponderServiceImpl.php.

References ilMailOptions\isAbsent().

      : void {
         if ($this->auto_responder_status && $mail_receiver_options->isAbsent()) {
             $this->auto_responder_data[$sender_id] = $mail_receiver_options;
         }
     }

Here is the call graph for this function:

◆ handleAutoresponderMails()

ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::handleAutoresponderMails ( int $auto_responder_receiver_usr_id )

Implements ILIAS\Mail\Autoresponder\AutoresponderService.

Definition at line 67 of file AutoresponderServiceImpl.php.

References ILIAS\Mail\Autoresponder\AutoresponderServiceImpl\$mail_action, ILIAS\Mail\Autoresponder\AutoresponderServiceImpl\normalizeDateTimezone(), null, ILIAS\Mail\Autoresponder\AutoresponderNotification\send(), ILIAS\Mail\Autoresponder\AutoresponderServiceImpl\shouldSendAutoresponder(), ILIAS\UI\examples\Menu\Sub\sub(), and ILIAS\Mail\Autoresponder\AutoresponderDto\withSentTime().

                                                                                  : void
     {
         if ($this->auto_responder_data === []) {
             return;
         }
 
         foreach ($this->auto_responder_data as $auto_responder_sender_usr_id => $mail_options) {
             if ($this->auto_responder_repository->exists(
                 $auto_responder_sender_usr_id,
                 $auto_responder_receiver_usr_id
             )) {
                 $auto_responder = $this->auto_responder_repository->findBySenderIdAndReceiverId(
                     $auto_responder_sender_usr_id,
                     $auto_responder_receiver_usr_id
                 );
             } else {
                 $auto_responder = new AutoresponderDto(
                     $auto_responder_sender_usr_id,
                     $auto_responder_receiver_usr_id,
                     $this->normalizeDateTimezone($this->clock->now())
                          ->sub($this->idle_time_interval)
                          ->modify('-1 second')
                 );
             }
 
             if ($this->shouldSendAutoresponder($auto_responder)) {
                 $auto_responder = $auto_responder->withSentTime($this->clock->now());
 
                 if ($this->mail_action !== null) {
                     ($this->mail_action)(
                         $auto_responder_sender_usr_id,
                         $mail_options,
                         $auto_responder->getSentTime()->add($this->idle_time_interval)
                     );
                 } else {
                     $mail = new AutoresponderNotification(
                         $mail_options,
                         $auto_responder_receiver_usr_id,
                         $auto_responder->getSentTime()->add($this->idle_time_interval)
                     );
                     $mail->send();
                 }
 
                 $this->auto_responder_repository->store($auto_responder);
             }
         }
     }

Here is the call graph for this function:

◆ isAutoresponderEnabled()

ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::isAutoresponderEnabled ( )

Implements ILIAS\Mail\Autoresponder\AutoresponderService.

Definition at line 52 of file AutoresponderServiceImpl.php.

                                             : bool
     {
         return $this->auto_responder_status;
     }

◆ normalizeDateTimezone()

ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::normalizeDateTimezone ( DateTimeImmutable $date_time )

private

Definition at line 115 of file AutoresponderServiceImpl.php.

Referenced by ILIAS\Mail\Autoresponder\AutoresponderServiceImpl\handleAutoresponderMails(), and ILIAS\Mail\Autoresponder\AutoresponderServiceImpl\shouldSendAutoresponder().

                                                                         : DateTimeImmutable
     {
         return $date_time->setTimezone(new DateTimeZone('UTC'));
     }

Here is the caller graph for this function:

◆ shouldSendAutoresponder()

ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::shouldSendAutoresponder ( AutoresponderDto $auto_responder )

private

Definition at line 120 of file AutoresponderServiceImpl.php.

References ILIAS\UI\examples\Symbol\Glyph\Add\add(), ILIAS\Mail\Autoresponder\AutoresponderDto\getSentTime(), and ILIAS\Mail\Autoresponder\AutoresponderServiceImpl\normalizeDateTimezone().

Referenced by ILIAS\Mail\Autoresponder\AutoresponderServiceImpl\handleAutoresponderMails().

                                                                               : bool
     {
         // Normalize timezones
         $last_send_time_with_added_interval = $this
             ->normalizeDateTimezone($auto_responder->getSentTime())
             ->add($this->idle_time_interval);
 
         $now = $this->normalizeDateTimezone($this->clock->now());
 
         // Don't compare the objects because of microseconds
         return $last_send_time_with_added_interval->format('Y-m-d H:i:s') <= $now->format('Y-m-d H:i:s');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $auto_responder_data

array ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::$auto_responder_data = []

protected

Definition at line 36 of file AutoresponderServiceImpl.php.

◆ $idle_time_interval

readonly DateInterval ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::$idle_time_interval

private

Definition at line 33 of file AutoresponderServiceImpl.php.

◆ $mail_action

ILIAS\Mail\Autoresponder\AutoresponderServiceImpl::$mail_action

private

Definition at line 32 of file AutoresponderServiceImpl.php.

Referenced by ILIAS\Mail\Autoresponder\AutoresponderServiceImpl\__construct(), and ILIAS\Mail\Autoresponder\AutoresponderServiceImpl\handleAutoresponderMails().

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

components/ILIAS/Mail/classes/Autoresponder/AutoresponderServiceImpl.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ disableAutoresponder()

◆ emptyAutoresponderData()

◆ enableAutoresponder()

◆ enqueueAutoresponderIfEnabled()

◆ handleAutoresponderMails()

◆ isAutoresponderEnabled()

◆ normalizeDateTimezone()

◆ shouldSendAutoresponder()

Field Documentation

◆ $auto_responder_data

◆ $idle_time_interval

◆ $mail_action