SLP® phpDocs

SLP_Power_Admin_Locations_Import extends SLP_Object_With_Objects
in package

The things that modify the Admin / Locations / Import UX.

Table of Contents

Constants

subtab_slug  = 'import'

Properties

$addon  : object
$class_prefix  : string
$dir  : string
$myslp  : MySLP
$objects  : array<string|int, mixed>
$slplus  : SLPlus
$uses_myslp  : bool
$uses_slplus  : bool
$slug  : mixed
$settings  : mixed

Methods

__construct()  : mixed
__get()  : mixed
Get the value, running it through a filter.
__isset()  : bool
Allow isset to be called on private properties.
add_object()  : mixed
create_import_subtab()  : mixed
Add the bulk upload form to add locations.
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
instantiate()  : null|object
Instantiate an object of the noted class.
set_properties()  : mixed
Set our properties.
at_startup()  : mixed
Things to do at startup after this baby is initialized. Override in your class.
initialize()  : mixed
Connect our addon.
set_default_object_options()  : mixed
Set default options for objects. Override in your class.
configure_javascript_variables()  : mixed
Configure the variables to be passed into the JavaScript code.
create_string_cron_schedule()  : string
Get the cron schedule as a formatted HTML string.
generate_recurring_import_card()  : mixed
get_html_for_scheduled_import_list()  : string
Get HTML cards to show scheduled data
import_file_settings_group()  : mixed
File Settings Group
import_messages_group()  : mixed
Import Messages Group
import_remote_file_group()  : mixed
Remote File Retrieval Group
import_schedule_group()  : mixed
Add the import messages group.
new_import_upload_csv_group()  : mixed
Upload CSV Group
status_bar()  : mixed
Create the import status bar.

Constants

Properties

$objects

public array<string|int, mixed> $objects

key = class name, array of attributes() auto_instantiate = true , instantiate the object when this object initializes object = the instantiated object options = default startup options subdir = the subdirectory (from theme root) that contains the class definition

$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()

__get()

Get the value, running it through a filter.

public __get(string $property) : mixed
Parameters
$property : string
Return values
mixed —

null if not set or the value

__isset()

Allow isset to be called on private properties.

public __isset(mixed $property) : bool
Parameters
$property : mixed
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() ]) : 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

instantiate()

Instantiate an object of the noted class.

public instantiate(string $class[, array<string|int, mixed> $options = array() ]) : null|object
Parameters
$class : string
$options : array<string|int, mixed> = array()
Return values
null|object

set_properties()

Set our properties.

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

at_startup()

Things to do at startup after this baby is initialized. Override in your class.

protected at_startup() : mixed

NOTE: this will not run at initialization if $this->objects is empty.

set_default_object_options()

Set default options for objects. Override in your class.

protected set_default_object_options() : mixed

configure_javascript_variables()

Configure the variables to be passed into the JavaScript code.

private configure_javascript_variables() : mixed

create_string_cron_schedule()

Get the cron schedule as a formatted HTML string.

private create_string_cron_schedule() : string
Return values
string

get_html_for_scheduled_import_list()

Get HTML cards to show scheduled data

private get_html_for_scheduled_import_list() : string
Return values
string

import_file_settings_group()

File Settings Group

private import_file_settings_group(string $section_slug) : mixed
Parameters
$section_slug : string

import_messages_group()

Import Messages Group

private import_messages_group(string $section_slug) : mixed
Parameters
$section_slug : string

import_remote_file_group()

Remote File Retrieval Group

private import_remote_file_group(string $section_slug) : mixed
Parameters
$section_slug : string

import_schedule_group()

Add the import messages group.

private import_schedule_group(string $section_slug) : mixed
Parameters
$section_slug : string

new_import_upload_csv_group()

Upload CSV Group

private new_import_upload_csv_group(string $section_slug) : mixed
Parameters
$section_slug : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results