SLP_Notifications_Manager
extends SLPlus_BaseClass_Object
in package
The Notification System.
Puts notifications on top of wpCSL plugin admin pages.
Table of Contents
Properties
- $enabled : bool
- $enabled : mixed
- $name : string
- $notices : array<string|int, SLP_Notification>
- $slplus : SLPlus
- $uses_slplus : bool
- $slplus : mixed
- $uses_slplus : mixed
- $alert_action : mixed
- $alert_icons : mixed
- $log_only : mixed
- $notices : mixed
Methods
- __construct() : mixed
- __get() : SLPlus_BaseClass_Object
- __isset() : bool
- add_notice() : mixed
- Add a notification to the notice stack
- delete_all_notices() : mixed
- Reset the notices to a blank array.
- disable_logging() : mixed
- Disable Logging
- display() : mixed
- Render the notices to the browser page.
- enable_logging() : mixed
- Enable Logging
- get() : array<string|int, SLP_Notification>
- Return a list of notices.
- get_html() : string
- Return a formatted HTML string representing the notification.
- get_instance() : SLPlus_BaseClass_Object
- Return an instance of the object which is also registered to the slplus global less the SLP_ part.
- initialize() : mixed
- Things we do at the start.
- set_properties() : mixed
- Set our properties.
- setup() : mixed
- Set me up.
Properties
$enabled
public
bool
$enabled
$enabled
public
mixed
$enabled
= \true
$name
public
string
$name
$notices read-only
public
array<string|int, SLP_Notification>
$notices
$slplus
public
SLPlus
$slplus
$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
$alert_action
private
mixed
$alert_action
$alert_icons
private
mixed
$alert_icons
= array()
$log_only
private
mixed
$log_only
= \false
$notices
private
mixed
$notices
= \null
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_notice()
Add a notification to the notice stack
public
add_notice([mixed $level = 1 ][, string $content = '' ][, string $link = null ]) : mixed
Parameters
- $level : mixed = 1
-
- int (1 severe, 9 info) string 'error','warning','info'
- $content : string = ''
-
- the message
- $link : string = null
-
- url
delete_all_notices()
Reset the notices to a blank array.
public
delete_all_notices() : mixed
disable_logging()
Disable Logging
public
disable_logging() : mixed
display()
Render the notices to the browser page.
public
display() : mixed
enable_logging()
Enable Logging
public
enable_logging() : mixed
get()
Return a list of notices.
public
get() : array<string|int, SLP_Notification>
Return values
array<string|int, SLP_Notification>get_html()
Return a formatted HTML string representing the notification.
public
get_html() : string
Return values
string —- the HTML or simple string output
get_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_Objectinitialize()
Things we do at the start.
public
initialize() : mixed
set_properties()
Set our properties.
public
set_properties([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
setup()
Set me up.
private
setup() : mixed