insideout10 / wordlift-plugin

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

Indentation +182 added lines, -182 removed lines

@@ -21,190 +21,190 @@
  */
 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;
-
-	/**
-	 * @var Ttl_Cache
-	 */
-	private $ttl_cache_service;
-
-	/**
-	 * Create a {@link Wordlift_Key_Validation_Service} instance.
-	 *
-	 * @since 3.14.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
-
-		add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
-		/**
-		 * Filter: wl_feature__enable__notices.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
-		}
-
-		$this->ttl_cache_service = new Ttl_Cache( 'key-validation-notification' );
-
-	}
-
-	/**
-	 * 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...' );
-
-		$response = Default_Api_Service::get_instance()->get(
-			'/accounts/info',
-			array(
-				'Authorization' => "Key $key",
-			)
-		);
-
-		/**
-		 * @param $response \Wordlift\Api\Response
-		 *
-		 * @since 3.38.5
-		 * This action is fired when the key is validated.
-		 */
-		do_action( 'wl_key_validation_response', $response );
-
-		return $response->get_response();
-	}
-
-	private function key_validation_request( $key ) {
-		$response = $this->get_account_info( $key );
-
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			throw new \Exception( __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ) );
-		}
-
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
-
-		$url = $res_body['url'];
-
-		$enabled_features = array_keys( array_filter( $res_body['features'] ) );
-		$plugin_features  = array(
-			Entity_Type_Setter::STARTER_PLAN,
-			Entity_Type_Setter::PROFESSIONAL_PLAN,
-			Entity_Type_Setter::BUSINESS_PLAN,
-		);
-
-		if ( count( array_intersect( $enabled_features, $plugin_features ) ) === 0 ) {
-			throw new \Exception( __( 'This key is not valid. Start building your Knowledge Graph by purchasing a WordLift subscription <a href=\'https://wordlift.io/pricing/\'>here</a>.', 'wordlift' ) );
-		}
-
-		// Considering that production URL may be filtered.
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
-
-		if ( ! empty( $url ) && $url !== $site_url ) {
-			throw new \Exception( __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if key is valid
-	 *
-	 * @param $key string
-	 *
-	 * @return bool
-	 */
-	public function is_key_valid( $key ) {
-		try {
-			$this->key_validation_request( $key );
-
-			return true;
-		} catch ( \Exception $e ) {
-			return false;
-		}
-	}
-
-	/**
-	 * 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'] ) ) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			wp_send_json_error( 'The key parameter is required.' );
-		}
-
-		$this->ttl_cache_service->delete( 'is_key_valid' );
-
-		try {
-			$this->key_validation_request( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			wp_send_json_success(
-				array(
-					'valid'   => true,
-					'message' => '',
-				)
-			);
-
-		} catch ( \Exception $e ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			wp_send_json_success(
-				array(
-					'valid'   => false,
-					'message' => $e->getMessage(),
-					'api_url' => Default_Api_Service::get_instance()->get_base_url(),
-				)
-			);
-		}
-	}
-
-	/**
-	 * This function is hooked `admin_init` to check _wl_blog_url.
-	 */
-	public function wl_load_plugin() {
-
-		$wl_blog_url = get_option( '_wl_blog_url' );
-		$home_url    = get_option( 'home' );
-
-		if ( ! $wl_blog_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-		} elseif ( $wl_blog_url !== $home_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-			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;
+
+    /**
+     * @var Ttl_Cache
+     */
+    private $ttl_cache_service;
+
+    /**
+     * Create a {@link Wordlift_Key_Validation_Service} instance.
+     *
+     * @since 3.14.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+
+        add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
+        /**
+         * Filter: wl_feature__enable__notices.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+            add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
+        }
+
+        $this->ttl_cache_service = new Ttl_Cache( 'key-validation-notification' );
+
+    }
+
+    /**
+     * 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...' );
+
+        $response = Default_Api_Service::get_instance()->get(
+            '/accounts/info',
+            array(
+                'Authorization' => "Key $key",
+            )
+        );
+
+        /**
+         * @param $response \Wordlift\Api\Response
+         *
+         * @since 3.38.5
+         * This action is fired when the key is validated.
+         */
+        do_action( 'wl_key_validation_response', $response );
+
+        return $response->get_response();
+    }
+
+    private function key_validation_request( $key ) {
+        $response = $this->get_account_info( $key );
+
+        if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+            throw new \Exception( __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ) );
+        }
+
+        $res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+        $url = $res_body['url'];
+
+        $enabled_features = array_keys( array_filter( $res_body['features'] ) );
+        $plugin_features  = array(
+            Entity_Type_Setter::STARTER_PLAN,
+            Entity_Type_Setter::PROFESSIONAL_PLAN,
+            Entity_Type_Setter::BUSINESS_PLAN,
+        );
+
+        if ( count( array_intersect( $enabled_features, $plugin_features ) ) === 0 ) {
+            throw new \Exception( __( 'This key is not valid. Start building your Knowledge Graph by purchasing a WordLift subscription <a href=\'https://wordlift.io/pricing/\'>here</a>.', 'wordlift' ) );
+        }
+
+        // Considering that production URL may be filtered.
+        $home_url = get_option( 'home' );
+        $site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+
+        if ( ! empty( $url ) && $url !== $site_url ) {
+            throw new \Exception( __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if key is valid
+     *
+     * @param $key string
+     *
+     * @return bool
+     */
+    public function is_key_valid( $key ) {
+        try {
+            $this->key_validation_request( $key );
+
+            return true;
+        } catch ( \Exception $e ) {
+            return false;
+        }
+    }
+
+    /**
+     * 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'] ) ) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
+            wp_send_json_error( 'The key parameter is required.' );
+        }
+
+        $this->ttl_cache_service->delete( 'is_key_valid' );
+
+        try {
+            $this->key_validation_request( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Missing
+            wp_send_json_success(
+                array(
+                    'valid'   => true,
+                    'message' => '',
+                )
+            );
+
+        } catch ( \Exception $e ) {
+            Wordlift_Configuration_Service::get_instance()->set_key( '' );
+            wp_send_json_success(
+                array(
+                    'valid'   => false,
+                    'message' => $e->getMessage(),
+                    'api_url' => Default_Api_Service::get_instance()->get_base_url(),
+                )
+            );
+        }
+    }
+
+    /**
+     * This function is hooked `admin_init` to check _wl_blog_url.
+     */
+    public function wl_load_plugin() {
+
+        $wl_blog_url = get_option( '_wl_blog_url' );
+        $home_url    = get_option( 'home' );
+
+        if ( ! $wl_blog_url ) {
+            update_option( '_wl_blog_url', $home_url, true );
+        } elseif ( $wl_blog_url !== $home_url ) {
+            update_option( '_wl_blog_url', $home_url, true );
+            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 esc_html( get_transient( 'wl-key-error-msg' ) ); ?></p>
 		  </div>
 			<?php
-		}
-	}
+        }
+    }
 }

Spacing +39 added lines, -39 removed lines

@@ -42,20 +42,20 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Key_Validation_Service');
 
-		add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
+		add_action('admin_init', array($this, 'wl_load_plugin'));
 		/**
 		 * Filter: wl_feature__enable__notices.
 		 *
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
+		if (apply_filters('wl_feature__enable__notices', true)) {
+			add_action('admin_notices', array($this, 'wl_key_update_notice'));
 		}
 
-		$this->ttl_cache_service = new Ttl_Cache( 'key-validation-notification' );
+		$this->ttl_cache_service = new Ttl_Cache('key-validation-notification');
 
 	}
 
@@ -67,9 +67,9 @@ 
 	 * @return WP_Error|array The response or WP_Error on failure.
 	 * @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...');
 
 		$response = Default_Api_Service::get_instance()->get(
 			'/accounts/info',
@@ -84,39 +84,39 @@ 
 		 * @since 3.38.5
 		 * This action is fired when the key is validated.
 		 */
-		do_action( 'wl_key_validation_response', $response );
+		do_action('wl_key_validation_response', $response);
 
 		return $response->get_response();
 	}
 
