MinnPost / object-sync-for-salesforce

object-sync-for-salesforce.php

Indentation +97 added lines, -97 removed lines

@@ -16,75 +16,75 @@ 
 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 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;
 
 	/**
@@ -95,13 +95,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();
@@ -222,17 +222,17 @@ 
 	}
 
 	/**
-	* Private helper to load methods for manipulating core WordPress data across the plugin
-	*
-	* @param object $wpdb
-	* @param string $version
-	* @param string $slug
-	* @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 object $mappings
+	 * @param object $logging
+	 *
+	 * @return object
+	 *   Instance of Object_Sync_Sf_WordPress
+	 */
 	private function wordpress( $wpdb, $version, $slug, $mappings, $logging ) {
 		require_once plugin_dir_path( __FILE__ ) . 'classes/wordpress.php';
 		$wordpress = new Object_Sync_Sf_WordPress( $wpdb, $version, $slug, $mappings, $logging );
@@ -240,13 +240,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
@@ -352,24 +352,24 @@ 
 	}
 
 	/**
-	* 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 object $wordpress
-	* @param object $salesforce
-	* @param object $mappings
-	* @param object $push
-	* @param object $pull
-	* @param object $logging
-	* @param array $schedulable_classes
-	* @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 object $wordpress
+	 * @param object $salesforce
+	 * @param object $mappings
+	 * @param object $push
+	 * @param object $pull
+	 * @param object $logging
+	 * @param array $schedulable_classes
+	 * @return object $admin
+	 *   Instance of Object_Sync_Sf_Admin
+	 *
+	 */
 	private function load_admin( $wpdb, $version, $login_credentials, $slug, $wordpress, $salesforce, $mappings, $push, $pull, $logging, $schedulable_classes ) {
 		require_once( plugin_dir_path( __FILE__ ) . 'classes/admin.php' );
 		$admin = new Object_Sync_Sf_Admin( $wpdb, $version, $login_credentials, $slug, $wordpress, $salesforce, $mappings, $push, $pull, $logging, $schedulable_classes );
@@ -381,13 +381,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>';
@@ -399,10 +399,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() {
 		wp_enqueue_script( $this->slug . '-admin', plugins_url( 'assets/js/object-sync-for-salesforce-admin.min.js', __FILE__ ), array( 'jquery' ), filemtime( plugin_dir_path( __FILE__ ) . 'assets/js/object-sync-for-salesforce-admin.js' ), true );
 		wp_enqueue_style( $this->slug . '-admin', plugins_url( 'assets/css/object-sync-for-salesforce-admin.min.css', __FILE__ ), array(), filemtime( plugin_dir_path( __FILE__ ) . 'assets/css/object-sync-for-salesforce-admin.css' ), 'all' );
@@ -418,13 +418,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( 'object_sync_for_salesforce_consumer_key', '' );