Object_Sync_Salesforce::get_instance() - Code Metrics - MinnPost/object-sync-for-salesforce - Measure and Improve Code Quality continuously with Scrutinizer

Object_Sync_Salesforce::get_instance() A
last analyzed 2024-10-09 02:21 UTC

↳ Parent: Object_Sync_Salesforce
Complexity

Conditions	3
Paths	3
Size

Total Lines	13
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	3
eloc	6
nc	3
nop	0
dl	0
loc	13
rs	10
c	1
b	0
f	0
<?php
/**
 * The main plugin class
 *
 * @class   Object_Sync_Salesforce
 * @package Object_Sync_Salesforce
 */

defined( 'ABSPATH' ) || exit;

/**
 * Object_Sync_Salesforce class.
 */
class Object_Sync_Salesforce {

	/**
	 * Current version of the plugin
	 *
	 * @var string
	 */
	public $version;

	/**
	 * The main plugin file
	 *
	 * @var string
	 */
	public $file;

	/**
	 * Global object of `$wpdb`, the WordPress database
	 *
	 * @var object
	 */
	public $wpdb;

	/**
	 * The plugin's slug so we can include it when necessary
	 *
	 * @var string
	 */
	public $slug;

	/**
	 * The plugin's prefix when saving options to the database
	 *
	 * @var string
	 */
	public $option_prefix;

	/**
	 * Suffix for group name in ActionScheduler
	 *
	 * @var string
	 */
	public $action_group_suffix;

	/**
	 * Array of what classes in the plugin can be scheduled to occur with `wp_cron` events
	 *
	 * @var array
	 */
	public $schedulable_classes;

	/**
	 * Legacy property that holds an instance of the plugin class.
	 *
	 * @var object
	 * @deprecated since 2.0.0
	 */
	public static $instance;

	/**
	 * Object_Sync_Sf_Queue class
	 *
	 * @var object
	 */
	public $queue;

	/**
	 * Object_Sync_Sf_Activate class
	 *
	 * @var object
	 */
	private $activated;

	/**
	 * Tells us if composer has been autoloaded
	 *
	 * @var bool
	 */
	private $composer_loaded;

	/**
	 * Login credentials for the Salesforce API; comes from wp-config or from the plugin settings
	 *
	 * @var array
	 */
	public $login_credentials;

	/**
	 * Object_Sync_Sf_Logging class
	 *
	 * @var object
	 */
	public $logging;

	/**
	 * Object_Sync_Sf_Mapping class
	 *
	 * @var object
	 */
	public $mappings;

	/**
	 * Object_Sync_Sf_WordPress class
	 *
	 * @var object
	 */
	public $wordpress;

	/**
	 * Object_Sync_Sf_Salesforce class
	 * This contains Salesforce API methods
	 *
	 * @var array
	 */
	public $salesforce;

	/**
	 * Object_Sync_Sf_Salesforce_Push class
	 *
	 * @var object
	 */
	public $push;

	/**
	 * Object_Sync_Sf_Salesforce_Pull class
	 *
	 * @var object
	 */
	public $pull;

	/**
	 * Object_Sync_Sf_Rest class
	 *
	 * @var object
	 */
	private $rest;

