API Documentation
\

\Horde_Notification_Storage_Session

A class that stores notifications in the session.

Copyright 2009-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
__construct()
get()
set()
exists()
clear()
push()
No public properties found
No constants found
No protected methods found
$_stack
N/A
No private methods found
No private properties found
N/A

Properties

$_stack

$_stack : string

The stack name.

Type

string

Methods

__construct()

__construct(string  $stack)

Constructor.

Parameters

string $stack

The name of the notification stack.

get()

get(string  $key) : mixed

Return the given stack from the notification store.

Parameters

string $key

The key for the data.

Returns

mixed —

The notification data stored for the given key.

set()

set(string  $key, mixed  $value)

Set the given stack in the notification store.

Parameters

string $key

The key for the data.
mixed $value

The data.

exists()

exists(string  $key) : boolean

Is the given stack present in the notification store?

Parameters

string $key

The key of the data.

Returns

boolean —

True if the element is set, false otherwise.

clear()

clear(string  $key)

Unset the given stack in the notification store.

Parameters

string $key

The key of the data.

push()

push(string  $listener, \Horde_Notification_Event  $event)

Store a new event for the given listener stack.

Parameters

string $listener

The event will be stored for this listener.
\Horde_Notification_Event $event

The event to store.