MySLP
in package
Class MySLP
Table of Contents
Constants
- class_base = 'MySLP_'
Properties
- $Customer_History : MySLP_Customer_History
- $Customer_Profile : MySLP_Customer_Profile
- $History : MySLP_History
- $https_logo_190x60 : mixed
- $menu_hooks : mixed
- $objects : mixed
- $objects : mixed
- $Option : MySLP_Option
- $option_modifier : MySLP_Option_Modifier
- $options : array<string|int, mixed>
- $options : mixed
- $Payments : MySLP_Payments
- $Payments_Page : MySLP_Payments_Page
- $PayPal_Payments : MySLP_PayPal_Payments
- $Recurring_Payments : MySLP_Recurring_Payments
- $Service_Levels : MySLP_Service_Levels
- $Settings_General : MySLP_Settings_General
- $Stripe_Payments : MySLP_Stripe_Payments
- $User : MySLP_User
- $Option : mixed
- $option_modifier : mixed
Methods
- __construct() : mixed
- MySLP constructor.
- __get() : null
- Get our objects using a simple name without needing an array ref.
- add_customer_role() : mixed
- Creeate new user role: Customer Basic Role: Customer can only access 3 pages: 1.) MySLP Dashboard 2.) Account Management 3.) Billing Management
- add_desc_wrapper() : html
- Create data group descripion wrapper
- add_hooks() : mixed
- Adding hooks
- add_section() : string|void
- Add new section markup dynamically. It accepts array as param
- add_section_desc() : html
- Create data group descripion
- add_subsection_desc() : html
- Add subsection description
- add_subsection_title() : html
- Add subsection heading title
- admin_bar() : mixed
- Remove admin bar access if not administrator
- auto_load() : mixed
- Auto-loads classes of name Geo_<module>* from include/<module> whenever it is needed.
- babel_script_loader_tag() : mixed
- JSX scripting and babel need different script type change from text/javascript to text/babel
- create_content() : html
- Create collapsible content for input data group
- create_dashboard_page() : mixed
- Dashboard page
- create_header() : html
- Create section header
- create_input() : html
- Create input data group. A wrapper of html input fields.
- create_menu() : mixed
- Separate Menu from SLP
- dashboard_redirect() : mixed
- Auto redirect to dashboard if it's active
- define_deployment() : mixed
- Define MySLP Deployment Level in MYSLP_DEPLOYMENT_LEVEL
- delete_location() : mixed
- Delete location using ajax.
- enqueue_scripts() : mixed
- Logged in styles.
- get_base_email() : mixed
- User email account as username
- get_instance() : SLPlus_BaseClass_Object
- Return an instance of the object which is also registered to the slplus global less the SLP_ part.
- is_addon_active() : bool
- Is the specified add on active?
- log_and_validate_referer() : bool
- map_languages() : mixed
- Return array flip of Map Languages
- modify_settings_general_tab() : mixed
- Modify the SLP General Settings Tab
- rand_password() : mixed
- Auto generate password using bin2hex This value will be emailed to new user
- rest_dispatch_request_filter() : WP_REST_Response
- Hook on the REST API response. Do the categorization for the location add / edit. Get the categories data on the get sinle location calls.
- set_input() : html
- Set input markup for fields in Settings
- show_notification() : mixed
- Create notification div.
- tweak_widgets() : mixed
- Tweak the WP dashboard widgets. Add ours, remove some defaults.
- update_options() : mixed
- Update our primary site options.
- zoom_adjustment() : mixed
- Return Zoom Adjustment array
- zoom_level() : mixed
- Return Zoom Level array
- remove_default_widgets() : mixed
- Remove Default Widgets
- updateLocationCategories() : mixed
- Add categories to the location
Constants
class_base
public
mixed
class_base
= 'MySLP_'
Properties
$Customer_History
public
MySLP_Customer_History
$Customer_History
$Customer_Profile
public
MySLP_Customer_Profile
$Customer_Profile
$History
public
MySLP_History
$History
$https_logo_190x60
public
mixed
$https_logo_190x60
= 'https://my.storelocatorplus.com/wp-content/uploads/2017/03/SLP-190x60.png'
$menu_hooks
public
mixed
$menu_hooks
$objects
public
mixed
$objects
Array of object instances we care about.
$objects
public
mixed
$objects
$Option
public
MySLP_Option
$Option
MUP(17.5) Option Helper
$option_modifier read-only
public
MySLP_Option_Modifier
$option_modifier
$options
public
array<string|int, mixed>
$options
Our global options
$options
public
mixed
$options
$Payments
public
MySLP_Payments
$Payments
MUP(17.6) Payments Interface
$Payments_Page
public
MySLP_Payments_Page
$Payments_Page
MUP(17.6) Payments Admin Tab
$PayPal_Payments
public
MySLP_PayPal_Payments
$PayPal_Payments
MUP(17.6) PayPal Payment Processing (stub only)
$Recurring_Payments
public
MySLP_Recurring_Payments
$Recurring_Payments
CPROF: Recurring Payments Module
$Service_Levels
public
MySLP_Service_Levels
$Service_Levels
MUP: Service Levels Management
$Settings_General
public
MySLP_Settings_General
$Settings_General
$Stripe_Payments
public
MySLP_Stripe_Payments
$Stripe_Payments
MUP(17.6) Stripe Payment Processing
$User
public
MySLP_User
$User
MUP: A MySLP User
$Option
private
mixed
$Option
$option_modifier
private
mixed
$option_modifier
Methods
__construct()
MySLP constructor.
public
__construct() : mixed
__get()
Get our objects using a simple name without needing an array ref.
public
__get( $property) : null
Parameters
Return values
nulladd_customer_role()
Creeate new user role: Customer Basic Role: Customer can only access 3 pages: 1.) MySLP Dashboard 2.) Account Management 3.) Billing Management
public
add_customer_role() : mixed
add_desc_wrapper()
Create data group descripion wrapper
public
add_desc_wrapper(mixed $desc) : html
Parameters
- $desc : mixed
Tags
Return values
html —markup for input data
add_hooks()
Adding hooks
public
add_hooks() : mixed
add_section()
Add new section markup dynamically. It accepts array as param
public
add_section([array<string|int, mixed> $param = array() ]) : string|void
Parameters
- $param : array<string|int, mixed> = array()
-
id required string Section id selector title required string Section title fields required array Determine what type of input using field param. It accepts array argument. id(fields) required string Input id selector label required string Use for input labeling tip required string Helper text for each field input required string text/textarea/select/check/radio
Return values
string|voidadd_section_desc()
Create data group descripion
public
add_section_desc(mixed $desc) : html
Parameters
- $desc : mixed
Tags
Return values
html —markup for input data
add_subsection_desc()
Add subsection description
public
add_subsection_desc(mixed $desc, mixed $section_id) : html
Parameters
- $desc : mixed
- $section_id : mixed
Tags
Return values
html —markup for input data
add_subsection_title()
Add subsection heading title
public
add_subsection_title(mixed $title, mixed $section_id) : html
Parameters
- $title : mixed
- $section_id : mixed
Tags
Return values
html —markup for input data
admin_bar()
Remove admin bar access if not administrator
public
admin_bar() : mixed
auto_load()
Auto-loads classes of name Geo_<module>* from include/<module> whenever it is needed.
public
auto_load(string $class_name) : mixed
Parameters
- $class_name : string
babel_script_loader_tag()
JSX scripting and babel need different script type change from text/javascript to text/babel
public
babel_script_loader_tag(mixed $tag, mixed $handle, mixed $src) : mixed
Parameters
- $tag : mixed
- $handle : mixed
- $src : mixed
Tags
create_content()
Create collapsible content for input data group
public
create_content(mixed $section_id, mixed $description, mixed $fields[, mixed $subsections = array() ]) : html
Parameters
- $section_id : mixed
- $description : mixed
- $fields : mixed
- $subsections : mixed = array()
Return values
html —markup for input data
create_dashboard_page()
Dashboard page
public
create_dashboard_page() : mixed
create_header()
Create section header
public
create_header(mixed $id, mixed $title) : html
Parameters
- $id : mixed
- $title : mixed
Tags
Return values
html —markup for header section
create_input()
Create input data group. A wrapper of html input fields.
public
create_input([mixed $input_fields = array() ][, mixed $counter = 0 ]) : html
Parameters
- $input_fields : mixed = array()
- $counter : mixed = 0
Tags
Return values
html —markup for input data
create_menu()
Separate Menu from SLP
public
create_menu() : mixed
dashboard_redirect()
Auto redirect to dashboard if it's active
public
dashboard_redirect(mixed $url, mixed $query, mixed $user) : mixed
Parameters
- $url : mixed
- $query : mixed
- $user : mixed
Tags
define_deployment()
Define MySLP Deployment Level in MYSLP_DEPLOYMENT_LEVEL
public
define_deployment() : mixed
delete_location()
Delete location using ajax.
public
delete_location() : mixed
It won't directly delete but instead it will pass to WP REST API request and do the deletion there
Tags
enqueue_scripts()
Logged in styles.
public
enqueue_scripts(mixed $hook) : mixed
Parameters
- $hook : mixed
get_base_email()
User email account as username
public
get_base_email(mixed $email) : mixed
Parameters
- $email : mixed
Tags
get_instance()
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
public
static get_instance([mixed $options = array() ]) : SLPlus_BaseClass_Object
Parameters
- $options : mixed = array()
-
object init params
Return values
SLPlus_BaseClass_Objectis_addon_active()
Is the specified add on active?
public
is_addon_active( $addon) : bool
Parameters
Return values
boollog_and_validate_referer()
public
log_and_validate_referer( $is_valid, WP_REST_Request $request) : bool
Parameters
Return values
boolmap_languages()
Return array flip of Map Languages
public
map_languages() : mixed
Tags
modify_settings_general_tab()
Modify the SLP General Settings Tab
public
modify_settings_general_tab(SLP_Settings $settings) : mixed
Parameters
- $settings : SLP_Settings
rand_password()
Auto generate password using bin2hex This value will be emailed to new user
public
rand_password([mixed $length = 4 ]) : mixed
Parameters
- $length : mixed = 4
rest_dispatch_request_filter()
Hook on the REST API response. Do the categorization for the location add / edit. Get the categories data on the get sinle location calls.
public
rest_dispatch_request_filter(mixed $result, WP_REST_Request $request, string $route, array<string|int, mixed> $handler) : WP_REST_Response
Parameters
- $result : mixed
- $request : WP_REST_Request
-
Request used to generate the response.
- $route : string
-
Route matched for the request.
- $handler : array<string|int, mixed>
-
Route handler used for the request.
Tags
Return values
WP_REST_Responseset_input()
Set input markup for fields in Settings
public
set_input([mixed $input_fields = array() ]) : html
Parameters
- $input_fields : mixed = array()
Tags
Return values
html —markup for input data
show_notification()
Create notification div.
public
show_notification( $message) : mixed
Parameters
tweak_widgets()
Tweak the WP dashboard widgets. Add ours, remove some defaults.
public
tweak_widgets() : mixed
update_options()
Update our primary site options.
public
update_options() : mixed
zoom_adjustment()
Return Zoom Adjustment array
public
zoom_adjustment() : mixed
Tags
zoom_level()
Return Zoom Level array
public
zoom_level() : mixed
Tags
remove_default_widgets()
Remove Default Widgets
private
remove_default_widgets() : mixed
updateLocationCategories()
Add categories to the location
private
updateLocationCategories(int $location_id, array<string|int, mixed> $categories) : mixed
Parameters
- $location_id : int
- $categories : array<string|int, mixed>