insideout10 / wordlift-plugin

src/wordlift/vocabulary/class-terms-compat.php

Indentation +12 added lines, -12 removed lines

@@ -3,20 +3,20 @@
 
 class Terms_Compat {
 
-	public static function get_terms( $taxonomy, $args ) {
-		global $wp_version;
+    public static function get_terms( $taxonomy, $args ) {
+        global $wp_version;
 
-		if ( version_compare( $wp_version, '4.5', '<' ) ) {
-			return get_terms( $taxonomy, $args );
-		} else {
-			$args['taxonomy'] = $taxonomy;
-			return get_terms( $args );
-		}
-	}
+        if ( version_compare( $wp_version, '4.5', '<' ) ) {
+            return get_terms( $taxonomy, $args );
+        } else {
+            $args['taxonomy'] = $taxonomy;
+            return get_terms( $args );
+        }
+    }
 
-	public static function get_public_taxonomies() {
-		return get_taxonomies( array( 'public' => true ) );
-	}
+    public static function get_public_taxonomies() {
+        return get_taxonomies( array( 'public' => true ) );
+    }
 
 
 }
\ No newline at end of file

Spacing +5 added lines, -5 removed lines

@@ -3,19 +3,19 @@
 
 class Terms_Compat {
 
-	public static function get_terms( $taxonomy, $args ) {
+	public static function get_terms($taxonomy, $args) {
 		global $wp_version;
 
-		if ( version_compare( $wp_version, '4.5', '<' ) ) {
-			return get_terms( $taxonomy, $args );
+		if (version_compare($wp_version, '4.5', '<')) {
+			return get_terms($taxonomy, $args);
 		} else {
 			$args['taxonomy'] = $taxonomy;
-			return get_terms( $args );
+			return get_terms($args);
 		}
 	}
 
 	public static function get_public_taxonomies() {
-		return get_taxonomies( array( 'public' => true ) );
+		return get_taxonomies(array('public' => true));
 	}
 
 

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

Indentation +712 added lines, -712 removed lines

@@ -13,7 +13,7 @@ 
 use Wordlift\Api\Default_Api_Service;
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -23,720 +23,720 @@ 
  */
 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';
-
-	/**
-	 * 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 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 {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var \Wordlift_Log_Service $log The {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * 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;
-
-	/**
-	 * Create a Wordlift_Configuration_Service's instance.
-	 *
-	 * @since 3.6.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @return \Wordlift_Configuration_Service
-	 * @since 3.6.0
-	 *
-	 */
-	public static function get_instance() {
-
-		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() {
-
-		return $this->get( 'wl_general_settings', self::LANGUAGE, 'en' );
-	}
-
-	/**
-	 * Set WordLift's language code, used when storing strings to the Linked Data dataset.
-	 *
-	 * @param string $value WordLift's language code.
-	 *
-	 * @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 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_features__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'] ) ? $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 );
-
-	}
-
-	/**
-	 * 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 ) ) {
-				$this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
-			} else {
-				$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';
+
+    /**
+     * 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 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 {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var \Wordlift_Log_Service $log The {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * 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;
+
+    /**
+     * Create a Wordlift_Configuration_Service's instance.
+     *
+     * @since 3.6.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance.
+     *
+     * @return \Wordlift_Configuration_Service
+     * @since 3.6.0
+     *
+     */
+    public static function get_instance() {
+
+        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() {
+
+        return $this->get( 'wl_general_settings', self::LANGUAGE, 'en' );
+    }
+
+    /**
+     * Set WordLift's language code, used when storing strings to the Linked Data dataset.
+     *
+     * @param string $value WordLift's language code.
+     *
+     * @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 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_features__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'] ) ? $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 );
+
+    }
+
+    /**
+     * 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 ) ) {
+                $this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
+            } else {
+                $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.
-		 */
-		$dataset_uri  = untrailingslashit( $json->datasetURI );
-		$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
-	 *
-	 */
-	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'] ) ? $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;
-	}
+        $json = json_decode( $response['body'] );
+        /**
+         * @since 3.27.7
+         * Remove the trailing slash returned from the new platform api.
+         */
+        $dataset_uri  = untrailingslashit( $json->datasetURI );
+        $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
+     *
+     */
+    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'] ) ? $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;
+    }
 
 }

Spacing +90 added lines, -90 removed lines

@@ -12,7 +12,7 @@ 
 
 use Wordlift\Api\Default_Api_Service;
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -140,7 +140,7 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		self::$instance = $this;
 
@@ -170,11 +170,11 @@ 
 	 * @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;
 	}
 
 	/**
@@ -187,12 +187,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);
 
 	}
 
@@ -205,7 +205,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');
 	}
 
 	/**
@@ -216,9 +216,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);
 
 	}
 
@@ -231,7 +231,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);
 	}
 
 	/**
@@ -242,9 +242,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);
 
 	}
 
@@ -257,7 +257,7 @@ 
 	 */
 	public function get_key() {
 
-		return $this->get( 'wl_general_settings', self::KEY, '' );
+		return $this->get('wl_general_settings', self::KEY, '');
 	}
 
 	/**
@@ -268,9 +268,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);
 	}
 
 	/**
@@ -284,7 +284,7 @@ 
 	 */
 	public function get_language_code() {
 
-		return $this->get( 'wl_general_settings', self::LANGUAGE, 'en' );
+		return $this->get('wl_general_settings', self::LANGUAGE, 'en');
 	}
 
 	/**
@@ -295,9 +295,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);
 
 	}
 
@@ -309,9 +309,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);
 
 	}
 
@@ -322,7 +322,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');
 	}
 
 	/**
@@ -334,7 +334,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');
 	}
 
 	/**
@@ -345,9 +345,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);
 
 	}
 
@@ -363,7 +363,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);
 	}
 
 	/**
@@ -374,9 +374,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);
 
 	}
 
@@ -390,8 +390,8 @@ 
 	 */
 	public function get_dataset_uri() {
 
-		if ( apply_filters( 'wl_features__enable__dataset', true ) ) {
-			return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
+		if (apply_filters('wl_features__enable__dataset', true)) {
+			return $this->get('wl_advanced_settings', self::DATASET_URI, null);
 		} else {
 			return null;
 		}
@@ -405,9 +405,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);
 	}
 
 	/**
@@ -419,7 +419,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);
 	}
 
 	/**
@@ -430,8 +430,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);
 	}
 
 	/**
@@ -447,11 +447,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'] ) ? $new_value['key'] : '';
+		$new_key = isset($new_value['key']) ? $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.
@@ -460,12 +460,12 @@ 
 		//		}
 
 		// 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);
 
 	}
 
@@ -481,15 +481,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;
 		}
@@ -504,15 +504,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();
 		/**
@@ -522,31 +522,31 @@ 
 		$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 ) ) {
-				$this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
+			if ( ! is_array($response)) {
+				$this->log->error("Unexpected response when opening URL $base_url$url: ".var_export($response, true));
 			} else {
-				$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;
 		}
@@ -556,18 +556,18 @@ 
 		 *
 		 * @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.
 		 */
-		$dataset_uri  = untrailingslashit( $json->datasetURI );
-		$package_type = isset( $json->packageType ) ? $json->packageType : null;
+		$dataset_uri  = untrailingslashit($json->datasetURI);
+		$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);
 	}
 
 	/**
@@ -585,20 +585,20 @@ 
 	 * @since 3.12.0
 	 *
 	 */
-	function maybe_update_dataset_uri( $value, $old_value ) {
+	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'] ) ? $value['key'] : '';
+		$old_key = isset($old_value['key']) ? $old_value['key'] : '';
+		$new_key = isset($value['key']) ? $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;
@@ -613,9 +613,9 @@ 
 	 * @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";
 	}
 
 	/**
@@ -627,7 +627,7 @@ 
 	 */
 	public function get_accounts() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'accounts';
 	}
 
 	/**
@@ -639,7 +639,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');
 	}
 
 	/**
@@ -650,9 +650,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');
 	}
 
 	/**
@@ -663,7 +663,7 @@ 
 	 *
 	 */
 	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');
 	}
 
 	/**
@@ -674,9 +674,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');
 	}
 
 	/**
@@ -687,7 +687,7 @@ 
 	 *
 	 */
 	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);
 	}
 
 	/**
@@ -698,7 +698,7 @@ 
 	 *
 	 */
 	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);
 	}
 
 	/**
@@ -710,7 +710,7 @@ 
 	 */
 	public function get_autocomplete_url() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'autocomplete';
 
 	}
 
@@ -723,7 +723,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';
 
 	}
 

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

Indentation +428 added lines, -428 removed lines

