Horde_Notification_Storage_Interface
in
An interface describing a storage location for notification messages.
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.
Tags
Table of Contents
- clear() : mixed
- Unset the given stack in the notification store.
- exists() : bool
- Is the given stack present in the notification store?
- get() : mixed
- Return the given stack from the notification store.
- push() : mixed
- Store a new event.
- set() : mixed
- Set the given stack in the notification store.
Methods
clear()
Unset the given stack in the notification store.
public
clear(string $key) : mixed
Parameters
- $key : string
-
The key of the data.
Return values
mixed —exists()
Is the given stack present in the notification store?
public
exists(string $key) : bool
Parameters
- $key : string
-
The key of the data.
Return values
bool —True if the element is set, false otherwise.
get()
Return the given stack from the notification store.
public
get(string $key) : mixed
Parameters
- $key : string
-
The key for the data.
Return values
mixed —The notification data stored for the given key.
push()
Store a new event.
public
push(string $listener, Horde_Notification_Event $event) : mixed
Parameters
- $listener : string
-
The event will be stored for this listener.
- $event : Horde_Notification_Event
-
The event to store.
Return values
mixed —set()
Set the given stack in the notification store.
public
set(string $key, mixed $value) : mixed
Parameters
- $key : string
-
The key for the data.
- $value : mixed
-
The data.