ilNotificationOSDHandler Class Reference

Notification handler for senden a notification popup to the recipients browser. More...

Inheritance diagram for ilNotificationOSDHandler:

Collaboration diagram for ilNotificationOSDHandler:

Public Member Functions
	__construct (\ilDBInterface $database=null, \ilLanguage $language=null, \ILIAS\DI\Container $dic=null)
	ilNotificationOSDHandler constructor. More...
	notify (ilNotificationObject $notification)
	showSettings ($item)
Public Member Functions inherited from ilNotificationEchoHandler
	notify (ilNotificationObject $notification)
Public Member Functions inherited from ilNotificationHandler
	notify (ilNotificationObject $notification)
	showSettings ($form)

Static Public Member Functions
static	getNotificationsForUser ($user_id, $append_osd_id_to_link=true, $max_age_seconds=0)
static	removeNotification ($notification_osd_id)
	Removes a notifcation and triggers a follow up notification to remove the notification from the browser view of the original recipient. More...
static	cleanup ()
	Remove orphaned notifications. More...
static	cleanupOnRandom ()
	Exec self::clean with a probability of 1%. More...

Static Private Member Functions
static	appendOsdIdToLinks ($subject, $osd_id)
static	appendParamToLink ($link, $param, $value)
	Helper to append an additional parameter to an existing url. More...

Private Attributes
	$database
	$language

Detailed Description

Notification handler for senden a notification popup to the recipients browser.

Definition at line 10 of file class.ilNotificationOSDHandler.php.

Constructor & Destructor Documentation

__construct()

ilNotificationOSDHandler::__construct	(	\ilDBInterface	$database = null,
		\ilLanguage	$language = null,
		\ILIAS\DI\Container	$dic = null
	)

ilNotificationOSDHandler constructor.

Parameters

ilDBInterface | null	$database
ilLanguage | null	$language
\ILIAS\DI\Container | null	$dic

Definition at line 25 of file class.ilNotificationOSDHandler.php.

References $database, $DIC, and $language.

      {
        if ($dic === null) {
            global $DIC;
            $dic = $DIC;
        }

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

        if ($language === null) {
            $language = $dic->language();
        }
        $this->language = $language;
    }

Member Function Documentation

appendOsdIdToLinks()

static ilNotificationOSDHandler::appendOsdIdToLinks (   $subject,   $osd_id  )

staticprivate

Definition at line 113 of file class.ilNotificationOSDHandler.php.

    {
        $matches = array();
        preg_match_all('/href="(.*?)"/', $subject, $matches);
        if ($matches[1]) {
            foreach ($matches[1] as $match) {
                $match_appended = self::appendParamToLink($match, 'osd_id', $osd_id);
                $subject = str_replace($match, $match_appended, $subject);
            }
        }
        return $subject;
    }

appendParamToLink()

static ilNotificationOSDHandler::appendParamToLink (   $link,   $param,   $value  )

staticprivate

Helper to append an additional parameter to an existing url.

Parameters

string	$link
string	$param
scalar	$value

Returns

string

Definition at line 188 of file class.ilNotificationOSDHandler.php.

    {
        if (strpos($link, '?') !== false) {
            $link .= '&' . $param . '=' . $value;
        } else {
            $link .= '?' . $param . '=' . $value;
        }
        return $link;
    }

cleanup()

static ilNotificationOSDHandler::cleanup ( )

static

Remove orphaned notifications.

ilDB $ilDB

Definition at line 159 of file class.ilNotificationOSDHandler.php.

References $DIC, $ilDB, $query, and ilNotificationSetupHelper\$tbl_notification_osd_handler.

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'DELETE FROM ' . ilNotificationSetupHelper::$tbl_notification_osd_handler . ' WHERE valid_until < ' . $ilDB->quote(time(), 'integer');
        $ilDB->manipulate($query);
    }

cleanupOnRandom()

static ilNotificationOSDHandler::cleanupOnRandom ( )

static

Exec self::clean with a probability of 1%.

Definition at line 172 of file class.ilNotificationOSDHandler.php.

    {
        $rnd = rand(0, 10000);
        if ($rnd == 500) {
            self::cleanup();
        }
    }

getNotificationsForUser()

static ilNotificationOSDHandler::getNotificationsForUser (   $user_id,   $append_osd_id_to_link = true,   $max_age_seconds = 0  )

static

Definition at line 76 of file class.ilNotificationOSDHandler.php.

References $DIC, $ilDB, $query, $row, ilNotificationSetupHelper\$tbl_notification_osd_handler, and $values.

