insideout10 / wordlift-plugin

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

Indentation +360 added lines, -360 removed lines

@@ -21,365 +21,365 @@
  */
 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;
-
-	/**
-	 * 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->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(), $relations = null, &$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.
-		$arr = $this->get_cache( $post_id );
-
-		// Return the cached contents if any.
-		if ( false !== $arr ) {
-			$contents = $arr['jsonld'];
-
-			// Add the cached relations if any.
-			if ( is_a( $arr['relations'], 'Wordlift\Relation\Relations' ) ) {
-				$relations->add( ...$arr['relations']->toArray() );
-			}
-
-			if ( is_array( $arr['references'] ) ) {
-				$references = $arr['references'];
-			}
-
-			$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, $relations );
-
-		/**
-		 * @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, $relations );
-
-		// 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 ) {
-
-		// 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 ? $modified_date_time->getTimestamp() : 0 );
-
-		// Bail out if we don't have cached contents or the cached contents are
-		// invalid.
-		if ( null === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) || ! isset( $contents['relations'] ) ) {
-			$this->log->debug( "Cached contents for post $post_id not found." );
-
-			return false;
-		}
-
-		return $contents['jsonld']
-			? array(
-				'jsonld'     => $contents['jsonld'],
-				'relations'  => Relations::from_json( $contents['relations'] ),
-				'references' => $contents['references'],
-			)
-			: false;
-	}
-
-	/**
-	 * 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, $relations ) {
-
-		$this->log->trace( "Caching result for post $post_id..." );
-
-		$this->cache->put(
-			$post_id,
-			array(
-				// @@todo check the `references`.
-				'references' => $references,
-				'jsonld'     => $jsonld,
-				'relations'  => $relations,
-			)
-		);
-
-	}
-
-	/**
-	 * 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;
+
+    /**
+     * 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->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(), $relations = null, &$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.
+        $arr = $this->get_cache( $post_id );
+
+        // Return the cached contents if any.
+        if ( false !== $arr ) {
+            $contents = $arr['jsonld'];
+
+            // Add the cached relations if any.
+            if ( is_a( $arr['relations'], 'Wordlift\Relation\Relations' ) ) {
+                $relations->add( ...$arr['relations']->toArray() );
+            }
+
+            if ( is_array( $arr['references'] ) ) {
+                $references = $arr['references'];
+            }
+
+            $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, $relations );
+
+        /**
+         * @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, $relations );
+
+        // 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 ) {
+
+        // 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 ? $modified_date_time->getTimestamp() : 0 );
+
+        // Bail out if we don't have cached contents or the cached contents are
+        // invalid.
+        if ( null === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) || ! isset( $contents['relations'] ) ) {
+            $this->log->debug( "Cached contents for post $post_id not found." );
+
+            return false;
+        }
+
+        return $contents['jsonld']
+            ? array(
+                'jsonld'     => $contents['jsonld'],
+                'relations'  => Relations::from_json( $contents['relations'] ),
+                'references' => $contents['references'],
+            )
+            : false;
+    }
+
+    /**
+     * 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, $relations ) {
+
+        $this->log->trace( "Caching result for post $post_id..." );
+
+        $this->cache->put(
+            $post_id,
+            array(
+                // @@todo check the `references`.
+                'references' => $references,
+                'jsonld'     => $jsonld,
+                'relations'  => $relations,
+            )
+        );
+
+    }
+
+    /**
+     * 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 +46 added lines, -46 removed lines

@@ -64,9 +64,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;
@@ -82,7 +82,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',
@@ -131,8 +131,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'));
 
 	}
 
@@ -143,36 +143,36 @@ 
 	 * @inheritdoc
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function convert( $post_id, &$references = array(), &$references_infos = array(), $relations = null, &$cache = false ) {
+	public function convert($post_id, &$references = array(), &$references_infos = array(), $relations = null, &$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.
-		$arr = $this->get_cache( $post_id );
+		$arr = $this->get_cache($post_id);
 
 		// Return the cached contents if any.
-		if ( false !== $arr ) {
+		if (false !== $arr) {
 			$contents = $arr['jsonld'];
 
 			// Add the cached relations if any.
-			if ( is_a( $arr['relations'], 'Wordlift\Relation\Relations' ) ) {
-				$relations->add( ...$arr['relations']->toArray() );
+			if (is_a($arr['relations'], 'Wordlift\Relation\Relations')) {
+				$relations->add(...$arr['relations']->toArray());
 			}
 
-			if ( is_array( $arr['references'] ) ) {
+			if (is_array($arr['references'])) {
 				$references = $arr['references'];
 			}
 
-			$this->log->debug( "Cached contents found for post $post_id." );
+			$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;
@@ -181,10 +181,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, $relations );
+		$jsonld = $this->converter->convert($post_id, $references, $references_infos, $relations);
 
 		/**
 		 * @since 3.32.0
@@ -192,7 +192,7 @@ 
 		 * it here before saving it on cache.
 		 */
 		// Cache the results.
-		$this->set_cache( $post_id, $references, $jsonld, $relations );
+		$this->set_cache($post_id, $references, $jsonld, $relations);
 
 		// Finally return the JSON-LD.
 		return $jsonld;
@@ -208,21 +208,21 @@ 
 	 * @since 3.16.0
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	private function get_cache( $post_id ) {
+	private function get_cache($post_id) {
 
 		// 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 ? $modified_date_time->getTimestamp() : 0 );
+		$modified_date_time = get_post_datetime($post_id, 'modified', 'gmt');
+		$contents           = $this->cache->get($post_id, $modified_date_time ? $modified_date_time->getTimestamp() : 0);
 
 		// Bail out if we don't have cached contents or the cached contents are
 		// invalid.
-		if ( null === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) || ! isset( $contents['relations'] ) ) {
-			$this->log->debug( "Cached contents for post $post_id not found." );
+		if (null === $contents || ! isset($contents['jsonld']) || ! isset($contents['references']) || ! isset($contents['relations'])) {
+			$this->log->debug("Cached contents for post $post_id not found.");
 
 			return false;
 		}
@@ -230,7 +230,7 @@ 
 		return $contents['jsonld']
 			? array(
 				'jsonld'     => $contents['jsonld'],
-				'relations'  => Relations::from_json( $contents['relations'] ),
+				'relations'  => Relations::from_json($contents['relations']),
 				'references' => $contents['references'],
 			)
 			: false;
@@ -247,9 +247,9 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	private function set_cache( $post_id, $references, $jsonld, $relations ) {
+	private function set_cache($post_id, $references, $jsonld, $relations) {
 
-		$this->log->trace( "Caching result for post $post_id..." );
+		$this->log->trace("Caching result for post $post_id...");
 
 		$this->cache->put(
 			$post_id,
@@ -270,13 +270,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);
 
 	}
 
@@ -290,21 +290,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);
 
 	}
 
@@ -314,7 +314,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();
 	}
@@ -325,7 +325,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();
 	}