	/**
	 * This is our constructor
	 *
	 * @param string $version is the plugin version.
	 * @param string $file is the main plugin file.
	 * @return void
	 */
	public function __construct( $version, $file ) {

		global $wpdb;

		$this->version             = $version;
		$this->file                = $file;
		$this->wpdb                = $wpdb;
		$this->slug                = 'object-sync-for-salesforce';
		$this->option_prefix       = 'object_sync_for_salesforce_';
		$this->action_group_suffix = '_check_records';

		$this->schedulable_classes = array(
			'salesforce_push' => array(
				'label'    => 'Push to Salesforce',
				'class'    => 'Object_Sync_Sf_Salesforce_Push',
				'callback' => $this->option_prefix . 'push_record',
			),
			'salesforce_pull' => array(
				'label'       => 'Pull from Salesforce',
				'class'       => 'Object_Sync_Sf_Salesforce_Pull',
				'initializer' => $this->option_prefix . 'pull_check_records',
				'callback'    => $this->option_prefix . 'pull_process_records',
			),
		);

		// users can modify the list of schedulable classes.
		$this->schedulable_classes = apply_filters( $this->option_prefix . 'modify_schedulable_classes', $this->schedulable_classes );
		$this->schedulable_classes = /** @scrutinizer ignore-call */ apply_filters( $this->option_prefix . 'modify_schedulable_classes', $this->schedulable_classes );

		/* // phpcs:ignore Squiz.PHP.CommentedOutCode.Found
		 * example to modify the array of classes by adding one and removing one
		 * add_filter( 'object_sync_for_salesforce_modify_schedulable_classes', 'modify_schedulable_classes', 10, 1 );
		 * function modify_schedulable_classes( $schedulable_classes ) {
		 * 	$schedulable_classes = array(
		 * 		'salesforce_push' => array(
		 * 		    'label' => 'Push to Salesforce',
		 * 		    'class' => 'Object_Sync_Sf_Salesforce_Push',
		 * 		    'callback' => 'salesforce_push_sync_rest',
		 * 		),
		 * 		'wordpress' => array( // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
		 * 		    'label' => 'WordPress',
		 * 		    'class' => 'Object_Sync_Sf_WordPress',
		 * 		),
		 * 		'salesforce' => array(
		 * 		    'label' => 'Salesforce Authorization',
		 * 		    'class' => 'Object_Sync_Sf_Salesforce',
		 * 		),
		 * 	);
		 * 	return $schedulable_classes;
		 * }
		*/
	}

	/**
	 * Load the static $instance property that holds the instance of the class.
	 * This is preserved for legacy usage, as the same thing exists in the `object_sync_for_salesforce` function.
	 *
	 * @return object $plugin
	 * @deprecated since 2.0.0
	 */
	public static function get_instance() {

		if ( function_exists( 'object_sync_for_salesforce' ) ) {
			return object_sync_for_salesforce();
		}

		static $plugin;

		if ( is_null( $plugin ) ) {
			$plugin = new Object_Sync_Salesforce( OBJECT_SYNC_SF_VERSION, OBJECT_SYNC_SF_FILE );
		}

		return $plugin;
	}

	/**
	 * Initialize the plugin and start the action hooks.
	 * We run this separately because activate can't run without the right priority.
	 */
	public function init() {

		// methods for the ActionScheduler queue. This needs to be loaded early because it is used during activation.
		$this->queue = new Object_Sync_Sf_Queue();

		// methods for activation.
		$this->activated = new Object_Sync_Sf_Activate();

		// action hooks.
		$this->add_actions();
	}

	/**
	 * Run non-activation actions.
	 * We do this on -10 because ActionScheduler has to have access to plugins_loaded with priority of zero.
	 */
	private function add_actions() {
		// public actions.
		add_action( 'plugins_loaded', array( $this, 'run' ), -10 );
  add_action( 'plugins_loaded', array( $this, 'run' ), -10 );
		add_action( 'plugins_loaded', array( $this, 'textdomain' ) );
	}

	/**
	 * Run the plugin, independent of activation methods.
	 */
	public function run() {

		$this->composer_loaded = $this->composer_loaded();

		$this->login_credentials = $this->get_login_credentials();

		// methods for deactivation.
		$deactivate = new Object_Sync_Sf_Deactivate();

		// logging methods.
		$this->logging = new Object_Sync_Sf_Logging();

		// methods for fieldmaps and object maps.
		$this->mappings = new Object_Sync_Sf_Mapping();

		// methods for WordPress.
		$this->wordpress = new Object_Sync_Sf_WordPress();

		// methods for calling the Salesforce API.
		$this->salesforce = $this->salesforce_get_api();

		// methods to push to Salesforce.
		$this->push = new Object_Sync_Sf_Salesforce_Push();

		// methods to pull from Salesforce.
		$this->pull = new Object_Sync_Sf_Salesforce_Pull();

		$this->rest = new Object_Sync_Sf_Rest();

		// admin functionality.
		new Object_Sync_Sf_Admin();
	}

	/**
	 * Autoload things from Composer.
	 *
	 * @return bool true
	 */
	private function composer_loaded() {
		require_once plugin_dir_path( $this->file ) . 'vendor/autoload.php';
		require_once /** @scrutinizer ignore-call */ plugin_dir_path( $this->file ) . 'vendor/autoload.php';
		return true;
	}