Referenced by ilNotificationGUI\getOSDNotificationsObject(), and ilNotificationOSDGUI\render().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'SELECT notification_osd_id, serialized, valid_until, visible_for, type FROM ' . ilNotificationSetupHelper::$tbl_notification_osd_handler
            . ' WHERE usr_id = %s AND (valid_until = 0 OR valid_until > ' . $ilDB->quote(time(), 'integer') . ') AND time_added > %s';

        $types = array('integer', 'integer');
        $values = array($user_id, $max_age_seconds ? (time() - $max_age_seconds) : 0);

        $rset = $ilDB->queryF($query, $types, $values);
        $notifications = array();

        while ($row = $ilDB->fetchAssoc($rset)) {
            $row['data'] = unserialize($row['serialized']);
            unset($row['serialized']);

            $row['data']->handlerParams = array('general' => $row['data']->handlerParams[''], 'osd' => $row['data']->handlerParams['osd']);

            if ($append_osd_id_to_link) {
                if ($row['data']->link) {
                    $row['data']->link = self::appendParamToLink($row['data']->link, 'osd_id', $row['notification_osd_id']);
                }

                $row['data']->shortDescription = self::appendOsdIdToLinks($row['data']->shortDescription, $row['notification_osd_id']);
                $row['data']->longDescription = self::appendOsdIdToLinks($row['data']->longDescription, $row['notification_osd_id']);
            }
            $notifications[] = $row;
        }

        self::cleanupOnRandom();

        return $notifications;
    }

Here is the caller graph for this function:

notify()

ilNotificationOSDHandler::notify

(

ilNotificationObject

$notification

)

Definition at line 46 of file class.ilNotificationOSDHandler.php.

References $id, and ilNotificationSetupHelper\$tbl_notification_osd_handler.

    {
        $id = $this->database->nextId(ilNotificationSetupHelper::$tbl_notification_osd_handler);

        $this->database->insert(
            ilNotificationSetupHelper::$tbl_notification_osd_handler,
            array(
                    'notification_osd_id' => array('integer', $id),
                    'usr_id' => array('integer', $notification->user->getId()),
                    'serialized' => array('text', serialize($notification)),
                    'valid_until' => array('integer', $notification->baseNotification->getValidForSeconds() ? ($notification->baseNotification->getValidForSeconds() + time()) : 0),
                    'visible_for' => array('integer', $notification->baseNotification->getVisibleForSeconds() ? $notification->baseNotification->getVisibleForSeconds() : 0),
                    'type' => array('text', $notification->baseNotification->getType()),
                    'time_added' => array('integer', time()),
                )
        );
    }

removeNotification()

static ilNotificationOSDHandler::removeNotification (   $notification_osd_id )

static

Removes a notifcation and triggers a follow up notification to remove the notification from the browser view of the original recipient.

ilDB $ilDB

Parameters

integer

$notification_osd_id

Definition at line 133 of file class.ilNotificationOSDHandler.php.

References $DIC, $ilDB, $query, $row, ilNotificationSetupHelper\$tbl_notification_osd_handler, and $values.

Referenced by ilPublicUserProfileGUI\executeCommand(), and ilNotificationGUI\removeOSDNotificationsObject().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'SELECT usr_id FROM ' . ilNotificationSetupHelper::$tbl_notification_osd_handler . ' WHERE notification_osd_id = %s';
        $types = array('integer');
        $values = array($notification_osd_id);

        $rset = $ilDB->queryF($query, $types, $values);

        if ($row = $ilDB->fetchAssoc($rset)) {
            $query = 'DELETE FROM ' . ilNotificationSetupHelper::$tbl_notification_osd_handler . ' WHERE notification_osd_id = %s';
            $types = array('integer');
            $values = array($notification_osd_id);

            $ilDB->manipulateF($query, $types, $values);
        }
    }

Here is the caller graph for this function:

showSettings()

ilNotificationOSDHandler::showSettings

(

$item

)

Definition at line 64 of file class.ilNotificationOSDHandler.php.

References $txt.

    {
        $txt = new ilTextInputGUI($this->language->txt('polling_intervall'), 'osd_polling_intervall');
        $txt->setRequired(true);
        $txt->setInfo($this->language->txt('polling_in_seconds'));
        $txt->setValue('300');

        $item->addSubItem($txt);

        return array('osd_polling_intervall');
    }

Field Documentation

$database

ilNotificationOSDHandler::$database

private

Definition at line 14 of file class.ilNotificationOSDHandler.php.

Referenced by __construct().

$language

ilNotificationOSDHandler::$language

private

Definition at line 17 of file class.ilNotificationOSDHandler.php.

Referenced by __construct().

---

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

• Services/Notifications/classes/class.ilNotificationOSDHandler.php