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/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';

classes/activate.php

Indentation +30 added lines, -30 removed lines

@@ -21,13 +21,13 @@ 
 	private $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;
@@ -39,8 +39,8 @@ 
 	}
 
 	/**
-	* Activation hooks
-	*/
+	 * Activation hooks
+	 */
 	private function add_actions() {
 
 		// on initial activation, run these hooks
@@ -53,8 +53,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__ ) );
@@ -63,10 +63,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();
@@ -127,12 +127,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
@@ -153,15 +153,15 @@ 
 	}
 
 	/**
-	* 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
-	*
-	* @param object $upgrader_object
-	* @param array $hook_extra
-	*
-	* See https://developer.wordpress.org/reference/hooks/upgrader_process_complete/
-	*
-	*/
+	 * 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
+	 *
+	 * @param object $upgrader_object
+	 * @param array $hook_extra
+	 *
+	 * See https://developer.wordpress.org/reference/hooks/upgrader_process_complete/
+	 *
+	 */
 	public function wordpress_salesforce_update_db_check( $upgrader_object, $hook_extra ) {
 		if ( get_site_option( 'object_sync_for_salesforce_db_version' ) !== $this->version ) {
 			$this->wordpress_salesforce_tables();

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 ) {
 
@@ -60,9 +60,9 @@ 
 	}
 
 	/**
-	* Create the actions to run
-	*
-	*/
+	 * Create the actions to run
+	 *
+	 */
 	public function add_actions() {
 
 		// create a recurring action for each schedulable item
@@ -103,10 +103,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 set_schedule_frequency( $schedules ) {
 
 		// create an option in the core schedules array for each one the plugin defines
@@ -144,10 +144,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', '' );
@@ -174,9 +174,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/deactivate.php

Indentation +31 added lines, -31 removed lines

@@ -20,13 +20,13 @@ 
 	protected $schedulable_classes;
 
 	/**
-	* 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;
@@ -45,10 +45,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';
@@ -58,11 +58,11 @@ 
 	}
 
 	/**
-	* 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
 	// todo: fix this so it uses action scheduler's scheduled tasks instead
-	*
-	*/
+	 *
+	 */
 	public function clear_schedule() {
 		foreach ( $this->schedulable_classes as $key => $value ) {
 			wp_clear_scheduled_hook( $key );
@@ -70,21 +70,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
@@ -104,18 +104,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/salesforce_push.php

Indentation +145 added lines, -145 removed lines

@@ -26,26 +26,26 @@ 
 	protected $queue;
 
 	/**
-	* @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 string $option_prefix
-	* @param object $wordpress
-	* @param object $salesforce
-	* @param object $mappings
-	* @param object $logging
-	* @param array $schedulable_classes
-	* @param object $queue
-	* @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 string $option_prefix
+	 * @param object $wordpress
+	 * @param object $salesforce
+	 * @param object $mappings
+	 * @param object $logging
+	 * @param array $schedulable_classes
+	 * @param object $queue
+	 * @throws \Object_Sync_Sf_Exception
+	 */
 	public function __construct( $wpdb, $version, $login_credentials, $slug, $option_prefix, $wordpress, $salesforce, $mappings, $logging, $schedulable_classes, $queue ) {
 		$this->wpdb                = $wpdb;
 		$this->version             = $version;
@@ -69,10 +69,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.
+	 *
+	 */
 	public function add_actions() {
 		$db_version = get_option( $this->option_prefix . 'db_version', false );
 		if ( $db_version === $this->version ) {
@@ -113,63 +113,63 @@ 
 	}
 
 	/**
-	* 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 adding a user via the Ultimate Member plugin
-	*
-	* @param string $user_id
-	*/
+	 * Callback method for adding a user via the Ultimate Member plugin
+	 *
+	 * @param string $user_id
+	 */
 	public function um_add_user( $user_id, $form_data = array() ) {
 		$this->object_insert( $form_data, '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;
@@ -216,66 +216,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'];
@@ -283,75 +283,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 );
@@ -475,20 +475,20 @@ 
 	}
 
 	/**
-	* Sync WordPress objects and Salesforce objects using the REST API.
-	*
-	* @param string $object_type
-	*   Type of WordPress object.
-	* @param array|int $object|$object_id
-	*   The WordPress object data or its ID.
-	* @param array $mapping|$mapping_id
-	*   Salesforce field mapping data array or ID.
-	* @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 array|int $object|$object_id
+	 *   The WordPress object data or its ID.
+	 * @param array $mapping|$mapping_id
+	 *   Salesforce field mapping data array or ID.
+	 * @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 ( is_int( $object ) ) {
@@ -1041,21 +1041,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/salesforce.php

Indentation +408 added lines, -408 removed lines

@@ -17,33 +17,33 @@ 
 	public $response;
 
 	/**
-	* Constructor which initializes the Salesforce APIs.
-	*
-	* @param string $consumer_key
-	*   Salesforce key to connect to your Salesforce instance.
-	* @param string $consumer_secret
-	*   Salesforce secret to connect to your Salesforce instance.
-	* @param string $login_url
-	*   Login URL for Salesforce auth requests - differs for production and sandbox
-	* @param string $callback_url
-	*   WordPress URL where Salesforce should send you after authentication
-	* @param string $authorize_path
-	*   Oauth path that Salesforce wants
-	* @param string $token_path
-	*   Path Salesforce uses to give you a token
-	* @param string $rest_api_version
-	*   What version of the Salesforce REST API to use
-	* @param object $wordpress
-	*   Object for doing things to WordPress - retrieving data, cache, etc.
-	* @param string $slug
-	*   Slug for this plugin. Can be used for file including, especially
-	* @param string $option_prefix
-	*   Option prefix for this plugin. Used for getting and setting options, actions, etc.
-	* @param object $logging
-	*   Logging object for this plugin.
-	* @param array $schedulable_classes
-	*   array of classes that can have scheduled tasks specific to them
-	*/
+	 * Constructor which initializes the Salesforce APIs.
+	 *
+	 * @param string $consumer_key
+	 *   Salesforce key to connect to your Salesforce instance.
+	 * @param string $consumer_secret
+	 *   Salesforce secret to connect to your Salesforce instance.
+	 * @param string $login_url
+	 *   Login URL for Salesforce auth requests - differs for production and sandbox
+	 * @param string $callback_url
+	 *   WordPress URL where Salesforce should send you after authentication
+	 * @param string $authorize_path
+	 *   Oauth path that Salesforce wants
+	 * @param string $token_path
+	 *   Path Salesforce uses to give you a token
+	 * @param string $rest_api_version
+	 *   What version of the Salesforce REST API to use
+	 * @param object $wordpress
+	 *   Object for doing things to WordPress - retrieving data, cache, etc.
+	 * @param string $slug
+	 *   Slug for this plugin. Can be used for file including, especially
+	 * @param string $option_prefix
+	 *   Option prefix for this plugin. Used for getting and setting options, actions, etc.
+	 * @param object $logging
+	 *   Logging object for this plugin.
+	 * @param array $schedulable_classes
+	 *   array of classes that can have scheduled tasks specific to them
+	 */
 	public function __construct( $consumer_key, $consumer_secret, $login_url, $callback_url, $authorize_path, $token_path, $rest_api_version, $wordpress, $slug, $option_prefix, $logging, $schedulable_classes ) {
 		$this->consumer_key        = $consumer_key;
 		$this->consumer_secret     = $consumer_secret;
@@ -73,14 +73,14 @@ 
 	}
 
 	/**
-	* Converts a 15-character case-sensitive Salesforce ID to 18-character
-	* case-insensitive ID. If input is not 15-characters, return input unaltered.
-	*
-	* @param string $sf_id_15
-	*   15-character case-sensitive Salesforce ID
-	* @return string
-	*   18-character case-insensitive Salesforce ID
-	*/
+	 * Converts a 15-character case-sensitive Salesforce ID to 18-character
+	 * case-insensitive ID. If input is not 15-characters, return input unaltered.
+	 *
+	 * @param string $sf_id_15
+	 *   15-character case-sensitive Salesforce ID
+	 * @return string
+	 *   18-character case-insensitive Salesforce ID
+	 */
 	public static function convert_id( $sf_id_15 ) {
 		if ( strlen( $sf_id_15 ) !== 15 ) {
 			return $sf_id_15;
@@ -100,17 +100,17 @@ 
 	}
 
 	/**
-	* Given a Salesforce ID, return the corresponding SObject name. (Based on
-	*  keyPrefix from object definition, @see
-	*  https://developer.salesforce.com/forums/?id=906F0000000901ZIAQ )
-	*
-	* @param string $sf_id
-	*   15- or 18-character Salesforce ID
-	* @return string
-	*   sObject name, e.g. "Account", "Contact", "my__Custom_Object__c" or FALSE
-	*   if no match could be found.
-	* @throws Object_Sync_Sf_Exception
-	*/
+	 * Given a Salesforce ID, return the corresponding SObject name. (Based on
+	 *  keyPrefix from object definition, @see
+	 *  https://developer.salesforce.com/forums/?id=906F0000000901ZIAQ )
+	 *
+	 * @param string $sf_id
+	 *   15- or 18-character Salesforce ID
+	 * @return string
+	 *   sObject name, e.g. "Account", "Contact", "my__Custom_Object__c" or FALSE
+	 *   if no match could be found.
+	 * @throws Object_Sync_Sf_Exception
+	 */
 	public function get_sobject_type( $sf_id ) {
 		$objects = $this->objects(
 			array(
@@ -127,17 +127,17 @@ 
 	}
 
 	/**
-	* Determine if this SF instance is fully configured.
-	*
-	*/
+	 * Determine if this SF instance is fully configured.
+	 *
+	 */
 	public function is_authorized() {
 		return ! empty( $this->consumer_key ) && ! empty( $this->consumer_secret ) && $this->get_refresh_token();
 	}
 
 	/**
-	* Get REST API versions available on this Salesforce organization
-	* This is not an authenticated call, so it would not be a helpful test
-	*/
+	 * Get REST API versions available on this Salesforce organization
+	 * This is not an authenticated call, so it would not be a helpful test
+	 */
 	public function get_api_versions() {
 		$options = array(
 			'authenticated' => false,
@@ -147,26 +147,26 @@ 
 	}
 
 	/**
-	* Make a call to the Salesforce REST API.
-	*
-	* @param string $path
-	*   Path to resource.
-	* @param array $params
-	*   Parameters to provide.
-	* @param string $method
-	*   Method to initiate the call, such as GET or POST. Defaults to GET.
-	* @param array $options
-	*   Any method can supply options for the API call, and they'll be preserved as far as the curl request
-	*   They get merged with the class options
-	* @param string $type
-	*   Type of call. Defaults to 'rest' - currently we don't support other types.
-	*   Other exammple in Drupal is 'apexrest'
-	*
-	* @return mixed
-	*   The requested response.
-	*
-	* @throws Object_Sync_Sf_Exception
-	*/
+	 * Make a call to the Salesforce REST API.
+	 *
+	 * @param string $path
+	 *   Path to resource.
+	 * @param array $params
+	 *   Parameters to provide.
+	 * @param string $method
+	 *   Method to initiate the call, such as GET or POST. Defaults to GET.
+	 * @param array $options
+	 *   Any method can supply options for the API call, and they'll be preserved as far as the curl request
+	 *   They get merged with the class options
+	 * @param string $type
+	 *   Type of call. Defaults to 'rest' - currently we don't support other types.
+	 *   Other exammple in Drupal is 'apexrest'
+	 *
+	 * @return mixed
+	 *   The requested response.
+	 *
+	 * @throws Object_Sync_Sf_Exception
+	 */
 	public function api_call( $path, $params = array(), $method = 'GET', $options = array(), $type = 'rest' ) {
 		if ( ! $this->get_access_token() ) {
 			$this->refresh_token();
@@ -217,25 +217,25 @@ 
 	}
 
 	/**
-	* Private helper to issue an SF API request.
-	* This method is the only place where we read to or write from the cache
-	*
-	* @param string $path
-	*   Path to resource.
-	* @param array $params
-	*   Parameters to provide.
-	* @param string $method
-	*   Method to initiate the call, such as GET or POST.  Defaults to GET.
-	* @param array $options
-	*   This is the options array from the api_call method
-	*   This is where it gets merged with $this->options
-	* @param string $type
-	*   Type of call. Defaults to 'rest' - currently we don't support other types
-	*   Other exammple in Drupal is 'apexrest'
-	*
-	* @return array
-	*   The requested data.
-	*/
+	 * Private helper to issue an SF API request.
+	 * This method is the only place where we read to or write from the cache
+	 *
+	 * @param string $path
+	 *   Path to resource.
+	 * @param array $params
+	 *   Parameters to provide.
+	 * @param string $method
+	 *   Method to initiate the call, such as GET or POST.  Defaults to GET.
+	 * @param array $options
+	 *   This is the options array from the api_call method
+	 *   This is where it gets merged with $this->options
+	 * @param string $type
+	 *   Type of call. Defaults to 'rest' - currently we don't support other types
+	 *   Other exammple in Drupal is 'apexrest'
+	 *
+	 * @return array
+	 *   The requested data.
+	 */
 	protected function api_http_request( $path, $params, $method, $options = array(), $type = 'rest' ) {
 		$options = array_merge( $this->options, $options ); // this will override a value in $this->options with the one in $options if there is a matching key
 		$url     = $this->get_api_endpoint( $type ) . $path;
@@ -313,22 +313,22 @@ 
 	}
 
 	/**
-	* Make the HTTP request. Wrapper around curl().
-	*
-	* @param string $url
-	*   Path to make request from.
-	* @param array $data
-	*   The request body.
-	* @param array $headers
-	*   Request headers to send as name => value.
-	* @param string $method
-	*   Method to initiate the call, such as GET or POST. Defaults to GET.
-	* @param array $options
-	*   This is the options array from the api_http_request method
-	*
-	* @return array
-	*   Salesforce response object.
-	*/
+	 * Make the HTTP request. Wrapper around curl().
+	 *
+	 * @param string $url
+	 *   Path to make request from.
+	 * @param array $data
+	 *   The request body.
+	 * @param array $headers
+	 *   Request headers to send as name => value.
+	 * @param string $method
+	 *   Method to initiate the call, such as GET or POST. Defaults to GET.
+	 * @param array $options
+	 *   This is the options array from the api_http_request method
+	 *
+	 * @return array
+	 *   Salesforce response object.
+	 */
 	protected function http_request( $url, $data, $headers = array(), $method = 'GET', $options = array() ) {
 		// Build the request, including path and headers. Internal use.
 
@@ -463,14 +463,14 @@ 
 	}
 
 	/**
-	* Get the API end point for a given type of the API.
-	*
-	* @param string $api_type
-	*   E.g., rest, partner, enterprise.
-	*
-	* @return string
-	*   Complete URL endpoint for API access.
-	*/
+	 * Get the API end point for a given type of the API.
+	 *
+	 * @param string $api_type
+	 *   E.g., rest, partner, enterprise.
+	 *
+	 * @return string
+	 *   Complete URL endpoint for API access.
+	 */
 	public function get_api_endpoint( $api_type = 'rest' ) {
 		// Special handling for apexrest, since it's not in the identity object.
 		if ( 'apexrest' === $api_type ) {
@@ -486,67 +486,67 @@ 
 	}
 
 	/**
-	* Get the SF instance URL. Useful for linking to objects.
-	*/
+	 * Get the SF instance URL. Useful for linking to objects.
+	 */
 	public function get_instance_url() {
 		return get_option( $this->option_prefix . 'instance_url', '' );
 	}
 
 	/**
-	* Set the SF instanc URL.
-	*
-	* @param string $url
-	*   URL to set.
-	*/
+	 * Set the SF instanc URL.
+	 *
+	 * @param string $url
+	 *   URL to set.
+	 */
 	protected function set_instance_url( $url ) {
 		update_option( $this->option_prefix . 'instance_url', $url );
 	}
 
 	/**
-	* Get the access token.
-	*/
+	 * Get the access token.
+	 */
 	public function get_access_token() {
 		return get_option( $this->option_prefix . 'access_token', '' );
 	}
 
 	/**
-	* Set the access token.
-	*
-	* It is stored in session.
-	*
-	* @param string $token
-	*   Access token from Salesforce.
-	*/
+	 * Set the access token.
+	 *
+	 * It is stored in session.
+	 *
+	 * @param string $token
+	 *   Access token from Salesforce.
+	 */
 	protected function set_access_token( $token ) {
 		update_option( $this->option_prefix . 'access_token', $token );
 	}
 
 	/**
-	* Get refresh token.
-	*/
+	 * Get refresh token.
+	 */
 	protected function get_refresh_token() {
 		return get_option( $this->option_prefix . 'refresh_token', '' );
 	}
 
 	/**
-	* Set refresh token.
-	*
-	* @param string $token
-	*   Refresh token from Salesforce.
-	*/
+	 * Set refresh token.
+	 *
+	 * @param string $token
+	 *   Refresh token from Salesforce.
+	 */
 	protected function set_refresh_token( $token ) {
 		update_option( $this->option_prefix . 'refresh_token', $token );
 	}
 
 	/**
-	* Refresh access token based on the refresh token. Updates session variable.
-	*
-	* todo: figure out how to do this as part of the schedule class
-	* this is a scheduleable class and so we could add a method from this class to run every 24 hours, but it's unclear to me that we need it. salesforce seems to refresh itself as it needs to.
-	* but it could be a performance boost to do it at scheduleable intervals instead.
-	*
-	* @throws Object_Sync_Sf_Exception
-	*/
+	 * Refresh access token based on the refresh token. Updates session variable.
+	 *
+	 * todo: figure out how to do this as part of the schedule class
+	 * this is a scheduleable class and so we could add a method from this class to run every 24 hours, but it's unclear to me that we need it. salesforce seems to refresh itself as it needs to.
+	 * but it could be a performance boost to do it at scheduleable intervals instead.
+	 *
+	 * @throws Object_Sync_Sf_Exception
+	 */
 	protected function refresh_token() {
 		$refresh_token = $this->get_refresh_token();
 		if ( empty( $refresh_token ) ) {
@@ -593,13 +593,13 @@ 
 	}
 
 	/**
-	* Retrieve and store the Salesforce identity given an ID url.
-	*
-	* @param string $id
-	*   Identity URL.
-	*
-	* @throws Object_Sync_Sf_Exception
-	*/
+	 * Retrieve and store the Salesforce identity given an ID url.
+	 *
+	 * @param string $id
+	 *   Identity URL.
+	 *
+	 * @throws Object_Sync_Sf_Exception
+	 */
 	protected function set_identity( $id ) {
 		$headers  = array(
 			'Authorization'   => 'Authorization: OAuth ' . $this->get_access_token(),
@@ -615,18 +615,18 @@ 
 	}
 
 	/**
-	* Return the Salesforce identity, which is stored in a variable.
-	*
-	* @return array
-	*   Returns FALSE if no identity has been stored.
-	*/
+	 * Return the Salesforce identity, which is stored in a variable.
+	 *
+	 * @return array
+	 *   Returns FALSE if no identity has been stored.
+	 */
 	public function get_identity() {
 		return get_option( $this->option_prefix . 'identity', false );
 	}
 
 	/**
-	* OAuth step 1: Redirect to Salesforce and request and authorization code.
-	*/
+	 * OAuth step 1: Redirect to Salesforce and request and authorization code.
+	 */
 	public function get_authorization_code() {
 		$url = add_query_arg(
 			array(
@@ -640,11 +640,11 @@ 
 	}
 
 	/**
-	* OAuth step 2: Exchange an authorization code for an access token.
-	*
-	* @param string $code
-	*   Code from Salesforce.
-	*/
+	 * OAuth step 2: Exchange an authorization code for an access token.
+	 *
+	 * @param string $code
+	 *   Code from Salesforce.
+	 */
 	public function request_token( $code ) {
 		$data = array(
 			'code'          => $code,
@@ -689,22 +689,22 @@ 
 	/* Core API calls */
 
 	/**
-	* Available objects and their metadata for your organization's data.
-	*
-	* @param array $conditions
-	*   Associative array of filters to apply to the returned objects. Filters
-	*   are applied after the list is returned from Salesforce.
-	* @param bool $reset
-	*   Whether to reset the cache and retrieve a fresh version from Salesforce.
-	*
-	* @return array
-	*   Available objects and metadata.
-	*
-	* part of core API calls. this call does require authentication, and the basic url it becomes is like this:
-	* https://instance.salesforce.com/services/data/v#.0/sobjects
-	*
-	* updateable is really how the api spells it
-	*/
+	 * Available objects and their metadata for your organization's data.
+	 *
+	 * @param array $conditions
+	 *   Associative array of filters to apply to the returned objects. Filters
+	 *   are applied after the list is returned from Salesforce.
+	 * @param bool $reset
+	 *   Whether to reset the cache and retrieve a fresh version from Salesforce.
+	 *
+	 * @return array
+	 *   Available objects and metadata.
+	 *
+	 * part of core API calls. this call does require authentication, and the basic url it becomes is like this:
+	 * https://instance.salesforce.com/services/data/v#.0/sobjects
+	 *
+	 * updateable is really how the api spells it
+	 */
 	public function objects(
 		$conditions = array(
 			'updateable'  => true,
@@ -734,22 +734,22 @@ 
 	}
 
 	/**
-	* Use SOQL to get objects based on query string.
-	*
-	* @param string $query
-	*   The SOQL query.
-	* @param array $options
-	*   Allow for the query to have options based on what the user needs from it, ie caching, read/write, etc.
-	* @param boolean $all
-	*   Whether this should get all results for the query
-	* @param boolean $explain
-	*   If set, Salesforce will return feedback on the query performance
-	*
-	* @return array
-	*   Array of Salesforce objects that match the query.
-	*
-	* part of core API calls
-	*/
+	 * Use SOQL to get objects based on query string.
+	 *
+	 * @param string $query
+	 *   The SOQL query.
+	 * @param array $options
+	 *   Allow for the query to have options based on what the user needs from it, ie caching, read/write, etc.
+	 * @param boolean $all
+	 *   Whether this should get all results for the query
+	 * @param boolean $explain
+	 *   If set, Salesforce will return feedback on the query performance
+	 *
+	 * @return array
+	 *   Array of Salesforce objects that match the query.
+	 *
+	 * part of core API calls
+	 */
 	public function query( $query, $options = array(), $all = false, $explain = false ) {
 		$search_data = [
 			'q' => (string) $query,
@@ -769,19 +769,19 @@ 
 	}
 
 	/**
-	* Retrieve all the metadata for an object.
-	*
-	* @param string $name
-	*   Object type name, E.g., Contact, Account, etc.
-	* @param bool $reset
-	*   Whether to reset the cache and retrieve a fresh version from Salesforce.
-	*
-	* @return array
-	*   All the metadata for an object, including information about each field,
-	*   URLs, and child relationships.
-	*
-	* part of core API calls
-	*/
+	 * Retrieve all the metadata for an object.
+	 *
+	 * @param string $name
+	 *   Object type name, E.g., Contact, Account, etc.
+	 * @param bool $reset
+	 *   Whether to reset the cache and retrieve a fresh version from Salesforce.
+	 *
+	 * @return array
+	 *   All the metadata for an object, including information about each field,
+	 *   URLs, and child relationships.
+	 *
+	 * part of core API calls
+	 */
 	public function object_describe( $name, $reset = false ) {
 		if ( empty( $name ) ) {
 			return array();
@@ -809,26 +809,26 @@ 
 	}
 
 	/**
-	* Create a new object of the given type.
-	*
-	* @param string $name
-	*   Object type name, E.g., Contact, Account, etc.
-	* @param array $params
-	*   Values of the fields to set for the object.
-	*
-	* @return array
-	*   json: {"id":"00190000001pPvHAAU","success":true,"errors":[]}
-	*   code: 201
-	*   data:
-	*     "id" : "00190000001pPvHAAU",
-	*     "success" : true
-	*     "errors" : [ ],
-	*   from_cache:
-	*   cached:
-	*   is_redo:
-	*
-	* part of core API calls
-	*/
+	 * Create a new object of the given type.
+	 *
+	 * @param string $name
+	 *   Object type name, E.g., Contact, Account, etc.
+	 * @param array $params
+	 *   Values of the fields to set for the object.
+	 *
+	 * @return array
+	 *   json: {"id":"00190000001pPvHAAU","success":true,"errors":[]}
+	 *   code: 201
+	 *   data:
+	 *     "id" : "00190000001pPvHAAU",
+	 *     "success" : true
+	 *     "errors" : [ ],
+	 *   from_cache:
+	 *   cached:
+	 *   is_redo:
+	 *
+	 * part of core API calls
+	 */
 	public function object_create( $name, $params ) {
 		$options = array(
 			'type' => 'write',
@@ -838,34 +838,34 @@ 
 	}
 
 	/**
-	* Create new records or update existing records.
-	*
-	* The new records or updated records are based on the value of the specified
-	* field.  If the value is not unique, REST API returns a 300 response with
-	* the list of matching records.
-	*
-	* @param string $name
-	*   Object type name, E.g., Contact, Account.
-	* @param string $key
-	*   The field to check if this record should be created or updated.
-	* @param string $value
-	*   The value for this record of the field specified for $key.
-	* @param array $params
-	*   Values of the fields to set for the object.
-	*
-	* @return array
-	*   json: {"id":"00190000001pPvHAAU","success":true,"errors":[]}
-	*   code: 201
-	*   data:
-	*     "id" : "00190000001pPvHAAU",
-	*     "success" : true
-	*     "errors" : [ ],
-	*   from_cache:
-	*   cached:
-	*   is_redo:
-	*
-	* part of core API calls
-	*/
+	 * Create new records or update existing records.
+	 *
+	 * The new records or updated records are based on the value of the specified
+	 * field.  If the value is not unique, REST API returns a 300 response with
+	 * the list of matching records.
+	 *
+	 * @param string $name
+	 *   Object type name, E.g., Contact, Account.
+	 * @param string $key
+	 *   The field to check if this record should be created or updated.
+	 * @param string $value
+	 *   The value for this record of the field specified for $key.
+	 * @param array $params
+	 *   Values of the fields to set for the object.
+	 *
+	 * @return array
+	 *   json: {"id":"00190000001pPvHAAU","success":true,"errors":[]}
+	 *   code: 201
+	 *   data:
+	 *     "id" : "00190000001pPvHAAU",
+	 *     "success" : true
+	 *     "errors" : [ ],
+	 *   from_cache:
+	 *   cached:
+	 *   is_redo:
+	 *
+	 * part of core API calls
+	 */
 	public function object_upsert( $name, $key, $value, $params ) {
 		$options = array(
 			'type' => 'write',
@@ -887,27 +887,27 @@ 
 	}
 
 	/**
-	* Update an existing object.
-	*
-	* @param string $name
-	*   Object type name, E.g., Contact, Account.
-	* @param string $id
-	*   Salesforce id of the object.
-	* @param array $params
-	*   Values of the fields to set for the object.
-	*
-	* part of core API calls
-	*
-	* @return array
-	*   json: {"success":true,"body":""}
-	*   code: 204
-	*   data:
+	 * Update an existing object.
+	 *
+	 * @param string $name
+	 *   Object type name, E.g., Contact, Account.
+	 * @param string $id
+	 *   Salesforce id of the object.
+	 * @param array $params
+	 *   Values of the fields to set for the object.
+	 *
+	 * part of core API calls
+	 *
+	 * @return array
+	 *   json: {"success":true,"body":""}
+	 *   code: 204
+	 *   data:
 		success: 1
 		body:
-	*   from_cache:
-	*   cached:
-	*   is_redo:
-	*/
+	 *   from_cache:
+	 *   cached:
+	 *   is_redo:
+	 */
 	public function object_update( $name, $id, $params ) {
 		$options = array(
 			'type' => 'write',
@@ -917,62 +917,62 @@ 
 	}
 
 	/**
-	* Return a full loaded Salesforce object.
-	*
-	* @param string $name
-	*   Object type name, E.g., Contact, Account.
-	* @param string $id
-	*   Salesforce id of the object.
-	*
-	* @return object
-	*   Object of the requested Salesforce object.
-	*
-	* part of core API calls
-	*/
+	 * Return a full loaded Salesforce object.
+	 *
+	 * @param string $name
+	 *   Object type name, E.g., Contact, Account.
+	 * @param string $id
+	 *   Salesforce id of the object.
+	 *
+	 * @return object
+	 *   Object of the requested Salesforce object.
+	 *
+	 * part of core API calls
+	 */
 	public function object_read( $name, $id ) {
 		return $this->api_call( "sobjects/{$name}/{$id}", array(), 'GET' );
 	}
 
 	/**
-	* Make a call to the Analytics API
-	*
-	* @param string $name
-	*   Object type name, E.g., Report
-	* @param string $id
-	*   Salesforce id of the object.
-	* @param string $route
-	*   What comes after the ID? E.g. instances, ?includeDetails=True
-	* @param array $params
-	*   Params to put with the request
-	* @param string $method
-	*   GET or POST
-	*
-	* @return object
-	*   Object of the requested Salesforce object.
-	*
-	* part of core API calls
-	*/
+	 * Make a call to the Analytics API
+	 *
+	 * @param string $name
+	 *   Object type name, E.g., Report
+	 * @param string $id
+	 *   Salesforce id of the object.
+	 * @param string $route
+	 *   What comes after the ID? E.g. instances, ?includeDetails=True
+	 * @param array $params
+	 *   Params to put with the request
+	 * @param string $method
+	 *   GET or POST
+	 *
+	 * @return object
+	 *   Object of the requested Salesforce object.
+	 *
+	 * part of core API calls
+	 */
 	public function analytics_api( $name, $id, $route = '', $params = array(), $method = 'GET' ) {
 		return $this->api_call( "analytics/{$name}/{$id}/{$route}", $params, $method );
 	}
 
 	/**
-	* Run a specific Analytics report
-	*
-	* @param string $id
-	*   Salesforce id of the object.
-	* @param bool $async
-	*   Whether the report is asynchronous
-	* @param array $params
-	*   Params to put with the request
-	* @param string $method
-	*   GET or POST
-	*
-	* @return object
-	*   Object of the requested Salesforce object.
-	*
-	* part of core API calls
-	*/
+	 * Run a specific Analytics report
+	 *
+	 * @param string $id
+	 *   Salesforce id of the object.
+	 * @param bool $async
+	 *   Whether the report is asynchronous
+	 * @param array $params
+	 *   Params to put with the request
+	 * @param string $method
+	 *   GET or POST
+	 *
+	 * @return object
+	 *   Object of the requested Salesforce object.
+	 *
+	 * part of core API calls
+	 */
 	public function run_analytics_report( $id, $async = true, $clear_cache = false, $params = array(), $method = 'GET', $report_cache_expiration = '', $cache_instance = true, $instance_cache_expiration = '' ) {
 
 		$id         = $this->convert_id( $id );
@@ -1058,36 +1058,36 @@ 
 	}
 
 	/**
-	* Return a full loaded Salesforce object from External ID.
-	*
-	* @param string $name
-	*   Object type name, E.g., Contact, Account.
-	* @param string $field
-	*   Salesforce external id field name.
-	* @param string $value
-	*   Value of external id.
-	*
-	* @return object
-	*   Object of the requested Salesforce object.
-	*
-	* part of core API calls
-	*/
+	 * Return a full loaded Salesforce object from External ID.
+	 *
+	 * @param string $name
+	 *   Object type name, E.g., Contact, Account.
+	 * @param string $field
+	 *   Salesforce external id field name.
+	 * @param string $value
+	 *   Value of external id.
+	 *
+	 * @return object
+	 *   Object of the requested Salesforce object.
+	 *
+	 * part of core API calls
+	 */
 	public function object_readby_external_id( $name, $field, $value ) {
 		return $this->api_call( "sobjects/{$name}/{$field}/{$value}" );
 	}
 
 	/**
-	* Delete a Salesforce object.
-	*
-	* @param string $name
-	*   Object type name, E.g., Contact, Account.
-	* @param string $id
-	*   Salesforce id of the object.
-	*
-	* @return array
-	*
-	* part of core API calls
-	*/
+	 * Delete a Salesforce object.
+	 *
+	 * @param string $name
+	 *   Object type name, E.g., Contact, Account.
+	 * @param string $id
+	 *   Salesforce id of the object.
+	 *
+	 * @return array
+	 *
+	 * part of core API calls
+	 */
 	public function object_delete( $name, $id ) {
 		$options = array(
 			'type' => 'write',
@@ -1097,17 +1097,17 @@ 
 	}
 
 	/**
-	* Retrieves the list of individual objects that have been deleted within the
-	* given timespan for a specified object type.
-	*
-	* @param string $type
-	*   Object type name, E.g., Contact, Account.
-	* @param string $startDate
-	*   Start date to check for deleted objects (in ISO 8601 format).
-	* @param string $endDate
-	*   End date to check for deleted objects (in ISO 8601 format).
-	* @return GetDeletedResult
-	*/
+	 * Retrieves the list of individual objects that have been deleted within the
+	 * given timespan for a specified object type.
+	 *
+	 * @param string $type
+	 *   Object type name, E.g., Contact, Account.
+	 * @param string $startDate
+	 *   Start date to check for deleted objects (in ISO 8601 format).
+	 * @param string $endDate
+	 *   End date to check for deleted objects (in ISO 8601 format).
+	 * @return GetDeletedResult
+	 */
 	public function get_deleted( $type, $start_date, $end_date ) {
 		$options = array(
 			'cache' => false,
@@ -1117,13 +1117,13 @@ 
 
 
 	/**
-	* Return a list of available resources for the configured API version.
-	*
-	* @return array
-	*   Associative array keyed by name with a URI value.
-	*
-	* part of core API calls
-	*/
+	 * Return a list of available resources for the configured API version.
+	 *
+	 * @return array
+	 *   Associative array keyed by name with a URI value.
+	 *
+	 * part of core API calls
+	 */
 	public function list_resources() {
 		$resources = $this->api_call( '' );
 		foreach ( $resources as $key => $path ) {
@@ -1133,31 +1133,31 @@ 
 	}
 
 	/**
-	* Return a list of SFIDs for the given object, which have been created or
-	* updated in the given timeframe.
-	*
-	* @param string $type
-	*   Object type name, E.g., Contact, Account.
-	*
-	* @param int $start
-	*   unix timestamp for older timeframe for updates.
-	*   Defaults to "-29 days" if empty.
-	*
-	* @param int $end
-	*   unix timestamp for end of timeframe for updates.
-	*   Defaults to now if empty
-	*
-	* @return array
-	*   return array has 2 indexes:
-	*     "ids": a list of SFIDs of those records which have been created or
-	*       updated in the given timeframe.
-	*     "latestDateCovered": ISO 8601 format timestamp (UTC) of the last date
-	*       covered in the request.
-	*
-	* @see https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_getupdated.htm
-	*
-	* part of core API calls
-	*/
+	 * Return a list of SFIDs for the given object, which have been created or
+	 * updated in the given timeframe.
+	 *
+	 * @param string $type
+	 *   Object type name, E.g., Contact, Account.
+	 *
+	 * @param int $start
+	 *   unix timestamp for older timeframe for updates.
+	 *   Defaults to "-29 days" if empty.
+	 *
+	 * @param int $end
+	 *   unix timestamp for end of timeframe for updates.
+	 *   Defaults to now if empty
+	 *
+	 * @return array
+	 *   return array has 2 indexes:
+	 *     "ids": a list of SFIDs of those records which have been created or
+	 *       updated in the given timeframe.
+	 *     "latestDateCovered": ISO 8601 format timestamp (UTC) of the last date
+	 *       covered in the request.
+	 *
+	 * @see https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_getupdated.htm
+	 *
+	 * part of core API calls
+	 */
 	public function get_updated( $type, $start = null, $end = null ) {
 		if ( empty( $start ) ) {
 			$start = strtotime( '-29 days' );
@@ -1176,19 +1176,19 @@ 
 	}
 
 	/**
-	* Given a DeveloperName and SObject Name, return the SFID of the
-	* corresponding RecordType. DeveloperName doesn't change between Salesforce
-	* environments, so it's safer to rely on compared to SFID.
-	*
-	* @param string $name
-	*   Object type name, E.g., Contact, Account.
-	*
-	* @param string $devname
-	*   RecordType DeveloperName, e.g. Donation, Membership, etc.
-	*
-	* @return string SFID
-	*   The Salesforce ID of the given Record Type, or null.
-	*/
+	 * Given a DeveloperName and SObject Name, return the SFID of the
+	 * corresponding RecordType. DeveloperName doesn't change between Salesforce
+	 * environments, so it's safer to rely on compared to SFID.
+	 *
+	 * @param string $name
+	 *   Object type name, E.g., Contact, Account.
+	 *
+	 * @param string $devname
+	 *   RecordType DeveloperName, e.g. Donation, Membership, etc.
+	 *
+	 * @return string SFID
+	 *   The Salesforce ID of the given Record Type, or null.
+	 */
 
 	public function get_record_type_id_by_developer_name( $name, $devname, $reset = false ) {
 
@@ -1216,10 +1216,10 @@ 
 	}
 
 	/**
-	* If there is a WordPress setting for how long to keep the cache, return it and set the object property
-	* Otherwise, return seconds in 24 hours
-	*
-	*/
+	 * If there is a WordPress setting for how long to keep the cache, return it and set the object property
+	 * Otherwise, return seconds in 24 hours
+	 *
+	 */
 	private function cache_expiration() {
 		$cache_expiration = $this->wordpress->cache_expiration( $this->option_prefix . 'cache_expiration', 86400 );
 		return $cache_expiration;

classes/salesforce_pull.php

Indentation +92 added lines, -92 removed lines

@@ -26,26 +26,26 @@ 
 	protected $queue;
 
 	/**
-	* @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 string $option_prefix
-	* @param object $wordpress
-	* @param object $salesforce
-	* @param object $mappings
-	* @param object $logging
-	* @param array $schedulable_classes
-	* @param object $queue
-	* @throws \Exception
-	*/
+	 * Constructor which sets up pull schedule
+	 *
+	 * @param object $wpdb
+	 * @param string $version
+	 * @param array $login_credentials
+	 * @param string $slug
+	 * @param string $option_prefix
+	 * @param object $wordpress
+	 * @param object $salesforce
+	 * @param object $mappings
+	 * @param object $logging
+	 * @param array $schedulable_classes
+	 * @param object $queue
+	 * @throws \Exception
+	 */
 	public function __construct( $wpdb, $version, $login_credentials, $slug, $option_prefix, $wordpress, $salesforce, $mappings, $logging, $schedulable_classes, $queue ) {
 		$this->wpdb                = $wpdb;
 		$this->version             = $version;
@@ -69,9 +69,9 @@ 
 	}
 
 	/**
-	* 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
+	 *
+	 */
 	public function add_actions() {
 
 		// ajax hook
@@ -83,11 +83,11 @@ 
 	}
 
 	/**
-	* 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() ) {
@@ -113,8 +113,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'];
 
@@ -134,13 +134,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( $this->option_prefix . 'pull_throttle', 5 );
 		$last_sync     = get_option( $this->option_prefix . 'pull_last_sync', 0 );
@@ -153,14 +153,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 ) {
@@ -344,18 +344,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();
@@ -440,10 +440,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'];
@@ -544,13 +544,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 );
@@ -565,20 +565,20 @@ 
 	}
 
 	/**
-	* Sync WordPress objects and Salesforce objects from the queue using the REST API.
-	*
-	* @param string $object_type
-	*   Type of Salesforce object.
-	* @param array|string $object
-	*   The Salesforce data or its Id value.
-	* @param array|int $mapping
-	*   Salesforce/WP mapping data or its id.
-	* @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 array|string $object
+	 *   The Salesforce data or its Id value.
+	 * @param array|int $mapping
+	 *   Salesforce/WP mapping data or its id.
+	 * @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 ) {
 
 		$sfapi = $this->salesforce['sfapi'];
@@ -1308,19 +1308,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(