insideout10 / wordlift-plugin

src/includes/class-wordlift-configuration-service.php

Indentation +798 added lines, -798 removed lines

@@ -13,7 +13,7 @@ 
 use Wordlift\Api\Default_Api_Service;
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -23,806 +23,806 @@ 
  */
 class Wordlift_Configuration_Service {
 
-	/**
-	 * The entity base path option name.
-	 *
-	 * @since 3.6.0
-	 */
-	const ENTITY_BASE_PATH_KEY = 'wl_entity_base_path';
-
-	/**
-	 * The skip wizard (admin installation wizard) option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const SKIP_WIZARD = 'wl_skip_wizard';
-
-	/**
-	 * The skip installation notice.
-	 *
-	 * @since 3.40.3
-	 */
-	const SKIP_INSTALLATION_NOTICE = 'wl_skip_installation_notice';
-
-	/**
-	 * WordLift's key option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const KEY = 'key';
-
-	/**
-	 * WordLift's configured language option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const LANGUAGE = 'site_language';
-
-	/**
-	 * WordLift's configured country code.
-	 *
-	 * @since 3.18.0
-	 */
-	const COUNTRY_CODE = 'country_code';
-
-	/**
-	 * The alternateName option name.
-	 *
-	 * @since 3.38.6
-	 */
-	const ALTERNATE_NAME = 'wl-alternate-name';
-
-	/**
-	 * The publisher entity post ID option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const PUBLISHER_ID = 'publisher_id';
-
-	/**
-	 * The dataset URI option name
-	 *
-	 * @since 3.10.0
-	 */
-	const DATASET_URI = 'redlink_dataset_uri';
-
-	/**
-	 * The link by default option name.
-	 *
-	 * @since 3.11.0
-	 */
-	const LINK_BY_DEFAULT = 'link_by_default';
-
-	/**
-	 * The analytics enable option.
-	 *
-	 * @since 3.21.0
-	 */
-	const ANALYTICS_ENABLE = 'analytics_enable';
-
-	/**
-	 * The analytics entity uri dimension option.
-	 *
-	 * @since 3.21.0
-	 */
-	const ANALYTICS_ENTITY_URI_DIMENSION = 'analytics_entity_uri_dimension';
-
-	/**
-	 * The analytics entity type dimension option.
-	 *
-	 * @since 3.21.0
-	 */
-	const ANALYTICS_ENTITY_TYPE_DIMENSION = 'analytics_entity_type_dimension';
-
-	/**
-	 * The user preferences about sharing data option.
-	 *
-	 * @since 3.19.0
-	 */
-	const SEND_DIAGNOSTIC = 'send_diagnostic';
-
-	/**
-	 * The package type configuration key.
-	 *
-	 * @since 3.20.0
-	 */
-	const PACKAGE_TYPE = 'package_type';
-	/**
-	 * The dataset ids connected to the current key
-	 *
-	 * @since 3.38.5
-	 */
-	const NETWORK_DATASET_IDS = 'network_dataset_ids';
-
-	const OVERRIDE_WEBSITE_URL = 'wl-override-website-url';
-
-	/**
-	 * The {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var \Wordlift_Log_Service $log The {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a Wordlift_Configuration_Service's instance.
-	 *
-	 * @since 3.6.0
-	 */
-	protected function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		// Sync some configuration properties when key is validated.
-		add_action( 'wl_key_validation_response', array( $this, 'sync' ) );
-
-	}
-
-	/**
-	 * @param $response \Wordlift\Api\Response
-	 *
-	 * @return void
-	 */
-	public function sync( $response ) {
-		if ( ! $response->is_success() ) {
-			return;
-		}
-		$data = json_decode( $response->get_body(), true );
-		if ( ! is_array( $data ) || ! array_key_exists( 'networkDatasetId', $data ) ) {
-			return;
-		}
-		$this->set_network_dataset_ids( $data['networkDatasetId'] );
-	}
-
-	/**
-	 * The Wordlift_Configuration_Service's singleton instance.
-	 *
-	 * @since  3.6.0
-	 *
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $instance Wordlift_Configuration_Service's singleton instance.
-	 */
-	private static $instance = null;
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @return \Wordlift_Configuration_Service
-	 * @since 3.6.0
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get a configuration given the option name and a key. The option value is
-	 * expected to be an array.
-	 *
-	 * @param string $option The option name.
-	 * @param string $key A key in the option value array.
-	 * @param string $default The default value in case the key is not found (by default an empty string).
-	 *
-	 * @return mixed The configuration value or the default value if not found.
-	 * @since 3.6.0
-	 */
-	private function get( $option, $key, $default = '' ) {
-
-		$options = get_option( $option, array() );
-
-		return isset( $options[ $key ] ) ? $options[ $key ] : $default;
-	}
-
-	/**
-	 * Set a configuration parameter.
-	 *
-	 * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
-	 * @param string $key The value key.
-	 * @param mixed  $value The value.
-	 *
-	 * @since 3.9.0
-	 */
-	private function set( $option, $key, $value ) {
-
-		$values         = get_option( $option );
-		$values         = isset( $values ) ? $values : array();
-		$values[ $key ] = $value;
-		update_option( $option, $values );
-
-	}
-
-	/**
-	 * Get the entity base path, by default 'entity'.
-	 *
-	 * @return string The entity base path.
-	 * @since 3.6.0
-	 */
-	public function get_entity_base_path() {
-
-		return $this->get( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity' );
-	}
-
-	/**
-	 * Get the entity base path.
-	 *
-	 * @param string $value The entity base path.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_entity_base_path( $value ) {
-
-		$this->set( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value );
-
-	}
-
-	/**
-	 * Whether the installation skip wizard should be skipped.
-	 *
-	 * @return bool True if it should be skipped otherwise false.
-	 * @since 3.9.0
-	 */
-	public function is_skip_wizard() {
-
-		return $this->get( 'wl_general_settings', self::SKIP_WIZARD, false );
-	}
-
-	/**
-	 * Set the skip wizard parameter.
-	 *
-	 * @param bool $value True to skip the wizard. We expect a boolean value.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_skip_wizard( $value ) {
-
-		$this->set( 'wl_general_settings', self::SKIP_WIZARD, true === $value );
-
-	}
-
-	/**
-	 * Get WordLift's key.
-	 *
-	 * @return string WordLift's key or an empty string if not set.
-	 * @since 3.9.0
-	 */
-	public function get_key() {
-
-		return $this->get( 'wl_general_settings', self::KEY, '' );
-	}
-
-	/**
-	 * Set WordLift's key.
-	 *
-	 * @param string $value WordLift's key.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_key( $value ) {
-
-		$this->set( 'wl_general_settings', self::KEY, $value );
-	}
-
-	/**
-	 * Get WordLift's configured language, by default 'en'.
-	 *
-	 * Note that WordLift's language is used when writing strings to the Linked Data dataset, not for the analysis.
-	 *
-	 * @return string WordLift's configured language code ('en' by default).
-	 * @since 3.9.0
-	 */
-	public function get_language_code() {
-
-		$language = get_locale();
-		if ( ! $language ) {
-			return 'en';
-		}
-
-		return substr( $language, 0, 2 );
-	}
-
-	/**
-	 * @param string $value WordLift's language code.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/1466
-	 *
-	 * Set WordLift's language code, used when storing strings to the Linked Data dataset.
-	 *
-	 * @deprecated As of 3.32.7 this below method has no effect on setting the language, we use the
-	 * language code form WordPress directly.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_language_code( $value ) {
-
-		$this->set( 'wl_general_settings', self::LANGUAGE, $value );
-
-	}
-
-	/**
-	 * Set the user preferences about sharing diagnostic with us.
-	 *
-	 * @param string $value The user preferences(yes/no).
-	 *
-	 * @since 3.19.0
-	 */
-	public function set_diagnostic_preferences( $value ) {
-
-		$this->set( 'wl_general_settings', self::SEND_DIAGNOSTIC, $value );
-
-	}
-
-	/**
-	 * Get the user preferences about sharing diagnostic.
-	 *
-	 * @since 3.19.0
-	 */
-	public function get_diagnostic_preferences() {
-
-		return $this->get( 'wl_general_settings', self::SEND_DIAGNOSTIC, 'no' );
-	}
-
-	/**
-	 * Get WordLift's configured country code, by default 'us'.
-	 *
-	 * @return string WordLift's configured country code ('us' by default).
-	 * @since 3.18.0
-	 */
-	public function get_country_code() {
-
-		return $this->get( 'wl_general_settings', self::COUNTRY_CODE, 'us' );
-	}
-
-	/**
-	 * Set WordLift's country code.
-	 *
-	 * @param string $value WordLift's country code.
-	 *
-	 * @since 3.18.0
-	 */
-	public function set_country_code( $value ) {
-
-		$this->set( 'wl_general_settings', self::COUNTRY_CODE, $value );
-
-	}
-
-	/**
-	 * Get the alternateName.
-	 *
-	 * Website markup alternateName
-	 *
-	 * @return string|NULL alternateName or NULL if not set.
-	 * @since 3.38.6
-	 */
-	public function get_alternate_name() {
-		return $this->get( 'wl_general_settings', self::ALTERNATE_NAME );
-	}
-
-	/**
-	 * Set the alternateName.
-	 *
-	 * @param int $value The alternateName value.
-	 *
-	 * @since 3.38.6
-	 */
-	public function set_alternate_name( $value ) {
-
-		$this->set( 'wl_general_settings', self::ALTERNATE_NAME, wp_strip_all_tags( $value ) );
-
-	}
-
-	/**
-	 * Get the publisher entity post id.
-	 *
-	 * The publisher entity post id points to an entity post which contains the data for the publisher used in schema.org
-	 * Article markup.
-	 *
-	 * @return int|NULL The publisher entity post id or NULL if not set.
-	 * @since 3.9.0
-	 */
-	public function get_publisher_id() {
-
-		return $this->get( 'wl_general_settings', self::PUBLISHER_ID, null );
-	}
-
-	/**
-	 * Set the publisher entity post id.
-	 *
-	 * @param int $value The publisher entity post id.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_publisher_id( $value ) {
-
-		$this->set( 'wl_general_settings', self::PUBLISHER_ID, $value );
-
-	}
-
-	/**
-	 * Get the dataset URI.
-	 *
-	 * @return string The dataset URI or an empty string if not set.
-	 * @since 3.10.0
-	 * @since 3.27.7 Always return null if `wl_features__enable__dataset` is disabled.
-	 */
-	public function get_dataset_uri() {
-
-		if ( apply_filters( 'wl_feature__enable__dataset', true ) ) {
-			return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * Set the dataset URI.
-	 *
-	 * @param string $value The dataset URI.
-	 *
-	 * @since 3.10.0
-	 */
-	public function set_dataset_uri( $value ) {
-
-		$this->set( 'wl_advanced_settings', self::DATASET_URI, $value );
-	}
-
-	/**
-	 * Get the package type.
-	 *
-	 * @return string The package type or an empty string if not set.
-	 * @since 3.20.0
-	 */
-	public function get_package_type() {
-
-		return $this->get( 'wl_advanced_settings', self::PACKAGE_TYPE, null );
-	}
-
-	/**
-	 * Set the package type.
-	 *
-	 * @param string $value The package type.
-	 *
-	 * @since 3.20.0
-	 */
-	public function set_package_type( $value ) {
-		$this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
-	}
-
-	/**
-	 * Intercept the change of the WordLift key in order to set the dataset URI.
-	 *
-	 * @since 3.20.0 as of #761, we save settings every time a key is set, not only when the key changes, so to
-	 *               store the configuration parameters such as country or language.
-	 * @since 3.11.0
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/761
-	 *
-	 * @param array $old_value The old settings.
-	 * @param array $new_value The new settings.
-	 */
-	public function update_key( $old_value, $new_value ) {
-
-		// Check the old key value and the new one. We're going to ask for the dataset URI only if the key has changed.
-		// $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $new_value['key'] ) ? trim( $new_value['key'] ) : '';
-
-		// If the key hasn't changed, don't do anything.
-		// WARN The 'update_option' hook is fired only if the new and old value are not equal.
-		// if ( $old_key === $new_key ) {
-		// return;
-		// }
-
-		// If the key is empty, empty the dataset URI.
-		if ( '' === $new_key ) {
-			$this->set_dataset_uri( '' );
-		}
-
-		// make the request to the remote server.
-		$this->get_remote_dataset_uri( $new_key );
-
-		do_action( 'wl_key_updated' );
-
-	}
-
-	/**
-	 * Handle retrieving the dataset uri from the remote server.
-	 *
-	 * If a valid dataset uri is returned it is stored in the appropriate option,
-	 * otherwise the option is set to empty string.
-	 *
-	 * @param string $key The key to be used.
-	 *
-	 * @since 3.12.0
-	 *
-	 * @since 3.17.0 send the site URL and get the dataset URI.
-	 */
-	public function get_remote_dataset_uri( $key ) {
-
-		$this->log->trace( 'Getting the remote dataset URI and package type...' );
-
-		if ( empty( $key ) ) {
-			$this->log->warn( 'Key set to empty value.' );
-
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
-
-			return;
-		}
-
-		/**
-		 * Allow 3rd parties to change the site_url.
-		 *
-		 * @param string $site_url The site url.
-		 *
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/850
-		 *
-		 * @since 3.20.0
-		 */
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
-
-		// Build the URL.
-		$url = '/accounts'
-			   . '?key=' . rawurlencode( $key )
-			   . '&url=' . rawurlencode( $site_url )
-			   . '&country=' . $this->get_country_code()
-			   . '&language=' . $this->get_language_code();
-
-		$api_service = Default_Api_Service::get_instance();
-		/**
-		 * @since 3.27.7.1
-		 * The Key should be passed to headers, otherwise api would return null.
-		 */
-		$headers  = array(
-			'Authorization' => "Key $key",
-		);
-		$response = $api_service->request( 'PUT', $url, $headers )->get_response();
-
-		// The response is an error.
-		if ( is_wp_error( $response ) ) {
-			$this->log->error( 'An error occurred setting the dataset URI: ' . $response->get_error_message() );
-
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
-
-			return;
-		}
-
-		// The response is not OK.
-		if ( ! is_array( $response ) || 200 !== (int) $response['response']['code'] ) {
-			$base_url = $api_service->get_base_url();
-
-			if ( ! is_array( $response ) ) {
-				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
-			} else {
-				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected status code when opening URL $base_url$url: " . $response['response']['code'] . "\n" . var_export( $response, true ) );
-			}
-
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
-
-			return;
-		}
-
-		/*
+    /**
+     * The entity base path option name.
+     *
+     * @since 3.6.0
+     */
+    const ENTITY_BASE_PATH_KEY = 'wl_entity_base_path';
+
+    /**
+     * The skip wizard (admin installation wizard) option name.
+     *
+     * @since 3.9.0
+     */
+    const SKIP_WIZARD = 'wl_skip_wizard';
+
+    /**
+     * The skip installation notice.
+     *
+     * @since 3.40.3
+     */
+    const SKIP_INSTALLATION_NOTICE = 'wl_skip_installation_notice';
+
+    /**
+     * WordLift's key option name.
+     *
+     * @since 3.9.0
+     */
+    const KEY = 'key';
+
+    /**
+     * WordLift's configured language option name.
+     *
+     * @since 3.9.0
+     */
+    const LANGUAGE = 'site_language';
+
+    /**
+     * WordLift's configured country code.
+     *
+     * @since 3.18.0
+     */
+    const COUNTRY_CODE = 'country_code';
+
+    /**
+     * The alternateName option name.
+     *
+     * @since 3.38.6
+     */
+    const ALTERNATE_NAME = 'wl-alternate-name';
+
+    /**
+     * The publisher entity post ID option name.
+     *
+     * @since 3.9.0
+     */
+    const PUBLISHER_ID = 'publisher_id';
+
+    /**
+     * The dataset URI option name
+     *
+     * @since 3.10.0
+     */
+    const DATASET_URI = 'redlink_dataset_uri';
+
+    /**
+     * The link by default option name.
+     *
+     * @since 3.11.0
+     */
+    const LINK_BY_DEFAULT = 'link_by_default';
+
+    /**
+     * The analytics enable option.
+     *
+     * @since 3.21.0
+     */
+    const ANALYTICS_ENABLE = 'analytics_enable';
+
+    /**
+     * The analytics entity uri dimension option.
+     *
+     * @since 3.21.0
+     */
+    const ANALYTICS_ENTITY_URI_DIMENSION = 'analytics_entity_uri_dimension';
+
+    /**
+     * The analytics entity type dimension option.
+     *
+     * @since 3.21.0
+     */
+    const ANALYTICS_ENTITY_TYPE_DIMENSION = 'analytics_entity_type_dimension';
+
+    /**
+     * The user preferences about sharing data option.
+     *
+     * @since 3.19.0
+     */
+    const SEND_DIAGNOSTIC = 'send_diagnostic';
+
+    /**
+     * The package type configuration key.
+     *
+     * @since 3.20.0
+     */
+    const PACKAGE_TYPE = 'package_type';
+    /**
+     * The dataset ids connected to the current key
+     *
+     * @since 3.38.5
+     */
+    const NETWORK_DATASET_IDS = 'network_dataset_ids';
+
+    const OVERRIDE_WEBSITE_URL = 'wl-override-website-url';
+
+    /**
+     * The {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var \Wordlift_Log_Service $log The {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a Wordlift_Configuration_Service's instance.
+     *
+     * @since 3.6.0
+     */
+    protected function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        // Sync some configuration properties when key is validated.
+        add_action( 'wl_key_validation_response', array( $this, 'sync' ) );
+
+    }
+
+    /**
+     * @param $response \Wordlift\Api\Response
+     *
+     * @return void
+     */
+    public function sync( $response ) {
+        if ( ! $response->is_success() ) {
+            return;
+        }
+        $data = json_decode( $response->get_body(), true );
+        if ( ! is_array( $data ) || ! array_key_exists( 'networkDatasetId', $data ) ) {
+            return;
+        }
+        $this->set_network_dataset_ids( $data['networkDatasetId'] );
+    }
+
+    /**
+     * The Wordlift_Configuration_Service's singleton instance.
+     *
+     * @since  3.6.0
+     *
+     * @access private
+     * @var \Wordlift_Configuration_Service $instance Wordlift_Configuration_Service's singleton instance.
+     */
+    private static $instance = null;
+
+    /**
+     * Get the singleton instance.
+     *
+     * @return \Wordlift_Configuration_Service
+     * @since 3.6.0
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Get a configuration given the option name and a key. The option value is
+     * expected to be an array.
+     *
+     * @param string $option The option name.
+     * @param string $key A key in the option value array.
+     * @param string $default The default value in case the key is not found (by default an empty string).
+     *
+     * @return mixed The configuration value or the default value if not found.
+     * @since 3.6.0
+     */
+    private function get( $option, $key, $default = '' ) {
+
+        $options = get_option( $option, array() );
+
+        return isset( $options[ $key ] ) ? $options[ $key ] : $default;
+    }
+
+    /**
+     * Set a configuration parameter.
+     *
+     * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
+     * @param string $key The value key.
+     * @param mixed  $value The value.
+     *
+     * @since 3.9.0
+     */
+    private function set( $option, $key, $value ) {
+
+        $values         = get_option( $option );
+        $values         = isset( $values ) ? $values : array();
+        $values[ $key ] = $value;
+        update_option( $option, $values );
+
+    }
+
+    /**
+     * Get the entity base path, by default 'entity'.
+     *
+     * @return string The entity base path.
+     * @since 3.6.0
+     */
+    public function get_entity_base_path() {
+
+        return $this->get( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity' );
+    }
+
+    /**
+     * Get the entity base path.
+     *
+     * @param string $value The entity base path.
+     *
+     * @since 3.9.0
+     */
+    public function set_entity_base_path( $value ) {
+
+        $this->set( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value );
+
+    }
+
+    /**
+     * Whether the installation skip wizard should be skipped.
+     *
+     * @return bool True if it should be skipped otherwise false.
+     * @since 3.9.0
+     */
+    public function is_skip_wizard() {
+
+        return $this->get( 'wl_general_settings', self::SKIP_WIZARD, false );
+    }
+
+    /**
+     * Set the skip wizard parameter.
+     *
+     * @param bool $value True to skip the wizard. We expect a boolean value.
+     *
+     * @since 3.9.0
+     */
+    public function set_skip_wizard( $value ) {
+
+        $this->set( 'wl_general_settings', self::SKIP_WIZARD, true === $value );
+
+    }
+
+    /**
+     * Get WordLift's key.
+     *
+     * @return string WordLift's key or an empty string if not set.
+     * @since 3.9.0
+     */
+    public function get_key() {
+
+        return $this->get( 'wl_general_settings', self::KEY, '' );
+    }
+
+    /**
+     * Set WordLift's key.
+     *
+     * @param string $value WordLift's key.
+     *
+     * @since 3.9.0
+     */
+    public function set_key( $value ) {
+
+        $this->set( 'wl_general_settings', self::KEY, $value );
+    }
+
+    /**
+     * Get WordLift's configured language, by default 'en'.
+     *
+     * Note that WordLift's language is used when writing strings to the Linked Data dataset, not for the analysis.
+     *
+     * @return string WordLift's configured language code ('en' by default).
+     * @since 3.9.0
+     */
+    public function get_language_code() {
+
+        $language = get_locale();
+        if ( ! $language ) {
+            return 'en';
+        }
+
+        return substr( $language, 0, 2 );
+    }
+
+    /**
+     * @param string $value WordLift's language code.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/1466
+     *
+     * Set WordLift's language code, used when storing strings to the Linked Data dataset.
+     *
+     * @deprecated As of 3.32.7 this below method has no effect on setting the language, we use the
+     * language code form WordPress directly.
+     *
+     * @since 3.9.0
+     */
+    public function set_language_code( $value ) {
+
+        $this->set( 'wl_general_settings', self::LANGUAGE, $value );
+
+    }
+
+    /**
+     * Set the user preferences about sharing diagnostic with us.
+     *
+     * @param string $value The user preferences(yes/no).
+     *
+     * @since 3.19.0
+     */
+    public function set_diagnostic_preferences( $value ) {
+
+        $this->set( 'wl_general_settings', self::SEND_DIAGNOSTIC, $value );
+
+    }
+
+    /**
+     * Get the user preferences about sharing diagnostic.
+     *
+     * @since 3.19.0
+     */
+    public function get_diagnostic_preferences() {
+
+        return $this->get( 'wl_general_settings', self::SEND_DIAGNOSTIC, 'no' );
+    }
+
+    /**
+     * Get WordLift's configured country code, by default 'us'.
+     *
+     * @return string WordLift's configured country code ('us' by default).
+     * @since 3.18.0
+     */
+    public function get_country_code() {
+
+        return $this->get( 'wl_general_settings', self::COUNTRY_CODE, 'us' );
+    }
+
+    /**
+     * Set WordLift's country code.
+     *
+     * @param string $value WordLift's country code.
+     *
+     * @since 3.18.0
+     */
+    public function set_country_code( $value ) {
+
+        $this->set( 'wl_general_settings', self::COUNTRY_CODE, $value );
+
+    }
+
+    /**
+     * Get the alternateName.
+     *
+     * Website markup alternateName
+     *
+     * @return string|NULL alternateName or NULL if not set.
+     * @since 3.38.6
+     */
+    public function get_alternate_name() {
+        return $this->get( 'wl_general_settings', self::ALTERNATE_NAME );
+    }
+
+    /**
+     * Set the alternateName.
+     *
+     * @param int $value The alternateName value.
+     *
+     * @since 3.38.6
+     */
+    public function set_alternate_name( $value ) {
+
+        $this->set( 'wl_general_settings', self::ALTERNATE_NAME, wp_strip_all_tags( $value ) );
+
+    }
+
+    /**
+     * Get the publisher entity post id.
+     *
+     * The publisher entity post id points to an entity post which contains the data for the publisher used in schema.org
+     * Article markup.
+     *
+     * @return int|NULL The publisher entity post id or NULL if not set.
+     * @since 3.9.0
+     */
+    public function get_publisher_id() {
+
+        return $this->get( 'wl_general_settings', self::PUBLISHER_ID, null );
+    }
+
+    /**
+     * Set the publisher entity post id.
+     *
+     * @param int $value The publisher entity post id.
+     *
+     * @since 3.9.0
+     */
+    public function set_publisher_id( $value ) {
+
+        $this->set( 'wl_general_settings', self::PUBLISHER_ID, $value );
+
+    }
+
+    /**
+     * Get the dataset URI.
+     *
+     * @return string The dataset URI or an empty string if not set.
+     * @since 3.10.0
+     * @since 3.27.7 Always return null if `wl_features__enable__dataset` is disabled.
+     */
+    public function get_dataset_uri() {
+
+        if ( apply_filters( 'wl_feature__enable__dataset', true ) ) {
+            return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Set the dataset URI.
+     *
+     * @param string $value The dataset URI.
+     *
+     * @since 3.10.0
+     */
+    public function set_dataset_uri( $value ) {
+
+        $this->set( 'wl_advanced_settings', self::DATASET_URI, $value );
+    }
+
+    /**
+     * Get the package type.
+     *
+     * @return string The package type or an empty string if not set.
+     * @since 3.20.0
+     */
+    public function get_package_type() {
+
+        return $this->get( 'wl_advanced_settings', self::PACKAGE_TYPE, null );
+    }
+
+    /**
+     * Set the package type.
+     *
+     * @param string $value The package type.
+     *
+     * @since 3.20.0
+     */
+    public function set_package_type( $value ) {
+        $this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
+    }
+
+    /**
+     * Intercept the change of the WordLift key in order to set the dataset URI.
+     *
+     * @since 3.20.0 as of #761, we save settings every time a key is set, not only when the key changes, so to
+     *               store the configuration parameters such as country or language.
+     * @since 3.11.0
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/761
+     *
+     * @param array $old_value The old settings.
+     * @param array $new_value The new settings.
+     */
+    public function update_key( $old_value, $new_value ) {
+
+        // Check the old key value and the new one. We're going to ask for the dataset URI only if the key has changed.
+        // $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
+        $new_key = isset( $new_value['key'] ) ? trim( $new_value['key'] ) : '';
+
+        // If the key hasn't changed, don't do anything.
+        // WARN The 'update_option' hook is fired only if the new and old value are not equal.
+        // if ( $old_key === $new_key ) {
+        // return;
+        // }
+
+        // If the key is empty, empty the dataset URI.
+        if ( '' === $new_key ) {
+            $this->set_dataset_uri( '' );
+        }
+
+        // make the request to the remote server.
+        $this->get_remote_dataset_uri( $new_key );
+
+        do_action( 'wl_key_updated' );
+
+    }
+
+    /**
+     * Handle retrieving the dataset uri from the remote server.
+     *
+     * If a valid dataset uri is returned it is stored in the appropriate option,
+     * otherwise the option is set to empty string.
+     *
+     * @param string $key The key to be used.
+     *
+     * @since 3.12.0
+     *
+     * @since 3.17.0 send the site URL and get the dataset URI.
+     */
+    public function get_remote_dataset_uri( $key ) {
+
+        $this->log->trace( 'Getting the remote dataset URI and package type...' );
+
+        if ( empty( $key ) ) {
+            $this->log->warn( 'Key set to empty value.' );
+
+            $this->set_dataset_uri( '' );
+            $this->set_package_type( null );
+
+            return;
+        }
+
+        /**
+         * Allow 3rd parties to change the site_url.
+         *
+         * @param string $site_url The site url.
+         *
+         * @see https://github.com/insideout10/wordlift-plugin/issues/850
+         *
+         * @since 3.20.0
+         */
+        $home_url = get_option( 'home' );
+        $site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+
+        // Build the URL.
+        $url = '/accounts'
+                . '?key=' . rawurlencode( $key )
+                . '&url=' . rawurlencode( $site_url )
+                . '&country=' . $this->get_country_code()
+                . '&language=' . $this->get_language_code();
+
+        $api_service = Default_Api_Service::get_instance();
+        /**
+         * @since 3.27.7.1
+         * The Key should be passed to headers, otherwise api would return null.
+         */
+        $headers  = array(
+            'Authorization' => "Key $key",
+        );
+        $response = $api_service->request( 'PUT', $url, $headers )->get_response();
+
+        // The response is an error.
+        if ( is_wp_error( $response ) ) {
+            $this->log->error( 'An error occurred setting the dataset URI: ' . $response->get_error_message() );
+
+            $this->set_dataset_uri( '' );
+            $this->set_package_type( null );
+
+            return;
+        }
+
+        // The response is not OK.
+        if ( ! is_array( $response ) || 200 !== (int) $response['response']['code'] ) {
+            $base_url = $api_service->get_base_url();
+
+            if ( ! is_array( $response ) ) {
+                // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
+                $this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
+            } else {
+                // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
+                $this->log->error( "Unexpected status code when opening URL $base_url$url: " . $response['response']['code'] . "\n" . var_export( $response, true ) );
+            }
+
+            $this->set_dataset_uri( '' );
+            $this->set_package_type( null );
+
+            return;
+        }
+
+        /*
 		 * We also store the package type.
 		 *
 		 * @since 3.20.0
 		 */
-		$json = json_decode( $response['body'] );
-		/**
-		 * @since 3.27.7
-		 * Remove the trailing slash returned from the new platform api.
-		 */
-		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$dataset_uri = untrailingslashit( $json->datasetURI );
-		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$package_type = isset( $json->packageType ) ? $json->packageType : null;
-
-		$this->log->info( "Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]..." );
-
-		$this->set_dataset_uri( $dataset_uri );
-		$this->set_package_type( $package_type );
-	}
-
-	/**
-	 * Handle the edge case where a user submits the same key again
-	 * when he does not have the dataset uri to regain it.
-	 *
-	 * This can not be handled in the normal option update hook because
-	 * it is not being triggered when the save value equals to the one already
-	 * in the DB.
-	 *
-	 * @param mixed $value The new, unserialized option value.
-	 * @param mixed $old_value The old option value.
-	 *
-	 * @return mixed The same value in the $value parameter
-	 * @since 3.12.0
-	 */
-	public function maybe_update_dataset_uri( $value, $old_value ) {
-
-		// Check the old key value and the new one. Here we're only handling the
-		// case where the key hasn't changed and the dataset URI isn't set. The
-		// other case, i.e. a new key is inserted, is handled at `update_key`.
-		$old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $value['key'] ) ? trim( $value['key'] ) : '';
-
-		$dataset_uri = $this->get_dataset_uri();
-
-		if ( ! empty( $new_key ) && $new_key === $old_key && empty( $dataset_uri ) ) {
-
-			// make the request to the remote server to try to get the dataset uri.
-			$this->get_remote_dataset_uri( $new_key );
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Get the API URI to retrieve the dataset URI using the WordLift Key.
-	 *
-	 * @param string $key The WordLift key to use.
-	 *
-	 * @return string The API URI.
-	 * @since 3.11.0
-	 */
-	public function get_accounts_by_key_dataset_uri( $key ) {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/key=$key/dataset_uri";
-	}
-
-	/**
-	 * Get the `accounts` end point.
-	 *
-	 * @return string The `accounts` end point.
-	 * @since 3.16.0
-	 */
-	public function get_accounts() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
-	}
-
-	/**
-	 * Get the `link by default` option.
-	 *
-	 * @return bool True if entities must be linked by default otherwise false.
-	 * @since 3.13.0
-	 */
-	public function is_link_by_default() {
-
-		return 'yes' === $this->get( 'wl_general_settings', self::LINK_BY_DEFAULT, 'yes' );
-	}
-
-	/**
-	 * Set the `link by default` option.
-	 *
-	 * @param bool $value True to enabling linking by default, otherwise false.
-	 *
-	 * @since 3.13.0
-	 */
-	public function set_link_by_default( $value ) {
-
-		$this->set( 'wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no' );
-	}
-
-	/**
-	 * Get the 'analytics-enable' option.
-	 *
-	 * @return string 'no' or 'yes' representing bool.
-	 * @since 3.21.0
-	 */
-	public function is_analytics_enable() {
-		return 'yes' === $this->get( 'wl_analytics_settings', self::ANALYTICS_ENABLE, 'no' );
-	}
-
-	/**
-	 * Set the `analytics-enable` option.
-	 *
-	 * @param bool $value True to enabling analytics, otherwise false.
-	 *
-	 * @since 3.21.0
-	 */
-	public function set_is_analytics_enable( $value ) {
-
-		$this->set( 'wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no' );
-	}
-
-	/**
-	 * Get the 'analytics-entity-uri-dimention' option.
-	 *
-	 * @return int
-	 * @since 3.21.0
-	 */
-	public function get_analytics_entity_uri_dimension() {
-		return (int) $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1 );
-	}
-
-	/**
-	 * Get the 'analytics-entity-type-dimension' option.
-	 *
-	 * @return int
-	 * @since 3.21.0
-	 */
-	public function get_analytics_entity_type_dimension() {
-		return $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2 );
-	}
-
-	/**
-	 * Get the URL to perform autocomplete request.
-	 *
-	 * @return string The URL to call to perform the autocomplete request.
-	 * @since 3.15.0
-	 */
-	public function get_autocomplete_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
-
-	}
-
-	/**
-	 * Get the URL to perform feedback deactivation request.
-	 *
-	 * @return string The URL to call to perform the feedback deactivation request.
-	 * @since 3.19.0
-	 */
-	public function get_deactivation_feedback_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'feedbacks';
-
-	}
-
-	/**
-	 * Get the base API URL.
-	 *
-	 * @return string The base API URL.
-	 * @since 3.20.0
-	 */
-	public function get_api_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE;
-	}
-
-	public function get_network_dataset_ids() {
-		return $this->get( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, array() );
-	}
-
-	public function set_network_dataset_ids( $network_dataset_ids ) {
-		$this->set( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, $network_dataset_ids );
-	}
-
-	public function get_skip_installation_notice() {
-
-		return $this->get( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, false );
-	}
-
-	public function set_skip_installation_notice( $value ) {
-
-		$this->set( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, $value );
-
-	}
-
-	/**
-	 * The override URL or false if not set.
-	 *
-	 * @return false|string
-	 */
-	public function get_override_website_url() {
-		$value = $this->get( 'wl_general_settings', self::OVERRIDE_WEBSITE_URL, false );
-		if ( empty( $value ) ) {
-			return false;
-		}
-
-		return untrailingslashit( $value );
-	}
-
-	public function set_override_website_url( $value ) {
-		$this->set( 'wl_general_settings', self::OVERRIDE_WEBSITE_URL, $value );
-	}
+        $json = json_decode( $response['body'] );
+        /**
+         * @since 3.27.7
+         * Remove the trailing slash returned from the new platform api.
+         */
+        // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+        $dataset_uri = untrailingslashit( $json->datasetURI );
+        // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+        $package_type = isset( $json->packageType ) ? $json->packageType : null;
+
+        $this->log->info( "Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]..." );
+
+        $this->set_dataset_uri( $dataset_uri );
+        $this->set_package_type( $package_type );
+    }
+
+    /**
+     * Handle the edge case where a user submits the same key again
+     * when he does not have the dataset uri to regain it.
+     *
+     * This can not be handled in the normal option update hook because
+     * it is not being triggered when the save value equals to the one already
+     * in the DB.
+     *
+     * @param mixed $value The new, unserialized option value.
+     * @param mixed $old_value The old option value.
+     *
+     * @return mixed The same value in the $value parameter
+     * @since 3.12.0
+     */
+    public function maybe_update_dataset_uri( $value, $old_value ) {
+
+        // Check the old key value and the new one. Here we're only handling the
+        // case where the key hasn't changed and the dataset URI isn't set. The
+        // other case, i.e. a new key is inserted, is handled at `update_key`.
+        $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
+        $new_key = isset( $value['key'] ) ? trim( $value['key'] ) : '';
+
+        $dataset_uri = $this->get_dataset_uri();
+
+        if ( ! empty( $new_key ) && $new_key === $old_key && empty( $dataset_uri ) ) {
+
+            // make the request to the remote server to try to get the dataset uri.
+            $this->get_remote_dataset_uri( $new_key );
+        }
+
+        return $value;
+    }
+
+    /**
+     * Get the API URI to retrieve the dataset URI using the WordLift Key.
+     *
+     * @param string $key The WordLift key to use.
+     *
+     * @return string The API URI.
+     * @since 3.11.0
+     */
+    public function get_accounts_by_key_dataset_uri( $key ) {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/key=$key/dataset_uri";
+    }
+
+    /**
+     * Get the `accounts` end point.
+     *
+     * @return string The `accounts` end point.
+     * @since 3.16.0
+     */
+    public function get_accounts() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
+    }
+
+    /**
+     * Get the `link by default` option.
+     *
+     * @return bool True if entities must be linked by default otherwise false.
+     * @since 3.13.0
+     */
+    public function is_link_by_default() {
+
+        return 'yes' === $this->get( 'wl_general_settings', self::LINK_BY_DEFAULT, 'yes' );
+    }
+
+    /**
+     * Set the `link by default` option.
+     *
+     * @param bool $value True to enabling linking by default, otherwise false.
+     *
+     * @since 3.13.0
+     */
+    public function set_link_by_default( $value ) {
+
+        $this->set( 'wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no' );
+    }
+
+    /**
+     * Get the 'analytics-enable' option.
+     *
+     * @return string 'no' or 'yes' representing bool.
+     * @since 3.21.0
+     */
+    public function is_analytics_enable() {
+        return 'yes' === $this->get( 'wl_analytics_settings', self::ANALYTICS_ENABLE, 'no' );
+    }
+
+    /**
+     * Set the `analytics-enable` option.
+     *
+     * @param bool $value True to enabling analytics, otherwise false.
+     *
+     * @since 3.21.0
+     */
+    public function set_is_analytics_enable( $value ) {
+
+        $this->set( 'wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no' );
+    }
+
+    /**
+     * Get the 'analytics-entity-uri-dimention' option.
+     *
+     * @return int
+     * @since 3.21.0
+     */
+    public function get_analytics_entity_uri_dimension() {
+        return (int) $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1 );
+    }
+
+    /**
+     * Get the 'analytics-entity-type-dimension' option.
+     *
+     * @return int
+     * @since 3.21.0
+     */
+    public function get_analytics_entity_type_dimension() {
+        return $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2 );
+    }
+
+    /**
+     * Get the URL to perform autocomplete request.
+     *
+     * @return string The URL to call to perform the autocomplete request.
+     * @since 3.15.0
+     */
+    public function get_autocomplete_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
+
+    }
+
+    /**
+     * Get the URL to perform feedback deactivation request.
+     *
+     * @return string The URL to call to perform the feedback deactivation request.
+     * @since 3.19.0
+     */
+    public function get_deactivation_feedback_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'feedbacks';
+
+    }
+
+    /**
+     * Get the base API URL.
+     *
+     * @return string The base API URL.
+     * @since 3.20.0
+     */
+    public function get_api_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE;
+    }
+
+    public function get_network_dataset_ids() {
+        return $this->get( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, array() );
+    }
+
+    public function set_network_dataset_ids( $network_dataset_ids ) {
+        $this->set( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, $network_dataset_ids );
+    }
+
+    public function get_skip_installation_notice() {
+
+        return $this->get( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, false );
+    }
+
+    public function set_skip_installation_notice( $value ) {
+
+        $this->set( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, $value );
+
+    }
+
+    /**
+     * The override URL or false if not set.
+     *
+     * @return false|string
+     */
+    public function get_override_website_url() {
+        $value = $this->get( 'wl_general_settings', self::OVERRIDE_WEBSITE_URL, false );
+        if ( empty( $value ) ) {
+            return false;
+        }
+
+        return untrailingslashit( $value );
+    }
+
+    public function set_override_website_url( $value ) {
+        $this->set( 'wl_general_settings', self::OVERRIDE_WEBSITE_URL, $value );
+    }
 
 }