	/**
	 * Set the Salesforce API version.
	 * As of version 2.2.0, this is set by the plugin and is not configurable in the interface, though it can be overridden by developer hook.
	 * Until version 3.0, this value will be overridden by pre-existing settings.
	 *
	 * @return array $sf_api_version_data what we know about the API version that is in use.
	 */
	public function get_salesforce_api_version() {
		$sf_api_version      = OBJECT_SYNC_SF_DEFAULT_API_VERSION;
		$sf_api_version_data = array(
			'rest_api_version'        => $sf_api_version,
			'using_deprecated_option' => false,
			'using_developer_filter'  => false,
		);

		// check for a deprecated version. if provided, use it.
		$deprecated_api_version = $this->check_deprecated_salesforce_api_version( $sf_api_version );
		$deprecated_api_version = /** @scrutinizer ignore-deprecated */ $this->check_deprecated_salesforce_api_version( $sf_api_version );
		if ( '' !== $deprecated_api_version ) {
			$sf_api_version_data['rest_api_version']        = $deprecated_api_version;
			$sf_api_version_data['using_deprecated_option'] = true;
		}

		// developers can modify the active API version. if provided, this takes priority.
		$developer_api_version = apply_filters( $this->option_prefix . 'modify_salesforce_api_version', $sf_api_version );
		$developer_api_version = /** @scrutinizer ignore-call */ apply_filters( $this->option_prefix . 'modify_salesforce_api_version', $sf_api_version );
		if ( $developer_api_version !== $sf_api_version ) {
			$sf_api_version_data['rest_api_version']       = $developer_api_version;
			$sf_api_version_data['using_developer_filter'] = true;
		}
		/* // phpcs:ignore Squiz.PHP.CommentedOutCode.Found
		 * example to change the REST API version by filter
		 * add_filter( 'object_sync_for_salesforce_modify_salesforce_api_version', 'modify_salesforce_api_version', 10, 1 );
		 * function modify_salesforce_api_version( $sf_api_version ) {
		 * 	$sf_api_version = '52.0';
		 * 	return $sf_api_version;
		 * }
		*/

		// return array that includes: 1) what version, 2) if it is a deprecated version, 3) if it is developer overridden.
		return $sf_api_version_data;
	}

	/**
	 * Check deprecated methods for a Salesforce API version.
	 *
	 * @param string $sf_api_version the active Salesforce version.
	 * @return string $deprecated_api_version the deprecated Salesforce version, if it exists.
	 * @deprecated and will be removed in version 3.0.
	 */
	private function check_deprecated_salesforce_api_version( $sf_api_version ) {
		$deprecated_api_version = defined( 'OBJECT_SYNC_SF_SALESFORCE_API_VERSION' ) ? OBJECT_SYNC_SF_SALESFORCE_API_VERSION : '';

		// if the constant exists.
		if ( '' === $deprecated_api_version ) {
			$deprecated_option_key = $this->option_prefix . 'api_version';
			$deprecated_api_option = get_option( $deprecated_option_key, 'not-exists' );
			$deprecated_api_option = /** @scrutinizer ignore-call */ get_option( $deprecated_option_key, 'not-exists' );
			// if the option exists (the value in the database is not not-exists).
			if ( 'not-exists' !== $deprecated_api_option ) {
				$deprecated_api_version = $deprecated_api_option;
				// if it exists, and is set to "" or exists and is is the same as the default version, just delete it.
				if ( '' === $deprecated_api_version || $deprecated_api_version === $sf_api_version ) {
					$deprecated_api_version = '';
					delete_option( $deprecated_option_key );
     delete_option( $deprecated_option_key );
				}
			}
		}
		return $deprecated_api_version;
	}

	/**
	 * Get the pre-login Salesforce credentials.
	 * These depend on the plugin's settings or constants defined in wp-config.php.
	 *
	 * @return array $login_credentials
	 */
	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', '' );
		$consumer_key        = defined( 'OBJECT_SYNC_SF_SALESFORCE_CONSUMER_KEY' ) ? OBJECT_SYNC_SF_SALESFORCE_CONSUMER_KEY : /** @scrutinizer ignore-call */ get_option( $this->option_prefix . 'consumer_key', '' );
		$consumer_secret     = defined( 'OBJECT_SYNC_SF_SALESFORCE_CONSUMER_SECRET' ) ? OBJECT_SYNC_SF_SALESFORCE_CONSUMER_SECRET : get_option( $this->option_prefix . 'consumer_secret', '' );

