insideout10 / wordlift-plugin

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

Doc Comments +1 added lines, -1 removed lines

@@ -651,7 +651,7 @@
 	/**
 	 * Get the 'analytics-enable' option.
 	 *
-	 * @return string 'no' or 'yes' representing bool.
+	 * @return boolean 'no' or 'yes' representing bool.
 	 * @since 3.21.0
 	 *
 	 */

Indentation +707 added lines, -707 removed lines

@@ -11,7 +11,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -21,715 +21,715 @@ 
  */
 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
-	 *
-	 */
-	public function get_dataset_uri() {
-
-		return $this->get( 'wl_advanced_settings', self::DATASET_URI, 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
-		 *
-		 */
-		$site_url = apply_filters( 'wl_production_site_url', site_url() );
-
-		// Build the URL.
-		$url = $this->get_accounts()
-		       . '?key=' . rawurlencode( $key )
-		       . '&url=' . rawurlencode( $site_url )
-		       . '&country=' . $this->get_country_code()
-		       . '&language=' . $this->get_language_code();
-
-		$args = wp_parse_args( unserialize( WL_REDLINK_API_HTTP_OPTIONS ), array(
-			'method' => 'PUT',
-		) );
-
-		$response = wp_remote_request( $url, $args );
-
-		// 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 ( 200 !== (int) $response['response']['code'] ) {
-			$this->log->error( "Unexpected status code when opening URL $url: " . $response['response']['code'] );
-
-			$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
+     *
+     */
+    public function get_dataset_uri() {
+
+        return $this->get( 'wl_advanced_settings', self::DATASET_URI, 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
+         *
+         */
+        $site_url = apply_filters( 'wl_production_site_url', site_url() );
+
+        // Build the URL.
+        $url = $this->get_accounts()
+                . '?key=' . rawurlencode( $key )
+                . '&url=' . rawurlencode( $site_url )
+                . '&country=' . $this->get_country_code()
+                . '&language=' . $this->get_language_code();
+
+        $args = wp_parse_args( unserialize( WL_REDLINK_API_HTTP_OPTIONS ), array(
+            'method' => 'PUT',
+        ) );
+
+        $response = wp_remote_request( $url, $args );
+
+        // 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 ( 200 !== (int) $response['response']['code'] ) {
+            $this->log->error( "Unexpected status code when opening URL $url: " . $response['response']['code'] );
+
+            $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'] );
-		$dataset_uri  = $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 API URI to retrieve the account info using the WordLift Key.
-	 *
-	 * @param string $key The WordLift key to use.
-	 *
-	 * @return string The API URI.
-	 * @since 3.26.0
-	 *
-	 */
-	public function get_accounts_info_by_key( $key ) {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/info";
-	}
-
-	/**
-	 * 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'] );
+        $dataset_uri  = $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 API URI to retrieve the account info using the WordLift Key.
+     *
+     * @param string $key The WordLift key to use.
+     *
+     * @return string The API URI.
+     * @since 3.26.0
+     *
+     */
+    public function get_accounts_info_by_key( $key ) {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/info";
+    }
+
+    /**
+     * 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 +89 added lines, -89 removed lines

@@ -10,7 +10,7 @@ 
  * @since      3.6.0
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -138,7 +138,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;
 
@@ -168,11 +168,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;
 	}
 
 	/**
@@ -185,12 +185,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);
 
 	}
 
@@ -203,7 +203,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');
 	}
 
 	/**
@@ -214,9 +214,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);
 
 	}
 
@@ -229,7 +229,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);
 	}
 
 	/**
@@ -240,9 +240,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);
 
 	}
 
@@ -255,7 +255,7 @@ 
 	 */
 	public function get_key() {
 
-		return $this->get( 'wl_general_settings', self::KEY, '' );
+		return $this->get('wl_general_settings', self::KEY, '');
 	}
 
 	/**
@@ -266,9 +266,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);
 	}
 
 	/**
@@ -282,7 +282,7 @@ 
 	 */
 	public function get_language_code() {
 
-		return $this->get( 'wl_general_settings', self::LANGUAGE, 'en' );
+		return $this->get('wl_general_settings', self::LANGUAGE, 'en');
 	}
 
 	/**
@@ -293,9 +293,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);
 
 	}
 
@@ -307,9 +307,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);
 
 	}
 
@@ -320,7 +320,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');
 	}
 
 	/**
@@ -332,7 +332,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');
 	}
 
 	/**
@@ -343,9 +343,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);
 
 	}
 
@@ -361,7 +361,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);
 	}
 
 	/**
@@ -372,9 +372,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);
 
 	}
 
@@ -387,7 +387,7 @@ 
 	 */
 	public function get_dataset_uri() {
 
-		return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
+		return $this->get('wl_advanced_settings', self::DATASET_URI, null);
 	}
 
 	/**
@@ -398,9 +398,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);
 	}
 
 	/**
@@ -412,7 +412,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);
 	}
 
 	/**
@@ -423,9 +423,9 @@ 
 	 * @since 3.20.0
 	 *
 	 */
-	public function set_package_type( $value ) {
+	public function set_package_type($value) {
 
-		$this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
+		$this->set('wl_advanced_settings', self::PACKAGE_TYPE, $value);
 	}
 
 	/**
@@ -441,11 +441,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.
@@ -454,12 +454,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);
 
 	}
 
@@ -475,15 +475,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;
 		}
@@ -498,37 +498,37 @@ 
 		 * @since 3.20.0
 		 *
 		 */
-		$site_url = apply_filters( 'wl_production_site_url', site_url() );
+		$site_url = apply_filters('wl_production_site_url', site_url());
 
 		// Build the URL.
 		$url = $this->get_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();
 
-		$args = wp_parse_args( unserialize( WL_REDLINK_API_HTTP_OPTIONS ), array(
+		$args = wp_parse_args(unserialize(WL_REDLINK_API_HTTP_OPTIONS), array(
 			'method' => 'PUT',
-		) );
+		));
 
-		$response = wp_remote_request( $url, $args );
+		$response = wp_remote_request($url, $args);
 
 		// 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 ( 200 !== (int) $response['response']['code'] ) {
-			$this->log->error( "Unexpected status code when opening URL $url: " . $response['response']['code'] );
+		if (200 !== (int) $response['response']['code']) {
+			$this->log->error("Unexpected status code when opening URL $url: ".$response['response']['code']);
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+			$this->set_dataset_uri('');
+			$this->set_package_type(null);
 
 			return;
 		}
@@ -538,14 +538,14 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$json         = json_decode( $response['body'] );
+		$json         = json_decode($response['body']);
 		$dataset_uri  = $json->datasetURI;
-		$package_type = isset( $json->packageType ) ? $json->packageType : null;
+		$package_type = isset($json->packageType) ? $json->packageType : null;
 
-		$this->log->info( "Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]..." );
+		$this->log->info("Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]...");
 
-		$this->set_dataset_uri( $dataset_uri );
-		$this->set_package_type( $package_type );
+		$this->set_dataset_uri($dataset_uri);
+		$this->set_package_type($package_type);
 
 	}
 
@@ -564,20 +564,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;
@@ -592,9 +592,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";
 	}
 
 	/**
@@ -606,9 +606,9 @@ 
 	 * @since 3.26.0
 	 *
 	 */
-	public function get_accounts_info_by_key( $key ) {
+	public function get_accounts_info_by_key($key) {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/info";
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE."accounts/info";
 	}
 
 	/**
@@ -620,7 +620,7 @@ 
 	 */
 	public function get_accounts() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'accounts';
 	}
 
 	/**
@@ -632,7 +632,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');
 	}
 
 	/**
@@ -643,9 +643,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');
 	}
 
 	/**
@@ -656,7 +656,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');
 	}
 
 	/**
@@ -667,9 +667,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');
 	}
 
 	/**
@@ -680,7 +680,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);
 	}
 
 	/**
@@ -691,7 +691,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);
 	}
 
 	/**
@@ -703,7 +703,7 @@ 
 	 */
 	public function get_autocomplete_url() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'autocomplete';
 
 	}
 
@@ -716,7 +716,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/includes/class-wordlift-abstract-post-to-jsonld-converter.php

Indentation +295 added lines, -295 removed lines

@@ -18,320 +18,320 @@
  */
 abstract class Wordlift_Abstract_Post_To_Jsonld_Converter implements Wordlift_Post_Converter {
 
-	/**
-	 * The JSON-LD context.
-	 *
-	 * @since 3.10.0
-	 */
-	const CONTEXT = 'http://schema.org';
-
-	/**
-	 * A {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access protected
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	protected $entity_type_service;
-
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access protected
-	 * @var \Wordlift_Entity_Service $entity_type_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	protected $entity_service;
-
-	/**
-	 * A {@link Wordlift_User_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
-	 */
-	protected $user_service;
-
-	/**
-	 * A {@link Wordlift_Attachment_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 */
-	protected $attachment_service;
-
-	/**
-	 * Wordlift_Post_To_Jsonld_Converter constructor.
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
-	 * @param \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 *
-	 * @since 3.10.0
-	 *
-	 */
-	public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service ) {
-
-		$this->entity_type_service = $entity_type_service;
-		$this->entity_service      = $entity_service;
-		$this->user_service        = $user_service;
-		$this->attachment_service  = $attachment_service;
-	}
-
-	/**
-	 * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
-	 * found while processing the post is set in the $references array.
-	 *
-	 * @param int $post_id The post id.
-	 * @param array $references An array of entity references.
-	 *
-	 * @return array A JSON-LD array.
-	 * @since 3.10.0
-	 *
-	 */
-	public function convert( $post_id, &$references = array() ) {
-
-		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
-			// Post not found.
-			return null;
-		}
-
-		// Get the post URI @id.
-		$id = $this->entity_service->get_uri( $post->ID );
-		if ( is_null( $id ) ) {
-			$id = 'get_uri returned null, dataset is ' . wl_configuration_get_redlink_dataset_uri();
-		}
-
-		/*
+    /**
+     * The JSON-LD context.
+     *
+     * @since 3.10.0
+     */
+    const CONTEXT = 'http://schema.org';
+
+    /**
+     * A {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since  3.10.0
+     * @access protected
+     * @var \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     */
+    protected $entity_type_service;
+
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.10.0
+     * @access protected
+     * @var \Wordlift_Entity_Service $entity_type_service A {@link Wordlift_Entity_Service} instance.
+     */
+    protected $entity_service;
+
+    /**
+     * A {@link Wordlift_User_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
+     */
+    protected $user_service;
+
+    /**
+     * A {@link Wordlift_Attachment_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     */
+    protected $attachment_service;
+
+    /**
+     * Wordlift_Post_To_Jsonld_Converter constructor.
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
+     * @param \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     *
+     * @since 3.10.0
+     *
+     */
+    public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service ) {
+
+        $this->entity_type_service = $entity_type_service;
+        $this->entity_service      = $entity_service;
+        $this->user_service        = $user_service;
+        $this->attachment_service  = $attachment_service;
+    }
+
+    /**
+     * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
+     * found while processing the post is set in the $references array.
+     *
+     * @param int $post_id The post id.
+     * @param array $references An array of entity references.
+     *
+     * @return array A JSON-LD array.
+     * @since 3.10.0
+     *
+     */
+    public function convert( $post_id, &$references = array() ) {
+
+        // Get the post instance.
+        $post = get_post( $post_id );
+        if ( null === $post ) {
+            // Post not found.
+            return null;
+        }
+
+        // Get the post URI @id.
+        $id = $this->entity_service->get_uri( $post->ID );
+        if ( is_null( $id ) ) {
+            $id = 'get_uri returned null, dataset is ' . wl_configuration_get_redlink_dataset_uri();
+        }
+
+        /*
 		 * The `types` variable holds one or more entity types. The `type` variable isn't used anymore.
 		 *
 		 * @since 3.20.0 We support more than one entity type.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 */
-		//		// Get the entity @type. We consider `post` BlogPostings.
-		//		$type = $this->entity_type_service->get( $post_id );
-		$types = $this->entity_type_service->get_names( $post_id );
-
-		// Prepare the response.
-		$jsonld = array(
-			'@context'    => self::CONTEXT,
-			'@id'         => $id,
-			'@type'       => self::make_one( $types ),
-			'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ),
-		);
-
-		// Set the `mainEntityOfPage` property if the post has some contents.
-		/*
+        //		// Get the entity @type. We consider `post` BlogPostings.
+        //		$type = $this->entity_type_service->get( $post_id );
+        $types = $this->entity_type_service->get_names( $post_id );
+
+        // Prepare the response.
+        $jsonld = array(
+            '@context'    => self::CONTEXT,
+            '@id'         => $id,
+            '@type'       => self::make_one( $types ),
+            'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ),
+        );
+
+        // Set the `mainEntityOfPage` property if the post has some contents.
+        /*
 		 * Apply the `wl_post_content` filter, in case 3rd parties want to change the post content, e.g.
 		 * because the content is written elsewhere.
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		if ( ! empty( $post_content ) ) {
-			// We're setting the `mainEntityOfPage` to signal which one is the
-			// main entity for the specified URL. It might be however that the
-			// post/page is actually about another specific entity. How WL deals
-			// with that hasn't been defined yet (see https://github.com/insideout10/wordlift-plugin/issues/451).
-			//
-			// See http://schema.org/mainEntityOfPage
-			//
-			// No need to specify `'@type' => 'WebPage'.
-			//
-			// See https://github.com/insideout10/wordlift-plugin/issues/451.
-			$jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
-		};
-
-		$this->set_images( $post, $jsonld );
-
-		// Get the entities referenced by this post and set it to the `references`
-		// array so that the caller can do further processing, such as printing out
-		// more of those references.
-		$references_without_locations = $this->entity_service->get_related_entities( $post->ID );
-
-		/*
+        $post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
+        if ( ! empty( $post_content ) ) {
+            // We're setting the `mainEntityOfPage` to signal which one is the
+            // main entity for the specified URL. It might be however that the
+            // post/page is actually about another specific entity. How WL deals
+            // with that hasn't been defined yet (see https://github.com/insideout10/wordlift-plugin/issues/451).
+            //
+            // See http://schema.org/mainEntityOfPage
+            //
+            // No need to specify `'@type' => 'WebPage'.
+            //
+            // See https://github.com/insideout10/wordlift-plugin/issues/451.
+            $jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
+        };
+
+        $this->set_images( $post, $jsonld );
+
+        // Get the entities referenced by this post and set it to the `references`
+        // array so that the caller can do further processing, such as printing out
+        // more of those references.
+        $references_without_locations = $this->entity_service->get_related_entities( $post->ID );
+
+        /*
 		 * Add the locations to the references.
 		 *
 		 * @since 3.19.5
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/858.
 		 */
-		// A reference to use in closure.
-		$entity_type_service = $this->entity_type_service;
-		$locations           = array_reduce( $references_without_locations, function ( $carry, $post_id ) use ( $entity_type_service ) {
-			// @see https://schema.org/location for the schema.org types using the `location` property.
-			if ( ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Action' )
-			     && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Event' )
-			     && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Organization' ) ) {
-				return $carry;
-			}
-
-			return array_merge( $carry, get_post_meta( $post_id, Wordlift_Schema_Service::FIELD_LOCATION ) );
-		}, array() );
-
-		// Merge the references with the referenced locations if any.
-		$references = array_unique( array_merge( $references_without_locations, $locations ) );
-
-		return $jsonld;
-	}
-
-	/**
-	 * If the provided value starts with the schema.org context, we remove the schema.org
-	 * part since it is set with the '@context'.
-	 *
-	 * @param string $value The property value.
-	 *
-	 * @return string The property value without the context.
-	 * @since 3.10.0
-	 *
-	 */
-	public function relative_to_context( $value ) {
-
-		return 0 === strpos( $value, self::CONTEXT . '/' ) ? substr( $value, strlen( self::CONTEXT ) + 1 ) : $value;
-	}
-
-	/**
-	 * Set the images, by looking for embedded images, for images loaded via the
-	 * gallery and for the featured image.
-	 *
-	 * Uses the cache service to store the results of this function for a day.
-	 *
-	 * @param WP_Post $post The target {@link WP_Post}.
-	 * @param array $jsonld The JSON-LD array.
-	 *
-	 * @since 3.10.0
-	 *
-	 */
-	protected function set_images( $post, &$jsonld ) {
-
-		// Prepare the attachment ids array.
-		$ids = array();
-
-		// Set the thumbnail id as first attachment id, if any.
-		$thumbnail_id = get_post_thumbnail_id( $post->ID );
-		if ( '' !== $thumbnail_id ) {
-			$ids[] = $thumbnail_id;
-		}
-
-		// For the time being the following is being removed since the query
-		// initiated by `get_image_embeds` is consuming lots of CPU.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/689.
-		//
-		// Get the embeds, removing existing ids.
-		// $embeds = array_diff( $this->attachment_service->get_image_embeds( $post->post_content ), $ids );
-		$embeds = array();
-
-		// Get the gallery, removing existing ids.
-		$gallery = array_diff( $this->attachment_service->get_gallery( $post ), $ids, $embeds );
-
-		// Map the attachment ids to images' data structured for schema.org use.
-		$images_with_sizes = array_filter(
-			array_reduce( array_merge( $ids, $embeds, $gallery ),
-				function ( $carry, $item ) {
-					/*
+        // A reference to use in closure.
+        $entity_type_service = $this->entity_type_service;
+        $locations           = array_reduce( $references_without_locations, function ( $carry, $post_id ) use ( $entity_type_service ) {
+            // @see https://schema.org/location for the schema.org types using the `location` property.
+            if ( ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Action' )
+                 && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Event' )
+                 && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Organization' ) ) {
+                return $carry;
+            }
+
+            return array_merge( $carry, get_post_meta( $post_id, Wordlift_Schema_Service::FIELD_LOCATION ) );
+        }, array() );
+
+        // Merge the references with the referenced locations if any.
+        $references = array_unique( array_merge( $references_without_locations, $locations ) );
+
+        return $jsonld;
+    }
+
+    /**
+     * If the provided value starts with the schema.org context, we remove the schema.org
+     * part since it is set with the '@context'.
+     *
+     * @param string $value The property value.
+     *
+     * @return string The property value without the context.
+     * @since 3.10.0
+     *
+     */
+    public function relative_to_context( $value ) {
+
+        return 0 === strpos( $value, self::CONTEXT . '/' ) ? substr( $value, strlen( self::CONTEXT ) + 1 ) : $value;
+    }
+
+    /**
+     * Set the images, by looking for embedded images, for images loaded via the
+     * gallery and for the featured image.
+     *
+     * Uses the cache service to store the results of this function for a day.
+     *
+     * @param WP_Post $post The target {@link WP_Post}.
+     * @param array $jsonld The JSON-LD array.
+     *
+     * @since 3.10.0
+     *
+     */
+    protected function set_images( $post, &$jsonld ) {
+
+        // Prepare the attachment ids array.
+        $ids = array();
+
+        // Set the thumbnail id as first attachment id, if any.
+        $thumbnail_id = get_post_thumbnail_id( $post->ID );
+        if ( '' !== $thumbnail_id ) {
+            $ids[] = $thumbnail_id;
+        }
+
+        // For the time being the following is being removed since the query
+        // initiated by `get_image_embeds` is consuming lots of CPU.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/689.
+        //
+        // Get the embeds, removing existing ids.
+        // $embeds = array_diff( $this->attachment_service->get_image_embeds( $post->post_content ), $ids );
+        $embeds = array();
+
+        // Get the gallery, removing existing ids.
+        $gallery = array_diff( $this->attachment_service->get_gallery( $post ), $ids, $embeds );
+
+        // Map the attachment ids to images' data structured for schema.org use.
+        $images_with_sizes = array_filter(
+            array_reduce( array_merge( $ids, $embeds, $gallery ),
+                function ( $carry, $item ) {
+                    /*
 					* @todo: we're not sure that we're getting attachment data here, we
 					* should filter `false`s.
 					*/
 
-					$sources = array_merge(
-						Wordlift_Image_Service::get_sources( $item ),
-						array( wp_get_attachment_image_src( $item, 'full' ) )
-					);
-
-					$sources_with_image = array_filter( $sources, function ( $source ) {
-						return ! empty( $source[0] );
-					} );
-
-					// Get the attachment data.
-					// $attachment = wp_get_attachment_image_src( $item, 'full' );
-
-					// var_dump( array( "sources-$item" => Wordlift_Image_Service::get_sources( $item ) ) );
-
-					// Bail if image is not found.
-					// In some cases, you can delete the image from the database
-					// or from uploads dir, but the image id still exists as featured image
-					// or in [gallery] shortcode.
-					//					if ( empty( $attachment[0] ) ) {
-					if ( empty( $sources_with_image ) ) {
-						return $carry;
-					}
-
-					// Merge the arrays.
-					return array_merge(
-						$carry,
-						$sources_with_image
-					);
-				}
-				// Initial array.
-				, array() )
-		);
-
-		// Refactor data as per schema.org specifications.
-		$images = array_map( function ( $attachment ) {
-			return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
-				array(
-					'@type' => 'ImageObject',
-					'url'   => $attachment[0],
-				), $attachment
-			);
-		}, $images_with_sizes );
-
-		// Add images if present.
-		if ( 0 < count( $images ) ) {
-			$jsonld['image'] = $images;
-		}
-
-	}
-
-	/**
-	 * If the provided array of values contains only one value, then one single
-	 * value is returned, otherwise the original array is returned.
-	 *
-	 * @param array $value An array of values.
-	 *
-	 * @return mixed|array A single value or the original array.
-	 * @since 3.20.0 The function has been moved from {@link Wordlift_Entity_Post_To_Jsonld_Converter} to
-	 *  {@link Wordlift_Abstract_Post_To_Jsonld_Converter}.
-	 * @since  3.8.0
-	 * @access private
-	 *
-	 */
-	protected static function make_one( $value ) {
-
-		return 1 === count( $value ) ? $value[0] : $value;
-	}
-
-	/**
-	 * Process the provided array by adding the width / height if the values
-	 * are available and are greater than 0.
-	 *
-	 * @param array $image The `ImageObject` array.
-	 * @param array $attachment The attachment array.
-	 *
-	 * @return array The enriched `ImageObject` array.
-	 * @since 3.14.0
-	 *
-	 */
-	public static function set_image_size( $image, $attachment ) {
-
-		// If you specify a "width" or "height" value you should leave out
-		// 'px'. For example: "width":"4608px" should be "width":"4608".
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/451.
-		if ( isset( $attachment[1] ) && is_numeric( $attachment[1] ) && 0 < $attachment[1] ) {
-			$image['width'] = $attachment[1];
-		}
-
-		if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
-			$image['height'] = $attachment[2];
-		}
-
-		return $image;
-	}
+                    $sources = array_merge(
+                        Wordlift_Image_Service::get_sources( $item ),
+                        array( wp_get_attachment_image_src( $item, 'full' ) )
+                    );
+
+                    $sources_with_image = array_filter( $sources, function ( $source ) {
+                        return ! empty( $source[0] );
+                    } );
+
+                    // Get the attachment data.
+                    // $attachment = wp_get_attachment_image_src( $item, 'full' );
+
+                    // var_dump( array( "sources-$item" => Wordlift_Image_Service::get_sources( $item ) ) );
+
+                    // Bail if image is not found.
+                    // In some cases, you can delete the image from the database
+                    // or from uploads dir, but the image id still exists as featured image
+                    // or in [gallery] shortcode.
+                    //					if ( empty( $attachment[0] ) ) {
+                    if ( empty( $sources_with_image ) ) {
+                        return $carry;
+                    }
+
+                    // Merge the arrays.
+                    return array_merge(
+                        $carry,
+                        $sources_with_image
+                    );
+                }
+                // Initial array.
+                , array() )
+        );
+
+        // Refactor data as per schema.org specifications.
+        $images = array_map( function ( $attachment ) {
+            return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
+                array(
+                    '@type' => 'ImageObject',
+                    'url'   => $attachment[0],
+                ), $attachment
+            );
+        }, $images_with_sizes );
+
+        // Add images if present.
+        if ( 0 < count( $images ) ) {
+            $jsonld['image'] = $images;
+        }
+
+    }
+
+    /**
+     * If the provided array of values contains only one value, then one single
+     * value is returned, otherwise the original array is returned.
+     *
+     * @param array $value An array of values.
+     *
+     * @return mixed|array A single value or the original array.
+     * @since 3.20.0 The function has been moved from {@link Wordlift_Entity_Post_To_Jsonld_Converter} to
+     *  {@link Wordlift_Abstract_Post_To_Jsonld_Converter}.
+     * @since  3.8.0
+     * @access private
+     *
+     */
+    protected static function make_one( $value ) {
+
+        return 1 === count( $value ) ? $value[0] : $value;
+    }
+
+    /**
+     * Process the provided array by adding the width / height if the values
+     * are available and are greater than 0.
+     *
+     * @param array $image The `ImageObject` array.
+     * @param array $attachment The attachment array.
+     *
+     * @return array The enriched `ImageObject` array.
+     * @since 3.14.0
+     *
+     */
+    public static function set_image_size( $image, $attachment ) {
+
+        // If you specify a "width" or "height" value you should leave out
+        // 'px'. For example: "width":"4608px" should be "width":"4608".
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/451.
+        if ( isset( $attachment[1] ) && is_numeric( $attachment[1] ) && 0 < $attachment[1] ) {
+            $image['width'] = $attachment[1];
+        }
+
+        if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
+            $image['height'] = $attachment[2];
+        }
+
+        return $image;
+    }
 }

