ILIAS\Notifications\ilNotificationOSDHandler Class Reference

Inheritance diagram for ILIAS\Notifications\ilNotificationOSDHandler:

Collaboration diagram for ILIAS\Notifications\ilNotificationOSDHandler:

Public Member Functions
	__construct (?ilNotificationOSDRepository $repo=null, ?ClockInterface $clock=null)
	notify (ilNotificationObject $notification)
	getOSDNotificationsForUser (int $user_id, bool $append_osd_id_to_link=true, int $max_age_seconds=0, string $type='')
	deleteStaleNotificationsForUserAndType (int $user_id, string $type)
	deleteStaleOSDNotificationsForUser (string $provider, int $user_id)
	removeOSDNotification (int $notification_osd_id)
	removeOSDNotificationByIdentification (string $provider, string $identification, int $user_id=0)
	clear ()
Public Member Functions inherited from ILIAS\Notifications\ilNotificationHandler
	notify (ilNotificationObject $notification)
	showSettings (ilPropertyFormGUI $form)
	clear ()

Private Member Functions
	appendParamToLink (string $link, string $param, int $value)

Private Attributes
readonly ilNotificationOSDRepository	$repo
readonly ClockInterface	$clock

Detailed Description

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Definition at line 31 of file ilNotificationOSDHandler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Notifications\ilNotificationOSDHandler::__construct	(	?ilNotificationOSDRepository	$repo = null,
		?ClockInterface	$clock = null
	)

Definition at line 36 of file ilNotificationOSDHandler.php.

References ILIAS\Notifications\ilNotificationOSDHandler\$clock, ILIAS\Notifications\ilNotificationOSDHandler\$repo, and null.

    {
        if ($repo === null) {
            $repo = new ilNotificationOSDRepository();
        }
        $this->repo = $repo;

        if ($clock === null) {
            $clock = (new \ILIAS\Data\Factory())->clock()->utc();
        }
        $this->clock = $clock;
    }

Member Function Documentation

appendParamToLink()

ILIAS\Notifications\ilNotificationOSDHandler::appendParamToLink ( string  $link, string  $param, int  $value  )

private

Definition at line 103 of file ilNotificationOSDHandler.php.

Referenced by ILIAS\Notifications\ilNotificationOSDHandler\getOSDNotificationsForUser().

                                                                               : string
    {
        if (str_contains($link, '?')) {
            $link .= '&' . $param . '=' . $value;
        } else {
            $link .= '?' . $param . '=' . $value;
        }

        return $link;
    }

Here is the caller graph for this function:

clear()

ILIAS\Notifications\ilNotificationOSDHandler::clear

(

)

Definition at line 114 of file ilNotificationOSDHandler.php.

                           : void
    {
        $this->repo->deleteAllOSDNotifications();
    }

deleteStaleNotificationsForUserAndType()

ILIAS\Notifications\ilNotificationOSDHandler::deleteStaleNotificationsForUserAndType	(	int	$user_id,
		string	$type
	)

Deprecated:

Definition at line 79 of file ilNotificationOSDHandler.php.

                                                                                      : void
    {
        $this->repo->deleteStaleOSDNotificationsForUserAndType($type, $user_id, $this->clock->now()->getTimestamp());
    }

deleteStaleOSDNotificationsForUser()

ILIAS\Notifications\ilNotificationOSDHandler::deleteStaleOSDNotificationsForUser	(	string	$provider,
		int	$user_id
	)

Definition at line 84 of file ilNotificationOSDHandler.php.

                                                                                      : void
    {
        $this->repo->deleteStaleOSDNotificationsForUserAndType($provider, $user_id, $this->clock->now()->getTimestamp());
    }

getOSDNotificationsForUser()

ILIAS\Notifications\ilNotificationOSDHandler::getOSDNotificationsForUser	(	int	$user_id,
		bool	$append_osd_id_to_link = true,
		int	$max_age_seconds = 0,
		string	$type = ''
	)

Returns

list<ilOSDNotificationObject>

Definition at line 57 of file ilNotificationOSDHandler.php.

References ILIAS\Notifications\ilNotificationOSDHandler\appendParamToLink().

     : array {
        $notifications = $this->repo->getOSDNotificationsByUser($user_id, $max_age_seconds, $type);

        foreach ($notifications as $notification) {
            if ($append_osd_id_to_link) {
                foreach ($notification->getObject()->links as $link) {
                    $link->setUrl($this->appendParamToLink($link->getUrl(), 'osd_id', $notification->getId()));
                }
            }
        }

        return $notifications;
    }

Here is the call graph for this function:

notify()

ILIAS\Notifications\ilNotificationOSDHandler::notify

(

ilNotificationObject

$notification

)

Definition at line 49 of file ilNotificationOSDHandler.php.

                                                              : void
    {
        $this->repo->createOSDNotification($notification->user->getId(), $notification);
    }

removeOSDNotification()

ILIAS\Notifications\ilNotificationOSDHandler::removeOSDNotification

(

int

$notification_osd_id

)

Definition at line 89 of file ilNotificationOSDHandler.php.

                                                                   : bool
    {
        return $this->repo->deleteOSDNotificationById($notification_osd_id);
    }

removeOSDNotificationByIdentification()

ILIAS\Notifications\ilNotificationOSDHandler::removeOSDNotificationByIdentification	(	string	$provider,
		string	$identification,
		int	$user_id = 0
	)

Definition at line 94 of file ilNotificationOSDHandler.php.

References $user_id.

                                                                                                                     : bool
    {
        return $this->repo->deleteOSDNotificationByIdentification(
            $provider,
            $identification,
            $user_id
        );
    }

Field Documentation

$clock

readonly ClockInterface ILIAS\Notifications\ilNotificationOSDHandler::$clock

private

Definition at line 34 of file ilNotificationOSDHandler.php.

Referenced by ILIAS\Notifications\ilNotificationOSDHandler\__construct().

$repo

readonly ilNotificationOSDRepository ILIAS\Notifications\ilNotificationOSDHandler::$repo

private

Definition at line 33 of file ilNotificationOSDHandler.php.

Referenced by ILIAS\Notifications\ilNotificationOSDHandler\__construct().

---

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

• components/ILIAS/Notifications/classes/ilNotificationOSDHandler.php