MinnPost / object-sync-for-salesforce

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(

classes/admin.php

Indentation +250 added lines, -250 removed lines

@@ -28,76 +28,76 @@ 
 	protected $queue;
 
 	/**
-	* @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 int
-	* Default max number of pull records
-	* Users can edit this
-	*/
+	 * @var int
+	 * Default max number of pull records
+	 * Users can edit this
+	 */
 	public $default_pull_limit;
 
 	/**
-	* @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;
 
 	/**
-	* @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 string
-	* Suffix for action group name
-	*/
+	 * @var string
+	 * Suffix for action group name
+	 */
 	public $action_group_suffix;
 
 	/**
-	* 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
-	* @param object $queue
-	* @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
+	 * @param object $queue
+	 * @throws \Exception
+	 */
 	public function __construct( $wpdb, $version, $login_credentials, $slug, $option_prefix, $wordpress, $salesforce, $mappings, $push, $pull, $logging, $schedulable_classes, $queue ) {
 		$this->wpdb                = $wpdb;
 		$this->version             = $version;
@@ -137,9 +137,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' ) );
@@ -174,9 +174,9 @@ 
 	}
 
 	/**
-	* Recurring task to check Salesforce for data
-	*
-	*/
+	 * Recurring task to check Salesforce for data
+	 *
+	 */
 	public function change_action_schedule( $old_schedule, $new_schedule, $option_name ) {
 
 		// exit if nothing changed
@@ -212,21 +212,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">';
@@ -436,10 +436,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';
@@ -464,13 +464,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(
@@ -717,25 +717,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 ) {
 
 		add_settings_section( $page, ucwords( $page ), null, $page );
@@ -844,13 +844,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(
@@ -1028,9 +1028,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
@@ -1103,14 +1103,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 ) ) {
@@ -1158,13 +1158,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'] ) ) {
@@ -1192,12 +1192,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 );
@@ -1216,13 +1216,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 ) ) {
@@ -1247,12 +1247,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 ) ) {
@@ -1271,12 +1271,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 ) ) {
@@ -1293,11 +1293,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 ) ) {
@@ -1316,13 +1316,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 );
@@ -1370,12 +1370,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'] ) {
@@ -1391,13 +1391,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 );
@@ -1436,12 +1436,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'] ) {
@@ -1457,9 +1457,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' ) ) {
@@ -1557,9 +1557,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' ) ) {
@@ -1588,10 +1588,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'];
@@ -1638,11 +1638,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'];
@@ -1676,10 +1676,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'];
@@ -1723,10 +1723,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();
@@ -1740,10 +1740,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'];
@@ -1770,11 +1770,11 @@ 
 	}
 
 	/**
-	* Allow for a standard sanitize/validate method. We could use more specific ones if need be, but this one provides a baseline.
-	*
-	* @param string $option
-	* @return string $option
-	*/
+	 * Allow for a standard sanitize/validate method. We could use more specific ones if need be, but this one provides a baseline.
+	 *
+	 * @param string $option
+	 * @return string $option
+	 */
 	public function sanitize_validate_text( $option ) {
 		if ( is_array( $option ) ) {
 			$options = array();
@@ -1788,10 +1788,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();
@@ -1850,10 +1850,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' );
@@ -1865,8 +1865,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(
@@ -1877,9 +1877,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 ) {
@@ -1899,9 +1899,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
@@ -1921,10 +1921,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() ) {
@@ -1948,10 +1948,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'] ) ) {
@@ -1976,10 +1976,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 );
@@ -2009,10 +2009,10 @@ 
 	}
 
 	/**
-	* Clear schedule
-	* This clears the schedule if the user clicks the button
-	* @param string $schedule_name
-	*/
+	 * Clear schedule
+	 * This clears the schedule if the user clicks the button
+	 * @param string $schedule_name
+	 */
 	private function clear_schedule( $schedule_name = '' ) {
 		if ( '' !== $schedule_name ) {
 			$this->queue->cancel( $schedule_name );
@@ -2024,10 +2024,10 @@ 
 	}
 
 	/**
-	* Get count of schedule items
-	* @param string $schedule_name
-	* @return int $count
-	*/
+	 * Get count of schedule items
+	 * @param string $schedule_name
+	 * @return int $count
+	 */
 	private function get_schedule_count( $schedule_name = '' ) {
 		if ( '' !== $schedule_name ) {
 			$count       = count( $this->queue->search(
@@ -2051,21 +2051,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(

object-sync-for-salesforce.php

Indentation +103 added lines, -103 removed lines

@@ -16,81 +16,81 @@ 
 class Object_Sync_Salesforce {
 
 	/**
-	* @var object
-	* Global object of `$wpdb`, the WordPress database
-	*/
+	 * @var object
+	 * Global object of `$wpdb`, the WordPress database
+	 */
 	private $wpdb;
 
 	/**
-	* @var array
-	* Login credentials for the Salesforce API; comes from wp-config or from the plugin settings
-	*/
+	 * @var array
+	 * Login credentials for the Salesforce API; comes from wp-config or from the plugin settings
+	 */
 	private $login_credentials;
 
 	/**
-	* @var string
-	* The plugin's slug so we can include it when necessary
-	*/
+	 * @var string
+	 * The plugin's slug so we can include it when necessary
+	 */
 	private $slug;
 
 	/**
-	* @var string
-	* The plugin's option prefix
-	*/
+	 * @var string
+	 * The plugin's option prefix
+	 */
 	private $option_prefix;
 
 	/**
-	* @var array
-	* Array of what classes in the plugin can be scheduled to occur with `wp_cron` events
-	*/
+	 * @var array
+	 * Array of what classes in the plugin can be scheduled to occur with `wp_cron` events
+	 */
 	public $schedulable_classes;
 
 	/**
-	* @var string
-	* Current version of the plugin
-	*/
+	 * @var string
+	 * Current version of the plugin
+	 */
 	private $version;
 
 	/**
-	* @var object
-	*/
+	 * @var object
+	 */
 	private $activated;
 
 	/**
-	* @var object
-	* Load and initialize the Object_Sync_Sf_Logging class
-	*/
+	 * @var object
+	 * Load and initialize the Object_Sync_Sf_Logging class
+	 */
 	private $logging;
 
 	/**
-	* @var object
-	* Load and initialize the Object_Sync_Sf_Mapping class
-	*/
+	 * @var object
+	 * Load and initialize the Object_Sync_Sf_Mapping class
+	 */
 	private $mappings;
 
 	/**
-	* @var object
-	* Load and initialize the Object_Sync_Sf_WordPress class
-	*/
+	 * @var object
+	 * Load and initialize the Object_Sync_Sf_WordPress class
+	 */
 	private $wordpress;
 
 	/**
-	* @var object
-	* Load and initialize the Object_Sync_Sf_Salesforce class.
-	* This contains the Salesforce API methods
-	*/
+	 * @var object
+	 * Load and initialize the Object_Sync_Sf_Salesforce class.
+	 * This contains the Salesforce API methods
+	 */
 	public $salesforce;
 
 	/**
-	* @var object
-	* Load and initialize the Object_Sync_Sf_Salesforce_Push class
-	*/
+	 * @var object
+	 * Load and initialize the Object_Sync_Sf_Salesforce_Push class
+	 */
 	private $push;
 
 	/**
-	* @var object
-	* Load and initialize the Object_Sync_Sf_Salesforce_Pull class
-	*/
+	 * @var object
+	 * Load and initialize the Object_Sync_Sf_Salesforce_Pull class
+	 */
 	private $pull;
 
 	/**
@@ -101,13 +101,13 @@ 
 	static $instance = null;
 
 	/**
-	* Load the static $instance property that holds the instance of the class.
-	* This instance makes the class reusable by other plugins
-	*
-	* @return object
-	*   The sfapi object if it is authenticated (empty, otherwise)
-	*
-	*/
+	 * Load the static $instance property that holds the instance of the class.
+	 * This instance makes the class reusable by other plugins
+	 *
+	 * @return object
+	 *   The sfapi object if it is authenticated (empty, otherwise)
+	 *
+	 */
 	static public function get_instance() {
 		if ( null === self::$instance ) {
 			self::$instance = new Object_Sync_Salesforce();
@@ -257,18 +257,18 @@ 
 	}
 
 	/**
-	* Private helper to load methods for manipulating core WordPress data across the plugin
-	*
-	* @param object $wpdb
-	* @param string $version
-	* @param string $slug
-	* @param string $option_prefix
-	* @param object $mappings
-	* @param object $logging
-	*
-	* @return object
-	*   Instance of Object_Sync_Sf_WordPress
-	*/
+	 * Private helper to load methods for manipulating core WordPress data across the plugin
+	 *
+	 * @param object $wpdb
+	 * @param string $version
+	 * @param string $slug
+	 * @param string $option_prefix
+	 * @param object $mappings
+	 * @param object $logging
+	 *
+	 * @return object
+	 *   Instance of Object_Sync_Sf_WordPress
+	 */
 	private function wordpress( $wpdb, $version, $slug, $option_prefix, $mappings, $logging ) {
 		require_once plugin_dir_path( __FILE__ ) . 'classes/wordpress.php';
 		$wordpress = new Object_Sync_Sf_WordPress( $wpdb, $version, $slug, $option_prefix, $mappings, $logging );
@@ -276,13 +276,13 @@ 
 	}
 
 	/**
-	* Public helper to load the Salesforce API and see if it is authenticated.
-	* This is public so other plugins can access the same SF API instance
-	*
-	* @return array
-	*   Whether Salesforce is authenticated (boolean)
-	*   The sfapi object if it is authenticated (empty, otherwise)
-	*/
+	 * Public helper to load the Salesforce API and see if it is authenticated.
+	 * This is public so other plugins can access the same SF API instance
+	 *
+	 * @return array
+	 *   Whether Salesforce is authenticated (boolean)
+	 *   The sfapi object if it is authenticated (empty, otherwise)
+	 */
 	public function salesforce_get_api() {
 		require_once( plugin_dir_path( __FILE__ ) . 'classes/salesforce.php' );
 		require_once( plugin_dir_path( __FILE__ ) . 'classes/salesforce_query.php' ); // this can be used to generate soql queries, but we don't often need it so it gets initialized whenever it's needed
@@ -391,26 +391,26 @@ 
 	}
 
 	/**
-	* Load the admin class.
-	* This also creates admin menu, unless the plugin that calls this library has indicated that it has its own menu
-	*
-	* @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 $push
-	* @param object $pull
-	* @param object $logging
-	* @param array $schedulable_classes
-	* @param object $queue
-	* @return object $admin
-	*   Instance of Object_Sync_Sf_Admin
-	*
-	*/
+	 * Load the admin class.
+	 * This also creates admin menu, unless the plugin that calls this library has indicated that it has its own menu
+	 *
+	 * @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 $push
+	 * @param object $pull
+	 * @param object $logging
+	 * @param array $schedulable_classes
+	 * @param object $queue
+	 * @return object $admin
+	 *   Instance of Object_Sync_Sf_Admin
+	 *
+	 */
 	private function load_admin( $wpdb, $version, $login_credentials, $slug, $option_prefix, $wordpress, $salesforce, $mappings, $push, $pull, $logging, $schedulable_classes, $queue ) {
 		require_once( plugin_dir_path( __FILE__ ) . 'classes/admin.php' );
 		$admin = new Object_Sync_Sf_Admin( $wpdb, $version, $login_credentials, $slug, $option_prefix, $wordpress, $salesforce, $mappings, $push, $pull, $logging, $schedulable_classes, $queue );
@@ -422,13 +422,13 @@ 
 	}
 
 	/**
-	* Display a Settings link on the main Plugins page
-	*
-	* @param array $links
-	* @param string $file
-	* @return array $links
-	*   These are the links that go with this plugin's entry
-	*/
+	 * Display a Settings link on the main Plugins page
+	 *
+	 * @param array $links
+	 * @param string $file
+	 * @return array $links
+	 *   These are the links that go with this plugin's entry
+	 */
 	public function plugin_action_links( $links, $file ) {
 		if ( plugin_basename( __FILE__ ) === $file ) {
 			$settings = '<a href="' . get_admin_url() . 'options-general.php?page=object-sync-salesforce-admin">' . __( 'Settings', 'object-sync-for-salesforce' ) . '</a>';
@@ -440,10 +440,10 @@ 
 
 
 	/**
-	* Admin styles. Load the CSS and JavaScript for the plugin's settings
-	*
-	* @return void
-	*/
+	 * Admin styles. Load the CSS and JavaScript for the plugin's settings
+	 *
+	 * @return void
+	 */
 	public function admin_scripts_and_styles() {
 
 		// I think some developers might not want to bother with select2 or selectwoo, so let's allow that to be changeable
@@ -484,13 +484,13 @@ 
 	}
 
 	/**
-	* Get the pre-login Salesforce credentials.
-	* These depend on the plugin's settings or constants defined in wp-config.php.
-	*
-	* @return array $login_credentials
-	*   Includes all settings necessary to log into the Salesforce API.
-	*   Replaces settings options with wp-config.php values if they exist.
-	*/
+	 * Get the pre-login Salesforce credentials.
+	 * These depend on the plugin's settings or constants defined in wp-config.php.
+	 *
+	 * @return array $login_credentials
+	 *   Includes all settings necessary to log into the Salesforce API.
+	 *   Replaces settings options with wp-config.php values if they exist.
+	 */
 	private function get_login_credentials() {
 
 		$consumer_key       = defined( 'OBJECT_SYNC_SF_SALESFORCE_CONSUMER_KEY' ) ? OBJECT_SYNC_SF_SALESFORCE_CONSUMER_KEY : get_option( $this->option_prefix . 'consumer_key', '' );