		$callback_url        = defined( 'OBJECT_SYNC_SF_SALESFORCE_CALLBACK_URL' ) ? OBJECT_SYNC_SF_SALESFORCE_CALLBACK_URL : get_option( $this->option_prefix . 'callback_url', '' );

		$login_base_url      = defined( 'OBJECT_SYNC_SF_SALESFORCE_LOGIN_BASE_URL' ) ? OBJECT_SYNC_SF_SALESFORCE_LOGIN_BASE_URL : get_option( $this->option_prefix . 'login_base_url', '' );

		$authorize_url_path  = defined( 'OBJECT_SYNC_SF_SALESFORCE_AUTHORIZE_URL_PATH' ) ? OBJECT_SYNC_SF_SALESFORCE_AUTHORIZE_URL_PATH : get_option( $this->option_prefix . 'authorize_url_path', '' );

		$token_url_path      = defined( 'OBJECT_SYNC_SF_SALESFORCE_TOKEN_URL_PATH' ) ? OBJECT_SYNC_SF_SALESFORCE_TOKEN_URL_PATH : get_option( $this->option_prefix . 'token_url_path', '' );

		$sf_api_version_data = $this->get_salesforce_api_version();

		$login_credentials = array(
			'consumer_key'    => $consumer_key,
			'consumer_secret' => $consumer_secret,
			'callback_url'    => $callback_url,
			'login_url'       => $login_base_url,
			'authorize_path'  => $authorize_url_path,
			'token_path'      => $token_url_path,
		);
		$login_credentials = array_merge( $login_credentials, $sf_api_version_data );
		return $login_credentials;
	}

	/**
	 * 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 we use.
	 *
	 * @return array
	 */
	public function salesforce_get_api() {

		$soap_available = $this->is_soap_available();
		$soap_loaded    = $this->is_soap_loaded();

		$consumer_key    = $this->login_credentials['consumer_key'];
		$consumer_secret = $this->login_credentials['consumer_secret'];
		$is_authorized   = false;
		$sfapi           = '';
		if ( $consumer_key && $consumer_secret ) {
			$sfapi = new Object_Sync_Sf_Salesforce();
			if ( true === $sfapi->is_authorized() ) {
				$is_authorized = true;
			}
		}

		return array(
			'is_authorized'  => $is_authorized,
			'sfapi'          => $sfapi,
			'soap_available' => $soap_available,
			'soap_loaded'    => $soap_loaded,
		);
	}

	/**
	 * Load textdomain
	 */
	public function textdomain() {
		load_plugin_textdomain( 'object-sync-for-salesforce', false, dirname( plugin_basename( $this->file ) ) . '/languages/' );
		load_plugin_textdomain( 'object-sync-for-salesforce', false, dirname( /** @scrutinizer ignore-call */ plugin_basename( $this->file ) ) . '/languages/' );
	}

	/**
	 * Check the server to see if Soap is available
	 *
	 * @return bool $is_soap_available
	 */
	private function is_soap_available() {
		$is_soap_available = false;
		if ( extension_loaded( 'soap' ) && class_exists( 'SoapClient' ) ) {
			$is_soap_available = true;
		}
		return $is_soap_available;
	}

	/**
	 * Check the plugin to see if the Soap option has been enabled and the class has been loaded
	 *
	 * @return bool $is_soap_loaded
	 */
	private function is_soap_loaded() {
		$is_soap_loaded = false;
		if ( false === $this->is_soap_available() ) {
			return $is_soap_loaded;
		}
		$use_soap = filter_var( get_option( 'object_sync_for_salesforce_use_soap', false ), FILTER_VALIDATE_BOOLEAN );
		$use_soap = filter_var( /** @scrutinizer ignore-call */ get_option( 'object_sync_for_salesforce_use_soap', false ), FILTER_VALIDATE_BOOLEAN );
		if ( false === $use_soap ) {
			return $is_soap_loaded;
		}
		if ( class_exists( 'Object_Sync_Sf_Salesforce_Soap_Partner' ) ) {
			$is_soap_loaded = true;
		}
		return $is_soap_loaded;
	}

} // end class

MinnPost / object-sync-for-salesforce

Object_Sync_Salesforce::get_instance() A last analyzed 2024-10-09 02:21 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Object_Sync_Salesforce::get_instance() A
last analyzed 2024-10-09 02:21 UTC
