MySLP_Notification
extends SLPlus_BaseClass_Object
in package
The Notification System.
Puts notifications on top of wpCSL plugin admin pages.
Tags
Table of Contents
Properties
- $enabled : bool
- $enabled : mixed
- $name : string
- $name : mixed
- $notices : array<string|int, wpCSL_notifications_notice__slplus>
- $prefix : string
- $prefix : mixed
- $slplus : SLPlus
- $url : string
- $url : mixed
- $uses_slplus : bool
- $slplus : mixed
- $uses_slplus : 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.
- display() : mixed
- Render the notices to the browser page.
- get() : 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.
- set_properties() : mixed
- Set our properties.
- initialize() : mixed
- Do these things when this object is invoked. Override in your class.
Properties
$enabled
public
bool
$enabled
$enabled
public
mixed
$enabled
= \true
$name
public
string
$name
$name
public
mixed
$name
$notices read-only
public
array<string|int, wpCSL_notifications_notice__slplus>
$notices
$prefix
public
string
$prefix
$prefix
public
mixed
$prefix
$slplus
public
SLPlus
$slplus
$url
public
string
$url
$url
public
mixed
$url
$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
$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
display()
Render the notices to the browser page.
public
display() : mixed
get()
Return a formatted HTML string representing the notification.
public
get([bool $simple = false ]) : string
Parameters
- $simple : bool = false
-
- set to true to see simplified unformatted notices.
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_Objectset_properties()
Set our properties.
public
set_properties([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
initialize()
Do these things when this object is invoked. Override in your class.
protected
initialize() : mixed