NotificationsBagInterface
extends
SessionBagInterface
in
Table of Contents
- add() : mixed
- Adds a notification for the given type.
- all() : array<string|int, mixed>
- Gets and clears from the stack.
- get() : array<string|int, mixed>
- Gets and clears from the stack.
- has() : bool
- Has notifications for a given type?
- keys() : array<string|int, mixed>
- Returns a list of all defined types.
- peek() : array<string|int, mixed>
- Gets notifications for a given type.
- peekAll() : array<string|int, mixed>
- Gets all notifications.
- set() : mixed
- Registers one or more notifications for a given type.
- setAll() : mixed
- Sets all notifications.
Methods
add()
Adds a notification for the given type.
public
add(string $type, mixed $notification) : mixed
Parameters
- $type : string
- $notification : mixed
Return values
mixed —all()
Gets and clears from the stack.
public
all() : array<string|int, mixed>
Return values
array<string|int, mixed> —get()
Gets and clears from the stack.
public
get(string $type[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
- $type : string
- $default : array<string|int, mixed> = []
-
Default value if $type does not exist
Return values
array<string|int, mixed> —has()
Has notifications for a given type?
public
has(string $type) : bool
Parameters
- $type : string
Return values
bool —keys()
Returns a list of all defined types.
public
keys() : array<string|int, mixed>
Return values
array<string|int, mixed> —peek()
Gets notifications for a given type.
public
peek(string $type[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
- $type : string
-
Notification category type
- $default : array<string|int, mixed> = []
-
Default value if $type does not exist
Return values
array<string|int, mixed> —peekAll()
Gets all notifications.
public
peekAll() : array<string|int, mixed>
Return values
array<string|int, mixed> —set()
Registers one or more notifications for a given type.
public
set(string $type, string|array<string|int, mixed> $notifications) : mixed
Parameters
- $type : string
- $notifications : string|array<string|int, mixed>
Return values
mixed —setAll()
Sets all notifications.
public
setAll(array<string|int, mixed> $notifications) : mixed
Parameters
- $notifications : array<string|int, mixed>