SLP_AddOns_Meta
extends SLPlus_BaseClass_Object
in package
Handle Add On MetaData.
Load the metadata from a plugin header only when needed. This lightens the memory and disk I/O load on normal UI operations.
Table of Contents
Properties
- $addon : mixed
- $meta_read : bool
- $metadata : array<string|int, string>
- $slplus : SLPlus
- $uses_slplus : bool
- $slplus : mixed
- $uses_slplus : mixed
- $meta_read : mixed
- $metadata : mixed
Methods
- __construct() : mixed
- __get() : SLPlus_BaseClass_Object
- __isset() : bool
- get_instance() : SLPlus_BaseClass_Object
- Return an instance of the object which is also registered to the slplus global less the SLP_ part.
- get_meta() : string
- Return the specified metadata property.
- set_properties() : mixed
- Set our properties.
- initialize() : mixed
- Do these things when this object is invoked. Override in your class.
- read_meta() : mixed
- Read the plugin header meta.
Properties
$addon
public
mixed
$addon
$meta_read read-only
public
bool
$meta_read
Has the meta data been read from the add on file header?
$metadata read-only
public
array<string|int, string>
$metadata
Named array of metadata properties. @see https://developer.wordpress.org/reference/functions/get_plugin_data/
$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
$meta_read
private
mixed
$meta_read
= \false
$metadata
private
mixed
$metadata
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
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_meta()
Return the specified metadata property.
public
get_meta(string $property) : string
Parameters
- $property : string
Return values
stringset_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
read_meta()
Read the plugin header meta.
private
read_meta() : mixed