@@ -337,10 +337,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);
 	}
 
 	/**
@@ -352,13 +352,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'));
 
 	}
 
@@ -370,10 +370,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;
 		}
 

src/includes/class-wordlift-post-adapter.php

Indentation +219 added lines, -219 removed lines

@@ -19,229 +19,229 @@
  */
 class Wordlift_Post_Adapter {
 
-	/**
-	 * The post id to which the adopter relates.
-	 *
-	 * @since 3.14.0
-	 *
-	 * @var integer $post_id .
-	 */
-	private $post_id;
-
-	const TYPE_ENTITY_LINK = 0;
-	const TYPE_TERM_LINK   = 1;
-
-	/**
-	 * Create the {@link Wordlift_Post_Adatpter} instance.
-	 *
-	 * @param integer $post_id the post ID of the post the adopter relates to.
-	 *
-	 * @since 3.14.0
-	 */
-	public function __construct( $post_id ) {
-
-		$this->post_id = $post_id;
-
-	}
-
-	/**
-	 * Get the word count of the post content.
-	 *
-	 * The count is calculated over the post content after stripping shortcodes and html tags.
-	 *
-	 * @return integer the number of words in the content after stripping shortcodes and html tags..
-	 * @since 3.14.0
-	 */
-	public function word_count() {
-
-		$post = get_post( $this->post_id );
-
-		/*
+    /**
+     * The post id to which the adopter relates.
+     *
+     * @since 3.14.0
+     *
+     * @var integer $post_id .
+     */
+    private $post_id;
+
+    const TYPE_ENTITY_LINK = 0;
+    const TYPE_TERM_LINK   = 1;
+
+    /**
+     * Create the {@link Wordlift_Post_Adatpter} instance.
+     *
+     * @param integer $post_id the post ID of the post the adopter relates to.
+     *
+     * @since 3.14.0
+     */
+    public function __construct( $post_id ) {
+
+        $this->post_id = $post_id;
+
+    }
+
+    /**
+     * Get the word count of the post content.
+     *
+     * The count is calculated over the post content after stripping shortcodes and html tags.
+     *
+     * @return integer the number of words in the content after stripping shortcodes and html tags..
+     * @since 3.14.0
+     */
+    public function word_count() {
+
+        $post = get_post( $this->post_id );
+
+        /*
 		 * 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 );
-
-		return self::str_word_count_utf8( wp_strip_all_tags( strip_shortcodes( $post_content ) ) );
-	}
-
-	/**
-	 * Count words in the string, taking into account UTF-8 characters.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/884
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param string $str The target string.
-	 *
-	 * @return int The number of words.
-	 */
-	private static function str_word_count_utf8( $str ) {
-
-		$words = preg_split( '~[^\p{L}\p{N}\']+~u', $str );
-
-		return $words ? count( $words ) : 0;
-	}
-
-	/**
-	 * Get the {@link WP_Post} permalink allowing 3rd parties to alter the URL.
-	 *
-	 * @param int $post_id Post ID.
-	 *
-	 * @return string The post permalink.
-	 * @since 3.20.0
-	 */
-	public static function get_production_permalink( $post_id, $object_type = Object_Type_Enum::POST ) {
-
-		$object_link_service = Object_Link_Provider::get_instance();
-		$permalink           = $object_link_service->get_permalink( $post_id, $object_type );
-
-		/**
-		 * WordPress 4.4 doesn't support meta queries for terms, therefore we only support post permalinks here.
-		 *
-		 * Later on for WordPress 4.5+ we look for terms bound to the entity and we use the term link instead of the
-		 * post permalink if we find them.
-		 */
-		global $wp_version;
-		if ( version_compare( $wp_version, '4.5', '<' ) ) {
-			return apply_filters( 'wl_production_permalink', $permalink, $post_id, self::TYPE_ENTITY_LINK, null );
-		}
-
-		/**
-		 * The `wl_production_permalink` filter allows to change the permalink, this is useful in contexts
-		 * when the production environment is copied over from a staging environment with staging
-		 * URLs.
-		 *
-		 * @param string $permalink_url The default permalink.
-		 * @param int $post_id The post id.
-		 *
-		 * @since 3.23.0 we check whether the entity is bound to a term and, in that case, we link to the term.
-		 * @since 3.20.0
-		 *
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/850
-		 */
-
-		$uris = $object_link_service->get_same_as_uris(
-			$post_id,
-			$object_type
-		);
-
-		// Only try to link a term if `WL_ENABLE_TERM_LINKING` is enabled.
-		$terms = array();
-		if ( defined( 'WL_ENABLE_TERM_LINKING' ) && WL_ENABLE_TERM_LINKING ) {
-			// Try to find one term matching the entity.
-			$terms = get_terms(
-				array(
-					'number'                 => 1,
-					'hide_empty'             => false,
-					'update_term_meta_cache' => false,
-					'meta_key'               => '_wl_entity_id',
-					'meta_value'             => $uris,
-					'meta_compare'           => 'IN',
-				)
-			);
-		}
-
-		$type = self::TYPE_ENTITY_LINK;
-		$term = null;
-		// If found use the term link, otherwise the permalink.
-		if ( 1 === count( $terms ) ) {
-			$term      = current( $terms );
-			$permalink = get_term_link( $term );
-			$type      = self::TYPE_TERM_LINK;
-		}
-
-		/**
-		 * Apply the `wl_production_permalink` filter.
-		 *
-		 * @param string $permalink The permalink.
-		 * @param int $post_id The post id.
-		 * @param int $type The permalink type: 0 = entity permalink, 1 = term link.
-		 * @param WP_Term $term The term if type is term link, otherwise null.
-		 *
-		 * @since 3.23.0 add the permalink type and term parameters.
-		 */
-		return apply_filters( 'wl_production_permalink', $permalink, $post_id, $type, $term );
-	}
-
-	/**
-	 * Get comma separated tags to be used as keywords
-	 *
-	 * @return string|void Comma separated tags
-	 *
-	 * @since 3.27.2
-	 */
-	public function keywords() {
-		$tags = get_the_tags( $this->post_id );
-
-		if ( empty( $tags ) ) {
-			return;
-		}
-
-		return implode(
-			',',
-			array_map(
-				function ( $tag ) {
-					return $tag->name;
-				},
-				$tags
-			)
-		);
-	}
-
-	/**
-	 * Get comma separated categories to be used as article section
-	 *
-	 * @return string[] Comma separated categories
-	 *
-	 * @since 3.27.2
-	 */
-	public function article_section() {
-		$categories = get_the_category( $this->post_id );
-
-		return wp_list_pluck( $categories, 'cat_name' );
-	}
-
-	/**
-	 * Get comment count
-	 *
-	 * @return string|void Comment count
-	 *
-	 * @since 3.27.2
-	 */
-	public function comment_count() {
-		return get_comments_number( $this->post_id );
-	}
-
-	/**
-	 * Get Language
-	 * Try WPML, Polylang for post specific languages, else fallback on get_locale()
-	 *
-	 * @return string|void Language code (locale)
-	 *
-	 * @since 3.27.2
-	 */
-	public function locale() {
-		$language = 'en-US';
-
-		if ( function_exists( 'wpml_get_language_information' ) ) {
-			// WPML handling
-			// WPML: Updated function signature.
-			// function wpml_get_language_information( $empty_value = null, $post_id = null )
-			$post_language = wpml_get_language_information( null, $this->post_id );
-			if ( ! $post_language instanceof WP_Error ) {
-				$language = $post_language['locale'];
-			}
-		} elseif ( function_exists( 'pll_get_post_language' ) ) {
-			// Polylang handling
-			$language = pll_get_post_language( $this->post_id, 'locale' );
-		} else {
-			$language = get_locale();
-		}
-
-		return str_replace( '_', '-', $language );
-	}
+        $post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
+
+        return self::str_word_count_utf8( wp_strip_all_tags( strip_shortcodes( $post_content ) ) );
+    }
+
+    /**
+     * Count words in the string, taking into account UTF-8 characters.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/884
+     *
+     * @since 3.20.0
+     *
+     * @param string $str The target string.
+     *
+     * @return int The number of words.
+     */
+    private static function str_word_count_utf8( $str ) {
+
+        $words = preg_split( '~[^\p{L}\p{N}\']+~u', $str );
+
+        return $words ? count( $words ) : 0;
+    }
+
+    /**
+     * Get the {@link WP_Post} permalink allowing 3rd parties to alter the URL.
+     *
+     * @param int $post_id Post ID.
+     *
+     * @return string The post permalink.
+     * @since 3.20.0
+     */
+    public static function get_production_permalink( $post_id, $object_type = Object_Type_Enum::POST ) {
+
+        $object_link_service = Object_Link_Provider::get_instance();
+        $permalink           = $object_link_service->get_permalink( $post_id, $object_type );
+
+        /**
+         * WordPress 4.4 doesn't support meta queries for terms, therefore we only support post permalinks here.
+         *
+         * Later on for WordPress 4.5+ we look for terms bound to the entity and we use the term link instead of the
+         * post permalink if we find them.
+         */
+        global $wp_version;
+        if ( version_compare( $wp_version, '4.5', '<' ) ) {
+            return apply_filters( 'wl_production_permalink', $permalink, $post_id, self::TYPE_ENTITY_LINK, null );
+        }
+
+        /**
+         * The `wl_production_permalink` filter allows to change the permalink, this is useful in contexts
+         * when the production environment is copied over from a staging environment with staging
+         * URLs.
+         *
+         * @param string $permalink_url The default permalink.
+         * @param int $post_id The post id.
+         *
+         * @since 3.23.0 we check whether the entity is bound to a term and, in that case, we link to the term.
+         * @since 3.20.0
+         *
+         * @see https://github.com/insideout10/wordlift-plugin/issues/850
+         */
+
+        $uris = $object_link_service->get_same_as_uris(
+            $post_id,
+            $object_type
+        );
+
+        // Only try to link a term if `WL_ENABLE_TERM_LINKING` is enabled.
+        $terms = array();
+        if ( defined( 'WL_ENABLE_TERM_LINKING' ) && WL_ENABLE_TERM_LINKING ) {
+            // Try to find one term matching the entity.
+            $terms = get_terms(
+                array(
+                    'number'                 => 1,
+                    'hide_empty'             => false,
+                    'update_term_meta_cache' => false,
+                    'meta_key'               => '_wl_entity_id',
+                    'meta_value'             => $uris,
+                    'meta_compare'           => 'IN',
+                )
+            );
+        }
+
+        $type = self::TYPE_ENTITY_LINK;
+        $term = null;
+        // If found use the term link, otherwise the permalink.
+        if ( 1 === count( $terms ) ) {
+            $term      = current( $terms );
+            $permalink = get_term_link( $term );
+            $type      = self::TYPE_TERM_LINK;
+        }
+
+        /**
+         * Apply the `wl_production_permalink` filter.
+         *
+         * @param string $permalink The permalink.
+         * @param int $post_id The post id.
+         * @param int $type The permalink type: 0 = entity permalink, 1 = term link.
+         * @param WP_Term $term The term if type is term link, otherwise null.
+         *
+         * @since 3.23.0 add the permalink type and term parameters.
+         */
+        return apply_filters( 'wl_production_permalink', $permalink, $post_id, $type, $term );
+    }
+
+    /**
+     * Get comma separated tags to be used as keywords
+     *
+     * @return string|void Comma separated tags
+     *
+     * @since 3.27.2
+     */
+    public function keywords() {
+        $tags = get_the_tags( $this->post_id );
+
+        if ( empty( $tags ) ) {
+            return;
+        }
+
+        return implode(
+            ',',
+            array_map(
+                function ( $tag ) {
+                    return $tag->name;
+                },
+                $tags
+            )
+        );
+    }
+
+    /**
+     * Get comma separated categories to be used as article section
+     *
+     * @return string[] Comma separated categories
+     *
+     * @since 3.27.2
+     */
+    public function article_section() {
+        $categories = get_the_category( $this->post_id );
+
+        return wp_list_pluck( $categories, 'cat_name' );
+    }
+
+    /**
+     * Get comment count
+     *
+     * @return string|void Comment count
+     *
+     * @since 3.27.2
+     */
+    public function comment_count() {
+        return get_comments_number( $this->post_id );
+    }
+
+    /**
+     * Get Language
+     * Try WPML, Polylang for post specific languages, else fallback on get_locale()
+     *
+     * @return string|void Language code (locale)
+     *
+     * @since 3.27.2
+     */
+    public function locale() {
+        $language = 'en-US';
+
+        if ( function_exists( 'wpml_get_language_information' ) ) {
+            // WPML handling
+            // WPML: Updated function signature.
+            // function wpml_get_language_information( $empty_value = null, $post_id = null )
+            $post_language = wpml_get_language_information( null, $this->post_id );
+            if ( ! $post_language instanceof WP_Error ) {
+                $language = $post_language['locale'];
+            }
+        } elseif ( function_exists( 'pll_get_post_language' ) ) {
+            // Polylang handling
+            $language = pll_get_post_language( $this->post_id, 'locale' );
+        } else {
+            $language = get_locale();
+        }
+
+        return str_replace( '_', '-', $language );
+    }
 
 }

Spacing +28 added lines, -28 removed lines

@@ -38,7 +38,7 @@ 
 	 *
 	 * @since 3.14.0
 	 */
-	public function __construct( $post_id ) {
+	public function __construct($post_id) {
 
 		$this->post_id = $post_id;
 
@@ -54,7 +54,7 @@ 
 	 */
 	public function word_count() {
 
-		$post = get_post( $this->post_id );
+		$post = get_post($this->post_id);
 
 		/*
 		 * Apply the `wl_post_content` filter, in case 3rd parties want to change the post content, e.g.
@@ -62,9 +62,9 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
+		$post_content = apply_filters('wl_post_content', $post->post_content, $post);
 
-		return self::str_word_count_utf8( wp_strip_all_tags( strip_shortcodes( $post_content ) ) );
+		return self::str_word_count_utf8(wp_strip_all_tags(strip_shortcodes($post_content)));
 	}
 
 	/**
@@ -78,11 +78,11 @@ 
 	 *
 	 * @return int The number of words.
 	 */
-	private static function str_word_count_utf8( $str ) {
+	private static function str_word_count_utf8($str) {
 
-		$words = preg_split( '~[^\p{L}\p{N}\']+~u', $str );
+		$words = preg_split('~[^\p{L}\p{N}\']+~u', $str);
 
-		return $words ? count( $words ) : 0;
+		return $words ? count($words) : 0;
 	}
 
 	/**
@@ -93,10 +93,10 @@ 
 	 * @return string The post permalink.
 	 * @since 3.20.0
 	 */
-	public static function get_production_permalink( $post_id, $object_type = Object_Type_Enum::POST ) {
+	public static function get_production_permalink($post_id, $object_type = Object_Type_Enum::POST) {
 
 		$object_link_service = Object_Link_Provider::get_instance();
-		$permalink           = $object_link_service->get_permalink( $post_id, $object_type );
+		$permalink           = $object_link_service->get_permalink($post_id, $object_type);
 
 		/**
 		 * WordPress 4.4 doesn't support meta queries for terms, therefore we only support post permalinks here.
@@ -105,8 +105,8 @@ 
 		 * post permalink if we find them.
 		 */
 		global $wp_version;
-		if ( version_compare( $wp_version, '4.5', '<' ) ) {
-			return apply_filters( 'wl_production_permalink', $permalink, $post_id, self::TYPE_ENTITY_LINK, null );
+		if (version_compare($wp_version, '4.5', '<')) {
+			return apply_filters('wl_production_permalink', $permalink, $post_id, self::TYPE_ENTITY_LINK, null);
 		}
 
 		/**
@@ -130,7 +130,7 @@ 
 
 		// Only try to link a term if `WL_ENABLE_TERM_LINKING` is enabled.
 		$terms = array();
-		if ( defined( 'WL_ENABLE_TERM_LINKING' ) && WL_ENABLE_TERM_LINKING ) {
+		if (defined('WL_ENABLE_TERM_LINKING') && WL_ENABLE_TERM_LINKING) {
 			// Try to find one term matching the entity.
 			$terms = get_terms(
 				array(
@@ -147,9 +147,9 @@ 
 		$type = self::TYPE_ENTITY_LINK;
 		$term = null;
 		// If found use the term link, otherwise the permalink.
-		if ( 1 === count( $terms ) ) {
-			$term      = current( $terms );
-			$permalink = get_term_link( $term );
+		if (1 === count($terms)) {
+			$term      = current($terms);
+			$permalink = get_term_link($term);
 			$type      = self::TYPE_TERM_LINK;
 		}
 
@@ -163,7 +163,7 @@ 
 		 *
 		 * @since 3.23.0 add the permalink type and term parameters.
 		 */
-		return apply_filters( 'wl_production_permalink', $permalink, $post_id, $type, $term );
+		return apply_filters('wl_production_permalink', $permalink, $post_id, $type, $term);
 	}
 
 	/**
@@ -174,16 +174,16 @@ 
 	 * @since 3.27.2
 	 */
 	public function keywords() {
-		$tags = get_the_tags( $this->post_id );
+		$tags = get_the_tags($this->post_id);
 
-		if ( empty( $tags ) ) {
+		if (empty($tags)) {
 			return;
 		}
 
 		return implode(
 			',',
 			array_map(
-				function ( $tag ) {
+				function($tag) {
 					return $tag->name;
 				},
 				$tags
@@ -199,9 +199,9 @@ 
 	 * @since 3.27.2
 	 */
 	public function article_section() {
-		$categories = get_the_category( $this->post_id );
+		$categories = get_the_category($this->post_id);
 
-		return wp_list_pluck( $categories, 'cat_name' );
+		return wp_list_pluck($categories, 'cat_name');
 	}
 
 	/**
@@ -212,7 +212,7 @@ 
 	 * @since 3.27.2
 	 */
 	public function comment_count() {
-		return get_comments_number( $this->post_id );
+		return get_comments_number($this->post_id);
 	}
 
 	/**
@@ -226,22 +226,22 @@ 
 	public function locale() {
 		$language = 'en-US';
 
-		if ( function_exists( 'wpml_get_language_information' ) ) {
+		if (function_exists('wpml_get_language_information')) {
 			// WPML handling
 			// WPML: Updated function signature.
 			// function wpml_get_language_information( $empty_value = null, $post_id = null )
-			$post_language = wpml_get_language_information( null, $this->post_id );
-			if ( ! $post_language instanceof WP_Error ) {
+			$post_language = wpml_get_language_information(null, $this->post_id);
+			if ( ! $post_language instanceof WP_Error) {
 				$language = $post_language['locale'];
 			}
-		} elseif ( function_exists( 'pll_get_post_language' ) ) {
+		} elseif (function_exists('pll_get_post_language')) {
 			// Polylang handling
-			$language = pll_get_post_language( $this->post_id, 'locale' );
+			$language = pll_get_post_language($this->post_id, 'locale');
 		} else {
 			$language = get_locale();
 		}
 
-		return str_replace( '_', '-', $language );
+		return str_replace('_', '-', $language);
 	}
 
 }

src/wordlift/vocabulary-terms/jsonld/class-jsonld-generator.php

Indentation +163 added lines, -163 removed lines

@@ -11,167 +11,167 @@
 
 class Jsonld_Generator {
 
-	/**
-	 * @var \Wordlift_Entity_Type_Service
-	 */
-	private $entity_type_service;
-	/**
-	 * @var \Wordlift_Property_Getter
-	 */
-	private $property_getter;
-	/**
-	 * @var Type_Service
-	 */
-	private $term_entity_type_service;
-	/**
-	 * @var \Wordlift_Entity_Service
-	 */
-	private $entity_service;
-
-	public function __construct( $entity_type_service, $property_getter ) {
-		$this->entity_type_service      = $entity_type_service;
-		$this->property_getter          = $property_getter;
-		$this->term_entity_type_service = Type_Service::get_instance();
-		$this->entity_service           = \Wordlift_Entity_Service::get_instance();
-	}
-
-	public function init() {
-		add_filter( 'wl_term_jsonld_array', array( $this, 'wl_term_jsonld_array' ), 10, 2 );
-	}
-
-	public function wl_term_jsonld_array( $data, $term_id ) {
-		$jsonld     = $data['jsonld'];
-		$references = $data['references'];
-
-		$term_jsonld_data = $this->get_jsonld_data_for_term( $term_id );
-
-		// Return early if we dont have the entity data
-		// for the term.
-		if ( ! $term_jsonld_data ) {
-			return $data;
-		}
-
-		$term_jsonld = $term_jsonld_data['jsonld'];
-
-		$references = array_merge( $references, $term_jsonld_data['references'] );
-
-		array_unshift( $jsonld, $term_jsonld );
-
-		return array(
-			'jsonld'     => $jsonld,
-			'references' => $references,
-		);
-	}
-
-	private function get_jsonld_data_for_term( $term_id ) {
-
-		$id = $this->entity_service->get_uri( $term_id, Object_Type_Enum::TERM );
-
-		// If we don't have a dataset  URI, then don't publish the term data
-		// on this page.
-		if ( ! $id ) {
-			return false;
-		}
-
-		$references = array();
-		$term       = get_term( $term_id );
-		$permalink  = get_term_link( $term );
-
-		$custom_fields = $this->entity_type_service->get_custom_fields_for_term( $term_id );
-		$term          = get_term( $term_id );
-		$jsonld        = array(
-			'@context'    => 'http://schema.org',
-			'name'        => $term->name,
-			'@type'       => $this->term_entity_type_service->get_entity_types_labels( $term_id ),
-			'@id'         => $id,
-			'description' => wp_strip_all_tags( self::strip_all_shortcodes( $term->description ) ),
-		);
-
-		if ( ! $custom_fields || ! is_array( $custom_fields ) ) {
-			return $jsonld;
-		}
-
-		foreach ( $custom_fields as $key => $value ) {
-			$name  = $this->relative_to_schema_context( $value['predicate'] );
-			$value = $this->property_getter->get( $term_id, $key, Object_Type_Enum::TERM );
-			$value = $this->process_value( $value, $references );
-			if ( ! isset( $value ) ||
-				 is_array( $value ) && empty( $value ) ||
-				 is_string( $value ) && empty( $value ) ) {
-				continue;
-			}
-			$jsonld[ $name ] = $value;
-
-		}
-
-		$jsonld = \Wordlift_Entity_Post_To_Jsonld_Converter::post_process( $jsonld );
-
-		if ( $permalink ) {
-			$jsonld['mainEntityOfPage'] = $permalink;
-		}
-
-		return apply_filters(
-			'wl_no_vocabulary_term_jsonld_array',
-			array(
-				'jsonld'     => $jsonld,
-				'references' => $references,
-			),
-			$term_id
-		);
-
-	}
-
-	private function relative_to_schema_context( $predicate ) {
-		return str_replace( 'http://schema.org/', '', $predicate );
-	}
-
-	private function process_value( $value, &$references ) {
-
-		if ( is_array( $value )
-			 && count( $value ) > 0
-			 && $value[0] instanceof \Wordlift_Property_Entity_Reference ) {
-
-			// All of the references from the custom fields are post references.
-			$references = array_merge(
-				$references,
-				array_map(
-					function ( $property_entity_reference ) {
-						/**
-						 * @var $property_entity_reference \Wordlift_Property_Entity_Reference
-						 */
-						return $property_entity_reference->get_id();
-					},
-					$value
-				)
-			);
-
-			return array_map(
-				function ( $reference ) {
-					/**
-					 * @var $reference \Wordlift_Property_Entity_Reference
-					 */
-					return array( '@id' => $reference->get_url() );
-				},
-				$value
-			);
-
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Remove all the shortcodes from the content. We're using our own function
-	 * because WordPress' own `strip_shortcodes` only takes into consideration
-	 * shortcodes for installed plugins/themes.
-	 *
-	 * @since 3.12.0
-	 *
-	 * @param string $content The content with shortcodes.
-	 *
-	 * @return string The content without shortcodes.
-	 */
-	private static function strip_all_shortcodes( $content ) {
-		return preg_replace( '/\[[^]]+\]/', '', $content );
-	}
+    /**
+     * @var \Wordlift_Entity_Type_Service
+     */
+    private $entity_type_service;
+    /**
+     * @var \Wordlift_Property_Getter
+     */
+    private $property_getter;
+    /**
+     * @var Type_Service
+     */
+    private $term_entity_type_service;
+    /**
+     * @var \Wordlift_Entity_Service
+     */
+    private $entity_service;
+
+    public function __construct( $entity_type_service, $property_getter ) {
+        $this->entity_type_service      = $entity_type_service;
+        $this->property_getter          = $property_getter;
+        $this->term_entity_type_service = Type_Service::get_instance();
+        $this->entity_service           = \Wordlift_Entity_Service::get_instance();
+    }
+
+    public function init() {
+        add_filter( 'wl_term_jsonld_array', array( $this, 'wl_term_jsonld_array' ), 10, 2 );
+    }
+
+    public function wl_term_jsonld_array( $data, $term_id ) {
+        $jsonld     = $data['jsonld'];
+        $references = $data['references'];
+
+        $term_jsonld_data = $this->get_jsonld_data_for_term( $term_id );
+
+        // Return early if we dont have the entity data
+        // for the term.
+        if ( ! $term_jsonld_data ) {
+            return $data;
+        }
+
+        $term_jsonld = $term_jsonld_data['jsonld'];
+
+        $references = array_merge( $references, $term_jsonld_data['references'] );
+
+        array_unshift( $jsonld, $term_jsonld );
+
+        return array(
+            'jsonld'     => $jsonld,
+            'references' => $references,
+        );
+    }
+
+    private function get_jsonld_data_for_term( $term_id ) {
+
+        $id = $this->entity_service->get_uri( $term_id, Object_Type_Enum::TERM );
+
+        // If we don't have a dataset  URI, then don't publish the term data
+        // on this page.
+        if ( ! $id ) {
+            return false;
+        }
+
+        $references = array();
+        $term       = get_term( $term_id );
+        $permalink  = get_term_link( $term );
+
+        $custom_fields = $this->entity_type_service->get_custom_fields_for_term( $term_id );
+        $term          = get_term( $term_id );
+        $jsonld        = array(
+            '@context'    => 'http://schema.org',
+            'name'        => $term->name,
+            '@type'       => $this->term_entity_type_service->get_entity_types_labels( $term_id ),
+            '@id'         => $id,
+            'description' => wp_strip_all_tags( self::strip_all_shortcodes( $term->description ) ),
+        );
+
+        if ( ! $custom_fields || ! is_array( $custom_fields ) ) {
+            return $jsonld;
+        }
+
+        foreach ( $custom_fields as $key => $value ) {
+            $name  = $this->relative_to_schema_context( $value['predicate'] );
+            $value = $this->property_getter->get( $term_id, $key, Object_Type_Enum::TERM );
+            $value = $this->process_value( $value, $references );
+            if ( ! isset( $value ) ||
+                 is_array( $value ) && empty( $value ) ||
+                 is_string( $value ) && empty( $value ) ) {
+                continue;
+            }
+            $jsonld[ $name ] = $value;
+
+        }
+
+        $jsonld = \Wordlift_Entity_Post_To_Jsonld_Converter::post_process( $jsonld );
+
+        if ( $permalink ) {
+            $jsonld['mainEntityOfPage'] = $permalink;
+        }
+
+        return apply_filters(
+            'wl_no_vocabulary_term_jsonld_array',
+            array(
+                'jsonld'     => $jsonld,
+                'references' => $references,
+            ),
+            $term_id
+        );
+
+    }
+
+    private function relative_to_schema_context( $predicate ) {
+        return str_replace( 'http://schema.org/', '', $predicate );
+    }
+
+    private function process_value( $value, &$references ) {
+
+        if ( is_array( $value )
+             && count( $value ) > 0
+             && $value[0] instanceof \Wordlift_Property_Entity_Reference ) {
+
+            // All of the references from the custom fields are post references.
+            $references = array_merge(
+                $references,
+                array_map(
+                    function ( $property_entity_reference ) {
+                        /**
+                         * @var $property_entity_reference \Wordlift_Property_Entity_Reference
+                         */
+                        return $property_entity_reference->get_id();
+                    },
+                    $value
+                )
+            );
+
+            return array_map(
+                function ( $reference ) {
+                    /**
+                     * @var $reference \Wordlift_Property_Entity_Reference
+                     */
+                    return array( '@id' => $reference->get_url() );
+                },
+                $value
+            );
+
+        }
+
+        return $value;
+    }
+
+    /**
+     * Remove all the shortcodes from the content. We're using our own function
+     * because WordPress' own `strip_shortcodes` only takes into consideration
+     * shortcodes for installed plugins/themes.
+     *
+     * @since 3.12.0
+     *
+     * @param string $content The content with shortcodes.
+     *
+     * @return string The content without shortcodes.
+     */
+    private static function strip_all_shortcodes( $content ) {
+        return preg_replace( '/\[[^]]+\]/', '', $content );
+    }
 }

src/wordlift/class-assertions.php

Indentation +100 added lines, -100 removed lines

@@ -15,105 +15,105 @@
 
 class Assertions {
 
-	/**
-	 * Asserts that the provided value is of the specified type.
-	 *
-	 * @param mixed  $value The value to test.
-	 * @param string $type The expected type.
-	 *
-	 * @throws Exception when an error occurs.
-	 */
-	public static function assert_of_type( $value, $type ) {
-
-		// Check for nulls.
-		if ( null === $value ) {
-			throw new Exception( 'Value can`t be null.' );
-		}
-
-		// Check for type.
-		if ( get_class( $value ) !== $type ) {
-			throw new Exception( "Value must be a $type." );
-		}
-
-	}
-
-	/**
-	 * @throws Exception when the argument is not a string.
-	 */
-	public static function is_string( $arg, $message = 'Value must be a string' ) {
-		if ( ! is_string( $arg ) ) {
-			throw new Exception( $message );
-		}
-	}
-
-	/**
-	 * @throws Exception when actual doesn't match expected.
-	 */
-	public static function equals( $actual, $expected, $message = 'Values do not match' ) {
-		if ( $actual !== $expected ) {
-			throw new Exception( $message );
-		}
-	}
-
-	/**
-	 * @throws Exception when actual doesn't match expected.
-	 */
-	public static function array_key_exists( $arr, $key ) {
-		if ( ! array_key_exists( $key, $arr ) ) {
-			throw new Exception( "The key {$key} doesn't exist in array" );
-		}
-	}
-
-	/**
-	 * @throws Exception when the value doesn't match the pattern.
-	 */
-	public static function matches( $value, $pattern, $message = "Value doesn't match" ) {
-		if ( 1 !== preg_match( $pattern, $value ) ) {
-			throw new Exception( $message );
-		}
-
-	}
-
-	/**
-	 * @throws Exception when the value doesn't start with the provided scope.
-	 */
-	public static function starts_with( $value, $scope, $message = "Value doesn't start with provided scope" ) {
-		if ( 0 !== strpos( $value, $scope ) ) {
-			throw new Exception( $message );
-		}
-	}
-
-	/**
-	 * @throws Exception when the value is not of the specified type.
-	 */
-	public static function is_a( $value, $type, $message = 'Value is not of the required type' ) {
-		if ( ! is_a( $value, $type ) ) {
-			throw new Exception( $message );
-		}
-	}
-
-	public static function is_set( $value, $message = 'Value is not set' ) {
-		if ( ! isset( $value ) ) {
-			throw new Exception( $message );
-		}
-	}
-
-	public static function not_empty( $value, $message = "Value can't be empty" ) {
-		if ( empty( $value ) ) {
-			throw new Exception( $message );
-		}
-	}
-
-	public static function is_array( $value, $message = 'Value should be array' ) {
-		if ( ! is_array( $value ) ) {
-			throw new Exception( $message );
-		}
-	}
-
-	public static function is_numeric( $value, $message = 'Value should be numeric' ) {
-		if ( ! is_numeric( $value ) ) {
-			throw new Exception( $message );
-		}
-	}
+    /**
+     * Asserts that the provided value is of the specified type.
+     *
+     * @param mixed  $value The value to test.
+     * @param string $type The expected type.
+     *
+     * @throws Exception when an error occurs.
+     */
+    public static function assert_of_type( $value, $type ) {
+
+        // Check for nulls.
+        if ( null === $value ) {
+            throw new Exception( 'Value can`t be null.' );
+        }
+
+        // Check for type.
+        if ( get_class( $value ) !== $type ) {
+            throw new Exception( "Value must be a $type." );
+        }
+
+    }
+
+    /**
+     * @throws Exception when the argument is not a string.
+     */
+    public static function is_string( $arg, $message = 'Value must be a string' ) {
+        if ( ! is_string( $arg ) ) {
+            throw new Exception( $message );
+        }
+    }
+
+    /**
+     * @throws Exception when actual doesn't match expected.
+     */
+    public static function equals( $actual, $expected, $message = 'Values do not match' ) {
+        if ( $actual !== $expected ) {
+            throw new Exception( $message );
+        }
+    }
+
+    /**
+     * @throws Exception when actual doesn't match expected.
+     */
+    public static function array_key_exists( $arr, $key ) {
+        if ( ! array_key_exists( $key, $arr ) ) {
+            throw new Exception( "The key {$key} doesn't exist in array" );
+        }
+    }
+
+    /**
+     * @throws Exception when the value doesn't match the pattern.
+     */
+    public static function matches( $value, $pattern, $message = "Value doesn't match" ) {
+        if ( 1 !== preg_match( $pattern, $value ) ) {
+            throw new Exception( $message );
+        }
+
+    }
+
+    /**
+     * @throws Exception when the value doesn't start with the provided scope.
+     */
+    public static function starts_with( $value, $scope, $message = "Value doesn't start with provided scope" ) {
+        if ( 0 !== strpos( $value, $scope ) ) {
+            throw new Exception( $message );
+        }
+    }
+
+    /**
+     * @throws Exception when the value is not of the specified type.
+     */
+    public static function is_a( $value, $type, $message = 'Value is not of the required type' ) {
+        if ( ! is_a( $value, $type ) ) {
+            throw new Exception( $message );
+        }
+    }
+
+    public static function is_set( $value, $message = 'Value is not set' ) {
+        if ( ! isset( $value ) ) {
+            throw new Exception( $message );
+        }
+    }
+
+    public static function not_empty( $value, $message = "Value can't be empty" ) {
+        if ( empty( $value ) ) {
+            throw new Exception( $message );
+        }
+    }
+
+    public static function is_array( $value, $message = 'Value should be array' ) {
+        if ( ! is_array( $value ) ) {
+            throw new Exception( $message );
+        }
+    }
+
+    public static function is_numeric( $value, $message = 'Value should be numeric' ) {
+        if ( ! is_numeric( $value ) ) {
+            throw new Exception( $message );
+        }
+    }
 
 }

Spacing +35 added lines, -35 removed lines

@@ -23,16 +23,16 @@ 
 	 *
 	 * @throws Exception when an error occurs.
 	 */
-	public static function assert_of_type( $value, $type ) {
+	public static function assert_of_type($value, $type) {
 
 		// Check for nulls.
-		if ( null === $value ) {
-			throw new Exception( 'Value can`t be null.' );
+		if (null === $value) {
+			throw new Exception('Value can`t be null.');
 		}
 
 		// Check for type.
-		if ( get_class( $value ) !== $type ) {
-			throw new Exception( "Value must be a $type." );
+		if (get_class($value) !== $type) {
+			throw new Exception("Value must be a $type.");
 		}
 
 	}
@@ -40,36 +40,36 @@ 
 	/**
 	 * @throws Exception when the argument is not a string.
 	 */
-	public static function is_string( $arg, $message = 'Value must be a string' ) {
-		if ( ! is_string( $arg ) ) {
-			throw new Exception( $message );
+	public static function is_string($arg, $message = 'Value must be a string') {
+		if ( ! is_string($arg)) {
+			throw new Exception($message);
 		}
 	}
 
 	/**
 	 * @throws Exception when actual doesn't match expected.
 	 */
-	public static function equals( $actual, $expected, $message = 'Values do not match' ) {
-		if ( $actual !== $expected ) {
-			throw new Exception( $message );
+	public static function equals($actual, $expected, $message = 'Values do not match') {
+		if ($actual !== $expected) {
+			throw new Exception($message);
 		}
 	}
 
 	/**
 	 * @throws Exception when actual doesn't match expected.
 	 */
-	public static function array_key_exists( $arr, $key ) {
-		if ( ! array_key_exists( $key, $arr ) ) {
-			throw new Exception( "The key {$key} doesn't exist in array" );
+	public static function array_key_exists($arr, $key) {
+		if ( ! array_key_exists($key, $arr)) {
+			throw new Exception("The key {$key} doesn't exist in array");
 		}
 	}
 
 	/**
 	 * @throws Exception when the value doesn't match the pattern.
 	 */
-	public static function matches( $value, $pattern, $message = "Value doesn't match" ) {
-		if ( 1 !== preg_match( $pattern, $value ) ) {
-			throw new Exception( $message );
+	public static function matches($value, $pattern, $message = "Value doesn't match") {
+		if (1 !== preg_match($pattern, $value)) {
+			throw new Exception($message);
 		}
 
 	}
@@ -77,42 +77,42 @@ 
 	/**
 	 * @throws Exception when the value doesn't start with the provided scope.
 	 */
-	public static function starts_with( $value, $scope, $message = "Value doesn't start with provided scope" ) {
-		if ( 0 !== strpos( $value, $scope ) ) {
-			throw new Exception( $message );
+	public static function starts_with($value, $scope, $message = "Value doesn't start with provided scope") {
+		if (0 !== strpos($value, $scope)) {
+			throw new Exception($message);
 		}
 	}
 
 	/**
 	 * @throws Exception when the value is not of the specified type.
 	 */
-	public static function is_a( $value, $type, $message = 'Value is not of the required type' ) {
-		if ( ! is_a( $value, $type ) ) {
-			throw new Exception( $message );
+	public static function is_a($value, $type, $message = 'Value is not of the required type') {
+		if ( ! is_a($value, $type)) {
+			throw new Exception($message);
 		}
 	}
 
-	public static function is_set( $value, $message = 'Value is not set' ) {
-		if ( ! isset( $value ) ) {
-			throw new Exception( $message );
+	public static function is_set($value, $message = 'Value is not set') {
+		if ( ! isset($value)) {
+			throw new Exception($message);
 		}
 	}
 
-	public static function not_empty( $value, $message = "Value can't be empty" ) {
-		if ( empty( $value ) ) {
-			throw new Exception( $message );
+	public static function not_empty($value, $message = "Value can't be empty") {
+		if (empty($value)) {
+			throw new Exception($message);
 		}
 	}
 
-	public static function is_array( $value, $message = 'Value should be array' ) {
-		if ( ! is_array( $value ) ) {
-			throw new Exception( $message );
+	public static function is_array($value, $message = 'Value should be array') {
+		if ( ! is_array($value)) {
+			throw new Exception($message);
 		}
 	}
 
-	public static function is_numeric( $value, $message = 'Value should be numeric' ) {
-		if ( ! is_numeric( $value ) ) {
-			throw new Exception( $message );
+	public static function is_numeric($value, $message = 'Value should be numeric') {
+		if ( ! is_numeric($value)) {
+			throw new Exception($message);
 		}
 	}
 

src/wordlift/jsonld/class-graph.php

Indentation +147 added lines, -147 removed lines

@@ -14,152 +14,152 @@
  */
 class Graph {
 
-	/**
-	 * A single item in jsonld ( associative array )
-	 *
-	 * @var array
-	 */
-	private $main_jsonld;
-
-	/**
-	 * @var array<Content_Id>
-	 */
-	private $referenced_content_ids = array();
-	/**
-	 * @var \Wordlift_Post_Converter
-	 */
-	private $post_converter;
-	/**
-	 * @var \Wordlift_Term_JsonLd_Adapter
-	 */
-	private $term_converter;
-
-	public function __construct( $main_jsonld, $post_converter, $term_converter ) {
-		$this->main_jsonld    = $main_jsonld;
-		$this->post_converter = $post_converter;
-		$this->term_converter = $term_converter;
-	}
-
-	public function set_main_jsonld( $main_jsonld ) {
-		$this->main_jsonld = $main_jsonld;
-	}
-
-	public function get_main_jsonld() {
-		return $this->main_jsonld;
-	}
-
-	/**
-	 * @param $references array<int>
-	 *
-	 * @return Graph
-	 */
-	public function add_references( $refs ) {
-		Assertions::is_array( $refs );
-
-		foreach ( $refs as $ref ) {
-			$this->referenced_content_ids[] = Wordpress_Content_Id::create_post( $ref );
-		}
-		return $this;
-	}
-
-	/**
-	 * @param $reference_infos array
-	 *     Structure: [
-	 *         [
-	 *             'reference' => \Wordlift_Property_Entity_Reference,
-	 *         ],
-	 *         // more array items ...
-	 *     ]
-	 *
-	 * @return Graph
-	 */
-	public function add_required_reference_infos( $references_infos ) {
-
-		/**
-		 * @var $required_references array<\Wordlift_Property_Entity_Reference>
-		 */
-		$required_references = array_filter(
-			$references_infos,
-			function ( $item ) {
-				return isset( $item['reference'] ) &&
-					   // Check that the reference is required
-					   $item['reference']->get_required();
-			}
-		);
-
-		foreach ( $required_references as $required_reference ) {
-			$this->referenced_content_ids[] = new Wordpress_Content_Id(
-				$required_reference->get_id(),
-				$required_reference->get_type()
-			);
-		}
-		return $this;
-
-	}
-
-	/**
-	 * @param $relations Relations
-	 *
-	 * @return Graph
-	 */
-	public function add_relations( $relations ) {
-
-		foreach ( $relations->toArray() as $relation ) {
-
-			$this->referenced_content_ids[] = $relation->get_object();
-
-		}
-
-		return $this;
-	}
-
-	/**
-	 * @param $content_id Wordpress_Content_Id
-	 * @param $context int
-	 * @return array|bool
-	 */
-	private function expand( $content_id, $context ) {
-		$object_id   = $content_id->get_id();
-		$object_type = $content_id->get_type();
-
-		if ( $object_type === Object_Type_Enum::POST ) {
-			$references     = array();
-			$reference_info = array();
-			$relations      = new Relations();
-			return $this->post_converter->convert( $object_id, $references, $reference_info, $relations );
-		} elseif ( $object_type === Object_Type_Enum::TERM ) {
-			// Skip the Uncategorized term.
-			if ( 1 === $object_id ) {
-				return false;
-			}
-			return $this->term_converter->get( $object_id, $context );
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * @param $context int Instance of Jsonld_Context_Enum
-	 *
-	 * @return array
-	 */
-	public function render( $context ) {
-
-		/**
-		 * This is possible because the toString() method of
-		 * Wordpress_Content_Id is used to get the unique value.
-		 */
-		$unique_content_ids = array_unique( $this->referenced_content_ids, SORT_STRING );
-
-		$result = array( $this->main_jsonld );
-
-		foreach ( $unique_content_ids as $unique_content_id ) {
-			$result[] = $this->expand( $unique_content_id, $context );
-		}
-
-		// Filter out the false and empty results.
-		return array_filter( $result );
-
-	}
+    /**
+     * A single item in jsonld ( associative array )
+     *
+     * @var array
+     */
+    private $main_jsonld;
+
+    /**
+     * @var array<Content_Id>
+     */
+    private $referenced_content_ids = array();
+    /**
+     * @var \Wordlift_Post_Converter
+     */
+    private $post_converter;
+    /**
+     * @var \Wordlift_Term_JsonLd_Adapter
+     */
+    private $term_converter;
+
+    public function __construct( $main_jsonld, $post_converter, $term_converter ) {
+        $this->main_jsonld    = $main_jsonld;
+        $this->post_converter = $post_converter;
+        $this->term_converter = $term_converter;
+    }
+
+    public function set_main_jsonld( $main_jsonld ) {
+        $this->main_jsonld = $main_jsonld;
+    }
+
+    public function get_main_jsonld() {
+        return $this->main_jsonld;
+    }
+
+    /**
+     * @param $references array<int>
+     *
+     * @return Graph
+     */
+    public function add_references( $refs ) {
+        Assertions::is_array( $refs );
+
+        foreach ( $refs as $ref ) {
+            $this->referenced_content_ids[] = Wordpress_Content_Id::create_post( $ref );
+        }
+        return $this;
+    }
+
+    /**
+     * @param $reference_infos array
+     *     Structure: [
+     *         [
+     *             'reference' => \Wordlift_Property_Entity_Reference,
+     *         ],
+     *         // more array items ...
+     *     ]
+     *
+     * @return Graph
+     */
+    public function add_required_reference_infos( $references_infos ) {
+
+        /**
+         * @var $required_references array<\Wordlift_Property_Entity_Reference>
+         */
+        $required_references = array_filter(
+            $references_infos,
+            function ( $item ) {
+                return isset( $item['reference'] ) &&
+                       // Check that the reference is required
+                       $item['reference']->get_required();
+            }
+        );
+
+        foreach ( $required_references as $required_reference ) {
+            $this->referenced_content_ids[] = new Wordpress_Content_Id(
+                $required_reference->get_id(),
+                $required_reference->get_type()
+            );
+        }
+        return $this;
+
+    }
+
+    /**
+     * @param $relations Relations
+     *
+     * @return Graph
+     */
+    public function add_relations( $relations ) {
+
+        foreach ( $relations->toArray() as $relation ) {
+
+            $this->referenced_content_ids[] = $relation->get_object();
+
+        }
+
+        return $this;
+    }
+
+    /**
+     * @param $content_id Wordpress_Content_Id
+     * @param $context int
+     * @return array|bool
+     */
+    private function expand( $content_id, $context ) {
+        $object_id   = $content_id->get_id();
+        $object_type = $content_id->get_type();
+
+        if ( $object_type === Object_Type_Enum::POST ) {
+            $references     = array();
+            $reference_info = array();
+            $relations      = new Relations();
+            return $this->post_converter->convert( $object_id, $references, $reference_info, $relations );
+        } elseif ( $object_type === Object_Type_Enum::TERM ) {
+            // Skip the Uncategorized term.
+            if ( 1 === $object_id ) {
+                return false;
+            }
+            return $this->term_converter->get( $object_id, $context );
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * @param $context int Instance of Jsonld_Context_Enum
+     *
+     * @return array
+     */
+    public function render( $context ) {
+
+        /**
+         * This is possible because the toString() method of
+         * Wordpress_Content_Id is used to get the unique value.
+         */
+        $unique_content_ids = array_unique( $this->referenced_content_ids, SORT_STRING );
+
+        $result = array( $this->main_jsonld );
+
+        foreach ( $unique_content_ids as $unique_content_id ) {
+            $result[] = $this->expand( $unique_content_id, $context );
+        }
+
+        // Filter out the false and empty results.
+        return array_filter( $result );
+
+    }
 
 }

Spacing +24 added lines, -24 removed lines

@@ -34,13 +34,13 @@ 
 	 */
 	private $term_converter;
 
-	public function __construct( $main_jsonld, $post_converter, $term_converter ) {
+	public function __construct($main_jsonld, $post_converter, $term_converter) {
 		$this->main_jsonld    = $main_jsonld;
 		$this->post_converter = $post_converter;
 		$this->term_converter = $term_converter;
 	}
 
-	public function set_main_jsonld( $main_jsonld ) {
+	public function set_main_jsonld($main_jsonld) {
 		$this->main_jsonld = $main_jsonld;
 	}
 
@@ -53,11 +53,11 @@ 
 	 *
 	 * @return Graph
 	 */
-	public function add_references( $refs ) {
-		Assertions::is_array( $refs );
+	public function add_references($refs) {
+		Assertions::is_array($refs);
 
-		foreach ( $refs as $ref ) {
-			$this->referenced_content_ids[] = Wordpress_Content_Id::create_post( $ref );
+		foreach ($refs as $ref) {
+			$this->referenced_content_ids[] = Wordpress_Content_Id::create_post($ref);
 		}
 		return $this;
 	}
@@ -73,21 +73,21 @@ 
 	 *
 	 * @return Graph
 	 */
-	public function add_required_reference_infos( $references_infos ) {
+	public function add_required_reference_infos($references_infos) {
 
 		/**
 		 * @var $required_references array<\Wordlift_Property_Entity_Reference>
 		 */
 		$required_references = array_filter(
 			$references_infos,
-			function ( $item ) {
-				return isset( $item['reference'] ) &&
+			function($item) {
+				return isset($item['reference']) &&
 					   // Check that the reference is required
 					   $item['reference']->get_required();
 			}
 		);
 
-		foreach ( $required_references as $required_reference ) {
+		foreach ($required_references as $required_reference) {
 			$this->referenced_content_ids[] = new Wordpress_Content_Id(
 				$required_reference->get_id(),
 				$required_reference->get_type()
@@ -102,9 +102,9 @@ 
 	 *
 	 * @return Graph
 	 */
-	public function add_relations( $relations ) {
+	public function add_relations($relations) {
 
-		foreach ( $relations->toArray() as $relation ) {
+		foreach ($relations->toArray() as $relation) {
 
 			$this->referenced_content_ids[] = $relation->get_object();
 
@@ -118,21 +118,21 @@ 
 	 * @param $context int
 	 * @return array|bool
 	 */
-	private function expand( $content_id, $context ) {
+	private function expand($content_id, $context) {
 		$object_id   = $content_id->get_id();
 		$object_type = $content_id->get_type();
 
-		if ( $object_type === Object_Type_Enum::POST ) {
+		if ($object_type === Object_Type_Enum::POST) {
 			$references     = array();
 			$reference_info = array();
 			$relations      = new Relations();
-			return $this->post_converter->convert( $object_id, $references, $reference_info, $relations );
-		} elseif ( $object_type === Object_Type_Enum::TERM ) {
+			return $this->post_converter->convert($object_id, $references, $reference_info, $relations);
+		} elseif ($object_type === Object_Type_Enum::TERM) {
 			// Skip the Uncategorized term.
-			if ( 1 === $object_id ) {
+			if (1 === $object_id) {
 				return false;
 			}
-			return $this->term_converter->get( $object_id, $context );
+			return $this->term_converter->get($object_id, $context);
 		} else {
 			return false;
 		}
@@ -143,22 +143,22 @@ 
 	 *
 	 * @return array
 	 */
-	public function render( $context ) {
+	public function render($context) {
 
 		/**
 		 * This is possible because the toString() method of
 		 * Wordpress_Content_Id is used to get the unique value.
 		 */
-		$unique_content_ids = array_unique( $this->referenced_content_ids, SORT_STRING );
+		$unique_content_ids = array_unique($this->referenced_content_ids, SORT_STRING);
 
-		$result = array( $this->main_jsonld );
+		$result = array($this->main_jsonld);
 
-		foreach ( $unique_content_ids as $unique_content_id ) {
-			$result[] = $this->expand( $unique_content_id, $context );
+		foreach ($unique_content_ids as $unique_content_id) {
+			$result[] = $this->expand($unique_content_id, $context);
 		}
 
 		// Filter out the false and empty results.
-		return array_filter( $result );
+		return array_filter($result);
 
 	}
 

src/wordlift/jsonld/class-jsonld-article-wrapper.php

Indentation +152 added lines, -152 removed lines

@@ -7,167 +7,167 @@
 
 class Jsonld_Article_Wrapper {
 
-	public static $article_types = array(
-		'Article',
-		'AdvertiserContentArticle',
-		'NewsArticle',
-		'AnalysisNewsArticle',
-		'AskPublicNewsArticle',
-		'BackgroundNewsArticle',
-		'OpinionNewsArticle',
-		'ReportageNewsArticle',
-		'ReviewNewsArticle',
-		'Report',
-		'SatiricalArticle',
-		'ScholarlyArticle',
-		'MedicalScholarlyArticle',
-		'SocialMediaPosting',
-		'BlogPosting',
-		'LiveBlogPosting',
-		'DiscussionForumPosting',
-		'TechArticle',
-		'APIReference',
-	);
-
-	/**
-	 * @var Wordlift_Post_To_Jsonld_Converter
-	 */
-	private $post_to_jsonld_converter;
-	/**
-	 * @var \Wordlift_Cached_Post_Converter
-	 */
-	private $cached_postid_to_jsonld_converter;
-	/**
-	 * @var \Wordlift_Entity_Uri_Service
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * Jsonld_Article_Wrapper constructor.
-	 *
-	 * @param Wordlift_Post_To_Jsonld_Converter $post_to_jsonld_converter
-	 * @param $cached_postid_to_jsonld_converter
-	 */
-	public function __construct( $post_to_jsonld_converter, $cached_postid_to_jsonld_converter ) {
-
-		$this->post_to_jsonld_converter = $post_to_jsonld_converter->new_instance_with_filters_disabled();
-
-		add_filter(
-			'wl_after_get_jsonld',
-			array(
-				$this,
-				'after_get_jsonld',
-			),
-			PHP_INT_MAX - 100,
-			3
-		);
-
-		$this->cached_postid_to_jsonld_converter = $cached_postid_to_jsonld_converter;
-
-		$this->entity_uri_service = \Wordlift_Entity_Uri_Service::get_instance();
-	}
-
-	public function after_get_jsonld( $jsonld, $post_id, $context ) {
-
-		// Invalid data structure
-		if ( ! is_array( $jsonld ) || ! isset( $jsonld[0] ) || ! is_array( $jsonld[0] ) ) {
-			return $jsonld;
-		}
-
-		if ( Jsonld_Context_Enum::PAGE !== $context
-			 // Returns true for "1", "true", "on" and "yes". Returns false otherwise.
-			 && ! filter_input( INPUT_GET, 'article_wrapper', FILTER_VALIDATE_BOOLEAN ) ) {
-			return $jsonld;
-		}
-
-		// Copy the 1st array element
-		$post_jsonld = $jsonld[0];
-
-		// Don't wrap in article if the json-ld is already about an Article (or its descendants). `@type` must be
-		// in the schema.org context, i.e. `Article`, not `http://schema.org/Article`.
-		if ( ! isset( $post_jsonld['@id'] ) || ! isset( $post_jsonld['@type'] ) || $this->is_article( $post_jsonld['@type'] ) ) {
-			return $jsonld;
-		}
-
-		$references      = array();
-		$reference_infos = array();
-
-		// Convert the post as Article.
-		$article_jsonld = $this->post_to_jsonld_converter->convert( $post_id, $references, $reference_infos, new Relations() );
-
-		$article_jsonld['@id'] = $post_jsonld['@id'] . '#article';
-		// Reset the type, since by default the type assigned via the Entity Type taxonomy is used.
-		$article_jsonld['@type'] = 'Article';
-		$article_jsonld['about'] = array( '@id' => $post_jsonld['@id'] );
-
-		// Copy over the URLs.
-		if ( isset( $post_jsonld['url'] ) ) {
-			$article_jsonld['url'] = $post_jsonld['url'];
-		}
-
-		array_unshift( $jsonld, $article_jsonld );
-
-		$author_jsonld = $this->get_author_linked_entity( $article_jsonld );
-
-		/**
-		 * The author entities can be present in graph for some entity types
-		 * for Person and Organization, so check before we add it to graph.
-		 * reference : https://schema.org/author
-		 */
-		if ( $author_jsonld && ! $this->is_author_entity_present_in_graph( $jsonld, $article_jsonld['author']['@id'] ) ) {
-			$jsonld[] = $author_jsonld;
-		}
-
-		return $jsonld;
-	}
-
-	private function is_article( $schema_types ) {
-
-		$array_intersect = array_intersect( self::$article_types, (array) $schema_types );
-
-		return ! empty( $array_intersect );
-	}
-
-	private function get_author_linked_entity( $article_jsonld ) {
-		if ( ! array_key_exists( 'author', $article_jsonld ) ) {
-			return false;
-		}
-
-		$author = $article_jsonld['author'];
+    public static $article_types = array(
+        'Article',
+        'AdvertiserContentArticle',
+        'NewsArticle',
+        'AnalysisNewsArticle',
+        'AskPublicNewsArticle',
+        'BackgroundNewsArticle',
+        'OpinionNewsArticle',
+        'ReportageNewsArticle',
+        'ReviewNewsArticle',
+        'Report',
+        'SatiricalArticle',
+        'ScholarlyArticle',
+        'MedicalScholarlyArticle',
+        'SocialMediaPosting',
+        'BlogPosting',
+        'LiveBlogPosting',
+        'DiscussionForumPosting',
+        'TechArticle',
+        'APIReference',
+    );
+
+    /**
+     * @var Wordlift_Post_To_Jsonld_Converter
+     */
+    private $post_to_jsonld_converter;
+    /**
+     * @var \Wordlift_Cached_Post_Converter
+     */
+    private $cached_postid_to_jsonld_converter;
+    /**
+     * @var \Wordlift_Entity_Uri_Service
+     */
+    private $entity_uri_service;
+
+    /**
+     * Jsonld_Article_Wrapper constructor.
+     *
+     * @param Wordlift_Post_To_Jsonld_Converter $post_to_jsonld_converter
+     * @param $cached_postid_to_jsonld_converter
+     */
+    public function __construct( $post_to_jsonld_converter, $cached_postid_to_jsonld_converter ) {
+
+        $this->post_to_jsonld_converter = $post_to_jsonld_converter->new_instance_with_filters_disabled();
+
+        add_filter(
+            'wl_after_get_jsonld',
+            array(
+                $this,
+                'after_get_jsonld',
+            ),
+            PHP_INT_MAX - 100,
+            3
+        );
+
+        $this->cached_postid_to_jsonld_converter = $cached_postid_to_jsonld_converter;
+
+        $this->entity_uri_service = \Wordlift_Entity_Uri_Service::get_instance();
+    }
+
+    public function after_get_jsonld( $jsonld, $post_id, $context ) {
+
+        // Invalid data structure
+        if ( ! is_array( $jsonld ) || ! isset( $jsonld[0] ) || ! is_array( $jsonld[0] ) ) {
+            return $jsonld;
+        }
+
+        if ( Jsonld_Context_Enum::PAGE !== $context
+                // Returns true for "1", "true", "on" and "yes". Returns false otherwise.
+             && ! filter_input( INPUT_GET, 'article_wrapper', FILTER_VALIDATE_BOOLEAN ) ) {
+            return $jsonld;
+        }
+
+        // Copy the 1st array element
+        $post_jsonld = $jsonld[0];
+
+        // Don't wrap in article if the json-ld is already about an Article (or its descendants). `@type` must be
+        // in the schema.org context, i.e. `Article`, not `http://schema.org/Article`.
+        if ( ! isset( $post_jsonld['@id'] ) || ! isset( $post_jsonld['@type'] ) || $this->is_article( $post_jsonld['@type'] ) ) {
+            return $jsonld;
+        }
+
+        $references      = array();
+        $reference_infos = array();
+
+        // Convert the post as Article.
+        $article_jsonld = $this->post_to_jsonld_converter->convert( $post_id, $references, $reference_infos, new Relations() );
+
+        $article_jsonld['@id'] = $post_jsonld['@id'] . '#article';
+        // Reset the type, since by default the type assigned via the Entity Type taxonomy is used.
+        $article_jsonld['@type'] = 'Article';
+        $article_jsonld['about'] = array( '@id' => $post_jsonld['@id'] );
+
+        // Copy over the URLs.
+        if ( isset( $post_jsonld['url'] ) ) {
+            $article_jsonld['url'] = $post_jsonld['url'];
+        }
+
+        array_unshift( $jsonld, $article_jsonld );
+
+        $author_jsonld = $this->get_author_linked_entity( $article_jsonld );
+
+        /**
+         * The author entities can be present in graph for some entity types
+         * for Person and Organization, so check before we add it to graph.
+         * reference : https://schema.org/author
+         */
+        if ( $author_jsonld && ! $this->is_author_entity_present_in_graph( $jsonld, $article_jsonld['author']['@id'] ) ) {
+            $jsonld[] = $author_jsonld;
+        }
+
+        return $jsonld;
+    }
+
+    private function is_article( $schema_types ) {
+
+        $array_intersect = array_intersect( self::$article_types, (array) $schema_types );
+
+        return ! empty( $array_intersect );
+    }
+
+    private function get_author_linked_entity( $article_jsonld ) {
+        if ( ! array_key_exists( 'author', $article_jsonld ) ) {
+            return false;
+        }
+
+        $author = $article_jsonld['author'];
 
-		if ( count( array_keys( $author ) ) !== 1 || ! array_key_exists( '@id', $author ) ) {
-			return false;
-		}
+        if ( count( array_keys( $author ) ) !== 1 || ! array_key_exists( '@id', $author ) ) {
+            return false;
+        }
 
-		$author_linked_entity_id = $author['@id'];
+        $author_linked_entity_id = $author['@id'];
 
-		$author_entity_post = $this->entity_uri_service->get_entity( $author_linked_entity_id );
+        $author_entity_post = $this->entity_uri_service->get_entity( $author_linked_entity_id );
 
-		if ( ! $author_entity_post instanceof \WP_Post ) {
-			return false;
-		}
+        if ( ! $author_entity_post instanceof \WP_Post ) {
+            return false;
+        }
 
-		$references      = array();
-		$reference_infos = array();
+        $references      = array();
+        $reference_infos = array();
 
-		return $this->cached_postid_to_jsonld_converter->convert(
-			$author_entity_post->ID,
-			$references,
-			$reference_infos,
-			new Relations()
-		);
+        return $this->cached_postid_to_jsonld_converter->convert(
+            $author_entity_post->ID,
+            $references,
+            $reference_infos,
+            new Relations()
+        );
 
-	}
+    }
 
-	private function is_author_entity_present_in_graph( $jsonld, $author_entity_id ) {
+    private function is_author_entity_present_in_graph( $jsonld, $author_entity_id ) {
 
-		foreach ( $jsonld as $item ) {
-			if ( $item && array_key_exists( '@id', $item ) && $item['@id'] === $author_entity_id ) {
-				return true;
-			}
-		}
+        foreach ( $jsonld as $item ) {
+            if ( $item && array_key_exists( '@id', $item ) && $item['@id'] === $author_entity_id ) {
+                return true;
+            }
+        }
 
-		return false;
-	}
+        return false;
+    }
 
 }

Spacing +24 added lines, -24 removed lines

@@ -48,7 +48,7 @@ 
 	 * @param Wordlift_Post_To_Jsonld_Converter $post_to_jsonld_converter
 	 * @param $cached_postid_to_jsonld_converter
 	 */
-	public function __construct( $post_to_jsonld_converter, $cached_postid_to_jsonld_converter ) {
+	public function __construct($post_to_jsonld_converter, $cached_postid_to_jsonld_converter) {
 
 		$this->post_to_jsonld_converter = $post_to_jsonld_converter->new_instance_with_filters_disabled();
 
@@ -67,16 +67,16 @@ 
 		$this->entity_uri_service = \Wordlift_Entity_Uri_Service::get_instance();
 	}
 
-	public function after_get_jsonld( $jsonld, $post_id, $context ) {
+	public function after_get_jsonld($jsonld, $post_id, $context) {
 
 		// Invalid data structure
-		if ( ! is_array( $jsonld ) || ! isset( $jsonld[0] ) || ! is_array( $jsonld[0] ) ) {
+		if ( ! is_array($jsonld) || ! isset($jsonld[0]) || ! is_array($jsonld[0])) {
 			return $jsonld;
 		}
 
-		if ( Jsonld_Context_Enum::PAGE !== $context
+		if (Jsonld_Context_Enum::PAGE !== $context
 			 // Returns true for "1", "true", "on" and "yes". Returns false otherwise.
-			 && ! filter_input( INPUT_GET, 'article_wrapper', FILTER_VALIDATE_BOOLEAN ) ) {
+			 && ! filter_input(INPUT_GET, 'article_wrapper', FILTER_VALIDATE_BOOLEAN)) {
 			return $jsonld;
 		}
 
@@ -85,7 +85,7 @@ 
 
 		// Don't wrap in article if the json-ld is already about an Article (or its descendants). `@type` must be
 		// in the schema.org context, i.e. `Article`, not `http://schema.org/Article`.
-		if ( ! isset( $post_jsonld['@id'] ) || ! isset( $post_jsonld['@type'] ) || $this->is_article( $post_jsonld['@type'] ) ) {
+		if ( ! isset($post_jsonld['@id']) || ! isset($post_jsonld['@type']) || $this->is_article($post_jsonld['@type'])) {
 			return $jsonld;
 		}
 
@@ -93,57 +93,57 @@ 
 		$reference_infos = array();
 
 		// Convert the post as Article.
-		$article_jsonld = $this->post_to_jsonld_converter->convert( $post_id, $references, $reference_infos, new Relations() );
+		$article_jsonld = $this->post_to_jsonld_converter->convert($post_id, $references, $reference_infos, new Relations());
 
-		$article_jsonld['@id'] = $post_jsonld['@id'] . '#article';
+		$article_jsonld['@id'] = $post_jsonld['@id'].'#article';
 		// Reset the type, since by default the type assigned via the Entity Type taxonomy is used.
 		$article_jsonld['@type'] = 'Article';
-		$article_jsonld['about'] = array( '@id' => $post_jsonld['@id'] );
+		$article_jsonld['about'] = array('@id' => $post_jsonld['@id']);
 
 		// Copy over the URLs.
-		if ( isset( $post_jsonld['url'] ) ) {
+		if (isset($post_jsonld['url'])) {
 			$article_jsonld['url'] = $post_jsonld['url'];
 		}
 
-		array_unshift( $jsonld, $article_jsonld );
+		array_unshift($jsonld, $article_jsonld);
 
-		$author_jsonld = $this->get_author_linked_entity( $article_jsonld );
+		$author_jsonld = $this->get_author_linked_entity($article_jsonld);
 
 		/**
 		 * The author entities can be present in graph for some entity types
 		 * for Person and Organization, so check before we add it to graph.
 		 * reference : https://schema.org/author
 		 */
-		if ( $author_jsonld && ! $this->is_author_entity_present_in_graph( $jsonld, $article_jsonld['author']['@id'] ) ) {
+		if ($author_jsonld && ! $this->is_author_entity_present_in_graph($jsonld, $article_jsonld['author']['@id'])) {
 			$jsonld[] = $author_jsonld;
 		}
 
 		return $jsonld;
 	}
 
-	private function is_article( $schema_types ) {
+	private function is_article($schema_types) {
 
-		$array_intersect = array_intersect( self::$article_types, (array) $schema_types );
+		$array_intersect = array_intersect(self::$article_types, (array) $schema_types);
 
-		return ! empty( $array_intersect );
+		return ! empty($array_intersect);
 	}
 
-	private function get_author_linked_entity( $article_jsonld ) {
-		if ( ! array_key_exists( 'author', $article_jsonld ) ) {
+	private function get_author_linked_entity($article_jsonld) {
+		if ( ! array_key_exists('author', $article_jsonld)) {
 			return false;
 		}
 
 		$author = $article_jsonld['author'];
 
-		if ( count( array_keys( $author ) ) !== 1 || ! array_key_exists( '@id', $author ) ) {
+		if (count(array_keys($author)) !== 1 || ! array_key_exists('@id', $author)) {
 			return false;
 		}
 
 		$author_linked_entity_id = $author['@id'];
 
-		$author_entity_post = $this->entity_uri_service->get_entity( $author_linked_entity_id );
+		$author_entity_post = $this->entity_uri_service->get_entity($author_linked_entity_id);
 
-		if ( ! $author_entity_post instanceof \WP_Post ) {
+		if ( ! $author_entity_post instanceof \WP_Post) {
 			return false;
 		}
 
@@ -159,10 +159,10 @@ 
 
 	}
 
-	private function is_author_entity_present_in_graph( $jsonld, $author_entity_id ) {
+	private function is_author_entity_present_in_graph($jsonld, $author_entity_id) {
 
-		foreach ( $jsonld as $item ) {
-			if ( $item && array_key_exists( '@id', $item ) && $item['@id'] === $author_entity_id ) {
+		foreach ($jsonld as $item) {
+			if ($item && array_key_exists('@id', $item) && $item['@id'] === $author_entity_id) {
 				return true;
 			}
 		}

src/wordlift/analysis/occurrences/class-occurrences.php

Indentation +4 added lines, -4 removed lines

@@ -10,9 +10,9 @@
 
 interface Occurrences {
 
-	/**
-	 * @return array Return json data structure.
-	 */
-	public function add_occurrences_to_entities( $occurrences, $json, $post_id );
+    /**
+     * @return array Return json data structure.
+     */
+    public function add_occurrences_to_entities( $occurrences, $json, $post_id );
 
 }

Spacing +1 added lines, -1 removed lines

@@ -13,6 +13,6 @@
 	/**
 	 * @return array Return json data structure.
 	 */
-	public function add_occurrences_to_entities( $occurrences, $json, $post_id );
+	public function add_occurrences_to_entities($occurrences, $json, $post_id);
 
 }

src/wordlift/analysis/occurrences/class-default-strategy.php

Indentation +12 added lines, -12 removed lines

@@ -11,20 +11,20 @@
 
 class Default_Strategy extends Singleton implements Occurrences {
 
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function add_occurrences_to_entities( $occurrences, $json, $post_id ) {
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function add_occurrences_to_entities( $occurrences, $json, $post_id ) {
 
-		foreach ( $json->entities as $id => $entity ) {
+        foreach ( $json->entities as $id => $entity ) {
 
-			$json->entities->{$id}->occurrences = isset( $occurrences[ $id ] ) ? $occurrences[ $id ] : array();
+            $json->entities->{$id}->occurrences = isset( $occurrences[ $id ] ) ? $occurrences[ $id ] : array();
 
-			foreach ( $json->entities->{$id}->occurrences as $annotation_id ) {
-				$json->entities->{$id}->annotations[ $annotation_id ] = array(
-					'id' => $annotation_id,
-				);
-			}
-		}
+            foreach ( $json->entities->{$id}->occurrences as $annotation_id ) {
+                $json->entities->{$id}->annotations[ $annotation_id ] = array(
+                    'id' => $annotation_id,
+                );
+            }
+        }
 
-		return $json;
-	}
+        return $json;
+    }
 }

Spacing +5 added lines, -5 removed lines

@@ -12,14 +12,14 @@
 class Default_Strategy extends Singleton implements Occurrences {
 
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function add_occurrences_to_entities( $occurrences, $json, $post_id ) {
+	public function add_occurrences_to_entities($occurrences, $json, $post_id) {
 
-		foreach ( $json->entities as $id => $entity ) {
+		foreach ($json->entities as $id => $entity) {
 
-			$json->entities->{$id}->occurrences = isset( $occurrences[ $id ] ) ? $occurrences[ $id ] : array();
+			$json->entities->{$id}->occurrences = isset($occurrences[$id]) ? $occurrences[$id] : array();
 
-			foreach ( $json->entities->{$id}->occurrences as $annotation_id ) {
-				$json->entities->{$id}->annotations[ $annotation_id ] = array(
+			foreach ($json->entities->{$id}->occurrences as $annotation_id) {
+				$json->entities->{$id}->annotations[$annotation_id] = array(
 					'id' => $annotation_id,
 				);
 			}

src/wordlift/analysis/response/class-analysis-response-ops.php

Indentation +377 added lines, -377 removed lines

@@ -16,382 +16,382 @@
 
 class Analysis_Response_Ops {
 
-	/**
-	 * The analysis response json.
-	 *
-	 * @since 3.21.5
-	 * @access private
-	 * @var mixed $json Holds the analysis response json.
-	 */
-	private $json;
-
-	/**
-	 * Holds the {@link Wordlift_Entity_Uri_Service}.
-	 *
-	 * @since 3.21.5
-	 * @access private
-	 * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * @var Entity_Helper
-	 */
-	private $entity_helper;
-
-	/**
-	 * @var int $post_id
-	 */
-	private $post_id;
-
-	/**
-	 * Analysis_Response_Ops constructor.
-	 *
-	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service}.
-	 * @param Entity_Helper                $entity_helper The {@link Entity_Helper}.
-	 * @param mixed                        $json The analysis response json.
-	 *
-	 * @since 3.21.5
-	 */
-	public function __construct( $entity_uri_service, $entity_helper, $json, $post_id ) {
-		$this->json               = $json;
-		$this->entity_uri_service = $entity_uri_service;
-		$this->entity_helper      = $entity_helper;
-		$this->post_id            = $post_id;
-	}
-
-	/**
-	 * Switches remote entities, i.e. entities with id outside the local dataset, to local entities.
-	 *
-	 * The function takes all the entities that have an id which is not local. For each remote entity, a list of URIs
-	 * is built comprising the entity id and the sameAs. Then a query is issued in the local database to find potential
-	 * matches from the local vocabulary.
-	 *
-	 * If found, the entity id is swapped with the local id and the remote id is added to the sameAs.
-	 *
-	 * @return Analysis_Response_Ops The current Analysis_Response_Ops instance.
-	 */
-	public function make_entities_local() {
-
-		if ( ! isset( $this->json->entities ) ) {
-			return $this;
-		}
-
-		// Get the URIs.
-		$uris     = array_keys( get_object_vars( $this->json->entities ) );
-		$mappings = $this->entity_helper->map_many_to_local( $uris );
-
-		foreach ( $mappings as $external_uri => $internal_uri ) {
-
-			// Move the data from the external URI to the internal URI.
-			if ( ! isset( $this->json->entities->{$internal_uri} ) ) {
-				$this->json->entities->{$internal_uri} = $this->json->entities->{$external_uri};
-			}
-
-			// Ensure sameAs is an array.
-			if ( ! isset( $this->json->entities->{$internal_uri}->sameAs )
-				 || ! is_array( $this->json->entities->{$internal_uri}->sameAs ) ) {
-				$this->json->entities->{$internal_uri}->sameAs = array();
-			}
-
-			// Add the external URI as sameAs.
-			$this->json->entities->{$internal_uri}->sameAs[] = $external_uri;
-
-			// Finally remove the external URI.
-			unset( $this->json->entities->{$external_uri} );
-		}
-
-		// Set the internal uri in the annotation for the entityMatch in annotations.
-		if ( isset( $this->json->annotations ) ) {
-			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			foreach ( $this->json->annotations as $key => $annotation ) {
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( isset( $annotation->entityMatches ) ) {
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					foreach ( $annotation->entityMatches as $match ) {
-						// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-						if ( isset( $match->entityId ) && isset( $mappings[ $match->entityId ] ) ) {
-							// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-							$match->entityId = $mappings[ $match->entityId ];
-						}
-					}
-				}
-			}
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Add occurrences by parsing the provided html content.
-	 *
-	 * @param string $content The html content with annotations.
-	 *
-	 * @return Analysis_Response_Ops The {@link Analysis_Response_Ops} instance.
-	 *
-	 * @since 3.23.7 refactor the regex pattern to take into account that there might be css classes between textannotation
-	 *  and disambiguated.
-	 *
-	 * @link https://github.com/insideout10/wordlift-plugin/issues/1001
-	 */
-	public function add_occurrences( $content ) {
-
-		// Try to get all the disambiguated annotations and bail out if an error occurs.
-		if ( false === preg_match_all(
-			'|<span\s+id="([^"]+)"\s+class="textannotation\s+(?:\S+\s+)?disambiguated(?=[\s"])[^"]*"\s+itemid="([^"]*)">(.*?)</span>|',
-			$content,
-			$matches,
-			PREG_OFFSET_CAPTURE
-		) ) {
-			return $this;
-		}
-
-		if ( empty( $matches ) ) {
-			return $this;
-		}
-
-		$parse_data = array_reduce(
-			range( 0, count( $matches[1] ) - 1 ),
-			function ( $carry, $i ) use ( $matches ) {
-				if ( empty( $matches[0] ) ) {
-					return $carry;
-				}
-
-				$start         = $matches[0][ $i ][1];
-				$end           = $start + strlen( $matches[0][ $i ][0] );
-				$annotation_id = $matches[1][ $i ][0];
-				$item_id       = $matches[2][ $i ][0];
-				$text          = $matches[3][ $i ][0];
-
-				$annotation = new StdClass();
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				$annotation->annotationId = $annotation_id;
-				$annotation->start        = $start;
-				$annotation->end          = $end;
-				$annotation->text         = $text;
-
-				$entity_match             = new StdClass();
-				$entity_match->confidence = 100;
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				$entity_match->entityId = $item_id;
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				$annotation->entityMatches[] = $entity_match;
-
-				$carry['annotations'][ $annotation_id ] = $annotation;
-				$carry['occurrences'][ $item_id ][]     = $annotation_id;
-
-				return $carry;
-			},
-			array(
-				'annotations' => array(),
-				'occurrences' => array(),
-			)
-		);
-
-		$annotations = $parse_data['annotations'];
-		$occurrences = $parse_data['occurrences'];
-
-		$entity_provider_registry = Entity_Provider_Registry::get_instance();
-
-		foreach ( array_keys( $occurrences ) as $item_id ) {
-
-			// If the entity isn't there, add it.
-			if ( ! is_bool( $this->json ) && ! isset( $this->json->entities->{$item_id} ) ) {
-				$entity = $entity_provider_registry->get_local_entity( $item_id );
-
-				// Entity not found in the local vocabulary, continue to the next one.
-				if ( false === $entity ) {
-					continue;
-				}
-
-				$this->json->entities->{$item_id} = $entity;
-			}
-		}
-
-		// Here we're adding back some data structures required by the client-side code.
-		//
-		// We're adding:
-		// 1. the .entities[entity_id].occurrences array with the annotations' ids.
-		// 2. the .entities[entity_id].annotations[annotation_id] = { id: annotation_id } map.
-		//
-		// Before 3.23.0 this was done by the client-side code located in src/coffee/editpost-widget/app.services.AnalysisService.coffee
-		// function `preselect`, which was called by src/coffee/editpost-widget/app.services.EditorService.coffee in
-		// `embedAnalysis`.
-
-		if ( ! is_bool( $this->json ) && isset( $this->json->entities ) ) {
-			$occurrences_processor = Occurrences_Factory::get_instance( $this->post_id );
-			$this->json            = $occurrences_processor->add_occurrences_to_entities( $occurrences, $this->json, $this->post_id );
-		}
-
-		// Add the missing annotations. This allows the analysis response to work also if we didn't receive results
-		// from the analysis API.
-		foreach ( $annotations as $annotation_id => $annotation ) {
-
-			if ( ! is_bool( $this->json ) && ! isset( $this->json->annotations->{$annotation_id} ) ) {
-				$this->json->annotations->{$annotation_id} = $annotation;
-			}
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Add local entities
-	 *
-	 * @return Analysis_Response_Ops The {@link Analysis_Response_Ops} instance.
-	 *
-	 * @since 3.27.6
-	 *
-	 * @link https://github.com/insideout10/wordlift-plugin/issues/1178
-	 */
-	public function add_local_entities() {
-
-		// Populating the local entities object
-		$entities = array();
-		foreach ( $this->json->annotations as $annotation ) {
-			// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-			foreach ( $annotation->entityMatches as $entity_matches ) {
-
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				$entity_id         = $this->entity_uri_service->get_post_id_from_url( $entity_matches->entityId );
-				$serialized_entity = wl_serialize_entity( $entity_id );
-
-				if ( $serialized_entity ) {
-					$serialized_entity['entityId'] = $serialized_entity['id'];
-					unset( $serialized_entity['id'] );
-
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_matches->entityId ] = $serialized_entity;
-				}
-			}
-		}
-
-		// Adding occurrences and annotations data structures required by the client-side code.
-		foreach ( $entities as $entity_id => $entity ) {
-			foreach ( $this->json->annotations as $annotation ) {
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( $annotation->entityMatches[0]->entityId === $entity_id ) {
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_id ]['occurrences'][] = $annotation->annotationId;
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_id ]['annotations'][ $annotation->annotationId ]['id'] = $annotation->annotationId;
-				}
-			}
-		}
-
-		$this->json->entities = $entities;
-
-		return $this;
-
-	}
-
-	/**
-	 * Return the JSON response.
-	 *
-	 * @return mixed The JSON response.
-	 * @since 3.24.2
-	 */
-	public function get_json() {
-
-		return $this->json;
-	}
-
-	/**
-	 * This function should be invoked after `make_entities_local` after this
-	 * method.
-	 *
-	 * @param $excluded_uris array An array of entity URIs to be excluded.
-	 *
-	 * @return $this
-	 * @since 3.32.3.1
-	 */
-	public function remove_excluded_entities( $excluded_uris ) {
-
-		// If we didnt receive array, return early.
-		if ( ! is_array( $excluded_uris ) ) {
-			return $this;
-		}
-
-		// We may also receive an array of null, make sure to filter uris when receiving.
-		$excluded_uris = array_filter( $excluded_uris, 'is_string' );
-
-		$this->remove_entities_with_excluded_uris( $excluded_uris );
-
-		$this->remove_annotations_with_excluded_uris( $excluded_uris );
-
-		return $this;
-	}
-
-	/**
-	 * Get the string representation of the JSON.
-	 *
-	 * @return false|string The string representation or false in case of error.
-	 */
-	public function to_string() {
-
-		// Add the `JSON_UNESCAPED_UNICODE` only for PHP 5.4+.
-		$options = ( version_compare( PHP_VERSION, '5.4', '>=' )
-			? 256 : 0 );
-
-		return wp_json_encode( $this->json, $options );
-	}
-
-	/**
-	 * Remove all the entities with the excluded URIs.
-	 *
-	 * @param array $excluded_uris The array of URIs to be excluded.
-	 */
-	private function remove_entities_with_excluded_uris( array $excluded_uris ) {
-		// Remove the excluded entity uris.
-		if ( isset( $this->json->entities ) ) {
-			foreach ( $excluded_uris as $excluded_uri ) {
-
-				if ( isset( $this->json->entities->{$excluded_uri} ) ) {
-					// Remove this entity.
-					unset( $this->json->entities->{$excluded_uri} );
-					// Also remove the annotations.
-				}
-			}
-		}
-	}
-
-	/**
-	 * Remove all the annotations with the excluded entity URIs.
-	 *
-	 * @param array $excluded_uris The array of URIs to be excluded.
-	 *
-	 * @return void
-	 */
-	private function remove_annotations_with_excluded_uris( array $excluded_uris ) {
-		if ( isset( $this->json->annotations ) ) {
-			foreach ( $this->json->annotations as $annotation_key => &$annotation_data ) {
-
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( ! isset( $annotation_data->entityMatches ) ) {
-					continue;
-				}
-
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				foreach ( $annotation_data->entityMatches as $entity_match_key => $entity_match_data ) {
-
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entity_uri = $entity_match_data->entityId;
-
-					if ( ! in_array( $entity_uri, $excluded_uris, true ) ) {
-						continue;
-					}
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					unset( $annotation_data->entityMatches[ $entity_match_key ] );
-				}
-
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( count( $annotation_data->entityMatches ) === 0 ) {
-					// Remove the annotation if we have zero empty annotation matches.
-					unset( $this->json->annotations->{$annotation_key} );
-				}
-			}
-		}
-
-	}
+    /**
+     * The analysis response json.
+     *
+     * @since 3.21.5
+     * @access private
+     * @var mixed $json Holds the analysis response json.
+     */
+    private $json;
+
+    /**
+     * Holds the {@link Wordlift_Entity_Uri_Service}.
+     *
+     * @since 3.21.5
+     * @access private
+     * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    private $entity_uri_service;
+
+    /**
+     * @var Entity_Helper
+     */
+    private $entity_helper;
+
+    /**
+     * @var int $post_id
+     */
+    private $post_id;
+
+    /**
+     * Analysis_Response_Ops constructor.
+     *
+     * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service}.
+     * @param Entity_Helper                $entity_helper The {@link Entity_Helper}.
+     * @param mixed                        $json The analysis response json.
+     *
+     * @since 3.21.5
+     */
+    public function __construct( $entity_uri_service, $entity_helper, $json, $post_id ) {
+        $this->json               = $json;
+        $this->entity_uri_service = $entity_uri_service;
+        $this->entity_helper      = $entity_helper;
+        $this->post_id            = $post_id;
+    }
+
+    /**
+     * Switches remote entities, i.e. entities with id outside the local dataset, to local entities.
+     *
+     * The function takes all the entities that have an id which is not local. For each remote entity, a list of URIs
+     * is built comprising the entity id and the sameAs. Then a query is issued in the local database to find potential
+     * matches from the local vocabulary.
+     *
+     * If found, the entity id is swapped with the local id and the remote id is added to the sameAs.
+     *
+     * @return Analysis_Response_Ops The current Analysis_Response_Ops instance.
+     */
+    public function make_entities_local() {
+
+        if ( ! isset( $this->json->entities ) ) {
+            return $this;
+        }
+
+        // Get the URIs.
+        $uris     = array_keys( get_object_vars( $this->json->entities ) );
+        $mappings = $this->entity_helper->map_many_to_local( $uris );
+
+        foreach ( $mappings as $external_uri => $internal_uri ) {
+
+            // Move the data from the external URI to the internal URI.
+            if ( ! isset( $this->json->entities->{$internal_uri} ) ) {
+                $this->json->entities->{$internal_uri} = $this->json->entities->{$external_uri};
+            }
+
+            // Ensure sameAs is an array.
+            if ( ! isset( $this->json->entities->{$internal_uri}->sameAs )
+                 || ! is_array( $this->json->entities->{$internal_uri}->sameAs ) ) {
+                $this->json->entities->{$internal_uri}->sameAs = array();
+            }
+
+            // Add the external URI as sameAs.
+            $this->json->entities->{$internal_uri}->sameAs[] = $external_uri;
+
+            // Finally remove the external URI.
+            unset( $this->json->entities->{$external_uri} );
+        }
+
+        // Set the internal uri in the annotation for the entityMatch in annotations.
+        if ( isset( $this->json->annotations ) ) {
+            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+            foreach ( $this->json->annotations as $key => $annotation ) {
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                if ( isset( $annotation->entityMatches ) ) {
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    foreach ( $annotation->entityMatches as $match ) {
+                        // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                        if ( isset( $match->entityId ) && isset( $mappings[ $match->entityId ] ) ) {
+                            // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                            $match->entityId = $mappings[ $match->entityId ];
+                        }
+                    }
+                }
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Add occurrences by parsing the provided html content.
+     *
+     * @param string $content The html content with annotations.
+     *
+     * @return Analysis_Response_Ops The {@link Analysis_Response_Ops} instance.
+     *
+     * @since 3.23.7 refactor the regex pattern to take into account that there might be css classes between textannotation
+     *  and disambiguated.
+     *
+     * @link https://github.com/insideout10/wordlift-plugin/issues/1001
+     */
+    public function add_occurrences( $content ) {
+
+        // Try to get all the disambiguated annotations and bail out if an error occurs.
+        if ( false === preg_match_all(
+            '|<span\s+id="([^"]+)"\s+class="textannotation\s+(?:\S+\s+)?disambiguated(?=[\s"])[^"]*"\s+itemid="([^"]*)">(.*?)</span>|',
+            $content,
+            $matches,
+            PREG_OFFSET_CAPTURE
+        ) ) {
+            return $this;
+        }
+
+        if ( empty( $matches ) ) {
+            return $this;
+        }
+
+        $parse_data = array_reduce(
+            range( 0, count( $matches[1] ) - 1 ),
+            function ( $carry, $i ) use ( $matches ) {
+                if ( empty( $matches[0] ) ) {
+                    return $carry;
+                }
+
+                $start         = $matches[0][ $i ][1];
+                $end           = $start + strlen( $matches[0][ $i ][0] );
+                $annotation_id = $matches[1][ $i ][0];
+                $item_id       = $matches[2][ $i ][0];
+                $text          = $matches[3][ $i ][0];
+
+                $annotation = new StdClass();
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                $annotation->annotationId = $annotation_id;
+                $annotation->start        = $start;
+                $annotation->end          = $end;
+                $annotation->text         = $text;
+
+                $entity_match             = new StdClass();
+                $entity_match->confidence = 100;
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                $entity_match->entityId = $item_id;
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                $annotation->entityMatches[] = $entity_match;
+
+                $carry['annotations'][ $annotation_id ] = $annotation;
+                $carry['occurrences'][ $item_id ][]     = $annotation_id;
+
+                return $carry;
+            },
+            array(
+                'annotations' => array(),
+                'occurrences' => array(),
+            )
+        );
+
+        $annotations = $parse_data['annotations'];
+        $occurrences = $parse_data['occurrences'];
+
+        $entity_provider_registry = Entity_Provider_Registry::get_instance();
+
+        foreach ( array_keys( $occurrences ) as $item_id ) {
+
+            // If the entity isn't there, add it.
+            if ( ! is_bool( $this->json ) && ! isset( $this->json->entities->{$item_id} ) ) {
+                $entity = $entity_provider_registry->get_local_entity( $item_id );
+
+                // Entity not found in the local vocabulary, continue to the next one.
+                if ( false === $entity ) {
+                    continue;
+                }
+
+                $this->json->entities->{$item_id} = $entity;
+            }
+        }
+
+        // Here we're adding back some data structures required by the client-side code.
+        //
+        // We're adding:
+        // 1. the .entities[entity_id].occurrences array with the annotations' ids.
+        // 2. the .entities[entity_id].annotations[annotation_id] = { id: annotation_id } map.
+        //
+        // Before 3.23.0 this was done by the client-side code located in src/coffee/editpost-widget/app.services.AnalysisService.coffee
+        // function `preselect`, which was called by src/coffee/editpost-widget/app.services.EditorService.coffee in
+        // `embedAnalysis`.
+
+        if ( ! is_bool( $this->json ) && isset( $this->json->entities ) ) {
+            $occurrences_processor = Occurrences_Factory::get_instance( $this->post_id );
+            $this->json            = $occurrences_processor->add_occurrences_to_entities( $occurrences, $this->json, $this->post_id );
+        }
+
+        // Add the missing annotations. This allows the analysis response to work also if we didn't receive results
+        // from the analysis API.
+        foreach ( $annotations as $annotation_id => $annotation ) {
+
+            if ( ! is_bool( $this->json ) && ! isset( $this->json->annotations->{$annotation_id} ) ) {
+                $this->json->annotations->{$annotation_id} = $annotation;
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Add local entities
+     *
+     * @return Analysis_Response_Ops The {@link Analysis_Response_Ops} instance.
+     *
+     * @since 3.27.6
+     *
+     * @link https://github.com/insideout10/wordlift-plugin/issues/1178
+     */
+    public function add_local_entities() {
+
+        // Populating the local entities object
+        $entities = array();
+        foreach ( $this->json->annotations as $annotation ) {
+            // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+            foreach ( $annotation->entityMatches as $entity_matches ) {
+
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                $entity_id         = $this->entity_uri_service->get_post_id_from_url( $entity_matches->entityId );
+                $serialized_entity = wl_serialize_entity( $entity_id );
+
+                if ( $serialized_entity ) {
+                    $serialized_entity['entityId'] = $serialized_entity['id'];
+                    unset( $serialized_entity['id'] );
+
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    $entities[ $entity_matches->entityId ] = $serialized_entity;
+                }
+            }
+        }
+
+        // Adding occurrences and annotations data structures required by the client-side code.
+        foreach ( $entities as $entity_id => $entity ) {
+            foreach ( $this->json->annotations as $annotation ) {
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                if ( $annotation->entityMatches[0]->entityId === $entity_id ) {
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    $entities[ $entity_id ]['occurrences'][] = $annotation->annotationId;
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    $entities[ $entity_id ]['annotations'][ $annotation->annotationId ]['id'] = $annotation->annotationId;
+                }
+            }
+        }
+
+        $this->json->entities = $entities;
+
+        return $this;
+
+    }
+
+    /**
+     * Return the JSON response.
+     *
+     * @return mixed The JSON response.
+     * @since 3.24.2
+     */
+    public function get_json() {
+
+        return $this->json;
+    }
+
+    /**
+     * This function should be invoked after `make_entities_local` after this
+     * method.
+     *
+     * @param $excluded_uris array An array of entity URIs to be excluded.
+     *
+     * @return $this
+     * @since 3.32.3.1
+     */
+    public function remove_excluded_entities( $excluded_uris ) {
+
+        // If we didnt receive array, return early.
+        if ( ! is_array( $excluded_uris ) ) {
+            return $this;
+        }
+
+        // We may also receive an array of null, make sure to filter uris when receiving.
+        $excluded_uris = array_filter( $excluded_uris, 'is_string' );
+
+        $this->remove_entities_with_excluded_uris( $excluded_uris );
+
+        $this->remove_annotations_with_excluded_uris( $excluded_uris );
+
+        return $this;
+    }
+
+    /**
+     * Get the string representation of the JSON.
+     *
+     * @return false|string The string representation or false in case of error.
+     */
+    public function to_string() {
+
+        // Add the `JSON_UNESCAPED_UNICODE` only for PHP 5.4+.
+        $options = ( version_compare( PHP_VERSION, '5.4', '>=' )
+            ? 256 : 0 );
+
+        return wp_json_encode( $this->json, $options );
+    }
+
+    /**
+     * Remove all the entities with the excluded URIs.
+     *
+     * @param array $excluded_uris The array of URIs to be excluded.
+     */
+    private function remove_entities_with_excluded_uris( array $excluded_uris ) {
+        // Remove the excluded entity uris.
+        if ( isset( $this->json->entities ) ) {
+            foreach ( $excluded_uris as $excluded_uri ) {
+
+                if ( isset( $this->json->entities->{$excluded_uri} ) ) {
+                    // Remove this entity.
+                    unset( $this->json->entities->{$excluded_uri} );
+                    // Also remove the annotations.
+                }
+            }
+        }
+    }
+
+    /**
+     * Remove all the annotations with the excluded entity URIs.
+     *
+     * @param array $excluded_uris The array of URIs to be excluded.
+     *
+     * @return void
+     */
+    private function remove_annotations_with_excluded_uris( array $excluded_uris ) {
+        if ( isset( $this->json->annotations ) ) {
+            foreach ( $this->json->annotations as $annotation_key => &$annotation_data ) {
+
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                if ( ! isset( $annotation_data->entityMatches ) ) {
+                    continue;
+                }
+
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                foreach ( $annotation_data->entityMatches as $entity_match_key => $entity_match_data ) {
+
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    $entity_uri = $entity_match_data->entityId;
+
+                    if ( ! in_array( $entity_uri, $excluded_uris, true ) ) {
+                        continue;
+                    }
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    unset( $annotation_data->entityMatches[ $entity_match_key ] );
+                }
+
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                if ( count( $annotation_data->entityMatches ) === 0 ) {
+                    // Remove the annotation if we have zero empty annotation matches.
+                    unset( $this->json->annotations->{$annotation_key} );
+                }
+            }
+        }
+
+    }
 
 }

Spacing +72 added lines, -72 removed lines

@@ -53,7 +53,7 @@ 
 	 *
 	 * @since 3.21.5
 	 */
-	public function __construct( $entity_uri_service, $entity_helper, $json, $post_id ) {
+	public function __construct($entity_uri_service, $entity_helper, $json, $post_id) {
 		$this->json               = $json;
 		$this->entity_uri_service = $entity_uri_service;
 		$this->entity_helper      = $entity_helper;
@@ -73,24 +73,24 @@ 
 	 */
 	public function make_entities_local() {
 
-		if ( ! isset( $this->json->entities ) ) {
+		if ( ! isset($this->json->entities)) {
 			return $this;
 		}
 
 		// Get the URIs.
-		$uris     = array_keys( get_object_vars( $this->json->entities ) );
-		$mappings = $this->entity_helper->map_many_to_local( $uris );
+		$uris     = array_keys(get_object_vars($this->json->entities));
+		$mappings = $this->entity_helper->map_many_to_local($uris);
 
-		foreach ( $mappings as $external_uri => $internal_uri ) {
+		foreach ($mappings as $external_uri => $internal_uri) {
 
 			// Move the data from the external URI to the internal URI.
-			if ( ! isset( $this->json->entities->{$internal_uri} ) ) {
+			if ( ! isset($this->json->entities->{$internal_uri} )) {
 				$this->json->entities->{$internal_uri} = $this->json->entities->{$external_uri};
 			}
 
 			// Ensure sameAs is an array.
-			if ( ! isset( $this->json->entities->{$internal_uri}->sameAs )
-				 || ! is_array( $this->json->entities->{$internal_uri}->sameAs ) ) {
+			if ( ! isset($this->json->entities->{$internal_uri}->sameAs)
+				 || ! is_array($this->json->entities->{$internal_uri}->sameAs)) {
 				$this->json->entities->{$internal_uri}->sameAs = array();
 			}
 
@@ -98,21 +98,21 @@ 
 			$this->json->entities->{$internal_uri}->sameAs[] = $external_uri;
 
 			// Finally remove the external URI.
-			unset( $this->json->entities->{$external_uri} );
+			unset($this->json->entities->{$external_uri} );
 		}
 
 		// Set the internal uri in the annotation for the entityMatch in annotations.
-		if ( isset( $this->json->annotations ) ) {
+		if (isset($this->json->annotations)) {
 			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			foreach ( $this->json->annotations as $key => $annotation ) {
+			foreach ($this->json->annotations as $key => $annotation) {
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( isset( $annotation->entityMatches ) ) {
+				if (isset($annotation->entityMatches)) {
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					foreach ( $annotation->entityMatches as $match ) {
+					foreach ($annotation->entityMatches as $match) {
 						// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-						if ( isset( $match->entityId ) && isset( $mappings[ $match->entityId ] ) ) {
+						if (isset($match->entityId) && isset($mappings[$match->entityId])) {
 							// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-							$match->entityId = $mappings[ $match->entityId ];
+							$match->entityId = $mappings[$match->entityId];
 						}
 					}
 				}
@@ -134,34 +134,34 @@ 
 	 *
 	 * @link https://github.com/insideout10/wordlift-plugin/issues/1001
 	 */
-	public function add_occurrences( $content ) {
+	public function add_occurrences($content) {
 
 		// Try to get all the disambiguated annotations and bail out if an error occurs.
-		if ( false === preg_match_all(
+		if (false === preg_match_all(
 			'|<span\s+id="([^"]+)"\s+class="textannotation\s+(?:\S+\s+)?disambiguated(?=[\s"])[^"]*"\s+itemid="([^"]*)">(.*?)</span>|',
 			$content,
 			$matches,
 			PREG_OFFSET_CAPTURE
-		) ) {
+		)) {
 			return $this;
 		}
 
-		if ( empty( $matches ) ) {
+		if (empty($matches)) {
 			return $this;
 		}
 
 		$parse_data = array_reduce(
-			range( 0, count( $matches[1] ) - 1 ),
-			function ( $carry, $i ) use ( $matches ) {
-				if ( empty( $matches[0] ) ) {
+			range(0, count($matches[1]) - 1),
+			function($carry, $i) use ($matches) {
+				if (empty($matches[0])) {
 					return $carry;
 				}
 
-				$start         = $matches[0][ $i ][1];
-				$end           = $start + strlen( $matches[0][ $i ][0] );
-				$annotation_id = $matches[1][ $i ][0];
-				$item_id       = $matches[2][ $i ][0];
-				$text          = $matches[3][ $i ][0];
+				$start         = $matches[0][$i][1];
+				$end           = $start + strlen($matches[0][$i][0]);
+				$annotation_id = $matches[1][$i][0];
+				$item_id       = $matches[2][$i][0];
+				$text          = $matches[3][$i][0];
 
 				$annotation = new StdClass();
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
@@ -177,8 +177,8 @@ 
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
 				$annotation->entityMatches[] = $entity_match;
 
-				$carry['annotations'][ $annotation_id ] = $annotation;
-				$carry['occurrences'][ $item_id ][]     = $annotation_id;
+				$carry['annotations'][$annotation_id] = $annotation;
+				$carry['occurrences'][$item_id][]     = $annotation_id;
 
 				return $carry;
 			},
@@ -193,14 +193,14 @@ 
 
 		$entity_provider_registry = Entity_Provider_Registry::get_instance();
 
-		foreach ( array_keys( $occurrences ) as $item_id ) {
+		foreach (array_keys($occurrences) as $item_id) {
 
 			// If the entity isn't there, add it.
-			if ( ! is_bool( $this->json ) && ! isset( $this->json->entities->{$item_id} ) ) {
-				$entity = $entity_provider_registry->get_local_entity( $item_id );
+			if ( ! is_bool($this->json) && ! isset($this->json->entities->{$item_id} )) {
+				$entity = $entity_provider_registry->get_local_entity($item_id);
 
 				// Entity not found in the local vocabulary, continue to the next one.
-				if ( false === $entity ) {
+				if (false === $entity) {
 					continue;
 				}
 
@@ -218,16 +218,16 @@ 
 		// function `preselect`, which was called by src/coffee/editpost-widget/app.services.EditorService.coffee in
 		// `embedAnalysis`.
 
-		if ( ! is_bool( $this->json ) && isset( $this->json->entities ) ) {
-			$occurrences_processor = Occurrences_Factory::get_instance( $this->post_id );
-			$this->json            = $occurrences_processor->add_occurrences_to_entities( $occurrences, $this->json, $this->post_id );
+		if ( ! is_bool($this->json) && isset($this->json->entities)) {
+			$occurrences_processor = Occurrences_Factory::get_instance($this->post_id);
+			$this->json            = $occurrences_processor->add_occurrences_to_entities($occurrences, $this->json, $this->post_id);
 		}
 
 		// Add the missing annotations. This allows the analysis response to work also if we didn't receive results
 		// from the analysis API.
-		foreach ( $annotations as $annotation_id => $annotation ) {
+		foreach ($annotations as $annotation_id => $annotation) {
 
-			if ( ! is_bool( $this->json ) && ! isset( $this->json->annotations->{$annotation_id} ) ) {
+			if ( ! is_bool($this->json) && ! isset($this->json->annotations->{$annotation_id} )) {
 				$this->json->annotations->{$annotation_id} = $annotation;
 			}
 		}
@@ -248,33 +248,33 @@ 
 
 		// Populating the local entities object
 		$entities = array();
-		foreach ( $this->json->annotations as $annotation ) {
+		foreach ($this->json->annotations as $annotation) {
 			// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-			foreach ( $annotation->entityMatches as $entity_matches ) {
+			foreach ($annotation->entityMatches as $entity_matches) {
 
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				$entity_id         = $this->entity_uri_service->get_post_id_from_url( $entity_matches->entityId );
-				$serialized_entity = wl_serialize_entity( $entity_id );
+				$entity_id         = $this->entity_uri_service->get_post_id_from_url($entity_matches->entityId);
+				$serialized_entity = wl_serialize_entity($entity_id);
 
-				if ( $serialized_entity ) {
+				if ($serialized_entity) {
 					$serialized_entity['entityId'] = $serialized_entity['id'];
-					unset( $serialized_entity['id'] );
+					unset($serialized_entity['id']);
 
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_matches->entityId ] = $serialized_entity;
+					$entities[$entity_matches->entityId] = $serialized_entity;
 				}
 			}
 		}
 
 		// Adding occurrences and annotations data structures required by the client-side code.
-		foreach ( $entities as $entity_id => $entity ) {
-			foreach ( $this->json->annotations as $annotation ) {
+		foreach ($entities as $entity_id => $entity) {
+			foreach ($this->json->annotations as $annotation) {
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( $annotation->entityMatches[0]->entityId === $entity_id ) {
+				if ($annotation->entityMatches[0]->entityId === $entity_id) {
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_id ]['occurrences'][] = $annotation->annotationId;
+					$entities[$entity_id]['occurrences'][] = $annotation->annotationId;
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_id ]['annotations'][ $annotation->annotationId ]['id'] = $annotation->annotationId;
+					$entities[$entity_id]['annotations'][$annotation->annotationId]['id'] = $annotation->annotationId;
 				}
 			}
 		}
@@ -305,19 +305,19 @@ 
 	 * @return $this
 	 * @since 3.32.3.1
 	 */
-	public function remove_excluded_entities( $excluded_uris ) {
+	public function remove_excluded_entities($excluded_uris) {
 
 		// If we didnt receive array, return early.
-		if ( ! is_array( $excluded_uris ) ) {
+		if ( ! is_array($excluded_uris)) {
 			return $this;
 		}
 
 		// We may also receive an array of null, make sure to filter uris when receiving.
-		$excluded_uris = array_filter( $excluded_uris, 'is_string' );
+		$excluded_uris = array_filter($excluded_uris, 'is_string');
 
-		$this->remove_entities_with_excluded_uris( $excluded_uris );
+		$this->remove_entities_with_excluded_uris($excluded_uris);
 
-		$this->remove_annotations_with_excluded_uris( $excluded_uris );
+		$this->remove_annotations_with_excluded_uris($excluded_uris);
 
 		return $this;
 	}
@@ -330,10 +330,10 @@ 
 	public function to_string() {
 
 		// Add the `JSON_UNESCAPED_UNICODE` only for PHP 5.4+.
-		$options = ( version_compare( PHP_VERSION, '5.4', '>=' )
-			? 256 : 0 );
+		$options = (version_compare(PHP_VERSION, '5.4', '>=')
+			? 256 : 0);
 
-		return wp_json_encode( $this->json, $options );
+		return wp_json_encode($this->json, $options);
 	}
 
 	/**
@@ -341,14 +341,14 @@ 
 	 *
 	 * @param array $excluded_uris The array of URIs to be excluded.
 	 */
-	private function remove_entities_with_excluded_uris( array $excluded_uris ) {
+	private function remove_entities_with_excluded_uris(array $excluded_uris) {
 		// Remove the excluded entity uris.
-		if ( isset( $this->json->entities ) ) {
-			foreach ( $excluded_uris as $excluded_uri ) {
+		if (isset($this->json->entities)) {
+			foreach ($excluded_uris as $excluded_uri) {
 
-				if ( isset( $this->json->entities->{$excluded_uri} ) ) {
+				if (isset($this->json->entities->{$excluded_uri} )) {
 					// Remove this entity.
-					unset( $this->json->entities->{$excluded_uri} );
+					unset($this->json->entities->{$excluded_uri} );
 					// Also remove the annotations.
 				}
 			}
@@ -362,32 +362,32 @@ 
 	 *
 	 * @return void
 	 */
-	private function remove_annotations_with_excluded_uris( array $excluded_uris ) {
-		if ( isset( $this->json->annotations ) ) {
-			foreach ( $this->json->annotations as $annotation_key => &$annotation_data ) {
+	private function remove_annotations_with_excluded_uris(array $excluded_uris) {
+		if (isset($this->json->annotations)) {
+			foreach ($this->json->annotations as $annotation_key => &$annotation_data) {
 
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( ! isset( $annotation_data->entityMatches ) ) {
+				if ( ! isset($annotation_data->entityMatches)) {
 					continue;
 				}
 
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				foreach ( $annotation_data->entityMatches as $entity_match_key => $entity_match_data ) {
+				foreach ($annotation_data->entityMatches as $entity_match_key => $entity_match_data) {
 
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
 					$entity_uri = $entity_match_data->entityId;
 
-					if ( ! in_array( $entity_uri, $excluded_uris, true ) ) {
+					if ( ! in_array($entity_uri, $excluded_uris, true)) {
 						continue;
 					}
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					unset( $annotation_data->entityMatches[ $entity_match_key ] );
+					unset($annotation_data->entityMatches[$entity_match_key]);
 				}
 
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( count( $annotation_data->entityMatches ) === 0 ) {
+				if (count($annotation_data->entityMatches) === 0) {
 					// Remove the annotation if we have zero empty annotation matches.
-					unset( $this->json->annotations->{$annotation_key} );
+					unset($this->json->annotations->{$annotation_key} );
 				}
 			}
 		}