-	private function key_validation_request( $key ) {
-		$response = $this->get_account_info( $key );
+	private function key_validation_request($key) {
+		$response = $this->get_account_info($key);
 
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			throw new \Exception( __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ) );
+		if (is_wp_error($response) || 2 !== (int) $response['response']['code'] / 100) {
+			throw new \Exception(__('An error occurred, please contact us at hello@wordlift.io', 'wordlift'));
 		}
 
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+		$res_body = json_decode(wp_remote_retrieve_body($response), true);
 
 		$url = $res_body['url'];
 
-		$enabled_features = array_keys( array_filter( $res_body['features'] ) );
+		$enabled_features = array_keys(array_filter($res_body['features']));
 		$plugin_features  = array(
 			Entity_Type_Setter::STARTER_PLAN,
 			Entity_Type_Setter::PROFESSIONAL_PLAN,
 			Entity_Type_Setter::BUSINESS_PLAN,
 		);
 
-		if ( count( array_intersect( $enabled_features, $plugin_features ) ) === 0 ) {
-			throw new \Exception( __( 'This key is not valid. Start building your Knowledge Graph by purchasing a WordLift subscription <a href=\'https://wordlift.io/pricing/\'>here</a>.', 'wordlift' ) );
+		if (count(array_intersect($enabled_features, $plugin_features)) === 0) {
+			throw new \Exception(__('This key is not valid. Start building your Knowledge Graph by purchasing a WordLift subscription <a href=\'https://wordlift.io/pricing/\'>here</a>.', 'wordlift'));
 		}
 
 		// Considering that production URL may be filtered.
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+		$home_url = get_option('home');
+		$site_url = apply_filters('wl_production_site_url', untrailingslashit($home_url));
 
-		if ( ! empty( $url ) && $url !== $site_url ) {
-			throw new \Exception( __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ) );
+		if ( ! empty($url) && $url !== $site_url) {
+			throw new \Exception(__('The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift'));
 		}
 
 		return true;
@@ -129,12 +129,12 @@ 
 	 *
 	 * @return bool
 	 */
-	public function is_key_valid( $key ) {
+	public function is_key_valid($key) {
 		try {
-			$this->key_validation_request( $key );
+			$this->key_validation_request($key);
 
 			return true;
-		} catch ( \Exception $e ) {
+		} catch (\Exception $e) {
 			return false;
 		}
 	}
@@ -150,14 +150,14 @@ 
 		ob_clean();
 
 		// Check if we have a key.
-		if ( ! isset( $_POST['key'] ) ) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			wp_send_json_error( 'The key parameter is required.' );
+		if ( ! isset($_POST['key'])) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
+			wp_send_json_error('The key parameter is required.');
 		}
 
-		$this->ttl_cache_service->delete( 'is_key_valid' );
+		$this->ttl_cache_service->delete('is_key_valid');
 
 		try {
-			$this->key_validation_request( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Missing
+			$this->key_validation_request(sanitize_text_field(wp_unslash((string) $_POST['key']))); //phpcs:ignore WordPress.Security.NonceVerification.Missing
 			wp_send_json_success(
 				array(
 					'valid'   => true,
@@ -165,8 +165,8 @@ 
 				)
 			);
 
-		} catch ( \Exception $e ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
+		} catch (\Exception $e) {
+			Wordlift_Configuration_Service::get_instance()->set_key('');
 			wp_send_json_success(
 				array(
 					'valid'   => false,
@@ -182,15 +182,15 @@ 
 	 */
 	public function wl_load_plugin() {
 
-		$wl_blog_url = get_option( '_wl_blog_url' );
-		$home_url    = get_option( 'home' );
+		$wl_blog_url = get_option('_wl_blog_url');
+		$home_url    = get_option('home');
 
-		if ( ! $wl_blog_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-		} elseif ( $wl_blog_url !== $home_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-			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', $home_url, true);
+		} elseif ($wl_blog_url !== $home_url) {
+			update_option('_wl_blog_url', $home_url, true);
+			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);
 		}
 
 	}
@@ -199,10 +199,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' ) ) {
+		if (get_transient('wl-key-error-msg')) {
 			?>
 		  <div class="updated notice is-dismissible error">
-			<p><?php esc_html( get_transient( 'wl-key-error-msg' ) ); ?></p>
+			<p><?php esc_html(get_transient('wl-key-error-msg')); ?></p>
 		  </div>
 			<?php
 		}

src/wordlift.php

Indentation +168 added lines, -168 removed lines

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

Spacing +61 added lines, -61 removed lines

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

src/wordlift/cache/class-ttl-cache.php

Spacing +35 added lines, -35 removed lines

@@ -66,19 +66,19 @@ 
 	 *
 	 * @since 3.21.2
 	 */
-	public function __construct( $name, $ttl = 900 ) {
+	public function __construct($name, $ttl = 900) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->name = $name;
 		$this->ttl  = $ttl;
 
-		$this->cache_dir = self::get_cache_folder() . DIRECTORY_SEPARATOR . md5( $name );
+		$this->cache_dir = self::get_cache_folder().DIRECTORY_SEPARATOR.md5($name);
 
-		$this->log->trace( "Creating the cache folder {$this->cache_dir}..." );
-		wp_mkdir_p( $this->cache_dir );
+		$this->log->trace("Creating the cache folder {$this->cache_dir}...");
+		wp_mkdir_p($this->cache_dir);
 
-		self::$caches[ $name ] = $this;
+		self::$caches[$name] = $this;
 
 	}
 
@@ -94,11 +94,11 @@ 
 
 		// Get the temp dir and add the directory separator if missing.
 		$temp_dir = get_temp_dir();
-		if ( DIRECTORY_SEPARATOR !== substr( $temp_dir, - strlen( DIRECTORY_SEPARATOR ) ) ) {
+		if (DIRECTORY_SEPARATOR !== substr($temp_dir, - strlen(DIRECTORY_SEPARATOR))) {
 			$temp_dir .= DIRECTORY_SEPARATOR;
 		}
 
-		return $temp_dir . 'wl.cache' . DIRECTORY_SEPARATOR . md5( home_url() );
+		return $temp_dir.'wl.cache'.DIRECTORY_SEPARATOR.md5(home_url());
 	}
 
 	/**
@@ -109,64 +109,64 @@ 
 	 * @return mixed|null
 	 * @since 3.21.2
 	 */
-	public function get( $key, $mintime = 0 ) {
+	public function get($key, $mintime = 0) {
 
-		$filename = $this->get_filename( $key );
+		$filename = $this->get_filename($key);
 
 		// No cache.
-		if ( ! file_exists( $filename ) ) {
+		if ( ! file_exists($filename)) {
 			return null;
 		}
 
 		// The cache is not updated or the ttl expired. Delete.
-		$filemtime = filemtime( $filename );
-		if ( $filemtime < $mintime || $this->ttl < ( time() - $filemtime ) ) {
-			$this->delete( $key );
+		$filemtime = filemtime($filename);
+		if ($filemtime < $mintime || $this->ttl < (time() - $filemtime)) {
+			$this->delete($key);
 
 			return null;
 		}
 
 
-		$this->log->trace( "Cache HIT.\n" );
+		$this->log->trace("Cache HIT.\n");
 
 		// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
-		return json_decode( file_get_contents( $filename ), true );
+		return json_decode(file_get_contents($filename), true);
 	}
 
-	public function put( $key, $data ) {
+	public function put($key, $data) {
 
-		$filename = $this->get_filename( $key );
+		$filename = $this->get_filename($key);
 
 		// Cache.
-		if ( file_exists( $filename ) ) {
+		if (file_exists($filename)) {
 			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@unlink( $filename );
+			@unlink($filename);
 		}
 
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged,WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
-		@file_put_contents( $filename, wp_json_encode( $data ) );
+		@file_put_contents($filename, wp_json_encode($data));
 
 	}
 
-	public function delete( $key ) {
+	public function delete($key) {
 
-		$filename = $this->get_filename( $key );
+		$filename = $this->get_filename($key);
 
 		// Delete.
-		if ( file_exists( $filename ) ) {
+		if (file_exists($filename)) {
 			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@unlink( $filename );
+			@unlink($filename);
 		}
 
 	}
 
 	public function flush() {
 
-		$files = glob( $this->cache_dir . DIRECTORY_SEPARATOR . '*' );
-		foreach ( $files as $file ) { // iterate files
-			if ( is_file( $file ) ) {
+		$files = glob($this->cache_dir.DIRECTORY_SEPARATOR.'*');
+		foreach ($files as $file) { // iterate files
+			if (is_file($file)) {
 				// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-				@unlink( $file );
+				@unlink($file);
 			}
 		}
 
@@ -175,7 +175,7 @@ 
 	public static function flush_all() {
 
 		/** @var Ttl_Cache $cache */
-		foreach ( self::$caches as $cache ) {
+		foreach (self::$caches as $cache) {
 			$cache->flush();
 		}
 
@@ -189,16 +189,16 @@ 
 	 * @return string The full path to the file.
 	 * @since 3.21.2
 	 */
-	private function get_path( $hash ) {
+	private function get_path($hash) {
 
-		return $this->cache_dir . DIRECTORY_SEPARATOR . $hash;
+		return $this->cache_dir.DIRECTORY_SEPARATOR.$hash;
 	}
 
-	private function get_filename( $key ) {
+	private function get_filename($key) {
 
 		// Create a hash and a path to the cache file.
-		$hash     = md5( wp_json_encode( $key ) );
-		$filename = $this->get_path( $hash );
+		$hash     = md5(wp_json_encode($key));
+		$filename = $this->get_path($hash);
 
 		return $filename;
 	}

Indentation +169 added lines, -169 removed lines

@@ -17,189 +17,189 @@
 // @@todo: add a hook to clear the cached files now and then.
 class Ttl_Cache {
 
-	/**
-	 * The cache name.
-	 *
-	 * @var string $name The cache name.
-	 * @access private
-	 * @since 3.21.2
-	 */
-	private $name;
-
-	/**
-	 * The TTL of cached responses in seconds.
-	 *
-	 * @var int $ttl The TTL in seconds.
-	 * @access private
-	 * @since 3.21.2
-	 */
-	private $ttl;
-
-	/**
-	 * The cache dir where the cached data is written.
-	 *
-	 * @since 3.21.2
-	 * @access private
-	 * @var string $cache_dir The cache dir where the cached responses are written.
-	 */
-	private $cache_dir;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 * @access private
-	 * @since 3.21.2
-	 */
-	private $log;
-
-	/**
-	 * @var array
-	 */
-	private static $caches = array();
-
-	/**
-	 * Create a {@link Ttl_Cache} with the specified TTL, default 900 secs.
-	 *
-	 * @param string $name The cache name.
-	 * @param int    $ttl The cache TTL, default 900 secs.
-	 *
-	 * @since 3.21.2
-	 */
-	public function __construct( $name, $ttl = 900 ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->name = $name;
-		$this->ttl  = $ttl;
-
-		$this->cache_dir = self::get_cache_folder() . DIRECTORY_SEPARATOR . md5( $name );
-
-		$this->log->trace( "Creating the cache folder {$this->cache_dir}..." );
-		wp_mkdir_p( $this->cache_dir );
-
-		self::$caches[ $name ] = $this;
-
-	}
-
-	/**
-	 * Get the root cache folder.
-	 *
-	 * This is useful to introduce a cache cleaning procedure which will scan and delete older stale cache files.
-	 *
-	 * @return string The root cache folder.
-	 * @since 3.22.5
-	 */
-	public static function get_cache_folder() {
-
-		// Get the temp dir and add the directory separator if missing.
-		$temp_dir = get_temp_dir();
-		if ( DIRECTORY_SEPARATOR !== substr( $temp_dir, - strlen( DIRECTORY_SEPARATOR ) ) ) {
-			$temp_dir .= DIRECTORY_SEPARATOR;
-		}
-
-		return $temp_dir . 'wl.cache' . DIRECTORY_SEPARATOR . md5( home_url() );
-	}
-
-	/**
-	 * Get the cached data for the specified key.
-	 *
-	 * @param mixed $key A serializable key.
-	 *
-	 * @return mixed|null
-	 * @since 3.21.2
-	 */
-	public function get( $key, $mintime = 0 ) {
-
-		$filename = $this->get_filename( $key );
-
-		// No cache.
-		if ( ! file_exists( $filename ) ) {
-			return null;
-		}
-
-		// The cache is not updated or the ttl expired. Delete.
-		$filemtime = filemtime( $filename );
-		if ( $filemtime < $mintime || $this->ttl < ( time() - $filemtime ) ) {
-			$this->delete( $key );
-
-			return null;
-		}
-
-		$this->log->trace( "Cache HIT.\n" );
-
-		// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
-		return json_decode( file_get_contents( $filename ), true );
-	}
-
-	public function put( $key, $data ) {
-
-		$filename = $this->get_filename( $key );
-
-		// Cache.
-		if ( file_exists( $filename ) ) {
-			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@unlink( $filename );
-		}
-
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged,WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
-		@file_put_contents( $filename, wp_json_encode( $data ) );
-
-	}
+    /**
+     * The cache name.
+     *
+     * @var string $name The cache name.
+     * @access private
+     * @since 3.21.2
+     */
+    private $name;
+
+    /**
+     * The TTL of cached responses in seconds.
+     *
+     * @var int $ttl The TTL in seconds.
+     * @access private
+     * @since 3.21.2
+     */
+    private $ttl;
+
+    /**
+     * The cache dir where the cached data is written.
+     *
+     * @since 3.21.2
+     * @access private
+     * @var string $cache_dir The cache dir where the cached responses are written.
+     */
+    private $cache_dir;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     * @access private
+     * @since 3.21.2
+     */
+    private $log;
+
+    /**
+     * @var array
+     */
+    private static $caches = array();
+
+    /**
+     * Create a {@link Ttl_Cache} with the specified TTL, default 900 secs.
+     *
+     * @param string $name The cache name.
+     * @param int    $ttl The cache TTL, default 900 secs.
+     *
+     * @since 3.21.2
+     */
+    public function __construct( $name, $ttl = 900 ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->name = $name;
+        $this->ttl  = $ttl;
+
+        $this->cache_dir = self::get_cache_folder() . DIRECTORY_SEPARATOR . md5( $name );
+
+        $this->log->trace( "Creating the cache folder {$this->cache_dir}..." );
+        wp_mkdir_p( $this->cache_dir );
+
+        self::$caches[ $name ] = $this;
+
+    }
+
+    /**
+     * Get the root cache folder.
+     *
+     * This is useful to introduce a cache cleaning procedure which will scan and delete older stale cache files.
+     *
+     * @return string The root cache folder.
+     * @since 3.22.5
+     */
+    public static function get_cache_folder() {
+
+        // Get the temp dir and add the directory separator if missing.
+        $temp_dir = get_temp_dir();
+        if ( DIRECTORY_SEPARATOR !== substr( $temp_dir, - strlen( DIRECTORY_SEPARATOR ) ) ) {
+            $temp_dir .= DIRECTORY_SEPARATOR;
+        }
+
+        return $temp_dir . 'wl.cache' . DIRECTORY_SEPARATOR . md5( home_url() );
+    }
+
+    /**
+     * Get the cached data for the specified key.
+     *
+     * @param mixed $key A serializable key.
+     *
+     * @return mixed|null
+     * @since 3.21.2
+     */
+    public function get( $key, $mintime = 0 ) {
+
+        $filename = $this->get_filename( $key );
+
+        // No cache.
+        if ( ! file_exists( $filename ) ) {
+            return null;
+        }
+
+        // The cache is not updated or the ttl expired. Delete.
+        $filemtime = filemtime( $filename );
+        if ( $filemtime < $mintime || $this->ttl < ( time() - $filemtime ) ) {
+            $this->delete( $key );
+
+            return null;
+        }
+
+        $this->log->trace( "Cache HIT.\n" );
+
+        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+        return json_decode( file_get_contents( $filename ), true );
+    }
+
+    public function put( $key, $data ) {
+
+        $filename = $this->get_filename( $key );
+
+        // Cache.
+        if ( file_exists( $filename ) ) {
+            // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+            @unlink( $filename );
+        }
+
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged,WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
+        @file_put_contents( $filename, wp_json_encode( $data ) );
+
+    }
 
-	public function delete( $key ) {
+    public function delete( $key ) {
 
-		$filename = $this->get_filename( $key );
+        $filename = $this->get_filename( $key );
 
-		// Delete.
-		if ( file_exists( $filename ) ) {
-			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@unlink( $filename );
-		}
+        // Delete.
+        if ( file_exists( $filename ) ) {
+            // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+            @unlink( $filename );
+        }
 
-	}
+    }
 
-	public function flush() {
+    public function flush() {
 
-		$files = glob( $this->cache_dir . DIRECTORY_SEPARATOR . '*' );
-		foreach ( $files as $file ) { // iterate files
-			if ( is_file( $file ) ) {
-				// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-				@unlink( $file );
-			}
-		}
+        $files = glob( $this->cache_dir . DIRECTORY_SEPARATOR . '*' );
+        foreach ( $files as $file ) { // iterate files
+            if ( is_file( $file ) ) {
+                // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+                @unlink( $file );
+            }
+        }
 
-	}
+    }
 
-	public static function flush_all() {
+    public static function flush_all() {
 
-		/** @var Ttl_Cache $cache */
-		foreach ( self::$caches as $cache ) {
-			$cache->flush();
-		}
+        /** @var Ttl_Cache $cache */
+        foreach ( self::$caches as $cache ) {
+            $cache->flush();
+        }
 
-	}
+    }
 
-	/**
-	 * Get the full path for the given `$hash`. The file is not checked for its existence.
-	 *
-	 * @param string $hash A file hash.
-	 *
-	 * @return string The full path to the file.
-	 * @since 3.21.2
-	 */
-	private function get_path( $hash ) {
+    /**
+     * Get the full path for the given `$hash`. The file is not checked for its existence.
+     *
+     * @param string $hash A file hash.
+     *
+     * @return string The full path to the file.
+     * @since 3.21.2
+     */
+    private function get_path( $hash ) {
 
-		return $this->cache_dir . DIRECTORY_SEPARATOR . $hash;
-	}
+        return $this->cache_dir . DIRECTORY_SEPARATOR . $hash;
+    }
 
-	private function get_filename( $key ) {
+    private function get_filename( $key ) {
 
-		// Create a hash and a path to the cache file.
-		$hash     = md5( wp_json_encode( $key ) );
-		$filename = $this->get_path( $hash );
+        // Create a hash and a path to the cache file.
+        $hash     = md5( wp_json_encode( $key ) );
+        $filename = $this->get_path( $hash );
 
-		return $filename;
-	}
+        return $filename;
+    }
 
 }

src/includes/class-wordlift-abstract-post-to-jsonld-converter.php

Indentation +402 added lines, -402 removed lines

@@ -23,428 +23,428 @@
  */
 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_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;
-
-	/**
-	 * @var Wordlift_Property_Getter
-	 */
-	private $property_getter;
-
-	/**
-	 * Wordlift_Post_To_Jsonld_Converter constructor.
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_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.
-	 * @param \Wordlift_Property_Getter     $property_getter
-	 *
-	 * @since 3.10.0
-	 */
-	public function __construct( $entity_type_service, $user_service, $attachment_service, $property_getter ) {
-		$this->entity_type_service = $entity_type_service;
-		$this->user_service        = $user_service;
-		$this->attachment_service  = $attachment_service;
-		$this->property_getter     = $property_getter;
-	}
-
-	/**
-	 * 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.
-	 * @param array $references_infos
-	 *
-	 * @return array A JSON-LD array.
-	 * @since 3.10.0
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
-
-		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
-			// Post not found.
-			return null;
-		}
-
-		// Get the post URI @id.
-		$id = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
-		if ( $id === null ) {
-			$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_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;
+
+    /**
+     * @var Wordlift_Property_Getter
+     */
+    private $property_getter;
+
+    /**
+     * Wordlift_Post_To_Jsonld_Converter constructor.
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_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.
+     * @param \Wordlift_Property_Getter     $property_getter
+     *
+     * @since 3.10.0
+     */
+    public function __construct( $entity_type_service, $user_service, $attachment_service, $property_getter ) {
+        $this->entity_type_service = $entity_type_service;
+        $this->user_service        = $user_service;
+        $this->attachment_service  = $attachment_service;
+        $this->property_getter     = $property_getter;
+    }
+
+    /**
+     * 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.
+     * @param array $references_infos
+     *
+     * @return array A JSON-LD array.
+     * @since 3.10.0
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
+
+        // Get the post instance.
+        $post = get_post( $post_id );
+        if ( null === $post ) {
+            // Post not found.
+            return null;
+        }
+
+        // Get the post URI @id.
+        $id = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
+        if ( $id === null ) {
+            $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 );
-		$type  = self::make_one( $types );
-
-		// Prepare the response.
-		$jsonld = array(
-			'@context' => self::CONTEXT,
-			'@id'      => $id,
-			'@type'    => $type,
-		);
-
-		if ( post_type_supports( $post->post_type, 'excerpt' ) ) {
-			$jsonld['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 );
+        $type  = self::make_one( $types );
+
+        // Prepare the response.
+        $jsonld = array(
+            '@context' => self::CONTEXT,
+            '@id'      => $id,
+            '@type'    => $type,
+        );
+
+        if ( post_type_supports( $post->post_type, 'excerpt' ) ) {
+            $jsonld['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 ) || in_array( 'Product', (array) $type, true ) ) {
-			// 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 );
-
-			/**
-			 * @see https://github.com/insideout10/wordlift-plugin/issues/1207
-			 *
-			 * @since 3.27.7
-			 */
-			if ( in_array(
-				$type,
-				array(
-					'Occupation',
-					'OccupationAggregationByEmployer',
-				),
-				true
-			) ) {
-				$jsonld['mainEntityOfPage'] = array(
-					'@type'        => 'WebPage',
-					'lastReviewed' => get_post_time( 'Y-m-d\TH:i:sP', true, $post, false ),
-				);
-			}
-		};
-
-		$this->set_images( $this->attachment_service, $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 = Object_Relation_Service::get_instance()
-															   ->get_references( $post_id, Object_Type_Enum::POST );
-
-		/*
+        $post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
+        if ( ! empty( $post_content ) || in_array( 'Product', (array) $type, true ) ) {
+            // 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 );
+
+            /**
+             * @see https://github.com/insideout10/wordlift-plugin/issues/1207
+             *
+             * @since 3.27.7
+             */
+            if ( in_array(
+                $type,
+                array(
+                    'Occupation',
+                    'OccupationAggregationByEmployer',
+                ),
+                true
+            ) ) {
+                $jsonld['mainEntityOfPage'] = array(
+                    '@type'        => 'WebPage',
+                    'lastReviewed' => get_post_time( 'Y-m-d\TH:i:sP', true, $post, false ),
+                );
+            }
+        };
+
+        $this->set_images( $this->attachment_service, $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 = Object_Relation_Service::get_instance()
+                                                                ->get_references( $post_id, Object_Type_Enum::POST );
+
+        /*
 		 * 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, $reference ) use ( $entity_type_service ) {
-				/**
-				 * @var $reference Reference
-				 */
-				// @see https://schema.org/location for the schema.org types using the `location` property.
-				if ( ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Action' )
-					 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Event' )
-					 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Organization' ) ) {
-
-					return $carry;
-				}
-				$post_location_ids        = get_post_meta( $reference->get_id(), Wordlift_Schema_Service::FIELD_LOCATION );
-				$post_location_references = array_map(
-					function ( $post_id ) {
-						return new Post_Reference( $post_id );
-					},
-					$post_location_ids
-				);
-
-				return array_merge( $carry, $post_location_references );
-			},
-			array()
-		);
-
-		// Merge the references with the referenced locations if any.
-		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$references = 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 ! is_array( $value ) && 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 $attachment_service Wordlift_Attachment_Service
-	 * @param WP_Post                                        $post The target {@link WP_Post}.
-	 * @param array                                          $jsonld The JSON-LD array.
-	 *
-	 * @since 3.10.0
-	 */
-	public static function set_images( $attachment_service, $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 && 0 !== $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.
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( apply_filters( 'wl_feature__enable__image-embeds', false ) ) {
-			$embeds = array_diff( $attachment_service->get_image_embeds( $post->post_content ), $ids );
-		} else {
-			$embeds = array();
-		}
-
-		// Get the gallery, removing existing ids.
-		$gallery = array_diff( $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, $reference ) use ( $entity_type_service ) {
+                /**
+                 * @var $reference Reference
+                 */
+                // @see https://schema.org/location for the schema.org types using the `location` property.
+                if ( ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Action' )
+                     && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Event' )
+                     && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Organization' ) ) {
+
+                    return $carry;
+                }
+                $post_location_ids        = get_post_meta( $reference->get_id(), Wordlift_Schema_Service::FIELD_LOCATION );
+                $post_location_references = array_map(
+                    function ( $post_id ) {
+                        return new Post_Reference( $post_id );
+                    },
+                    $post_location_ids
+                );
+
+                return array_merge( $carry, $post_location_references );
+            },
+            array()
+        );
+
+        // Merge the references with the referenced locations if any.
+        // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+        $references = 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 ! is_array( $value ) && 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 $attachment_service Wordlift_Attachment_Service
+     * @param WP_Post                                        $post The target {@link WP_Post}.
+     * @param array                                          $jsonld The JSON-LD array.
+     *
+     * @since 3.10.0
+     */
+    public static function set_images( $attachment_service, $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 && 0 !== $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.
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( apply_filters( 'wl_feature__enable__image-embeds', false ) ) {
+            $embeds = array_diff( $attachment_service->get_image_embeds( $post->post_content ), $ids );
+        } else {
+            $embeds = array();
+        }
+
+        // Get the gallery, removing existing ids.
+        $gallery = array_diff( $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;
-	}
-
-	/**
-	 * Add data to the JSON-LD using the `custom_fields` array which contains the definitions of property
-	 * for the post entity type.
-	 *
-	 * @param array   $jsonld The JSON-LD array.
-	 * @param array   $fields The entity types field array.
-	 * @param WP_Post $post The target {@link WP_Post} instance.
-	 * @param array   $references The references array.
-	 *
-	 * @since 3.20.0 This code moved from the above function `convert`, used for entity types defined in
-	 *  the {@link Wordlift_Schema_Service} class.
-	 */
-	protected function process_type_custom_fields( &$jsonld, $fields, $post, &$references, &$references_infos ) {
-
-		// Set a reference to use in closures.
-		$converter = $this;
-
-		// Try each field on the entity.
-		foreach ( $fields as $key => $value ) {
-
-			// Get the predicate.
-			$name = $this->relative_to_context( $value['predicate'] );
-
-			// Get the value, the property service will get the right extractor
-			// for that property.
-			$value = $this->property_getter->get( $post->ID, $key, Object_Type_Enum::POST );
-
-			if ( empty( $value ) ) {
-				continue;
-			}
-
-			// Map the value to the property name.
-			// If we got an array with just one value, we return that one value.
-			// If we got a Wordlift_Property_Entity_Reference we get the URL.
-			$jsonld[ $name ] = self::make_one(
-				array_map(
-					function ( $item ) use ( $converter, &$references, &$references_infos ) {
-
-						if ( $item instanceof Wordlift_Property_Entity_Reference ) {
-
-							$url = $item->get_url();
-
-							// The refactored converters require the entity id.
-							// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-							$references[] = $item->to_reference();
-
-							// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-							$references_infos[] = array( 'reference' => $item );
-
-							return array( '@id' => $url );
-						}
-
-						return $converter->relative_to_context( $item );
-					},
-					$value
-				)
-			);
-
-		}
-
-	}
+                    $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;
+    }
+
+    /**
+     * Add data to the JSON-LD using the `custom_fields` array which contains the definitions of property
+     * for the post entity type.
+     *
+     * @param array   $jsonld The JSON-LD array.
+     * @param array   $fields The entity types field array.
+     * @param WP_Post $post The target {@link WP_Post} instance.
+     * @param array   $references The references array.
+     *
+     * @since 3.20.0 This code moved from the above function `convert`, used for entity types defined in
+     *  the {@link Wordlift_Schema_Service} class.
+     */
+    protected function process_type_custom_fields( &$jsonld, $fields, $post, &$references, &$references_infos ) {
+
+        // Set a reference to use in closures.
+        $converter = $this;
+
+        // Try each field on the entity.
+        foreach ( $fields as $key => $value ) {
+
+            // Get the predicate.
+            $name = $this->relative_to_context( $value['predicate'] );
+
+            // Get the value, the property service will get the right extractor
+            // for that property.
+            $value = $this->property_getter->get( $post->ID, $key, Object_Type_Enum::POST );
+
+            if ( empty( $value ) ) {
+                continue;
+            }
+
+            // Map the value to the property name.
+            // If we got an array with just one value, we return that one value.
+            // If we got a Wordlift_Property_Entity_Reference we get the URL.
+            $jsonld[ $name ] = self::make_one(
+                array_map(
+                    function ( $item ) use ( $converter, &$references, &$references_infos ) {
+
+                        if ( $item instanceof Wordlift_Property_Entity_Reference ) {
+
+                            $url = $item->get_url();
+
+                            // The refactored converters require the entity id.
+                            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                            $references[] = $item->to_reference();
+
+                            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                            $references_infos[] = array( 'reference' => $item );
+
+                            return array( '@id' => $url );
+                        }
+
+                        return $converter->relative_to_context( $item );
+                    },
+                    $value
+                )
+            );
+
+        }
+
+    }
 
 }

Spacing +61 added lines, -61 removed lines

@@ -72,7 +72,7 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	public function __construct( $entity_type_service, $user_service, $attachment_service, $property_getter ) {
+	public function __construct($entity_type_service, $user_service, $attachment_service, $property_getter) {
 		$this->entity_type_service = $entity_type_service;
 		$this->user_service        = $user_service;
 		$this->attachment_service  = $attachment_service;
@@ -91,19 +91,19 @@ 
 	 * @since 3.10.0
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
+	public function convert($post_id, &$references = array(), &$references_infos = 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 = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
-		if ( $id === null ) {
-			$id = 'get_uri returned null, dataset is ' . wl_configuration_get_redlink_dataset_uri();
+		$id = Wordlift_Entity_Service::get_instance()->get_uri($post->ID);
+		if ($id === null) {
+			$id = 'get_uri returned null, dataset is '.wl_configuration_get_redlink_dataset_uri();
 		}
 
 		/*
@@ -115,8 +115,8 @@ 
 		 */
 		// 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 );
-		$type  = self::make_one( $types );
+		$types = $this->entity_type_service->get_names($post_id);
+		$type  = self::make_one($types);
 
 		// Prepare the response.
 		$jsonld = array(
@@ -125,8 +125,8 @@ 
 			'@type'    => $type,
 		);
 
-		if ( post_type_supports( $post->post_type, 'excerpt' ) ) {
-			$jsonld['description'] = Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post );
+		if (post_type_supports($post->post_type, 'excerpt')) {
+			$jsonld['description'] = Wordlift_Post_Excerpt_Helper::get_text_excerpt($post);
 		}
 
 		// Set the `mainEntityOfPage` property if the post has some contents.
@@ -136,8 +136,8 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		if ( ! empty( $post_content ) || in_array( 'Product', (array) $type, true ) ) {
+		$post_content = apply_filters('wl_post_content', $post->post_content, $post);
+		if ( ! empty($post_content) || in_array('Product', (array) $type, true)) {
 			// 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
@@ -148,35 +148,35 @@ 
 			// 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);
 
 			/**
 			 * @see https://github.com/insideout10/wordlift-plugin/issues/1207
 			 *
 			 * @since 3.27.7
 			 */
-			if ( in_array(
+			if (in_array(
 				$type,
 				array(
 					'Occupation',
 					'OccupationAggregationByEmployer',
 				),
 				true
-			) ) {
+			)) {
 				$jsonld['mainEntityOfPage'] = array(
 					'@type'        => 'WebPage',
-					'lastReviewed' => get_post_time( 'Y-m-d\TH:i:sP', true, $post, false ),
+					'lastReviewed' => get_post_time('Y-m-d\TH:i:sP', true, $post, false),
 				);
 			}
 		};
 
-		$this->set_images( $this->attachment_service, $post, $jsonld );
+		$this->set_images($this->attachment_service, $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 = Object_Relation_Service::get_instance()
-															   ->get_references( $post_id, Object_Type_Enum::POST );
+															   ->get_references($post_id, Object_Type_Enum::POST);
 
 		/*
 		 * Add the locations to the references.
@@ -189,33 +189,33 @@ 
 		$entity_type_service = $this->entity_type_service;
 		$locations           = array_reduce(
 			$references_without_locations,
-			function ( $carry, $reference ) use ( $entity_type_service ) {
+			function($carry, $reference) use ($entity_type_service) {
 				/**
 				 * @var $reference Reference
 				 */
 				// @see https://schema.org/location for the schema.org types using the `location` property.
-				if ( ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Action' )
-					 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Event' )
-					 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Organization' ) ) {
+				if ( ! $entity_type_service->has_entity_type($reference->get_id(), 'http://schema.org/Action')
+					 && ! $entity_type_service->has_entity_type($reference->get_id(), 'http://schema.org/Event')
+					 && ! $entity_type_service->has_entity_type($reference->get_id(), 'http://schema.org/Organization')) {
 
 					return $carry;
 				}
-				$post_location_ids        = get_post_meta( $reference->get_id(), Wordlift_Schema_Service::FIELD_LOCATION );
+				$post_location_ids        = get_post_meta($reference->get_id(), Wordlift_Schema_Service::FIELD_LOCATION);
 				$post_location_references = array_map(
-					function ( $post_id ) {
-						return new Post_Reference( $post_id );
+					function($post_id) {
+						return new Post_Reference($post_id);
 					},
 					$post_location_ids
 				);
 
-				return array_merge( $carry, $post_location_references );
+				return array_merge($carry, $post_location_references);
 			},
 			array()
 		);
 
 		// Merge the references with the referenced locations if any.
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$references = array_merge( $references_without_locations, $locations );
+		$references = array_merge($references_without_locations, $locations);
 
 		return $jsonld;
 	}
@@ -229,8 +229,8 @@ 
 	 * @return string The property value without the context.
 	 * @since 3.10.0
 	 */
-	public function relative_to_context( $value ) {
-		return ! is_array( $value ) && 0 === strpos( $value, self::CONTEXT . '/' ) ? substr( $value, strlen( self::CONTEXT ) + 1 ) : $value;
+	public function relative_to_context($value) {
+		return ! is_array($value) && 0 === strpos($value, self::CONTEXT.'/') ? substr($value, strlen(self::CONTEXT) + 1) : $value;
 	}
 
 	/**
@@ -245,14 +245,14 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	public static function set_images( $attachment_service, $post, &$jsonld ) {
+	public static function set_images($attachment_service, $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 && 0 !== $thumbnail_id ) {
+		$thumbnail_id = get_post_thumbnail_id($post->ID);
+		if ('' !== $thumbnail_id && 0 !== $thumbnail_id) {
 			$ids[] = $thumbnail_id;
 		}
 
@@ -263,34 +263,34 @@ 
 		//
 		// Get the embeds, removing existing ids.
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( apply_filters( 'wl_feature__enable__image-embeds', false ) ) {
-			$embeds = array_diff( $attachment_service->get_image_embeds( $post->post_content ), $ids );
+		if (apply_filters('wl_feature__enable__image-embeds', false)) {
+			$embeds = array_diff($attachment_service->get_image_embeds($post->post_content), $ids);
 		} else {
 			$embeds = array();
 		}
 
 		// Get the gallery, removing existing ids.
-		$gallery = array_diff( $attachment_service->get_gallery( $post ), $ids, $embeds );
+		$gallery = array_diff($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_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] );
+						function($source) {
+							return ! empty($source[0]);
 						}
 					);
 
@@ -304,7 +304,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;
 					}
 
@@ -322,7 +322,7 @@ 
 
 		// Refactor data as per schema.org specifications.
 		$images = array_map(
-			function ( $attachment ) {
+			function($attachment) {
 				return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
 					array(
 						'@type' => 'ImageObject',
@@ -335,7 +335,7 @@ 
 		);
 
 		// Add images if present.
-		if ( 0 < count( $images ) ) {
+		if (0 < count($images)) {
 			$jsonld['image'] = $images;
 		}
 
@@ -353,9 +353,9 @@ 
 	 * @since  3.8.0
 	 * @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;
 	}
 
 	/**
@@ -368,17 +368,17 @@ 
 	 * @return array The enriched `ImageObject` array.
 	 * @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];
 		}
 
@@ -397,33 +397,33 @@ 
 	 * @since 3.20.0 This code moved from the above function `convert`, used for entity types defined in
 	 *  the {@link Wordlift_Schema_Service} class.
 	 */
-	protected function process_type_custom_fields( &$jsonld, $fields, $post, &$references, &$references_infos ) {
+	protected function process_type_custom_fields(&$jsonld, $fields, $post, &$references, &$references_infos) {
 
 		// Set a reference to use in closures.
 		$converter = $this;
 
 		// Try each field on the entity.
-		foreach ( $fields as $key => $value ) {
+		foreach ($fields as $key => $value) {
 
 			// Get the predicate.
-			$name = $this->relative_to_context( $value['predicate'] );
+			$name = $this->relative_to_context($value['predicate']);
 
 			// Get the value, the property service will get the right extractor
 			// for that property.
-			$value = $this->property_getter->get( $post->ID, $key, Object_Type_Enum::POST );
+			$value = $this->property_getter->get($post->ID, $key, Object_Type_Enum::POST);
 
-			if ( empty( $value ) ) {
+			if (empty($value)) {
 				continue;
 			}
 
 			// Map the value to the property name.
 			// If we got an array with just one value, we return that one value.
 			// If we got a Wordlift_Property_Entity_Reference we get the URL.
-			$jsonld[ $name ] = self::make_one(
+			$jsonld[$name] = self::make_one(
 				array_map(
-					function ( $item ) use ( $converter, &$references, &$references_infos ) {
+					function($item) use ($converter, &$references, &$references_infos) {
 
-						if ( $item instanceof Wordlift_Property_Entity_Reference ) {
+						if ($item instanceof Wordlift_Property_Entity_Reference) {
 
 							$url = $item->get_url();
 
@@ -432,12 +432,12 @@ 
 							$references[] = $item->to_reference();
 
 							// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-							$references_infos[] = array( 'reference' => $item );
+							$references_infos[] = array('reference' => $item);
 
-							return array( '@id' => $url );
+							return array('@id' => $url);
 						}
 
-						return $converter->relative_to_context( $item );
+						return $converter->relative_to_context($item);
 					},
 					$value
 				)

src/includes/cache/class-wordlift-cached-post-converter.php

Indentation +350 added lines, -350 removed lines

@@ -21,355 +21,355 @@
  */
 class Wordlift_Cached_Post_Converter implements Wordlift_Post_Converter {
 
-	/**
-	 * A {@link Wordlift_Post_Converter} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var \Wordlift_Post_Converter $converter A {@link Wordlift_Post_Converter} instance.
-	 */
-	private $converter;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var Wordlift_Log_Service \$log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * A list of meta keys that do not cause the cache to update.
-	 *
-	 * @since 3.17.3
-	 * @var array An array of ignored meta keys.
-	 */
-	private static $ignored_meta_keys = array(
-		'_edit_lock',
-		'_edit_last',
-		'_wp_page_template',
-		'_wp_attachment_is_custom_background',
-		'_wp_attachment_backup_sizes',
-		'_wp_attachment_is_custom_header',
-	);
-	/**
-	 * @var Ttl_Cache
-	 */
-	private $cache;
-	/**
-	 * @var Reference_Processor
-	 */
-	private $reference_processor;
-
-	/**
-	 * Wordlift_Cached_Post_Converter constructor.
-	 *
-	 * @param \Wordlift_Post_Converter $converter The {@link Wordlift_Post_Converter} implementation.
-	 * @param Ttl_Cache                $cache The {@link Ttl_Cache} cache instance.
-	 */
-	public function __construct( $converter, $cache ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->cache               = $cache;
-		$this->converter           = $converter;
-		$this->reference_processor = Reference_Processor::get_instance();
-		$this->init_hooks();
-
-	}
-
-	/**
-	 * Hooks to catch post/post meta changes in order to invalidate the cache.
-	 *
-	 * @since 3.16.0
-	 */
-	private function init_hooks() {
-
-		// Hook on post save to flush relevant cache.
-		add_action( 'save_post', array( $this, 'save_post' ) );
-
-		add_action(
-			'added_post_meta',
-			array(
-				$this,
-				'changed_post_meta',
-			),
-			10,
-			3
-		);
-		add_action(
-			'updated_post_meta',
-			array(
-				$this,
-				'changed_post_meta',
-			),
-			10,
-			3
-		);
-		add_action(
-			'deleted_post_meta',
-			array(
-				$this,
-				'changed_post_meta',
-			),
-			10,
-			3
-		);
-
-		// Flush cache when wordlift settings were updated.
-		add_action(
-			'update_option_wl_general_settings',
-			array(
-				$this,
-				'update_option_wl_general_settings',
-			)
-		);
-
-		// Flushes the cache when permalink structure is changed.
-		add_action(
-			'update_option_permalink_structure',
-			array(
-				$this,
-				'permalinks_structure_changed',
-			)
-		);
-
-		// Invalid cache on relationship change.
-		add_action( 'wl_relation_added', array( $this, 'relation_changed' ) );
-		add_action( 'wl_relation_deleted', array( $this, 'relation_changed' ) );
-
-	}
-
-	/**
-	 * Note that the `&$cache` parameter here is used only to report whether the response comes from the cache. It
-	 * used by `test-issue-626.php` and nowhere else in code.
-	 *
-	 * @inheritdoc
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function convert( $post_id, &$references = array(), &$references_infos = array(), &$cache = false ) {
-
-		// Ensure post ID is `int`. Otherwise we may have issues with caching, since caching is strict about
-		// key var types.
-		$post_id = (int) $post_id;
-
-		$this->log->trace( "Converting post $post_id..." );
-
-		// Try to get a cached result.
-		$contents = $this->get_cache( $post_id, $references );
-
-		// Return the cached contents if any.
-		if ( false !== $contents ) {
-			$this->log->debug( "Cached contents found for post $post_id." );
-
-			// Inform the caller that this is cached result.
-			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			$cache = true;
-			$this->add_http_header( $post_id, true );
-
-			// Return the contents.
-			return $contents;
-		}
-
-		// Set cached to false.
-		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$cache = false;
-		$this->add_http_header( $post_id, false );
-
-		// Convert the post.
-		$jsonld = $this->converter->convert( $post_id, $references, $references_infos );
-
-		/**
-		 * @since 3.32.0
-		 * We cant apply json_encode on the objects {@link \Wordlift\Jsonld\Reference}, so we decode
-		 * it here before saving it on cache.
-		 */
-		// Cache the results.
-		$this->set_cache( $post_id, $references, $jsonld );
-
-		// Finally return the JSON-LD.
-		return $jsonld;
-	}
-
-	/**
-	 * Try to get the cached contents.
-	 *
-	 * @param int $post_id The {@link WP_Post} id.
-	 * @param array $references The referenced posts.
-	 *
-	 * @return mixed|bool The cached contents or false if the cached isn't found.
-	 * @since 3.16.0
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	private function get_cache( $post_id, &$references = array() ) {
-
-		// Ensure post ID is int, because cache is strict about var types.
-		$post_id = (int) $post_id;
-
-		$this->log->trace( "Getting cached contents for post $post_id..." );
-
-		// Get the cache.
-		$modified_date_time = get_post_datetime( $post_id, 'modified', 'gmt' );
-		$contents           = $this->cache->get( $post_id, $modified_date_time->getTimestamp() );
-
-		// Bail out if we don't have cached contents or the cached contents are
-		// invalid.
-		if ( null === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) ) {
-			$this->log->debug( "Cached contents for post $post_id not found." );
-
-			return false;
-		}
-
-		// Remap the cache.
-		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$references = $this->reference_processor->deserialize_references( $contents['references'] );
-
-		return $contents['jsonld'];
-	}
-
-	/**
-	 * Set the cache with the provided results.
-	 *
-	 * The function will prepare the provided results and will ask the {@link Ttl_Cache} to cache them.
-	 *
-	 * @param int   $post_id The {@link WP_Post} id.
-	 * @param array $references An array of references.
-	 * @param array $jsonld A JSON-LD structure.
-	 *
-	 * @since 3.16.0
-	 */
-	private function set_cache( $post_id, $references, $jsonld ) {
-
-		$this->log->trace( "Caching result for post $post_id..." );
-
-		$this->cache->put(
-			$post_id,
-			array(
-				'references' => $this->reference_processor->serialize_references( $references ),
-				'jsonld'     => $jsonld,
-			)
-		);
-
-	}
-
-	/**
-	 * Hook to 'save_post', will invalidate the cache for that post.
-	 *
-	 * @param int $post_id The {@link WP_Post} id.
-	 *
-	 * @since 3.16.0
-	 */
-	public function save_post( $post_id ) {
-
-		$this->log->trace( "Post $post_id saved, invalidating cache..." );
-
-		$this->cache->delete( $post_id );
-
-		$this->flush_cache_if_publisher( $post_id );
-
-	}
-
-	/**
-	 * Hook to meta changed for a {@link WP_Post}, will cause the cause to
-	 * invalidate.
-	 *
-	 * @param int    $id The {@link WP_Post} meta id.
-	 * @param int    $post_id The {@link WP_Post} id.
-	 * @param string $meta_key The meta key.
-	 *
-	 * @since 3.16.0
-	 */
-	public function changed_post_meta( $id, $post_id, $meta_key ) {
-
-		if ( in_array( $meta_key, self::$ignored_meta_keys, true ) ) {
-			$this->log->trace( "Post $post_id meta $meta_key ignored." );
-
-			return;
-		}
-
-		$this->log->trace( "Post $post_id meta $meta_key changed, invalidating cache..." );
-
-		// Delete the single cache file.
-		$this->cache->delete( $post_id );
-
-		// Flush the cache if it's the publisher.
-		$this->flush_cache_if_publisher( $post_id );
-
-	}
-
-	/**
-	 * Hook to WordLift's options changes, will flush the cache.
-	 *
-	 * @since 3.16.0
-	 */
-	public function update_option_wl_general_settings() {
-		$this->log->trace( 'WordLift options changed, flushing cache...' );
-
-		$this->cache->flush();
-	}
-
-	/**
-	 * Hook when permalinks are changed, will flush the cache.
-	 *
-	 * @since 3.17.0
-	 */
-	public function permalinks_structure_changed() {
-		$this->log->trace( 'Permalinks structure changed, flushing cache...' );
-
-		$this->cache->flush();
-	}
-
-	/**
-	 * Hook to WordLift's post/entity relation changes, will invalidate the cache.
-	 *
-	 * @param int $post_id The {@link WP_Post} id.
-	 *
-	 * @since 3.16.0
-	 */
-	public function relation_changed( $post_id ) {
-		$this->log->trace( "Post $post_id relations changed, invalidating cache..." );
-
-		$this->cache->delete( $post_id );
-	}
-
-	/**
-	 * When in Ajax, prints an http header with the information whether the
-	 * response is cached or not.
-	 *
-	 * @param int  $post_id The {@link WP_Post} id.
-	 * @param bool $cache Whether the response fragment is cached.
-	 *
-	 * @since 3.16.0
-	 */
-	private function add_http_header( $post_id, $cache ) {
-
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || headers_sent() ) {
-			return;
-		}
-
-		header( "X-WordLift-JsonLd-Cache-$post_id: " . ( $cache ? 'HIT' : 'MISS' ) );
-
-	}
-
-	/**
-	 * Call the `flush` operation on the {@link Ttl_Cache} if
-	 * the publisher has changed.
-	 *
-	 * @param int $post_id The changed {@link WP_Post}'s id.
-	 *
-	 * @since 3.16.0
-	 */
-	private function flush_cache_if_publisher( $post_id ) {
-
-		// Bail out if it's not the publisher.
-		if ( Wordlift_Configuration_Service::get_instance()->get_publisher_id() !== $post_id ) {
-			return;
-		}
-
-		// Flush the cache, since the publisher has changed.
-		$this->cache->flush();
-
-	}
+    /**
+     * A {@link Wordlift_Post_Converter} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var \Wordlift_Post_Converter $converter A {@link Wordlift_Post_Converter} instance.
+     */
+    private $converter;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var Wordlift_Log_Service \$log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * A list of meta keys that do not cause the cache to update.
+     *
+     * @since 3.17.3
+     * @var array An array of ignored meta keys.
+     */
+    private static $ignored_meta_keys = array(
+        '_edit_lock',
+        '_edit_last',
+        '_wp_page_template',
+        '_wp_attachment_is_custom_background',
+        '_wp_attachment_backup_sizes',
+        '_wp_attachment_is_custom_header',
+    );
+    /**
+     * @var Ttl_Cache
+     */
+    private $cache;
+    /**
+     * @var Reference_Processor
+     */
+    private $reference_processor;
+
+    /**
+     * Wordlift_Cached_Post_Converter constructor.
+     *
+     * @param \Wordlift_Post_Converter $converter The {@link Wordlift_Post_Converter} implementation.
+     * @param Ttl_Cache                $cache The {@link Ttl_Cache} cache instance.
+     */
+    public function __construct( $converter, $cache ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->cache               = $cache;
+        $this->converter           = $converter;
+        $this->reference_processor = Reference_Processor::get_instance();
+        $this->init_hooks();
+
+    }
+
+    /**
+     * Hooks to catch post/post meta changes in order to invalidate the cache.
+     *
+     * @since 3.16.0
+     */
+    private function init_hooks() {
+
+        // Hook on post save to flush relevant cache.
+        add_action( 'save_post', array( $this, 'save_post' ) );
+
+        add_action(
+            'added_post_meta',
+            array(
+                $this,
+                'changed_post_meta',
+            ),
+            10,
+            3
+        );
+        add_action(
+            'updated_post_meta',
+            array(
+                $this,
+                'changed_post_meta',
+            ),
+            10,
+            3
+        );
+        add_action(
+            'deleted_post_meta',
+            array(
+                $this,
+                'changed_post_meta',
+            ),
+            10,
+            3
+        );
+
+        // Flush cache when wordlift settings were updated.
+        add_action(
+            'update_option_wl_general_settings',
+            array(
+                $this,
+                'update_option_wl_general_settings',
+            )
+        );
+
+        // Flushes the cache when permalink structure is changed.
+        add_action(
+            'update_option_permalink_structure',
+            array(
+                $this,
+                'permalinks_structure_changed',
+            )
+        );
+
+        // Invalid cache on relationship change.
+        add_action( 'wl_relation_added', array( $this, 'relation_changed' ) );
+        add_action( 'wl_relation_deleted', array( $this, 'relation_changed' ) );
+
+    }
+
+    /**
+     * Note that the `&$cache` parameter here is used only to report whether the response comes from the cache. It
+     * used by `test-issue-626.php` and nowhere else in code.
+     *
+     * @inheritdoc
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function convert( $post_id, &$references = array(), &$references_infos = array(), &$cache = false ) {
+
+        // Ensure post ID is `int`. Otherwise we may have issues with caching, since caching is strict about
+        // key var types.
+        $post_id = (int) $post_id;
+
+        $this->log->trace( "Converting post $post_id..." );
+
+        // Try to get a cached result.
+        $contents = $this->get_cache( $post_id, $references );
+
+        // Return the cached contents if any.
+        if ( false !== $contents ) {
+            $this->log->debug( "Cached contents found for post $post_id." );
+
+            // Inform the caller that this is cached result.
+            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+            $cache = true;
+            $this->add_http_header( $post_id, true );
+
+            // Return the contents.
+            return $contents;
+        }
+
+        // Set cached to false.
+        // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+        $cache = false;
+        $this->add_http_header( $post_id, false );
+
+        // Convert the post.
+        $jsonld = $this->converter->convert( $post_id, $references, $references_infos );
+
+        /**
+         * @since 3.32.0
+         * We cant apply json_encode on the objects {@link \Wordlift\Jsonld\Reference}, so we decode
+         * it here before saving it on cache.
+         */
+        // Cache the results.
+        $this->set_cache( $post_id, $references, $jsonld );
+
+        // Finally return the JSON-LD.
+        return $jsonld;
+    }
+
+    /**
+     * Try to get the cached contents.
+     *
+     * @param int $post_id The {@link WP_Post} id.
+     * @param array $references The referenced posts.
+     *
+     * @return mixed|bool The cached contents or false if the cached isn't found.
+     * @since 3.16.0
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    private function get_cache( $post_id, &$references = array() ) {
+
+        // Ensure post ID is int, because cache is strict about var types.
+        $post_id = (int) $post_id;
+
+        $this->log->trace( "Getting cached contents for post $post_id..." );
+
+        // Get the cache.
+        $modified_date_time = get_post_datetime( $post_id, 'modified', 'gmt' );
+        $contents           = $this->cache->get( $post_id, $modified_date_time->getTimestamp() );
+
+        // Bail out if we don't have cached contents or the cached contents are
+        // invalid.
+        if ( null === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) ) {
+            $this->log->debug( "Cached contents for post $post_id not found." );
+
+            return false;
+        }
+
+        // Remap the cache.
+        // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+        $references = $this->reference_processor->deserialize_references( $contents['references'] );
+
+        return $contents['jsonld'];
+    }
+
+    /**
+     * Set the cache with the provided results.
+     *
+     * The function will prepare the provided results and will ask the {@link Ttl_Cache} to cache them.
+     *
+     * @param int   $post_id The {@link WP_Post} id.
+     * @param array $references An array of references.
+     * @param array $jsonld A JSON-LD structure.
+     *
+     * @since 3.16.0
+     */
+    private function set_cache( $post_id, $references, $jsonld ) {
+
+        $this->log->trace( "Caching result for post $post_id..." );
+
+        $this->cache->put(
+            $post_id,
+            array(
+                'references' => $this->reference_processor->serialize_references( $references ),
+                'jsonld'     => $jsonld,
+            )
+        );
+
+    }
+
+    /**
+     * Hook to 'save_post', will invalidate the cache for that post.
+     *
+     * @param int $post_id The {@link WP_Post} id.
+     *
+     * @since 3.16.0
+     */
+    public function save_post( $post_id ) {
+
+        $this->log->trace( "Post $post_id saved, invalidating cache..." );
+
+        $this->cache->delete( $post_id );
+
+        $this->flush_cache_if_publisher( $post_id );
+
+    }
+
+    /**
+     * Hook to meta changed for a {@link WP_Post}, will cause the cause to
+     * invalidate.
+     *
+     * @param int    $id The {@link WP_Post} meta id.
+     * @param int    $post_id The {@link WP_Post} id.
+     * @param string $meta_key The meta key.
+     *
+     * @since 3.16.0
+     */
+    public function changed_post_meta( $id, $post_id, $meta_key ) {
+
+        if ( in_array( $meta_key, self::$ignored_meta_keys, true ) ) {
+            $this->log->trace( "Post $post_id meta $meta_key ignored." );
+
+            return;
+        }
+
+        $this->log->trace( "Post $post_id meta $meta_key changed, invalidating cache..." );
+
+        // Delete the single cache file.
+        $this->cache->delete( $post_id );
+
+        // Flush the cache if it's the publisher.
+        $this->flush_cache_if_publisher( $post_id );
+
+    }
+
+    /**
+     * Hook to WordLift's options changes, will flush the cache.
+     *
+     * @since 3.16.0
+     */
+    public function update_option_wl_general_settings() {
+        $this->log->trace( 'WordLift options changed, flushing cache...' );
+
+        $this->cache->flush();
+    }
+
+    /**
+     * Hook when permalinks are changed, will flush the cache.
+     *
+     * @since 3.17.0
+     */
+    public function permalinks_structure_changed() {
+        $this->log->trace( 'Permalinks structure changed, flushing cache...' );
+
+        $this->cache->flush();
+    }
+
+    /**
+     * Hook to WordLift's post/entity relation changes, will invalidate the cache.
+     *
+     * @param int $post_id The {@link WP_Post} id.
+     *
+     * @since 3.16.0
+     */
+    public function relation_changed( $post_id ) {
+        $this->log->trace( "Post $post_id relations changed, invalidating cache..." );
+
+        $this->cache->delete( $post_id );
+    }
+
+    /**
+     * When in Ajax, prints an http header with the information whether the
+     * response is cached or not.
+     *
+     * @param int  $post_id The {@link WP_Post} id.
+     * @param bool $cache Whether the response fragment is cached.
+     *
+     * @since 3.16.0
+     */
+    private function add_http_header( $post_id, $cache ) {
+
+        if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || headers_sent() ) {
+            return;
+        }
+
+        header( "X-WordLift-JsonLd-Cache-$post_id: " . ( $cache ? 'HIT' : 'MISS' ) );
+
+    }
+
+    /**
+     * Call the `flush` operation on the {@link Ttl_Cache} if
+     * the publisher has changed.
+     *
+     * @param int $post_id The changed {@link WP_Post}'s id.
+     *
+     * @since 3.16.0
+     */
+    private function flush_cache_if_publisher( $post_id ) {
+
+        // Bail out if it's not the publisher.
+        if ( Wordlift_Configuration_Service::get_instance()->get_publisher_id() !== $post_id ) {
+            return;
+        }
+
+        // Flush the cache, since the publisher has changed.
+        $this->cache->flush();
+
+    }
 
 }

Spacing +44 added lines, -44 removed lines

@@ -68,9 +68,9 @@ 
 	 * @param \Wordlift_Post_Converter $converter The {@link Wordlift_Post_Converter} implementation.
 	 * @param Ttl_Cache                $cache The {@link Ttl_Cache} cache instance.
 	 */
-	public function __construct( $converter, $cache ) {
+	public function __construct($converter, $cache) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->cache               = $cache;
 		$this->converter           = $converter;
@@ -87,7 +87,7 @@ 
 	private function init_hooks() {
 
 		// Hook on post save to flush relevant cache.
-		add_action( 'save_post', array( $this, 'save_post' ) );
+		add_action('save_post', array($this, 'save_post'));
 
 		add_action(
 			'added_post_meta',
@@ -136,8 +136,8 @@ 
 		);
 
 		// Invalid cache on relationship change.
-		add_action( 'wl_relation_added', array( $this, 'relation_changed' ) );
-		add_action( 'wl_relation_deleted', array( $this, 'relation_changed' ) );
+		add_action('wl_relation_added', array($this, 'relation_changed'));
+		add_action('wl_relation_deleted', array($this, 'relation_changed'));
 
 	}
 
@@ -148,25 +148,25 @@ 
 	 * @inheritdoc
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function convert( $post_id, &$references = array(), &$references_infos = array(), &$cache = false ) {
+	public function convert($post_id, &$references = array(), &$references_infos = array(), &$cache = false) {
 
 		// Ensure post ID is `int`. Otherwise we may have issues with caching, since caching is strict about
 		// key var types.
 		$post_id = (int) $post_id;
 
-		$this->log->trace( "Converting post $post_id..." );
+		$this->log->trace("Converting post $post_id...");
 
 		// Try to get a cached result.
-		$contents = $this->get_cache( $post_id, $references );
+		$contents = $this->get_cache($post_id, $references);
 
 		// Return the cached contents if any.
-		if ( false !== $contents ) {
-			$this->log->debug( "Cached contents found for post $post_id." );
+		if (false !== $contents) {
+			$this->log->debug("Cached contents found for post $post_id.");
 
 			// Inform the caller that this is cached result.
 			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 			$cache = true;
-			$this->add_http_header( $post_id, true );
+			$this->add_http_header($post_id, true);
 
 			// Return the contents.
 			return $contents;
@@ -175,10 +175,10 @@ 
 		// Set cached to false.
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 		$cache = false;
-		$this->add_http_header( $post_id, false );
+		$this->add_http_header($post_id, false);
 
 		// Convert the post.
-		$jsonld = $this->converter->convert( $post_id, $references, $references_infos );
+		$jsonld = $this->converter->convert($post_id, $references, $references_infos);
 
 		/**
 		 * @since 3.32.0
@@ -186,7 +186,7 @@ 
 		 * it here before saving it on cache.
 		 */
 		// Cache the results.
-		$this->set_cache( $post_id, $references, $jsonld );
+		$this->set_cache($post_id, $references, $jsonld);
 
 		// Finally return the JSON-LD.
 		return $jsonld;
@@ -202,28 +202,28 @@ 
 	 * @since 3.16.0
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	private function get_cache( $post_id, &$references = array() ) {
+	private function get_cache($post_id, &$references = array()) {
 
 		// Ensure post ID is int, because cache is strict about var types.
 		$post_id = (int) $post_id;
 
-		$this->log->trace( "Getting cached contents for post $post_id..." );
+		$this->log->trace("Getting cached contents for post $post_id...");
 
 		// Get the cache.
-		$modified_date_time = get_post_datetime( $post_id, 'modified', 'gmt' );
-		$contents           = $this->cache->get( $post_id, $modified_date_time->getTimestamp() );
+		$modified_date_time = get_post_datetime($post_id, 'modified', 'gmt');
+		$contents           = $this->cache->get($post_id, $modified_date_time->getTimestamp());
 
 		// Bail out if we don't have cached contents or the cached contents are
 		// invalid.
-		if ( null === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) ) {
-			$this->log->debug( "Cached contents for post $post_id not found." );
+		if (null === $contents || ! isset($contents['jsonld']) || ! isset($contents['references'])) {
+			$this->log->debug("Cached contents for post $post_id not found.");
 
 			return false;
 		}
 
 		// Remap the cache.
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$references = $this->reference_processor->deserialize_references( $contents['references'] );
+		$references = $this->reference_processor->deserialize_references($contents['references']);
 
 		return $contents['jsonld'];
 	}
@@ -239,14 +239,14 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	private function set_cache( $post_id, $references, $jsonld ) {
+	private function set_cache($post_id, $references, $jsonld) {
 
-		$this->log->trace( "Caching result for post $post_id..." );
+		$this->log->trace("Caching result for post $post_id...");
 
 		$this->cache->put(
 			$post_id,
 			array(
-				'references' => $this->reference_processor->serialize_references( $references ),
+				'references' => $this->reference_processor->serialize_references($references),
 				'jsonld'     => $jsonld,
 			)
 		);
@@ -260,13 +260,13 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	public function save_post( $post_id ) {
+	public function save_post($post_id) {
 
-		$this->log->trace( "Post $post_id saved, invalidating cache..." );
+		$this->log->trace("Post $post_id saved, invalidating cache...");
 
-		$this->cache->delete( $post_id );
+		$this->cache->delete($post_id);
 
-		$this->flush_cache_if_publisher( $post_id );
+		$this->flush_cache_if_publisher($post_id);
 
 	}
 
@@ -280,21 +280,21 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	public function changed_post_meta( $id, $post_id, $meta_key ) {
+	public function changed_post_meta($id, $post_id, $meta_key) {
 
-		if ( in_array( $meta_key, self::$ignored_meta_keys, true ) ) {
-			$this->log->trace( "Post $post_id meta $meta_key ignored." );
+		if (in_array($meta_key, self::$ignored_meta_keys, true)) {
+			$this->log->trace("Post $post_id meta $meta_key ignored.");
 
 			return;
 		}
 
-		$this->log->trace( "Post $post_id meta $meta_key changed, invalidating cache..." );
+		$this->log->trace("Post $post_id meta $meta_key changed, invalidating cache...");
 
 		// Delete the single cache file.
-		$this->cache->delete( $post_id );
+		$this->cache->delete($post_id);
 
 		// Flush the cache if it's the publisher.
-		$this->flush_cache_if_publisher( $post_id );
+		$this->flush_cache_if_publisher($post_id);
 
 	}
 
@@ -304,7 +304,7 @@ 
 	 * @since 3.16.0
 	 */
 	public function update_option_wl_general_settings() {
-		$this->log->trace( 'WordLift options changed, flushing cache...' );
+		$this->log->trace('WordLift options changed, flushing cache...');
 
 		$this->cache->flush();
 	}
@@ -315,7 +315,7 @@ 
 	 * @since 3.17.0
 	 */
 	public function permalinks_structure_changed() {
-		$this->log->trace( 'Permalinks structure changed, flushing cache...' );
+		$this->log->trace('Permalinks structure changed, flushing cache...');
 
 		$this->cache->flush();
 	}
@@ -327,10 +327,10 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	public function relation_changed( $post_id ) {
-		$this->log->trace( "Post $post_id relations changed, invalidating cache..." );
+	public function relation_changed($post_id) {
+		$this->log->trace("Post $post_id relations changed, invalidating cache...");
 
-		$this->cache->delete( $post_id );
+		$this->cache->delete($post_id);
 	}
 
 	/**
@@ -342,13 +342,13 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	private function add_http_header( $post_id, $cache ) {
+	private function add_http_header($post_id, $cache) {
 
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || headers_sent() ) {
+		if ( ! defined('DOING_AJAX') || ! DOING_AJAX || headers_sent()) {
 			return;
 		}
 
-		header( "X-WordLift-JsonLd-Cache-$post_id: " . ( $cache ? 'HIT' : 'MISS' ) );
+		header("X-WordLift-JsonLd-Cache-$post_id: ".($cache ? 'HIT' : 'MISS'));
 
 	}
 
@@ -360,10 +360,10 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	private function flush_cache_if_publisher( $post_id ) {
+	private function flush_cache_if_publisher($post_id) {
 
 		// Bail out if it's not the publisher.
-		if ( Wordlift_Configuration_Service::get_instance()->get_publisher_id() !== $post_id ) {
+		if (Wordlift_Configuration_Service::get_instance()->get_publisher_id() !== $post_id) {
 			return;
 		}