Spacing +113 added lines, -113 removed lines

@@ -12,7 +12,7 @@ 
 
 use Wordlift\Api\Default_Api_Service;
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -152,10 +152,10 @@ 
 	 */
 	protected function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		// Sync some configuration properties when key is validated.
-		add_action( 'wl_key_validation_response', array( $this, 'sync' ) );
+		add_action('wl_key_validation_response', array($this, 'sync'));
 
 	}
 
@@ -164,15 +164,15 @@ 
 	 *
 	 * @return void
 	 */
-	public function sync( $response ) {
-		if ( ! $response->is_success() ) {
+	public function sync($response) {
+		if ( ! $response->is_success()) {
 			return;
 		}
-		$data = json_decode( $response->get_body(), true );
-		if ( ! is_array( $data ) || ! array_key_exists( 'networkDatasetId', $data ) ) {
+		$data = json_decode($response->get_body(), true);
+		if ( ! is_array($data) || ! array_key_exists('networkDatasetId', $data)) {
 			return;
 		}
-		$this->set_network_dataset_ids( $data['networkDatasetId'] );
+		$this->set_network_dataset_ids($data['networkDatasetId']);
 	}
 
 	/**
@@ -193,7 +193,7 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -211,11 +211,11 @@ 
 	 * @return mixed The configuration value or the default value if not found.
 	 * @since 3.6.0
 	 */
-	private function get( $option, $key, $default = '' ) {
+	private function get($option, $key, $default = '') {
 
-		$options = get_option( $option, array() );
+		$options = get_option($option, array());
 
-		return isset( $options[ $key ] ) ? $options[ $key ] : $default;
+		return isset($options[$key]) ? $options[$key] : $default;
 	}
 
 	/**
@@ -227,12 +227,12 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	private function set( $option, $key, $value ) {
+	private function set($option, $key, $value) {
 
-		$values         = get_option( $option );
-		$values         = isset( $values ) ? $values : array();
-		$values[ $key ] = $value;
-		update_option( $option, $values );
+		$values         = get_option($option);
+		$values         = isset($values) ? $values : array();
+		$values[$key] = $value;
+		update_option($option, $values);
 
 	}
 
@@ -244,7 +244,7 @@ 
 	 */
 	public function get_entity_base_path() {
 
-		return $this->get( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity' );
+		return $this->get('wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity');
 	}
 
 	/**
@@ -254,9 +254,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	public function set_entity_base_path( $value ) {
+	public function set_entity_base_path($value) {
 
-		$this->set( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value );
+		$this->set('wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value);
 
 	}
 
@@ -268,7 +268,7 @@ 
 	 */
 	public function is_skip_wizard() {
 
-		return $this->get( 'wl_general_settings', self::SKIP_WIZARD, false );
+		return $this->get('wl_general_settings', self::SKIP_WIZARD, false);
 	}
 
 	/**
@@ -278,9 +278,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	public function set_skip_wizard( $value ) {
+	public function set_skip_wizard($value) {
 
-		$this->set( 'wl_general_settings', self::SKIP_WIZARD, true === $value );
+		$this->set('wl_general_settings', self::SKIP_WIZARD, true === $value);
 
 	}
 
@@ -292,7 +292,7 @@ 
 	 */
 	public function get_key() {
 
-		return $this->get( 'wl_general_settings', self::KEY, '' );
+		return $this->get('wl_general_settings', self::KEY, '');
 	}
 
 	/**
@@ -302,9 +302,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	public function set_key( $value ) {
+	public function set_key($value) {
 
-		$this->set( 'wl_general_settings', self::KEY, $value );
+		$this->set('wl_general_settings', self::KEY, $value);
 	}
 
 	/**
@@ -318,11 +318,11 @@ 
 	public function get_language_code() {
 
 		$language = get_locale();
-		if ( ! $language ) {
+		if ( ! $language) {
 			return 'en';
 		}
 
-		return substr( $language, 0, 2 );
+		return substr($language, 0, 2);
 	}
 
 	/**
@@ -337,9 +337,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	public function set_language_code( $value ) {
+	public function set_language_code($value) {
 
-		$this->set( 'wl_general_settings', self::LANGUAGE, $value );
+		$this->set('wl_general_settings', self::LANGUAGE, $value);
 
 	}
 
@@ -350,9 +350,9 @@ 
 	 *
 	 * @since 3.19.0
 	 */
-	public function set_diagnostic_preferences( $value ) {
+	public function set_diagnostic_preferences($value) {
 
-		$this->set( 'wl_general_settings', self::SEND_DIAGNOSTIC, $value );
+		$this->set('wl_general_settings', self::SEND_DIAGNOSTIC, $value);
 
 	}
 
@@ -363,7 +363,7 @@ 
 	 */
 	public function get_diagnostic_preferences() {
 
-		return $this->get( 'wl_general_settings', self::SEND_DIAGNOSTIC, 'no' );
+		return $this->get('wl_general_settings', self::SEND_DIAGNOSTIC, 'no');
 	}
 
 	/**
@@ -374,7 +374,7 @@ 
 	 */
 	public function get_country_code() {
 
-		return $this->get( 'wl_general_settings', self::COUNTRY_CODE, 'us' );
+		return $this->get('wl_general_settings', self::COUNTRY_CODE, 'us');
 	}
 
 	/**
@@ -384,9 +384,9 @@ 
 	 *
 	 * @since 3.18.0
 	 */
-	public function set_country_code( $value ) {
+	public function set_country_code($value) {
 
-		$this->set( 'wl_general_settings', self::COUNTRY_CODE, $value );
+		$this->set('wl_general_settings', self::COUNTRY_CODE, $value);
 
 	}
 
@@ -399,7 +399,7 @@ 
 	 * @since 3.38.6
 	 */
 	public function get_alternate_name() {
-		return $this->get( 'wl_general_settings', self::ALTERNATE_NAME );
+		return $this->get('wl_general_settings', self::ALTERNATE_NAME);
 	}
 
 	/**
@@ -409,9 +409,9 @@ 
 	 *
 	 * @since 3.38.6
 	 */
-	public function set_alternate_name( $value ) {
+	public function set_alternate_name($value) {
 
-		$this->set( 'wl_general_settings', self::ALTERNATE_NAME, wp_strip_all_tags( $value ) );
+		$this->set('wl_general_settings', self::ALTERNATE_NAME, wp_strip_all_tags($value));
 
 	}
 
@@ -426,7 +426,7 @@ 
 	 */
 	public function get_publisher_id() {
 
-		return $this->get( 'wl_general_settings', self::PUBLISHER_ID, null );
+		return $this->get('wl_general_settings', self::PUBLISHER_ID, null);
 	}
 
 	/**
@@ -436,9 +436,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	public function set_publisher_id( $value ) {
+	public function set_publisher_id($value) {
 
-		$this->set( 'wl_general_settings', self::PUBLISHER_ID, $value );
+		$this->set('wl_general_settings', self::PUBLISHER_ID, $value);
 
 	}
 
@@ -451,8 +451,8 @@ 
 	 */
 	public function get_dataset_uri() {
 
-		if ( apply_filters( 'wl_feature__enable__dataset', true ) ) {
-			return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
+		if (apply_filters('wl_feature__enable__dataset', true)) {
+			return $this->get('wl_advanced_settings', self::DATASET_URI, null);
 		} else {
 			return null;
 		}
@@ -465,9 +465,9 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	public function set_dataset_uri( $value ) {
+	public function set_dataset_uri($value) {
 
-		$this->set( 'wl_advanced_settings', self::DATASET_URI, $value );
+		$this->set('wl_advanced_settings', self::DATASET_URI, $value);
 	}
 
 	/**
@@ -478,7 +478,7 @@ 
 	 */
 	public function get_package_type() {
 
-		return $this->get( 'wl_advanced_settings', self::PACKAGE_TYPE, null );
+		return $this->get('wl_advanced_settings', self::PACKAGE_TYPE, null);
 	}
 
 	/**
@@ -488,8 +488,8 @@ 
 	 *
 	 * @since 3.20.0
 	 */
-	public function set_package_type( $value ) {
-		$this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
+	public function set_package_type($value) {
+		$this->set('wl_advanced_settings', self::PACKAGE_TYPE, $value);
 	}
 
 	/**
@@ -504,11 +504,11 @@ 
 	 * @param array $old_value The old settings.
 	 * @param array $new_value The new settings.
 	 */
-	public function update_key( $old_value, $new_value ) {
+	public function update_key($old_value, $new_value) {
 
 		// Check the old key value and the new one. We're going to ask for the dataset URI only if the key has changed.
 		// $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $new_value['key'] ) ? trim( $new_value['key'] ) : '';
+		$new_key = isset($new_value['key']) ? trim($new_value['key']) : '';
 
 		// If the key hasn't changed, don't do anything.
 		// WARN The 'update_option' hook is fired only if the new and old value are not equal.
@@ -517,14 +517,14 @@ 
 		// }
 
 		// If the key is empty, empty the dataset URI.
-		if ( '' === $new_key ) {
-			$this->set_dataset_uri( '' );
+		if ('' === $new_key) {
+			$this->set_dataset_uri('');
 		}
 
 		// make the request to the remote server.
-		$this->get_remote_dataset_uri( $new_key );
+		$this->get_remote_dataset_uri($new_key);
 
-		do_action( 'wl_key_updated' );
+		do_action('wl_key_updated');
 
 	}
 
@@ -540,15 +540,15 @@ 
 	 *
 	 * @since 3.17.0 send the site URL and get the dataset URI.
 	 */
-	public function get_remote_dataset_uri( $key ) {
+	public function get_remote_dataset_uri($key) {
 
-		$this->log->trace( 'Getting the remote dataset URI and package type...' );
+		$this->log->trace('Getting the remote dataset URI and package type...');
 
-		if ( empty( $key ) ) {
-			$this->log->warn( 'Key set to empty value.' );
+		if (empty($key)) {
+			$this->log->warn('Key set to empty value.');
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+			$this->set_dataset_uri('');
+			$this->set_package_type(null);
 
 			return;
 		}
@@ -562,15 +562,15 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+		$home_url = get_option('home');
+		$site_url = apply_filters('wl_production_site_url', untrailingslashit($home_url));
 
 		// Build the URL.
 		$url = '/accounts'
-			   . '?key=' . rawurlencode( $key )
-			   . '&url=' . rawurlencode( $site_url )
-			   . '&country=' . $this->get_country_code()
-			   . '&language=' . $this->get_language_code();
+			   . '?key='.rawurlencode($key)
+			   . '&url='.rawurlencode($site_url)
+			   . '&country='.$this->get_country_code()
+			   . '&language='.$this->get_language_code();
 
 		$api_service = Default_Api_Service::get_instance();
 		/**
@@ -580,32 +580,32 @@ 
 		$headers  = array(
 			'Authorization' => "Key $key",
 		);
-		$response = $api_service->request( 'PUT', $url, $headers )->get_response();
+		$response = $api_service->request('PUT', $url, $headers)->get_response();
 
 		// The response is an error.
-		if ( is_wp_error( $response ) ) {
-			$this->log->error( 'An error occurred setting the dataset URI: ' . $response->get_error_message() );
+		if (is_wp_error($response)) {
+			$this->log->error('An error occurred setting the dataset URI: '.$response->get_error_message());
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+			$this->set_dataset_uri('');
+			$this->set_package_type(null);
 
 			return;
 		}
 
 		// The response is not OK.
-		if ( ! is_array( $response ) || 200 !== (int) $response['response']['code'] ) {
+		if ( ! is_array($response) || 200 !== (int) $response['response']['code']) {
 			$base_url = $api_service->get_base_url();
 
-			if ( ! is_array( $response ) ) {
+			if ( ! is_array($response)) {
 				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
+				$this->log->error("Unexpected response when opening URL $base_url$url: ".var_export($response, true));
 			} else {
 				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected status code when opening URL $base_url$url: " . $response['response']['code'] . "\n" . var_export( $response, true ) );
+				$this->log->error("Unexpected status code when opening URL $base_url$url: ".$response['response']['code']."\n".var_export($response, true));
 			}
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+			$this->set_dataset_uri('');
+			$this->set_package_type(null);
 
 			return;
 		}
@@ -615,20 +615,20 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$json = json_decode( $response['body'] );
+		$json = json_decode($response['body']);
 		/**
 		 * @since 3.27.7
 		 * Remove the trailing slash returned from the new platform api.
 		 */
 		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$dataset_uri = untrailingslashit( $json->datasetURI );
+		$dataset_uri = untrailingslashit($json->datasetURI);
 		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$package_type = isset( $json->packageType ) ? $json->packageType : null;
+		$package_type = isset($json->packageType) ? $json->packageType : null;
 
-		$this->log->info( "Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]..." );
+		$this->log->info("Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]...");
 
-		$this->set_dataset_uri( $dataset_uri );
-		$this->set_package_type( $package_type );
+		$this->set_dataset_uri($dataset_uri);
+		$this->set_package_type($package_type);
 	}
 
 	/**
@@ -645,20 +645,20 @@ 
 	 * @return mixed The same value in the $value parameter
 	 * @since 3.12.0
 	 */
-	public function maybe_update_dataset_uri( $value, $old_value ) {
+	public function maybe_update_dataset_uri($value, $old_value) {
 
 		// Check the old key value and the new one. Here we're only handling the
 		// case where the key hasn't changed and the dataset URI isn't set. The
 		// other case, i.e. a new key is inserted, is handled at `update_key`.
-		$old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $value['key'] ) ? trim( $value['key'] ) : '';
+		$old_key = isset($old_value['key']) ? $old_value['key'] : '';
+		$new_key = isset($value['key']) ? trim($value['key']) : '';
 
 		$dataset_uri = $this->get_dataset_uri();
 
-		if ( ! empty( $new_key ) && $new_key === $old_key && empty( $dataset_uri ) ) {
+		if ( ! empty($new_key) && $new_key === $old_key && empty($dataset_uri)) {
 
 			// make the request to the remote server to try to get the dataset uri.
-			$this->get_remote_dataset_uri( $new_key );
+			$this->get_remote_dataset_uri($new_key);
 		}
 
 		return $value;
@@ -672,9 +672,9 @@ 
 	 * @return string The API URI.
 	 * @since 3.11.0
 	 */
-	public function get_accounts_by_key_dataset_uri( $key ) {
+	public function get_accounts_by_key_dataset_uri($key) {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/key=$key/dataset_uri";
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE."accounts/key=$key/dataset_uri";
 	}
 
 	/**
@@ -685,7 +685,7 @@ 
 	 */
 	public function get_accounts() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'accounts';
 	}
 
 	/**
@@ -696,7 +696,7 @@ 
 	 */
 	public function is_link_by_default() {
 
-		return 'yes' === $this->get( 'wl_general_settings', self::LINK_BY_DEFAULT, 'yes' );
+		return 'yes' === $this->get('wl_general_settings', self::LINK_BY_DEFAULT, 'yes');
 	}
 
 	/**
@@ -706,9 +706,9 @@ 
 	 *
 	 * @since 3.13.0
 	 */
-	public function set_link_by_default( $value ) {
+	public function set_link_by_default($value) {
 
-		$this->set( 'wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no' );
+		$this->set('wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no');
 	}
 
 	/**
@@ -718,7 +718,7 @@ 
 	 * @since 3.21.0
 	 */
 	public function is_analytics_enable() {
-		return 'yes' === $this->get( 'wl_analytics_settings', self::ANALYTICS_ENABLE, 'no' );
+		return 'yes' === $this->get('wl_analytics_settings', self::ANALYTICS_ENABLE, 'no');
 	}
 
 	/**
@@ -728,9 +728,9 @@ 
 	 *
 	 * @since 3.21.0
 	 */
-	public function set_is_analytics_enable( $value ) {
+	public function set_is_analytics_enable($value) {
 
-		$this->set( 'wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no' );
+		$this->set('wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no');
 	}
 
 	/**
@@ -740,7 +740,7 @@ 
 	 * @since 3.21.0
 	 */
 	public function get_analytics_entity_uri_dimension() {
-		return (int) $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1 );
+		return (int) $this->get('wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1);
 	}
 
 	/**
@@ -750,7 +750,7 @@ 
 	 * @since 3.21.0
 	 */
 	public function get_analytics_entity_type_dimension() {
-		return $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2 );
+		return $this->get('wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2);
 	}
 
 	/**
@@ -761,7 +761,7 @@ 
 	 */
 	public function get_autocomplete_url() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'autocomplete';
 
 	}
 
@@ -773,7 +773,7 @@ 
 	 */
 	public function get_deactivation_feedback_url() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'feedbacks';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'feedbacks';
 
 	}
 
@@ -789,21 +789,21 @@ 
 	}
 
 	public function get_network_dataset_ids() {
-		return $this->get( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, array() );
+		return $this->get('wl_advanced_settings', self::NETWORK_DATASET_IDS, array());
 	}
 
-	public function set_network_dataset_ids( $network_dataset_ids ) {
-		$this->set( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, $network_dataset_ids );
+	public function set_network_dataset_ids($network_dataset_ids) {
+		$this->set('wl_advanced_settings', self::NETWORK_DATASET_IDS, $network_dataset_ids);
 	}
 
 	public function get_skip_installation_notice() {
 
-		return $this->get( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, false );
+		return $this->get('wl_general_settings', self::SKIP_INSTALLATION_NOTICE, false);
 	}
 
-	public function set_skip_installation_notice( $value ) {
+	public function set_skip_installation_notice($value) {
 
-		$this->set( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, $value );
+		$this->set('wl_general_settings', self::SKIP_INSTALLATION_NOTICE, $value);
 
 	}
 
@@ -813,16 +813,16 @@ 
 	 * @return false|string
 	 */
 	public function get_override_website_url() {
-		$value = $this->get( 'wl_general_settings', self::OVERRIDE_WEBSITE_URL, false );
-		if ( empty( $value ) ) {
+		$value = $this->get('wl_general_settings', self::OVERRIDE_WEBSITE_URL, false);
+		if (empty($value)) {
 			return false;
 		}
 
-		return untrailingslashit( $value );
+		return untrailingslashit($value);
 	}
 
-	public function set_override_website_url( $value ) {
-		$this->set( 'wl_general_settings', self::OVERRIDE_WEBSITE_URL, $value );
+	public function set_override_website_url($value) {
+		$this->set('wl_general_settings', self::OVERRIDE_WEBSITE_URL, $value);
 	}
 
 }

src/includes/class-wordlift-entity-uri-service.php

Indentation +249 added lines, -249 removed lines

@@ -20,100 +20,100 @@ 
  */
 class Wordlift_Entity_Uri_Service {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * An array of URIs to post ID valid for the current request.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var array $uri_to_post An array of URIs to post ID valid for the current request.
-	 */
-	protected $uri_to_post;
-
-	/**
-	 * Create a {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since 3.16.3
-	 */
-	protected function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		// Add a filter to the `rest_post_dispatch` filter to add the wl_entity_url meta as `wl:entity_url`.
-		add_filter( 'rest_post_dispatch', array( $this, 'rest_post_dispatch' ) );
-		add_filter( 'wl_content_service__post__not_found', array( $this, 'content_service__post__not_found' ), 10, 2 );
-
-	}
-
-	/**
-	 * Holds the {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since 3.21.5
-	 * @access private
-	 * @var Wordlift_Entity_Uri_Service $instance The {@link Wordlift_Entity_Uri_Service} singleton.
-	 */
-	private static $instance = null;
-
-	/**
-	 * Get the singleton.
-	 *
-	 * @return Wordlift_Entity_Uri_Service The singleton instance.
-	 * @since 3.21.5
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			$entity_uri_cache_service = new Wordlift_File_Cache_Service( WL_TEMP_DIR . 'entity_uri/' );
-			self::$instance           = new Wordlift_Cached_Entity_Uri_Service( $entity_uri_cache_service );
-
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Try to find a post when the content service doesn't find it.
-	 *
-	 * @param WP_Post|null $post
-	 * @param string       $uri
-	 *
-	 * @return false|int
-	 */
-	public function content_service__post__not_found( $post, $uri ) {
-		return $this->get_post_id_from_url( $uri );
-	}
-
-	/**
-	 * Preload the provided URIs in the local cache.
-	 *
-	 * This function will populate the local `$uri_to_post` array by running a
-	 * single query with all the URIs and returning the mappings in the array.
-	 *
-	 * @param array $uris An array of URIs.
-	 *
-	 * @since 3.16.3
-	 */
-	public function preload_uris( $uris ) {
-
-		// Bail out if there are no URIs.
-		if ( 0 === count( $uris ) ) {
-			return;
-		}
-
-		$this->log->trace( 'Preloading ' . count( $uris ) . ' URI(s)...' );
-
-		global $wpdb;
-		$in_post_types  = implode( "','", array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() ) );
-		$in_entity_uris = implode( "','", array_map( 'esc_sql', $uris ) );
-		$sql            = "
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * An array of URIs to post ID valid for the current request.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var array $uri_to_post An array of URIs to post ID valid for the current request.
+     */
+    protected $uri_to_post;
+
+    /**
+     * Create a {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since 3.16.3
+     */
+    protected function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        // Add a filter to the `rest_post_dispatch` filter to add the wl_entity_url meta as `wl:entity_url`.
+        add_filter( 'rest_post_dispatch', array( $this, 'rest_post_dispatch' ) );
+        add_filter( 'wl_content_service__post__not_found', array( $this, 'content_service__post__not_found' ), 10, 2 );
+
+    }
+
+    /**
+     * Holds the {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since 3.21.5
+     * @access private
+     * @var Wordlift_Entity_Uri_Service $instance The {@link Wordlift_Entity_Uri_Service} singleton.
+     */
+    private static $instance = null;
+
+    /**
+     * Get the singleton.
+     *
+     * @return Wordlift_Entity_Uri_Service The singleton instance.
+     * @since 3.21.5
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            $entity_uri_cache_service = new Wordlift_File_Cache_Service( WL_TEMP_DIR . 'entity_uri/' );
+            self::$instance           = new Wordlift_Cached_Entity_Uri_Service( $entity_uri_cache_service );
+
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Try to find a post when the content service doesn't find it.
+     *
+     * @param WP_Post|null $post
+     * @param string       $uri
+     *
+     * @return false|int
+     */
+    public function content_service__post__not_found( $post, $uri ) {
+        return $this->get_post_id_from_url( $uri );
+    }
+
+    /**
+     * Preload the provided URIs in the local cache.
+     *
+     * This function will populate the local `$uri_to_post` array by running a
+     * single query with all the URIs and returning the mappings in the array.
+     *
+     * @param array $uris An array of URIs.
+     *
+     * @since 3.16.3
+     */
+    public function preload_uris( $uris ) {
+
+        // Bail out if there are no URIs.
+        if ( 0 === count( $uris ) ) {
+            return;
+        }
+
+        $this->log->trace( 'Preloading ' . count( $uris ) . ' URI(s)...' );
+
+        global $wpdb;
+        $in_post_types  = implode( "','", array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() ) );
+        $in_entity_uris = implode( "','", array_map( 'esc_sql', $uris ) );
+        $sql            = "
 			SELECT ID FROM $wpdb->posts p
 			INNER JOIN $wpdb->postmeta pm
 			 ON pm.post_id = p.ID
@@ -123,160 +123,160 @@ 
 			  AND p.post_status IN ( 'publish', 'draft', 'private', 'future' )
   		";
 
-		// Get the posts.
-		$posts = $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-
-		// Populate the array. We reinitialize the array on purpose because
-		// we don't want these data to long live.
-		$this->uri_to_post = array_reduce(
-			$posts,
-			function ( $carry, $item ) {
-				$uris = get_post_meta( $item, Wordlift_Schema_Service::FIELD_SAME_AS );
-
-				$uri = Wordpress_Content_Service::get_instance()
-												->get_entity_id( Wordpress_Content_Id::create_post( $item ) );
-
-				if ( isset( $uri ) ) {
-					$uris[] = $uri;
-				}
-
-				return $carry
-					   // Get the URI related to the post and fill them with the item id.
-					   + array_fill_keys( $uris, $item );
-			},
-			array()
-		);
-
-		// Add the not found URIs.
-		$this->uri_to_post += array_fill_keys( $uris, null );
-
-		$this->log->debug( count( $this->uri_to_post ) . ' URI(s) preloaded.' );
-
-	}
-
-	/**
-	 * Reset the URI to post local cache.
-	 *
-	 * @since 3.16.3
-	 */
-	public function reset_uris() {
-
-		$this->uri_to_post = array();
-
-	}
-
-	/**
-	 * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
-	 *
-	 * @param string $uri The entity URI.
-	 *
-	 * @return WP_Post|null A WP_Post instance or null if not found.
-	 * @since 3.2.0
-	 */
-	public function get_entity( $uri ) {
-		if ( ! isset( $uri ) ) {
-			return null;
-		}
-
-		$this->log->trace( "Getting an entity post for URI $uri..." );
-
-		$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
-
-		// Return null if the content isn't found or isn't a post.
-		if ( ! isset( $content ) || ! is_a( $content->get_bag(), '\WP_Post' ) ) {
-			return null;
-		}
-
-		return $content->get_bag();
-	}
-
-	/**
-	 * Determines whether a given uri is an internal uri or not.
-	 *
-	 * @param string $uri An uri.
-	 *
-	 * @return true if the uri internal to the current dataset otherwise false.
-	 * @since 3.16.3
-	 */
-	public function is_internal( $uri ) {
-
-		return ( 0 === strrpos( $uri, (string) Wordlift_Configuration_Service::get_instance()->get_dataset_uri() ) );
-	}
-
-	/**
-	 * Hook to `rest_post_dispatch` to alter the response and add the `wl_entity_url` post meta as `wl:entity_url`.
-	 *
-	 * We're using this filter instead of the well known `register_meta` / `register_rest_field` because we still need
-	 * to provide full compatibility with WordPress 4.4+.
-	 *
-	 * @param WP_HTTP_Response $result Result to send to the client. Usually a WP_REST_Response.
-	 *
-	 * @return WP_HTTP_Response The result to send to the client.
-	 *
-	 * @since 3.23.0
-	 */
-	public function rest_post_dispatch( $result ) {
-
-		// Get a reference to the actual data.
-		$data = &$result->data;
-
-		// Bail out if we don't have the required parameters, or if the type is not a valid entity.
-		if ( ! is_array( $data ) || ! isset( $data['id'] ) || ! isset( $data['type'] )
-			 || ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $data['type'] ) ) {
-			return $result;
-		}
-
-		// Add the `wl:entity_url`.
-		$data['wl:entity_url'] = Wordlift_Entity_Service::get_instance()->get_uri( $data['id'] );
-
-		return $result;
-	}
-
-	/**
-	 * Helper function to fetch post_id from a WordPress URL
-	 * Primarily used when dataset is not enabled
-	 *
-	 * @param $url
-	 *
-	 * @return int Post ID | bool false
-	 */
-	public function get_post_id_from_url( $url ) {
-		global $wp_rewrite;
-
-		// We need to check that rewrite is available because the `url_to_postid` uses it and can raise an exception
-		// otherwise.
-		if ( $wp_rewrite === null ) {
-			return false;
-		}
-
-		// Try url_to_postid
-		$post_id = url_to_postid( htmlspecialchars_decode( $url ) );
-		if ( 0 !== $post_id ) {
-			return $post_id;
-		}
-
-		$parsed_url = wp_parse_url( $url );
-
-		if ( ! isset( $parsed_url['query'] ) ) {
-			return false;
-		}
-
-		parse_str( $parsed_url['query'], $parsed_query );
-
-		// Try to parse WooCommerce non-pretty product URL
-		if ( $parsed_query['product'] ) {
-			$posts = get_posts(
-				array(
-					'name'      => $parsed_query['product'],
-					'post_type' => 'product',
-				)
-			);
-			if ( count( $posts ) > 0 ) {
-				return $posts[0]->ID;
-			}
-		}
-
-		return false;
-	}
+        // Get the posts.
+        $posts = $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+
+        // Populate the array. We reinitialize the array on purpose because
+        // we don't want these data to long live.
+        $this->uri_to_post = array_reduce(
+            $posts,
+            function ( $carry, $item ) {
+                $uris = get_post_meta( $item, Wordlift_Schema_Service::FIELD_SAME_AS );
+
+                $uri = Wordpress_Content_Service::get_instance()
+                                                ->get_entity_id( Wordpress_Content_Id::create_post( $item ) );
+
+                if ( isset( $uri ) ) {
+                    $uris[] = $uri;
+                }
+
+                return $carry
+                        // Get the URI related to the post and fill them with the item id.
+                       + array_fill_keys( $uris, $item );
+            },
+            array()
+        );
+
+        // Add the not found URIs.
+        $this->uri_to_post += array_fill_keys( $uris, null );
+
+        $this->log->debug( count( $this->uri_to_post ) . ' URI(s) preloaded.' );
+
+    }
+
+    /**
+     * Reset the URI to post local cache.
+     *
+     * @since 3.16.3
+     */
+    public function reset_uris() {
+
+        $this->uri_to_post = array();
+
+    }
+
+    /**
+     * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
+     *
+     * @param string $uri The entity URI.
+     *
+     * @return WP_Post|null A WP_Post instance or null if not found.
+     * @since 3.2.0
+     */
+    public function get_entity( $uri ) {
+        if ( ! isset( $uri ) ) {
+            return null;
+        }
+
+        $this->log->trace( "Getting an entity post for URI $uri..." );
+
+        $content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
+
+        // Return null if the content isn't found or isn't a post.
+        if ( ! isset( $content ) || ! is_a( $content->get_bag(), '\WP_Post' ) ) {
+            return null;
+        }
+
+        return $content->get_bag();
+    }
+
+    /**
+     * Determines whether a given uri is an internal uri or not.
+     *
+     * @param string $uri An uri.
+     *
+     * @return true if the uri internal to the current dataset otherwise false.
+     * @since 3.16.3
+     */
+    public function is_internal( $uri ) {
+
+        return ( 0 === strrpos( $uri, (string) Wordlift_Configuration_Service::get_instance()->get_dataset_uri() ) );
+    }
+
+    /**
+     * Hook to `rest_post_dispatch` to alter the response and add the `wl_entity_url` post meta as `wl:entity_url`.
+     *
+     * We're using this filter instead of the well known `register_meta` / `register_rest_field` because we still need
+     * to provide full compatibility with WordPress 4.4+.
+     *
+     * @param WP_HTTP_Response $result Result to send to the client. Usually a WP_REST_Response.
+     *
+     * @return WP_HTTP_Response The result to send to the client.
+     *
+     * @since 3.23.0
+     */
+    public function rest_post_dispatch( $result ) {
+
+        // Get a reference to the actual data.
+        $data = &$result->data;
+
+        // Bail out if we don't have the required parameters, or if the type is not a valid entity.
+        if ( ! is_array( $data ) || ! isset( $data['id'] ) || ! isset( $data['type'] )
+             || ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $data['type'] ) ) {
+            return $result;
+        }
+
+        // Add the `wl:entity_url`.
+        $data['wl:entity_url'] = Wordlift_Entity_Service::get_instance()->get_uri( $data['id'] );
+
+        return $result;
+    }
+
+    /**
+     * Helper function to fetch post_id from a WordPress URL
+     * Primarily used when dataset is not enabled
+     *
+     * @param $url
+     *
+     * @return int Post ID | bool false
+     */
+    public function get_post_id_from_url( $url ) {
+        global $wp_rewrite;
+
+        // We need to check that rewrite is available because the `url_to_postid` uses it and can raise an exception
+        // otherwise.
+        if ( $wp_rewrite === null ) {
+            return false;
+        }
+
+        // Try url_to_postid
+        $post_id = url_to_postid( htmlspecialchars_decode( $url ) );
+        if ( 0 !== $post_id ) {
+            return $post_id;
+        }
+
+        $parsed_url = wp_parse_url( $url );
+
+        if ( ! isset( $parsed_url['query'] ) ) {
+            return false;
+        }
+
+        parse_str( $parsed_url['query'], $parsed_query );
+
+        // Try to parse WooCommerce non-pretty product URL
+        if ( $parsed_query['product'] ) {
+            $posts = get_posts(
+                array(
+                    'name'      => $parsed_query['product'],
+                    'post_type' => 'product',
+                )
+            );
+            if ( count( $posts ) > 0 ) {
+                return $posts[0]->ID;
+            }
+        }
+
+        return false;
+    }
 
 }

Spacing +41 added lines, -41 removed lines

@@ -45,11 +45,11 @@ 
 	 */
 	protected function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		// Add a filter to the `rest_post_dispatch` filter to add the wl_entity_url meta as `wl:entity_url`.
-		add_filter( 'rest_post_dispatch', array( $this, 'rest_post_dispatch' ) );
-		add_filter( 'wl_content_service__post__not_found', array( $this, 'content_service__post__not_found' ), 10, 2 );
+		add_filter('rest_post_dispatch', array($this, 'rest_post_dispatch'));
+		add_filter('wl_content_service__post__not_found', array($this, 'content_service__post__not_found'), 10, 2);
 
 	}
 
@@ -70,9 +70,9 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
-			$entity_uri_cache_service = new Wordlift_File_Cache_Service( WL_TEMP_DIR . 'entity_uri/' );
-			self::$instance           = new Wordlift_Cached_Entity_Uri_Service( $entity_uri_cache_service );
+		if ( ! isset(self::$instance)) {
+			$entity_uri_cache_service = new Wordlift_File_Cache_Service(WL_TEMP_DIR.'entity_uri/');
+			self::$instance           = new Wordlift_Cached_Entity_Uri_Service($entity_uri_cache_service);
 
 		}
 
@@ -87,8 +87,8 @@ 
 	 *
 	 * @return false|int
 	 */
-	public function content_service__post__not_found( $post, $uri ) {
-		return $this->get_post_id_from_url( $uri );
+	public function content_service__post__not_found($post, $uri) {
+		return $this->get_post_id_from_url($uri);
 	}
 
 	/**
@@ -101,18 +101,18 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function preload_uris( $uris ) {
+	public function preload_uris($uris) {
 
 		// Bail out if there are no URIs.
-		if ( 0 === count( $uris ) ) {
+		if (0 === count($uris)) {
 			return;
 		}
 
-		$this->log->trace( 'Preloading ' . count( $uris ) . ' URI(s)...' );
+		$this->log->trace('Preloading '.count($uris).' URI(s)...');
 
 		global $wpdb;
-		$in_post_types  = implode( "','", array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() ) );
-		$in_entity_uris = implode( "','", array_map( 'esc_sql', $uris ) );
+		$in_post_types  = implode("','", array_map('esc_sql', Wordlift_Entity_Service::valid_entity_post_types()));
+		$in_entity_uris = implode("','", array_map('esc_sql', $uris));
 		$sql            = "
 			SELECT ID FROM $wpdb->posts p
 			INNER JOIN $wpdb->postmeta pm
@@ -124,33 +124,33 @@ 
   		";
 
 		// Get the posts.
-		$posts = $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+		$posts = $wpdb->get_col($sql); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 
 		// Populate the array. We reinitialize the array on purpose because
 		// we don't want these data to long live.
 		$this->uri_to_post = array_reduce(
 			$posts,
-			function ( $carry, $item ) {
-				$uris = get_post_meta( $item, Wordlift_Schema_Service::FIELD_SAME_AS );
+			function($carry, $item) {
+				$uris = get_post_meta($item, Wordlift_Schema_Service::FIELD_SAME_AS);
 
 				$uri = Wordpress_Content_Service::get_instance()
-												->get_entity_id( Wordpress_Content_Id::create_post( $item ) );
+												->get_entity_id(Wordpress_Content_Id::create_post($item));
 
-				if ( isset( $uri ) ) {
+				if (isset($uri)) {
 					$uris[] = $uri;
 				}
 
 				return $carry
 					   // Get the URI related to the post and fill them with the item id.
-					   + array_fill_keys( $uris, $item );
+					   + array_fill_keys($uris, $item);
 			},
 			array()
 		);
 
 		// Add the not found URIs.
-		$this->uri_to_post += array_fill_keys( $uris, null );
+		$this->uri_to_post += array_fill_keys($uris, null);
 
-		$this->log->debug( count( $this->uri_to_post ) . ' URI(s) preloaded.' );
+		$this->log->debug(count($this->uri_to_post).' URI(s) preloaded.');
 
 	}
 
@@ -173,17 +173,17 @@ 
 	 * @return WP_Post|null A WP_Post instance or null if not found.
 	 * @since 3.2.0
 	 */
-	public function get_entity( $uri ) {
-		if ( ! isset( $uri ) ) {
+	public function get_entity($uri) {
+		if ( ! isset($uri)) {
 			return null;
 		}
 
-		$this->log->trace( "Getting an entity post for URI $uri..." );
+		$this->log->trace("Getting an entity post for URI $uri...");
 
-		$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
+		$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as($uri);
 
 		// Return null if the content isn't found or isn't a post.
-		if ( ! isset( $content ) || ! is_a( $content->get_bag(), '\WP_Post' ) ) {
+		if ( ! isset($content) || ! is_a($content->get_bag(), '\WP_Post')) {
 			return null;
 		}
 
@@ -198,9 +198,9 @@ 
 	 * @return true if the uri internal to the current dataset otherwise false.
 	 * @since 3.16.3
 	 */
-	public function is_internal( $uri ) {
+	public function is_internal($uri) {
 
-		return ( 0 === strrpos( $uri, (string) Wordlift_Configuration_Service::get_instance()->get_dataset_uri() ) );
+		return (0 === strrpos($uri, (string) Wordlift_Configuration_Service::get_instance()->get_dataset_uri()));
 	}
 
 	/**
@@ -215,19 +215,19 @@ 
 	 *
 	 * @since 3.23.0
 	 */
-	public function rest_post_dispatch( $result ) {
+	public function rest_post_dispatch($result) {
 
 		// Get a reference to the actual data.
 		$data = &$result->data;
 
 		// Bail out if we don't have the required parameters, or if the type is not a valid entity.
-		if ( ! is_array( $data ) || ! isset( $data['id'] ) || ! isset( $data['type'] )
-			 || ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $data['type'] ) ) {
+		if ( ! is_array($data) || ! isset($data['id']) || ! isset($data['type'])
+			 || ! Wordlift_Entity_Type_Service::is_valid_entity_post_type($data['type'])) {
 			return $result;
 		}
 
 		// Add the `wl:entity_url`.
-		$data['wl:entity_url'] = Wordlift_Entity_Service::get_instance()->get_uri( $data['id'] );
+		$data['wl:entity_url'] = Wordlift_Entity_Service::get_instance()->get_uri($data['id']);
 
 		return $result;
 	}
@@ -240,38 +240,38 @@ 
 	 *
 	 * @return int Post ID | bool false
 	 */
-	public function get_post_id_from_url( $url ) {
+	public function get_post_id_from_url($url) {
 		global $wp_rewrite;
 
 		// We need to check that rewrite is available because the `url_to_postid` uses it and can raise an exception
 		// otherwise.
-		if ( $wp_rewrite === null ) {
+		if ($wp_rewrite === null) {
 			return false;
 		}
 
 		// Try url_to_postid
-		$post_id = url_to_postid( htmlspecialchars_decode( $url ) );
-		if ( 0 !== $post_id ) {
+		$post_id = url_to_postid(htmlspecialchars_decode($url));
+		if (0 !== $post_id) {
 			return $post_id;
 		}
 
-		$parsed_url = wp_parse_url( $url );
+		$parsed_url = wp_parse_url($url);
 
-		if ( ! isset( $parsed_url['query'] ) ) {
+		if ( ! isset($parsed_url['query'])) {
 			return false;
 		}
 
-		parse_str( $parsed_url['query'], $parsed_query );
+		parse_str($parsed_url['query'], $parsed_query);
 
 		// Try to parse WooCommerce non-pretty product URL
-		if ( $parsed_query['product'] ) {
+		if ($parsed_query['product']) {
 			$posts = get_posts(
 				array(
 					'name'      => $parsed_query['product'],
 					'post_type' => 'product',
 				)
 			);
-			if ( count( $posts ) > 0 ) {
+			if (count($posts) > 0) {
 				return $posts[0]->ID;
 			}
 		}

src/admin/elements/class-wordlift-admin-input-element.php

Indentation +68 added lines, -68 removed lines

@@ -18,95 +18,95 @@
  */
 class Wordlift_Admin_Input_Element implements Wordlift_Admin_Element {
 
-	/**
-	 * Output the HTML for an input box type settings_page
-	 *
-	 * @param array $args An array with the following keys:
-	 *                    Parameters controlling the result.
-	 *
-	 * @type string name The name attribute of the input element. Mandatory.
-	 *
-	 * @type string id    The id attribute of the input element. Optional.
-	 * @type string id    The id attribute of the input element.
-	 *                            Optional, randomly generated one is used if not supplied.
-	 * @type string value    The value of the input element.
-	 *                            Optional, defaults to empty string.
-	 * @type bool readonly    Indicates whether the input is read only.
-	 *                            Optional, defaults to read-write
-	 * @type string css_class    The class attribute for the input element.
-	 *                            If empty string no class attribute will be added.
-	 *                            Optional, defaults to empty string.
-	 * @type string description    The descriptio text to be displayed below the element.
-	 *                            Can include some HTML element.
-	 *                            If empty string no description will be displayed.
-	 *                            Optional, defaults to empty string.
-	 * @return $this|Wordlift_Admin_Element
-	 * @since 3.21.0 added the ability to use a $type arg.
-	 */
-	public function render( $args ) {
+    /**
+     * Output the HTML for an input box type settings_page
+     *
+     * @param array $args An array with the following keys:
+     *                    Parameters controlling the result.
+     *
+     * @type string name The name attribute of the input element. Mandatory.
+     *
+     * @type string id    The id attribute of the input element. Optional.
+     * @type string id    The id attribute of the input element.
+     *                            Optional, randomly generated one is used if not supplied.
+     * @type string value    The value of the input element.
+     *                            Optional, defaults to empty string.
+     * @type bool readonly    Indicates whether the input is read only.
+     *                            Optional, defaults to read-write
+     * @type string css_class    The class attribute for the input element.
+     *                            If empty string no class attribute will be added.
+     *                            Optional, defaults to empty string.
+     * @type string description    The descriptio text to be displayed below the element.
+     *                            Can include some HTML element.
+     *                            If empty string no description will be displayed.
+     *                            Optional, defaults to empty string.
+     * @return $this|Wordlift_Admin_Element
+     * @since 3.21.0 added the ability to use a $type arg.
+     */
+    public function render( $args ) {
 
-		/*
+        /*
 		 * Parse the arguments and merge with default values.
 		 * Name intentionally do not have a default as it has to be in SyncEvent
 		 * with form handling code
 		 */
-		$pre_params = wp_parse_args(
-			$args,
-			array(
-				'id'          => uniqid( 'wl-input-' ),
-				'value'       => '',
-				'readonly'    => false,
-				'css_class'   => '',
-				'description' => '',
-				'pattern'     => false,
-				'placeholder' => false,
-			)
-		);
-		$params     = apply_filters( 'wl_admin_input_element_params', $pre_params );
-		// allow different types of input - default to 'text'.
-		$input_type = ! empty( $params['type'] ) ? $params['type'] : 'text';
-		?>
+        $pre_params = wp_parse_args(
+            $args,
+            array(
+                'id'          => uniqid( 'wl-input-' ),
+                'value'       => '',
+                'readonly'    => false,
+                'css_class'   => '',
+                'description' => '',
+                'pattern'     => false,
+                'placeholder' => false,
+            )
+        );
+        $params     = apply_filters( 'wl_admin_input_element_params', $pre_params );
+        // allow different types of input - default to 'text'.
+        $input_type = ! empty( $params['type'] ) ? $params['type'] : 'text';
+        ?>
 
 		<input type="<?php echo esc_attr( $input_type ); ?>"
 			   id="<?php echo esc_attr( $params['id'] ); ?>"
 			   name="<?php echo esc_attr( $params['name'] ); ?>"
 			   value="<?php echo esc_attr( $params['value'] ); ?>"
 			<?php
-			if ( $params['pattern'] ) {
-				echo ' pattern="';
-				echo esc_attr( $params['pattern'] );
-				echo '"';
-			}
-			?>
+            if ( $params['pattern'] ) {
+                echo ' pattern="';
+                echo esc_attr( $params['pattern'] );
+                echo '"';
+            }
+            ?>
 			<?php
-			if ( $params['placeholder'] ) {
-				echo ' placeholder="';
-				echo esc_attr( $params['placeholder'] );
-				echo '"';
-			}
-			?>
+            if ( $params['placeholder'] ) {
+                echo ' placeholder="';
+                echo esc_attr( $params['placeholder'] );
+                echo '"';
+            }
+            ?>
 			<?php
-			if ( ! empty( $params['data'] ) && is_array( $params['data'] ) ) {
-				foreach ( $params['data'] as $key => $value ) {
-					echo 'data-' . esc_attr( $key ) . '="' . esc_attr( $value ) . '" ';
-				}
-			}
-			if ( ! empty( $params['readonly'] ) ) {
-				?>
+            if ( ! empty( $params['data'] ) && is_array( $params['data'] ) ) {
+                foreach ( $params['data'] as $key => $value ) {
+                    echo 'data-' . esc_attr( $key ) . '="' . esc_attr( $value ) . '" ';
+                }
+            }
+            if ( ! empty( $params['readonly'] ) ) {
+                ?>
 				readonly="readonly" <?php } ?>
 			<?php
-			if ( ! empty( $params['css_class'] ) ) {
-				?>
+            if ( ! empty( $params['css_class'] ) ) {
+                ?>
 				class="<?php echo esc_attr( $params['css_class'] ); ?>" <?php } ?>
 		/>
 		<?php
-		if ( ! empty( $params['description'] ) ) {
-			?>
+        if ( ! empty( $params['description'] ) ) {
+            ?>
 			<p><?php echo wp_kses( $params['description'], array( 'a' => array( 'href' => array() ) ) ); ?></p><?php } ?>
 
 		<?php
 
-		return $this;
-	}
+        return $this;
+    }
 
 }

Spacing +20 added lines, -20 removed lines

@@ -43,7 +43,7 @@ 
 	 * @return $this|Wordlift_Admin_Element
 	 * @since 3.21.0 added the ability to use a $type arg.
 	 */
-	public function render( $args ) {
+	public function render($args) {
 
 		/*
 		 * Parse the arguments and merge with default values.
@@ -53,7 +53,7 @@ 
 		$pre_params = wp_parse_args(
 			$args,
 			array(
-				'id'          => uniqid( 'wl-input-' ),
+				'id'          => uniqid('wl-input-'),
 				'value'       => '',
 				'readonly'    => false,
 				'css_class'   => '',
@@ -62,47 +62,47 @@ 
 				'placeholder' => false,
 			)
 		);
-		$params     = apply_filters( 'wl_admin_input_element_params', $pre_params );
+		$params     = apply_filters('wl_admin_input_element_params', $pre_params);
 		// allow different types of input - default to 'text'.
-		$input_type = ! empty( $params['type'] ) ? $params['type'] : 'text';
+		$input_type = ! empty($params['type']) ? $params['type'] : 'text';
 		?>
 
-		<input type="<?php echo esc_attr( $input_type ); ?>"
-			   id="<?php echo esc_attr( $params['id'] ); ?>"
-			   name="<?php echo esc_attr( $params['name'] ); ?>"
-			   value="<?php echo esc_attr( $params['value'] ); ?>"
+		<input type="<?php echo esc_attr($input_type); ?>"
+			   id="<?php echo esc_attr($params['id']); ?>"
+			   name="<?php echo esc_attr($params['name']); ?>"
+			   value="<?php echo esc_attr($params['value']); ?>"
 			<?php
-			if ( $params['pattern'] ) {
+			if ($params['pattern']) {
 				echo ' pattern="';
-				echo esc_attr( $params['pattern'] );
+				echo esc_attr($params['pattern']);
 				echo '"';
 			}
 			?>
 			<?php
-			if ( $params['placeholder'] ) {
+			if ($params['placeholder']) {
 				echo ' placeholder="';
-				echo esc_attr( $params['placeholder'] );
+				echo esc_attr($params['placeholder']);
 				echo '"';
 			}
 			?>
 			<?php
-			if ( ! empty( $params['data'] ) && is_array( $params['data'] ) ) {
-				foreach ( $params['data'] as $key => $value ) {
-					echo 'data-' . esc_attr( $key ) . '="' . esc_attr( $value ) . '" ';
+			if ( ! empty($params['data']) && is_array($params['data'])) {
+				foreach ($params['data'] as $key => $value) {
+					echo 'data-'.esc_attr($key).'="'.esc_attr($value).'" ';
 				}
 			}
-			if ( ! empty( $params['readonly'] ) ) {
+			if ( ! empty($params['readonly'])) {
 				?>
 				readonly="readonly" <?php } ?>
 			<?php
-			if ( ! empty( $params['css_class'] ) ) {
+			if ( ! empty($params['css_class'])) {
 				?>
-				class="<?php echo esc_attr( $params['css_class'] ); ?>" <?php } ?>
+				class="<?php echo esc_attr($params['css_class']); ?>" <?php } ?>
 		/>
 		<?php
-		if ( ! empty( $params['description'] ) ) {
+		if ( ! empty($params['description'])) {
 			?>
-			<p><?php echo wp_kses( $params['description'], array( 'a' => array( 'href' => array() ) ) ); ?></p><?php } ?>
+			<p><?php echo wp_kses($params['description'], array('a' => array('href' => array()))); ?></p><?php } ?>
 
 		<?php
 

src/admin/class-wordlift-admin-settings-page.php

Indentation +403 added lines, -403 removed lines

@@ -18,408 +18,408 @@
  */
 class Wordlift_Admin_Settings_Page extends Wordlift_Admin_Page {
 
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Admin_Input_Element} element renderer.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Admin_Input_Element $input_element An {@link Wordlift_Admin_Input_Element} element renderer.
-	 */
-	private $input_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
-	 *
-	 * @since  3.13.0
-	 * @access protected
-	 * @var \Wordlift_Admin_Radio_Input_Element $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
-	 */
-	private $radio_input_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 */
-	private $language_select_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 *
-	 * @since  3.18.0
-	 * @access private
-	 * @var \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 */
-	private $country_select_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Publisher_Element} element renderer.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Admin_Publisher_Element $publisher_element A {@link Wordlift_Admin_Publisher_Element} element renderer.
-	 */
-	private $publisher_element;
-
-	/**
-	 * Create a {@link Wordlift_Admin_Settings_Page} instance.
-	 *
-	 * @param \Wordlift_Entity_Service                $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Admin_Input_Element           $input_element A {@link Wordlift_Admin_Input_Element} element renderer.
-	 * @param \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 * @param \Wordlift_Admin_Country_Select_Element  $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 * @param \Wordlift_Admin_Publisher_Element       $publisher_element A {@link Wordlift_Admin_Publisher_Element} element renderer.
-	 * @param \Wordlift_Admin_Radio_Input_Element     $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
-	 *
-	 * @since 3.11.0
-	 */
-	public function __construct( $entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element ) {
-
-		$this->entity_service = $entity_service;
-
-		// Set a reference to the UI elements.
-		$this->input_element           = $input_element;
-		$this->radio_input_element     = $radio_input_element;
-		$this->language_select_element = $language_select_element;
-		$this->country_select_element  = $country_select_element;
-		$this->publisher_element       = $publisher_element;
-
-	}
-
-	private static $instance;
-
-	/**
-	 * Get the singleton instance of the Notice service.
-	 *
-	 * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
-	 * @since 3.14.0
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			$publisher_element = new Wordlift_Admin_Publisher_Element(
-				Wordlift_Publisher_Service::get_instance(),
-				new Wordlift_Admin_Tabs_Element(),
-				new Wordlift_Admin_Select2_Element()
-			);
-
-			self::$instance = new self(
-				Wordlift_Entity_Service::get_instance(),
-				new Wordlift_Admin_Input_Element(),
-				new Wordlift_Admin_Language_Select_Element(),
-				new Wordlift_Admin_Country_Select_Element(),
-				$publisher_element,
-				new Wordlift_Admin_Radio_Input_Element()
-			);
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_parent_slug() {
-
-		return 'wl_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_capability() {
-
-		return 'manage_options';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_page_title() {
-
-		return __( 'WordLift Settings', 'wordlift' );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_menu_title() {
-
-		return __( 'Settings', 'wordlift' );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_menu_slug() {
-
-		return 'wl_configuration_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_partial_name() {
-
-		return 'wordlift-admin-settings-page.php';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function enqueue_scripts() {
-
-		// Enqueue the media scripts to be used for the publisher's logo selection.
-		wp_enqueue_media();
-
-		// JavaScript required for the settings page.
-		// @todo: try to move to the `wordlift-admin.bundle.js`.
-		wp_enqueue_script( 'wordlift-admin-settings-page', plugin_dir_url( __DIR__ ) . 'admin/js/1/settings.js', array( 'wp-util' ), WORDLIFT_VERSION, false );
-		wp_enqueue_style( 'wordlift-admin-settings-page', plugin_dir_url( __DIR__ ) . 'admin/js/1/settings.css', array(), WORDLIFT_VERSION );
-
-	}
-
-	/**
-	 * Configure all the configuration parameters.
-	 *
-	 * Called by the *admin_init* hook.
-	 *
-	 * @since 3.11.0
-	 */
-	public function admin_init() {
-		// Register WordLift's general settings, providing our own sanitize callback
-		// which will also check whether the user filled the WL Publisher form.
-		register_setting(
-			'wl_general_settings',
-			'wl_general_settings',
-			array( $this, 'sanitize_callback' )
-		);
-
-		// Add the general settings section.
-		add_settings_section(
-			'wl_general_settings_section', // ID used to identify this section and with which to register options.
-			'',                            // Section header.
-			'',                            // Callback used to render the description of the section.
-			'wl_general_settings'          // Page on which to add this section of options.
-		);
-
-		$key_args = array(
-			'id'          => 'wl-key',
-			'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::KEY . ']',
-			'value'       => Wordlift_Configuration_Service::get_instance()->get_key(),
-			'description' => __( 'Insert the <a href="https://wordlift.io">WordLift Key</a> you received via email.', 'wordlift' )
-							 . ' [' . apply_filters( 'wl_production_site_url', untrailingslashit( get_option( 'home' ) ) ) . ']',
-		);
-
-		// Before we were used to validate the key beforehand, but this means
-		// an http call whenever a page is opened in the admin area. Therefore
-		// we now leave the input `untouched`, leaving to the client to update
-		// the `css_class`.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/669.
-		$key_args['css_class'] = 'untouched';
-
-		// Add the `key` field.
-		add_settings_field(
-			'wl-key',                                       // Element id used to identify the field throughout the theme.
-			__( 'WordLift Key', 'wordlift' ),               // The label to the left of the option interface element.
-			// The name of the function responsible for rendering the option interface.
-			array( $this->input_element, 'render' ),
-			'wl_general_settings',                          // The page on which this option will be displayed.
-			'wl_general_settings_section',                  // The name of the section to which this field belongs.
-			$key_args                                       // The array of arguments to pass to the callback. In this case, just a description.
-		);
-
-		// Entity Base Path input.
-		$entity_base_path_args = array(
-			// The array of arguments to pass to the callback. In this case, just a description.
-			'id'          => 'wl-entity-base-path',
-			'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::ENTITY_BASE_PATH_KEY . ']',
-			'value'       => Wordlift_Configuration_Service::get_instance()->get_entity_base_path(),
-			/* translators: Placeholders: %s - a link to FAQ's page. */
-			'description' => sprintf( __( 'All new pages created with WordLift, will be stored inside your internal vocabulary. You can customize the url pattern of these pages in the field above. Check our <a href="%s">FAQs</a> if you need more info.', 'wordlift' ), 'https://wordlift.io/wordlift-user-faqs/#10-why-and-how-should-i-customize-the-url-of-the-entity-pages-created-in-my-vocabulary' ),
-		);
-
-		// The following call is very heavy on large web sites and is always run
-		// also when not needed:
-		// $entity_base_path_args['readonly'] = 0 < $this->entity_service->count();
-		//
-		// It is now replaced by a filter to add the `readonly` flag to the
-		// input element when this is actually rendered.
-		add_filter(
-			'wl_admin_input_element_params',
-			array(
-				$this,
-				'entity_path_input_element_params',
-			)
-		);
-
-		// Add the `wl_entity_base_path` field.
-		add_settings_field(
-			'wl-entity-base-path',                                // ID used to identify the field throughout the theme
-			__( 'Entity Base Path', 'wordlift' ),                 // The label to the left of the option interface element
-			// The name of the function responsible for rendering the option interface
-			array( $this->input_element, 'render' ),
-			'wl_general_settings',                                // The page on which this option will be displayed
-			'wl_general_settings_section',                        // The name of the section to which this field belongs
-			$entity_base_path_args
-		);
-
-		// Add the `country_code` field.
-		add_settings_field(
-			'wl-country-code',
-			__( 'Country', 'wordlift' ),
-			array( $this->country_select_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'          => 'wl-country-code',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::COUNTRY_CODE . ']',
-				'value'       => Wordlift_Configuration_Service::get_instance()->get_country_code(),
-				'description' => __( 'Please select a country.', 'wordlift' ),
-				'notice'      => __( 'The selected language is not supported in this country.</br>Please choose another country or language.', 'wordlift' ),
-			)
-		);
-
-		// Add the `alternateName` field.
-		add_settings_field(
-			'wl-alternate-name',
-			__( 'Website Alternate Name', 'wordlift' ),
-			array( $this->input_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'    => 'wl-alternate-name',
-				'name'  => 'wl_general_settings[' . Wordlift_Configuration_Service::ALTERNATE_NAME . ']',
-				'value' => Wordlift_Configuration_Service::get_instance()->get_alternate_name(),
-			)
-		);
-
-		// Add the override URL.
-		add_settings_field(
-			'wl-override-website-url',
-			__( 'Override Website URL', 'wordlift' ),
-			array( $this->input_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'          => 'wl-override-website-url',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::OVERRIDE_WEBSITE_URL . ']',
-				'value'       => Wordlift_Configuration_Service::get_instance()->get_override_website_url(),
-				'pattern'     => '^https?://.+$',
-				'placeholder' => __( 'Optionally type a URL like https://...', 'wordlift' ),
-			)
-		);
-
-		// Add the `publisher` field.
-		add_settings_field(
-			'wl-publisher-id',
-			__( 'Publisher', 'wordlift' ),
-			array( $this->publisher_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'   => 'wl-publisher-id',
-				'name' => 'wl_general_settings[' . Wordlift_Configuration_Service::PUBLISHER_ID . ']',
-			)
-		);
-
-		// Add the `link by default` field.
-		add_settings_field(
-			'wl-link-by-default',
-			__( 'Link by Default', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'          => 'wl-link-by-default',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LINK_BY_DEFAULT . ']',
-				'value'       => Wordlift_Configuration_Service::get_instance()->is_link_by_default() ? 'yes' : 'no',
-				'description' => __( 'Whether to link entities by default or not. This setting applies to all the entities.', 'wordlift' ),
-			)
-		);
-
-		// Add the `diagnostic data` field.
-		add_settings_field(
-			'wl-send-diagnostic',
-			__( 'Send Diagnostic Data', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				'id'          => 'wl-send-diagnostic',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::SEND_DIAGNOSTIC . ']',
-				'value'       => 'yes' === Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences() ? 'yes' : 'no',
-				'description' => __( 'Whether to send diagnostic data or not.', 'wordlift' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Filter the {@link Wordlift_Admin_Input_Element} in order to add the
-	 * `readonly` flag to the `wl-entity-base-path` input.
-	 *
-	 * @param array $args An array of {@link Wordlift_Admin_Input_Element} parameters.
-	 *
-	 * @return array The updated array.
-	 * @since 3.17.0
-	 */
-	public function entity_path_input_element_params( $args ) {
-
-		// Bail out if it's not the `wl-entity-base-path`).
-		if ( 'wl-entity-base-path' !== $args['id'] ) {
-			return $args;
-		}
-
-		// Set the readonly flag according to the entities count.
-		$args['readonly'] = 0 < $this->entity_service->count();
-
-		// Return the updated args.
-		return $args;
-	}
-
-	/**
-	 * Sanitize the configuration settings to be stored.
-	 *
-	 * If a new entity is being created for the publisher, create it and set The
-	 * publisher setting.
-	 *
-	 * @param array $input The configuration settings array.
-	 *
-	 * @return array The sanitized input array.
-	 * @since 3.11.0
-	 */
-	public function sanitize_callback( $input ) {
-		// No nonce verification since this callback is handled by settings api.
-		// Check whether a publisher name has been set.
-		// phpcs:ignore Standard.Category.SniffName.ErrorCode
-		if ( isset( $_POST['wl_publisher'] ) && ! empty( $_POST['wl_publisher']['name'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			$name = isset( $_POST['wl_publisher']['name'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['wl_publisher']['name'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			$type = isset( $_POST['wl_publisher']['type'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['wl_publisher']['type'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			// phpcs:ignore Standard.Category.SniffName.ErrorCode
-			$thumbnail_id = isset( $_POST['wl_publisher']['thumbnail_id'] ) ? sanitize_text_field( wp_unslash( $_POST['wl_publisher']['thumbnail_id'] ) ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Missing
-
-			// Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
-			$type_uri = sprintf( 'http://schema.org/%s', 'organization' === $type ? 'Organization' : 'Person' );
-
-			// Create an entity for the publisher and assign it to the input
-			// parameter which WordPress automatically saves into the settings.
-			$input['publisher_id'] = $this->entity_service->create( $name, $type_uri, $thumbnail_id, 'publish' );
-		}
-
-		return $input;
-	}
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Admin_Input_Element} element renderer.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Admin_Input_Element $input_element An {@link Wordlift_Admin_Input_Element} element renderer.
+     */
+    private $input_element;
+
+    /**
+     * A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
+     *
+     * @since  3.13.0
+     * @access protected
+     * @var \Wordlift_Admin_Radio_Input_Element $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
+     */
+    private $radio_input_element;
+
+    /**
+     * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     */
+    private $language_select_element;
+
+    /**
+     * A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     *
+     * @since  3.18.0
+     * @access private
+     * @var \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     */
+    private $country_select_element;
+
+    /**
+     * A {@link Wordlift_Admin_Publisher_Element} element renderer.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Admin_Publisher_Element $publisher_element A {@link Wordlift_Admin_Publisher_Element} element renderer.
+     */
+    private $publisher_element;
+
+    /**
+     * Create a {@link Wordlift_Admin_Settings_Page} instance.
+     *
+     * @param \Wordlift_Entity_Service                $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Admin_Input_Element           $input_element A {@link Wordlift_Admin_Input_Element} element renderer.
+     * @param \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     * @param \Wordlift_Admin_Country_Select_Element  $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     * @param \Wordlift_Admin_Publisher_Element       $publisher_element A {@link Wordlift_Admin_Publisher_Element} element renderer.
+     * @param \Wordlift_Admin_Radio_Input_Element     $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
+     *
+     * @since 3.11.0
+     */
+    public function __construct( $entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element ) {
+
+        $this->entity_service = $entity_service;
+
+        // Set a reference to the UI elements.
+        $this->input_element           = $input_element;
+        $this->radio_input_element     = $radio_input_element;
+        $this->language_select_element = $language_select_element;
+        $this->country_select_element  = $country_select_element;
+        $this->publisher_element       = $publisher_element;
+
+    }
+
+    private static $instance;
+
+    /**
+     * Get the singleton instance of the Notice service.
+     *
+     * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
+     * @since 3.14.0
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            $publisher_element = new Wordlift_Admin_Publisher_Element(
+                Wordlift_Publisher_Service::get_instance(),
+                new Wordlift_Admin_Tabs_Element(),
+                new Wordlift_Admin_Select2_Element()
+            );
+
+            self::$instance = new self(
+                Wordlift_Entity_Service::get_instance(),
+                new Wordlift_Admin_Input_Element(),
+                new Wordlift_Admin_Language_Select_Element(),
+                new Wordlift_Admin_Country_Select_Element(),
+                $publisher_element,
+                new Wordlift_Admin_Radio_Input_Element()
+            );
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_parent_slug() {
+
+        return 'wl_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_capability() {
+
+        return 'manage_options';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_page_title() {
+
+        return __( 'WordLift Settings', 'wordlift' );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_menu_title() {
+
+        return __( 'Settings', 'wordlift' );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_menu_slug() {
+
+        return 'wl_configuration_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_partial_name() {
+
+        return 'wordlift-admin-settings-page.php';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function enqueue_scripts() {
+
+        // Enqueue the media scripts to be used for the publisher's logo selection.
+        wp_enqueue_media();
+
+        // JavaScript required for the settings page.
+        // @todo: try to move to the `wordlift-admin.bundle.js`.
+        wp_enqueue_script( 'wordlift-admin-settings-page', plugin_dir_url( __DIR__ ) . 'admin/js/1/settings.js', array( 'wp-util' ), WORDLIFT_VERSION, false );
+        wp_enqueue_style( 'wordlift-admin-settings-page', plugin_dir_url( __DIR__ ) . 'admin/js/1/settings.css', array(), WORDLIFT_VERSION );
+
+    }
+
+    /**
+     * Configure all the configuration parameters.
+     *
+     * Called by the *admin_init* hook.
+     *
+     * @since 3.11.0
+     */
+    public function admin_init() {
+        // Register WordLift's general settings, providing our own sanitize callback
+        // which will also check whether the user filled the WL Publisher form.
+        register_setting(
+            'wl_general_settings',
+            'wl_general_settings',
+            array( $this, 'sanitize_callback' )
+        );
+
+        // Add the general settings section.
+        add_settings_section(
+            'wl_general_settings_section', // ID used to identify this section and with which to register options.
+            '',                            // Section header.
+            '',                            // Callback used to render the description of the section.
+            'wl_general_settings'          // Page on which to add this section of options.
+        );
+
+        $key_args = array(
+            'id'          => 'wl-key',
+            'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::KEY . ']',
+            'value'       => Wordlift_Configuration_Service::get_instance()->get_key(),
+            'description' => __( 'Insert the <a href="https://wordlift.io">WordLift Key</a> you received via email.', 'wordlift' )
+                                . ' [' . apply_filters( 'wl_production_site_url', untrailingslashit( get_option( 'home' ) ) ) . ']',
+        );
+
+        // Before we were used to validate the key beforehand, but this means
+        // an http call whenever a page is opened in the admin area. Therefore
+        // we now leave the input `untouched`, leaving to the client to update
+        // the `css_class`.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/669.
+        $key_args['css_class'] = 'untouched';
+
+        // Add the `key` field.
+        add_settings_field(
+            'wl-key',                                       // Element id used to identify the field throughout the theme.
+            __( 'WordLift Key', 'wordlift' ),               // The label to the left of the option interface element.
+            // The name of the function responsible for rendering the option interface.
+            array( $this->input_element, 'render' ),
+            'wl_general_settings',                          // The page on which this option will be displayed.
+            'wl_general_settings_section',                  // The name of the section to which this field belongs.
+            $key_args                                       // The array of arguments to pass to the callback. In this case, just a description.
+        );
+
+        // Entity Base Path input.
+        $entity_base_path_args = array(
+            // The array of arguments to pass to the callback. In this case, just a description.
+            'id'          => 'wl-entity-base-path',
+            'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::ENTITY_BASE_PATH_KEY . ']',
+            'value'       => Wordlift_Configuration_Service::get_instance()->get_entity_base_path(),
+            /* translators: Placeholders: %s - a link to FAQ's page. */
+            'description' => sprintf( __( 'All new pages created with WordLift, will be stored inside your internal vocabulary. You can customize the url pattern of these pages in the field above. Check our <a href="%s">FAQs</a> if you need more info.', 'wordlift' ), 'https://wordlift.io/wordlift-user-faqs/#10-why-and-how-should-i-customize-the-url-of-the-entity-pages-created-in-my-vocabulary' ),
+        );
+
+        // The following call is very heavy on large web sites and is always run
+        // also when not needed:
+        // $entity_base_path_args['readonly'] = 0 < $this->entity_service->count();
+        //
+        // It is now replaced by a filter to add the `readonly` flag to the
+        // input element when this is actually rendered.
+        add_filter(
+            'wl_admin_input_element_params',
+            array(
+                $this,
+                'entity_path_input_element_params',
+            )
+        );
+
+        // Add the `wl_entity_base_path` field.
+        add_settings_field(
+            'wl-entity-base-path',                                // ID used to identify the field throughout the theme
+            __( 'Entity Base Path', 'wordlift' ),                 // The label to the left of the option interface element
+            // The name of the function responsible for rendering the option interface
+            array( $this->input_element, 'render' ),
+            'wl_general_settings',                                // The page on which this option will be displayed
+            'wl_general_settings_section',                        // The name of the section to which this field belongs
+            $entity_base_path_args
+        );
+
+        // Add the `country_code` field.
+        add_settings_field(
+            'wl-country-code',
+            __( 'Country', 'wordlift' ),
+            array( $this->country_select_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'          => 'wl-country-code',
+                'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::COUNTRY_CODE . ']',
+                'value'       => Wordlift_Configuration_Service::get_instance()->get_country_code(),
+                'description' => __( 'Please select a country.', 'wordlift' ),
+                'notice'      => __( 'The selected language is not supported in this country.</br>Please choose another country or language.', 'wordlift' ),
+            )
+        );
+
+        // Add the `alternateName` field.
+        add_settings_field(
+            'wl-alternate-name',
+            __( 'Website Alternate Name', 'wordlift' ),
+            array( $this->input_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'    => 'wl-alternate-name',
+                'name'  => 'wl_general_settings[' . Wordlift_Configuration_Service::ALTERNATE_NAME . ']',
+                'value' => Wordlift_Configuration_Service::get_instance()->get_alternate_name(),
+            )
+        );
+
+        // Add the override URL.
+        add_settings_field(
+            'wl-override-website-url',
+            __( 'Override Website URL', 'wordlift' ),
+            array( $this->input_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'          => 'wl-override-website-url',
+                'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::OVERRIDE_WEBSITE_URL . ']',
+                'value'       => Wordlift_Configuration_Service::get_instance()->get_override_website_url(),
+                'pattern'     => '^https?://.+$',
+                'placeholder' => __( 'Optionally type a URL like https://...', 'wordlift' ),
+            )
+        );
+
+        // Add the `publisher` field.
+        add_settings_field(
+            'wl-publisher-id',
+            __( 'Publisher', 'wordlift' ),
+            array( $this->publisher_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'   => 'wl-publisher-id',
+                'name' => 'wl_general_settings[' . Wordlift_Configuration_Service::PUBLISHER_ID . ']',
+            )
+        );
+
+        // Add the `link by default` field.
+        add_settings_field(
+            'wl-link-by-default',
+            __( 'Link by Default', 'wordlift' ),
+            array( $this->radio_input_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'          => 'wl-link-by-default',
+                'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LINK_BY_DEFAULT . ']',
+                'value'       => Wordlift_Configuration_Service::get_instance()->is_link_by_default() ? 'yes' : 'no',
+                'description' => __( 'Whether to link entities by default or not. This setting applies to all the entities.', 'wordlift' ),
+            )
+        );
+
+        // Add the `diagnostic data` field.
+        add_settings_field(
+            'wl-send-diagnostic',
+            __( 'Send Diagnostic Data', 'wordlift' ),
+            array( $this->radio_input_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                'id'          => 'wl-send-diagnostic',
+                'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::SEND_DIAGNOSTIC . ']',
+                'value'       => 'yes' === Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences() ? 'yes' : 'no',
+                'description' => __( 'Whether to send diagnostic data or not.', 'wordlift' ),
+            )
+        );
+
+    }
+
+    /**
+     * Filter the {@link Wordlift_Admin_Input_Element} in order to add the
+     * `readonly` flag to the `wl-entity-base-path` input.
+     *
+     * @param array $args An array of {@link Wordlift_Admin_Input_Element} parameters.
+     *
+     * @return array The updated array.
+     * @since 3.17.0
+     */
+    public function entity_path_input_element_params( $args ) {
+
+        // Bail out if it's not the `wl-entity-base-path`).
+        if ( 'wl-entity-base-path' !== $args['id'] ) {
+            return $args;
+        }
+
+        // Set the readonly flag according to the entities count.
+        $args['readonly'] = 0 < $this->entity_service->count();
+
+        // Return the updated args.
+        return $args;
+    }
+
+    /**
+     * Sanitize the configuration settings to be stored.
+     *
+     * If a new entity is being created for the publisher, create it and set The
+     * publisher setting.
+     *
+     * @param array $input The configuration settings array.
+     *
+     * @return array The sanitized input array.
+     * @since 3.11.0
+     */
+    public function sanitize_callback( $input ) {
+        // No nonce verification since this callback is handled by settings api.
+        // Check whether a publisher name has been set.
+        // phpcs:ignore Standard.Category.SniffName.ErrorCode
+        if ( isset( $_POST['wl_publisher'] ) && ! empty( $_POST['wl_publisher']['name'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
+            $name = isset( $_POST['wl_publisher']['name'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['wl_publisher']['name'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Missing
+            $type = isset( $_POST['wl_publisher']['type'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['wl_publisher']['type'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Missing
+            // phpcs:ignore Standard.Category.SniffName.ErrorCode
+            $thumbnail_id = isset( $_POST['wl_publisher']['thumbnail_id'] ) ? sanitize_text_field( wp_unslash( $_POST['wl_publisher']['thumbnail_id'] ) ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Missing
+
+            // Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
+            $type_uri = sprintf( 'http://schema.org/%s', 'organization' === $type ? 'Organization' : 'Person' );
+
+            // Create an entity for the publisher and assign it to the input
+            // parameter which WordPress automatically saves into the settings.
+            $input['publisher_id'] = $this->entity_service->create( $name, $type_uri, $thumbnail_id, 'publish' );
+        }
+
+        return $input;
+    }
 
 }

Spacing +56 added lines, -56 removed lines

@@ -84,7 +84,7 @@ 
 	 *
 	 * @since 3.11.0
 	 */
-	public function __construct( $entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element ) {
+	public function __construct($entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element) {
 
 		$this->entity_service = $entity_service;
 
@@ -107,7 +107,7 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			$publisher_element = new Wordlift_Admin_Publisher_Element(
 				Wordlift_Publisher_Service::get_instance(),
 				new Wordlift_Admin_Tabs_Element(),
@@ -148,7 +148,7 @@ 
 	 */
 	public function get_page_title() {
 
-		return __( 'WordLift Settings', 'wordlift' );
+		return __('WordLift Settings', 'wordlift');
 	}
 
 	/**
@@ -156,7 +156,7 @@ 
 	 */
 	public function get_menu_title() {
 
-		return __( 'Settings', 'wordlift' );
+		return __('Settings', 'wordlift');
 	}
 
 	/**
@@ -185,8 +185,8 @@ 
 
 		// JavaScript required for the settings page.
 		// @todo: try to move to the `wordlift-admin.bundle.js`.
-		wp_enqueue_script( 'wordlift-admin-settings-page', plugin_dir_url( __DIR__ ) . 'admin/js/1/settings.js', array( 'wp-util' ), WORDLIFT_VERSION, false );
-		wp_enqueue_style( 'wordlift-admin-settings-page', plugin_dir_url( __DIR__ ) . 'admin/js/1/settings.css', array(), WORDLIFT_VERSION );
+		wp_enqueue_script('wordlift-admin-settings-page', plugin_dir_url(__DIR__).'admin/js/1/settings.js', array('wp-util'), WORDLIFT_VERSION, false);
+		wp_enqueue_style('wordlift-admin-settings-page', plugin_dir_url(__DIR__).'admin/js/1/settings.css', array(), WORDLIFT_VERSION);
 
 	}
 
@@ -203,23 +203,23 @@ 
 		register_setting(
 			'wl_general_settings',
 			'wl_general_settings',
-			array( $this, 'sanitize_callback' )
+			array($this, 'sanitize_callback')
 		);
 
 		// Add the general settings section.
 		add_settings_section(
 			'wl_general_settings_section', // ID used to identify this section and with which to register options.
-			'',                            // Section header.
-			'',                            // Callback used to render the description of the section.
+			'', // Section header.
+			'', // Callback used to render the description of the section.
 			'wl_general_settings'          // Page on which to add this section of options.
 		);
 
 		$key_args = array(
 			'id'          => 'wl-key',
-			'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::KEY . ']',
+			'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::KEY.']',
 			'value'       => Wordlift_Configuration_Service::get_instance()->get_key(),
-			'description' => __( 'Insert the <a href="https://wordlift.io">WordLift Key</a> you received via email.', 'wordlift' )
-							 . ' [' . apply_filters( 'wl_production_site_url', untrailingslashit( get_option( 'home' ) ) ) . ']',
+			'description' => __('Insert the <a href="https://wordlift.io">WordLift Key</a> you received via email.', 'wordlift')
+							 . ' ['.apply_filters('wl_production_site_url', untrailingslashit(get_option('home'))).']',
 		);
 
 		// Before we were used to validate the key beforehand, but this means
@@ -232,12 +232,12 @@ 
 
 		// Add the `key` field.
 		add_settings_field(
-			'wl-key',                                       // Element id used to identify the field throughout the theme.
-			__( 'WordLift Key', 'wordlift' ),               // The label to the left of the option interface element.
+			'wl-key', // Element id used to identify the field throughout the theme.
+			__('WordLift Key', 'wordlift'), // The label to the left of the option interface element.
 			// The name of the function responsible for rendering the option interface.
-			array( $this->input_element, 'render' ),
-			'wl_general_settings',                          // The page on which this option will be displayed.
-			'wl_general_settings_section',                  // The name of the section to which this field belongs.
+			array($this->input_element, 'render'),
+			'wl_general_settings', // The page on which this option will be displayed.
+			'wl_general_settings_section', // The name of the section to which this field belongs.
 			$key_args                                       // The array of arguments to pass to the callback. In this case, just a description.
 		);
 
@@ -245,10 +245,10 @@ 
 		$entity_base_path_args = array(
 			// The array of arguments to pass to the callback. In this case, just a description.
 			'id'          => 'wl-entity-base-path',
-			'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::ENTITY_BASE_PATH_KEY . ']',
+			'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::ENTITY_BASE_PATH_KEY.']',
 			'value'       => Wordlift_Configuration_Service::get_instance()->get_entity_base_path(),
 			/* translators: Placeholders: %s - a link to FAQ's page. */
-			'description' => sprintf( __( 'All new pages created with WordLift, will be stored inside your internal vocabulary. You can customize the url pattern of these pages in the field above. Check our <a href="%s">FAQs</a> if you need more info.', 'wordlift' ), 'https://wordlift.io/wordlift-user-faqs/#10-why-and-how-should-i-customize-the-url-of-the-entity-pages-created-in-my-vocabulary' ),
+			'description' => sprintf(__('All new pages created with WordLift, will be stored inside your internal vocabulary. You can customize the url pattern of these pages in the field above. Check our <a href="%s">FAQs</a> if you need more info.', 'wordlift'), 'https://wordlift.io/wordlift-user-faqs/#10-why-and-how-should-i-customize-the-url-of-the-entity-pages-created-in-my-vocabulary'),
 		);
 
 		// The following call is very heavy on large web sites and is always run
@@ -267,41 +267,41 @@ 
 
 		// Add the `wl_entity_base_path` field.
 		add_settings_field(
-			'wl-entity-base-path',                                // ID used to identify the field throughout the theme
-			__( 'Entity Base Path', 'wordlift' ),                 // The label to the left of the option interface element
+			'wl-entity-base-path', // ID used to identify the field throughout the theme
+			__('Entity Base Path', 'wordlift'), // The label to the left of the option interface element
 			// The name of the function responsible for rendering the option interface
-			array( $this->input_element, 'render' ),
-			'wl_general_settings',                                // The page on which this option will be displayed
-			'wl_general_settings_section',                        // The name of the section to which this field belongs
+			array($this->input_element, 'render'),
+			'wl_general_settings', // The page on which this option will be displayed
+			'wl_general_settings_section', // The name of the section to which this field belongs
 			$entity_base_path_args
 		);
 
 		// Add the `country_code` field.
 		add_settings_field(
 			'wl-country-code',
-			__( 'Country', 'wordlift' ),
-			array( $this->country_select_element, 'render' ),
+			__('Country', 'wordlift'),
+			array($this->country_select_element, 'render'),
 			'wl_general_settings',
 			'wl_general_settings_section',
 			array(
 				'id'          => 'wl-country-code',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::COUNTRY_CODE . ']',
+				'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::COUNTRY_CODE.']',
 				'value'       => Wordlift_Configuration_Service::get_instance()->get_country_code(),
-				'description' => __( 'Please select a country.', 'wordlift' ),
-				'notice'      => __( 'The selected language is not supported in this country.</br>Please choose another country or language.', 'wordlift' ),
+				'description' => __('Please select a country.', 'wordlift'),
+				'notice'      => __('The selected language is not supported in this country.</br>Please choose another country or language.', 'wordlift'),
 			)
 		);
 
 		// Add the `alternateName` field.
 		add_settings_field(
 			'wl-alternate-name',
-			__( 'Website Alternate Name', 'wordlift' ),
-			array( $this->input_element, 'render' ),
+			__('Website Alternate Name', 'wordlift'),
+			array($this->input_element, 'render'),
 			'wl_general_settings',
 			'wl_general_settings_section',
 			array(
 				'id'    => 'wl-alternate-name',
-				'name'  => 'wl_general_settings[' . Wordlift_Configuration_Service::ALTERNATE_NAME . ']',
+				'name'  => 'wl_general_settings['.Wordlift_Configuration_Service::ALTERNATE_NAME.']',
 				'value' => Wordlift_Configuration_Service::get_instance()->get_alternate_name(),
 			)
 		);
@@ -309,59 +309,59 @@ 
 		// Add the override URL.
 		add_settings_field(
 			'wl-override-website-url',
-			__( 'Override Website URL', 'wordlift' ),
-			array( $this->input_element, 'render' ),
+			__('Override Website URL', 'wordlift'),
+			array($this->input_element, 'render'),
 			'wl_general_settings',
 			'wl_general_settings_section',
 			array(
 				'id'          => 'wl-override-website-url',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::OVERRIDE_WEBSITE_URL . ']',
+				'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::OVERRIDE_WEBSITE_URL.']',
 				'value'       => Wordlift_Configuration_Service::get_instance()->get_override_website_url(),
 				'pattern'     => '^https?://.+$',
-				'placeholder' => __( 'Optionally type a URL like https://...', 'wordlift' ),
+				'placeholder' => __('Optionally type a URL like https://...', 'wordlift'),
 			)
 		);
 
 		// Add the `publisher` field.
 		add_settings_field(
 			'wl-publisher-id',
-			__( 'Publisher', 'wordlift' ),
-			array( $this->publisher_element, 'render' ),
+			__('Publisher', 'wordlift'),
+			array($this->publisher_element, 'render'),
 			'wl_general_settings',
 			'wl_general_settings_section',
 			array(
 				'id'   => 'wl-publisher-id',
-				'name' => 'wl_general_settings[' . Wordlift_Configuration_Service::PUBLISHER_ID . ']',
+				'name' => 'wl_general_settings['.Wordlift_Configuration_Service::PUBLISHER_ID.']',
 			)
 		);
 
 		// Add the `link by default` field.
 		add_settings_field(
 			'wl-link-by-default',
-			__( 'Link by Default', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
+			__('Link by Default', 'wordlift'),
+			array($this->radio_input_element, 'render'),
 			'wl_general_settings',
 			'wl_general_settings_section',
 			array(
 				'id'          => 'wl-link-by-default',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LINK_BY_DEFAULT . ']',
+				'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::LINK_BY_DEFAULT.']',
 				'value'       => Wordlift_Configuration_Service::get_instance()->is_link_by_default() ? 'yes' : 'no',
-				'description' => __( 'Whether to link entities by default or not. This setting applies to all the entities.', 'wordlift' ),
+				'description' => __('Whether to link entities by default or not. This setting applies to all the entities.', 'wordlift'),
 			)
 		);
 
 		// Add the `diagnostic data` field.
 		add_settings_field(
 			'wl-send-diagnostic',
-			__( 'Send Diagnostic Data', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
+			__('Send Diagnostic Data', 'wordlift'),
+			array($this->radio_input_element, 'render'),
 			'wl_general_settings',
 			'wl_general_settings_section',
 			array(
 				'id'          => 'wl-send-diagnostic',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::SEND_DIAGNOSTIC . ']',
+				'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::SEND_DIAGNOSTIC.']',
 				'value'       => 'yes' === Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences() ? 'yes' : 'no',
-				'description' => __( 'Whether to send diagnostic data or not.', 'wordlift' ),
+				'description' => __('Whether to send diagnostic data or not.', 'wordlift'),
 			)
 		);
 
@@ -376,10 +376,10 @@ 
 	 * @return array The updated array.
 	 * @since 3.17.0
 	 */
-	public function entity_path_input_element_params( $args ) {
+	public function entity_path_input_element_params($args) {
 
 		// Bail out if it's not the `wl-entity-base-path`).
-		if ( 'wl-entity-base-path' !== $args['id'] ) {
+		if ('wl-entity-base-path' !== $args['id']) {
 			return $args;
 		}
 
@@ -401,22 +401,22 @@ 
 	 * @return array The sanitized input array.
 	 * @since 3.11.0
 	 */
-	public function sanitize_callback( $input ) {
+	public function sanitize_callback($input) {
 		// No nonce verification since this callback is handled by settings api.
 		// Check whether a publisher name has been set.
 		// phpcs:ignore Standard.Category.SniffName.ErrorCode
-		if ( isset( $_POST['wl_publisher'] ) && ! empty( $_POST['wl_publisher']['name'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			$name = isset( $_POST['wl_publisher']['name'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['wl_publisher']['name'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			$type = isset( $_POST['wl_publisher']['type'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['wl_publisher']['type'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Missing
+		if (isset($_POST['wl_publisher']) && ! empty($_POST['wl_publisher']['name'])) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
+			$name = isset($_POST['wl_publisher']['name']) ? sanitize_text_field(wp_unslash((string) $_POST['wl_publisher']['name'])) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Missing
+			$type = isset($_POST['wl_publisher']['type']) ? sanitize_text_field(wp_unslash((string) $_POST['wl_publisher']['type'])) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Missing
 			// phpcs:ignore Standard.Category.SniffName.ErrorCode
-			$thumbnail_id = isset( $_POST['wl_publisher']['thumbnail_id'] ) ? sanitize_text_field( wp_unslash( $_POST['wl_publisher']['thumbnail_id'] ) ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Missing
+			$thumbnail_id = isset($_POST['wl_publisher']['thumbnail_id']) ? sanitize_text_field(wp_unslash($_POST['wl_publisher']['thumbnail_id'])) : null; //phpcs:ignore WordPress.Security.NonceVerification.Missing
 
 			// Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
-			$type_uri = sprintf( 'http://schema.org/%s', 'organization' === $type ? 'Organization' : 'Person' );
+			$type_uri = sprintf('http://schema.org/%s', 'organization' === $type ? 'Organization' : 'Person');
 
 			// Create an entity for the publisher and assign it to the input
 			// parameter which WordPress automatically saves into the settings.
-			$input['publisher_id'] = $this->entity_service->create( $name, $type_uri, $thumbnail_id, 'publish' );
+			$input['publisher_id'] = $this->entity_service->create($name, $type_uri, $thumbnail_id, 'publish');
 		}
 
 		return $input;

src/modules/override-url/load.php

Indentation +8 added lines, -8 removed lines

@@ -1,21 +1,21 @@
 <?php
 
 function _wl_override_url__production_site_url( $value ) {
-	$override_website_url = Wordlift_Configuration_Service::get_instance()->get_override_website_url();
+    $override_website_url = Wordlift_Configuration_Service::get_instance()->get_override_website_url();
 
-	return ! empty( $override_website_url ) ? $override_website_url : $value;
+    return ! empty( $override_website_url ) ? $override_website_url : $value;
 }
 
 function _wl_override_url__wl_production_permalink( $value ) {
-	$override_website_url = Wordlift_Configuration_Service::get_instance()->get_override_website_url();
+    $override_website_url = Wordlift_Configuration_Service::get_instance()->get_override_website_url();
 
-	if ( empty( $override_website_url ) ) {
-		return $value;
-	}
+    if ( empty( $override_website_url ) ) {
+        return $value;
+    }
 
-	$home_url = untrailingslashit( get_option( 'home' ) );
+    $home_url = untrailingslashit( get_option( 'home' ) );
 
-	return $override_website_url . substr( $value, strlen( $home_url ) );
+    return $override_website_url . substr( $value, strlen( $home_url ) );
 }
 
 add_filter( 'wl_production_site_url', '_wl_override_url__production_site_url' );

Spacing +8 added lines, -8 removed lines

@@ -1,23 +1,23 @@
 <?php
 
-function _wl_override_url__production_site_url( $value ) {
+function _wl_override_url__production_site_url($value) {
 	$override_website_url = Wordlift_Configuration_Service::get_instance()->get_override_website_url();
 
-	return ! empty( $override_website_url ) ? $override_website_url : $value;
+	return ! empty($override_website_url) ? $override_website_url : $value;
 }
 
-function _wl_override_url__wl_production_permalink( $value ) {
+function _wl_override_url__wl_production_permalink($value) {
 	$override_website_url = Wordlift_Configuration_Service::get_instance()->get_override_website_url();
 
-	if ( empty( $override_website_url ) ) {
+	if (empty($override_website_url)) {
 		return $value;
 	}
 
-	$home_url = untrailingslashit( get_option( 'home' ) );
+	$home_url = untrailingslashit(get_option('home'));
 
-	return $override_website_url . substr( $value, strlen( $home_url ) );
+	return $override_website_url.substr($value, strlen($home_url));
 }
 
-add_filter( 'wl_production_site_url', '_wl_override_url__production_site_url' );
+add_filter('wl_production_site_url', '_wl_override_url__production_site_url');
 
-add_filter( 'wl_production_permalink', '_wl_override_url__wl_production_permalink' );
+add_filter('wl_production_permalink', '_wl_override_url__wl_production_permalink');

src/wordlift.php

Indentation +172 added lines, -172 removed lines

@@ -47,7 +47,7 @@ 
  * @since 3.33.6
  */
 if ( ! apply_filters( 'wl_is_enabled', true ) ) {
-	return;
+    return;
 }
 
 require_once plugin_dir_path( __FILE__ ) . 'vendor/autoload.php';
@@ -76,33 +76,33 @@ 
  */
 function activate_wordlift() {
 
-	$log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
+    $log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
 
-	$log->info( 'Activating WordLift...' );
+    $log->info( 'Activating WordLift...' );
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
-	Wordlift_Activator::activate();
+    require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
+    Wordlift_Activator::activate();
 
-	/**
-	 * Tell the {@link Wordlift_Http_Api} class that we're activating, to let it run activation tasks.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
-	 * @since 3.19.2
-	 */
-	Wordlift_Http_Api::activate();
+    /**
+     * Tell the {@link Wordlift_Http_Api} class that we're activating, to let it run activation tasks.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
+     * @since 3.19.2
+     */
+    Wordlift_Http_Api::activate();
 
-	// Ensure the post type is registered before flushing the rewrite rules.
-	Wordlift_Entity_Post_Type_Service::get_instance()->register();
-	flush_rewrite_rules();
-	/**
-	 * @since 3.27.7
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/1214
-	 */
-	Top_Entities::activate();
+    // Ensure the post type is registered before flushing the rewrite rules.
+    Wordlift_Entity_Post_Type_Service::get_instance()->register();
+    flush_rewrite_rules();
+    /**
+     * @since 3.27.7
+     * @see https://github.com/insideout10/wordlift-plugin/issues/1214
+     */
+    Top_Entities::activate();
 
-	if ( ! wp_next_scheduled( 'wl_daily_cron' ) ) {
-		wp_schedule_event( time(), 'daily', 'wl_daily_cron' );
-	}
+    if ( ! wp_next_scheduled( 'wl_daily_cron' ) ) {
+        wp_schedule_event( time(), 'daily', 'wl_daily_cron' );
+    }
 
 }
 
@@ -112,23 +112,23 @@ 
  */
 function deactivate_wordlift() {
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
-	Wordlift_Deactivator::deactivate();
-	Wordlift_Http_Api::deactivate();
-	Ttl_Cache_Cleaner::deactivate();
-	/**
-	 * @since 3.27.7
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/1214
-	 */
-	Top_Entities::deactivate();
-	/**
-	 * @since 3.27.8
-	 * Remove notification flag on deactivation.
-	 */
-	Key_Validation_Notice::remove_notification_flag();
-	flush_rewrite_rules();
-
-	wp_clear_scheduled_hook( 'wl_daily_cron' );
+    require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
+    Wordlift_Deactivator::deactivate();
+    Wordlift_Http_Api::deactivate();
+    Ttl_Cache_Cleaner::deactivate();
+    /**
+     * @since 3.27.7
+     * @see https://github.com/insideout10/wordlift-plugin/issues/1214
+     */
+    Top_Entities::deactivate();
+    /**
+     * @since 3.27.8
+     * Remove notification flag on deactivation.
+     */
+    Key_Validation_Notice::remove_notification_flag();
+    flush_rewrite_rules();
+
+    wp_clear_scheduled_hook( 'wl_daily_cron' );
 
 }
 
@@ -151,84 +151,84 @@ 
  * @since    1.0.0
  */
 function run_wordlift() {
-	/**
-	 * Filter: wl_feature__enable__widgets.
-	 *
-	 * @param bool whether the widgets needed to be registered, defaults to true.
-	 *
-	 * @return bool
-	 * @since 3.27.6
-	 */
-	if ( apply_filters( 'wl_feature__enable__widgets', true ) ) {
-		add_action( 'widgets_init', 'wl_register_chord_widget' );
-		add_action( 'widgets_init', 'wl_register_geo_widget' );
-		add_action( 'widgets_init', 'wl_register_timeline_widget' );
-	}
-	add_filter( 'widget_text', 'do_shortcode' );
-
-	/**
-	 * Filter: wl_feature__enable__analysis
-	 *
-	 * @param bool Whether to send api request to analysis or not
-	 *
-	 * @return bool
-	 * @since 3.27.6
-	 */
-	if ( apply_filters( 'wl_feature__enable__analysis', true ) ) {
-		add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_action' );
-	} else {
-		add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_disabled_action' );
-	}
-
-	$plugin = new Wordlift();
-	$plugin->run();
-
-	// Initialize the TTL Cache Cleaner.
-	new Ttl_Cache_Cleaner();
-
-	// Load the new Post Adapter.
-	new Post_Adapter();
-
-	// Load the API Data Hooks.
-	new Api_Data_Hooks();
-
-	add_action(
-		'plugins_loaded',
-		function () {
-			// All features from registry should be initialized here.
-			$features_registry = Features_Registry::get_instance();
-			$features_registry->initialize_all_features();
-		},
-		5
-	);
-
-	add_action(
-		'plugins_loaded',
-		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		function () use ( $plugin ) {
-
-			new Wordlift_Products_Navigator_Shortcode_REST();
-
-			// Register the Dataset module, requires `$api_service`.
-			require_once plugin_dir_path( __FILE__ ) . 'classes/dataset/index.php';
-			require_once plugin_dir_path( __FILE__ ) . 'classes/shipping-data/index.php';
-
-			/*
+    /**
+     * Filter: wl_feature__enable__widgets.
+     *
+     * @param bool whether the widgets needed to be registered, defaults to true.
+     *
+     * @return bool
+     * @since 3.27.6
+     */
+    if ( apply_filters( 'wl_feature__enable__widgets', true ) ) {
+        add_action( 'widgets_init', 'wl_register_chord_widget' );
+        add_action( 'widgets_init', 'wl_register_geo_widget' );
+        add_action( 'widgets_init', 'wl_register_timeline_widget' );
+    }
+    add_filter( 'widget_text', 'do_shortcode' );
+
+    /**
+     * Filter: wl_feature__enable__analysis
+     *
+     * @param bool Whether to send api request to analysis or not
+     *
+     * @return bool
+     * @since 3.27.6
+     */
+    if ( apply_filters( 'wl_feature__enable__analysis', true ) ) {
+        add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_action' );
+    } else {
+        add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_disabled_action' );
+    }
+
+    $plugin = new Wordlift();
+    $plugin->run();
+
+    // Initialize the TTL Cache Cleaner.
+    new Ttl_Cache_Cleaner();
+
+    // Load the new Post Adapter.
+    new Post_Adapter();
+
+    // Load the API Data Hooks.
+    new Api_Data_Hooks();
+
+    add_action(
+        'plugins_loaded',
+        function () {
+            // All features from registry should be initialized here.
+            $features_registry = Features_Registry::get_instance();
+            $features_registry->initialize_all_features();
+        },
+        5
+    );
+
+    add_action(
+        'plugins_loaded',
+        // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+        function () use ( $plugin ) {
+
+            new Wordlift_Products_Navigator_Shortcode_REST();
+
+            // Register the Dataset module, requires `$api_service`.
+            require_once plugin_dir_path( __FILE__ ) . 'classes/dataset/index.php';
+            require_once plugin_dir_path( __FILE__ ) . 'classes/shipping-data/index.php';
+
+            /*
 			* Require the Entity annotation cleanup module.
 			*
 			* @since 3.34.6
 			*/
-			require_once plugin_dir_path( __FILE__ ) . 'classes/cleanup/index.php';
+            require_once plugin_dir_path( __FILE__ ) . 'classes/cleanup/index.php';
 
-			/*
+            /*
 			* Import LOD entities.
 			*
 			* @since 3.35.0
 			*/
-			require_once plugin_dir_path( __FILE__ ) . 'classes/lod-import/index.php';
+            require_once plugin_dir_path( __FILE__ ) . 'classes/lod-import/index.php';
 
-		}
-	);
+        }
+    );
 
 }
 
@@ -242,50 +242,50 @@ 
  */
 function wordlift_plugin_autoload_register() {
 
-	spl_autoload_register(
-		function ( $class_name ) {
+    spl_autoload_register(
+        function ( $class_name ) {
 
-			// Bail out if these are not our classes.
-			if ( 0 !== strpos( $class_name, 'Wordlift\\' ) ) {
-				return false;
-			}
+            // Bail out if these are not our classes.
+            if ( 0 !== strpos( $class_name, 'Wordlift\\' ) ) {
+                return false;
+            }
 
-			$class_name_lc = strtolower( str_replace( '_', '-', $class_name ) );
+            $class_name_lc = strtolower( str_replace( '_', '-', $class_name ) );
 
-			preg_match( '|^wordlift\\\\(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches );
+            preg_match( '|^wordlift\\\\(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches );
 
-			$path = str_replace( '\\', DIRECTORY_SEPARATOR, $matches[1] );
-			$file = 'class-' . $matches[2] . '.php';
+            $path = str_replace( '\\', DIRECTORY_SEPARATOR, $matches[1] );
+            $file = 'class-' . $matches[2] . '.php';
 
-			$full_path = plugin_dir_path( __FILE__ ) . 'classes' . DIRECTORY_SEPARATOR . $path . DIRECTORY_SEPARATOR . $file;
+            $full_path = plugin_dir_path( __FILE__ ) . 'classes' . DIRECTORY_SEPARATOR . $path . DIRECTORY_SEPARATOR . $file;
 
-			if ( ! file_exists( $full_path ) ) {
-				return false;
-			}
+            if ( ! file_exists( $full_path ) ) {
+                return false;
+            }
 
-			try {
-				require_once $full_path;
-			} catch ( Exception $e ) {
-				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
-				error_log( "[WordLift] $full_path not found, cannot include." );
-			}
+            try {
+                require_once $full_path;
+            } catch ( Exception $e ) {
+                // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
+                error_log( "[WordLift] $full_path not found, cannot include." );
+            }
 
-			return true;
-		}
-	);
+            return true;
+        }
+    );
 
 }
 
 function wl_block_categories( $categories ) {
-	return array_merge(
-		$categories,
-		array(
-			array(
-				'slug'  => 'wordlift',
-				'title' => __( 'WordLift', 'wordlift' ),
-			),
-		)
-	);
+    return array_merge(
+        $categories,
+        array(
+            array(
+                'slug'  => 'wordlift',
+                'title' => __( 'WordLift', 'wordlift' ),
+            ),
+        )
+    );
 }
 
 /**
@@ -293,19 +293,19 @@ 
  * this has to be removed when removing the legacy fields from the ui.
  */
 function wl_enqueue_leaflet( $in_footer = false ) {
-	// Leaflet.
-	wp_enqueue_style( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.css', array(), '1.6.0' );
-	wp_enqueue_script( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.js', array(), '1.6.0', $in_footer );
+    // Leaflet.
+    wp_enqueue_style( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.css', array(), '1.6.0' );
+    wp_enqueue_script( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.js', array(), '1.6.0', $in_footer );
 }
 
 add_filter( 'block_categories', 'wl_block_categories', 10 );
 
 // Temporary fix for a typo in WooCommerce Extension.
 add_filter(
-	'wl_feature__enable__dataset',
-	function ( $value ) {
-		return apply_filters( 'wl_features__enable__dataset', $value );
-	}
+    'wl_feature__enable__dataset',
+    function ( $value ) {
+        return apply_filters( 'wl_features__enable__dataset', $value );
+    }
 );
 
 require_once __DIR__ . '/modules/food-kg/load.php';
@@ -322,35 +322,35 @@ 
 require_once __DIR__ . '/modules/override-url/load.php';
 
 function _wl_update_plugins_raptive_domain( $update, $plugin_data, $plugin_file ) {
-	// Bail out if it's not our plugin.
-	$update_uri = $plugin_data['UpdateURI'];
-	if ( 'wordlift/wordlift.php' !== $plugin_file || ! isset( $update_uri ) ) {
-		return $update;
-	}
-
-	$response = wp_remote_get( "$update_uri?nocache=" . time() );
-
-	if ( is_wp_error( $response ) ) {
-		return $update;
-	}
-
-	try {
-		return json_decode( wp_remote_retrieve_body( $response ) );
-	} catch ( Exception $e ) {
-		return $update;
-	}
+    // Bail out if it's not our plugin.
+    $update_uri = $plugin_data['UpdateURI'];
+    if ( 'wordlift/wordlift.php' !== $plugin_file || ! isset( $update_uri ) ) {
+        return $update;
+    }
+
+    $response = wp_remote_get( "$update_uri?nocache=" . time() );
+
+    if ( is_wp_error( $response ) ) {
+        return $update;
+    }
+
+    try {
+        return json_decode( wp_remote_retrieve_body( $response ) );
+    } catch ( Exception $e ) {
+        return $update;
+    }
 }
 
 add_action(
-	'update_plugins_adthrive.wordlift.io',
-	'_wl_update_plugins_raptive_domain',
-	10,
-	3
+    'update_plugins_adthrive.wordlift.io',
+    '_wl_update_plugins_raptive_domain',
+    10,
+    3
 );
 
 add_action(
-	'update_plugins_raptive.wordlift.io',
-	'_wl_update_plugins_raptive_domain',
-	10,
-	3
+    'update_plugins_raptive.wordlift.io',
+    '_wl_update_plugins_raptive_domain',
+    10,
+    3
 );

Spacing +73 added lines, -73 removed lines

@@ -31,26 +31,26 @@ 
 use Wordlift\Features\Features_Registry;
 use Wordlift\Post\Post_Adapter;
 
-define( 'WORDLIFT_PLUGIN_FILE', __FILE__ );
-define( 'WORDLIFT_VERSION', '3.52.0-0' );
+define('WORDLIFT_PLUGIN_FILE', __FILE__);
+define('WORDLIFT_VERSION', '3.52.0-0');
 
 // ## DO NOT REMOVE THIS LINE: WHITELABEL PLACEHOLDER ##
 
-require_once plugin_dir_path( __FILE__ ) . '/libraries/action-scheduler/action-scheduler.php';
-require_once __DIR__ . '/modules/common/load.php';
-require_once __DIR__ . '/modules/app/load.php';
-require_once __DIR__ . '/modules/include-exclude/load.php';
+require_once plugin_dir_path(__FILE__).'/libraries/action-scheduler/action-scheduler.php';
+require_once __DIR__.'/modules/common/load.php';
+require_once __DIR__.'/modules/app/load.php';
+require_once __DIR__.'/modules/include-exclude/load.php';
 
 /**
  * Filter to disable WLP on any request, defaults to true.
  *
  * @since 3.33.6
  */
-if ( ! apply_filters( 'wl_is_enabled', true ) ) {
+if ( ! apply_filters('wl_is_enabled', true)) {
 	return;
 }
 
-require_once plugin_dir_path( __FILE__ ) . 'vendor/autoload.php';
+require_once plugin_dir_path(__FILE__).'vendor/autoload.php';
 
 /*
  * We introduce the WordLift autoloader, since we start using classes in namespaces, i.e. Wordlift\Http.
@@ -60,15 +60,15 @@ 
 wordlift_plugin_autoload_register();
 
 // Include WordLift constants.
-require_once plugin_dir_path( __FILE__ ) . 'wordlift-constants.php';
+require_once plugin_dir_path(__FILE__).'wordlift-constants.php';
 
 // Load modules.
-require_once plugin_dir_path( __FILE__ ) . 'modules/core/wordlift-core.php';
+require_once plugin_dir_path(__FILE__).'modules/core/wordlift-core.php';
 
-require_once plugin_dir_path( __FILE__ ) . 'deprecations.php';
+require_once plugin_dir_path(__FILE__).'deprecations.php';
 
 // Load early to enable/disable features.
-require_once plugin_dir_path( __FILE__ ) . 'classes/features/index.php';
+require_once plugin_dir_path(__FILE__).'classes/features/index.php';
 
 /**
  * The code that runs during plugin activation.
@@ -76,11 +76,11 @@ 
  */
 function activate_wordlift() {
 
-	$log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
+	$log = Wordlift_Log_Service::get_logger('activate_wordlift');
 
-	$log->info( 'Activating WordLift...' );
+	$log->info('Activating WordLift...');
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
+	require_once plugin_dir_path(__FILE__).'includes/class-wordlift-activator.php';
 	Wordlift_Activator::activate();
 
 	/**
@@ -100,8 +100,8 @@ 
 	 */
 	Top_Entities::activate();
 
-	if ( ! wp_next_scheduled( 'wl_daily_cron' ) ) {
-		wp_schedule_event( time(), 'daily', 'wl_daily_cron' );
+	if ( ! wp_next_scheduled('wl_daily_cron')) {
+		wp_schedule_event(time(), 'daily', 'wl_daily_cron');
 	}
 
 }
@@ -112,7 +112,7 @@ 
  */
 function deactivate_wordlift() {
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
+	require_once plugin_dir_path(__FILE__).'includes/class-wordlift-deactivator.php';
 	Wordlift_Deactivator::deactivate();
 	Wordlift_Http_Api::deactivate();
 	Ttl_Cache_Cleaner::deactivate();
@@ -128,18 +128,18 @@ 
 	Key_Validation_Notice::remove_notification_flag();
 	flush_rewrite_rules();
 
-	wp_clear_scheduled_hook( 'wl_daily_cron' );
+	wp_clear_scheduled_hook('wl_daily_cron');
 
 }
 
-register_activation_hook( __FILE__, 'activate_wordlift' );
-register_deactivation_hook( __FILE__, 'deactivate_wordlift' );
+register_activation_hook(__FILE__, 'activate_wordlift');
+register_deactivation_hook(__FILE__, 'deactivate_wordlift');
 
 /**
  * The core plugin class that is used to define internationalization,
  * admin-specific hooks, and public-facing site hooks.
  */
-require plugin_dir_path( __FILE__ ) . 'includes/class-wordlift.php';
+require plugin_dir_path(__FILE__).'includes/class-wordlift.php';
 
 /**
  * Begins execution of the plugin.
@@ -159,12 +159,12 @@ 
 	 * @return bool
 	 * @since 3.27.6
 	 */
-	if ( apply_filters( 'wl_feature__enable__widgets', true ) ) {
-		add_action( 'widgets_init', 'wl_register_chord_widget' );
-		add_action( 'widgets_init', 'wl_register_geo_widget' );
-		add_action( 'widgets_init', 'wl_register_timeline_widget' );
+	if (apply_filters('wl_feature__enable__widgets', true)) {
+		add_action('widgets_init', 'wl_register_chord_widget');
+		add_action('widgets_init', 'wl_register_geo_widget');
+		add_action('widgets_init', 'wl_register_timeline_widget');
 	}
-	add_filter( 'widget_text', 'do_shortcode' );
+	add_filter('widget_text', 'do_shortcode');
 
 	/**
 	 * Filter: wl_feature__enable__analysis
@@ -174,10 +174,10 @@ 
 	 * @return bool
 	 * @since 3.27.6
 	 */
-	if ( apply_filters( 'wl_feature__enable__analysis', true ) ) {
-		add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_action' );
+	if (apply_filters('wl_feature__enable__analysis', true)) {
+		add_action('wp_ajax_wl_analyze', 'wl_ajax_analyze_action');
 	} else {
-		add_action( 'wp_ajax_wl_analyze', 'wl_ajax_analyze_disabled_action' );
+		add_action('wp_ajax_wl_analyze', 'wl_ajax_analyze_disabled_action');
 	}
 
 	$plugin = new Wordlift();
@@ -194,7 +194,7 @@ 
 
 	add_action(
 		'plugins_loaded',
-		function () {
+		function() {
 			// All features from registry should be initialized here.
 			$features_registry = Features_Registry::get_instance();
 			$features_registry->initialize_all_features();
@@ -205,27 +205,27 @@ 
 	add_action(
 		'plugins_loaded',
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		function () use ( $plugin ) {
+		function() use ($plugin) {
 
 			new Wordlift_Products_Navigator_Shortcode_REST();
 
 			// Register the Dataset module, requires `$api_service`.
-			require_once plugin_dir_path( __FILE__ ) . 'classes/dataset/index.php';
-			require_once plugin_dir_path( __FILE__ ) . 'classes/shipping-data/index.php';
+			require_once plugin_dir_path(__FILE__).'classes/dataset/index.php';
+			require_once plugin_dir_path(__FILE__).'classes/shipping-data/index.php';
 
 			/*
 			* Require the Entity annotation cleanup module.
 			*
 			* @since 3.34.6
 			*/
-			require_once plugin_dir_path( __FILE__ ) . 'classes/cleanup/index.php';
+			require_once plugin_dir_path(__FILE__).'classes/cleanup/index.php';
 
 			/*
 			* Import LOD entities.
 			*
 			* @since 3.35.0
 			*/
-			require_once plugin_dir_path( __FILE__ ) . 'classes/lod-import/index.php';
+			require_once plugin_dir_path(__FILE__).'classes/lod-import/index.php';
 
 		}
 	);
@@ -243,31 +243,31 @@ 
 function wordlift_plugin_autoload_register() {
 
 	spl_autoload_register(
-		function ( $class_name ) {
+		function($class_name) {
 
 			// Bail out if these are not our classes.
-			if ( 0 !== strpos( $class_name, 'Wordlift\\' ) ) {
+			if (0 !== strpos($class_name, 'Wordlift\\')) {
 				return false;
 			}
 
-			$class_name_lc = strtolower( str_replace( '_', '-', $class_name ) );
+			$class_name_lc = strtolower(str_replace('_', '-', $class_name));
 
-			preg_match( '|^wordlift\\\\(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches );
+			preg_match('|^wordlift\\\\(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches);
 
-			$path = str_replace( '\\', DIRECTORY_SEPARATOR, $matches[1] );
-			$file = 'class-' . $matches[2] . '.php';
+			$path = str_replace('\\', DIRECTORY_SEPARATOR, $matches[1]);
+			$file = 'class-'.$matches[2].'.php';
 
-			$full_path = plugin_dir_path( __FILE__ ) . 'classes' . DIRECTORY_SEPARATOR . $path . DIRECTORY_SEPARATOR . $file;
+			$full_path = plugin_dir_path(__FILE__).'classes'.DIRECTORY_SEPARATOR.$path.DIRECTORY_SEPARATOR.$file;
 
-			if ( ! file_exists( $full_path ) ) {
+			if ( ! file_exists($full_path)) {
 				return false;
 			}
 
 			try {
 				require_once $full_path;
-			} catch ( Exception $e ) {
+			} catch (Exception $e) {
 				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
-				error_log( "[WordLift] $full_path not found, cannot include." );
+				error_log("[WordLift] $full_path not found, cannot include.");
 			}
 
 			return true;
@@ -276,13 +276,13 @@ 
 
 }
 
-function wl_block_categories( $categories ) {
+function wl_block_categories($categories) {
 	return array_merge(
 		$categories,
 		array(
 			array(
 				'slug'  => 'wordlift',
-				'title' => __( 'WordLift', 'wordlift' ),
+				'title' => __('WordLift', 'wordlift'),
 			),
 		)
 	);
@@ -292,51 +292,51 @@ 
  * This function is created temporarily to handle the legacy library,
  * this has to be removed when removing the legacy fields from the ui.
  */
-function wl_enqueue_leaflet( $in_footer = false ) {
+function wl_enqueue_leaflet($in_footer = false) {
 	// Leaflet.
-	wp_enqueue_style( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.css', array(), '1.6.0' );
-	wp_enqueue_script( 'wl-leaflet', plugin_dir_url( __FILE__ ) . 'js/leaflet/leaflet.js', array(), '1.6.0', $in_footer );
+	wp_enqueue_style('wl-leaflet', plugin_dir_url(__FILE__).'js/leaflet/leaflet.css', array(), '1.6.0');
+	wp_enqueue_script('wl-leaflet', plugin_dir_url(__FILE__).'js/leaflet/leaflet.js', array(), '1.6.0', $in_footer);
 }
 
-add_filter( 'block_categories', 'wl_block_categories', 10 );
+add_filter('block_categories', 'wl_block_categories', 10);
 
 // Temporary fix for a typo in WooCommerce Extension.
 add_filter(
 	'wl_feature__enable__dataset',
-	function ( $value ) {
-		return apply_filters( 'wl_features__enable__dataset', $value );
+	function($value) {
+		return apply_filters('wl_features__enable__dataset', $value);
 	}
 );
 
-require_once __DIR__ . '/modules/food-kg/load.php';
-require_once __DIR__ . '/modules/gardening-kg/load.php';
-require_once __DIR__ . '/modules/acf4so/load.php';
-require_once __DIR__ . '/modules/dashboard/load.php';
-require_once __DIR__ . '/modules/pods/load.php';
-require_once __DIR__ . '/modules/include-exclude-push-config/load.php';
-require_once __DIR__ . '/modules/super-resolution/load.php';
-require_once __DIR__ . '/modules/redeem-code/load.php';
-require_once __DIR__ . '/modules/raptive-setup/load.php';
-require_once __DIR__ . '/modules/events/load.php';
-require_once __DIR__ . '/modules/plugin-diagnostics/load.php';
-require_once __DIR__ . '/modules/override-url/load.php';
-
-function _wl_update_plugins_raptive_domain( $update, $plugin_data, $plugin_file ) {
+require_once __DIR__.'/modules/food-kg/load.php';
+require_once __DIR__.'/modules/gardening-kg/load.php';
+require_once __DIR__.'/modules/acf4so/load.php';
+require_once __DIR__.'/modules/dashboard/load.php';
+require_once __DIR__.'/modules/pods/load.php';
+require_once __DIR__.'/modules/include-exclude-push-config/load.php';
+require_once __DIR__.'/modules/super-resolution/load.php';
+require_once __DIR__.'/modules/redeem-code/load.php';
+require_once __DIR__.'/modules/raptive-setup/load.php';
+require_once __DIR__.'/modules/events/load.php';
+require_once __DIR__.'/modules/plugin-diagnostics/load.php';
+require_once __DIR__.'/modules/override-url/load.php';
+
+function _wl_update_plugins_raptive_domain($update, $plugin_data, $plugin_file) {
 	// Bail out if it's not our plugin.
 	$update_uri = $plugin_data['UpdateURI'];
-	if ( 'wordlift/wordlift.php' !== $plugin_file || ! isset( $update_uri ) ) {
+	if ('wordlift/wordlift.php' !== $plugin_file || ! isset($update_uri)) {
 		return $update;
 	}
 
-	$response = wp_remote_get( "$update_uri?nocache=" . time() );
+	$response = wp_remote_get("$update_uri?nocache=".time());
 
-	if ( is_wp_error( $response ) ) {
+	if (is_wp_error($response)) {
 		return $update;
 	}
 
 	try {
-		return json_decode( wp_remote_retrieve_body( $response ) );
-	} catch ( Exception $e ) {
+		return json_decode(wp_remote_retrieve_body($response));
+	} catch (Exception $e) {
 		return $update;
 	}
 }