Store Locator Plus®

SLP_BaseClass_Activation extends SLPlus_BaseClass_Object
in package

A base class that helps add-on packs separate activation functionality.

Add on packs should include and extend this class.

This allows the main plugin to only include this file during activation.

Tags
see
SLPLUS

class.activation.upgrade for examples.

Table of Contents

Properties

$addon  : SLP_BaseClass_Addon
$slplus  : SLPlus
$smartOptions  : array<string|int, string>
$updating_from  : string
$uses_slplus  : bool
$addon  : mixed
$slplus  : mixed
$smartOptions  : mixed
$updating_from  : mixed
$uses_slplus  : 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.
initialize()  : mixed
Things we do at startup.
set_properties()  : mixed
Set our properties.
update()  : mixed
Do this whenever the activation class is instantiated.
remove_unnamed_options()  : mixed
Remove all numeric option names.
setup_smart_option()  : mixed
Override
convert_to_smartoptions()  : mixed
Convert legacy add on options to smart options.
remove_obsolete_options()  : mixed
Remove any options listed in smart options lists.

Properties

$smartOptions

public array<string|int, string> $smartOptions

A list of addon options converting to SmartOptions

$updating_from

public string $updating_from

The version of this add-on that was installed previously.

$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_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

set_properties()

Set our properties.

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

update()

Do this whenever the activation class is instantiated.

public update() : mixed

This is triggered via the update_prior_installs method in the admin class, which is run via update_install_info() in the admin class.

update_install_info should be something you put in any add-on pack that is using the base add-on class. It typically goes inside the do_admin_startup() method which is overridden by the new add on adminui class code.

remove_unnamed_options()

Remove all numeric option names.

protected remove_unnamed_options() : mixed

This is cleanup from ill-behaved add-on packs.

setup_smart_option()

Override

protected setup_smart_option( $slug,  $value) : mixed
Parameters
$slug :
$value :

convert_to_smartoptions()

Convert legacy add on options to smart options.

private convert_to_smartoptions() : mixed

The parent SLP_BaseClass_Admin.php from SLP will auto-call update_option( ) for addon->options.

remove_obsolete_options()

Remove any options listed in smart options lists.

private remove_obsolete_options() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results