@@ -18,433 +18,433 @@
  */
 class Wordlift_Admin_Settings_Page extends Wordlift_Admin_Page {
 
-	/**
-	 * A singleton instance of the Notice service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_Notice_Service $instance A singleton instance of the Notice service.
-	 */
-	private static $instance;
-
-	/**
-	 * 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_Configuration_Service} instance.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_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_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} 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
-	 *
-	 */
-	function __construct( $configuration_service, $entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element ) {
-
-		$this->configuration_service = $configuration_service;
-		$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;
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * 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() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_parent_slug() {
-
-		return 'wl_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_capability() {
-
-		return 'manage_options';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_page_title() {
-
-		return 'WordLift Settings';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_menu_title() {
-
-		return 'Settings';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function get_menu_slug() {
-
-		return 'wl_configuration_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	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( dirname( __FILE__ ) ) . 'admin/js/1/settings.js', array( 'wp-util' ) );
-		wp_enqueue_style( 'wordlift-admin-settings-page', plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/settings.css' );
-
-	}
-
-	/**
-	 * Configure all the configuration parameters.
-	 *
-	 * Called by the *admin_init* hook.
-	 *
-	 * @since 3.11.0
-	 */
-	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'       => $this->configuration_service->get_key(),
-			'description' => __( 'Insert the <a href="https://www.wordlift.io/blogger">WordLift Key</a> you received via email.', 'wordlift' )
-			                 . ' [' . 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'       => $this->configuration_service->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 `language_name` field.
-		add_settings_field(
-			'wl-site-language',
-			__( 'Site Language', 'wordlift' ),
-			array( $this->language_select_element, 'render' ),
-			'wl_general_settings',
-			'wl_general_settings_section',
-			array(
-				// The array of arguments to pass to the callback. In this case, just a description.
-				'id'          => 'wl-site-language',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LANGUAGE . ']',
-				'value'       => $this->configuration_service->get_language_code(),
-				'description' => __( 'Each WordLift Key can be used only in one language. Pick yours.', 'wordlift' ),
-			)
-		);
-
-		// Add the `country_code` field.
-		add_settings_field(
-			'wl-country-code',
-			_x( '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'       => $this->configuration_service->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 `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'       => $this->configuration_service->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' === $this->configuration_service->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
-	 *
-	 */
-	function sanitize_callback( $input ) {
-
-		// Validate the selected country.
-		$this->validate_country();
-
-		// Check whether a publisher name has been set.
-		if ( isset( $_POST['wl_publisher'] ) && ! empty( $_POST['wl_publisher']['name'] ) ) { // WPCS: CSRF, input var, sanitization ok.
-			$name         = $_POST['wl_publisher']['name']; // WPCS: CSRF, input var, sanitization ok.
-			$type         = $_POST['wl_publisher']['type']; // WPCS: CSRF, input var, sanitization ok.
-			$thumbnail_id = $_POST['wl_publisher']['thumbnail_id'] ?: null; // WPCS: CSRF, input var, sanitization ok.
-
-			// 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;
-	}
-
-	/**
-	 * Check whether the currently selected country supports the site language.
-	 *
-	 * @since 3.18.0
-	 */
-	private function validate_country() {
-
-		// Bail out if for some reason the country and language are not set.
-		if (
-			empty( $_POST['wl_general_settings']['site_language'] ) && // WPCS: CSRF, input var, sanitization ok.
-			empty( $_POST['wl_general_settings']['country_code'] ) // WPCS: CSRF, input var, sanitization ok.
-		) {
-			return;
-		}
-
-		// Get the values.
-		$language = $_POST['wl_general_settings']['site_language']; // WPCS: CSRF, input var, sanitization ok.
-		$country  = $_POST['wl_general_settings']['country_code']; // WPCS: CSRF, input var, sanitization ok.
-		$codes    = Wordlift_Countries::get_codes();
-
-		// Check whether the chosen country has language limitations
-		// and whether the chosen language is supported for that country.
-		if (
-			! empty( $codes[ $country ] ) &&
-			! in_array( $language, $codes[ $country ] )
-		) {
-			// Otherwise add an error.
-			add_settings_error(
-				'wl-country-code',
-				esc_attr( 'settings_updated' ),
-				_x( 'The selected language is not supported for the currently chosen country. Please choose another country or language.', 'wordlift' )
-			);
-		}
-	}
+    /**
+     * A singleton instance of the Notice service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_Notice_Service $instance A singleton instance of the Notice service.
+     */
+    private static $instance;
+
+    /**
+     * 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_Configuration_Service} instance.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_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_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} 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
+     *
+     */
+    function __construct( $configuration_service, $entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element ) {
+
+        $this->configuration_service = $configuration_service;
+        $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;
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * 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() {
+
+        return self::$instance;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_parent_slug() {
+
+        return 'wl_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_capability() {
+
+        return 'manage_options';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_page_title() {
+
+        return 'WordLift Settings';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_menu_title() {
+
+        return 'Settings';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function get_menu_slug() {
+
+        return 'wl_configuration_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    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( dirname( __FILE__ ) ) . 'admin/js/1/settings.js', array( 'wp-util' ) );
+        wp_enqueue_style( 'wordlift-admin-settings-page', plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/settings.css' );
+
+    }
+
+    /**
+     * Configure all the configuration parameters.
+     *
+     * Called by the *admin_init* hook.
+     *
+     * @since 3.11.0
+     */
+    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'       => $this->configuration_service->get_key(),
+            'description' => __( 'Insert the <a href="https://www.wordlift.io/blogger">WordLift Key</a> you received via email.', 'wordlift' )
+                                . ' [' . 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'       => $this->configuration_service->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 `language_name` field.
+        add_settings_field(
+            'wl-site-language',
+            __( 'Site Language', 'wordlift' ),
+            array( $this->language_select_element, 'render' ),
+            'wl_general_settings',
+            'wl_general_settings_section',
+            array(
+                // The array of arguments to pass to the callback. In this case, just a description.
+                'id'          => 'wl-site-language',
+                'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LANGUAGE . ']',
+                'value'       => $this->configuration_service->get_language_code(),
+                'description' => __( 'Each WordLift Key can be used only in one language. Pick yours.', 'wordlift' ),
+            )
+        );
+
+        // Add the `country_code` field.
+        add_settings_field(
+            'wl-country-code',
+            _x( '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'       => $this->configuration_service->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 `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'       => $this->configuration_service->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' === $this->configuration_service->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
+     *
+     */
+    function sanitize_callback( $input ) {
+
+        // Validate the selected country.
+        $this->validate_country();
+
+        // Check whether a publisher name has been set.
+        if ( isset( $_POST['wl_publisher'] ) && ! empty( $_POST['wl_publisher']['name'] ) ) { // WPCS: CSRF, input var, sanitization ok.
+            $name         = $_POST['wl_publisher']['name']; // WPCS: CSRF, input var, sanitization ok.
+            $type         = $_POST['wl_publisher']['type']; // WPCS: CSRF, input var, sanitization ok.
+            $thumbnail_id = $_POST['wl_publisher']['thumbnail_id'] ?: null; // WPCS: CSRF, input var, sanitization ok.
+
+            // 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;
+    }
+
+    /**
+     * Check whether the currently selected country supports the site language.
+     *
+     * @since 3.18.0
+     */
+    private function validate_country() {
+
+        // Bail out if for some reason the country and language are not set.
+        if (
+            empty( $_POST['wl_general_settings']['site_language'] ) && // WPCS: CSRF, input var, sanitization ok.
+            empty( $_POST['wl_general_settings']['country_code'] ) // WPCS: CSRF, input var, sanitization ok.
+        ) {
+            return;
+        }
+
+        // Get the values.
+        $language = $_POST['wl_general_settings']['site_language']; // WPCS: CSRF, input var, sanitization ok.
+        $country  = $_POST['wl_general_settings']['country_code']; // WPCS: CSRF, input var, sanitization ok.
+        $codes    = Wordlift_Countries::get_codes();
+
+        // Check whether the chosen country has language limitations
+        // and whether the chosen language is supported for that country.
+        if (
+            ! empty( $codes[ $country ] ) &&
+            ! in_array( $language, $codes[ $country ] )
+        ) {
+            // Otherwise add an error.
+            add_settings_error(
+                'wl-country-code',
+                esc_attr( 'settings_updated' ),
+                _x( 'The selected language is not supported for the currently chosen country. Please choose another country or language.', 'wordlift' )
+            );
+        }
+    }
 
 }

Spacing +55 added lines, -55 removed lines

@@ -104,7 +104,7 @@ 
 	 * @since 3.11.0
 	 *
 	 */
-	function __construct( $configuration_service, $entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element ) {
+	function __construct($configuration_service, $entity_service, $input_element, $language_select_element, $country_select_element, $publisher_element, $radio_input_element) {
 
 		$this->configuration_service = $configuration_service;
 		$this->entity_service        = $entity_service;
@@ -189,8 +189,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( dirname( __FILE__ ) ) . 'admin/js/1/settings.js', array( 'wp-util' ) );
-		wp_enqueue_style( 'wordlift-admin-settings-page', plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/settings.css' );
+		wp_enqueue_script('wordlift-admin-settings-page', plugin_dir_url(dirname(__FILE__)).'admin/js/1/settings.js', array('wp-util'));
+		wp_enqueue_style('wordlift-admin-settings-page', plugin_dir_url(dirname(__FILE__)).'admin/js/1/settings.css');
 
 	}
 
@@ -207,23 +207,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'       => $this->configuration_service->get_key(),
-			'description' => __( 'Insert the <a href="https://www.wordlift.io/blogger">WordLift Key</a> you received via email.', 'wordlift' )
-			                 . ' [' . get_option( 'home' ) . ']',
+			'description' => __('Insert the <a href="https://www.wordlift.io/blogger">WordLift Key</a> you received via email.', 'wordlift')
+			                 . ' ['.get_option('home').']',
 		);
 
 		// Before we were used to validate the key beforehand, but this means
@@ -236,12 +236,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.
 		);
 
@@ -249,10 +249,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'       => $this->configuration_service->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
@@ -261,94 +261,94 @@ 
 		//
 		// 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(
+		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
+			'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 `language_name` field.
 		add_settings_field(
 			'wl-site-language',
-			__( 'Site Language', 'wordlift' ),
-			array( $this->language_select_element, 'render' ),
+			__('Site Language', 'wordlift'),
+			array($this->language_select_element, 'render'),
 			'wl_general_settings',
 			'wl_general_settings_section',
 			array(
 				// The array of arguments to pass to the callback. In this case, just a description.
 				'id'          => 'wl-site-language',
-				'name'        => 'wl_general_settings[' . Wordlift_Configuration_Service::LANGUAGE . ']',
+				'name'        => 'wl_general_settings['.Wordlift_Configuration_Service::LANGUAGE.']',
 				'value'       => $this->configuration_service->get_language_code(),
-				'description' => __( 'Each WordLift Key can be used only in one language. Pick yours.', 'wordlift' ),
+				'description' => __('Each WordLift Key can be used only in one language. Pick yours.', 'wordlift'),
 			)
 		);
 
 		// Add the `country_code` field.
 		add_settings_field(
 			'wl-country-code',
-			_x( 'Country', 'wordlift' ),
-			array( $this->country_select_element, 'render' ),
+			_x('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'       => $this->configuration_service->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 `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'       => $this->configuration_service->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' === $this->configuration_service->get_diagnostic_preferences() ? 'yes' : 'no',
-				'description' => __( 'Whether to send diagnostic data or not.', 'wordlift' ),
+				'description' => __('Whether to send diagnostic data or not.', 'wordlift'),
 			)
 		);
 
@@ -364,10 +364,10 @@ 
 	 * @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;
 		}
 
@@ -390,23 +390,23 @@ 
 	 * @since 3.11.0
 	 *
 	 */
-	function sanitize_callback( $input ) {
+	function sanitize_callback($input) {
 
 		// Validate the selected country.
 		$this->validate_country();
 
 		// Check whether a publisher name has been set.
-		if ( isset( $_POST['wl_publisher'] ) && ! empty( $_POST['wl_publisher']['name'] ) ) { // WPCS: CSRF, input var, sanitization ok.
+		if (isset($_POST['wl_publisher']) && ! empty($_POST['wl_publisher']['name'])) { // WPCS: CSRF, input var, sanitization ok.
 			$name         = $_POST['wl_publisher']['name']; // WPCS: CSRF, input var, sanitization ok.
 			$type         = $_POST['wl_publisher']['type']; // WPCS: CSRF, input var, sanitization ok.
 			$thumbnail_id = $_POST['wl_publisher']['thumbnail_id'] ?: null; // WPCS: CSRF, input var, sanitization ok.
 
 			// 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;
@@ -421,8 +421,8 @@ 
 
 		// Bail out if for some reason the country and language are not set.
 		if (
-			empty( $_POST['wl_general_settings']['site_language'] ) && // WPCS: CSRF, input var, sanitization ok.
-			empty( $_POST['wl_general_settings']['country_code'] ) // WPCS: CSRF, input var, sanitization ok.
+			empty($_POST['wl_general_settings']['site_language']) && // WPCS: CSRF, input var, sanitization ok.
+			empty($_POST['wl_general_settings']['country_code']) // WPCS: CSRF, input var, sanitization ok.
 		) {
 			return;
 		}
@@ -435,14 +435,14 @@ 
 		// Check whether the chosen country has language limitations
 		// and whether the chosen language is supported for that country.
 		if (
-			! empty( $codes[ $country ] ) &&
-			! in_array( $language, $codes[ $country ] )
+			! empty($codes[$country]) &&
+			! in_array($language, $codes[$country])
 		) {
 			// Otherwise add an error.
 			add_settings_error(
 				'wl-country-code',
-				esc_attr( 'settings_updated' ),
-				_x( 'The selected language is not supported for the currently chosen country. Please choose another country or language.', 'wordlift' )
+				esc_attr('settings_updated'),
+				_x('The selected language is not supported for the currently chosen country. Please choose another country or language.', 'wordlift')
 			);
 		}
 	}

src/admin/class-wordlift-admin-setup.php

Indentation +270 added lines, -270 removed lines

@@ -13,7 +13,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -28,140 +28,140 @@ 
  */
 class Wordlift_Admin_Setup {
 
-	/**
-	 * A {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.9.0
-	 * @access private
-	 * @var Wordlift_Configuration_Service A {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * A {@link Wordlift_Key_Validation_Service} instance.
-	 *
-	 * @since  3.9.0
-	 * @access private
-	 * @var Wordlift_Key_Validation_Service A {@link Wordlift_Key_Validation_Service} instance.
-	 */
-	private $key_validation_service;
-
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.9.0
-	 * @access private
-	 * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 *
-	 * @since  3.20.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.20.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;
-
-	/**
-	 * Initialize the class and set its properties.
-	 *
-	 * @param \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
-	 * @param \Wordlift_Key_Validation_Service $key_validation_service A {@link Wordlift_Key_Validation_Service} instance.
-	 * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @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.
-	 *
-	 * @since    3.9.0
-	 *
-	 */
-	public function __construct( $configuration_service, $key_validation_service, $entity_service, $language_select_element, $country_select_element ) {
-
-		// Set a reference to the configuration service.
-		$this->configuration_service = $configuration_service;
-
-		// Set a reference to the key validation service.
-		$this->key_validation_service = $key_validation_service;
-
-		// Set a reference to the entity service.
-		$this->entity_service = $entity_service;
-
-		// Set a reference to the UI elements language and country.
-		$this->language_select_element = $language_select_element;
-		$this->country_select_element  = $country_select_element;
-
-		// Hook to some WP's events:
-		// When WP is loaded check whether the user decided to skip the set-up, i.e. don't show us even if WL is not set up.
-		add_action( 'wp_loaded', array( $this, 'hide_notices' ) );
-
-		// Hook to `admin_menu` in order to add our own setup wizard page.
-		add_action( 'admin_menu', array( $this, 'admin_menu' ) );
-
-		// Triggered when the user accesses the admin area, we decide whether to show our own wizard.
-		add_action( 'admin_init', array( $this, 'show_page' ) );
-
-		/**
-		 * Filter: wl_feature__enable__notices.
-		 *
-		 * @param bool whether the notices needs to be enabled or not.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			// Hook to `admin_notices` to display our notices.
-			add_action( 'admin_notices', array( $this, 'admin_notices' ) );
-		}
-	}
-
-	/**
-	 * Hook to `admin_init` and redirect to WordLift's setup page if the `_wl_activation_redirect` transient flag is set.
-	 *
-	 * @since 3.9.0
-	 */
-	public function admin_init() {
-
-		// If the `_wl_activation_redirect` is set, the redirect to the setup page.
-		if ( get_transient( '_wl_activation_redirect' ) ) {
-			delete_transient( '_wl_activation_redirect' );
-
-			// If the user asked to skip the wizard then comply.
-			if ( $this->configuration_service->is_skip_wizard() ) {
-				return;
-			}
-
-			// If we're already on the page or the user doesn't have permissions, return.
-			if ( ( ! empty( $_GET['page'] ) && 'wl-setup' === $_GET['page'] ) || is_network_admin() || isset( $_GET['activate-multi'] ) || ! current_user_can( 'manage_options' ) ) {
-				return;
-			}
-
-			// Finally redirect to the setup page.
-			wp_safe_redirect( admin_url( 'index.php?page=wl-setup' ) );
-
-			exit;
-		}
-
-	}
-
-	/**
-	 * Generate an admin notice suggesting to start the wizard if there is no configuration.
-	 *
-	 * @since    3.9.0
-	 */
-	public function admin_notices() {
-
-		// Use `wl_configuration_get_key` to check whether WL's key is set and that the user didn't disable the wizard.
-		if ( '' === $this->configuration_service->get_key() && ! $this->configuration_service->is_skip_wizard() ) { ?>
+    /**
+     * A {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.9.0
+     * @access private
+     * @var Wordlift_Configuration_Service A {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * A {@link Wordlift_Key_Validation_Service} instance.
+     *
+     * @since  3.9.0
+     * @access private
+     * @var Wordlift_Key_Validation_Service A {@link Wordlift_Key_Validation_Service} instance.
+     */
+    private $key_validation_service;
+
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.9.0
+     * @access private
+     * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     *
+     * @since  3.20.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.20.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;
+
+    /**
+     * Initialize the class and set its properties.
+     *
+     * @param \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
+     * @param \Wordlift_Key_Validation_Service $key_validation_service A {@link Wordlift_Key_Validation_Service} instance.
+     * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @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.
+     *
+     * @since    3.9.0
+     *
+     */
+    public function __construct( $configuration_service, $key_validation_service, $entity_service, $language_select_element, $country_select_element ) {
+
+        // Set a reference to the configuration service.
+        $this->configuration_service = $configuration_service;
+
+        // Set a reference to the key validation service.
+        $this->key_validation_service = $key_validation_service;
+
+        // Set a reference to the entity service.
+        $this->entity_service = $entity_service;
+
+        // Set a reference to the UI elements language and country.
+        $this->language_select_element = $language_select_element;
+        $this->country_select_element  = $country_select_element;
+
+        // Hook to some WP's events:
+        // When WP is loaded check whether the user decided to skip the set-up, i.e. don't show us even if WL is not set up.
+        add_action( 'wp_loaded', array( $this, 'hide_notices' ) );
+
+        // Hook to `admin_menu` in order to add our own setup wizard page.
+        add_action( 'admin_menu', array( $this, 'admin_menu' ) );
+
+        // Triggered when the user accesses the admin area, we decide whether to show our own wizard.
+        add_action( 'admin_init', array( $this, 'show_page' ) );
+
+        /**
+         * Filter: wl_feature__enable__notices.
+         *
+         * @param bool whether the notices needs to be enabled or not.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+            // Hook to `admin_notices` to display our notices.
+            add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+        }
+    }
+
+    /**
+     * Hook to `admin_init` and redirect to WordLift's setup page if the `_wl_activation_redirect` transient flag is set.
+     *
+     * @since 3.9.0
+     */
+    public function admin_init() {
+
+        // If the `_wl_activation_redirect` is set, the redirect to the setup page.
+        if ( get_transient( '_wl_activation_redirect' ) ) {
+            delete_transient( '_wl_activation_redirect' );
+
+            // If the user asked to skip the wizard then comply.
+            if ( $this->configuration_service->is_skip_wizard() ) {
+                return;
+            }
+
+            // If we're already on the page or the user doesn't have permissions, return.
+            if ( ( ! empty( $_GET['page'] ) && 'wl-setup' === $_GET['page'] ) || is_network_admin() || isset( $_GET['activate-multi'] ) || ! current_user_can( 'manage_options' ) ) {
+                return;
+            }
+
+            // Finally redirect to the setup page.
+            wp_safe_redirect( admin_url( 'index.php?page=wl-setup' ) );
+
+            exit;
+        }
+
+    }
+
+    /**
+     * Generate an admin notice suggesting to start the wizard if there is no configuration.
+     *
+     * @since    3.9.0
+     */
+    public function admin_notices() {
+
+        // Use `wl_configuration_get_key` to check whether WL's key is set and that the user didn't disable the wizard.
+        if ( '' === $this->configuration_service->get_key() && ! $this->configuration_service->is_skip_wizard() ) { ?>
             <div id="wl-message" class="updated">
                 <p><?php esc_html_e( 'Welcome to WordLift &#8211; You&lsquo;re almost ready to start', 'wordlift' ); ?></p>
                 <p class="submit">
@@ -173,140 +173,140 @@ 
             </div>
 		<?php }
 
-	}
-
-	/**
-	 * Handle hiding the wizard notices by user request.
-	 *
-	 * @since    3.9.0
-	 */
-	public function hide_notices() {
-
-		// If it's not a `wl-hide-notice` or the nonce is not set, return.
-		if ( ! isset( $_GET['wl-hide-notice'], $_GET['_wl_notice_nonce'] ) ) {
-			return;
-		}
-
-		// If the nonce is invalid, return an error.
-		if ( ! wp_verify_nonce( $_GET['_wl_notice_nonce'], 'wordlift_hide_notices_nonce' ) ) {
-			wp_die( __( 'Action failed. Please refresh the page and retry.', 'wordlift' ) );
-		}
-
-		// If the user doesn't have the right privileges, return an error.
-		if ( ! current_user_can( 'manage_options' ) ) {
-			wp_die( __( 'Cheatin&#8217; huh?', 'wordlift' ) );
-		}
-
-		// Store a flag telling to skip the wizard.
-		$this->configuration_service->set_skip_wizard( true );
-
-	}
-
-	/**
-	 * Register the wizard page to be able to access it.
-	 *
-	 * @since    3.9.0
-	 */
-	public function admin_menu() {
-		/**
-		 *
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/1209
-		 * @since 3.27.7
-		 */
-		// @todo: find another way to do this, since this is adding an empty space in WP's dashboard menu.
-		add_dashboard_page( '', '', 'manage_options', 'wl-setup', '' );
-	}
-
-	/**
-	 * Displays the wizard page.
-	 *
-	 * @since    3.9.0
-	 */
-	public function show_page() {
-
-		// First check if we are in the wizard page at all, if not do nothing.
-		if ( empty( $_GET['page'] ) || 'wl-setup' !== $_GET['page'] ) {
-			return;
-		}
-
-		// If it's a POST and the `wl-save-configuration` action is set, save the configuration.
-		if ( isset( $_POST['action'] ) && 'wl-save-configuration' === $_POST['action'] ) {
-
-			// Check the nonce and the user capabilities.
-			check_admin_referer( 'wl-save-configuration' );
-
-			// Check if the user has the right privileges.
-			if ( ! current_user_can( 'manage_options' ) ) {
-				wp_die( __( 'Sorry, you do not have a permission to save the settings', 'wordlift' ) );
-			}
-
-			// Save the configuration.
-			$this->save_configuration( $_POST );
-
-			// Redirect to the admin's page.
-			wp_redirect( admin_url() );
-
-			exit;
-		}
-
-		$language_select = $this->language_select_element;
-		$country_select  = $this->country_select_element;
-
-		include plugin_dir_path( dirname( __FILE__ ) ) . 'admin/partials/wordlift-admin-setup.php';
-
-		exit;
-	}
-
-	/**
-	 * Save WordLift's configuration using the provided parameters.
-	 *
-	 * @param array $params An array of configuration parameters.
-	 *
-	 * @since 3.9.0
-	 *
-	 */
-	public function save_configuration( $params ) {
-
-		// We have the following parameters:
-		// `key`, holding WL's key,
-		// `vocabulary`, holding the vocabulary path,
-		// `wl-site-language`, with the language code (e.g. `en`),
-		// `wl-country-code` with the country code (e.g. `us`),
-		// `share-diagnostic`, the user preferences about sharing data with us.
-		// `user_type`, the user type either `personal` or `company`,
-		// `name`, with the `personal` or `company`'s name,
-		// `logo`, the attachment id for the `personal` or `company` entity.
-
-		// Store the key:
-		$this->configuration_service->set_key( $params['key'] );
-
-		// Store the vocabulary path:
-		$this->configuration_service->set_entity_base_path( $params['vocabulary'] );
-
-		// Store the site's language:
-		$this->configuration_service->set_language_code( $params['wl-site-language'] );
-
-		// Store the site's country:
-		$this->configuration_service->set_country_code( $params['wl-country-code'] );
-
-		// Store the preferences in variable, because if the checkbox is not checked
-		// the `share-diagnostic` will not exists in `$params` array.
-		$share_diagnostic_preferences = empty( $params['share-diagnostic'] ) ? 'no' : 'yes';
-
-		// Store the diagnostic preferences:
-		$this->configuration_service->set_diagnostic_preferences( $share_diagnostic_preferences );
-
-		// Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
-		$type_uri = sprintf( 'http://schema.org/%s', 'organization' === $params['user_type'] ? 'Organization' : 'Person' );
-
-		// Create an entity for the publisher.
-		$publisher_post_id = $this->entity_service->create( $params['name'], $type_uri, $params['logo'], 'publish' );
-
-		// Store the publisher entity post id in the configuration.
-		$this->configuration_service->set_publisher_id( $publisher_post_id );
-
-		flush_rewrite_rules(); // Needed because of possible change to the entity base path.
-
-	}
+    }
+
+    /**
+     * Handle hiding the wizard notices by user request.
+     *
+     * @since    3.9.0
+     */
+    public function hide_notices() {
+
+        // If it's not a `wl-hide-notice` or the nonce is not set, return.
+        if ( ! isset( $_GET['wl-hide-notice'], $_GET['_wl_notice_nonce'] ) ) {
+            return;
+        }
+
+        // If the nonce is invalid, return an error.
+        if ( ! wp_verify_nonce( $_GET['_wl_notice_nonce'], 'wordlift_hide_notices_nonce' ) ) {
+            wp_die( __( 'Action failed. Please refresh the page and retry.', 'wordlift' ) );
+        }
+
+        // If the user doesn't have the right privileges, return an error.
+        if ( ! current_user_can( 'manage_options' ) ) {
+            wp_die( __( 'Cheatin&#8217; huh?', 'wordlift' ) );
+        }
+
+        // Store a flag telling to skip the wizard.
+        $this->configuration_service->set_skip_wizard( true );
+
+    }
+
+    /**
+     * Register the wizard page to be able to access it.
+     *
+     * @since    3.9.0
+     */
+    public function admin_menu() {
+        /**
+         *
+         * @see https://github.com/insideout10/wordlift-plugin/issues/1209
+         * @since 3.27.7
+         */
+        // @todo: find another way to do this, since this is adding an empty space in WP's dashboard menu.
+        add_dashboard_page( '', '', 'manage_options', 'wl-setup', '' );
+    }
+
+    /**
+     * Displays the wizard page.
+     *
+     * @since    3.9.0
+     */
+    public function show_page() {
+
+        // First check if we are in the wizard page at all, if not do nothing.
+        if ( empty( $_GET['page'] ) || 'wl-setup' !== $_GET['page'] ) {
+            return;
+        }
+
+        // If it's a POST and the `wl-save-configuration` action is set, save the configuration.
+        if ( isset( $_POST['action'] ) && 'wl-save-configuration' === $_POST['action'] ) {
+
+            // Check the nonce and the user capabilities.
+            check_admin_referer( 'wl-save-configuration' );
+
+            // Check if the user has the right privileges.
+            if ( ! current_user_can( 'manage_options' ) ) {
+                wp_die( __( 'Sorry, you do not have a permission to save the settings', 'wordlift' ) );
+            }
+
+            // Save the configuration.
+            $this->save_configuration( $_POST );
+
+            // Redirect to the admin's page.
+            wp_redirect( admin_url() );
+
+            exit;
+        }
+
+        $language_select = $this->language_select_element;
+        $country_select  = $this->country_select_element;
+
+        include plugin_dir_path( dirname( __FILE__ ) ) . 'admin/partials/wordlift-admin-setup.php';
+
+        exit;
+    }
+
+    /**
+     * Save WordLift's configuration using the provided parameters.
+     *
+     * @param array $params An array of configuration parameters.
+     *
+     * @since 3.9.0
+     *
+     */
+    public function save_configuration( $params ) {
+
+        // We have the following parameters:
+        // `key`, holding WL's key,
+        // `vocabulary`, holding the vocabulary path,
+        // `wl-site-language`, with the language code (e.g. `en`),
+        // `wl-country-code` with the country code (e.g. `us`),
+        // `share-diagnostic`, the user preferences about sharing data with us.
+        // `user_type`, the user type either `personal` or `company`,
+        // `name`, with the `personal` or `company`'s name,
+        // `logo`, the attachment id for the `personal` or `company` entity.
+
+        // Store the key:
+        $this->configuration_service->set_key( $params['key'] );
+
+        // Store the vocabulary path:
+        $this->configuration_service->set_entity_base_path( $params['vocabulary'] );
+
+        // Store the site's language:
+        $this->configuration_service->set_language_code( $params['wl-site-language'] );
+
+        // Store the site's country:
+        $this->configuration_service->set_country_code( $params['wl-country-code'] );
+
+        // Store the preferences in variable, because if the checkbox is not checked
+        // the `share-diagnostic` will not exists in `$params` array.
+        $share_diagnostic_preferences = empty( $params['share-diagnostic'] ) ? 'no' : 'yes';
+
+        // Store the diagnostic preferences:
+        $this->configuration_service->set_diagnostic_preferences( $share_diagnostic_preferences );
+
+        // Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
+        $type_uri = sprintf( 'http://schema.org/%s', 'organization' === $params['user_type'] ? 'Organization' : 'Person' );
+
+        // Create an entity for the publisher.
+        $publisher_post_id = $this->entity_service->create( $params['name'], $type_uri, $params['logo'], 'publish' );
+
+        // Store the publisher entity post id in the configuration.
+        $this->configuration_service->set_publisher_id( $publisher_post_id );
+
+        flush_rewrite_rules(); // Needed because of possible change to the entity base path.
+
+    }
 
 }

src/wordlift/features/class-features-registry.php

Indentation +50 added lines, -50 removed lines

@@ -4,54 +4,54 @@
 
 class Features_Registry {
 
-	/**
-	 * @var array<Feature>
-	 */
-	private $features = array();
-
-	private static $instance = null;
-
-	public static function get_instance() {
-		if ( self::$instance === null ) {
-			self::$instance = new Features_Registry();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * @param $feature Feature
-	 */
-	public function register_feature( $feature ) {
-		$this->features[] = $feature;
-	}
-
-	/**
-	 * @param $feature_slug string
-	 * @param $default_value bool
-	 * @param $callback callable
-	 */
-	public function register_feature_from_slug( $feature_slug, $default_value, $callback ) {
-		$this->features[] = new Feature(
-			$feature_slug,
-			$default_value,
-			$callback
-		);
-	}
-
-	public function initialize_all_features() {
-		foreach ( $this->features as $feature ) {
-			/**
-			 * @var $feature Feature
-			 */
-			$feature_slug = $feature->feature_slug;
-			if ( apply_filters( "wl_feature__enable__${feature_slug}", $feature->default_value ) ) {
-				call_user_func( $feature->callback );
-			}
-		}
-	}
-
-	public function clear_all() {
-		$this->features = array();
-	}
+    /**
+     * @var array<Feature>
+     */
+    private $features = array();
+
+    private static $instance = null;
+
+    public static function get_instance() {
+        if ( self::$instance === null ) {
+            self::$instance = new Features_Registry();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * @param $feature Feature
+     */
+    public function register_feature( $feature ) {
+        $this->features[] = $feature;
+    }
+
+    /**
+     * @param $feature_slug string
+     * @param $default_value bool
+     * @param $callback callable
+     */
+    public function register_feature_from_slug( $feature_slug, $default_value, $callback ) {
+        $this->features[] = new Feature(
+            $feature_slug,
+            $default_value,
+            $callback
+        );
+    }
+
+    public function initialize_all_features() {
+        foreach ( $this->features as $feature ) {
+            /**
+             * @var $feature Feature
+             */
+            $feature_slug = $feature->feature_slug;
+            if ( apply_filters( "wl_feature__enable__${feature_slug}", $feature->default_value ) ) {
+                call_user_func( $feature->callback );
+            }
+        }
+    }
+
+    public function clear_all() {
+        $this->features = array();
+    }
 }
\ No newline at end of file

src/wordlift/features/class-response-adapter.php

Indentation +77 added lines, -77 removed lines

@@ -3,115 +3,115 @@
 namespace Wordlift\Features;
 
 class Response_Adapter {
-	const WL_FEATURES = '_wl_features';
-	const WL_1 = 'wl1';
+    const WL_FEATURES = '_wl_features';
+    const WL_1 = 'wl1';
 
-	/**
-	 * @var \Wordlift_Log_Service
-	 */
-	private $log;
+    /**
+     * @var \Wordlift_Log_Service
+     */
+    private $log;
 
-	function __construct() {
+    function __construct() {
 
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
+        $this->log = \Wordlift_Log_Service::get_logger( get_class() );
 
-		// Filter responses from the API calls to update the enabled features.
-		add_filter( 'wl_api_service__response', array( $this, 'response' ), 10, 1 );
+        // Filter responses from the API calls to update the enabled features.
+        add_filter( 'wl_api_service__response', array( $this, 'response' ), 10, 1 );
 
-		// Initialize from `$_ENV`: this is currently required for Unit Tests, since `tests/bootstrap.php` loads WordLift
-		// before it can actually query the enabled features via HTTP (mock), which would prevent files from being included.
+        // Initialize from `$_ENV`: this is currently required for Unit Tests, since `tests/bootstrap.php` loads WordLift
+        // before it can actually query the enabled features via HTTP (mock), which would prevent files from being included.
 //		$this->init_from_env();
 
-		// Register the `wl_features__enable__{feature-name}` filters.
-		$this->register_filters();
+        // Register the `wl_features__enable__{feature-name}` filters.
+        $this->register_filters();
 
-		// Hook to updates to the features setting to refresh the features' filters.
-		add_action( 'update_option_' . self::WL_FEATURES, array( $this, 'register_filters' ), 10, 0 );
+        // Hook to updates to the features setting to refresh the features' filters.
+        add_action( 'update_option_' . self::WL_FEATURES, array( $this, 'register_filters' ), 10, 0 );
 
-	}
+    }
 
-	function response( $response ) {
+    function response( $response ) {
 
-		$headers = wp_remote_retrieve_headers( $response );
+        $headers = wp_remote_retrieve_headers( $response );
 
-		// Bail out if the `wl1` header isn't defined.
-		if ( ! isset( $headers[ self::WL_1 ] ) ) {
-			return $response;
-		}
-		$wl1_as_base64_string = $headers[ self::WL_1 ];
-		$wl1                  = json_decode( base64_decode( $wl1_as_base64_string ), true );
+        // Bail out if the `wl1` header isn't defined.
+        if ( ! isset( $headers[ self::WL_1 ] ) ) {
+            return $response;
+        }
+        $wl1_as_base64_string = $headers[ self::WL_1 ];
+        $wl1                  = json_decode( base64_decode( $wl1_as_base64_string ), true );
 
-		$this->log->debug( "WL1 [ encoded :: $wl1_as_base64_string ] " . var_export( $wl1, true ) );
+        $this->log->debug( "WL1 [ encoded :: $wl1_as_base64_string ] " . var_export( $wl1, true ) );
 
 
-		$updated_features = $wl1['features'];
+        $updated_features = $wl1['features'];
 
-		$existing_features = get_option( self::WL_FEATURES, array() );
+        $existing_features = get_option( self::WL_FEATURES, array() );
 
-		// Loop through updated features.
-		foreach ( $updated_features as $feature_slug => $new_value ) {
+        // Loop through updated features.
+        foreach ( $updated_features as $feature_slug => $new_value ) {
 
-			// We cant pass false because that indicates if the feature is active or not, null is used to represent the features which are
-			// not set before.
-			$old_value = array_key_exists( $feature_slug, $existing_features ) ? $existing_features[ $feature_slug ] : null;
+            // We cant pass false because that indicates if the feature is active or not, null is used to represent the features which are
+            // not set before.
+            $old_value = array_key_exists( $feature_slug, $existing_features ) ? $existing_features[ $feature_slug ] : null;
 
-			if ( $old_value !== $new_value ) {
-				/**
-				 * @param $feature_slug string The feature slug.
-				 * @param $old_value null | boolean Null represents the feature flag was not set before.
-				 * @param $new_value boolean True or false.
-				 *
-				 * @since 3.32.1
-				 * Hook : `wl_feature__change__{feature_slug}`
-				 * Action hook to be fired when there is a change in feature state.
-				 */
-				do_action( "wl_feature__change__${feature_slug}", $new_value, $old_value, $feature_slug );
-			}
+            if ( $old_value !== $new_value ) {
+                /**
+                 * @param $feature_slug string The feature slug.
+                 * @param $old_value null | boolean Null represents the feature flag was not set before.
+                 * @param $new_value boolean True or false.
+                 *
+                 * @since 3.32.1
+                 * Hook : `wl_feature__change__{feature_slug}`
+                 * Action hook to be fired when there is a change in feature state.
+                 */
+                do_action( "wl_feature__change__${feature_slug}", $new_value, $old_value, $feature_slug );
+            }
 
-		}
+        }
 
 
-		if ( isset( $updated_features ) ) {
+        if ( isset( $updated_features ) ) {
 
-			if ( update_option( self::WL_FEATURES, (array) $updated_features, true ) ) {
-				$this->register_filters();
-			}
-		}
+            if ( update_option( self::WL_FEATURES, (array) $updated_features, true ) ) {
+                $this->register_filters();
+            }
+        }
 
-		return $response;
-	}
+        return $response;
+    }
 
-	/**
-	 * Registers the feature filters.
-	 */
-	function register_filters() {
+    /**
+     * Registers the feature filters.
+     */
+    function register_filters() {
 
-		$this->log->debug( 'Registering feature filters...' );
+        $this->log->debug( 'Registering feature filters...' );
 
-		foreach ( (array) get_option( self::WL_FEATURES, array() ) as $name => $enabled ) {
-			// Remove previous filters.
-			remove_filter( "wl_feature__enable__${name}", '__return_true' );
-			remove_filter( "wl_feature__enable__${name}", '__return_false' );
+        foreach ( (array) get_option( self::WL_FEATURES, array() ) as $name => $enabled ) {
+            // Remove previous filters.
+            remove_filter( "wl_feature__enable__${name}", '__return_true' );
+            remove_filter( "wl_feature__enable__${name}", '__return_false' );
 
-			$callback = ( $enabled ? '__return_true' : '__return_false' );
-			add_filter( "wl_feature__enable__${name}", $callback );
-		}
+            $callback = ( $enabled ? '__return_true' : '__return_false' );
+            add_filter( "wl_feature__enable__${name}", $callback );
+        }
 
-	}
+    }
 
-	private function init_from_env() {
-		$features = array_reduce( array_filter( array_keys( $_ENV ), function ( $key ) {
-			return preg_match( '~^WL_FEATURES__.*~', $key );
-		} ), function ( $features, $env ) {
-			$name              = strtolower( str_replace( '_', '-', substr( $env, strlen( 'WL_FEATURES__' ) ) ) );
-			$value             = wp_validate_boolean( getenv( $env ) );
-			$features[ $name ] = $value;
+    private function init_from_env() {
+        $features = array_reduce( array_filter( array_keys( $_ENV ), function ( $key ) {
+            return preg_match( '~^WL_FEATURES__.*~', $key );
+        } ), function ( $features, $env ) {
+            $name              = strtolower( str_replace( '_', '-', substr( $env, strlen( 'WL_FEATURES__' ) ) ) );
+            $value             = wp_validate_boolean( getenv( $env ) );
+            $features[ $name ] = $value;
 
-			return $features;
-		}, array() );
+            return $features;
+        }, array() );
 
-		update_option( self::WL_FEATURES, (array) $features, true );
+        update_option( self::WL_FEATURES, (array) $features, true );
 
-	}
+    }
 
 }

Spacing +30 added lines, -30 removed lines

@@ -13,10 +13,10 @@ 
 
 	function __construct() {
 
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = \Wordlift_Log_Service::get_logger(get_class());
 
 		// Filter responses from the API calls to update the enabled features.
-		add_filter( 'wl_api_service__response', array( $this, 'response' ), 10, 1 );
+		add_filter('wl_api_service__response', array($this, 'response'), 10, 1);
 
 		// Initialize from `$_ENV`: this is currently required for Unit Tests, since `tests/bootstrap.php` loads WordLift
 		// before it can actually query the enabled features via HTTP (mock), which would prevent files from being included.
@@ -26,36 +26,36 @@ 
 		$this->register_filters();
 
 		// Hook to updates to the features setting to refresh the features' filters.
-		add_action( 'update_option_' . self::WL_FEATURES, array( $this, 'register_filters' ), 10, 0 );
+		add_action('update_option_'.self::WL_FEATURES, array($this, 'register_filters'), 10, 0);
 
 	}
 
-	function response( $response ) {
+	function response($response) {
 
-		$headers = wp_remote_retrieve_headers( $response );
+		$headers = wp_remote_retrieve_headers($response);
 
 		// Bail out if the `wl1` header isn't defined.
-		if ( ! isset( $headers[ self::WL_1 ] ) ) {
+		if ( ! isset($headers[self::WL_1])) {
 			return $response;
 		}
-		$wl1_as_base64_string = $headers[ self::WL_1 ];
-		$wl1                  = json_decode( base64_decode( $wl1_as_base64_string ), true );
+		$wl1_as_base64_string = $headers[self::WL_1];
+		$wl1                  = json_decode(base64_decode($wl1_as_base64_string), true);
 
-		$this->log->debug( "WL1 [ encoded :: $wl1_as_base64_string ] " . var_export( $wl1, true ) );
+		$this->log->debug("WL1 [ encoded :: $wl1_as_base64_string ] ".var_export($wl1, true));
 
 
 		$updated_features = $wl1['features'];
 
-		$existing_features = get_option( self::WL_FEATURES, array() );
+		$existing_features = get_option(self::WL_FEATURES, array());
 
 		// Loop through updated features.
-		foreach ( $updated_features as $feature_slug => $new_value ) {
+		foreach ($updated_features as $feature_slug => $new_value) {
 
 			// We cant pass false because that indicates if the feature is active or not, null is used to represent the features which are
 			// not set before.
-			$old_value = array_key_exists( $feature_slug, $existing_features ) ? $existing_features[ $feature_slug ] : null;
+			$old_value = array_key_exists($feature_slug, $existing_features) ? $existing_features[$feature_slug] : null;
 
-			if ( $old_value !== $new_value ) {
+			if ($old_value !== $new_value) {
 				/**
 				 * @param $feature_slug string The feature slug.
 				 * @param $old_value null | boolean Null represents the feature flag was not set before.
@@ -65,15 +65,15 @@ 
 				 * Hook : `wl_feature__change__{feature_slug}`
 				 * Action hook to be fired when there is a change in feature state.
 				 */
-				do_action( "wl_feature__change__${feature_slug}", $new_value, $old_value, $feature_slug );
+				do_action("wl_feature__change__${feature_slug}", $new_value, $old_value, $feature_slug);
 			}
 
 		}
 
 
-		if ( isset( $updated_features ) ) {
+		if (isset($updated_features)) {
 
-			if ( update_option( self::WL_FEATURES, (array) $updated_features, true ) ) {
+			if (update_option(self::WL_FEATURES, (array) $updated_features, true)) {
 				$this->register_filters();
 			}
 		}
@@ -86,31 +86,31 @@ 
 	 */
 	function register_filters() {
 
-		$this->log->debug( 'Registering feature filters...' );
+		$this->log->debug('Registering feature filters...');
 
-		foreach ( (array) get_option( self::WL_FEATURES, array() ) as $name => $enabled ) {
+		foreach ((array) get_option(self::WL_FEATURES, array()) as $name => $enabled) {
 			// Remove previous filters.
-			remove_filter( "wl_feature__enable__${name}", '__return_true' );
-			remove_filter( "wl_feature__enable__${name}", '__return_false' );
+			remove_filter("wl_feature__enable__${name}", '__return_true');
+			remove_filter("wl_feature__enable__${name}", '__return_false');
 
-			$callback = ( $enabled ? '__return_true' : '__return_false' );
-			add_filter( "wl_feature__enable__${name}", $callback );
+			$callback = ($enabled ? '__return_true' : '__return_false');
+			add_filter("wl_feature__enable__${name}", $callback);
 		}
 
 	}
 
 	private function init_from_env() {
-		$features = array_reduce( array_filter( array_keys( $_ENV ), function ( $key ) {
-			return preg_match( '~^WL_FEATURES__.*~', $key );
-		} ), function ( $features, $env ) {
-			$name              = strtolower( str_replace( '_', '-', substr( $env, strlen( 'WL_FEATURES__' ) ) ) );
-			$value             = wp_validate_boolean( getenv( $env ) );
-			$features[ $name ] = $value;
+		$features = array_reduce(array_filter(array_keys($_ENV), function($key) {
+			return preg_match('~^WL_FEATURES__.*~', $key);
+		} ), function($features, $env) {
+			$name              = strtolower(str_replace('_', '-', substr($env, strlen('WL_FEATURES__'))));
+			$value             = wp_validate_boolean(getenv($env));
+			$features[$name] = $value;
 
 			return $features;
-		}, array() );
+		}, array());
 
-		update_option( self::WL_FEATURES, (array) $features, true );
+		update_option(self::WL_FEATURES, (array) $features, true);
 
 	}
 

src/wordlift/entity-type/class-entity-type-setter.php

Indentation +185 added lines, -185 removed lines

@@ -11,191 +11,191 @@
 class Entity_Type_Setter {
 
 
-	const STARTER_PLAN = 'entity-types-starter';
-
-	const PROFESSIONAL_PLAN = 'entity-types-professional';
-
-	const BUSINESS_PLAN = 'entity-types-business';
-
-	public function __construct() {
-		add_action( "wl_feature__change__entity-types-starter", array( $this, 'wl_entity_types_feature_changed' ), 10, 3 );
-		add_action( "wl_feature__change__entity-types-professional", array( $this, 'wl_entity_types_feature_changed' ), 10, 3 );
-		add_action( "wl_feature__change__entity-types-business", array( $this, 'wl_entity_types_feature_changed' ), 10, 3 );
-	}
-
-
-	public function wl_entity_types_feature_changed( $new_value, $old_value, $feature_slug ) {
-
-		// If the entity types is not set by server, then return early.
-		if (  ! $new_value ) {
-			return;
-		}
-
-
-		$entity_types_data = self::get_entity_types_by_feature_flag( $feature_slug );
-
-		// If we dont have entity types returned, then dont reset the entity types, return early.
-		if ( ! $entity_types_data ) {
-			return;
-		}
-		// Repopulate the ones returned by package type.
-		foreach ( $entity_types_data as $entity_type_data ) {
-
-			$schema_label = $entity_type_data['label'];
-
-			$term_exists = get_term_by( 'name', $schema_label, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) instanceof \WP_Term;
-
-			if ( $term_exists ) {
-				// Dont create term if it already exists.
-				continue;
-			}
-
-
-			$term_data = wp_insert_term(
-				$schema_label,
-				Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				array(
-					'description' => $entity_type_data['description'],
-					'slug'        => $entity_type_data['slug']
-				)
-			);
-
-			$term_id = $term_data['term_id'];
-
-			update_term_meta( $term_id, '_wl_uri', 'http://schema.org/' . $schema_label );
-			update_term_meta( $term_id, '_wl_name', $schema_label );
-		}
-
-	}
-
-
-	public static function get_starter_entity_types() {
-		return array(
-			array(
-				'label'       => 'Person',
-				'description' => 'A person (or a music artist).',
-				'slug'        => 'person'
-			),
-			array(
-				'label'       => 'Thing',
-				'description' => 'A generic thing (something that doesn\'t fit in the previous definitions.',
-				'slug'        => 'thing'
-			),
-
-			array(
-				'label'       => 'Place',
-				'description' => 'A place.',
-				'slug'        => 'place'
-			),
-
-			array(
-				'label'       => 'CreativeWork',
-				'description' => 'A creative work (or a Music Album).',
-				'slug'        => 'creative-work'
-			),
-			array(
-				'label'       => 'Organization',
-				'description' => 'An organization, including a government or a newspaper.',
-				'slug'        => 'organization'
-			),
-
-			array(
-				'label'       => 'Article',
-				'description' => 'An article, such as a news article or piece of investigative report. Newspapers and magazines have articles of many different types and this is intended to cover them all.',
-				'slug'        => 'article'
-			),
-
-			array(
-				'label'       => 'WebSite',
-				'description' => 'A WebSite is a set of related web pages and other items typically served from a single web domain and accessible via URLs.',
-				'slug'        => 'web-site'
-			),
-
-			array(
-				'label'       => 'NewsArticle',
-				'description' => 'A NewsArticle is an article whose content reports news, or provides background context and supporting materials for understanding the news.',
-				'slug'        => 'news-article'
-			),
-
-			array(
-				'label'       => 'AboutPage',
-				'description' => 'An About page.',
-				'slug'        => 'about-page'
-			),
-
-			array(
-				'label'       => 'ContactPage',
-				'description' => 'A Contact Page.',
-				'slug'        => 'contact-page'
-			)
-
-		);
-	}
-
-
-	public static function get_professional_entity_types() {
-		return array(
-
-			array(
-				'label'       => 'FAQPage',
-				'description' => 'A FAQPage is a WebPage presenting one or more "Frequently asked questions".',
-				'slug'        => 'faq-page'
-			),
-			array(
-				'label'       => 'LocalBusiness',
-				'description' => 'A particular physical business or branch of an organization. Examples of LocalBusiness include a restaurant, a particular branch of a restaurant chain, a branch of a bank, a medical practice, a club, a bowling alley, etc.',
-				'slug'        => 'local-business'
-
-			),
-			array(
-				'label'       => 'Recipe',
-				'description' => 'A recipe',
-				'slug'        => 'recipe'
-			),
-			array(
-				'label'       => 'PodcastEpisode',
-				'description' => 'A single episode of a podcast series.',
-				'slug'        => 'podcast-episode'
-			),
-			array(
-				'label'       => 'Course',
-				'description' => 'A description of an educational course which may be offered as distinct instances at which take place at different times or take place at different locations, or be offered through different media or modes of study.',
-				'slug'        => 'course'
-			),
-			array(
-				'label'       => 'Event',
-				'description' => 'An event happening at a certain time and location, such as a concert, lecture, or festival.',
-				'slug'        => 'event'
-			),
-			array(
-				'label'       => 'Review',
-				'description' => 'A review of an item - for example, of a restaurant, movie, or store.',
-				'slug'        => 'review'
-			),
-
-		);
-	}
-
-
-	private static function get_entity_types_by_feature_flag( $package_type ) {
-
-		switch ( $package_type ) {
-			case self::STARTER_PLAN:
-				return self::get_starter_entity_types();
-			case self::BUSINESS_PLAN:
-			case self::PROFESSIONAL_PLAN:
-				// We return same entity types for professional and business plans.
-				// Business plan should have sync schema ui feature enabled, to sync all the entity types.
-				return array_merge(
-					self::get_starter_entity_types(),
-					self::get_professional_entity_types()
-				);
-			default:
-				return array();
-
-		}
-
-	}
+    const STARTER_PLAN = 'entity-types-starter';
+
+    const PROFESSIONAL_PLAN = 'entity-types-professional';
+
+    const BUSINESS_PLAN = 'entity-types-business';
+
+    public function __construct() {
+        add_action( "wl_feature__change__entity-types-starter", array( $this, 'wl_entity_types_feature_changed' ), 10, 3 );
+        add_action( "wl_feature__change__entity-types-professional", array( $this, 'wl_entity_types_feature_changed' ), 10, 3 );
+        add_action( "wl_feature__change__entity-types-business", array( $this, 'wl_entity_types_feature_changed' ), 10, 3 );
+    }
+
+
+    public function wl_entity_types_feature_changed( $new_value, $old_value, $feature_slug ) {
+
+        // If the entity types is not set by server, then return early.
+        if (  ! $new_value ) {
+            return;
+        }
+
+
+        $entity_types_data = self::get_entity_types_by_feature_flag( $feature_slug );
+
+        // If we dont have entity types returned, then dont reset the entity types, return early.
+        if ( ! $entity_types_data ) {
+            return;
+        }
+        // Repopulate the ones returned by package type.
+        foreach ( $entity_types_data as $entity_type_data ) {
+
+            $schema_label = $entity_type_data['label'];
+
+            $term_exists = get_term_by( 'name', $schema_label, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) instanceof \WP_Term;
+
+            if ( $term_exists ) {
+                // Dont create term if it already exists.
+                continue;
+            }
+
+
+            $term_data = wp_insert_term(
+                $schema_label,
+                Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                array(
+                    'description' => $entity_type_data['description'],
+                    'slug'        => $entity_type_data['slug']
+                )
+            );
+
+            $term_id = $term_data['term_id'];
+
+            update_term_meta( $term_id, '_wl_uri', 'http://schema.org/' . $schema_label );
+            update_term_meta( $term_id, '_wl_name', $schema_label );
+        }
+
+    }
+
+
+    public static function get_starter_entity_types() {
+        return array(
+            array(
+                'label'       => 'Person',
+                'description' => 'A person (or a music artist).',
+                'slug'        => 'person'
+            ),
+            array(
+                'label'       => 'Thing',
+                'description' => 'A generic thing (something that doesn\'t fit in the previous definitions.',
+                'slug'        => 'thing'
+            ),
+
+            array(
+                'label'       => 'Place',
+                'description' => 'A place.',
+                'slug'        => 'place'
+            ),
+
+            array(
+                'label'       => 'CreativeWork',
+                'description' => 'A creative work (or a Music Album).',
+                'slug'        => 'creative-work'
+            ),
+            array(
+                'label'       => 'Organization',
+                'description' => 'An organization, including a government or a newspaper.',
+                'slug'        => 'organization'
+            ),
+
+            array(
+                'label'       => 'Article',
+                'description' => 'An article, such as a news article or piece of investigative report. Newspapers and magazines have articles of many different types and this is intended to cover them all.',
+                'slug'        => 'article'
+            ),
+
+            array(
+                'label'       => 'WebSite',
+                'description' => 'A WebSite is a set of related web pages and other items typically served from a single web domain and accessible via URLs.',
+                'slug'        => 'web-site'
+            ),
+
+            array(
+                'label'       => 'NewsArticle',
+                'description' => 'A NewsArticle is an article whose content reports news, or provides background context and supporting materials for understanding the news.',
+                'slug'        => 'news-article'
+            ),
+
+            array(
+                'label'       => 'AboutPage',
+                'description' => 'An About page.',
+                'slug'        => 'about-page'
+            ),
+
+            array(
+                'label'       => 'ContactPage',
+                'description' => 'A Contact Page.',
+                'slug'        => 'contact-page'
+            )
+
+        );
+    }
+
+
+    public static function get_professional_entity_types() {
+        return array(
+
+            array(
+                'label'       => 'FAQPage',
+                'description' => 'A FAQPage is a WebPage presenting one or more "Frequently asked questions".',
+                'slug'        => 'faq-page'
+            ),
+            array(
+                'label'       => 'LocalBusiness',
+                'description' => 'A particular physical business or branch of an organization. Examples of LocalBusiness include a restaurant, a particular branch of a restaurant chain, a branch of a bank, a medical practice, a club, a bowling alley, etc.',
+                'slug'        => 'local-business'
+
+            ),
+            array(
+                'label'       => 'Recipe',
+                'description' => 'A recipe',
+                'slug'        => 'recipe'
+            ),
+            array(
+                'label'       => 'PodcastEpisode',
+                'description' => 'A single episode of a podcast series.',
+                'slug'        => 'podcast-episode'
+            ),
+            array(
+                'label'       => 'Course',
+                'description' => 'A description of an educational course which may be offered as distinct instances at which take place at different times or take place at different locations, or be offered through different media or modes of study.',
+                'slug'        => 'course'
+            ),
+            array(
+                'label'       => 'Event',
+                'description' => 'An event happening at a certain time and location, such as a concert, lecture, or festival.',
+                'slug'        => 'event'
+            ),
+            array(
+                'label'       => 'Review',
+                'description' => 'A review of an item - for example, of a restaurant, movie, or store.',
+                'slug'        => 'review'
+            ),
+
+        );
+    }
+
+
+    private static function get_entity_types_by_feature_flag( $package_type ) {
+
+        switch ( $package_type ) {
+            case self::STARTER_PLAN:
+                return self::get_starter_entity_types();
+            case self::BUSINESS_PLAN:
+            case self::PROFESSIONAL_PLAN:
+                // We return same entity types for professional and business plans.
+                // Business plan should have sync schema ui feature enabled, to sync all the entity types.
+                return array_merge(
+                    self::get_starter_entity_types(),
+                    self::get_professional_entity_types()
+                );
+            default:
+                return array();
+
+        }
+
+    }
 
 
 }
\ No newline at end of file

Spacing +14 added lines, -14 removed lines

@@ -18,34 +18,34 @@ 
 	const BUSINESS_PLAN = 'entity-types-business';
 
 	public function __construct() {
-		add_action( "wl_feature__change__entity-types-starter", array( $this, 'wl_entity_types_feature_changed' ), 10, 3 );
-		add_action( "wl_feature__change__entity-types-professional", array( $this, 'wl_entity_types_feature_changed' ), 10, 3 );
-		add_action( "wl_feature__change__entity-types-business", array( $this, 'wl_entity_types_feature_changed' ), 10, 3 );
+		add_action("wl_feature__change__entity-types-starter", array($this, 'wl_entity_types_feature_changed'), 10, 3);
+		add_action("wl_feature__change__entity-types-professional", array($this, 'wl_entity_types_feature_changed'), 10, 3);
+		add_action("wl_feature__change__entity-types-business", array($this, 'wl_entity_types_feature_changed'), 10, 3);
 	}
 
 
-	public function wl_entity_types_feature_changed( $new_value, $old_value, $feature_slug ) {
+	public function wl_entity_types_feature_changed($new_value, $old_value, $feature_slug) {
 
 		// If the entity types is not set by server, then return early.
-		if (  ! $new_value ) {
+		if ( ! $new_value) {
 			return;
 		}
 
 
-		$entity_types_data = self::get_entity_types_by_feature_flag( $feature_slug );
+		$entity_types_data = self::get_entity_types_by_feature_flag($feature_slug);
 
 		// If we dont have entity types returned, then dont reset the entity types, return early.
-		if ( ! $entity_types_data ) {
+		if ( ! $entity_types_data) {
 			return;
 		}
 		// Repopulate the ones returned by package type.
-		foreach ( $entity_types_data as $entity_type_data ) {
+		foreach ($entity_types_data as $entity_type_data) {
 
 			$schema_label = $entity_type_data['label'];
 
-			$term_exists = get_term_by( 'name', $schema_label, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) instanceof \WP_Term;
+			$term_exists = get_term_by('name', $schema_label, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME) instanceof \WP_Term;
 
-			if ( $term_exists ) {
+			if ($term_exists) {
 				// Dont create term if it already exists.
 				continue;
 			}
@@ -62,8 +62,8 @@ 
 
 			$term_id = $term_data['term_id'];
 
-			update_term_meta( $term_id, '_wl_uri', 'http://schema.org/' . $schema_label );
-			update_term_meta( $term_id, '_wl_name', $schema_label );
+			update_term_meta($term_id, '_wl_uri', 'http://schema.org/'.$schema_label);
+			update_term_meta($term_id, '_wl_name', $schema_label);
 		}
 
 	}
@@ -177,9 +177,9 @@ 
 	}
 
 
-	private static function get_entity_types_by_feature_flag( $package_type ) {
+	private static function get_entity_types_by_feature_flag($package_type) {
 
-		switch ( $package_type ) {
+		switch ($package_type) {
 			case self::STARTER_PLAN:
 				return self::get_starter_entity_types();
 			case self::BUSINESS_PLAN:

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

Indentation +317 added lines, -317 removed lines

@@ -18,323 +18,323 @@
  */
 class Wordlift_Admin_Settings_Analytics_Page extends Wordlift_Admin_Page {
 
-	/**
-	 * A singleton instance of the Notice service.
-	 *
-	 * @since  3.21.0
-	 * @access private
-	 * @var \Wordlift_Admin_Settings_Analytics_Page $instance A singleton instance of a {@link Wordlift_Admin_Settings_Analytics_Page} class.
-	 */
-	private static $instance;
-
-	/**
-	 * A {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.21.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * A {@link Wordlift_Admin_Input_Element} element renderer.
-	 *
-	 * @since  3.21.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.21.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;
-
-	/**
-	 * Create a {@link Wordlift_Admin_Settings_Page} instance.
-	 *
-	 * @param \Wordlift_Configuration_Service $configuration_service The wordlift configuration service.
-	 * @param \Wordlift_Admin_Input_Element $input_element An input element class to output input boxes in a settings form.
-	 * @param \Wordlift_Admin_Radio_Input_Element $radio_input_element A radio element input class for use in a settings form.
-	 *
-	 * @since 3.21.0
-	 *
-	 */
-	public function __construct( $configuration_service, $input_element, $radio_input_element ) {
-
-		$this->configuration_service = $configuration_service;
-
-		// Set a reference to the UI elements.
-		$this->input_element       = $input_element;
-		$this->radio_input_element = $radio_input_element;
-
-		// Adds this page to the main admin settings tabbed menu.
-		add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
-
-		self::$instance = $this;
-	}
-
-	/**
-	 * Get the singleton instance of the Notice service.
-	 *
-	 * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
-	 * @since 3.21.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	protected function get_parent_slug() {
-
-		return 'wl_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	protected function get_capability() {
-
-		return 'manage_options';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_page_title() {
-
-		return __( 'WorldLift Analytics Settings', 'wordlift' );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_menu_title() {
-
-		return __( 'Analytics Settings', 'wordlift' );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_menu_slug() {
-
-		return 'wl_configuration_admin_analytics_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_partial_name() {
-
-		return 'wordlift-admin-settings-analytics-page.php';
-	}
-
-	/**
-	 * Returns the string to use for the tab slug on main admin settings page.
-	 *
-	 * @method get_admin_page_tab_slug
-	 * @return string
-	 * @since  3.21.0
-	 */
-	public function get_admin_page_tab_slug() {
-		return 'analytics';
-	}
-
-	/**
-	 * Adds pages to the tabs menu on the main admin settings page.
-	 *
-	 * @method add_admin_page_tab
-	 * @param array $tabs an array of tab titles and slugs to use when building a tabbed menu on option pages.
-	 *
-	 * @since  3.21.0
-	 */
-	public function add_admin_page_tab( $tabs ) {
-		if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
-			$tabs[] = array(
-				'title' => $this->get_menu_title(),
-				'slug'  => $this->get_admin_page_tab_slug(),
-			);
-		}
-
-		return $tabs;
-	}
-
-	/**
-	 * Configure all the configuration parameters.
-	 *
-	 * Called by the *admin_init* hook.
-	 *
-	 * @since 3.21.0
-	 */
-	public function admin_init() {
-
-		// Register WordLift's analytics settings with our in class sanitizer.
-		register_setting(
-			'wl_analytics_settings',
-			'wl_analytics_settings',
-			array( $this, 'sanitize_callback' )
-		);
-
-		// Add the analytics settings setction.
-		add_settings_section(
-			'wl_analytics_settings_section',
-			'',
-			'',
-			'wl_analytics_settings'
-		);
-
-		// Add a toggle to determine if analytics functions are enabled or not.
-		// NOTE: this uses yes/no rather than true/false.
-		add_settings_field(
-			'wl-analytics-enabled',
-			__( 'Enable Analytics', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-enable',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
-				'value'       => $this->configuration_service->is_analytics_enable() ? 'yes' : 'no',
-				'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
-			)
-		);
-
-		/**
-		 * A basic number field that will accept anything from 1 to 20.
-		 *
-		 * Represents the custom dim number for the uri.
-		 */
-		add_settings_field(
-			'wl-analytics-entity-uri-dimension',
-			__( 'Entity URI dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-entity-uri-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
-				'type'        => 'number',
-				'value'       => $this->configuration_service->get_analytics_entity_uri_dimension(),
-				'description' => __( 'Entity URI dimesion', 'wordlift' ),
-			)
-		);
-
-		/**
-		 * A basic number field that will accept anything from 1 to 20.
-		 *
-		 * Represents the custom dim number for the type.
-		 */
-		add_settings_field(
-			'wl-analytics-entity-type-dimension',
-			__( 'Entity Type dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-entity-type-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
-				'type'        => 'number',
-				'value'       => $this->configuration_service->get_analytics_entity_type_dimension(),
-				'description' => __( 'Entity Type dimension', 'wordlift' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Validates an entity uri based on an integer passed.
-	 *
-	 * TODO: Needs a feedback method to pass back error messages.
-	 *
-	 * @method validate_entity_uri
-	 * @param string $uri a sting representing an entity ID that can be converted to a uri.
-	 *
-	 * @return int
-	 * @since 3.21.0
-	 */
-	public function validate_entity_uri( $uri ) {
-		// Basic validation is to ensure number is between 1 and 20.
-		// NOTE: certain analytics accounts have a much higher value - as many
-		// as 200 are allowed.
-		if ( (int) $uri < 1 || (int) $uri > 20 ) {
-			// if we are out of range then pass the default value.
-			$uri = $this->configuration_service->get_analytics_entity_uri_dimension();
-		}
-
-		return absint( $uri );
-	}
-
-	/**
-	 * Validates an entity type.
-	 *
-	 * TODO: Needs a feedback method to pass back error messages.
-	 *
-	 * @method validate_entity_type
-	 * @param string $type This is an entity type ID in string form - really a number.
-	 *
-	 * @return int
-	 * @since  3.21.0
-	 */
-	public function validate_entity_type( $type ) {
-		// Basic validation is to ensure number is between 1 and 20.
-		// NOTE: certain analytics accounts have a much higher value - as many
-		// as 200 are allowed.
-		if ( (int) $type < 1 || (int) $type > 20 ) {
-			// if we are out of range then pass the default value.
-			$type = $this->configuration_service->get_analytics_entity_type_dimension();
-		}
-
-		return absint( $type );
-	}
-
-	/**
-	 * 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.21.0
-	 *
-	 */
-	public function sanitize_callback( $input ) {
-		if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
-			// Any failing nonce checks already die().
-			return;
-		}
-
-		/**
-		 * Validate and sanitize the $inputs and store them in $output saved.
-		 */
-		$output = array();
-		if ( isset( $input['analytics_enable'] ) ) {
-			$output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
-		}
-		if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
-			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
-		}
-		if ( isset( $input['analytics_entity_type_dimension'] ) ) {
-			// This dimension cannot be the same as the one set above. If it is
-			// then zero it out and it will fail validation.
-			if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
-				$input['analytics_entity_type_dimension'] = 0;
-			}
-			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
-		}
-
-		// return items added to the output for saving.
-		return $output;
-	}
+    /**
+     * A singleton instance of the Notice service.
+     *
+     * @since  3.21.0
+     * @access private
+     * @var \Wordlift_Admin_Settings_Analytics_Page $instance A singleton instance of a {@link Wordlift_Admin_Settings_Analytics_Page} class.
+     */
+    private static $instance;
+
+    /**
+     * A {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.21.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * A {@link Wordlift_Admin_Input_Element} element renderer.
+     *
+     * @since  3.21.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.21.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;
+
+    /**
+     * Create a {@link Wordlift_Admin_Settings_Page} instance.
+     *
+     * @param \Wordlift_Configuration_Service $configuration_service The wordlift configuration service.
+     * @param \Wordlift_Admin_Input_Element $input_element An input element class to output input boxes in a settings form.
+     * @param \Wordlift_Admin_Radio_Input_Element $radio_input_element A radio element input class for use in a settings form.
+     *
+     * @since 3.21.0
+     *
+     */
+    public function __construct( $configuration_service, $input_element, $radio_input_element ) {
+
+        $this->configuration_service = $configuration_service;
+
+        // Set a reference to the UI elements.
+        $this->input_element       = $input_element;
+        $this->radio_input_element = $radio_input_element;
+
+        // Adds this page to the main admin settings tabbed menu.
+        add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
+
+        self::$instance = $this;
+    }
+
+    /**
+     * Get the singleton instance of the Notice service.
+     *
+     * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
+     * @since 3.21.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function get_parent_slug() {
+
+        return 'wl_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function get_capability() {
+
+        return 'manage_options';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_page_title() {
+
+        return __( 'WorldLift Analytics Settings', 'wordlift' );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_menu_title() {
+
+        return __( 'Analytics Settings', 'wordlift' );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_menu_slug() {
+
+        return 'wl_configuration_admin_analytics_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_partial_name() {
+
+        return 'wordlift-admin-settings-analytics-page.php';
+    }
+
+    /**
+     * Returns the string to use for the tab slug on main admin settings page.
+     *
+     * @method get_admin_page_tab_slug
+     * @return string
+     * @since  3.21.0
+     */
+    public function get_admin_page_tab_slug() {
+        return 'analytics';
+    }
+
+    /**
+     * Adds pages to the tabs menu on the main admin settings page.
+     *
+     * @method add_admin_page_tab
+     * @param array $tabs an array of tab titles and slugs to use when building a tabbed menu on option pages.
+     *
+     * @since  3.21.0
+     */
+    public function add_admin_page_tab( $tabs ) {
+        if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
+            $tabs[] = array(
+                'title' => $this->get_menu_title(),
+                'slug'  => $this->get_admin_page_tab_slug(),
+            );
+        }
+
+        return $tabs;
+    }
+
+    /**
+     * Configure all the configuration parameters.
+     *
+     * Called by the *admin_init* hook.
+     *
+     * @since 3.21.0
+     */
+    public function admin_init() {
+
+        // Register WordLift's analytics settings with our in class sanitizer.
+        register_setting(
+            'wl_analytics_settings',
+            'wl_analytics_settings',
+            array( $this, 'sanitize_callback' )
+        );
+
+        // Add the analytics settings setction.
+        add_settings_section(
+            'wl_analytics_settings_section',
+            '',
+            '',
+            'wl_analytics_settings'
+        );
+
+        // Add a toggle to determine if analytics functions are enabled or not.
+        // NOTE: this uses yes/no rather than true/false.
+        add_settings_field(
+            'wl-analytics-enabled',
+            __( 'Enable Analytics', 'wordlift' ),
+            array( $this->radio_input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-enable',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
+                'value'       => $this->configuration_service->is_analytics_enable() ? 'yes' : 'no',
+                'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
+            )
+        );
+
+        /**
+         * A basic number field that will accept anything from 1 to 20.
+         *
+         * Represents the custom dim number for the uri.
+         */
+        add_settings_field(
+            'wl-analytics-entity-uri-dimension',
+            __( 'Entity URI dimension', 'wordlift' ),
+            array( $this->input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-entity-uri-dimension',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
+                'type'        => 'number',
+                'value'       => $this->configuration_service->get_analytics_entity_uri_dimension(),
+                'description' => __( 'Entity URI dimesion', 'wordlift' ),
+            )
+        );
+
+        /**
+         * A basic number field that will accept anything from 1 to 20.
+         *
+         * Represents the custom dim number for the type.
+         */
+        add_settings_field(
+            'wl-analytics-entity-type-dimension',
+            __( 'Entity Type dimension', 'wordlift' ),
+            array( $this->input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-entity-type-dimension',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
+                'type'        => 'number',
+                'value'       => $this->configuration_service->get_analytics_entity_type_dimension(),
+                'description' => __( 'Entity Type dimension', 'wordlift' ),
+            )
+        );
+
+    }
+
+    /**
+     * Validates an entity uri based on an integer passed.
+     *
+     * TODO: Needs a feedback method to pass back error messages.
+     *
+     * @method validate_entity_uri
+     * @param string $uri a sting representing an entity ID that can be converted to a uri.
+     *
+     * @return int
+     * @since 3.21.0
+     */
+    public function validate_entity_uri( $uri ) {
+        // Basic validation is to ensure number is between 1 and 20.
+        // NOTE: certain analytics accounts have a much higher value - as many
+        // as 200 are allowed.
+        if ( (int) $uri < 1 || (int) $uri > 20 ) {
+            // if we are out of range then pass the default value.
+            $uri = $this->configuration_service->get_analytics_entity_uri_dimension();
+        }
+
+        return absint( $uri );
+    }
+
+    /**
+     * Validates an entity type.
+     *
+     * TODO: Needs a feedback method to pass back error messages.
+     *
+     * @method validate_entity_type
+     * @param string $type This is an entity type ID in string form - really a number.
+     *
+     * @return int
+     * @since  3.21.0
+     */
+    public function validate_entity_type( $type ) {
+        // Basic validation is to ensure number is between 1 and 20.
+        // NOTE: certain analytics accounts have a much higher value - as many
+        // as 200 are allowed.
+        if ( (int) $type < 1 || (int) $type > 20 ) {
+            // if we are out of range then pass the default value.
+            $type = $this->configuration_service->get_analytics_entity_type_dimension();
+        }
+
+        return absint( $type );
+    }
+
+    /**
+     * 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.21.0
+     *
+     */
+    public function sanitize_callback( $input ) {
+        if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
+            // Any failing nonce checks already die().
+            return;
+        }
+
+        /**
+         * Validate and sanitize the $inputs and store them in $output saved.
+         */
+        $output = array();
+        if ( isset( $input['analytics_enable'] ) ) {
+            $output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
+        }
+        if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
+            $output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
+        }
+        if ( isset( $input['analytics_entity_type_dimension'] ) ) {
+            // This dimension cannot be the same as the one set above. If it is
+            // then zero it out and it will fail validation.
+            if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
+                $input['analytics_entity_type_dimension'] = 0;
+            }
+            $output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
+        }
+
+        // return items added to the output for saving.
+        return $output;
+    }
 
 
 }

Spacing +34 added lines, -34 removed lines

@@ -64,7 +64,7 @@ 
 	 * @since 3.21.0
 	 *
 	 */
-	public function __construct( $configuration_service, $input_element, $radio_input_element ) {
+	public function __construct($configuration_service, $input_element, $radio_input_element) {
 
 		$this->configuration_service = $configuration_service;
 
@@ -73,7 +73,7 @@ 
 		$this->radio_input_element = $radio_input_element;
 
 		// Adds this page to the main admin settings tabbed menu.
-		add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
+		add_filter('wl_admin_page_tabs', array($this, 'add_admin_page_tab'));
 
 		self::$instance = $this;
 	}
@@ -110,7 +110,7 @@ 
 	 */
 	public function get_page_title() {
 
-		return __( 'WorldLift Analytics Settings', 'wordlift' );
+		return __('WorldLift Analytics Settings', 'wordlift');
 	}
 
 	/**
@@ -118,7 +118,7 @@ 
 	 */
 	public function get_menu_title() {
 
-		return __( 'Analytics Settings', 'wordlift' );
+		return __('Analytics Settings', 'wordlift');
 	}
 
 	/**
@@ -156,8 +156,8 @@ 
 	 *
 	 * @since  3.21.0
 	 */
-	public function add_admin_page_tab( $tabs ) {
-		if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
+	public function add_admin_page_tab($tabs) {
+		if (apply_filters('wl_feature__enable__analytics', true)) {
 			$tabs[] = array(
 				'title' => $this->get_menu_title(),
 				'slug'  => $this->get_admin_page_tab_slug(),
@@ -180,7 +180,7 @@ 
 		register_setting(
 			'wl_analytics_settings',
 			'wl_analytics_settings',
-			array( $this, 'sanitize_callback' )
+			array($this, 'sanitize_callback')
 		);
 
 		// Add the analytics settings setction.
@@ -195,15 +195,15 @@ 
 		// NOTE: this uses yes/no rather than true/false.
 		add_settings_field(
 			'wl-analytics-enabled',
-			__( 'Enable Analytics', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
+			__('Enable Analytics', 'wordlift'),
+			array($this->radio_input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-enable',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENABLE.']',
 				'value'       => $this->configuration_service->is_analytics_enable() ? 'yes' : 'no',
-				'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
+				'description' => __('Toggle on/off the default values.', 'wordlift'),
 			)
 		);
 
@@ -214,16 +214,16 @@ 
 		 */
 		add_settings_field(
 			'wl-analytics-entity-uri-dimension',
-			__( 'Entity URI dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
+			__('Entity URI dimension', 'wordlift'),
+			array($this->input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-entity-uri-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION.']',
 				'type'        => 'number',
 				'value'       => $this->configuration_service->get_analytics_entity_uri_dimension(),
-				'description' => __( 'Entity URI dimesion', 'wordlift' ),
+				'description' => __('Entity URI dimesion', 'wordlift'),
 			)
 		);
 
@@ -234,16 +234,16 @@ 
 		 */
 		add_settings_field(
 			'wl-analytics-entity-type-dimension',
-			__( 'Entity Type dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
+			__('Entity Type dimension', 'wordlift'),
+			array($this->input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-entity-type-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION.']',
 				'type'        => 'number',
 				'value'       => $this->configuration_service->get_analytics_entity_type_dimension(),
-				'description' => __( 'Entity Type dimension', 'wordlift' ),
+				'description' => __('Entity Type dimension', 'wordlift'),
 			)
 		);
 
@@ -260,16 +260,16 @@ 
 	 * @return int
 	 * @since 3.21.0
 	 */
-	public function validate_entity_uri( $uri ) {
+	public function validate_entity_uri($uri) {
 		// Basic validation is to ensure number is between 1 and 20.
 		// NOTE: certain analytics accounts have a much higher value - as many
 		// as 200 are allowed.
-		if ( (int) $uri < 1 || (int) $uri > 20 ) {
+		if ((int) $uri < 1 || (int) $uri > 20) {
 			// if we are out of range then pass the default value.
 			$uri = $this->configuration_service->get_analytics_entity_uri_dimension();
 		}
 
-		return absint( $uri );
+		return absint($uri);
 	}
 
 	/**
@@ -283,16 +283,16 @@ 
 	 * @return int
 	 * @since  3.21.0
 	 */
-	public function validate_entity_type( $type ) {
+	public function validate_entity_type($type) {
 		// Basic validation is to ensure number is between 1 and 20.
 		// NOTE: certain analytics accounts have a much higher value - as many
 		// as 200 are allowed.
-		if ( (int) $type < 1 || (int) $type > 20 ) {
+		if ((int) $type < 1 || (int) $type > 20) {
 			// if we are out of range then pass the default value.
 			$type = $this->configuration_service->get_analytics_entity_type_dimension();
 		}
 
-		return absint( $type );
+		return absint($type);
 	}
 
 	/**
@@ -307,8 +307,8 @@ 
 	 * @since 3.21.0
 	 *
 	 */
-	public function sanitize_callback( $input ) {
-		if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
+	public function sanitize_callback($input) {
+		if ( ! check_admin_referer('wl_analytics_settings-options')) {
 			// Any failing nonce checks already die().
 			return;
 		}
@@ -317,19 +317,19 @@ 
 		 * Validate and sanitize the $inputs and store them in $output saved.
 		 */
 		$output = array();
-		if ( isset( $input['analytics_enable'] ) ) {
-			$output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
+		if (isset($input['analytics_enable'])) {
+			$output['analytics_enable'] = ('yes' === $input['analytics_enable']) ? 'yes' : 'no';
 		}
-		if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
-			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
+		if (isset($input['analytics_entity_uri_dimension'])) {
+			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri($input['analytics_entity_uri_dimension']);
 		}
-		if ( isset( $input['analytics_entity_type_dimension'] ) ) {
+		if (isset($input['analytics_entity_type_dimension'])) {
 			// This dimension cannot be the same as the one set above. If it is
 			// then zero it out and it will fail validation.
-			if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
+			if (isset($output['analytics_entity_uri_dimension']) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension']) {
 				$input['analytics_entity_type_dimension'] = 0;
 			}
-			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
+			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type($input['analytics_entity_type_dimension']);
 		}
 
 		// return items added to the output for saving.

src/wordlift/post-excerpt/class-post-excerpt-rest-controller.php

Indentation +197 added lines, -197 removed lines

@@ -18,202 +18,202 @@
 
 class Post_Excerpt_Rest_Controller {
 
-	const POST_EXCERPT_NAMESPACE = 'post-excerpt';
-	/**
-	 * Key for storing the meta data for the wordlift post excerpt.
-	 */
-	const POST_EXCERPT_META_KEY = '_wl_post_excerpt_meta';
-
-	/**
-	 * Url for getting the post excerpt data from wordlift api.
-	 */
-	const WORDLIFT_POST_EXCERPT_ENDPOINT = '/summarize';
-
-	/**
-	 * Wordlift returns excerpt in response using this key..
-	 */
-	const WORDLIFT_POST_EXCERPT_RESPONSE_KEY = 'summary';
-
-	public static function register_routes() {
-		add_action( 'rest_api_init', 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::register_route_callback' );
-	}
-
-	/**
-	 * Determines whether we need to get the excerpt from wordlift api,
-	 * or just use the one we already obtained by generating the hash and comparing it
-	 * with the previous one.
-	 *
-	 * @param $request WP_REST_Request $request {@link WP_REST_Request instance}.
-	 *
-	 * @return array Post excerpt data.
-	 */
-	public static function get_post_excerpt( $request ) {
-		$data            = $request->get_params();
-		$post_id         = $data['post_id'];
-		$post_body       = strip_shortcodes( $data['post_body'] );
-		$current_hash    = md5( $post_body );
-		$server_response = self::get_post_excerpt_conditionally( $post_id, $post_body, $current_hash );
-		if ( empty( $server_response ) || ! array_key_exists( 'post_excerpt', $server_response ) ) {
-			return array(
-				'status'  => 'error',
-				'message' => __( 'Unable to contact WordLift API', 'wordlift' )
-			);
-		} else {
-			return array(
-				'status'       => 'success',
-				'post_excerpt' => $server_response['post_excerpt'],
-				'from_cache'   => $server_response['from_cache'],
-				'message'      => __( 'Excerpt successfully generated.', 'wordlift' )
-			);
-		}
-
-	}
-
-	/**
-	 * This function determines whether to get the excerpt from the server or from the meta cache.
-	 *
-	 * @param $post_id int The Post id.
-	 * @param $post_body string The post content
-	 * @param $current_hash string md5 hash of the current post body.
-	 *
-	 * @return array|bool|null
-	 */
-	public static function get_post_excerpt_conditionally( $post_id, $post_body, $current_hash ) {
-		$previous_data   = get_post_meta( $post_id, self::POST_EXCERPT_META_KEY, true );
-		$server_response = null;
-		if ( $previous_data === "" ) {
-			// There is no data in meta, so just fetch the data from remote server.
-			$server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
-		} else {
-			// If there is data in meta, get the previous hash and compare.
-			$previous_hash = $previous_data['post_body_hash'];
-
-			if ( $current_hash === $previous_hash ) {
-				// then return the previous value.
-				$server_response = array(
-					'post_excerpt' => $previous_data['post_excerpt'],
-					'from_cache'   => true
-				);
-			} else {
-				// send the request to external API and then send the response.
-				$server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
-			}
-		}
-
-		return $server_response;
-	}
-
-	/**
-	 * Sends the remote request to the wordlift API and saves the response in meta for
-	 * future use.
-	 *
-	 * @param $post_id int Post id which the post excerpt belongs to
-	 * @param $post_body string Total text content of the post body.
-	 *
-	 * @return array|bool
-	 */
-	public static function get_post_excerpt_from_remote_server( $post_id, $post_body ) {
-		// The configuration is constant for now, it might be changing in future.
-		$configuration = array(
-			'ratio'      => 0.0005,
-			'min_length' => 60
-		);
-		// Construct the url with the configuration
-		$endpoint    = add_query_arg( $configuration, self::WORDLIFT_POST_EXCERPT_ENDPOINT );
-		$api_service = Default_Api_Service::get_instance();
-		$response    = $api_service->request(
-			'POST',
-			$endpoint,
-			array( 'Content-Type' => 'text/plain' ),
-			$post_body,
-			null,
-			null,
-			array( 'data_format' => 'body' )
-		);
-
-		return self::save_response_to_meta_on_success( $post_id, $post_body, $response );
-	}
-
-	/**
-	 * Save the post excerpt to meta if the response is successful.
-	 *
-	 * @param $post_id int The post id
-	 * @param $post_body string Full text content of the post.
-	 * @param $response Response instance
-	 *
-	 * @return array|bool
-	 */
-	public static function save_response_to_meta_on_success( $post_id, $post_body, $response ) {
-		// If body exists then decode the body.
-		$body = json_decode( $response->get_body(), true );
-		if ( empty( $body ) || ! array_key_exists( self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY, $body ) ) {
-			// Bail out if we get an incorrect response
-			return false;
-		} else {
-			$post_excerpt = (string) $body[ self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY ];
-			// Save it to meta.
-			self::save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body );
-
-			return array(
-				'post_excerpt' => $post_excerpt,
-				'from_cache'   => false
-			);
-		}
-	}
-
-	/**
-	 * Saves the excerpt in the post meta.
-	 *
-	 * @param $post_id int Post id which the post excerpt belongs to
-	 * @param $post_excerpt string Post excerpt returned by the server
-	 * @param $post_body string Total text content of the post body.
-	 *
-	 * @return void
-	 */
-	public static function save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body ) {
-		// hash the post body and save it.
-		$data = array(
-			'post_body_hash' => md5( $post_body ),
-			'post_excerpt'   => $post_excerpt
-		);
-		update_post_meta( $post_id, self::POST_EXCERPT_META_KEY, $data );
-	}
-
-	/**
-	 * This call back is invoked by the Rest api action.
-	 */
-	public static function register_route_callback() {
-		/** @var  $post_id_validation_settings array Settings used to validate post id */
-		$post_id_validation_settings   = array(
-			'required'          => true,
-			'validate_callback' => function ( $param, $request, $key ) {
-				return is_numeric( $param );
-			}
-		);
-		$post_body_validation_settings = array(
-			'required'          => true,
-			'validate_callback' => function ( $param, $request, $key ) {
-				return is_string( $param );
-			}
-		);
-		/**
-		 * Rest route for getting the excerpt from wordlift api.
-		 */
-		register_rest_route(
-			WL_REST_ROUTE_DEFAULT_NAMESPACE,
-			'/' . self::POST_EXCERPT_NAMESPACE . '/(?P<post_id>\d+)',
-			array(
-				'methods'             => \WP_REST_Server::CREATABLE,
-				'callback'            => 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::get_post_excerpt',
-				'permission_callback' => function () {
-					return current_user_can( 'publish_posts' );
-				},
-				'args'                => array(
-					'post_id'   => $post_id_validation_settings,
-					'post_body' => $post_body_validation_settings
-				)
-			)
-		);
-	}
+    const POST_EXCERPT_NAMESPACE = 'post-excerpt';
+    /**
+     * Key for storing the meta data for the wordlift post excerpt.
+     */
+    const POST_EXCERPT_META_KEY = '_wl_post_excerpt_meta';
+
+    /**
+     * Url for getting the post excerpt data from wordlift api.
+     */
+    const WORDLIFT_POST_EXCERPT_ENDPOINT = '/summarize';
+
+    /**
+     * Wordlift returns excerpt in response using this key..
+     */
+    const WORDLIFT_POST_EXCERPT_RESPONSE_KEY = 'summary';
+
+    public static function register_routes() {
+        add_action( 'rest_api_init', 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::register_route_callback' );
+    }
+
+    /**
+     * Determines whether we need to get the excerpt from wordlift api,
+     * or just use the one we already obtained by generating the hash and comparing it
+     * with the previous one.
+     *
+     * @param $request WP_REST_Request $request {@link WP_REST_Request instance}.
+     *
+     * @return array Post excerpt data.
+     */
+    public static function get_post_excerpt( $request ) {
+        $data            = $request->get_params();
+        $post_id         = $data['post_id'];
+        $post_body       = strip_shortcodes( $data['post_body'] );
+        $current_hash    = md5( $post_body );
+        $server_response = self::get_post_excerpt_conditionally( $post_id, $post_body, $current_hash );
+        if ( empty( $server_response ) || ! array_key_exists( 'post_excerpt', $server_response ) ) {
+            return array(
+                'status'  => 'error',
+                'message' => __( 'Unable to contact WordLift API', 'wordlift' )
+            );
+        } else {
+            return array(
+                'status'       => 'success',
+                'post_excerpt' => $server_response['post_excerpt'],
+                'from_cache'   => $server_response['from_cache'],
+                'message'      => __( 'Excerpt successfully generated.', 'wordlift' )
+            );
+        }
+
+    }
+
+    /**
+     * This function determines whether to get the excerpt from the server or from the meta cache.
+     *
+     * @param $post_id int The Post id.
+     * @param $post_body string The post content
+     * @param $current_hash string md5 hash of the current post body.
+     *
+     * @return array|bool|null
+     */
+    public static function get_post_excerpt_conditionally( $post_id, $post_body, $current_hash ) {
+        $previous_data   = get_post_meta( $post_id, self::POST_EXCERPT_META_KEY, true );
+        $server_response = null;
+        if ( $previous_data === "" ) {
+            // There is no data in meta, so just fetch the data from remote server.
+            $server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
+        } else {
+            // If there is data in meta, get the previous hash and compare.
+            $previous_hash = $previous_data['post_body_hash'];
+
+            if ( $current_hash === $previous_hash ) {
+                // then return the previous value.
+                $server_response = array(
+                    'post_excerpt' => $previous_data['post_excerpt'],
+                    'from_cache'   => true
+                );
+            } else {
+                // send the request to external API and then send the response.
+                $server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
+            }
+        }
+
+        return $server_response;
+    }
+
+    /**
+     * Sends the remote request to the wordlift API and saves the response in meta for
+     * future use.
+     *
+     * @param $post_id int Post id which the post excerpt belongs to
+     * @param $post_body string Total text content of the post body.
+     *
+     * @return array|bool
+     */
+    public static function get_post_excerpt_from_remote_server( $post_id, $post_body ) {
+        // The configuration is constant for now, it might be changing in future.
+        $configuration = array(
+            'ratio'      => 0.0005,
+            'min_length' => 60
+        );
+        // Construct the url with the configuration
+        $endpoint    = add_query_arg( $configuration, self::WORDLIFT_POST_EXCERPT_ENDPOINT );
+        $api_service = Default_Api_Service::get_instance();
+        $response    = $api_service->request(
+            'POST',
+            $endpoint,
+            array( 'Content-Type' => 'text/plain' ),
+            $post_body,
+            null,
+            null,
+            array( 'data_format' => 'body' )
+        );
+
+        return self::save_response_to_meta_on_success( $post_id, $post_body, $response );
+    }
+
+    /**
+     * Save the post excerpt to meta if the response is successful.
+     *
+     * @param $post_id int The post id
+     * @param $post_body string Full text content of the post.
+     * @param $response Response instance
+     *
+     * @return array|bool
+     */
+    public static function save_response_to_meta_on_success( $post_id, $post_body, $response ) {
+        // If body exists then decode the body.
+        $body = json_decode( $response->get_body(), true );
+        if ( empty( $body ) || ! array_key_exists( self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY, $body ) ) {
+            // Bail out if we get an incorrect response
+            return false;
+        } else {
+            $post_excerpt = (string) $body[ self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY ];
+            // Save it to meta.
+            self::save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body );
+
+            return array(
+                'post_excerpt' => $post_excerpt,
+                'from_cache'   => false
+            );
+        }
+    }
+
+    /**
+     * Saves the excerpt in the post meta.
+     *
+     * @param $post_id int Post id which the post excerpt belongs to
+     * @param $post_excerpt string Post excerpt returned by the server
+     * @param $post_body string Total text content of the post body.
+     *
+     * @return void
+     */
+    public static function save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body ) {
+        // hash the post body and save it.
+        $data = array(
+            'post_body_hash' => md5( $post_body ),
+            'post_excerpt'   => $post_excerpt
+        );
+        update_post_meta( $post_id, self::POST_EXCERPT_META_KEY, $data );
+    }
+
+    /**
+     * This call back is invoked by the Rest api action.
+     */
+    public static function register_route_callback() {
+        /** @var  $post_id_validation_settings array Settings used to validate post id */
+        $post_id_validation_settings   = array(
+            'required'          => true,
+            'validate_callback' => function ( $param, $request, $key ) {
+                return is_numeric( $param );
+            }
+        );
+        $post_body_validation_settings = array(
+            'required'          => true,
+            'validate_callback' => function ( $param, $request, $key ) {
+                return is_string( $param );
+            }
+        );
+        /**
+         * Rest route for getting the excerpt from wordlift api.
+         */
+        register_rest_route(
+            WL_REST_ROUTE_DEFAULT_NAMESPACE,
+            '/' . self::POST_EXCERPT_NAMESPACE . '/(?P<post_id>\d+)',
+            array(
+                'methods'             => \WP_REST_Server::CREATABLE,
+                'callback'            => 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::get_post_excerpt',
+                'permission_callback' => function () {
+                    return current_user_can( 'publish_posts' );
+                },
+                'args'                => array(
+                    'post_id'   => $post_id_validation_settings,
+                    'post_body' => $post_body_validation_settings
+                )
+            )
+        );
+    }
 
 }

Spacing +35 added lines, -35 removed lines

@@ -35,7 +35,7 @@ 
 	const WORDLIFT_POST_EXCERPT_RESPONSE_KEY = 'summary';
 
 	public static function register_routes() {
-		add_action( 'rest_api_init', 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::register_route_callback' );
+		add_action('rest_api_init', 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::register_route_callback');
 	}
 
 	/**
@@ -47,23 +47,23 @@ 
 	 *
 	 * @return array Post excerpt data.
 	 */
-	public static function get_post_excerpt( $request ) {
+	public static function get_post_excerpt($request) {
 		$data            = $request->get_params();
 		$post_id         = $data['post_id'];
-		$post_body       = strip_shortcodes( $data['post_body'] );
-		$current_hash    = md5( $post_body );
-		$server_response = self::get_post_excerpt_conditionally( $post_id, $post_body, $current_hash );
-		if ( empty( $server_response ) || ! array_key_exists( 'post_excerpt', $server_response ) ) {
+		$post_body       = strip_shortcodes($data['post_body']);
+		$current_hash    = md5($post_body);
+		$server_response = self::get_post_excerpt_conditionally($post_id, $post_body, $current_hash);
+		if (empty($server_response) || ! array_key_exists('post_excerpt', $server_response)) {
 			return array(
 				'status'  => 'error',
-				'message' => __( 'Unable to contact WordLift API', 'wordlift' )
+				'message' => __('Unable to contact WordLift API', 'wordlift')
 			);
 		} else {
 			return array(
 				'status'       => 'success',
 				'post_excerpt' => $server_response['post_excerpt'],
 				'from_cache'   => $server_response['from_cache'],
-				'message'      => __( 'Excerpt successfully generated.', 'wordlift' )
+				'message'      => __('Excerpt successfully generated.', 'wordlift')
 			);
 		}
 
@@ -78,17 +78,17 @@ 
 	 *
 	 * @return array|bool|null
 	 */
-	public static function get_post_excerpt_conditionally( $post_id, $post_body, $current_hash ) {
-		$previous_data   = get_post_meta( $post_id, self::POST_EXCERPT_META_KEY, true );
+	public static function get_post_excerpt_conditionally($post_id, $post_body, $current_hash) {
+		$previous_data   = get_post_meta($post_id, self::POST_EXCERPT_META_KEY, true);
 		$server_response = null;
-		if ( $previous_data === "" ) {
+		if ($previous_data === "") {
 			// There is no data in meta, so just fetch the data from remote server.
-			$server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
+			$server_response = self::get_post_excerpt_from_remote_server($post_id, $post_body);
 		} else {
 			// If there is data in meta, get the previous hash and compare.
 			$previous_hash = $previous_data['post_body_hash'];
 
-			if ( $current_hash === $previous_hash ) {
+			if ($current_hash === $previous_hash) {
 				// then return the previous value.
 				$server_response = array(
 					'post_excerpt' => $previous_data['post_excerpt'],
@@ -96,7 +96,7 @@ 
 				);
 			} else {
 				// send the request to external API and then send the response.
-				$server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
+				$server_response = self::get_post_excerpt_from_remote_server($post_id, $post_body);
 			}
 		}
 
@@ -112,26 +112,26 @@ 
 	 *
 	 * @return array|bool
 	 */
-	public static function get_post_excerpt_from_remote_server( $post_id, $post_body ) {
+	public static function get_post_excerpt_from_remote_server($post_id, $post_body) {
 		// The configuration is constant for now, it might be changing in future.
 		$configuration = array(
 			'ratio'      => 0.0005,
 			'min_length' => 60
 		);
 		// Construct the url with the configuration
-		$endpoint    = add_query_arg( $configuration, self::WORDLIFT_POST_EXCERPT_ENDPOINT );
+		$endpoint    = add_query_arg($configuration, self::WORDLIFT_POST_EXCERPT_ENDPOINT);
 		$api_service = Default_Api_Service::get_instance();
 		$response    = $api_service->request(
 			'POST',
 			$endpoint,
-			array( 'Content-Type' => 'text/plain' ),
+			array('Content-Type' => 'text/plain'),
 			$post_body,
 			null,
 			null,
-			array( 'data_format' => 'body' )
+			array('data_format' => 'body')
 		);
 
-		return self::save_response_to_meta_on_success( $post_id, $post_body, $response );
+		return self::save_response_to_meta_on_success($post_id, $post_body, $response);
 	}
 
 	/**
@@ -143,16 +143,16 @@ 
 	 *
 	 * @return array|bool
 	 */
-	public static function save_response_to_meta_on_success( $post_id, $post_body, $response ) {
+	public static function save_response_to_meta_on_success($post_id, $post_body, $response) {
 		// If body exists then decode the body.
-		$body = json_decode( $response->get_body(), true );
-		if ( empty( $body ) || ! array_key_exists( self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY, $body ) ) {
+		$body = json_decode($response->get_body(), true);
+		if (empty($body) || ! array_key_exists(self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY, $body)) {
 			// Bail out if we get an incorrect response
 			return false;
 		} else {
-			$post_excerpt = (string) $body[ self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY ];
+			$post_excerpt = (string) $body[self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY];
 			// Save it to meta.
-			self::save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body );
+			self::save_post_excerpt_in_meta($post_id, $post_excerpt, $post_body);
 
 			return array(
 				'post_excerpt' => $post_excerpt,
@@ -170,13 +170,13 @@ 
 	 *
 	 * @return void
 	 */
-	public static function save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body ) {
+	public static function save_post_excerpt_in_meta($post_id, $post_excerpt, $post_body) {
 		// hash the post body and save it.
 		$data = array(
-			'post_body_hash' => md5( $post_body ),
+			'post_body_hash' => md5($post_body),
 			'post_excerpt'   => $post_excerpt
 		);
-		update_post_meta( $post_id, self::POST_EXCERPT_META_KEY, $data );
+		update_post_meta($post_id, self::POST_EXCERPT_META_KEY, $data);
 	}
 
 	/**
@@ -184,16 +184,16 @@ 
 	 */
 	public static function register_route_callback() {
 		/** @var  $post_id_validation_settings array Settings used to validate post id */
-		$post_id_validation_settings   = array(
+		$post_id_validation_settings = array(
 			'required'          => true,
-			'validate_callback' => function ( $param, $request, $key ) {
-				return is_numeric( $param );
+			'validate_callback' => function($param, $request, $key) {
+				return is_numeric($param);
 			}
 		);
 		$post_body_validation_settings = array(
 			'required'          => true,
-			'validate_callback' => function ( $param, $request, $key ) {
-				return is_string( $param );
+			'validate_callback' => function($param, $request, $key) {
+				return is_string($param);
 			}
 		);
 		/**
@@ -201,12 +201,12 @@ 
 		 */
 		register_rest_route(
 			WL_REST_ROUTE_DEFAULT_NAMESPACE,
-			'/' . self::POST_EXCERPT_NAMESPACE . '/(?P<post_id>\d+)',
+			'/'.self::POST_EXCERPT_NAMESPACE.'/(?P<post_id>\d+)',
 			array(
 				'methods'             => \WP_REST_Server::CREATABLE,
 				'callback'            => 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::get_post_excerpt',
-				'permission_callback' => function () {
-					return current_user_can( 'publish_posts' );
+				'permission_callback' => function() {
+					return current_user_can('publish_posts');
 				},
 				'args'                => array(
 					'post_id'   => $post_id_validation_settings,