SLP_Message_Manager
extends SLPlus_BaseClass_Object
in package
Message Manager
Table of Contents
Properties
- $messages : array<string|int, string>
- $slplus : SLPlus
- $slug : string
- $slug : mixed
- $uses_slplus : bool
- $slplus : mixed
- $uses_slplus : mixed
- $messages : mixed
- $option_name : mixed
Methods
- __construct() : mixed
- __get() : SLPlus_BaseClass_Object
- __isset() : bool
- add_message() : mixed
- Add a message to the queue.
- clear_messages() : mixed
- Clear the messages from memory and persistent storage.
- exist() : bool
- Returns true if some messages exist
- get_instance() : SLPlus_BaseClass_Object
- Return an instance of the object which is also registered to the slplus global less the SLP_ part.
- get_message_string() : string
- Get the messages back in a formatted HTML div block.
- initialize() : mixed
- Initialize this message manager and setup the related smart option.
- save_messages() : mixed
- Save the messages in persistent storage.
- set_messages() : mixed
- Set the message stack, fetching from persistent storage.
- set_properties() : mixed
- Set our properties.
- get_transient_name() : string
- Return the transient name for this message stack. slp-<slug>-messages.
Properties
$messages read-only
public
array<string|int, string>
$messages
The messages stack.
$slplus
public
SLPlus
$slplus
$slug
public
string
$slug
The transient name.
$slug
public
mixed
$slug
$uses_slplus
public
bool
$uses_slplus
Set to true (default) if the object needs access to the SLPlus plugin object.
$slplus
protected
mixed
$slplus
$uses_slplus
protected
mixed
$uses_slplus
= \true
$messages
private
mixed
$messages
= array()
$option_name
private
mixed
$option_name
Methods
__construct()
public
__construct([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
__get()
public
__get(string $property) : SLPlus_BaseClass_Object
Parameters
- $property : string
Return values
SLPlus_BaseClass_Object__isset()
public
__isset(string $property) : bool
Parameters
- $property : string
Return values
booladd_message()
Add a message to the queue.
public
add_message(string $message[, bool $nodate = false ]) : mixed
Parameters
- $message : string
- $nodate : bool = false
-
if true skip the date/source tagging
clear_messages()
Clear the messages from memory and persistent storage.
public
clear_messages() : mixed
exist()
Returns true if some messages exist
public
exist() : bool
Return values
boolget_instance()
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
public
static get_instance([bool $no_global = false ][, mixed $params = array() ]) : SLPlus_BaseClass_Object
TODO: PHP7.4 and PHP8.0 the static instance variable returns an object matching $class TODO: PHP8.1 the static instance continually returns the FIRST object (SLP_Admin_Helper) every time -- it is like PHP8.1 static instance is bound to base_class-object versus the calling class object
Parameters
- $no_global : bool = false
-
set to true to skip assigning object to SLP global as a property.
- $params : mixed = array()
-
object init params
Return values
SLPlus_BaseClass_Objectget_message_string()
Get the messages back in a formatted HTML div block.
public
get_message_string() : string
Return values
string —HTML including message text.
initialize()
Initialize this message manager and setup the related smart option.
public
initialize() : mixed
save_messages()
Save the messages in persistent storage.
public
save_messages() : mixed
set_messages()
Set the message stack, fetching from persistent storage.
public
set_messages() : mixed
set_properties()
Set our properties.
public
set_properties([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
get_transient_name()
Return the transient name for this message stack. slp-<slug>-messages.
private
get_transient_name() : string