ILIAS\Notifications\Repository\ilNotificationOSDRepository Class Reference

Inheritance diagram for ILIAS\Notifications\Repository\ilNotificationOSDRepository:

Collaboration diagram for ILIAS\Notifications\Repository\ilNotificationOSDRepository:

Public Member Functions
	__construct (?ilDBInterface $database=null)
	createOSDNotification (int $user_id, ilNotificationObject $object)
	ifOSDNotificationExistsById (int $id)
	getOSDNotificationsByUser (int $user_id, int $max_age_seconds=0, string $type='')
	deleteOSDNotificationById (int $id)
	deleteOSDNotificationByIdentification (string $povider_type, string $identification, int $user_id=0)
	deleteStaleOSDNotificationsForUserAndType (string $povider_type, int $user_id, int $until_timestamp)
	deleteAllOSDNotifications ()
Public Member Functions inherited from ILIAS\Notifications\Repository\ilNotificationOSDRepositoryInterface
	__construct ()
	getOSDNotificationsByUser (int $user_id)

Private Member Functions
	getCurrentUnixTimestamp ()
	deleteOSDNotificationByUserAndType (int $user_id, string $type)

Private Attributes
const	UNIQUE_TYPES
readonly ilDBInterface	$database

Detailed Description

Author

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

Definition at line 36 of file ilNotificationOSDRepository.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Notifications\Repository\ilNotificationOSDRepository::__construct

(

?ilDBInterface

$database = null

)

Definition at line 44 of file ilNotificationOSDRepository.php.

References ILIAS\Notifications\Repository\ilNotificationOSDRepository\$database, $DIC, and null.

    {
        if ($database === null) {
            global $DIC;
            $database = $DIC->database();
        }
        $this->database = $database;
    }

Member Function Documentation

createOSDNotification()

ILIAS\Notifications\Repository\ilNotificationOSDRepository::createOSDNotification	(	int	$user_id,
		ilNotificationObject	$object
	)

Implements ILIAS\Notifications\Repository\ilNotificationOSDRepositoryInterface.

Definition at line 58 of file ilNotificationOSDRepository.php.

References $id, ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_osd_handler, ILIAS\Notifications\Repository\ilNotificationOSDRepository\deleteOSDNotificationByUserAndType(), ILIAS\Notifications\Repository\ilNotificationOSDRepository\getCurrentUnixTimestamp(), null, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                                                                                     : ?ilOSDNotificationObject
    {
        $id = $this->database->nextId(ilNotificationSetupHelper::$tbl_notification_osd_handler);
        $base = $object->baseNotification;
        $now = $this->getCurrentUnixTimestamp();

        $notification = new ilOSDNotificationObject(
            $id,
            $user_id,
            $object,
            $now,
            $base->getValidForSeconds() ? $base->getValidForSeconds() + $now : 0,
            $base->getVisibleForSeconds(),
            $base->getType(),
            $base->getIdentification()
        );

        if (in_array($notification->getType(), self::UNIQUE_TYPES)) {
            $this->deleteOSDNotificationByUserAndType($user_id, $notification->getType());
        }

        $affected = $this->database->insert(
            ilNotificationSetupHelper::$tbl_notification_osd_handler,
            [
                'notification_osd_id' => [ilDBConstants::T_INTEGER, $notification->getId()],
                'usr_id' => [ilDBConstants::T_INTEGER, $notification->getUser()],
                'serialized' => [ilDBConstants::T_TEXT, serialize($notification->getObject())],
                'valid_until' => [ilDBConstants::T_INTEGER, $notification->getValidUntil()],
                'visible_for' => [ilDBConstants::T_INTEGER, $notification->getVisibleFor()],
                'type' => [ilDBConstants::T_TEXT, $notification->getType()],
                'time_added' => [ilDBConstants::T_INTEGER, $notification->getTimeAdded()],
                'identification' => [ilDBConstants::T_TEXT, (string) $notification->getIdentification()]
            ]
        );

        return ($affected === 1) ? $notification : null;
    }

