SLP® phpDocs

SLP_Premier_Admin_General_Text extends SLPlus_BaseClass_Object
in package

SLP Text Modifier

Table of Contents

Properties

$addon  : object
$myslp  : MySLP
$slplus  : SLPlus
$uses_myslp  : bool
$uses_slplus  : bool
$slug  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
augment_text_string()  : string
Replace the SLP Text Manager Strings at startup.
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
set_properties()  : mixed
Set our properties.
set_schedule_description()  : string
Set the schedule info for the help text on scheduled options.
initialize()  : mixed
SLP Text Manager Hooks
description()  : string
Descriptions
label()  : string
Labels
settings_group()  : string
Settings Groups
settings_group_header()  : string
Settings Group Headers = Settings Groups
settings_section()  : string
Settings Sections

Properties

$uses_myslp

public bool $uses_myslp

Set to true to add a $myslp property pointing to global $myslp

$uses_slplus

public bool $uses_slplus

Set to true (default) if the object needs access to the SLPlus plugin object.

Methods

__construct()

public __construct([array<string|int, mixed> $options = array() ]) : mixed
Parameters
$options : array<string|int, mixed> = array()

__isset()

public __isset(string $property) : bool
Parameters
$property : string
Return values
bool

augment_text_string()

Replace the SLP Text Manager Strings at startup.

public augment_text_string(string $text, string $slug) : string
Parameters
$text : string

the original text

$slug : string

the slug being requested

Tags
uses
SLP_Premier_Admin_General_Text::description
uses
SLP_Premier_Admin_General_Text::label
uses
SLP_Premier_Admin_General_Text::settings_group
uses
SLP_Premier_Admin_General_Text::settings_group_header
uses
SLP_Premier_Admin_General_Text::settings_section
Return values
string —

the new SLP text manager strings

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() ]) : static
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
static

set_properties()

Set our properties.

public set_properties([array<string|int, mixed> $options = array() ]) : mixed
Parameters
$options : array<string|int, mixed> = array()

set_schedule_description()

Set the schedule info for the help text on scheduled options.

public set_schedule_description(string $slug) : string
Parameters
$slug : string
Return values
string

description()

Descriptions

private description(string $slug, string $text) : string
Parameters
$slug : string
$text : string
Return values
string

label()

Labels

private label(string $slug, string $text) : string
Parameters
$slug : string
$text : string
Return values
string

settings_group()

Settings Groups

private settings_group(string $slug, string $text) : string
Parameters
$slug : string
$text : string
Return values
string

settings_group_header()

Settings Group Headers = Settings Groups

private settings_group_header(string $slug, string $text) : string
Parameters
$slug : string
$text : string
Return values
string

settings_section()

Settings Sections

private settings_section(string $slug, string $text) : string
Parameters
$slug : string
$text : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results