Store Locator Plus®

SLP_Text_Links extends SLPlus_BaseClass_Object
in package

Class SLP_Text_Links

Table of Contents

Properties

$slplus  : SLPlus
$uses_slplus  : bool
$slplus  : mixed
$uses_slplus  : mixed
$urls  : mixed
$web_links  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
get()  : SLP_Web_Link
Get the specified web page HTML with embedded hyperlinks.
get_instance()  : SLPlus_BaseClass_Object
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
get_url()  : string
Get the specified URL.
set_properties()  : mixed
Set our properties.
initialize()  : mixed
Do these things when this object is invoked. Override in your class.
build_dynamic_link()  : mixed
Build dynamic link.
docs_for()  : mixed
Build a docs_for_<slug> link to the docs site.
icon_for()  : mixed
Build a icon_for_<slug> link.
init_urls()  : mixed
Load up the URLs array.
shop_for()  : string
Build a shop_for_<slug> link to the shopping site.

Properties

$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

get()

Get the specified web page HTML with embedded hyperlinks.

public get(string $slug[, string $option = '' ]) : SLP_Web_Link

docs_for_ calls the docs_for() method icon_for_ calls the icon_for() method shop_for_ calls the shop_for() method

any other web link not specified in the custom list below will link using..

the "sentence" that matches the text manager 'printf' with the same slug the "link_text" taht matches the text manager 'link_text' with the same slug and link to the URL noted in the init_urls() list here with the same slug

Parameters
$slug : string

web page link to fetch.

$option : string = ''

Option (such as a product slug) for further processing.

Return values
SLP_Web_Link

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_Object

get_url()

Get the specified URL.

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

set_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

build_dynamic_link()

Build dynamic link.

private build_dynamic_link(string $slug, string $option) : mixed
Parameters
$slug : string
$option : string

Option (such as a product slug) for further processing.

docs_for()

Build a docs_for_<slug> link to the docs site.

private docs_for(string $slug) : mixed
Parameters
$slug : string

icon_for()

Build a icon_for_<slug> link.

private icon_for(string $slug) : mixed
Parameters
$slug : string

init_urls()

Load up the URLs array.

private init_urls() : mixed

TODO: rework this to accept the slug we are looking for & use switch/case so we only load up the URL we need vs. filling up this much RAM.

shop_for()

Build a shop_for_<slug> link to the shopping site.

private shop_for(string $slug) : string
Parameters
$slug : string
Return values
string —

| null


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results