Here is the call graph for this function:

deleteAllOSDNotifications()

ILIAS\Notifications\Repository\ilNotificationOSDRepository::deleteAllOSDNotifications

(

)

Definition at line 200 of file ilNotificationOSDRepository.php.

References ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_osd_handler.

                                               : void
    {
        $this->database->manipulate('TRUNCATE TABLE ' . ilNotificationSetupHelper::$tbl_notification_osd_handler);
    }

deleteOSDNotificationById()

ILIAS\Notifications\Repository\ilNotificationOSDRepository::deleteOSDNotificationById

(

int

$id

)

Implements ILIAS\Notifications\Repository\ilNotificationOSDRepositoryInterface.

Definition at line 157 of file ilNotificationOSDRepository.php.

References ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_osd_handler, ILIAS\Notifications\Repository\ilNotificationOSDRepository\ifOSDNotificationExistsById(), and ilDBConstants\T_INTEGER.

                                                      : bool
    {
        if ($this->ifOSDNotificationExistsById($id)) {
            $query = 'DELETE FROM ' . ilNotificationSetupHelper::$tbl_notification_osd_handler . ' WHERE notification_osd_id = %s';
            return 1 === $this->database->manipulateF($query, [ilDBConstants::T_INTEGER], [$id]);
        }

        return false;
    }

Here is the call graph for this function:

deleteOSDNotificationByIdentification()

ILIAS\Notifications\Repository\ilNotificationOSDRepository::deleteOSDNotificationByIdentification	(	string	$povider_type,
		string	$identification,
		int	$user_id = 0
	)

Definition at line 177 of file ilNotificationOSDRepository.php.

References ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_osd_handler, $user_id, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                                                                                                                         : bool
    {
        $query = 'DELETE FROM ' . ilNotificationSetupHelper::$tbl_notification_osd_handler . ' WHERE type = %s AND identification = %s';
        $keys = [ilDBConstants::T_TEXT, ilDBConstants::T_TEXT];
        $values = [$povider_type, $identification];
        if ($user_id > 0) {
            $query .= ' AND user_id = %s';
            $keys[] = ilDBConstants::T_INTEGER;
            $values[] = $user_id;
        }
        return (1 === $this->database->manipulateF($query, $keys, $values));
    }

deleteOSDNotificationByUserAndType()

ILIAS\Notifications\Repository\ilNotificationOSDRepository::deleteOSDNotificationByUserAndType ( int  $user_id, string  $type  )

private

Definition at line 167 of file ilNotificationOSDRepository.php.

References ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_osd_handler, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by ILIAS\Notifications\Repository\ilNotificationOSDRepository\createOSDNotification().

                                                                                   : void
    {
        $query = 'DELETE FROM ' . ilNotificationSetupHelper::$tbl_notification_osd_handler . ' WHERE usr_id = %s AND type = %s';
        $this->database->manipulateF(
            $query,
            [ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT],
            [$user_id, $type]
        );
    }

Here is the caller graph for this function:

deleteStaleOSDNotificationsForUserAndType()

ILIAS\Notifications\Repository\ilNotificationOSDRepository::deleteStaleOSDNotificationsForUserAndType	(	string	$povider_type,
		int	$user_id,
		int	$until_timestamp
	)

Definition at line 190 of file ilNotificationOSDRepository.php.

References ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_osd_handler, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                                                                                                                       : void
    {
        $query = 'DELETE FROM ' . ilNotificationSetupHelper::$tbl_notification_osd_handler . ' WHERE type = %s AND usr_id = %s AND time_added < %s';
        $this->database->manipulateF(
            $query,
            [ilDBConstants::T_TEXT, ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER],
            [$povider_type, $user_id, $until_timestamp]
        );
    }

getCurrentUnixTimestamp()

ILIAS\Notifications\Repository\ilNotificationOSDRepository::getCurrentUnixTimestamp ( )

private

Definition at line 53 of file ilNotificationOSDRepository.php.