Spacing +44 added lines, -44 removed lines

@@ -72,7 +72,7 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service ) {
+	public function __construct($entity_type_service, $entity_service, $user_service, $attachment_service) {
 
 		$this->entity_type_service = $entity_type_service;
 		$this->entity_service      = $entity_service;
@@ -91,19 +91,19 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	public function convert( $post_id, &$references = array() ) {
+	public function convert($post_id, &$references = array()) {
 
 		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
+		$post = get_post($post_id);
+		if (null === $post) {
 			// Post not found.
 			return null;
 		}
 
 		// Get the post URI @id.
-		$id = $this->entity_service->get_uri( $post->ID );
-		if ( is_null( $id ) ) {
-			$id = 'get_uri returned null, dataset is ' . wl_configuration_get_redlink_dataset_uri();
+		$id = $this->entity_service->get_uri($post->ID);
+		if (is_null($id)) {
+			$id = 'get_uri returned null, dataset is '.wl_configuration_get_redlink_dataset_uri();
 		}
 
 		/*
@@ -115,14 +115,14 @@ 
 		 */
 		//		// Get the entity @type. We consider `post` BlogPostings.
 		//		$type = $this->entity_type_service->get( $post_id );
-		$types = $this->entity_type_service->get_names( $post_id );
+		$types = $this->entity_type_service->get_names($post_id);
 
 		// Prepare the response.
 		$jsonld = array(
 			'@context'    => self::CONTEXT,
 			'@id'         => $id,
-			'@type'       => self::make_one( $types ),
-			'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ),
+			'@type'       => self::make_one($types),
+			'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt($post),
 		);
 
 		// Set the `mainEntityOfPage` property if the post has some contents.
@@ -132,8 +132,8 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		if ( ! empty( $post_content ) ) {
+		$post_content = apply_filters('wl_post_content', $post->post_content, $post);
+		if ( ! empty($post_content)) {
 			// We're setting the `mainEntityOfPage` to signal which one is the
 			// main entity for the specified URL. It might be however that the
 			// post/page is actually about another specific entity. How WL deals
@@ -144,15 +144,15 @@ 
 			// No need to specify `'@type' => 'WebPage'.
 			//
 			// See https://github.com/insideout10/wordlift-plugin/issues/451.
-			$jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
+			$jsonld['mainEntityOfPage'] = get_the_permalink($post->ID);
 		};
 
-		$this->set_images( $post, $jsonld );
+		$this->set_images($post, $jsonld);
 
 		// Get the entities referenced by this post and set it to the `references`
 		// array so that the caller can do further processing, such as printing out
 		// more of those references.
-		$references_without_locations = $this->entity_service->get_related_entities( $post->ID );
+		$references_without_locations = $this->entity_service->get_related_entities($post->ID);
 
 		/*
 		 * Add the locations to the references.
@@ -163,19 +163,19 @@ 
 		 */
 		// A reference to use in closure.
 		$entity_type_service = $this->entity_type_service;
-		$locations           = array_reduce( $references_without_locations, function ( $carry, $post_id ) use ( $entity_type_service ) {
+		$locations           = array_reduce($references_without_locations, function($carry, $post_id) use ($entity_type_service) {
 			// @see https://schema.org/location for the schema.org types using the `location` property.
-			if ( ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Action' )
-			     && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Event' )
-			     && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Organization' ) ) {
+			if ( ! $entity_type_service->has_entity_type($post_id, 'http://schema.org/Action')
+			     && ! $entity_type_service->has_entity_type($post_id, 'http://schema.org/Event')
+			     && ! $entity_type_service->has_entity_type($post_id, 'http://schema.org/Organization')) {
 				return $carry;
 			}
 
-			return array_merge( $carry, get_post_meta( $post_id, Wordlift_Schema_Service::FIELD_LOCATION ) );
-		}, array() );
+			return array_merge($carry, get_post_meta($post_id, Wordlift_Schema_Service::FIELD_LOCATION));
+		}, array());
 
 		// Merge the references with the referenced locations if any.
-		$references = array_unique( array_merge( $references_without_locations, $locations ) );
+		$references = array_unique(array_merge($references_without_locations, $locations));
 
 		return $jsonld;
 	}
@@ -190,9 +190,9 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	public function relative_to_context( $value ) {
+	public function relative_to_context($value) {
 
-		return 0 === strpos( $value, self::CONTEXT . '/' ) ? substr( $value, strlen( self::CONTEXT ) + 1 ) : $value;
+		return 0 === strpos($value, self::CONTEXT.'/') ? substr($value, strlen(self::CONTEXT) + 1) : $value;
 	}
 
 	/**
@@ -207,14 +207,14 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	protected function set_images( $post, &$jsonld ) {
+	protected function set_images($post, &$jsonld) {
 
 		// Prepare the attachment ids array.
 		$ids = array();
 
 		// Set the thumbnail id as first attachment id, if any.
-		$thumbnail_id = get_post_thumbnail_id( $post->ID );
-		if ( '' !== $thumbnail_id ) {
+		$thumbnail_id = get_post_thumbnail_id($post->ID);
+		if ('' !== $thumbnail_id) {
 			$ids[] = $thumbnail_id;
 		}
 
@@ -228,24 +228,24 @@ 
 		$embeds = array();
 
 		// Get the gallery, removing existing ids.
-		$gallery = array_diff( $this->attachment_service->get_gallery( $post ), $ids, $embeds );
+		$gallery = array_diff($this->attachment_service->get_gallery($post), $ids, $embeds);
 
 		// Map the attachment ids to images' data structured for schema.org use.
 		$images_with_sizes = array_filter(
-			array_reduce( array_merge( $ids, $embeds, $gallery ),
-				function ( $carry, $item ) {
+			array_reduce(array_merge($ids, $embeds, $gallery),
+				function($carry, $item) {
 					/*
 					* @todo: we're not sure that we're getting attachment data here, we
 					* should filter `false`s.
 					*/
 
 					$sources = array_merge(
-						Wordlift_Image_Service::get_sources( $item ),
-						array( wp_get_attachment_image_src( $item, 'full' ) )
+						Wordlift_Image_Service::get_sources($item),
+						array(wp_get_attachment_image_src($item, 'full'))
 					);
 
-					$sources_with_image = array_filter( $sources, function ( $source ) {
-						return ! empty( $source[0] );
+					$sources_with_image = array_filter($sources, function($source) {
+						return ! empty($source[0]);
 					} );
 
 					// Get the attachment data.
@@ -258,7 +258,7 @@ 
 					// or from uploads dir, but the image id still exists as featured image
 					// or in [gallery] shortcode.
 					//					if ( empty( $attachment[0] ) ) {
-					if ( empty( $sources_with_image ) ) {
+					if (empty($sources_with_image)) {
 						return $carry;
 					}
 
@@ -269,21 +269,21 @@ 
 					);
 				}
 				// Initial array.
-				, array() )
+				, array())
 		);
 
 		// Refactor data as per schema.org specifications.
-		$images = array_map( function ( $attachment ) {
+		$images = array_map(function($attachment) {
 			return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
 				array(
 					'@type' => 'ImageObject',
 					'url'   => $attachment[0],
 				), $attachment
 			);
-		}, $images_with_sizes );
+		}, $images_with_sizes);
 
 		// Add images if present.
-		if ( 0 < count( $images ) ) {
+		if (0 < count($images)) {
 			$jsonld['image'] = $images;
 		}
 
@@ -302,9 +302,9 @@ 
 	 * @access private
 	 *
 	 */
-	protected static function make_one( $value ) {
+	protected static function make_one($value) {
 
-		return 1 === count( $value ) ? $value[0] : $value;
+		return 1 === count($value) ? $value[0] : $value;
 	}
 
 	/**
@@ -318,17 +318,17 @@ 
 	 * @since 3.14.0
 	 *
 	 */
-	public static function set_image_size( $image, $attachment ) {
+	public static function set_image_size($image, $attachment) {
 
 		// If you specify a "width" or "height" value you should leave out
 		// 'px'. For example: "width":"4608px" should be "width":"4608".
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/451.
-		if ( isset( $attachment[1] ) && is_numeric( $attachment[1] ) && 0 < $attachment[1] ) {
+		if (isset($attachment[1]) && is_numeric($attachment[1]) && 0 < $attachment[1]) {
 			$image['width'] = $attachment[1];
 		}
 
-		if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
+		if (isset($attachment[2]) && is_numeric($attachment[2]) && 0 < $attachment[2]) {
 			$image['height'] = $attachment[2];
 		}
 

src/includes/class-wordlift-key-validation-service.php

Indentation +137 added lines, -137 removed lines

@@ -17,145 +17,145 @@
  */
 class Wordlift_Key_Validation_Service {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * Create a {@link Wordlift_Key_Validation_Service} instance.
-	 *
-	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since 3.14.0
-	 *
-	 */
-	public function __construct( $configuration_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
-
-		$this->configuration_service = $configuration_service;
-		add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
-		add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
-
-	}
-
-	/**
-	 * Validate the provided key.
-	 *
-	 * @param string $key WordLift's key to validate.
-	 *
-	 * @return WP_Error|array The response or WP_Error on failure.
-	 * @since 3.9.0
-	 *
-	 */
-	public function get_account_info( $key ) {
-
-		$this->log->debug( 'Validating key...' );
-
-		// Request the account info as a way to validate the key
-
-		$args = array_merge_recursive(
-			unserialize( WL_REDLINK_API_HTTP_OPTIONS ),
-			array(
-				'headers' => array(
-					'Content-Type'    => 'application/json; charset=utf-8',
-					'X-Authorization' => $key,
-				)
-			)
-		);
-
-		return wp_remote_get( $this->configuration_service->get_accounts_info_by_key( $key ), $args );
-	}
-
-	/**
-	 * This function is hooked to the `wl_validate_key` AJAX call.
-	 *
-	 * @since 3.9.0
-	 */
-	public function validate_key() {
-
-		// Ensure we don't have garbage before us.
-		ob_clean();
-
-		// Check if we have a key.
-		if ( ! isset( $_POST['key'] ) ) {
-			wp_send_json_error( 'The key parameter is required.' );
-		}
-
-		$response = $this->get_account_info( $_POST['key'] );
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
-
-		// The URL stored in WLS. If this is the initial install the URL may be null.
-		$url = $res_body['url'];
-
-		// If we got an error, return invalid.
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			wp_send_json_success( array( 'valid' => false, 'message' => '' ) );
-		}
-
-		// If the URL isn't set or matches, then it's valid.
-		if ( is_null( $url ) || $url === site_url() ) {
-			wp_send_json_success( array( 'valid' => true, 'message' => '' ) );
-		}
-
-		// If the URL doesn't match it means that this key has been configured elsewhere already.
-		if ( $url !== site_url() ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			wp_send_json_success( array(
-				'valid'   => false,
-				'message' => __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ),
-			) );
-		}
-
-		// Set a response with valid set to true or false according to the key validity with message.
-		wp_send_json_success( array(
-			'valid'   => false,
-			'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
-		) );
-	}
-
-	/**
-	 * This function is hooked `admin_init` to check _wl_blog_url.
-	 *
-	 */
-	public function wl_load_plugin() {
-
-		$wl_blog_url = get_option( '_wl_blog_url' );
-
-		if ( ! $wl_blog_url ) {
-			update_option( '_wl_blog_url', site_url(), true );
-		} else if ( $wl_blog_url !== site_url() ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			set_transient( 'wl-key-error-msg', __( "Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift' ), 10 );
-		}
-
-	}
-
-	/**
-	 * This function is hooked to the `admin_notices` to show admin notification.
-	 *
-	 */
-	public function wl_key_update_notice() {
-		if ( get_transient( 'wl-key-error-msg' ) ) {
-			?>
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * Create a {@link Wordlift_Key_Validation_Service} instance.
+     *
+     * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since 3.14.0
+     *
+     */
+    public function __construct( $configuration_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+
+        $this->configuration_service = $configuration_service;
+        add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
+        add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
+
+    }
+
+    /**
+     * Validate the provided key.
+     *
+     * @param string $key WordLift's key to validate.
+     *
+     * @return WP_Error|array The response or WP_Error on failure.
+     * @since 3.9.0
+     *
+     */
+    public function get_account_info( $key ) {
+
+        $this->log->debug( 'Validating key...' );
+
+        // Request the account info as a way to validate the key
+
+        $args = array_merge_recursive(
+            unserialize( WL_REDLINK_API_HTTP_OPTIONS ),
+            array(
+                'headers' => array(
+                    'Content-Type'    => 'application/json; charset=utf-8',
+                    'X-Authorization' => $key,
+                )
+            )
+        );
+
+        return wp_remote_get( $this->configuration_service->get_accounts_info_by_key( $key ), $args );
+    }
+
+    /**
+     * This function is hooked to the `wl_validate_key` AJAX call.
+     *
+     * @since 3.9.0
+     */
+    public function validate_key() {
+
+        // Ensure we don't have garbage before us.
+        ob_clean();
+
+        // Check if we have a key.
+        if ( ! isset( $_POST['key'] ) ) {
+            wp_send_json_error( 'The key parameter is required.' );
+        }
+
+        $response = $this->get_account_info( $_POST['key'] );
+        $res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+        // The URL stored in WLS. If this is the initial install the URL may be null.
+        $url = $res_body['url'];
+
+        // If we got an error, return invalid.
+        if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+            wp_send_json_success( array( 'valid' => false, 'message' => '' ) );
+        }
+
+        // If the URL isn't set or matches, then it's valid.
+        if ( is_null( $url ) || $url === site_url() ) {
+            wp_send_json_success( array( 'valid' => true, 'message' => '' ) );
+        }
+
+        // If the URL doesn't match it means that this key has been configured elsewhere already.
+        if ( $url !== site_url() ) {
+            Wordlift_Configuration_Service::get_instance()->set_key( '' );
+            wp_send_json_success( array(
+                'valid'   => false,
+                'message' => __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ),
+            ) );
+        }
+
+        // Set a response with valid set to true or false according to the key validity with message.
+        wp_send_json_success( array(
+            'valid'   => false,
+            'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
+        ) );
+    }
+
+    /**
+     * This function is hooked `admin_init` to check _wl_blog_url.
+     *
+     */
+    public function wl_load_plugin() {
+
+        $wl_blog_url = get_option( '_wl_blog_url' );
+
+        if ( ! $wl_blog_url ) {
+            update_option( '_wl_blog_url', site_url(), true );
+        } else if ( $wl_blog_url !== site_url() ) {
+            Wordlift_Configuration_Service::get_instance()->set_key( '' );
+            set_transient( 'wl-key-error-msg', __( "Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift' ), 10 );
+        }
+
+    }
+
+    /**
+     * This function is hooked to the `admin_notices` to show admin notification.
+     *
+     */
+    public function wl_key_update_notice() {
+        if ( get_transient( 'wl-key-error-msg' ) ) {
+            ?>
             <div class="updated notice is-dismissible error">
                 <p><?php _e( get_transient( 'wl-key-error-msg' ), 'wordlift' ); ?></p>
             </div>
 			<?php
-		}
-	}
+        }
+    }
 }

Spacing +32 added lines, -32 removed lines

@@ -43,13 +43,13 @@ 
 	 * @since 3.14.0
 	 *
 	 */
-	public function __construct( $configuration_service ) {
+	public function __construct($configuration_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Key_Validation_Service');
 
 		$this->configuration_service = $configuration_service;
-		add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
-		add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
+		add_action('admin_init', array($this, 'wl_load_plugin'));
+		add_action('admin_notices', array($this, 'wl_key_update_notice'));
 
 	}
 
@@ -62,14 +62,14 @@ 
 	 * @since 3.9.0
 	 *
 	 */
-	public function get_account_info( $key ) {
+	public function get_account_info($key) {
 
-		$this->log->debug( 'Validating key...' );
+		$this->log->debug('Validating key...');
 
 		// Request the account info as a way to validate the key
 
 		$args = array_merge_recursive(
-			unserialize( WL_REDLINK_API_HTTP_OPTIONS ),
+			unserialize(WL_REDLINK_API_HTTP_OPTIONS),
 			array(
 				'headers' => array(
 					'Content-Type'    => 'application/json; charset=utf-8',
@@ -78,7 +78,7 @@ 
 			)
 		);
 
-		return wp_remote_get( $this->configuration_service->get_accounts_info_by_key( $key ), $args );
+		return wp_remote_get($this->configuration_service->get_accounts_info_by_key($key), $args);
 	}
 
 	/**
@@ -92,40 +92,40 @@ 
 		ob_clean();
 
 		// Check if we have a key.
-		if ( ! isset( $_POST['key'] ) ) {
-			wp_send_json_error( 'The key parameter is required.' );
+		if ( ! isset($_POST['key'])) {
+			wp_send_json_error('The key parameter is required.');
 		}
 
-		$response = $this->get_account_info( $_POST['key'] );
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+		$response = $this->get_account_info($_POST['key']);
+		$res_body = json_decode(wp_remote_retrieve_body($response), true);
 
 		// The URL stored in WLS. If this is the initial install the URL may be null.
 		$url = $res_body['url'];
 
 		// If we got an error, return invalid.
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			wp_send_json_success( array( 'valid' => false, 'message' => '' ) );
+		if (is_wp_error($response) || 2 !== (int) $response['response']['code'] / 100) {
+			wp_send_json_success(array('valid' => false, 'message' => ''));
 		}
 
 		// If the URL isn't set or matches, then it's valid.
-		if ( is_null( $url ) || $url === site_url() ) {
-			wp_send_json_success( array( 'valid' => true, 'message' => '' ) );
+		if (is_null($url) || $url === site_url()) {
+			wp_send_json_success(array('valid' => true, 'message' => ''));
 		}
 
 		// If the URL doesn't match it means that this key has been configured elsewhere already.
-		if ( $url !== site_url() ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			wp_send_json_success( array(
+		if ($url !== site_url()) {
+			Wordlift_Configuration_Service::get_instance()->set_key('');
+			wp_send_json_success(array(
 				'valid'   => false,
-				'message' => __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ),
-			) );
+				'message' => __('The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift'),
+			));
 		}
 
 		// Set a response with valid set to true or false according to the key validity with message.
-		wp_send_json_success( array(
+		wp_send_json_success(array(
 			'valid'   => false,
-			'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
-		) );
+			'message' => __('An error occurred, please contact us at hello@wordlift.io', 'wordlift'),
+		));
 	}
 
 	/**
@@ -134,13 +134,13 @@ 
 	 */
 	public function wl_load_plugin() {
 
-		$wl_blog_url = get_option( '_wl_blog_url' );
+		$wl_blog_url = get_option('_wl_blog_url');
 
-		if ( ! $wl_blog_url ) {
-			update_option( '_wl_blog_url', site_url(), true );
-		} else if ( $wl_blog_url !== site_url() ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			set_transient( 'wl-key-error-msg', __( "Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift' ), 10 );
+		if ( ! $wl_blog_url) {
+			update_option('_wl_blog_url', site_url(), true);
+		} else if ($wl_blog_url !== site_url()) {
+			Wordlift_Configuration_Service::get_instance()->set_key('');
+			set_transient('wl-key-error-msg', __("Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift'), 10);
 		}
 
 	}
@@ -150,10 +150,10 @@ 
 	 *
 	 */
 	public function wl_key_update_notice() {
-		if ( get_transient( 'wl-key-error-msg' ) ) {
+		if (get_transient('wl-key-error-msg')) {
 			?>
             <div class="updated notice is-dismissible error">
-                <p><?php _e( get_transient( 'wl-key-error-msg' ), 'wordlift' ); ?></p>
+                <p><?php _e(get_transient('wl-key-error-msg'), 'wordlift'); ?></p>
             </div>
 			<?php
 		}

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

Indentation +582 added lines, -582 removed lines

@@ -16,506 +16,506 @@ 
  */
 class Wordlift_Entity_Service {
 
-	/**
-	 * The Log service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log The Log service.
-	 */
-	private $log;
-
-	/**
-	 * The UI service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_UI_Service $ui_service The UI service.
-	 */
-	private $ui_service;
-
-	/**
-	 * The {@link Wordlift_Relation_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
-	 */
-	private $relation_service;
-
-	/**
-	 * The {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * The entity post type name.
-	 *
-	 * @since 3.1.0
-	 */
-	const TYPE_NAME = 'entity';
-
-	/**
-	 * The alternative label meta key.
-	 *
-	 * @since 3.2.0
-	 */
-	const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';
-
-	/**
-	 * The alternative label input template.
-	 *
-	 * @since 3.2.0
-	 */
-	// TODO: this should be moved to a class that deals with HTML code.
-	const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
+    /**
+     * The Log service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_Log_Service $log The Log service.
+     */
+    private $log;
+
+    /**
+     * The UI service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_UI_Service $ui_service The UI service.
+     */
+    private $ui_service;
+
+    /**
+     * The {@link Wordlift_Relation_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
+     */
+    private $relation_service;
+
+    /**
+     * The {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    private $entity_uri_service;
+
+    /**
+     * The entity post type name.
+     *
+     * @since 3.1.0
+     */
+    const TYPE_NAME = 'entity';
+
+    /**
+     * The alternative label meta key.
+     *
+     * @since 3.2.0
+     */
+    const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';
+
+    /**
+     * The alternative label input template.
+     *
+     * @since 3.2.0
+     */
+    // TODO: this should be moved to a class that deals with HTML code.
+    const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
                 <label class="screen-reader-text" id="wl-alternative-label-prompt-text" for="wl-alternative-label">Enter alternative label here</label>
                 <input name="wl_alternative_label[]" size="30" value="%s" id="wl-alternative-label" type="text">
                 <button class="button wl-delete-button">%s</button>
                 </div>';
 
-	/**
-	 * A singleton instance of the Entity service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $instance A singleton instance of the Entity service.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a Wordlift_Entity_Service instance.
-	 *
-	 * @param \Wordlift_UI_Service $ui_service The UI service.
-	 * @param \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
-	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since 3.2.0
-	 *
-	 */
-	public function __construct( $ui_service, $relation_service, $entity_uri_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
-
-		$this->ui_service         = $ui_service;
-		$this->relation_service   = $relation_service;
-		$this->entity_uri_service = $entity_uri_service;
-
-		// Set the singleton instance.
-		self::$instance = $this;
-	}
-
-	/**
-	 * Get the singleton instance of the Entity service.
-	 *
-	 * @return \Wordlift_Entity_Service The singleton instance of the Entity service.
-	 * @since 3.2.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Determines whether a post is an entity or not. Entity is in this context
-	 * something which is not an article.
-	 *
-	 * @param int $post_id A post id.
-	 *
-	 * @return bool Return true if the post is an entity otherwise false.
-	 * @since 3.1.0
-	 *
-	 */
-	public function is_entity( $post_id ) {
-
-		$terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-
-		if ( is_wp_error( $terms ) ) {
-			$this->log->error( "Cannot get the terms for post $post_id: " . $terms->get_error_message() );
-
-			return false;
-		}
-
-		if ( empty( $terms ) ) {
-			return false;
-		}
-
-		/*
+    /**
+     * A singleton instance of the Entity service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_Entity_Service $instance A singleton instance of the Entity service.
+     */
+    private static $instance;
+
+    /**
+     * Create a Wordlift_Entity_Service instance.
+     *
+     * @param \Wordlift_UI_Service $ui_service The UI service.
+     * @param \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
+     * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since 3.2.0
+     *
+     */
+    public function __construct( $ui_service, $relation_service, $entity_uri_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+
+        $this->ui_service         = $ui_service;
+        $this->relation_service   = $relation_service;
+        $this->entity_uri_service = $entity_uri_service;
+
+        // Set the singleton instance.
+        self::$instance = $this;
+    }
+
+    /**
+     * Get the singleton instance of the Entity service.
+     *
+     * @return \Wordlift_Entity_Service The singleton instance of the Entity service.
+     * @since 3.2.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Determines whether a post is an entity or not. Entity is in this context
+     * something which is not an article.
+     *
+     * @param int $post_id A post id.
+     *
+     * @return bool Return true if the post is an entity otherwise false.
+     * @since 3.1.0
+     *
+     */
+    public function is_entity( $post_id ) {
+
+        $terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+
+        if ( is_wp_error( $terms ) ) {
+            $this->log->error( "Cannot get the terms for post $post_id: " . $terms->get_error_message() );
+
+            return false;
+        }
+
+        if ( empty( $terms ) ) {
+            return false;
+        }
+
+        /*
 		 * We don't consider an `article` to be an entity.
 		 *
 		 * @since 3.20.0 At least one associated mustn't be an `article`.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 */
-		foreach ( $terms as $term ) {
-			if ( 'article' !== $term->slug ) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get the proper classification scope for a given entity post
-	 *
-	 * @param integer $post_id An entity post id.
-	 *
-	 * @param string $default The default classification scope, `what` if not
-	 *                         provided.
-	 *
-	 * @return string Returns a classification scope (e.g. 'what').
-	 * @since 3.5.0
-	 *
-	 */
-	public function get_classification_scope_for( $post_id, $default = WL_WHAT_RELATION ) {
-
-		if ( false === $this->is_entity( $post_id ) ) {
-			return $default;
-		}
-
-		// Retrieve the entity type
-		$entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
-		$entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
-		// Retrieve classification boxes configuration
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
-				return $cb['id'];
-			}
-		}
-
-		return $default;
-	}
-
-	/**
-	 * Check whether a {@link WP_Post} is used.
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 *
-	 * @return bool|null Null if it's not an entity, otherwise true if it's used.
-	 */
-	public function is_used( $post_id ) {
-
-		if ( false === $this->is_entity( $post_id ) ) {
-			return null;
-		}
-		// Retrieve the post
-		$entity = get_post( $post_id );
-
-		global $wpdb;
-		// Retrieve Wordlift relation instances table name
-		$table_name = wl_core_get_relation_instances_table_name();
-
-		// Check is it's referenced / related to another post / entity
-		$stmt = $wpdb->prepare(
-			"SELECT COUNT(*) FROM $table_name WHERE  object_id = %d",
-			$entity->ID
-		);
-
-		// Perform the query
-		$relation_instances = (int) $wpdb->get_var( $stmt );
-		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
-			return true;
-		}
-
-		// Check if the entity uri is used as meta_value
-		$stmt = $wpdb->prepare(
-			"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
-			$entity->ID,
-			wl_get_entity_uri( $entity->ID )
-		);
-		// Perform the query
-		$meta_instances = (int) $wpdb->get_var( $stmt );
-
-		// If there is at least one meta that refers the current entity uri, then current entity is used
-		if ( 0 < $meta_instances ) {
-			return true;
-		}
-
-		// If we are here, it means the current entity is not used at the moment
-		return false;
-	}
-
-	/**
-	 * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
-	 *
-	 * @param string $uri The entity URI.
-	 *
-	 * @return WP_Post|null A WP_Post instance or null if not found.
-	 * @deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
-	 *
-	 * @since      3.16.3 deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
-	 * @since      3.2.0
-	 *
-	 */
-	public function get_entity_post_by_uri( $uri ) {
-
-		return $this->entity_uri_service->get_entity( $uri );
-	}
-
-	/**
-	 * Fires once a post has been saved. This function uses the $_REQUEST, therefore
-	 * we check that the post we're saving is the current post.
-	 *
-	 * @see   https://github.com/insideout10/wordlift-plugin/issues/363
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param int $post_id Post ID.
-	 * @param WP_Post $post Post object.
-	 * @param bool $update Whether this is an existing post being updated or not.
-	 */
-	public function save_post( $post_id, $post, $update ) {
-
-		// Avoid doing anything if post is autosave or a revision.
-		if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
-			return;
-		}
-
-		// We're setting the alternative label that have been provided via the UI
-		// (in fact we're using $_REQUEST), while save_post may be also called
-		// programmatically by some other function: we need to check therefore if
-		// the $post_id in the save_post call matches the post id set in the request.
-		//
-		// If this is not the current post being saved or if it's not an entity, return.
-		if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
-			return;
-		}
-
-		// Get the alt labels from the request (or empty array).
-		$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
-
-		if ( ( ! empty( $_POST['content'] ) && ! empty( $_POST['post_content'] ) ) || isset( $_REQUEST['wl_alternative_label'] ) ) {
-			// This is via classic editor, so set the alternative labels.
-			$this->set_alternative_labels( $post_id, $alt_labels );
-		}
-
-
-	}
-
-	/**
-	 * Set the alternative labels.
-	 *
-	 * @param int $post_id The post id.
-	 * @param array $alt_labels An array of labels.
-	 *
-	 * @since 3.2.0
-	 *
-	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
-
-		// Bail out if post id is not numeric. We add this check as we found a WP install that was sending a WP_Error
-		// instead of post id.
-		if ( ! is_numeric( $post_id ) ) {
-			return;
-		}
-
-		// Force $alt_labels to be an array
-		if ( ! is_array( $alt_labels ) ) {
-			$alt_labels = array( $alt_labels );
-		}
-
-		$this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
-
-		// Delete all the existing alternate labels.
-		delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
-
-		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
-			}
-		}
-
-	}
-
-	/**
-	 * Retrieve the alternate labels.
-	 *
-	 * @param int $post_id Post id.
-	 *
-	 * @return mixed An array  of alternative labels.
-	 * @since 3.2.0
-	 *
-	 */
-	public function get_alternative_labels( $post_id ) {
-
-		return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
-	}
-
-	/**
-	 * Retrieve the labels for an entity, i.e. the title + the synonyms.
-	 *
-	 * @param int $post_id The entity {@link WP_Post} id.
-	 *
-	 * @return array An array with the entity title and labels.
-	 * @since 3.12.0
-	 *
-	 */
-	public function get_labels( $post_id ) {
-
-		return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
-	}
-
-	/**
-	 * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
-	 *
-	 * @param WP_Post $post Post object.
-	 *
-	 * @since 3.2.0
-	 *
-	 */
-	public function edit_form_before_permalink( $post ) {
-
-		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
-			return;
-		}
-
-		// Print the input template.
-		$this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
-
-		// Print all the currently set alternative labels.
-		foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
-
-			echo $this->get_alternative_label_input( $alt_label );
-
-		};
-
-		// Print the button.
-		$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
-
-	}
-
-	/**
-	 * Get the URI for the entity with the specified post id.
-	 *
-	 * @param int $post_id The entity post id.
-	 *
-	 * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
-	 * @since 3.6.0
-	 *
-	 */
-	public function get_uri( $post_id ) {
-
-		// If a null is given, nothing to do
-		if ( is_null( $post_id ) ) {
-			return null;
-		}
-
-		$dataset_uri = wl_configuration_get_redlink_dataset_uri();
-
-		// If the dataset uri is not properly configured, null is returned
-		if ( empty( $dataset_uri ) ) {
-			return null;
-		}
-
-		$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
-
-		/*
+        foreach ( $terms as $term ) {
+            if ( 'article' !== $term->slug ) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Get the proper classification scope for a given entity post
+     *
+     * @param integer $post_id An entity post id.
+     *
+     * @param string $default The default classification scope, `what` if not
+     *                         provided.
+     *
+     * @return string Returns a classification scope (e.g. 'what').
+     * @since 3.5.0
+     *
+     */
+    public function get_classification_scope_for( $post_id, $default = WL_WHAT_RELATION ) {
+
+        if ( false === $this->is_entity( $post_id ) ) {
+            return $default;
+        }
+
+        // Retrieve the entity type
+        $entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
+        $entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
+        // Retrieve classification boxes configuration
+        $classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
+        foreach ( $classification_boxes as $cb ) {
+            if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
+                return $cb['id'];
+            }
+        }
+
+        return $default;
+    }
+
+    /**
+     * Check whether a {@link WP_Post} is used.
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     *
+     * @return bool|null Null if it's not an entity, otherwise true if it's used.
+     */
+    public function is_used( $post_id ) {
+
+        if ( false === $this->is_entity( $post_id ) ) {
+            return null;
+        }
+        // Retrieve the post
+        $entity = get_post( $post_id );
+
+        global $wpdb;
+        // Retrieve Wordlift relation instances table name
+        $table_name = wl_core_get_relation_instances_table_name();
+
+        // Check is it's referenced / related to another post / entity
+        $stmt = $wpdb->prepare(
+            "SELECT COUNT(*) FROM $table_name WHERE  object_id = %d",
+            $entity->ID
+        );
+
+        // Perform the query
+        $relation_instances = (int) $wpdb->get_var( $stmt );
+        // If there is at least one relation instance for the current entity, then it's used
+        if ( 0 < $relation_instances ) {
+            return true;
+        }
+
+        // Check if the entity uri is used as meta_value
+        $stmt = $wpdb->prepare(
+            "SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
+            $entity->ID,
+            wl_get_entity_uri( $entity->ID )
+        );
+        // Perform the query
+        $meta_instances = (int) $wpdb->get_var( $stmt );
+
+        // If there is at least one meta that refers the current entity uri, then current entity is used
+        if ( 0 < $meta_instances ) {
+            return true;
+        }
+
+        // If we are here, it means the current entity is not used at the moment
+        return false;
+    }
+
+    /**
+     * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
+     *
+     * @param string $uri The entity URI.
+     *
+     * @return WP_Post|null A WP_Post instance or null if not found.
+     * @deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
+     *
+     * @since      3.16.3 deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
+     * @since      3.2.0
+     *
+     */
+    public function get_entity_post_by_uri( $uri ) {
+
+        return $this->entity_uri_service->get_entity( $uri );
+    }
+
+    /**
+     * Fires once a post has been saved. This function uses the $_REQUEST, therefore
+     * we check that the post we're saving is the current post.
+     *
+     * @see   https://github.com/insideout10/wordlift-plugin/issues/363
+     *
+     * @since 3.2.0
+     *
+     * @param int $post_id Post ID.
+     * @param WP_Post $post Post object.
+     * @param bool $update Whether this is an existing post being updated or not.
+     */
+    public function save_post( $post_id, $post, $update ) {
+
+        // Avoid doing anything if post is autosave or a revision.
+        if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
+            return;
+        }
+
+        // We're setting the alternative label that have been provided via the UI
+        // (in fact we're using $_REQUEST), while save_post may be also called
+        // programmatically by some other function: we need to check therefore if
+        // the $post_id in the save_post call matches the post id set in the request.
+        //
+        // If this is not the current post being saved or if it's not an entity, return.
+        if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
+            return;
+        }
+
+        // Get the alt labels from the request (or empty array).
+        $alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
+
+        if ( ( ! empty( $_POST['content'] ) && ! empty( $_POST['post_content'] ) ) || isset( $_REQUEST['wl_alternative_label'] ) ) {
+            // This is via classic editor, so set the alternative labels.
+            $this->set_alternative_labels( $post_id, $alt_labels );
+        }
+
+
+    }
+
+    /**
+     * Set the alternative labels.
+     *
+     * @param int $post_id The post id.
+     * @param array $alt_labels An array of labels.
+     *
+     * @since 3.2.0
+     *
+     */
+    public function set_alternative_labels( $post_id, $alt_labels ) {
+
+        // Bail out if post id is not numeric. We add this check as we found a WP install that was sending a WP_Error
+        // instead of post id.
+        if ( ! is_numeric( $post_id ) ) {
+            return;
+        }
+
+        // Force $alt_labels to be an array
+        if ( ! is_array( $alt_labels ) ) {
+            $alt_labels = array( $alt_labels );
+        }
+
+        $this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
+
+        // Delete all the existing alternate labels.
+        delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+
+        // Set the alternative labels.
+        foreach ( $alt_labels as $alt_label ) {
+            if ( ! empty( $alt_label ) ) {
+                add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
+            }
+        }
+
+    }
+
+    /**
+     * Retrieve the alternate labels.
+     *
+     * @param int $post_id Post id.
+     *
+     * @return mixed An array  of alternative labels.
+     * @since 3.2.0
+     *
+     */
+    public function get_alternative_labels( $post_id ) {
+
+        return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+    }
+
+    /**
+     * Retrieve the labels for an entity, i.e. the title + the synonyms.
+     *
+     * @param int $post_id The entity {@link WP_Post} id.
+     *
+     * @return array An array with the entity title and labels.
+     * @since 3.12.0
+     *
+     */
+    public function get_labels( $post_id ) {
+
+        return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
+    }
+
+    /**
+     * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
+     *
+     * @param WP_Post $post Post object.
+     *
+     * @since 3.2.0
+     *
+     */
+    public function edit_form_before_permalink( $post ) {
+
+        // If it's not an entity, return.
+        if ( ! $this->is_entity( $post->ID ) ) {
+            return;
+        }
+
+        // Print the input template.
+        $this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+
+        // Print all the currently set alternative labels.
+        foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
+
+            echo $this->get_alternative_label_input( $alt_label );
+
+        };
+
+        // Print the button.
+        $this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+
+    }
+
+    /**
+     * Get the URI for the entity with the specified post id.
+     *
+     * @param int $post_id The entity post id.
+     *
+     * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
+     * @since 3.6.0
+     *
+     */
+    public function get_uri( $post_id ) {
+
+        // If a null is given, nothing to do
+        if ( is_null( $post_id ) ) {
+            return null;
+        }
+
+        $dataset_uri = wl_configuration_get_redlink_dataset_uri();
+
+        // If the dataset uri is not properly configured, null is returned
+        if ( empty( $dataset_uri ) ) {
+            return null;
+        }
+
+        $uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
+
+        /*
 		 * Consider the URI invalid if it doesn't start with the dataset URI.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/996
 		 */
-		if ( 0 !== strpos( $uri, $dataset_uri ) ) {
-			$uri = null;
-		}
-
-		// Set the URI if it isn't set yet.
-		$post_status = get_post_status( $post_id );
-		if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
-			$uri = wl_build_entity_uri( $post_id );
-			wl_set_entity_uri( $post_id, $uri );
-		}
-
-		return $uri;
-	}
-
-
-	/**
-	 * Get the alternative label input HTML code.
-	 *
-	 * @param string $value The input value.
-	 *
-	 * @return string The input HTML code.
-	 * @since 3.2.0
-	 *
-	 */
-	private function get_alternative_label_input( $value = '' ) {
-
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
-	}
-
-	/**
-	 * Get the number of entity posts published in this blog.
-	 *
-	 * @return int The number of published entity posts.
-	 * @since 3.6.0
-	 *
-	 */
-	public function count() {
-		global $wpdb;
-
-		// Try to get the count from the transient.
-		$count = get_transient( '_wl_entity_service__count' );
-		if ( false !== $count ) {
-			return $count;
-		}
-
-		// Query the count.
-		$count = $wpdb->get_var( $wpdb->prepare(
-			"SELECT COUNT( DISTINCT( tr.object_id ) )"
-			. " FROM {$wpdb->term_relationships} tr"
-			. " INNER JOIN {$wpdb->term_taxonomy} tt"
-			. "  ON tt.taxonomy = %s AND tt.term_taxonomy_id = tr.term_taxonomy_id"
-			. " INNER JOIN {$wpdb->terms} t"
-			. "  ON t.term_id = tt.term_id AND t.name != %s",
-			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-			'article'
-		) );
-
-		// Store the count in cache.
-		set_transient( '_wl_entity_service__count', $count, 900 );
-
-		return $count;
-	}
-
-	/**
-	 * Add the entity filtering criterias to the arguments for a `get_posts`
-	 * call.
-	 *
-	 * @param array $args The arguments for a `get_posts` call.
-	 *
-	 * @return array The arguments for a `get_posts` call.
-	 * @since 3.15.0
-	 *
-	 */
-	public static function add_criterias( $args ) {
-
-		// Build an optimal tax-query.
-		$tax_query = array(
-			'relation' => 'AND',
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'operator' => 'EXISTS',
-			),
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'field'    => 'slug',
-				'terms'    => 'article',
-				'operator' => 'NOT IN',
-			),
-		);
-
-		return $args + array(
-				'post_type' => Wordlift_Entity_Service::valid_entity_post_types(),
-				/*
+        if ( 0 !== strpos( $uri, $dataset_uri ) ) {
+            $uri = null;
+        }
+
+        // Set the URI if it isn't set yet.
+        $post_status = get_post_status( $post_id );
+        if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
+            $uri = wl_build_entity_uri( $post_id );
+            wl_set_entity_uri( $post_id, $uri );
+        }
+
+        return $uri;
+    }
+
+
+    /**
+     * Get the alternative label input HTML code.
+     *
+     * @param string $value The input value.
+     *
+     * @return string The input HTML code.
+     * @since 3.2.0
+     *
+     */
+    private function get_alternative_label_input( $value = '' ) {
+
+        return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
+    }
+
+    /**
+     * Get the number of entity posts published in this blog.
+     *
+     * @return int The number of published entity posts.
+     * @since 3.6.0
+     *
+     */
+    public function count() {
+        global $wpdb;
+
+        // Try to get the count from the transient.
+        $count = get_transient( '_wl_entity_service__count' );
+        if ( false !== $count ) {
+            return $count;
+        }
+
+        // Query the count.
+        $count = $wpdb->get_var( $wpdb->prepare(
+            "SELECT COUNT( DISTINCT( tr.object_id ) )"
+            . " FROM {$wpdb->term_relationships} tr"
+            . " INNER JOIN {$wpdb->term_taxonomy} tt"
+            . "  ON tt.taxonomy = %s AND tt.term_taxonomy_id = tr.term_taxonomy_id"
+            . " INNER JOIN {$wpdb->terms} t"
+            . "  ON t.term_id = tt.term_id AND t.name != %s",
+            Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+            'article'
+        ) );
+
+        // Store the count in cache.
+        set_transient( '_wl_entity_service__count', $count, 900 );
+
+        return $count;
+    }
+
+    /**
+     * Add the entity filtering criterias to the arguments for a `get_posts`
+     * call.
+     *
+     * @param array $args The arguments for a `get_posts` call.
+     *
+     * @return array The arguments for a `get_posts` call.
+     * @since 3.15.0
+     *
+     */
+    public static function add_criterias( $args ) {
+
+        // Build an optimal tax-query.
+        $tax_query = array(
+            'relation' => 'AND',
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'operator' => 'EXISTS',
+            ),
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'field'    => 'slug',
+                'terms'    => 'article',
+                'operator' => 'NOT IN',
+            ),
+        );
+
+        return $args + array(
+                'post_type' => Wordlift_Entity_Service::valid_entity_post_types(),
+                /*
 				 * Ensure compatibility with Polylang.
 				 *
 				 * @see https://github.com/insideout10/wordlift-plugin/issues/855.
@@ -523,102 +523,102 @@ 
 				 *
 				 * @since 3.19.5
 				 */
-				'lang'      => '',
-				'tax_query' => $tax_query,
-			);
-	}
-
-	/**
-	 * Create a new entity.
-	 *
-	 * @param string $name The entity name.
-	 * @param string $type_uri The entity's type URI.
-	 * @param null $logo The entity logo id (or NULL if none).
-	 * @param string $status The post status, by default 'publish'.
-	 *
-	 * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
-	 * @since 3.9.0
-	 *
-	 */
-	public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
-
-		// Create an entity for the publisher.
-		$post_id = @wp_insert_post( array(
-			'post_type'    => self::TYPE_NAME,
-			'post_title'   => $name,
-			'post_status'  => $status,
-			'post_content' => '',
-		) );
-
-		// Return the error if any.
-		if ( is_wp_error( $post_id ) ) {
-			return $post_id;
-		}
-
-		// Set the entity logo.
-		if ( $logo && is_numeric( $logo ) ) {
-			set_post_thumbnail( $post_id, $logo );
-		}
-
-		// Set the entity type.
-		Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
-
-		return $post_id;
-	}
-
-	/**
-	 * Get the entities related to the one with the specified id. By default only
-	 * published entities will be returned.
-	 *
-	 * @param int $id The post id.
-	 * @param string $post_status The target post status (default = publish).
-	 *
-	 * @return array An array of post ids.
-	 * @since 3.10.0
-	 *
-	 */
-	public function get_related_entities( $id, $post_status = 'publish' ) {
-
-		return $this->relation_service->get_objects( $id, 'ids', null, $post_status );
-	}
-
-	/**
-	 * Get the list of entities.
-	 *
-	 * @param array $params Custom parameters for WordPress' own {@link get_posts} function.
-	 *
-	 * @return array An array of entity posts.
-	 * @since 3.12.2
-	 *
-	 */
-	public function get( $params = array() ) {
-
-		// Set the defaults.
-		$defaults = array( 'post_type' => 'entity' );
-
-		// Merge the defaults with the provided parameters.
-		$args = wp_parse_args( $params, $defaults );
-
-		// Call the `get_posts` function.
-		return get_posts( $args );
-	}
-
-	/**
-	 * The list of post type names which can be used for entities
-	 *
-	 * Criteria is that the post type is public. The list of valid post types
-	 * can be overridden with a filter.
-	 *
-	 * @return array Array containing the names of the valid post types.
-	 * @since 3.15.0
-	 *
-	 */
-	static function valid_entity_post_types() {
-
-		// Ignore builtins in the call to avoid getting attachments.
-		$post_types = array( 'post', 'page', self::TYPE_NAME );
-
-		return apply_filters( 'wl_valid_entity_post_types', $post_types );
-	}
+                'lang'      => '',
+                'tax_query' => $tax_query,
+            );
+    }
+
+    /**
+     * Create a new entity.
+     *
+     * @param string $name The entity name.
+     * @param string $type_uri The entity's type URI.
+     * @param null $logo The entity logo id (or NULL if none).
+     * @param string $status The post status, by default 'publish'.
+     *
+     * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
+     * @since 3.9.0
+     *
+     */
+    public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
+
+        // Create an entity for the publisher.
+        $post_id = @wp_insert_post( array(
+            'post_type'    => self::TYPE_NAME,
+            'post_title'   => $name,
+            'post_status'  => $status,
+            'post_content' => '',
+        ) );
+
+        // Return the error if any.
+        if ( is_wp_error( $post_id ) ) {
+            return $post_id;
+        }
+
+        // Set the entity logo.
+        if ( $logo && is_numeric( $logo ) ) {
+            set_post_thumbnail( $post_id, $logo );
+        }
+
+        // Set the entity type.
+        Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
+
+        return $post_id;
+    }
+
+    /**
+     * Get the entities related to the one with the specified id. By default only
+     * published entities will be returned.
+     *
+     * @param int $id The post id.
+     * @param string $post_status The target post status (default = publish).
+     *
+     * @return array An array of post ids.
+     * @since 3.10.0
+     *
+     */
+    public function get_related_entities( $id, $post_status = 'publish' ) {
+
+        return $this->relation_service->get_objects( $id, 'ids', null, $post_status );
+    }
+
+    /**
+     * Get the list of entities.
+     *
+     * @param array $params Custom parameters for WordPress' own {@link get_posts} function.
+     *
+     * @return array An array of entity posts.
+     * @since 3.12.2
+     *
+     */
+    public function get( $params = array() ) {
+
+        // Set the defaults.
+        $defaults = array( 'post_type' => 'entity' );
+
+        // Merge the defaults with the provided parameters.
+        $args = wp_parse_args( $params, $defaults );
+
+        // Call the `get_posts` function.
+        return get_posts( $args );
+    }
+
+    /**
+     * The list of post type names which can be used for entities
+     *
+     * Criteria is that the post type is public. The list of valid post types
+     * can be overridden with a filter.
+     *
+     * @return array Array containing the names of the valid post types.
+     * @since 3.15.0
+     *
+     */
+    static function valid_entity_post_types() {
+
+        // Ignore builtins in the call to avoid getting attachments.
+        $post_types = array( 'post', 'page', self::TYPE_NAME );
+
+        return apply_filters( 'wl_valid_entity_post_types', $post_types );
+    }
 
 }

Spacing +83 added lines, -83 removed lines

@@ -97,9 +97,9 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function __construct( $ui_service, $relation_service, $entity_uri_service ) {
+	public function __construct($ui_service, $relation_service, $entity_uri_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Entity_Service');
 
 		$this->ui_service         = $ui_service;
 		$this->relation_service   = $relation_service;
@@ -130,17 +130,17 @@ 
 	 * @since 3.1.0
 	 *
 	 */
-	public function is_entity( $post_id ) {
+	public function is_entity($post_id) {
 
-		$terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+		$terms = wp_get_object_terms($post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 
-		if ( is_wp_error( $terms ) ) {
-			$this->log->error( "Cannot get the terms for post $post_id: " . $terms->get_error_message() );
+		if (is_wp_error($terms)) {
+			$this->log->error("Cannot get the terms for post $post_id: ".$terms->get_error_message());
 
 			return false;
 		}
 
-		if ( empty( $terms ) ) {
+		if (empty($terms)) {
 			return false;
 		}
 
@@ -151,8 +151,8 @@ 
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 */
-		foreach ( $terms as $term ) {
-			if ( 'article' !== $term->slug ) {
+		foreach ($terms as $term) {
+			if ('article' !== $term->slug) {
 				return true;
 			}
 		}
@@ -172,19 +172,19 @@ 
 	 * @since 3.5.0
 	 *
 	 */
-	public function get_classification_scope_for( $post_id, $default = WL_WHAT_RELATION ) {
+	public function get_classification_scope_for($post_id, $default = WL_WHAT_RELATION) {
 
-		if ( false === $this->is_entity( $post_id ) ) {
+		if (false === $this->is_entity($post_id)) {
 			return $default;
 		}
 
 		// Retrieve the entity type
-		$entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
-		$entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
+		$entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get($post_id);
+		$entity_type     = str_replace('wl-', '', $entity_type_arr['css_class']);
 		// Retrieve classification boxes configuration
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
+		$classification_boxes = unserialize(WL_CORE_POST_CLASSIFICATION_BOXES);
+		foreach ($classification_boxes as $cb) {
+			if (in_array($entity_type, $cb['registeredTypes'])) {
 				return $cb['id'];
 			}
 		}
@@ -199,13 +199,13 @@ 
 	 *
 	 * @return bool|null Null if it's not an entity, otherwise true if it's used.
 	 */
-	public function is_used( $post_id ) {
+	public function is_used($post_id) {
 
-		if ( false === $this->is_entity( $post_id ) ) {
+		if (false === $this->is_entity($post_id)) {
 			return null;
 		}
 		// Retrieve the post
-		$entity = get_post( $post_id );
+		$entity = get_post($post_id);
 
 		global $wpdb;
 		// Retrieve Wordlift relation instances table name
@@ -218,9 +218,9 @@ 
 		);
 
 		// Perform the query
-		$relation_instances = (int) $wpdb->get_var( $stmt );
+		$relation_instances = (int) $wpdb->get_var($stmt);
 		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
+		if (0 < $relation_instances) {
 			return true;
 		}
 
@@ -228,13 +228,13 @@ 
 		$stmt = $wpdb->prepare(
 			"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
 			$entity->ID,
-			wl_get_entity_uri( $entity->ID )
+			wl_get_entity_uri($entity->ID)
 		);
 		// Perform the query
-		$meta_instances = (int) $wpdb->get_var( $stmt );
+		$meta_instances = (int) $wpdb->get_var($stmt);
 
 		// If there is at least one meta that refers the current entity uri, then current entity is used
-		if ( 0 < $meta_instances ) {
+		if (0 < $meta_instances) {
 			return true;
 		}
 
@@ -254,9 +254,9 @@ 
 	 * @since      3.2.0
 	 *
 	 */
-	public function get_entity_post_by_uri( $uri ) {
+	public function get_entity_post_by_uri($uri) {
 
-		return $this->entity_uri_service->get_entity( $uri );
+		return $this->entity_uri_service->get_entity($uri);
 	}
 
 	/**
@@ -271,10 +271,10 @@ 
 	 * @param WP_Post $post Post object.
 	 * @param bool $update Whether this is an existing post being updated or not.
 	 */
-	public function save_post( $post_id, $post, $update ) {
+	public function save_post($post_id, $post, $update) {
 
 		// Avoid doing anything if post is autosave or a revision.
-		if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
+		if (wp_is_post_autosave($post) || wp_is_post_revision($post)) {
 			return;
 		}
 
@@ -284,16 +284,16 @@ 
 		// the $post_id in the save_post call matches the post id set in the request.
 		//
 		// If this is not the current post being saved or if it's not an entity, return.
-		if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
+		if ( ! isset($_REQUEST['post_ID']) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity($post_id)) {
 			return;
 		}
 
 		// Get the alt labels from the request (or empty array).
-		$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
+		$alt_labels = isset($_REQUEST['wl_alternative_label']) ? $_REQUEST['wl_alternative_label'] : array();
 
-		if ( ( ! empty( $_POST['content'] ) && ! empty( $_POST['post_content'] ) ) || isset( $_REQUEST['wl_alternative_label'] ) ) {
+		if (( ! empty($_POST['content']) && ! empty($_POST['post_content'])) || isset($_REQUEST['wl_alternative_label'])) {
 			// This is via classic editor, so set the alternative labels.
-			$this->set_alternative_labels( $post_id, $alt_labels );
+			$this->set_alternative_labels($post_id, $alt_labels);
 		}
 
 
@@ -308,28 +308,28 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
+	public function set_alternative_labels($post_id, $alt_labels) {
 
 		// Bail out if post id is not numeric. We add this check as we found a WP install that was sending a WP_Error
 		// instead of post id.
-		if ( ! is_numeric( $post_id ) ) {
+		if ( ! is_numeric($post_id)) {
 			return;
 		}
 
 		// Force $alt_labels to be an array
-		if ( ! is_array( $alt_labels ) ) {
-			$alt_labels = array( $alt_labels );
+		if ( ! is_array($alt_labels)) {
+			$alt_labels = array($alt_labels);
 		}
 
-		$this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
+		$this->log->debug("Setting alternative labels [ post id :: $post_id ][ alt labels :: ".implode(',', $alt_labels)." ]");
 
 		// Delete all the existing alternate labels.
-		delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+		delete_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY);
 
 		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
+		foreach ($alt_labels as $alt_label) {
+			if ( ! empty($alt_label)) {
+				add_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label);
 			}
 		}
 
@@ -344,9 +344,9 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function get_alternative_labels( $post_id ) {
+	public function get_alternative_labels($post_id) {
 
-		return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+		return get_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY);
 	}
 
 	/**
@@ -358,9 +358,9 @@ 
 	 * @since 3.12.0
 	 *
 	 */
-	public function get_labels( $post_id ) {
+	public function get_labels($post_id) {
 
-		return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
+		return array_merge((array) get_the_title($post_id), $this->get_alternative_labels($post_id));
 	}
 
 	/**
@@ -371,25 +371,25 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function edit_form_before_permalink( $post ) {
+	public function edit_form_before_permalink($post) {
 
 		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
+		if ( ! $this->is_entity($post->ID)) {
 			return;
 		}
 
 		// Print the input template.
-		$this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+		$this->ui_service->print_template('wl-tmpl-alternative-label-input', $this->get_alternative_label_input());
 
 		// Print all the currently set alternative labels.
-		foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
+		foreach ($this->get_alternative_labels($post->ID) as $alt_label) {
 
-			echo $this->get_alternative_label_input( $alt_label );
+			echo $this->get_alternative_label_input($alt_label);
 
 		};
 
 		// Print the button.
-		$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+		$this->ui_service->print_button('wl-add-alternative-labels-button', __('Add more titles', 'wordlift'));
 
 	}
 
@@ -402,36 +402,36 @@ 
 	 * @since 3.6.0
 	 *
 	 */
-	public function get_uri( $post_id ) {
+	public function get_uri($post_id) {
 
 		// If a null is given, nothing to do
-		if ( is_null( $post_id ) ) {
+		if (is_null($post_id)) {
 			return null;
 		}
 
 		$dataset_uri = wl_configuration_get_redlink_dataset_uri();
 
 		// If the dataset uri is not properly configured, null is returned
-		if ( empty( $dataset_uri ) ) {
+		if (empty($dataset_uri)) {
 			return null;
 		}
 
-		$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
+		$uri = get_post_meta($post_id, WL_ENTITY_URL_META_NAME, true);
 
 		/*
 		 * Consider the URI invalid if it doesn't start with the dataset URI.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/996
 		 */
-		if ( 0 !== strpos( $uri, $dataset_uri ) ) {
+		if (0 !== strpos($uri, $dataset_uri)) {
 			$uri = null;
 		}
 
 		// Set the URI if it isn't set yet.
-		$post_status = get_post_status( $post_id );
-		if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
-			$uri = wl_build_entity_uri( $post_id );
-			wl_set_entity_uri( $post_id, $uri );
+		$post_status = get_post_status($post_id);
+		if (empty($uri) && 'auto-draft' !== $post_status && 'revision' !== $post_status) {
+			$uri = wl_build_entity_uri($post_id);
+			wl_set_entity_uri($post_id, $uri);
 		}
 
 		return $uri;
@@ -447,9 +447,9 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	private function get_alternative_label_input( $value = '' ) {
+	private function get_alternative_label_input($value = '') {
 
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
+		return sprintf(self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr($value), __('Delete', 'wordlift'));
 	}
 
 	/**
@@ -463,13 +463,13 @@ 
 		global $wpdb;
 
 		// Try to get the count from the transient.
-		$count = get_transient( '_wl_entity_service__count' );
-		if ( false !== $count ) {
+		$count = get_transient('_wl_entity_service__count');
+		if (false !== $count) {
 			return $count;
 		}
 
 		// Query the count.
-		$count = $wpdb->get_var( $wpdb->prepare(
+		$count = $wpdb->get_var($wpdb->prepare(
 			"SELECT COUNT( DISTINCT( tr.object_id ) )"
 			. " FROM {$wpdb->term_relationships} tr"
 			. " INNER JOIN {$wpdb->term_taxonomy} tt"
@@ -478,10 +478,10 @@ 
 			. "  ON t.term_id = tt.term_id AND t.name != %s",
 			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
 			'article'
-		) );
+		));
 
 		// Store the count in cache.
-		set_transient( '_wl_entity_service__count', $count, 900 );
+		set_transient('_wl_entity_service__count', $count, 900);
 
 		return $count;
 	}
@@ -496,7 +496,7 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	public static function add_criterias( $args ) {
+	public static function add_criterias($args) {
 
 		// Build an optimal tax-query.
 		$tax_query = array(
@@ -540,28 +540,28 @@ 
 	 * @since 3.9.0
 	 *
 	 */
-	public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
+	public function create($name, $type_uri, $logo = null, $status = 'publish') {
 
 		// Create an entity for the publisher.
-		$post_id = @wp_insert_post( array(
+		$post_id = @wp_insert_post(array(
 			'post_type'    => self::TYPE_NAME,
 			'post_title'   => $name,
 			'post_status'  => $status,
 			'post_content' => '',
-		) );
+		));
 
 		// Return the error if any.
-		if ( is_wp_error( $post_id ) ) {
+		if (is_wp_error($post_id)) {
 			return $post_id;
 		}
 
 		// Set the entity logo.
-		if ( $logo && is_numeric( $logo ) ) {
-			set_post_thumbnail( $post_id, $logo );
+		if ($logo && is_numeric($logo)) {
+			set_post_thumbnail($post_id, $logo);
 		}
 
 		// Set the entity type.
-		Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
+		Wordlift_Entity_Type_Service::get_instance()->set($post_id, $type_uri);
 
 		return $post_id;
 	}
@@ -577,9 +577,9 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	public function get_related_entities( $id, $post_status = 'publish' ) {
+	public function get_related_entities($id, $post_status = 'publish') {
 
-		return $this->relation_service->get_objects( $id, 'ids', null, $post_status );
+		return $this->relation_service->get_objects($id, 'ids', null, $post_status);
 	}
 
 	/**
@@ -591,16 +591,16 @@ 
 	 * @since 3.12.2
 	 *
 	 */
-	public function get( $params = array() ) {
+	public function get($params = array()) {
 
 		// Set the defaults.
-		$defaults = array( 'post_type' => 'entity' );
+		$defaults = array('post_type' => 'entity');
 
 		// Merge the defaults with the provided parameters.
-		$args = wp_parse_args( $params, $defaults );
+		$args = wp_parse_args($params, $defaults);
 
 		// Call the `get_posts` function.
-		return get_posts( $args );
+		return get_posts($args);
 	}
 
 	/**
@@ -616,9 +616,9 @@ 
 	static function valid_entity_post_types() {
 
 		// Ignore builtins in the call to avoid getting attachments.
-		$post_types = array( 'post', 'page', self::TYPE_NAME );
+		$post_types = array('post', 'page', self::TYPE_NAME);
 
-		return apply_filters( 'wl_valid_entity_post_types', $post_types );
+		return apply_filters('wl_valid_entity_post_types', $post_types);
 	}
 
 }