Object Sync for Salesforce Code Documentation

Object_Sync_Sf_Activate

Object_Sync_Sf_Activate class.

Table of Contents

$action_group_suffix  : string
Suffix for group name in ActionScheduler
$file  : string
The main plugin file
$option_prefix  : string
The plugin's prefix when saving options to the database
$queue  : object
Object_Sync_Sf_Queue class
$schedulable_classes  : array<string|int, mixed>
Array of what classes in the plugin can be scheduled to occur with `wp_cron` events
$slug  : string
The plugin's slug so we can include it when necessary
$user_installed_version  : string
The version of this plugin's database setup
$version  : string
Current version of the plugin
$wpdb  : object
Global object of `$wpdb`, the WordPress database
__construct()  : mixed
Constructor for activate class
add_roles_capabilities()  : mixed
Add roles and capabilities This adds the configure_salesforce capability to the admin role
check_for_action_scheduler()  : mixed
Check whether the user has ActionScheduler tasks when they upgrade
php_requirements()  : mixed
Check for the minimum required version of php
require_ssl()  : mixed
Require SSL because otherwise the plugin will not authorize
wordpress_salesforce_tables()  : mixed
Create database tables for Salesforce This creates tables for fieldmaps (between types of objects) and object maps (between individual instances of objects).
wordpress_salesforce_update_db_check()  : mixed
Check for database version When the plugin is loaded in the admin, if the database version does not match the current version, perform these methods
add_actions()  : mixed
Activation hooks
log_trigger_settings()  : mixed
Check for log trigger settings based on plugin version When the plugin is loaded in the admin, if the previously installed version is below 2.0.0, update the values for the log trigger settings.

Properties

$schedulable_classes

Array of what classes in the plugin can be scheduled to occur with `wp_cron` events

public array<string|int, mixed> $schedulable_classes

Methods

add_roles_capabilities()

Add roles and capabilities This adds the configure_salesforce capability to the admin role

public add_roles_capabilities() : mixed

It also allows other plugins to add the capability to other roles

Return values
mixed

check_for_action_scheduler()

Check whether the user has ActionScheduler tasks when they upgrade

public check_for_action_scheduler(object $upgrader_object, array<string|int, mixed> $hook_extra) : mixed
Parameters
$upgrader_object : object

this is the WP_Upgrader object.

$hook_extra : array<string|int, mixed>

the array of bulk item update data.

Tags
see
https://developer.wordpress.org/reference/hooks/upgrader_process_complete/
deprecated

since 2.0.0 and will be removed in version 3.0.0.

Return values
mixed

require_ssl()

Require SSL because otherwise the plugin will not authorize

public require_ssl() : mixed
Return values
mixed

wordpress_salesforce_tables()

Create database tables for Salesforce This creates tables for fieldmaps (between types of objects) and object maps (between individual instances of objects).

public wordpress_salesforce_tables() : mixed

Important requirement for developers: when you update the SQL for either of these tables, also update it in the documentation file located at /docs/troubleshooting-unable-to-create-database-tables.md and make sure that is included in your commit(s).

Return values
mixed

wordpress_salesforce_update_db_check()

Check for database version When the plugin is loaded in the admin, if the database version does not match the current version, perform these methods

public wordpress_salesforce_update_db_check() : mixed
Return values
mixed

log_trigger_settings()

Check for log trigger settings based on plugin version When the plugin is loaded in the admin, if the previously installed version is below 2.0.0, update the values for the log trigger settings.

private log_trigger_settings() : mixed
Return values
mixed

Search results