Referenced by ILIAS\Notifications\Repository\ilNotificationOSDRepository\createOSDNotification(), and ILIAS\Notifications\Repository\ilNotificationOSDRepository\getOSDNotificationsByUser().

                                              : int
    {
        return time(); // Should be replace by the consumption of the `Clock` interface
    }

Here is the caller graph for this function:

getOSDNotificationsByUser()

ILIAS\Notifications\Repository\ilNotificationOSDRepository::getOSDNotificationsByUser	(	int	$user_id,
		int	$max_age_seconds = 0,
		string	$type = ''
	)

Definition at line 105 of file ilNotificationOSDRepository.php.

References ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_osd_handler, $user_id, ILIAS\Notifications\Repository\ilNotificationOSDRepository\getCurrentUnixTimestamp(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                                                                                                        : array
    {
        $now = $this->getCurrentUnixTimestamp();

        if ($max_age_seconds === 0) {
            $max_age_seconds = $now;
        }

        $query =
            'SELECT * FROM ' . ilNotificationSetupHelper::$tbl_notification_osd_handler .
            ' WHERE usr_id = %s AND (valid_until = 0 OR valid_until > %s) AND time_added > %s';

        $types = [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER];
        $values = [$user_id, $now, $now - $max_age_seconds];

        if ($type !== '') {
            $query .= ' AND type = %s';
            $types[] = ilDBConstants::T_TEXT;
            $values[] = $type;
        }

        $rset = $this->database->queryF($query, $types, $values);
        $notifications = [];

        while ($row = $this->database->fetchAssoc($rset)) {
            $object = unserialize(
                $row['serialized'],
                ['allowed_classes' => [ilNotificationObject::class, ilNotificationLink::class, ilNotificationParameter::class]]
            );
            if (isset($object->handlerParams[''], $object->handlerParams['osd'])) {
                $object->handlerParams = [
                    'general' => $object->handlerParams[''],
                    'osd' => $object->handlerParams['osd']
                ];
            }
            $notification = new ilOSDNotificationObject(
                (int) $row['notification_osd_id'],
                (int) $row['usr_id'],
                $object,
                (int) $row['time_added'],
                (int) $row['valid_until'],
                (int) $row['visible_for'],
                $row['type'],
                new NotificationIdentification($row['type'], $row['identification'])
            );

            $notifications[] = $notification;
        }

        return $notifications;
    }

Here is the call graph for this function:

ifOSDNotificationExistsById()

ILIAS\Notifications\Repository\ilNotificationOSDRepository::ifOSDNotificationExistsById

(

int

$id

)

Implements ILIAS\Notifications\Repository\ilNotificationOSDRepositoryInterface.

Definition at line 96 of file ilNotificationOSDRepository.php.

References ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_osd_handler, and ilDBConstants\T_INTEGER.

Referenced by ILIAS\Notifications\Repository\ilNotificationOSDRepository\deleteOSDNotificationById().

                                                        : bool
    {
        $query = 'SELECT count(*) AS count FROM ' . ilNotificationSetupHelper::$tbl_notification_osd_handler . ' WHERE notification_osd_id = %s';
        $result = $this->database->queryF($query, [ilDBConstants::T_INTEGER], [$id]);
        $row = $this->database->fetchAssoc($result);

        return ((int) ($row['count'] ?? 0)) === 1;
    }

Here is the caller graph for this function:

Field Documentation

$database

readonly ilDBInterface ILIAS\Notifications\Repository\ilNotificationOSDRepository::$database

private

Definition at line 42 of file ilNotificationOSDRepository.php.

Referenced by ILIAS\Notifications\Repository\ilNotificationOSDRepository\__construct().

UNIQUE_TYPES

const ILIAS\Notifications\Repository\ilNotificationOSDRepository::UNIQUE_TYPES

private

Initial value:

= [
        'who_is_online'
    ]

Definition at line 38 of file ilNotificationOSDRepository.php.

---

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

• components/ILIAS/Notifications/classes/Repository/ilNotificationOSDRepository.php