ilNotificationOSDHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Notifications;

use ILIAS\Notifications\Model\ilNotificationObject;
use ILIAS\Notifications\Model\OSD\ilOSDNotificationObject;
use ILIAS\Notifications\Repository\ilNotificationOSDRepository;
use ILIAS\Data\Clock\ClockInterface;

class ilNotificationOSDHandler extends ilNotificationHandler
{
    private readonly ilNotificationOSDRepository $repo;
    private readonly ClockInterface $clock;

    public function __construct(?ilNotificationOSDRepository $repo = null, ?ClockInterface $clock = null)
    {
        if ($repo === null) {
            $repo = new ilNotificationOSDRepository();
        }
        $this->repo = $repo;

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

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

    public function getOSDNotificationsForUser(
        int $user_id,
        bool $append_osd_id_to_link = true,
        int $max_age_seconds = 0,
        string $type = ''
    ): 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;
    }

    public function deleteStaleNotificationsForUserAndType(int $user_id, string $type): void
    {
        $this->repo->deleteStaleOSDNotificationsForUserAndType($type, $user_id, $this->clock->now()->getTimestamp());
    }

    public function deleteStaleOSDNotificationsForUser(string $provider, int $user_id): void
    {
        $this->repo->deleteStaleOSDNotificationsForUserAndType($provider, $user_id, $this->clock->now()->getTimestamp());
    }

    public function removeOSDNotification(int $notification_osd_id): bool
    {
        return $this->repo->deleteOSDNotificationById($notification_osd_id);
    }

    public function removeOSDNotificationByIdentification(string $provider, string $identification, int $user_id = 0): bool
    {
        return $this->repo->deleteOSDNotificationByIdentification(
            $provider,
            $identification,
            $user_id
        );
    }

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

        return $link;
    }

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