jMessage
in package
Utility class to log some message in session in order to be displayed in a template.
Tags
Table of Contents
- $session_name : mixed
- add() : mixed
- Add a message.
- clear() : mixed
- Clear messages for the given type.
- clearAll() : mixed
- Clear all messages.
- get() : mixed
- Get messages for the given type.
- getAll() : mixed
- Get all messages.
Properties
$session_name
protected
static mixed
$session_name
= 'JELIX_MESSAGE'
Methods
add()
Add a message.
public
static add(string $message[, string $type = 'default' ]) : mixed
Parameters
- $message : string
-
the message
- $type : string = 'default'
-
the message type ('default' by default)
Return values
mixed —clear()
Clear messages for the given type.
public
static clear([string $type = 'default' ]) : mixed
Parameters
- $type : string = 'default'
-
the message type ('default' by default)
Return values
mixed —clearAll()
Clear all messages.
public
static clearAll() : mixed
Return values
mixed —get()
Get messages for the given type.
public
static get([string $type = 'default' ]) : mixed
Parameters
- $type : string = 'default'
-
the message type ('default' by default)
Return values
mixed —array/null
getAll()
Get all messages.
public
static getAll() : mixed
Return values
mixed —array/null