MinnPost / object-sync-for-salesforce

classes/salesforce_query.php

Indentation +23 added lines, -23 removed lines

@@ -22,27 +22,27 @@ 
 	public $conditions = array();
 
 	/**
-	* Constructor which sets the query object type.
-	*
-	* @param string $object_type
-	*   Salesforce object type to query.
-	*/
+	 * Constructor which sets the query object type.
+	 *
+	 * @param string $object_type
+	 *   Salesforce object type to query.
+	 */
 	public function __construct( $object_type = '' ) {
 		$this->object_type = $object_type;
 	}
 
 	/**
-	* Add a condition to the query.
-	*
-	* @param string $field
-	*   Field name.
-	* @param mixed $value
-	*   Condition value. If an array, it will be split into quote enclosed
-	*   strings separated by commas inside of parenthesis. Note that the caller
-	*   must enclose the value in quotes as needed by the SF API.
-	* @param string $operator
-	*   Conditional operator. One of '=', '!=', '<', '>', 'LIKE, 'IN', 'NOT IN'.
-	*/
+	 * Add a condition to the query.
+	 *
+	 * @param string $field
+	 *   Field name.
+	 * @param mixed $value
+	 *   Condition value. If an array, it will be split into quote enclosed
+	 *   strings separated by commas inside of parenthesis. Note that the caller
+	 *   must enclose the value in quotes as needed by the SF API.
+	 * @param string $operator
+	 *   Conditional operator. One of '=', '!=', '<', '>', 'LIKE, 'IN', 'NOT IN'.
+	 */
 	public function add_condition( $field, $value, $operator = '=' ) {
 		if ( is_array( $value ) ) {
 			$value = "('" . implode( "','", $value ) . "')";
@@ -60,13 +60,13 @@ 
 	}
 
 	/**
-	* Implements PHP's magic __toString().
-	*
-	* Function to convert the query to a string to pass to the SF API.
-	*
-	* @return string
-	*   SOQL query ready to be executed the SF API.
-	*/
+	 * Implements PHP's magic __toString().
+	 *
+	 * Function to convert the query to a string to pass to the SF API.
+	 *
+	 * @return string
+	 *   SOQL query ready to be executed the SF API.
+	 */
 	public function __toString() {
 
 		$query  = 'SELECT ';

classes/admin-notice.php

Indentation +12 added lines, -12 removed lines

@@ -21,15 +21,15 @@ 
 	protected $template;
 
 	/**
-	* Constructor which sets up the admin_notices hook for rendering
-	*
-	* @param mixed $condition
-	* @param string $message
-	* @param bool $dismissible
-	* @param string $type
-	* @param string $template
-	*
-	*/
+	 * Constructor which sets up the admin_notices hook for rendering
+	 *
+	 * @param mixed $condition
+	 * @param string $message
+	 * @param bool $dismissible
+	 * @param string $type
+	 * @param string $template
+	 *
+	 */
 	public function __construct( $condition, $message, $dismissible = false, $type = '', $template = '' ) {
 		$this->condition   = $condition;
 		$this->message     = $message;
@@ -42,9 +42,9 @@ 
 	}
 
 	/**
-	* Render an admin notice
-	*
-	*/
+	 * Render an admin notice
+	 *
+	 */
 	public function render() {
 
 		// class for the notice to use

classes/activate.php

Indentation +23 added lines, -23 removed lines

@@ -19,13 +19,13 @@ 
 	protected $installed_version;
 
 	/**
-	* Constructor which sets up activate hooks
-	*
-	* @param object $wpdb
-	* @param string $version
-	* @param string $slug
-	*
-	*/
+	 * Constructor which sets up activate hooks
+	 *
+	 * @param object $wpdb
+	 * @param string $version
+	 * @param string $slug
+	 *
+	 */
 	public function __construct( $wpdb, $version, $slug ) {
 		$this->wpdb              = $wpdb;
 		$this->version           = $version;
@@ -37,8 +37,8 @@ 
 	}
 
 	/**
-	* Check for the minimum required version of php
-	*/
+	 * Check for the minimum required version of php
+	 */
 	public function php_requirements() {
 		if ( version_compare( PHP_VERSION, '5.5', '<' ) ) {
 			deactivate_plugins( plugin_basename( __FILE__ ) );
@@ -47,10 +47,10 @@ 
 	}
 
 	/**
-	* Create database tables for Salesforce
-	* This creates tables for fieldmaps (between types of objects) and object maps (between indidual instances of objects)
-	*
-	*/
+	 * Create database tables for Salesforce
+	 * This creates tables for fieldmaps (between types of objects) and object maps (between indidual instances of objects)
+	 *
+	 */
 	public function wordpress_salesforce_tables() {
 
 		$charset_collate = $this->wpdb->get_charset_collate();
@@ -111,10 +111,10 @@ 
 	}
 
 	/**
-	* Check for database version on plugin upgrade
-	* When the plugin is upgraded, if the database version does not match the current version, perform these methods
-	*
-	*/
+	 * Check for database version on plugin upgrade
+	 * When the plugin is upgraded, if the database version does not match the current version, perform these methods
+	 *
+	 */
 	public function wordpress_salesforce_update_db_check() {
 		if ( get_site_option( 'object_sync_for_salesforce_db_version' ) !== $this->version ) {
 			$this->wordpress_salesforce_tables();
@@ -122,12 +122,12 @@ 
 	}
 
 	/**
-	* Add roles and capabilities
-	* This adds the configure_salesforce capability to the admin role
-	*
-	* It also allows other plugins to add the capability to other roles
-	*
-	*/
+	 * Add roles and capabilities
+	 * This adds the configure_salesforce capability to the admin role
+	 *
+	 * It also allows other plugins to add the capability to other roles
+	 *
+	 */
 	public function add_roles_capabilities() {
 
 		// by default, only administrators can configure the plugin

classes/salesforce_pull.php

Indentation +93 added lines, -93 removed lines

@@ -24,24 +24,24 @@ 
 	protected $schedulable_classes;
 
 	/**
-	* @var string
-	*/
+	 * @var string
+	 */
 	public $schedule_name; // allow for naming the queue in case there are multiple queues
 
 	/**
-	* Constructor which sets up pull schedule
-	*
-	* @param object $wpdb
-	* @param string $version
-	* @param array $login_credentials
-	* @param string $slug
-	* @param object $wordpress
-	* @param object $salesforce
-	* @param object $mappings
-	* @param object $logging
-	* @param array $schedulable_classes
-	* @throws \Exception
-	*/
+	 * Constructor which sets up pull schedule
+	 *
+	 * @param object $wpdb
+	 * @param string $version
+	 * @param array $login_credentials
+	 * @param string $slug
+	 * @param object $wordpress
+	 * @param object $salesforce
+	 * @param object $mappings
+	 * @param object $logging
+	 * @param array $schedulable_classes
+	 * @throws \Exception
+	 */
 	public function __construct( $wpdb, $version, $login_credentials, $slug, $wordpress, $salesforce, $mappings, $logging, $schedulable_classes ) {
 		$this->wpdb                = $wpdb;
 		$this->version             = $version;
@@ -70,19 +70,19 @@ 
 	}
 
 	/**
-	* Create the action hooks based on what object maps exist from the admin settings
-	*
-	*/
+	 * Create the action hooks based on what object maps exist from the admin settings
+	 *
+	 */
 	private function add_actions() {
 		add_action( 'wp_ajax_salesforce_pull_webhook', array( $this, 'salesforce_pull_webhook' ) );
 	}
 
 	/**
-	* Ajax callback for salesforce pull. Returns status of 200 for successful
-	* attempt or 403 for a failed pull attempt (SF not authorized, threshhold
-	* reached, etc.
-	* this is the ajax callback; not a cron run
-	*/
+	 * Ajax callback for salesforce pull. Returns status of 200 for successful
+	 * attempt or 403 for a failed pull attempt (SF not authorized, threshhold
+	 * reached, etc.
+	 * this is the ajax callback; not a cron run
+	 */
 	public function salesforce_pull_webhook() {
 
 		if ( true === $this->salesforce_pull() ) {
@@ -102,8 +102,8 @@ 
 	}
 
 	/**
-	* Callback for the standard pull process used by webhooks and cron.
-	*/
+	 * Callback for the standard pull process used by webhooks and cron.
+	 */
 	public function salesforce_pull() {
 		$sfapi = $this->salesforce['sfapi'];
 
@@ -123,9 +123,9 @@ 
 	}
 
 	/**
-	* Load schedule
-	* This loads the schedule class
-	*/
+	 * Load schedule
+	 * This loads the schedule class
+	 */
 	private function schedule() {
 		if ( ! class_exists( 'Object_Sync_Sf_Schedule' ) && file_exists( plugin_dir_path( __FILE__ ) . '../vendor/autoload.php' ) ) {
 			require_once plugin_dir_path( __FILE__ ) . '../vendor/autoload.php';
@@ -137,13 +137,13 @@ 
 	}
 
 	/**
-	* Determines if the Salesforce pull should be allowed, or throttled.
-	*
-	* Prevents too many pull processes from running at once.
-	*
-	* @return bool
-	*    Returns false if the time elapsed between recent pulls is too short.
-	*/
+	 * Determines if the Salesforce pull should be allowed, or throttled.
+	 *
+	 * Prevents too many pull processes from running at once.
+	 *
+	 * @return bool
+	 *    Returns false if the time elapsed between recent pulls is too short.
+	 */
 	private function check_throttle() {
 		$pull_throttle = get_option( 'object_sync_for_salesforce_pull_throttle', 5 );
 		$last_sync     = get_option( 'object_sync_for_salesforce_pull_last_sync', 0 );
@@ -156,14 +156,14 @@ 
 	}
 
 	/**
-	* Pull updated records from Salesforce and place them in the queue.
-	*
-	* Executes a SOQL query based on defined mappings, loops through the results,
-	* and places each updated SF object into the queue for later processing.
-	*
-	* We copy the convention from the Drupal module here, and run a separate SOQL query for each type of object in SF
-	*
-	*/
+	 * Pull updated records from Salesforce and place them in the queue.
+	 *
+	 * Executes a SOQL query based on defined mappings, loops through the results,
+	 * and places each updated SF object into the queue for later processing.
+	 *
+	 * We copy the convention from the Drupal module here, and run a separate SOQL query for each type of object in SF
+	 *
+	 */
 	private function get_updated_records() {
 		$sfapi = $this->salesforce['sfapi'];
 		foreach ( $this->mappings->get_fieldmaps() as $salesforce_mapping ) {
@@ -329,18 +329,18 @@ 
 	}
 
 	/**
-	* Given a SObject type name, build an SOQL query to include all fields for all
-	* SalesforceMappings mapped to that SObject.
-	*
-	* @param string $type
-	*   e.g. "Contact", "Account", etc.
-	*
-	* @return Object_Sync_Sf_Salesforce_Select_Query or null if no mappings or no mapped fields
-	*   were found.
-	*
-	* @see Object_Sync_Sf_Mapping::get_mapped_fields
-	* @see Object_Sync_Sf_Mapping::get_mapped_record_types
-	*/
+	 * Given a SObject type name, build an SOQL query to include all fields for all
+	 * SalesforceMappings mapped to that SObject.
+	 *
+	 * @param string $type
+	 *   e.g. "Contact", "Account", etc.
+	 *
+	 * @return Object_Sync_Sf_Salesforce_Select_Query or null if no mappings or no mapped fields
+	 *   were found.
+	 *
+	 * @see Object_Sync_Sf_Mapping::get_mapped_fields
+	 * @see Object_Sync_Sf_Mapping::get_mapped_record_types
+	 */
 	private function get_pull_query( $type, $salesforce_mapping = array() ) {
 		$mapped_fields       = array();
 		$mapped_record_types = array();
@@ -422,10 +422,10 @@ 
 	}
 
 	/**
-	* Get deleted records from salesforce.
-	* Note that deletions can only be queried via REST with an API version >= 29.0.
-	*
-	*/
+	 * Get deleted records from salesforce.
+	 * Note that deletions can only be queried via REST with an API version >= 29.0.
+	 *
+	 */
 	private function get_deleted_records() {
 
 		$sfapi = $this->salesforce['sfapi'];
@@ -517,13 +517,13 @@ 
 	}
 
 	/**
-	* Method for ajax hooks to call for pulling manually
-	*
-	* @param string $object_type
-	* @param string $salesforce_id
-	* @param string $wordpress_object
-	*
-	*/
+	 * Method for ajax hooks to call for pulling manually
+	 *
+	 * @param string $object_type
+	 * @param string $salesforce_id
+	 * @param string $wordpress_object
+	 *
+	 */
 	public function manual_pull( $object_type, $salesforce_id, $wordpress_object ) {
 		$sfapi   = $this->salesforce['sfapi'];
 		$object  = $sfapi->api_call( 'sobjects/' . $object_type . '/' . $salesforce_id );
@@ -538,20 +538,20 @@ 
 	}
 
 	/**
-	* Sync WordPress objects and Salesforce objects from the queue using the REST API.
-	*
-	* @param string $object_type
-	*   Type of Salesforce object.
-	* @param object $object
-	*   The Salesforce object.
-	* @param object $mapping
-	*   Salesforce/WP mapping object.
-	* @param int $sf_sync_trigger
-	*   Trigger for this sync.
-	*
-	* @return true or exit the method
-	*
-	*/
+	 * Sync WordPress objects and Salesforce objects from the queue using the REST API.
+	 *
+	 * @param string $object_type
+	 *   Type of Salesforce object.
+	 * @param object $object
+	 *   The Salesforce object.
+	 * @param object $mapping
+	 *   Salesforce/WP mapping object.
+	 * @param int $sf_sync_trigger
+	 *   Trigger for this sync.
+	 *
+	 * @return true or exit the method
+	 *
+	 */
 	public function salesforce_pull_process_records( $object_type, $object, $mapping, $sf_sync_trigger ) {
 		$mapping_conditions = array(
 			'salesforce_object' => $object_type,
@@ -1282,19 +1282,19 @@ 
 	}
 
 	/**
-	* Create an object map between a Salesforce object and a WordPress object
-	*
-	* @param array $salesforce_object
-	*   Array of the salesforce object's data
-	* @param string $wordpress_id
-	*   Unique identifier for the WordPress object
-	* @param array $field_mapping
-	*   The row that maps the object types together, including which fields match which other fields
-	*
-	* @return int $wpdb->insert_id
-	*   This is the database row for the map object
-	*
-	*/
+	 * Create an object map between a Salesforce object and a WordPress object
+	 *
+	 * @param array $salesforce_object
+	 *   Array of the salesforce object's data
+	 * @param string $wordpress_id
+	 *   Unique identifier for the WordPress object
+	 * @param array $field_mapping
+	 *   The row that maps the object types together, including which fields match which other fields
+	 *
+	 * @return int $wpdb->insert_id
+	 *   This is the database row for the map object
+	 *
+	 */
 	private function create_object_map( $salesforce_object, $wordpress_id, $field_mapping ) {
 		// Create object map and save it
 		$mapping_object = $this->mappings->create_object_map(

classes/admin.php

Indentation +231 added lines, -231 removed lines

@@ -26,62 +26,62 @@ 
 	protected $schedulable_classes;
 
 	/**
-	* @var string
-	* Default path for the Salesforce authorize URL
-	*/
+	 * @var string
+	 * Default path for the Salesforce authorize URL
+	 */
 	public $default_authorize_url_path;
 
 	/**
-	* @var string
-	* Default path for the Salesforce token URL
-	*/
+	 * @var string
+	 * Default path for the Salesforce token URL
+	 */
 	public $default_token_url_path;
 
 	/**
-	* @var string
-	* What version of the Salesforce API should be the default on the settings screen.
-	* Users can edit this, but they won't see a correct list of all their available versions until WordPress has
-	* been authenticated with Salesforce.
-	*/
+	 * @var string
+	 * What version of the Salesforce API should be the default on the settings screen.
+	 * Users can edit this, but they won't see a correct list of all their available versions until WordPress has
+	 * been authenticated with Salesforce.
+	 */
 	public $default_api_version;
 
 	/**
-	* @var bool
-	* Default for whether to limit to triggerable items
-	* Users can edit this
-	*/
+	 * @var bool
+	 * Default for whether to limit to triggerable items
+	 * Users can edit this
+	 */
 	public $default_triggerable;
 
 	/**
-	* @var bool
-	* Default for whether to limit to updateable items
-	* Users can edit this
-	*/
+	 * @var bool
+	 * Default for whether to limit to updateable items
+	 * Users can edit this
+	 */
 	public $default_updateable;
 
 	/**
-	* @var int
-	* Default pull throttle for how often Salesforce can pull
-	* Users can edit this
-	*/
+	 * @var int
+	 * Default pull throttle for how often Salesforce can pull
+	 * Users can edit this
+	 */
 	public $default_pull_throttle;
 
 	/**
-	* Constructor which sets up admin pages
-	*
-	* @param object $wpdb
-	* @param string $version
-	* @param array $login_credentials
-	* @param string $slug
-	* @param object $wordpress
-	* @param object $salesforce
-	* @param object $mappings
-	* @param object $push
-	* @param object $pull
-	* @param object $logging
-	* @param array $schedulable_classes
-	* @throws \Exception
-	*/
+	 * Constructor which sets up admin pages
+	 *
+	 * @param object $wpdb
+	 * @param string $version
+	 * @param array $login_credentials
+	 * @param string $slug
+	 * @param object $wordpress
+	 * @param object $salesforce
+	 * @param object $mappings
+	 * @param object $push
+	 * @param object $pull
+	 * @param object $logging
+	 * @param array $schedulable_classes
+	 * @throws \Exception
+	 */
 	public function __construct( $wpdb, $version, $login_credentials, $slug, $wordpress, $salesforce, $mappings, $push, $pull, $logging, $schedulable_classes ) {
 		$this->wpdb                = $wpdb;
 		$this->version             = $version;
@@ -117,9 +117,9 @@ 
 	}
 
 	/**
-	* Create the action hooks to create the admin page(s)
-	*
-	*/
+	 * Create the action hooks to create the admin page(s)
+	 *
+	 */
 	public function add_actions() {
 		add_action( 'admin_init', array( $this, 'salesforce_settings_forms' ) );
 		add_action( 'admin_init', array( $this, 'notices' ) );
@@ -148,21 +148,21 @@ 
 	}
 
 	/**
-	* Create WordPress admin options page
-	*
-	*/
+	 * Create WordPress admin options page
+	 *
+	 */
 	public function create_admin_menu() {
 		$title = __( 'Salesforce', 'object-sync-for-salesforce' );
 		add_options_page( $title, $title, 'configure_salesforce', 'object-sync-salesforce-admin', array( $this, 'show_admin_page' ) );
 	}
 
 	/**
-	* Render full admin pages in WordPress
-	* This allows other plugins to add tabs to the Salesforce settings screen
-	*
-	* todo: better front end: html, organization of html into templates, css, js
-	*
-	*/
+	 * Render full admin pages in WordPress
+	 * This allows other plugins to add tabs to the Salesforce settings screen
+	 *
+	 * todo: better front end: html, organization of html into templates, css, js
+	 *
+	 */
 	public function show_admin_page() {
 		$get_data = filter_input_array( INPUT_GET, FILTER_SANITIZE_STRING );
 		echo '<div class="wrap">';
@@ -372,10 +372,10 @@ 
 	}
 
 	/**
-	* Create default WordPress admin settings form for salesforce
-	* This is for the Settings page/tab
-	*
-	*/
+	 * Create default WordPress admin settings form for salesforce
+	 * This is for the Settings page/tab
+	 *
+	 */
 	public function salesforce_settings_forms() {
 		$get_data = filter_input_array( INPUT_GET, FILTER_SANITIZE_STRING );
 		$page     = isset( $get_data['tab'] ) ? sanitize_key( $get_data['tab'] ) : 'settings';
@@ -400,13 +400,13 @@ 
 	}
 
 	/**
-	* Fields for the Settings tab
-	* This runs add_settings_section once, as well as add_settings_field and register_setting methods for each option
-	*
-	* @param string $page
-	* @param string $section
-	* @param string $input_callback
-	*/
+	 * Fields for the Settings tab
+	 * This runs add_settings_section once, as well as add_settings_field and register_setting methods for each option
+	 *
+	 * @param string $page
+	 * @param string $section
+	 * @param string $input_callback
+	 */
 	private function fields_settings( $page, $section, $callbacks ) {
 		add_settings_section( $page, ucwords( $page ), null, $page );
 		$salesforce_settings = array(
@@ -611,25 +611,25 @@ 
 	}
 
 	/**
-	* Fields for the Fieldmaps tab
-	* This runs add_settings_section once, as well as add_settings_field and register_setting methods for each option
-	*
-	* @param string $page
-	* @param string $section
-	* @param string $input_callback
-	*/
+	 * Fields for the Fieldmaps tab
+	 * This runs add_settings_section once, as well as add_settings_field and register_setting methods for each option
+	 *
+	 * @param string $page
+	 * @param string $section
+	 * @param string $input_callback
+	 */
 	private function fields_fieldmaps( $page, $section, $input_callback = '' ) {
 		add_settings_section( $page, ucwords( $page ), null, $page );
 	}
 
 	/**
-	* Fields for the Scheduling tab
-	* This runs add_settings_section once, as well as add_settings_field and register_setting methods for each option
-	*
-	* @param string $page
-	* @param string $section
-	* @param string $input_callback
-	*/
+	 * Fields for the Scheduling tab
+	 * This runs add_settings_section once, as well as add_settings_field and register_setting methods for each option
+	 *
+	 * @param string $page
+	 * @param string $section
+	 * @param string $input_callback
+	 */
 	private function fields_scheduling( $page, $section, $callbacks ) {
 		foreach ( $this->schedulable_classes as $key => $value ) {
 			add_settings_section( $key, $value['label'], null, $page );
@@ -708,13 +708,13 @@ 
 	}
 
 	/**
-	* Fields for the Log Settings tab
-	* This runs add_settings_section once, as well as add_settings_field and register_setting methods for each option
-	*
-	* @param string $page
-	* @param string $section
-	* @param array $callbacks
-	*/
+	 * Fields for the Log Settings tab
+	 * This runs add_settings_section once, as well as add_settings_field and register_setting methods for each option
+	 *
+	 * @param string $page
+	 * @param string $section
+	 * @param array $callbacks
+	 */
 	private function fields_log_settings( $page, $section, $callbacks ) {
 		add_settings_section( $page, ucwords( str_replace( '_', ' ', $page ) ), null, $page );
 		$log_settings = array(
@@ -892,9 +892,9 @@ 
 	}
 
 	/**
-	* Create the notices, settings, and conditions by which admin notices should appear
-	*
-	*/
+	 * Create the notices, settings, and conditions by which admin notices should appear
+	 *
+	 */
 	public function notices() {
 
 		// before a notice is displayed, we should make sure we are on a page related to this plugin
@@ -967,14 +967,14 @@ 
 	}
 
 	/**
-	* Get all the Salesforce object settings for fieldmapping
-	* This takes either the $_POST array via ajax, or can be directly called with a $data array
-	*
-	* @param array $data
-	* data must contain a salesforce_object
-	* can optionally contain a type
-	* @return array $object_settings
-	*/
+	 * Get all the Salesforce object settings for fieldmapping
+	 * This takes either the $_POST array via ajax, or can be directly called with a $data array
+	 *
+	 * @param array $data
+	 * data must contain a salesforce_object
+	 * can optionally contain a type
+	 * @return array $object_settings
+	 */
 	public function get_salesforce_object_description( $data = array() ) {
 		$ajax = false;
 		if ( empty( $data ) ) {
@@ -1022,13 +1022,13 @@ 
 	}
 
 	/**
-	* Get Salesforce object fields for fieldmapping
-	*
-	* @param array $data
-	* data must contain a salesforce_object
-	* can optionally contain a type for the field
-	* @return array $object_fields
-	*/
+	 * Get Salesforce object fields for fieldmapping
+	 *
+	 * @param array $data
+	 * data must contain a salesforce_object
+	 * can optionally contain a type for the field
+	 * @return array $object_fields
+	 */
 	public function get_salesforce_object_fields( $data = array() ) {
 
 		if ( ! empty( $data['salesforce_object'] ) ) {
@@ -1056,12 +1056,12 @@ 
 	}
 
 	/**
-	* Get WordPress object fields for fieldmapping
-	* This takes either the $_POST array via ajax, or can be directly called with a $wordpress_object field
-	*
-	* @param string $wordpress_object
-	* @return array $object_fields
-	*/
+	 * Get WordPress object fields for fieldmapping
+	 * This takes either the $_POST array via ajax, or can be directly called with a $wordpress_object field
+	 *
+	 * @param string $wordpress_object
+	 * @return array $object_fields
+	 */
 	public function get_wordpress_object_fields( $wordpress_object = '' ) {
 		$ajax      = false;
 		$post_data = filter_input_array( INPUT_POST, FILTER_SANITIZE_STRING );
@@ -1080,13 +1080,13 @@ 
 	}
 
 	/**
-	* Get WordPress and Salesforce object fields together for fieldmapping
-	* This takes either the $_POST array via ajax, or can be directly called with $wordpress_object and $salesforce_object fields
-	*
-	* @param string $wordpress_object
-	* @param string $salesforce_object
-	* @return array $object_fields
-	*/
+	 * Get WordPress and Salesforce object fields together for fieldmapping
+	 * This takes either the $_POST array via ajax, or can be directly called with $wordpress_object and $salesforce_object fields
+	 *
+	 * @param string $wordpress_object
+	 * @param string $salesforce_object
+	 * @return array $object_fields
+	 */
 	public function get_wp_sf_object_fields( $wordpress_object = '', $salesforce = '' ) {
 		$post_data = filter_input_array( INPUT_POST, FILTER_SANITIZE_STRING );
 		if ( empty( $wordpress_object ) ) {
@@ -1111,12 +1111,12 @@ 
 	}
 
 	/**
-	* Manually push the WordPress object to Salesforce
-	* This takes either the $_POST array via ajax, or can be directly called with $wordpress_object and $wordpress_id fields
-	*
-	* @param string $wordpress_object
-	* @param int $wordpress_id
-	*/
+	 * Manually push the WordPress object to Salesforce
+	 * This takes either the $_POST array via ajax, or can be directly called with $wordpress_object and $wordpress_id fields
+	 *
+	 * @param string $wordpress_object
+	 * @param int $wordpress_id
+	 */
 	public function push_to_salesforce( $wordpress_object = '', $wordpress_id = '' ) {
 		$post_data = filter_input_array( INPUT_POST, FILTER_SANITIZE_STRING );
 		if ( empty( $wordpress_object ) && empty( $wordpress_id ) ) {
@@ -1135,12 +1135,12 @@ 
 	}
 
 	/**
-	* Manually pull the Salesforce object into WordPress
-	* This takes either the $_POST array via ajax, or can be directly called with $salesforce_id fields
-	*
-	* @param string $salesforce_id
-	* @param string $wordpress_object
-	*/
+	 * Manually pull the Salesforce object into WordPress
+	 * This takes either the $_POST array via ajax, or can be directly called with $salesforce_id fields
+	 *
+	 * @param string $salesforce_id
+	 * @param string $wordpress_object
+	 */
 	public function pull_from_salesforce( $salesforce_id = '', $wordpress_object = '' ) {
 		$post_data = filter_input_array( INPUT_POST, FILTER_SANITIZE_STRING );
 		if ( empty( $wordpress_object ) && empty( $salesforce_id ) ) {
@@ -1157,11 +1157,11 @@ 
 	}
 
 	/**
-	* Manually pull the Salesforce object into WordPress
-	* This takes an id for a mapping object row
-	*
-	* @param int $mapping_id
-	*/
+	 * Manually pull the Salesforce object into WordPress
+	 * This takes an id for a mapping object row
+	 *
+	 * @param int $mapping_id
+	 */
 	public function refresh_mapped_data( $mapping_id = '' ) {
 		$post_data = filter_input_array( INPUT_POST, FILTER_SANITIZE_STRING );
 		if ( empty( $mapping_id ) ) {
@@ -1180,13 +1180,13 @@ 
 	}
 
 	/**
-	* Prepare fieldmap data and redirect after processing
-	* This runs when the create or update forms are submitted
-	* It is public because it depends on an admin hook
-	* It then calls the Object_Sync_Sf_Mapping class and sends prepared data over to it, then redirects to the correct page
-	* This method does include error handling, by loading the submission in a transient if there is an error, and then deleting it upon success
-	*
-	*/
+	 * Prepare fieldmap data and redirect after processing
+	 * This runs when the create or update forms are submitted
+	 * It is public because it depends on an admin hook
+	 * It then calls the Object_Sync_Sf_Mapping class and sends prepared data over to it, then redirects to the correct page
+	 * This method does include error handling, by loading the submission in a transient if there is an error, and then deleting it upon success
+	 *
+	 */
 	public function prepare_fieldmap_data() {
 		$error     = false;
 		$post_data = filter_input_array( INPUT_POST, FILTER_SANITIZE_STRING );
@@ -1234,12 +1234,12 @@ 
 	}
 
 	/**
-	* Delete fieldmap data and redirect after processing
-	* This runs when the delete link is clicked, after the user confirms
-	* It is public because it depends on an admin hook
-	* It then calls the Object_Sync_Sf_Mapping class and the delete method
-	*
-	*/
+	 * Delete fieldmap data and redirect after processing
+	 * This runs when the delete link is clicked, after the user confirms
+	 * It is public because it depends on an admin hook
+	 * It then calls the Object_Sync_Sf_Mapping class and the delete method
+	 *
+	 */
 	public function delete_fieldmap() {
 		$post_data = filter_input_array( INPUT_POST, FILTER_SANITIZE_STRING );
 		if ( $post_data['id'] ) {
@@ -1255,13 +1255,13 @@ 
 	}
 
 	/**
-	* Prepare object data and redirect after processing
-	* This runs when the update form is submitted
-	* It is public because it depends on an admin hook
-	* It then calls the Object_Sync_Sf_Mapping class and sends prepared data over to it, then redirects to the correct page
-	* This method does include error handling, by loading the submission in a transient if there is an error, and then deleting it upon success
-	*
-	*/
+	 * Prepare object data and redirect after processing
+	 * This runs when the update form is submitted
+	 * It is public because it depends on an admin hook
+	 * It then calls the Object_Sync_Sf_Mapping class and sends prepared data over to it, then redirects to the correct page
+	 * This method does include error handling, by loading the submission in a transient if there is an error, and then deleting it upon success
+	 *
+	 */
 	public function prepare_object_map_data() {
 		$error     = false;
 		$post_data = filter_input_array( INPUT_POST, FILTER_SANITIZE_STRING );
@@ -1300,12 +1300,12 @@ 
 	}
 
 	/**
-	* Delete object map data and redirect after processing
-	* This runs when the delete link is clicked on an error row, after the user confirms
-	* It is public because it depends on an admin hook
-	* It then calls the Object_Sync_Sf_Mapping class and the delete method
-	*
-	*/
+	 * Delete object map data and redirect after processing
+	 * This runs when the delete link is clicked on an error row, after the user confirms
+	 * It is public because it depends on an admin hook
+	 * It then calls the Object_Sync_Sf_Mapping class and the delete method
+	 *
+	 */
 	public function delete_object_map() {
 		$post_data = filter_input_array( INPUT_POST, FILTER_SANITIZE_STRING );
 		if ( $post_data['id'] ) {
@@ -1321,9 +1321,9 @@ 
 	}
 
 	/**
-	* Import a json file and use it for plugin data
-	*
-	*/
+	 * Import a json file and use it for plugin data
+	 *
+	 */
 	public function import_json_file() {
 
 		if ( ! wp_verify_nonce( $_POST['object_sync_for_salesforce_nonce_import'], 'object_sync_for_salesforce_nonce_import' ) ) {
@@ -1421,9 +1421,9 @@ 
 	}
 
 	/**
-	* Create a json file for exporting
-	*
-	*/
+	 * Create a json file for exporting
+	 *
+	 */
 	public function export_json_file() {
 
 		if ( ! wp_verify_nonce( $_POST['object_sync_for_salesforce_nonce_export'], 'object_sync_for_salesforce_nonce_export' ) ) {
@@ -1452,10 +1452,10 @@ 
 	}
 
 	/**
-	* Default display for <input> fields
-	*
-	* @param array $args
-	*/
+	 * Default display for <input> fields
+	 *
+	 * @param array $args
+	 */
 	public function display_input_field( $args ) {
 		$type    = $args['type'];
 		$id      = $args['label_for'];
@@ -1502,11 +1502,11 @@ 
 	}
 
 	/**
-	* Display for multiple checkboxes
-	* Above method can handle a single checkbox as it is
-	*
-	* @param array $args
-	*/
+	 * Display for multiple checkboxes
+	 * Above method can handle a single checkbox as it is
+	 *
+	 * @param array $args
+	 */
 	public function display_checkboxes( $args ) {
 		$type    = 'checkbox';
 		$name    = $args['name'];
@@ -1540,10 +1540,10 @@ 
 	}
 
 	/**
-	* Display for a dropdown
-	*
-	* @param array $args
-	*/
+	 * Display for a dropdown
+	 *
+	 * @param array $args
+	 */
 	public function display_select( $args ) {
 		$type = $args['type'];
 		$id   = $args['label_for'];
@@ -1587,10 +1587,10 @@ 
 	}
 
 	/**
-	* Dropdown formatted list of Salesforce API versions
-	*
-	* @return array $args
-	*/
+	 * Dropdown formatted list of Salesforce API versions
+	 *
+	 * @return array $args
+	 */
 	private function version_options() {
 		$versions = $this->salesforce['sfapi']->get_api_versions();
 		$args     = array();
@@ -1604,10 +1604,10 @@ 
 	}
 
 	/**
-	* Default display for <a href> links
-	*
-	* @param array $args
-	*/
+	 * Default display for <a href> links
+	 *
+	 * @param array $args
+	 */
 	public function display_link( $args ) {
 		$label = $args['label'];
 		$desc  = $args['desc'];
@@ -1634,10 +1634,10 @@ 
 	}
 
 	/**
-	* Run a demo of Salesforce API call on the authenticate tab after WordPress has authenticated with it
-	*
-	* @param object $sfapi
-	*/
+	 * Run a demo of Salesforce API call on the authenticate tab after WordPress has authenticated with it
+	 *
+	 * @param object $sfapi
+	 */
 	private function status( $sfapi ) {
 
 		$versions = $sfapi->get_api_versions();
@@ -1696,10 +1696,10 @@ 
 	}
 
 	/**
-	* Deauthorize WordPress from Salesforce.
-	* This deletes the tokens from the database; it does not currently do anything in Salesforce
-	* For this plugin at this time, that is the decision we are making: don't do any kind of authorization stuff inside Salesforce
-	*/
+	 * Deauthorize WordPress from Salesforce.
+	 * This deletes the tokens from the database; it does not currently do anything in Salesforce
+	 * For this plugin at this time, that is the decision we are making: don't do any kind of authorization stuff inside Salesforce
+	 */
 	private function logout() {
 		$this->access_token  = delete_option( $this->option_prefix . 'access_token' );
 		$this->instance_url  = delete_option( $this->option_prefix . 'instance_url' );
@@ -1711,8 +1711,8 @@ 
 	}
 
 	/**
-	* Ajax call to clear the plugin cache.
-	*/
+	 * Ajax call to clear the plugin cache.
+	 */
 	public function clear_sfwp_cache() {
 		$result   = $this->clear_cache( true );
 		$response = array(
@@ -1723,9 +1723,9 @@ 
 	}
 
 	/**
-	* Clear the plugin's cache.
-	* This uses the flush method contained in the WordPress cache to clear all of this plugin's cached data.
-	*/
+	 * Clear the plugin's cache.
+	 * This uses the flush method contained in the WordPress cache to clear all of this plugin's cached data.
+	 */
 	private function clear_cache( $ajax = false ) {
 		$result = (bool) $this->wordpress->sfwp_transients->flush();
 		if ( true === $result ) {
@@ -1745,9 +1745,9 @@ 
 	}
 
 	/**
-	* Check WordPress Admin permissions
-	* Check if the current user is allowed to access the Salesforce plugin options
-	*/
+	 * Check WordPress Admin permissions
+	 * Check if the current user is allowed to access the Salesforce plugin options
+	 */
 	private function check_wordpress_admin_permissions() {
 
 		// one programmatic way to give this capability to additional user roles is the
@@ -1767,10 +1767,10 @@ 
 	}
 
 	/**
-	* Show what we know about this user's relationship to a Salesforce object, if any
-	* @param object $user
-	*
-	*/
+	 * Show what we know about this user's relationship to a Salesforce object, if any
+	 * @param object $user
+	 *
+	 */
 	public function show_salesforce_user_fields( $user ) {
 		$get_data = filter_input_array( INPUT_GET, FILTER_SANITIZE_STRING );
 		if ( true === $this->check_wordpress_admin_permissions() ) {
@@ -1794,10 +1794,10 @@ 
 	}
 
 	/**
-	* If the user profile has been mapped to Salesforce, do it
-	* @param int $user_id
-	*
-	*/
+	 * If the user profile has been mapped to Salesforce, do it
+	 * @param int $user_id
+	 *
+	 */
 	public function save_salesforce_user_fields( $user_id ) {
 		$post_data = filter_input_array( INPUT_POST, FILTER_SANITIZE_STRING );
 		if ( isset( $post_data['salesforce_update_mapped_user'] ) && '1' === rawurlencode( $post_data['salesforce_update_mapped_user'] ) ) {
@@ -1822,10 +1822,10 @@ 
 	}
 
 	/**
-	* Render tabs for settings pages in admin
-	* @param array $tabs
-	* @param string $tab
-	*/
+	 * Render tabs for settings pages in admin
+	 * @param array $tabs
+	 * @param string $tab
+	 */
 	private function tabs( $tabs, $tab = '' ) {
 
 		$get_data        = filter_input_array( INPUT_GET, FILTER_SANITIZE_STRING );
@@ -1855,9 +1855,9 @@ 
 	}
 
 	/**
-	* Clear schedule
-	* This clears the schedule if the user clicks the button
-	*/
+	 * Clear schedule
+	 * This clears the schedule if the user clicks the button
+	 */
 	private function clear_schedule( $schedule_name = '' ) {
 		if ( '' !== $schedule_name ) {
 			$schedule = $this->schedule( $schedule_name );
@@ -1879,8 +1879,8 @@ 
 	}
 
 	/**
-	* Load the schedule class
-	*/
+	 * Load the schedule class
+	 */
 	private function schedule( $schedule_name ) {
 		if ( ! class_exists( 'Object_Sync_Sf_Schedule' ) && file_exists( plugin_dir_path( __FILE__ ) . '../vendor/autoload.php' ) ) {
 			require_once plugin_dir_path( __FILE__ ) . '../vendor/autoload.php';
@@ -1892,21 +1892,21 @@ 
 	}
 
 	/**
-	* Create an object map between a WordPress object and a Salesforce object
-	*
-	* @param int $wordpress_id
-	*   Unique identifier for the WordPress object
-	* @param string $wordpress_object
-	*   What kind of object is it?
-	* @param string $salesforce_id
-	*   Unique identifier for the Salesforce object
-	* @param string $action
-	*   Did we push or pull?
-	*
-	* @return int $wpdb->insert_id
-	*   This is the database row for the map object
-	*
-	*/
+	 * Create an object map between a WordPress object and a Salesforce object
+	 *
+	 * @param int $wordpress_id
+	 *   Unique identifier for the WordPress object
+	 * @param string $wordpress_object
+	 *   What kind of object is it?
+	 * @param string $salesforce_id
+	 *   Unique identifier for the Salesforce object
+	 * @param string $action
+	 *   Did we push or pull?
+	 *
+	 * @return int $wpdb->insert_id
+	 *   This is the database row for the map object
+	 *
+	 */
 	private function create_object_map( $wordpress_id, $wordpress_object, $salesforce_id, $action = '' ) {
 		// Create object map and save it
 		$mapping_object = $this->mappings->create_object_map(

classes/salesforce_push.php

Indentation +139 added lines, -139 removed lines

@@ -24,24 +24,24 @@ 
 	protected $schedulable_classes;
 
 	/**
-	* @var string
-	*/
+	 * @var string
+	 */
 	public $schedule_name; // allow for naming the queue in case there are multiple queues
 
 	/**
-	* Constructor which sets up push schedule
-	*
-	* @param object $wpdb
-	* @param string $version
-	* @param array $login_credentials
-	* @param string $slug
-	* @param object $wordpress
-	* @param object $salesforce
-	* @param object $mappings
-	* @param object $logging
-	* @param array $schedulable_classes
-	* @throws \Object_Sync_Sf_Exception
-	*/
+	 * Constructor which sets up push schedule
+	 *
+	 * @param object $wpdb
+	 * @param string $version
+	 * @param array $login_credentials
+	 * @param string $slug
+	 * @param object $wordpress
+	 * @param object $salesforce
+	 * @param object $mappings
+	 * @param object $logging
+	 * @param array $schedulable_classes
+	 * @throws \Object_Sync_Sf_Exception
+	 */
 	public function __construct( $wpdb, $version, $login_credentials, $slug, $wordpress, $salesforce, $mappings, $logging, $schedulable_classes ) {
 		$this->wpdb                = $wpdb;
 		$this->version             = $version;
@@ -62,10 +62,10 @@ 
 	}
 
 	/**
-	* Create the action hooks based on what object maps exist from the admin settings.
-	* We do not have any actions for blogroll at this time.
-	*
-	*/
+	 * Create the action hooks based on what object maps exist from the admin settings.
+	 * We do not have any actions for blogroll at this time.
+	 *
+	 */
 	private function add_actions() {
 		$db_version = get_option( 'object_sync_for_salesforce_db_version', false );
 		if ( $db_version === $this->version ) {
@@ -97,54 +97,54 @@ 
 	}
 
 	/**
-	* Method for ajax hooks to call for pushing manually
-	*
-	* @param array $object
-	* @param string $type
-	*
-	*/
+	 * Method for ajax hooks to call for pushing manually
+	 *
+	 * @param array $object
+	 * @param string $type
+	 *
+	 */
 	public function manual_object_update( $object, $type ) {
 		$this->salesforce_push_object_crud( $type, $object, $this->mappings->sync_wordpress_update, true );
 	}
 
 	/**
-	* Callback method for adding a user
-	*
-	* @param string $user_id
-	*/
+	 * Callback method for adding a user
+	 *
+	 * @param string $user_id
+	 */
 	public function add_user( $user_id ) {
 		$user = $this->wordpress->get_wordpress_object_data( 'user', $user_id );
 		$this->object_insert( $user, 'user' );
 	}
 
 	/**
-	* Callback method for editing a user
-	*
-	* @param string $user_id
-	* @param object $old_user_data
-	*/
+	 * Callback method for editing a user
+	 *
+	 * @param string $user_id
+	 * @param object $old_user_data
+	 */
 	public function edit_user( $user_id, $old_user_data ) {
 		$user = $this->wordpress->get_wordpress_object_data( 'user', $user_id );
 		$this->object_update( $user, 'user' );
 	}
 
 	/**
-	* Callback method for deleting a user
-	*
-	* @param string $user_id
-	*/
+	 * Callback method for deleting a user
+	 *
+	 * @param string $user_id
+	 */
 	public function delete_user( $user_id ) {
 		$user = $this->wordpress->get_wordpress_object_data( 'user', $user_id );
 		$this->object_delete( $user, 'user' );
 	}
 
 	/**
-	* Callback method for posts of any type
-	* This can handle create, update, and delete actions
-	*
-	* @param string $post_id
-	* @param object $post
-	*/
+	 * Callback method for posts of any type
+	 * This can handle create, update, and delete actions
+	 *
+	 * @param string $post_id
+	 * @param object $post
+	 */
 	public function post_actions( $post_id, $post ) {
 
 		$post_type = $post->post_type;
@@ -191,66 +191,66 @@ 
 	}
 
 	/**
-	* Callback method for adding an attachment
-	*
-	* @param string $post_id
-	*/
+	 * Callback method for adding an attachment
+	 *
+	 * @param string $post_id
+	 */
 	public function add_attachment( $post_id ) {
 		$attachment = $this->wordpress->get_wordpress_object_data( 'attachment', $post_id );
 		$this->object_insert( $attachment, 'attachment' );
 	}
 
 	/**
-	* Callback method for editing an attachment
-	*
-	* @param string $post_id
-	*/
+	 * Callback method for editing an attachment
+	 *
+	 * @param string $post_id
+	 */
 	public function edit_attachment( $post_id ) {
 		$attachment = $this->wordpress->get_wordpress_object_data( 'attachment', $post_id );
 		$this->object_update( $attachment, 'attachment' );
 	}
 
 	/**
-	* Callback method for editing an attachment
-	*
-	* @param string $post_id
-	*/
+	 * Callback method for editing an attachment
+	 *
+	 * @param string $post_id
+	 */
 	public function delete_attachment( $post_id ) {
 		$attachment = $this->wordpress->get_wordpress_object_data( 'attachment', $post_id );
 		$this->object_delete( $attachment, 'attachment' );
 	}
 
 	/**
-	* Callback method for adding a term
-	*
-	* @param string $term_id
-	* @param string $tt_id
-	* @param string $taxonomy
-	*/
+	 * Callback method for adding a term
+	 *
+	 * @param string $term_id
+	 * @param string $tt_id
+	 * @param string $taxonomy
+	 */
 	public function add_term( $term_id, $tt_id, $taxonomy ) {
 		$term = $this->wordpress->get_wordpress_object_data( $taxonomy, $term_id );
 		$this->object_insert( $term, $taxonomy );
 	}
 
 	/**
-	* Callback method for editing a term
-	*
-	* @param string $term_id
-	* @param string $taxonomy
-	*/
+	 * Callback method for editing a term
+	 *
+	 * @param string $term_id
+	 * @param string $taxonomy
+	 */
 	public function edit_term( $term_id, $taxonomy ) {
 		$term = $this->wordpress->get_wordpress_object_data( $taxonomy, $term_id );
 		$this->object_update( $term, $taxonomy );
 	}
 
 	/**
-	* Callback method for deleting a term
-	*
-	* @param int $term (id)
-	* @param int $term_taxonomy_id
-	* @param string $taxonomy (slug)
-	* @param object $deleted_term
-	*/
+	 * Callback method for deleting a term
+	 *
+	 * @param int $term (id)
+	 * @param int $term_taxonomy_id
+	 * @param string $taxonomy (slug)
+	 * @param object $deleted_term
+	 */
 	public function delete_term( $term, $tt_id, $taxonomy, $deleted_term ) {
 		$deleted_term = (array) $deleted_term;
 		$type         = $deleted_term['taxonomy'];
@@ -258,75 +258,75 @@ 
 	}
 
 	/**
-	* Callback method for adding a comment
-	*
-	* @param string $comment_id
-	* @param int|string comment_approved
-	* @param array $commentdata
-	*/
+	 * Callback method for adding a comment
+	 *
+	 * @param string $comment_id
+	 * @param int|string comment_approved
+	 * @param array $commentdata
+	 */
 	public function add_comment( $comment_id, $comment_approved, $commentdata = array() ) {
 		$comment = $this->wordpress->get_wordpress_object_data( 'comment', $comment_id );
 		$this->object_insert( $comment, 'comment' );
 	}
 
 	/**
-	* Callback method for editing a comment
-	*
-	* @param string $comment_id
-	*/
+	 * Callback method for editing a comment
+	 *
+	 * @param string $comment_id
+	 */
 	public function edit_comment( $comment_id ) {
 		$comment = $this->wordpress->get_wordpress_object_data( 'comment', $comment_id );
 		$this->object_update( $comment, 'comment' );
 	}
 
 	/**
-	* Callback method for deleting a comment
-	*
-	* @param string $comment_id
-	*/
+	 * Callback method for deleting a comment
+	 *
+	 * @param string $comment_id
+	 */
 	public function delete_comment( $comment_id ) {
 		$comment = $this->wordpress->get_wordpress_object_data( 'comment', $comment_id );
 		$this->object_delete( $comment, 'comment' );
 	}
 
 	/**
-	* Insert a new object
-	* This calls the overall push crud method, which controls queuing and sending data to the Salesforce class
-	*/
+	 * Insert a new object
+	 * This calls the overall push crud method, which controls queuing and sending data to the Salesforce class
+	 */
 	private function object_insert( $object, $type ) {
 		$this->salesforce_push_object_crud( $type, $object, $this->mappings->sync_wordpress_create );
 	}
 
 	/**
-	* Update an existing object
-	* This calls the overall push crud method, which controls queuing and sending data to the Salesforce class
-	*/
+	 * Update an existing object
+	 * This calls the overall push crud method, which controls queuing and sending data to the Salesforce class
+	 */
 	private function object_update( $object, $type ) {
 		$this->salesforce_push_object_crud( $type, $object, $this->mappings->sync_wordpress_update );
 	}
 
 	/**
-	* Delete an existing object
-	* This calls the overall push crud method, which controls queuing and sending data to the Salesforce class
-	*/
+	 * Delete an existing object
+	 * This calls the overall push crud method, which controls queuing and sending data to the Salesforce class
+	 */
 	private function object_delete( $object, $type ) {
 		$this->salesforce_push_object_crud( $type, $object, $this->mappings->sync_wordpress_delete );
 	}
 
 	/**
-	* Push objects to Salesforce.
-	* This method decides whether to do the processing immediately or queue it to the schedule class (or skip it based on another plugin's activity)
-	*
-	* @param string $object_type
-	*   Type of WordPress object.
-	* @param array $object
-	*   The WordPress data that needs to be sent to Salesforce.
-	* @param int $sf_sync_trigger
-	*   The trigger being responded to.
-	* @param bool $manual
-	*   Are we calling this manually?
-	*
-	*/
+	 * Push objects to Salesforce.
+	 * This method decides whether to do the processing immediately or queue it to the schedule class (or skip it based on another plugin's activity)
+	 *
+	 * @param string $object_type
+	 *   Type of WordPress object.
+	 * @param array $object
+	 *   The WordPress data that needs to be sent to Salesforce.
+	 * @param int $sf_sync_trigger
+	 *   The trigger being responded to.
+	 * @param bool $manual
+	 *   Are we calling this manually?
+	 *
+	 */
 	private function salesforce_push_object_crud( $object_type, $object, $sf_sync_trigger, $manual = false ) {
 
 		$structure       = $this->wordpress->get_wordpress_table_structure( $object_type );
@@ -451,20 +451,20 @@ 
 	}
 
 	/**
-	* Sync WordPress objects and Salesforce objects using the REST API.
-	*
-	* @param string $object_type
-	*   Type of WordPress object.
-	* @param object $object
-	*   The object object.
-	* @param object $mapping
-	*   Salesforce mapping object.
-	* @param int $sf_sync_trigger
-	*   Trigger for this sync.
-	*
-	* @return true or exit the method
-	*
-	*/
+	 * Sync WordPress objects and Salesforce objects using the REST API.
+	 *
+	 * @param string $object_type
+	 *   Type of WordPress object.
+	 * @param object $object
+	 *   The object object.
+	 * @param object $mapping
+	 *   Salesforce mapping object.
+	 * @param int $sf_sync_trigger
+	 *   Trigger for this sync.
+	 *
+	 * @return true or exit the method
+	 *
+	 */
 	public function salesforce_push_sync_rest( $object_type, $object, $mapping, $sf_sync_trigger ) {
 
 		// If Salesforce is not authorized, don't do anything.
@@ -1006,21 +1006,21 @@ 
 	}
 
 	/**
-	* Create an object map between a WordPress object and a Salesforce object
-	*
-	* @param array $wordpress_object
-	*   Array of the WordPress object's data
-	* @param string $id_field_name
-	*   How this object names its primary field. ie Id or comment_id or whatever
-	* @param string $salesforce_id
-	*   Unique identifier for the Salesforce object
-	* @param array $field_mapping
-	*   The row that maps the object types together, including which fields match which other fields
-	*
-	* @return int $wpdb->insert_id
-	*   This is the database row for the map object
-	*
-	*/
+	 * Create an object map between a WordPress object and a Salesforce object
+	 *
+	 * @param array $wordpress_object
+	 *   Array of the WordPress object's data
+	 * @param string $id_field_name
+	 *   How this object names its primary field. ie Id or comment_id or whatever
+	 * @param string $salesforce_id
+	 *   Unique identifier for the Salesforce object
+	 * @param array $field_mapping
+	 *   The row that maps the object types together, including which fields match which other fields
+	 *
+	 * @return int $wpdb->insert_id
+	 *   This is the database row for the map object
+	 *
+	 */
 	private function create_object_map( $wordpress_object, $id_field_name, $salesforce_id, $field_mapping, $pending = false ) {
 
 		if ( true === $pending ) {

classes/deactivate.php

Indentation +31 added lines, -31 removed lines

@@ -18,13 +18,13 @@ 
 	protected $version;
 
 	/**
-	* Constructor which sets up deactivate hooks
-	* @param object $wpdb
-	* @param string $version
-	* @param string $slug
-	* @param array $schedulable_classes
-	*
-	*/
+	 * Constructor which sets up deactivate hooks
+	 * @param object $wpdb
+	 * @param string $version
+	 * @param string $slug
+	 * @param array $schedulable_classes
+	 *
+	 */
 	public function __construct( $wpdb, $version, $slug, $schedulable_classes ) {
 		$this->wpdb                = $wpdb;
 		$this->version             = $version;
@@ -42,10 +42,10 @@ 
 	}
 
 	/**
-	* Drop database tables for Salesforce
-	* This removes the tables for fieldmaps (between types of objects) and object maps (between indidual instances of objects)
-	*
-	*/
+	 * Drop database tables for Salesforce
+	 * This removes the tables for fieldmaps (between types of objects) and object maps (between indidual instances of objects)
+	 *
+	 */
 	public function wordpress_salesforce_drop_tables() {
 		$field_map_table  = $this->wpdb->prefix . 'object_sync_sf_field_map';
 		$object_map_table = $this->wpdb->prefix . 'object_sync_sf_object_map';
@@ -55,10 +55,10 @@ 
 	}
 
 	/**
-	* Clear the scheduled tasks
-	* This removes all the scheduled tasks that are included in the plugin's $schedulable_classes array
-	*
-	*/
+	 * Clear the scheduled tasks
+	 * This removes all the scheduled tasks that are included in the plugin's $schedulable_classes array
+	 *
+	 */
 	public function clear_schedule() {
 		foreach ( $this->schedulable_classes as $key => $value ) {
 			wp_clear_scheduled_hook( $key );
@@ -66,21 +66,21 @@ 
 	}
 
 	/**
-	* Delete the log post type
-	* This removes the log post type
-	*
-	*/
+	 * Delete the log post type
+	 * This removes the log post type
+	 *
+	 */
 	public function delete_log_post_type() {
 		unregister_post_type( 'wp_log' );
 	}
 
 	/**
-	* Remove roles and capabilities
-	* This removes the configure_salesforce capability from the admin role
-	*
-	* It also allows other plugins to remove the capability from other roles
-	*
-	*/
+	 * Remove roles and capabilities
+	 * This removes the configure_salesforce capability from the admin role
+	 *
+	 * It also allows other plugins to remove the capability from other roles
+	 *
+	 */
 	public function remove_roles_capabilities() {
 
 		// by default, only administrators can configure the plugin
@@ -100,18 +100,18 @@ 
 	}
 
 	/**
-	* Flush the plugin cache
-	*
-	*/
+	 * Flush the plugin cache
+	 *
+	 */
 	public function flush_plugin_cache() {
 		$sfwp_transients = new Object_Sync_Sf_WordPress_Transient( 'sfwp_transients' );
 		$sfwp_transients->flush();
 	}
 
 	/**
-	* Clear the plugin options
-	*
-	*/
+	 * Clear the plugin options
+	 *
+	 */
 	public function delete_plugin_options() {
 		$table          = $this->wpdb->prefix . 'options';
 		$plugin_options = $this->wpdb->get_results( 'SELECT option_name FROM ' . $table . ' WHERE option_name LIKE "object_sync_for_salesforce_%"', ARRAY_A );

classes/schedule.php

Indentation +26 added lines, -26 removed lines

@@ -25,18 +25,18 @@ 
 	protected $logging;
 
 	/**
-	* Constructor which sets up schedule and handler for when schedule runs
-	*
-	* @param object $wpdb
-	* @param string $version
-	* @param array $login_credentials
-	* @param string $slug
-	* @param object $wordpress
-	* @param object $salesforce
-	* @param object $mappings
-	* @param string $schedule_name
-	* @throws \Exception
-	*/
+	 * Constructor which sets up schedule and handler for when schedule runs
+	 *
+	 * @param object $wpdb
+	 * @param string $version
+	 * @param array $login_credentials
+	 * @param string $slug
+	 * @param object $wordpress
+	 * @param object $salesforce
+	 * @param object $mappings
+	 * @param string $schedule_name
+	 * @throws \Exception
+	 */
 
 	public function __construct( $wpdb, $version, $login_credentials, $slug, $wordpress, $salesforce, $mappings, $schedule_name, $logging, $schedulable_classes ) {
 
@@ -59,18 +59,18 @@ 
 	}
 
 	/**
-	* Create the filters we need to run
-	*
-	*/
+	 * Create the filters we need to run
+	 *
+	 */
 	public function add_filters() {
 		add_filter( 'cron_schedules', array( $this, 'set_schedule_frequency' ) );
 	}
 
 	/**
-	* Convert the schedule frequency from the admin settings into an array
-	* interval must be in seconds for the class to use it
-	*
-	*/
+	 * Convert the schedule frequency from the admin settings into an array
+	 * interval must be in seconds for the class to use it
+	 *
+	 */
 	public function set_schedule_frequency( $schedules ) {
 
 		// create an option in the core schedules array for each one the plugin defines
@@ -108,10 +108,10 @@ 
 	}
 
 	/**
-	* Convert the schedule frequency from the admin settings into an array
-	* interval must be in seconds for the class to use it
-	*
-	*/
+	 * Convert the schedule frequency from the admin settings into an array
+	 * interval must be in seconds for the class to use it
+	 *
+	 */
 	public function get_schedule_frequency_key( $name = '' ) {
 
 		$schedule_number = get_option( 'object_sync_for_salesforce_' . $name . '_schedule_number', '' );
@@ -138,9 +138,9 @@ 
 	}
 
 	/**
-	* Convert the schedule frequency from the admin settings into seconds
-	*
-	*/
+	 * Convert the schedule frequency from the admin settings into seconds
+	 *
+	 */
 	public function get_schedule_frequency_seconds( $name = '' ) {
 
 		$schedule_number = get_option( 'object_sync_for_salesforce_' . $name . '_schedule_number', '' );

classes/salesforce_soap_partner.php

Indentation +3 added lines, -3 removed lines

@@ -22,9 +22,9 @@
 	public $wsdl;
 
 	/**
-	* Constructor which loads the SOAP client
-	*
-	*/
+	 * Constructor which loads the SOAP client
+	 *
+	 */
 	public function __construct( Object_Sync_Sf_Salesforce $sfapi, $wsdl = null ) {
 		if ( ! class_exists( 'SforceBaseClient' ) && file_exists( plugin_dir_path( __FILE__ ) . '../vendor/autoload.php' ) ) {
 			require_once plugin_dir_path( __FILE__ ) . '../vendor/developerforce/force.com-toolkit-for-php/soapclient/SforcePartnerClient.php';