architecture – Store Locator Plus® Internal Docs

WordPress / SaaS Menu Ordering

WordPress

add_menu_page()


add_menu_page( 
string $page_title, 
string $menu_title, 
string $capability, 
string $menu_slug, 
callable $callback = ”, 
string $icon_url = ”, 
int|float $position = null 
): string

WordPress Default Admin Menu Positions

Standard	Network Admin
2 – Dashboard	2 – Dashboard
4 – Separator	4 – Separator
5 – Posts	5 – Sites
10 – Media	10 – Users
15 – Links	15 – Themes
20 – Pages	20 – Plugins
25 – Comments	25 – Settings
	30 – Updates
59 – Separator
60 – Appearance
65 – Plugins
70 – Users
75 – Tools
80 – Settings
99 – Separator	99 – Separator

SaaS Menu Positions

Standard / User	Network Admin
1.10 – MySLP myslp-dashboard	1.10 – Manage MYSLP_MANAGE_MENU_SLUG ‘myslp-manage-menu’ 10 – Customers 30 – History Log 50 – Cron : System 51 – Cron : User 80 – Database 70 – Addressess
1.20 – Store Locator Plus® csl-slplus
	1.30 – Config MYSLP_CONFIG_MENU_SLUG ‘myslp-config-menu’ 10 – Plans 15 – Plan Limits 20 – Plugins 25 – Email Settings 30 – Payments 70 – System Settings 80- Cache
2 – Dashboard	2 – Dashboard
4 – Separator	4 – Separator
5 – Posts	5 – Sites
10 – Media	10 – Users
15 – Links	15 – Themes
20 – Pages	20 – Plugins
25 – Comments	25 – Settings
	30 – Updates
59 – Separator
60 – Appearance
65 – Plugins
70 – Users
75 – Tools
80 – Settings
99 – Separator	99 – Separator

Locator Style Architecture

Posted by lcleveland in Architecture, Development, Store Locator Plus®

This setting is stored in the options_nojs[‘style’] option setting.

It is managed by an instantiation of the SLP_Settings_style_vision_list object.

data_field: options_nojs[style]
label: ‘Locator Style’
type: ‘style_vision_list’

This is a “smart option” managed by SLP_SmartOptions.
It is defined in \SLP_SmartOptions:view_appearance()
It has a ‘vue’ object type for rendering assistance.

Stack Trace : SLP | Settings

Triggered selecting – Menu : Store Locator Plus® | Settings

Most recent to oldest…

SLP_Settings_card_list.php:42, SLP_Settings_card_list->display()
- SLP_Settings_Group.php:88, SLP_Settings_Group->display()
  - SLP_Settings_Section.php:94, SLP_Settings_Section->display()
    - SLP_Settings.php:384, SLP_Settings->render_settings_page()
      - SLP_Admin_Settings.php:289, SLP_Admin_Settings->display()
SLP_Settings_style_vision_list.php:15, SLP_Settings_style_vision_list->get_items()
- SLP_Settings_card_list.php:28, SLP_Settings_card_list->at_startup()
  - SLP_Setting.php:48, SLP_Setting->initialize()
    …
    - SLP_Admin_Settings.php:213, SLP_Admin_Settings->add_view()

Showing The Currently Selected Style

\SLP_Settings_card_list::display()

Renders the list of styles.

When $this->value === $item->clean_title it marks it as selected.

$item is from the list of locator styles fetched from the SLP locator style service (see \SLP_Settings_style_vision_list->items below).

In our test case $this->value is EMPTY string “”.

Stack Trace : setting the initial value of the ‘style’ property (option)

\SLP_Setting->set_value() appears to have value already set to “”.

Track down the SLP_SmartOptions and how it loads the default values from options/options_nojs into the Smart Option properties.

SLP_SmartOptions.php:1784, SLP_SmartOptions->set_valid_option()
- SLP_SmartOptions.php:1832, SLP_SmartOptions->set_valid_options_nojs()
  - SLP_SmartOptions.php:1661, array_walk()
    - SLP_SmartOptions.php:1661, SLP_SmartOptions->slp_specific_setup()
      - SLP_SmartOptions.php:1513, SLP_SmartOptions->initialize_after_plugins_loaded() SLPlus.php:386
        
        SLPlus->initialize_after_plugins_loaded()

Class : SLP_Setting

Methods

set_value()

Sets the value of a setting.

Fetches the value of a setting from \WPOption_Manager::get_wp_option() if necessary.

Class : SLP_Settings_card_list

Extends SLP_Setting.

SLP_Setting type: “style_vision_list”

Class: SLP_Settings_style_vision_list

Extends SLP_Settings_card_list.

Properties

items : SLP_Setting_item[]

Contains the array of styles retrieved from the SLP Locator Styles service (REST call to external service).

value

Contains the currently set/selected style for the user.

Store Locator Plus® JavaScript Pub/Sub

Posted by lcleveland in Architecture, Store Locator Plus®

Store Locator Plus® was updated with a “pub/sub” model a few years ago. This feature is a managed interface for jQuery Callbacks that allows disparate Javascript functions to interact with each other. It works much like hooks and filters in WordPress, but solely within the JavaScript runtime space.

The basic premise is any JavaScript function can call a “publish” method that fires off a stack of callbacks.

slp_Filter('slp_map_ready').publish(cslmap);

What is run by those callbacks is set by having a JavaScript module call a “subscribe” method.

slp_Filter( 'slp_map_ready' ).subscribe( this.initialize );

Architecture: Locations Bulk Action

Posted by lcleveland in Architecture, Store Locator Plus®

Location bulk actions allow for users to work on multiple locations at once. Export a list of locations, delete select locations from the location table, geocode locations ,and more.

2209.12

Export locations is our first attempt at making bulk actions work more like a single page application.

Instead of doing a form post and submitting the location list, then reading in some PHP-driven variables to set the JavaScript behavior — in 2209.12 the export process bypasses the form submit.

Bypass is handled by using a pub/sub module with a dynamic filter name “exportBulkAction”. This tells the main SLP JavaScript process to execute the callback stack instead of pushing a form submit. This allows the AJAX call to happen immediately without a full page re-render.

2208.15

The apply button processing is handled in the main plugin’s admin.js file.

It uses jQuery to process form variables and prepare the #locationForm to be submitted.

When submitted it sends the request back to WordPress for standard “full page load” processing.

Architecture: Location Download

Posted by lcleveland in Architecture, Store Locator Plus®

A feature provided in the Professional level service is a CSV export of locations via the Location Manager page.

2209.12

This process is being revised so that export bulk action works more like a single page application.

Also see the Bulk Action processor page.

2208.15

The process flow for the Locations : Export CSV…

~~The process starts with a standard form submit from the Bulk Actions “Apply” button.~~

WordPress sets up a JavaScript variable location_import that has info about the action “export”.

~~This triggers a jQuery(document).ready() call that fires another request via AJAX back to WordPress with some new parameters in place.~~

That AJAX call eventually sends back a CSV file that is stored in a DOM div that was prepared with the jQuery() document loader when the refreshed page (post original submit) was rendered.