insideout10 / wordlift-plugin

src/includes/schemaorg/class-wordlift-schemaorg-sync-batch-operation.php

Indentation +114 added lines, -114 removed lines

@@ -16,119 +16,119 @@
  */
 class Wordlift_Schemaorg_Sync_Batch_Operation implements Wordlift_Batch_Operation_Interface {
 
-	private static $instance = null;
-
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Process the batch operation starting from the specified offset.
-	 *
-	 * @param int $offset Start from the specified offset (or 0 if not specified).
-	 * @param int $limit Process the specified amount of items per call (or 10 if not specified).
-	 *
-	 * @return array {
-	 * The operation result.
-	 *
-	 * @type int $next The next offset.
-	 * @type int $limit The amount of items to process per call.
-	 * @type int $remaining The remaining number of elements to process.
-	 * }
-	 * @since 3.20.0
-	 */
-	public function process( $offset = 0, $limit = 10 ) {
-
-		// Get the schema classes.
-		$all_schema_classes = $this->get_schema_classes();
-
-		// Get only the part that we need to process.
-		$schema_classes = array_slice( $all_schema_classes, $offset, $limit );
-
-		// Load the Schema.org classes.
-		foreach ( $schema_classes as $schema_class ) {
-			$slug = $schema_class['dashname'];
-			$term = term_exists( $slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-
-			$args = array(
-				'parent'      => 0,
-				'description' => $schema_class['description'],
-				'slug'        => $schema_class['dashname'],
-			);
-			if ( null !== $term ) {
-				wp_update_term( $term['term_id'], Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $args );
-			} else {
-				$term = wp_insert_term( $schema_class['name'], Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $args );
-			}
-
-			// Update the parents/children relationship.
-			delete_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::PARENT_OF_META_KEY );
-			foreach ( $schema_class['children'] as $child ) {
-				add_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::PARENT_OF_META_KEY, $child['dashname'] );
-			}
-
-			// Update the term name.
-			delete_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::NAME_META_KEY );
-			update_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::NAME_META_KEY, $schema_class['name'] );
-
-			// Update the term URI.
-			delete_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::URI_META_KEY );
-			update_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::URI_META_KEY, "http://schema.org/{$schema_class['name']}" );
-
-		}
-
-		// Calculate the return values.
-		$next      = $offset + $limit;
-		$remaining = $this->count();
-
-		return array(
-			'next'      => $next,
-			'limit'     => $limit,
-			'complete'  => ( 0 === $remaining ),
-			'remaining' => $remaining,
-		);
-	}
-
-	/**
-	 * Count the number of elements that would be affected by the operation.
-	 *
-	 * @return int The number of elements that would be affected.
-	 * @since 3.20.0
-	 */
-	public function count() {
-
-		// Schema Classes count.
-		$schema_classes_count = count( $this->get_schema_classes() );
-
-		// Terms count.
-		$terms_count = wp_count_terms( Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-
-		// Return the difference.
-		return $schema_classes_count - $terms_count;
-	}
-
-	/**
-	 * Get the schema.org classes from the JSON file.
-	 *
-	 * @return array An array of schema classes.
-	 * @since 3.20.0
-	 */
-	private function get_schema_classes() {
-
-		// Load the file contents.
-		// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
-		$contents = file_get_contents( __DIR__ . '/schema-classes.json' );
-
-		// Decode the JSON contents.
-		$json = json_decode( $contents, true );
-
-		// Return the schema classes or an empty array.
-		return isset( $json['schemaClasses'] ) ? $json['schemaClasses'] : array();
-	}
+    private static $instance = null;
+
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Process the batch operation starting from the specified offset.
+     *
+     * @param int $offset Start from the specified offset (or 0 if not specified).
+     * @param int $limit Process the specified amount of items per call (or 10 if not specified).
+     *
+     * @return array {
+     * The operation result.
+     *
+     * @type int $next The next offset.
+     * @type int $limit The amount of items to process per call.
+     * @type int $remaining The remaining number of elements to process.
+     * }
+     * @since 3.20.0
+     */
+    public function process( $offset = 0, $limit = 10 ) {
+
+        // Get the schema classes.
+        $all_schema_classes = $this->get_schema_classes();
+
+        // Get only the part that we need to process.
+        $schema_classes = array_slice( $all_schema_classes, $offset, $limit );
+
+        // Load the Schema.org classes.
+        foreach ( $schema_classes as $schema_class ) {
+            $slug = $schema_class['dashname'];
+            $term = term_exists( $slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+
+            $args = array(
+                'parent'      => 0,
+                'description' => $schema_class['description'],
+                'slug'        => $schema_class['dashname'],
+            );
+            if ( null !== $term ) {
+                wp_update_term( $term['term_id'], Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $args );
+            } else {
+                $term = wp_insert_term( $schema_class['name'], Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $args );
+            }
+
+            // Update the parents/children relationship.
+            delete_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::PARENT_OF_META_KEY );
+            foreach ( $schema_class['children'] as $child ) {
+                add_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::PARENT_OF_META_KEY, $child['dashname'] );
+            }
+
+            // Update the term name.
+            delete_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::NAME_META_KEY );
+            update_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::NAME_META_KEY, $schema_class['name'] );
+
+            // Update the term URI.
+            delete_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::URI_META_KEY );
+            update_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::URI_META_KEY, "http://schema.org/{$schema_class['name']}" );
+
+        }
+
+        // Calculate the return values.
+        $next      = $offset + $limit;
+        $remaining = $this->count();
+
+        return array(
+            'next'      => $next,
+            'limit'     => $limit,
+            'complete'  => ( 0 === $remaining ),
+            'remaining' => $remaining,
+        );
+    }
+
+    /**
+     * Count the number of elements that would be affected by the operation.
+     *
+     * @return int The number of elements that would be affected.
+     * @since 3.20.0
+     */
+    public function count() {
+
+        // Schema Classes count.
+        $schema_classes_count = count( $this->get_schema_classes() );
+
+        // Terms count.
+        $terms_count = wp_count_terms( Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+
+        // Return the difference.
+        return $schema_classes_count - $terms_count;
+    }
+
+    /**
+     * Get the schema.org classes from the JSON file.
+     *
+     * @return array An array of schema classes.
+     * @since 3.20.0
+     */
+    private function get_schema_classes() {
+
+        // Load the file contents.
+        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+        $contents = file_get_contents( __DIR__ . '/schema-classes.json' );
+
+        // Decode the JSON contents.
+        $json = json_decode( $contents, true );
+
+        // Return the schema classes or an empty array.
+        return isset( $json['schemaClasses'] ) ? $json['schemaClasses'] : array();
+    }
 
 }

Spacing +21 added lines, -21 removed lines

@@ -20,7 +20,7 @@ 
 
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -42,43 +42,43 @@ 
 	 * }
 	 * @since 3.20.0
 	 */
-	public function process( $offset = 0, $limit = 10 ) {
+	public function process($offset = 0, $limit = 10) {
 
 		// Get the schema classes.
 		$all_schema_classes = $this->get_schema_classes();
 
 		// Get only the part that we need to process.
-		$schema_classes = array_slice( $all_schema_classes, $offset, $limit );
+		$schema_classes = array_slice($all_schema_classes, $offset, $limit);
 
 		// Load the Schema.org classes.
-		foreach ( $schema_classes as $schema_class ) {
+		foreach ($schema_classes as $schema_class) {
 			$slug = $schema_class['dashname'];
-			$term = term_exists( $slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+			$term = term_exists($slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 
 			$args = array(
 				'parent'      => 0,
 				'description' => $schema_class['description'],
 				'slug'        => $schema_class['dashname'],
 			);
-			if ( null !== $term ) {
-				wp_update_term( $term['term_id'], Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $args );
+			if (null !== $term) {
+				wp_update_term($term['term_id'], Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $args);
 			} else {
-				$term = wp_insert_term( $schema_class['name'], Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $args );
+				$term = wp_insert_term($schema_class['name'], Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $args);
 			}
 
 			// Update the parents/children relationship.
-			delete_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::PARENT_OF_META_KEY );
-			foreach ( $schema_class['children'] as $child ) {
-				add_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::PARENT_OF_META_KEY, $child['dashname'] );
+			delete_term_meta($term['term_id'], Wordlift_Schemaorg_Class_Service::PARENT_OF_META_KEY);
+			foreach ($schema_class['children'] as $child) {
+				add_term_meta($term['term_id'], Wordlift_Schemaorg_Class_Service::PARENT_OF_META_KEY, $child['dashname']);
 			}
 
 			// Update the term name.
-			delete_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::NAME_META_KEY );
-			update_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::NAME_META_KEY, $schema_class['name'] );
+			delete_term_meta($term['term_id'], Wordlift_Schemaorg_Class_Service::NAME_META_KEY);
+			update_term_meta($term['term_id'], Wordlift_Schemaorg_Class_Service::NAME_META_KEY, $schema_class['name']);
 
 			// Update the term URI.
-			delete_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::URI_META_KEY );
-			update_term_meta( $term['term_id'], Wordlift_Schemaorg_Class_Service::URI_META_KEY, "http://schema.org/{$schema_class['name']}" );
+			delete_term_meta($term['term_id'], Wordlift_Schemaorg_Class_Service::URI_META_KEY);
+			update_term_meta($term['term_id'], Wordlift_Schemaorg_Class_Service::URI_META_KEY, "http://schema.org/{$schema_class['name']}");
 
 		}
 
@@ -89,7 +89,7 @@ 
 		return array(
 			'next'      => $next,
 			'limit'     => $limit,
-			'complete'  => ( 0 === $remaining ),
+			'complete'  => (0 === $remaining),
 			'remaining' => $remaining,
 		);
 	}
@@ -103,10 +103,10 @@ 
 	public function count() {
 
 		// Schema Classes count.
-		$schema_classes_count = count( $this->get_schema_classes() );
+		$schema_classes_count = count($this->get_schema_classes());
 
 		// Terms count.
-		$terms_count = wp_count_terms( Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+		$terms_count = wp_count_terms(Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 
 		// Return the difference.
 		return $schema_classes_count - $terms_count;
@@ -122,13 +122,13 @@ 
 
 		// Load the file contents.
 		// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
-		$contents = file_get_contents( __DIR__ . '/schema-classes.json' );
+		$contents = file_get_contents(__DIR__.'/schema-classes.json');
 
 		// Decode the JSON contents.
-		$json = json_decode( $contents, true );
+		$json = json_decode($contents, true);
 
 		// Return the schema classes or an empty array.
-		return isset( $json['schemaClasses'] ) ? $json['schemaClasses'] : array();
+		return isset($json['schemaClasses']) ? $json['schemaClasses'] : array();
 	}
 
 }

src/includes/schemaorg/class-wordlift-schemaorg-property-service.php

Indentation +105 added lines, -105 removed lines

@@ -16,110 +16,110 @@
  */
 class Wordlift_Schemaorg_Property_Service {
 
-	/**
-	 * The meta key prefix used to store properties. The `_` prefix makes these metas invisible in the
-	 * edit screen custom fields metabox.
-	 *
-	 * @since 3.20.0
-	 */
-	const PREFIX = '_wl_prop_';
-
-	/**
-	 * Create a {@link Wordlift_Schemaorg_Property_Service} instance.
-	 *
-	 * @since 3.20.0
-	 */
-	protected function __construct() {
-
-	}
-
-	private static $instance = null;
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @return \Wordlift_Schemaorg_Property_Service The singleton instance.
-	 * @since 3.20.0
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get all the properties bound to the specified post.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array An array of properties instances keyed by the property name. Each property contains a
-	 *  `type` and a `value` and optionally a `language`.
-	 * }
-	 * @since 3.20.0
-	 */
-	public function get_all( $post_id ) {
-
-		// Get all the post metas.
-		$post_metas = get_post_meta( $post_id );
-
-		// Cycle through them to get the Schema.org properties.
-		$props = array();
-		foreach ( $post_metas as $key => $values ) {
-			$matches = array();
-
-			// We're looking for `_wl_prop_propName_uuid_key`.
-			if ( 1 === preg_match( '/' . self::PREFIX . '(\w+)_([\w-]+)_(\w+)/i', $key, $matches ) ) {
-				$name = $matches[1];
-				$uuid = $matches[2];
-				$key  = $matches[3];
-
-				// Record the value.
-				$props[ $name ][ $uuid ][ $key ] = $values[0];
-			}
-		}
-
-		// Remove the UUIDs.
-		foreach ( $props as $name => $instance ) {
-			foreach ( $instance as $uuid => $keys ) {
-				// This way we remove the `uuid`s.
-				$props[ $name ] = array_values( $instance );
-			}
-		}
-
-		// Finally return the props.
-		return $props;
-	}
-
-	/**
-	 * Get the meta keys for Schema.org properties associated with the specified post.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array An array of meta keys.
-	 * @since 3.20.0
-	 */
-	public function get_keys( $post_id ) {
-
-		// Get all the post metas to remove the `_wl_prop` ones.
-		$post_meta = get_post_meta( $post_id );
-
-		// Get the keys.
-		$post_meta_keys = array_unique( array_keys( $post_meta ) );
-
-		// Get only the `_wl_prop` keys. `array_values` resets the indexes.
-		$prop_keys = array_values(
-			array_filter(
-				$post_meta_keys,
-				function ( $item ) {
-					return 0 === strpos( $item, Wordlift_Schemaorg_Property_Service::PREFIX );
-				}
-			)
-		);
-
-		return $prop_keys;
-	}
+    /**
+     * The meta key prefix used to store properties. The `_` prefix makes these metas invisible in the
+     * edit screen custom fields metabox.
+     *
+     * @since 3.20.0
+     */
+    const PREFIX = '_wl_prop_';
+
+    /**
+     * Create a {@link Wordlift_Schemaorg_Property_Service} instance.
+     *
+     * @since 3.20.0
+     */
+    protected function __construct() {
+
+    }
+
+    private static $instance = null;
+
+    /**
+     * Get the singleton instance.
+     *
+     * @return \Wordlift_Schemaorg_Property_Service The singleton instance.
+     * @since 3.20.0
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Get all the properties bound to the specified post.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array An array of properties instances keyed by the property name. Each property contains a
+     *  `type` and a `value` and optionally a `language`.
+     * }
+     * @since 3.20.0
+     */
+    public function get_all( $post_id ) {
+
+        // Get all the post metas.
+        $post_metas = get_post_meta( $post_id );
+
+        // Cycle through them to get the Schema.org properties.
+        $props = array();
+        foreach ( $post_metas as $key => $values ) {
+            $matches = array();
+
+            // We're looking for `_wl_prop_propName_uuid_key`.
+            if ( 1 === preg_match( '/' . self::PREFIX . '(\w+)_([\w-]+)_(\w+)/i', $key, $matches ) ) {
+                $name = $matches[1];
+                $uuid = $matches[2];
+                $key  = $matches[3];
+
+                // Record the value.
+                $props[ $name ][ $uuid ][ $key ] = $values[0];
+            }
+        }
+
+        // Remove the UUIDs.
+        foreach ( $props as $name => $instance ) {
+            foreach ( $instance as $uuid => $keys ) {
+                // This way we remove the `uuid`s.
+                $props[ $name ] = array_values( $instance );
+            }
+        }
+
+        // Finally return the props.
+        return $props;
+    }
+
+    /**
+     * Get the meta keys for Schema.org properties associated with the specified post.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array An array of meta keys.
+     * @since 3.20.0
+     */
+    public function get_keys( $post_id ) {
+
+        // Get all the post metas to remove the `_wl_prop` ones.
+        $post_meta = get_post_meta( $post_id );
+
+        // Get the keys.
+        $post_meta_keys = array_unique( array_keys( $post_meta ) );
+
+        // Get only the `_wl_prop` keys. `array_values` resets the indexes.
+        $prop_keys = array_values(
+            array_filter(
+                $post_meta_keys,
+                function ( $item ) {
+                    return 0 === strpos( $item, Wordlift_Schemaorg_Property_Service::PREFIX );
+                }
+            )
+        );
+
+        return $prop_keys;
+    }
 
 }

Spacing +14 added lines, -14 removed lines

@@ -43,7 +43,7 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -60,32 +60,32 @@ 
 	 * }
 	 * @since 3.20.0
 	 */
-	public function get_all( $post_id ) {
+	public function get_all($post_id) {
 
 		// Get all the post metas.
-		$post_metas = get_post_meta( $post_id );
+		$post_metas = get_post_meta($post_id);
 
 		// Cycle through them to get the Schema.org properties.
 		$props = array();
-		foreach ( $post_metas as $key => $values ) {
+		foreach ($post_metas as $key => $values) {
 			$matches = array();
 
 			// We're looking for `_wl_prop_propName_uuid_key`.
-			if ( 1 === preg_match( '/' . self::PREFIX . '(\w+)_([\w-]+)_(\w+)/i', $key, $matches ) ) {
+			if (1 === preg_match('/'.self::PREFIX.'(\w+)_([\w-]+)_(\w+)/i', $key, $matches)) {
 				$name = $matches[1];
 				$uuid = $matches[2];
 				$key  = $matches[3];
 
 				// Record the value.
-				$props[ $name ][ $uuid ][ $key ] = $values[0];
+				$props[$name][$uuid][$key] = $values[0];
 			}
 		}
 
 		// Remove the UUIDs.
-		foreach ( $props as $name => $instance ) {
-			foreach ( $instance as $uuid => $keys ) {
+		foreach ($props as $name => $instance) {
+			foreach ($instance as $uuid => $keys) {
 				// This way we remove the `uuid`s.
-				$props[ $name ] = array_values( $instance );
+				$props[$name] = array_values($instance);
 			}
 		}
 
@@ -101,20 +101,20 @@ 
 	 * @return array An array of meta keys.
 	 * @since 3.20.0
 	 */
-	public function get_keys( $post_id ) {
+	public function get_keys($post_id) {
 
 		// Get all the post metas to remove the `_wl_prop` ones.
-		$post_meta = get_post_meta( $post_id );
+		$post_meta = get_post_meta($post_id);
 
 		// Get the keys.
-		$post_meta_keys = array_unique( array_keys( $post_meta ) );
+		$post_meta_keys = array_unique(array_keys($post_meta));
 
 		// Get only the `_wl_prop` keys. `array_values` resets the indexes.
 		$prop_keys = array_values(
 			array_filter(
 				$post_meta_keys,
-				function ( $item ) {
-					return 0 === strpos( $item, Wordlift_Schemaorg_Property_Service::PREFIX );
+				function($item) {
+					return 0 === strpos($item, Wordlift_Schemaorg_Property_Service::PREFIX);
 				}
 			)
 		);

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

Indentation +13 added lines, -13 removed lines

@@ -16,20 +16,20 @@
  */
 class Wordlift_NewRelic_Adapter {
 
-	/**
-	 * Tell NewRelic to ignore this "transaction" for the Apdex.
-	 *
-	 * @see   https://github.com/insideout10/wordlift-plugin/issues/521
-	 *
-	 * @since 3.11.3
-	 */
-	public static function ignore_apdex() {
+    /**
+     * Tell NewRelic to ignore this "transaction" for the Apdex.
+     *
+     * @see   https://github.com/insideout10/wordlift-plugin/issues/521
+     *
+     * @since 3.11.3
+     */
+    public static function ignore_apdex() {
 
-		// Ensure PHP agent and the function are available.
-		if ( extension_loaded( 'newrelic' ) && function_exists( 'newrelic_ignore_apdex' ) ) {
-			newrelic_ignore_apdex();
-		}
+        // Ensure PHP agent and the function are available.
+        if ( extension_loaded( 'newrelic' ) && function_exists( 'newrelic_ignore_apdex' ) ) {
+            newrelic_ignore_apdex();
+        }
 
-	}
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
 	public static function ignore_apdex() {
 
 		// Ensure PHP agent and the function are available.
-		if ( extension_loaded( 'newrelic' ) && function_exists( 'newrelic_ignore_apdex' ) ) {
+		if (extension_loaded('newrelic') && function_exists('newrelic_ignore_apdex')) {
 			newrelic_ignore_apdex();
 		}
 

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

Indentation +116 added lines, -116 removed lines

@@ -17,54 +17,54 @@ 
  */
 class Wordlift_Entity_Page_Service {
 
-	/**
-	 * Set the entity post types as one to be included in archive pages.
-	 *
-	 * In order to have entities show up in standard WP categories (Posts categories)
-	 * we configure the `entity` post type, but we also need to alter the main
-	 * WP query (which by default queries posts only) to include the `entities`.
-	 *
-	 * @since 3.12.0
-	 *
-	 * @param WP_Query $query WP's {@link WP_Query} instance.
-	 */
-	public function pre_get_posts( $query ) {
-
-		// Only for the main query, avoid problems with widgets and what not.
-		if ( ! $query->is_main_query() ) {
-			return;
-		}
-
-		// We don't want to alter the query if we're in the admin UI, if this is
-		// not a entity type achieve query, or if the `suppress_filters` is set.
-		//
-		// Note that it is unlikely for `suppress_filter` to be set on the front
-		// end, but let's be safe if it is set the calling code assumes no
-		// modifications of queries.
-
-		// Ignore admin side request, requests for which filters should be
-		// suppressed, and when we are not on a entity type archive page.
-		if ( is_admin() ||
-			 ! is_tax( Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) ||
-			 ! empty( $query->query_vars['suppress_filters'] )
-		) {
-			return;
-		}
-
-		// Events should be sorted by start date in descending order.
-		if ( is_tax( Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, 'event' ) ) {
-
-			// Update the query to use the start time meta and desc order.
-			$meta_query = array(
-				array(
-					'key' => Wordlift_Schema_Service::FIELD_DATE_START,
-				),
-			);
-			$query->set( 'meta_query', $meta_query );
-			$query->set( 'orderby', 'meta_value' );
-			$query->set( 'order', 'DESC' );
-		} else {
-			/*
+    /**
+     * Set the entity post types as one to be included in archive pages.
+     *
+     * In order to have entities show up in standard WP categories (Posts categories)
+     * we configure the `entity` post type, but we also need to alter the main
+     * WP query (which by default queries posts only) to include the `entities`.
+     *
+     * @since 3.12.0
+     *
+     * @param WP_Query $query WP's {@link WP_Query} instance.
+     */
+    public function pre_get_posts( $query ) {
+
+        // Only for the main query, avoid problems with widgets and what not.
+        if ( ! $query->is_main_query() ) {
+            return;
+        }
+
+        // We don't want to alter the query if we're in the admin UI, if this is
+        // not a entity type achieve query, or if the `suppress_filters` is set.
+        //
+        // Note that it is unlikely for `suppress_filter` to be set on the front
+        // end, but let's be safe if it is set the calling code assumes no
+        // modifications of queries.
+
+        // Ignore admin side request, requests for which filters should be
+        // suppressed, and when we are not on a entity type archive page.
+        if ( is_admin() ||
+             ! is_tax( Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) ||
+             ! empty( $query->query_vars['suppress_filters'] )
+        ) {
+            return;
+        }
+
+        // Events should be sorted by start date in descending order.
+        if ( is_tax( Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, 'event' ) ) {
+
+            // Update the query to use the start time meta and desc order.
+            $meta_query = array(
+                array(
+                    'key' => Wordlift_Schema_Service::FIELD_DATE_START,
+                ),
+            );
+            $query->set( 'meta_query', $meta_query );
+            $query->set( 'orderby', 'meta_value' );
+            $query->set( 'order', 'DESC' );
+        } else {
+            /*
 			 * All other entity types should be sorted by their connectivity.
 			 * For this we need to query the relationship table which has
 			 * to be done by manipulating the SQL generated for the query.
@@ -72,73 +72,73 @@ 
 			 * additional filters to handle it.
 			 */
 
-			add_filter( 'posts_join', array( $this, 'posts_join' ) );
-			add_filter( 'posts_groupby', array( $this, 'posts_groupby' ) );
-			add_filter( 'posts_orderby', array( $this, 'posts_orderby' ) );
-		}
-	}
-
-	/**
-	 * Filter handler that sets the join part of a query to include the
-	 * relationship table to be able to use it in the sorting.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param string $join_statement The join part of the SQL statement which is used for the query.
-	 *
-	 * @return string An join SQL which add the relationships table to the join.
-	 */
-	public function posts_join( $join_statement ) {
-
-		global $wpdb;
-
-		$join_statement .= " LEFT JOIN {$wpdb->prefix}wl_relation_instances ri "
-						   . " ON (ri.object_id = {$wpdb->posts}.ID)";
-
-		// Remove to make sure it will not run agan in other context.
-		remove_filter( 'posts_join', array( $this, 'posts_join' ) );
-
-		return $join_statement;
-	}
-
-	/**
-	 * Filter handler that sets the groupby part of a query to include the
-	 * relationship table to be able to use it in the sorting.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param string $groupby_statement The groupby part of the SQL statement which is used for the query.
-	 *
-	 * @return string A groupby SQL which add the relationships table to the join.
-	 */
-	public function posts_groupby( $groupby_statement ) {
-
-		$groupby_statement = 'ri.object_id, ' . $groupby_statement;
-
-		// Remove to make sure it will not run agan in other context.
-		remove_filter( 'posts_groupby', array( $this, 'posts_groupby' ) );
-
-		return $groupby_statement;
-	}
-
-	/**
-	 * Filter handler that sets the orderby part of a query to sort by number of
-	 * relationships.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param string $orderby_statement The orderby part of the SQL statement which is used for the query.
-	 *
-	 * @return string An orderby SQL which sorts by the number of relationships
-	 */
-	public function posts_orderby( $orderby_statement ) {
-
-		$orderby_statement = 'COUNT( ri.object_id ) DESC, ' . $orderby_statement;
-
-		// Remove to make sure it will not run agan in other context.
-		remove_filter( 'posts_orderby', array( $this, 'posts_orderby' ) );
-
-		return $orderby_statement;
-	}
+            add_filter( 'posts_join', array( $this, 'posts_join' ) );
+            add_filter( 'posts_groupby', array( $this, 'posts_groupby' ) );
+            add_filter( 'posts_orderby', array( $this, 'posts_orderby' ) );
+        }
+    }
+
+    /**
+     * Filter handler that sets the join part of a query to include the
+     * relationship table to be able to use it in the sorting.
+     *
+     * @since 3.15.0
+     *
+     * @param string $join_statement The join part of the SQL statement which is used for the query.
+     *
+     * @return string An join SQL which add the relationships table to the join.
+     */
+    public function posts_join( $join_statement ) {
+
+        global $wpdb;
+
+        $join_statement .= " LEFT JOIN {$wpdb->prefix}wl_relation_instances ri "
+                            . " ON (ri.object_id = {$wpdb->posts}.ID)";
+
+        // Remove to make sure it will not run agan in other context.
+        remove_filter( 'posts_join', array( $this, 'posts_join' ) );
+
+        return $join_statement;
+    }
+
+    /**
+     * Filter handler that sets the groupby part of a query to include the
+     * relationship table to be able to use it in the sorting.
+     *
+     * @since 3.15.0
+     *
+     * @param string $groupby_statement The groupby part of the SQL statement which is used for the query.
+     *
+     * @return string A groupby SQL which add the relationships table to the join.
+     */
+    public function posts_groupby( $groupby_statement ) {
+
+        $groupby_statement = 'ri.object_id, ' . $groupby_statement;
+
+        // Remove to make sure it will not run agan in other context.
+        remove_filter( 'posts_groupby', array( $this, 'posts_groupby' ) );
+
+        return $groupby_statement;
+    }
+
+    /**
+     * Filter handler that sets the orderby part of a query to sort by number of
+     * relationships.
+     *
+     * @since 3.15.0
+     *
+     * @param string $orderby_statement The orderby part of the SQL statement which is used for the query.
+     *
+     * @return string An orderby SQL which sorts by the number of relationships
+     */
+    public function posts_orderby( $orderby_statement ) {
+
+        $orderby_statement = 'COUNT( ri.object_id ) DESC, ' . $orderby_statement;
+
+        // Remove to make sure it will not run agan in other context.
+        remove_filter( 'posts_orderby', array( $this, 'posts_orderby' ) );
+
+        return $orderby_statement;
+    }
 
 }

Spacing +20 added lines, -20 removed lines

@@ -28,10 +28,10 @@ 
 	 *
 	 * @param WP_Query $query WP's {@link WP_Query} instance.
 	 */
-	public function pre_get_posts( $query ) {
+	public function pre_get_posts($query) {
 
 		// Only for the main query, avoid problems with widgets and what not.
-		if ( ! $query->is_main_query() ) {
+		if ( ! $query->is_main_query()) {
 			return;
 		}
 
@@ -44,15 +44,15 @@ 
 
 		// Ignore admin side request, requests for which filters should be
 		// suppressed, and when we are not on a entity type archive page.
-		if ( is_admin() ||
-			 ! is_tax( Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) ||
-			 ! empty( $query->query_vars['suppress_filters'] )
+		if (is_admin() ||
+			 ! is_tax(Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME) ||
+			 ! empty($query->query_vars['suppress_filters'])
 		) {
 			return;
 		}
 
 		// Events should be sorted by start date in descending order.
-		if ( is_tax( Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, 'event' ) ) {
+		if (is_tax(Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, 'event')) {
 
 			// Update the query to use the start time meta and desc order.
 			$meta_query = array(
@@ -60,9 +60,9 @@ 
 					'key' => Wordlift_Schema_Service::FIELD_DATE_START,
 				),
 			);
-			$query->set( 'meta_query', $meta_query );
-			$query->set( 'orderby', 'meta_value' );
-			$query->set( 'order', 'DESC' );
+			$query->set('meta_query', $meta_query);
+			$query->set('orderby', 'meta_value');
+			$query->set('order', 'DESC');
 		} else {
 			/*
 			 * All other entity types should be sorted by their connectivity.
@@ -72,9 +72,9 @@ 
 			 * additional filters to handle it.
 			 */
 
-			add_filter( 'posts_join', array( $this, 'posts_join' ) );
-			add_filter( 'posts_groupby', array( $this, 'posts_groupby' ) );
-			add_filter( 'posts_orderby', array( $this, 'posts_orderby' ) );
+			add_filter('posts_join', array($this, 'posts_join'));
+			add_filter('posts_groupby', array($this, 'posts_groupby'));
+			add_filter('posts_orderby', array($this, 'posts_orderby'));
 		}
 	}
 
@@ -88,7 +88,7 @@ 
 	 *
 	 * @return string An join SQL which add the relationships table to the join.
 	 */
-	public function posts_join( $join_statement ) {
+	public function posts_join($join_statement) {
 
 		global $wpdb;
 
@@ -96,7 +96,7 @@ 
 						   . " ON (ri.object_id = {$wpdb->posts}.ID)";
 
 		// Remove to make sure it will not run agan in other context.
-		remove_filter( 'posts_join', array( $this, 'posts_join' ) );
+		remove_filter('posts_join', array($this, 'posts_join'));
 
 		return $join_statement;
 	}
@@ -111,12 +111,12 @@ 
 	 *
 	 * @return string A groupby SQL which add the relationships table to the join.
 	 */
-	public function posts_groupby( $groupby_statement ) {
+	public function posts_groupby($groupby_statement) {
 
-		$groupby_statement = 'ri.object_id, ' . $groupby_statement;
+		$groupby_statement = 'ri.object_id, '.$groupby_statement;
 
 		// Remove to make sure it will not run agan in other context.
-		remove_filter( 'posts_groupby', array( $this, 'posts_groupby' ) );
+		remove_filter('posts_groupby', array($this, 'posts_groupby'));
 
 		return $groupby_statement;
 	}
@@ -131,12 +131,12 @@ 
 	 *
 	 * @return string An orderby SQL which sorts by the number of relationships
 	 */
-	public function posts_orderby( $orderby_statement ) {
+	public function posts_orderby($orderby_statement) {
 
-		$orderby_statement = 'COUNT( ri.object_id ) DESC, ' . $orderby_statement;
+		$orderby_statement = 'COUNT( ri.object_id ) DESC, '.$orderby_statement;
 
 		// Remove to make sure it will not run agan in other context.
-		remove_filter( 'posts_orderby', array( $this, 'posts_orderby' ) );
+		remove_filter('posts_orderby', array($this, 'posts_orderby'));
 
 		return $orderby_statement;
 	}

src/includes/class-wordlift-sample-data-service.php

Indentation +329 added lines, -329 removed lines

@@ -17,98 +17,98 @@ 
  */
 class Wordlift_Sample_Data_Service {
 
-	/**
-	 * An array of sample data.
-	 *
-	 * @since 3.12.0
-	 * @var array $samples An array of sample data.
-	 */
-	private $samples = array(
-		array(
-			'post'            => array(
-				'post_name'    => 'praesent_imperdiet_odio_sed_lectus_vulputate_finibus',
-				'post_title'   => 'Praesent imperdiet odio sed lectus vulputate finibus',
-				'post_content' => 'Praesent imperdiet odio sed lectus vulputate finibus. Donec placerat ex arcu, eget fermentum metus ullamcorper vitae. Cras interdum libero a tellus sagittis, sed ultricies sapien tincidunt. Aliquam sit amet vehicula sem. Mauris neque nisl, pellentesque ut molestie id, laoreet nec tortor. Sed tempus ornare est, nec dapibus enim ornare eu. Cras risus ligula, blandit ut faucibus ut, vulputate id ipsum. In vel purus at orci hendrerit cursus. Aliquam interdum lorem id dui maximus volutpat. Vestibulum mi velit, efficitur nec neque eu, posuere porta risus.',
-				'post_type'    => 'entity',
-				'post_status'  => 'publish',
-			),
-			'entity_type_uri' => 'http://schema.org/Event',
-		),
-		array(
-			'post'            => array(
-				'post_name'    => 'nullam_tempor_lectus_sit_amet_tincidunt_euismod',
-				'post_title'   => 'Nullam tempor lectus sit amet tincidunt euismod',
-				'post_content' => '<span id="urn:enhancement-da554278-9522-2d83-76ad-8129d2292cb3" class="textannotation disambiguated wl-event" itemid="{dataset-uri}/entity/praesent_imperdiet_odio_sed_lectus_vulputate_finibus">Praesent imperdiet odio sed lectus vulputate finibus</span> Nullam tempor lectus sit amet tincidunt euismod. Nunc posuere libero augue, eu pretium erat interdum id. Vivamus aliquam dui in mauris tempor, vitae vestibulum odio aliquet. Proin quis bibendum diam, nec tempus dui. Pellentesque sit amet justo vitae urna ornare volutpat quis consectetur nisl. Sed hendrerit purus et magna varius, sodales tincidunt velit finibus. Donec malesuada faucibus mattis. Morbi viverra sagittis justo nec luctus. Nullam et justo sed nisi fringilla rutrum sit amet a urna. Integer elementum, risus in condimentum rhoncus, nisi velit cursus tellus, sed sagittis ante tellus hendrerit ante. Donec et semper libero, vitae imperdiet ligula. Donec eleifend iaculis nisi sed mollis. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Proin faucibus magna ac lectus tempor iaculis quis in nisi. Mauris ac nibh lacinia, ultrices erat quis, rhoncus lectus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.',
-				'post_type'    => 'entity',
-				'post_status'  => 'publish',
-			),
-			'entity_type_uri' => 'http://schema.org/Place',
-		),
-		array(
-			'post'            => array(
-				'post_name'    => 'praesent_luctus_tincidunt_odio_quis_aliquam',
-				'post_title'   => 'Praesent luctus tincidunt odio quis aliquam',
-				'post_content' => 'Praesent luctus tincidunt odio quis aliquam. Ut pellentesque odio nec turpis placerat, at rhoncus mauris elementum. Proin vehicula lectus a dolor bibendum, ut pretium lacus volutpat. Integer luctus enim sed odio dapibus tempus. Fusce elementum purus in diam dictum, sit amet ultricies leo molestie. Etiam id nunc tincidunt sapien tristique interdum ac at purus. Nulla eget laoreet turpis. Nullam id cursus nulla.',
-				'post_type'    => 'entity',
-				'post_status'  => 'publish',
-			),
-			'entity_type_uri' => 'http://schema.org/Organization',
-		),
-		array(
-			'post'            => array(
-				'post_name'    => 'lorem_ipsum_dolor_sit_amet__consectetur_adipiscing_elit',
-				'post_title'   => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit',
-				'post_content' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.',
-				'post_type'    => 'entity',
-				'post_status'  => 'publish',
-			),
-			'entity_type_uri' => 'http://schema.org/CreativeWork',
-		),
-		array(
-			'post' =>
-				array(
-					'post_name'    => 'post_1',
-					'post_title'   => 'Praesent imperdiet odio sed lectus vulputate finibus',
-					'post_content' => '<span><span id="urn:enhancement-da554278-9522-2d83-76ad-8129d2292cb3" class="textannotation disambiguated wl-event" itemid="{dataset-uri}/entity/praesent_imperdiet_odio_sed_lectus_vulputate_finibus">Praesent imperdiet odio sed lectus vulputate finibus</span>. Donec placerat ex arcu, eget fermentum metus ullamcorper vitae. Cras interdum libero a tellus sagittis, sed ultricies sapien tincidunt. Aliquam sit amet vehicula sem. Mauris neque nisl, pellentesque ut molestie id, laoreet nec tortor. Sed tempus ornare est, nec dapibus enim ornare eu. Cras risus ligula, blandit ut faucibus ut, vulputate id ipsum. In vel purus at orci hendrerit cursus. Aliquam interdum lorem id dui maximus volutpat. Vestibulum mi velit, efficitur nec neque eu, posuere porta risus.</span>',
-					'post_type'    => 'post',
-					'post_status'  => 'publish',
-				),
-		),
-		array(
-			'post' =>
-				array(
-					'post_name'    => 'post_2',
-					'post_title'   => 'Nullam tempor lectus sit amet tincidunt euismod',
-					'post_content' => '<span><span id="urn:local-text-annotation-p8i5o4279ex3rsbwqkrx9z5mh1ox91ae" class="textannotation disambiguated wl-place" itemid="{dataset-uri}/entity/nullam_tempor_lectus_sit_amet_tincidunt_euismod">Nullam tempor lectus sit amet tincidunt euismod</span>. Nunc posuere libero augue, eu pretium erat interdum id. Vivamus aliquam dui in mauris tempor, vitae vestibulum odio aliquet. Proin quis bibendum diam, nec tempus dui. Pellentesque sit amet justo vitae urna ornare volutpat quis consectetur nisl. Sed hendrerit purus et magna varius, sodales tincidunt velit finibus. Donec malesuada faucibus mattis. Morbi viverra sagittis justo nec luctus. Nullam et justo sed nisi fringilla rutrum sit amet a urna. Integer elementum, risus in condimentum rhoncus, nisi velit cursus tellus, sed sagittis ante tellus hendrerit ante. Donec et semper libero, vitae imperdiet ligula. Donec eleifend iaculis nisi sed mollis. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Proin faucibus magna ac lectus tempor iaculis quis in nisi. Mauris ac nibh lacinia, ultrices erat quis, rhoncus lectus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.</span>',
-					'post_type'    => 'post',
-					'post_status'  => 'publish',
-				),
-		),
-		array(
-			'post' =>
-				array(
-					'post_name'    => 'post_3',
-					'post_title'   => 'Praesent luctus tincidunt odio quis aliquam',
-					'post_content' => '<span><span id="urn:enhancement-b3487a20-4696-b6d9-6c55-842445f5c263" class="textannotation disambiguated wl-organization" itemid="{dataset-uri}/entity/praesent_luctus_tincidunt_odio_quis_aliquam">Praesent luctus tincidunt odio quis aliquam</span>. Ut pellentesque odio nec turpis placerat, at rhoncus mauris elementum. Proin vehicula lectus a dolor bibendum, ut pretium lacus volutpat. Integer luctus enim sed odio dapibus tempus. Fusce elementum purus in diam dictum, sit amet ultricies leo molestie. Etiam id nunc tincidunt sapien tristique interdum ac at purus. Nulla eget laoreet turpis. Nullam id cursus nulla.</span>',
-					'post_type'    => 'post',
-					'post_status'  => 'publish',
-				),
-		),
-		array(
-			'post' =>
-				array(
-					'post_name'    => 'post_4',
-					'post_title'   => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit',
-					'post_content' => '<span><span id="urn:enhancement-4edc3bde-d275-22f9-8d50-0b707596b292" class="textannotation disambiguated wl-thing" itemid="{dataset-uri}/entity/lorem_ipsum_dolor_sit_amet__consectetur_adipiscing_elit">Lorem ipsum dolor sit amet, consectetur adipiscing elit</span>. Proin rutrum ultrices nulla ut elementum. Nunc nec lacus tortor. Curabitur bibendum imperdiet luctus. Vivamus a faucibus dolor. Donec blandit malesuada risus. Vestibulum volutpat ut tellus sed tincidunt. Sed id tincidunt velit. Integer sed felis id libero fringilla molestie vitae id orci. Ut vel purus ullamcorper, feugiat tortor non, iaculis neque. Vivamus vitae vehicula sem. Mauris fermentum, metus id vestibulum sodales, lorem lacus efficitur ante, non vestibulum ligula ligula a turpis. Vivamus quis scelerisque massa.</span>',
-					'post_type'    => 'post',
-					'post_status'  => 'publish',
-				),
-		),
-		array(
-			'post' => array(
-				'post_name'    => 'post_5',
-				'post_title'   => 'Lorem ipsum',
-				'post_content' => '
+    /**
+     * An array of sample data.
+     *
+     * @since 3.12.0
+     * @var array $samples An array of sample data.
+     */
+    private $samples = array(
+        array(
+            'post'            => array(
+                'post_name'    => 'praesent_imperdiet_odio_sed_lectus_vulputate_finibus',
+                'post_title'   => 'Praesent imperdiet odio sed lectus vulputate finibus',
+                'post_content' => 'Praesent imperdiet odio sed lectus vulputate finibus. Donec placerat ex arcu, eget fermentum metus ullamcorper vitae. Cras interdum libero a tellus sagittis, sed ultricies sapien tincidunt. Aliquam sit amet vehicula sem. Mauris neque nisl, pellentesque ut molestie id, laoreet nec tortor. Sed tempus ornare est, nec dapibus enim ornare eu. Cras risus ligula, blandit ut faucibus ut, vulputate id ipsum. In vel purus at orci hendrerit cursus. Aliquam interdum lorem id dui maximus volutpat. Vestibulum mi velit, efficitur nec neque eu, posuere porta risus.',
+                'post_type'    => 'entity',
+                'post_status'  => 'publish',
+            ),
+            'entity_type_uri' => 'http://schema.org/Event',
+        ),
+        array(
+            'post'            => array(
+                'post_name'    => 'nullam_tempor_lectus_sit_amet_tincidunt_euismod',
+                'post_title'   => 'Nullam tempor lectus sit amet tincidunt euismod',
+                'post_content' => '<span id="urn:enhancement-da554278-9522-2d83-76ad-8129d2292cb3" class="textannotation disambiguated wl-event" itemid="{dataset-uri}/entity/praesent_imperdiet_odio_sed_lectus_vulputate_finibus">Praesent imperdiet odio sed lectus vulputate finibus</span> Nullam tempor lectus sit amet tincidunt euismod. Nunc posuere libero augue, eu pretium erat interdum id. Vivamus aliquam dui in mauris tempor, vitae vestibulum odio aliquet. Proin quis bibendum diam, nec tempus dui. Pellentesque sit amet justo vitae urna ornare volutpat quis consectetur nisl. Sed hendrerit purus et magna varius, sodales tincidunt velit finibus. Donec malesuada faucibus mattis. Morbi viverra sagittis justo nec luctus. Nullam et justo sed nisi fringilla rutrum sit amet a urna. Integer elementum, risus in condimentum rhoncus, nisi velit cursus tellus, sed sagittis ante tellus hendrerit ante. Donec et semper libero, vitae imperdiet ligula. Donec eleifend iaculis nisi sed mollis. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Proin faucibus magna ac lectus tempor iaculis quis in nisi. Mauris ac nibh lacinia, ultrices erat quis, rhoncus lectus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.',
+                'post_type'    => 'entity',
+                'post_status'  => 'publish',
+            ),
+            'entity_type_uri' => 'http://schema.org/Place',
+        ),
+        array(
+            'post'            => array(
+                'post_name'    => 'praesent_luctus_tincidunt_odio_quis_aliquam',
+                'post_title'   => 'Praesent luctus tincidunt odio quis aliquam',
+                'post_content' => 'Praesent luctus tincidunt odio quis aliquam. Ut pellentesque odio nec turpis placerat, at rhoncus mauris elementum. Proin vehicula lectus a dolor bibendum, ut pretium lacus volutpat. Integer luctus enim sed odio dapibus tempus. Fusce elementum purus in diam dictum, sit amet ultricies leo molestie. Etiam id nunc tincidunt sapien tristique interdum ac at purus. Nulla eget laoreet turpis. Nullam id cursus nulla.',
+                'post_type'    => 'entity',
+                'post_status'  => 'publish',
+            ),
+            'entity_type_uri' => 'http://schema.org/Organization',
+        ),
+        array(
+            'post'            => array(
+                'post_name'    => 'lorem_ipsum_dolor_sit_amet__consectetur_adipiscing_elit',
+                'post_title'   => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit',
+                'post_content' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.',
+                'post_type'    => 'entity',
+                'post_status'  => 'publish',
+            ),
+            'entity_type_uri' => 'http://schema.org/CreativeWork',
+        ),
+        array(
+            'post' =>
+                array(
+                    'post_name'    => 'post_1',
+                    'post_title'   => 'Praesent imperdiet odio sed lectus vulputate finibus',
+                    'post_content' => '<span><span id="urn:enhancement-da554278-9522-2d83-76ad-8129d2292cb3" class="textannotation disambiguated wl-event" itemid="{dataset-uri}/entity/praesent_imperdiet_odio_sed_lectus_vulputate_finibus">Praesent imperdiet odio sed lectus vulputate finibus</span>. Donec placerat ex arcu, eget fermentum metus ullamcorper vitae. Cras interdum libero a tellus sagittis, sed ultricies sapien tincidunt. Aliquam sit amet vehicula sem. Mauris neque nisl, pellentesque ut molestie id, laoreet nec tortor. Sed tempus ornare est, nec dapibus enim ornare eu. Cras risus ligula, blandit ut faucibus ut, vulputate id ipsum. In vel purus at orci hendrerit cursus. Aliquam interdum lorem id dui maximus volutpat. Vestibulum mi velit, efficitur nec neque eu, posuere porta risus.</span>',
+                    'post_type'    => 'post',
+                    'post_status'  => 'publish',
+                ),
+        ),
+        array(
+            'post' =>
+                array(
+                    'post_name'    => 'post_2',
+                    'post_title'   => 'Nullam tempor lectus sit amet tincidunt euismod',
+                    'post_content' => '<span><span id="urn:local-text-annotation-p8i5o4279ex3rsbwqkrx9z5mh1ox91ae" class="textannotation disambiguated wl-place" itemid="{dataset-uri}/entity/nullam_tempor_lectus_sit_amet_tincidunt_euismod">Nullam tempor lectus sit amet tincidunt euismod</span>. Nunc posuere libero augue, eu pretium erat interdum id. Vivamus aliquam dui in mauris tempor, vitae vestibulum odio aliquet. Proin quis bibendum diam, nec tempus dui. Pellentesque sit amet justo vitae urna ornare volutpat quis consectetur nisl. Sed hendrerit purus et magna varius, sodales tincidunt velit finibus. Donec malesuada faucibus mattis. Morbi viverra sagittis justo nec luctus. Nullam et justo sed nisi fringilla rutrum sit amet a urna. Integer elementum, risus in condimentum rhoncus, nisi velit cursus tellus, sed sagittis ante tellus hendrerit ante. Donec et semper libero, vitae imperdiet ligula. Donec eleifend iaculis nisi sed mollis. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Proin faucibus magna ac lectus tempor iaculis quis in nisi. Mauris ac nibh lacinia, ultrices erat quis, rhoncus lectus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.</span>',
+                    'post_type'    => 'post',
+                    'post_status'  => 'publish',
+                ),
+        ),
+        array(
+            'post' =>
+                array(
+                    'post_name'    => 'post_3',
+                    'post_title'   => 'Praesent luctus tincidunt odio quis aliquam',
+                    'post_content' => '<span><span id="urn:enhancement-b3487a20-4696-b6d9-6c55-842445f5c263" class="textannotation disambiguated wl-organization" itemid="{dataset-uri}/entity/praesent_luctus_tincidunt_odio_quis_aliquam">Praesent luctus tincidunt odio quis aliquam</span>. Ut pellentesque odio nec turpis placerat, at rhoncus mauris elementum. Proin vehicula lectus a dolor bibendum, ut pretium lacus volutpat. Integer luctus enim sed odio dapibus tempus. Fusce elementum purus in diam dictum, sit amet ultricies leo molestie. Etiam id nunc tincidunt sapien tristique interdum ac at purus. Nulla eget laoreet turpis. Nullam id cursus nulla.</span>',
+                    'post_type'    => 'post',
+                    'post_status'  => 'publish',
+                ),
+        ),
+        array(
+            'post' =>
+                array(
+                    'post_name'    => 'post_4',
+                    'post_title'   => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit',
+                    'post_content' => '<span><span id="urn:enhancement-4edc3bde-d275-22f9-8d50-0b707596b292" class="textannotation disambiguated wl-thing" itemid="{dataset-uri}/entity/lorem_ipsum_dolor_sit_amet__consectetur_adipiscing_elit">Lorem ipsum dolor sit amet, consectetur adipiscing elit</span>. Proin rutrum ultrices nulla ut elementum. Nunc nec lacus tortor. Curabitur bibendum imperdiet luctus. Vivamus a faucibus dolor. Donec blandit malesuada risus. Vestibulum volutpat ut tellus sed tincidunt. Sed id tincidunt velit. Integer sed felis id libero fringilla molestie vitae id orci. Ut vel purus ullamcorper, feugiat tortor non, iaculis neque. Vivamus vitae vehicula sem. Mauris fermentum, metus id vestibulum sodales, lorem lacus efficitur ante, non vestibulum ligula ligula a turpis. Vivamus quis scelerisque massa.</span>',
+                    'post_type'    => 'post',
+                    'post_status'  => 'publish',
+                ),
+        ),
+        array(
+            'post' => array(
+                'post_name'    => 'post_5',
+                'post_title'   => 'Lorem ipsum',
+                'post_content' => '
 					<span id="urn:enhancement-28cb4112-64cf-bd49-ef97-a2ee54727de7" class="textannotation disambiguated wl-thing" itemid="{dataset-uri}/entity/lorem_ipsum_dolor_sit_amet__consectetur_adipiscing_elit">Lorem ipsum</span> dolor sit amet, consectetur adipiscing elit. Proin rutrum ultrices nulla ut elementum. Nunc nec lacus tortor. Curabitur bibendum imperdiet luctus. Vivamus a faucibus dolor. Donec blandit malesuada risus. Vestibulum volutpat ut tellus sed tincidunt. Sed id tincidunt velit. Integer sed felis id libero fringilla molestie vitae id orci. Ut vel purus ullamcorper, feugiat tortor non, iaculis neque. Vivamus vitae vehicula sem. Mauris fermentum, metus id vestibulum sodales, lorem lacus efficitur ante, non vestibulum ligula ligula a turpis. Vivamus quis scelerisque massa.
 					
 					[wl_navigator]
@@ -123,242 +123,242 @@ 
 					
 					<span id="urn:local-text-annotation-v0kqdtx685n6cg9jrfvl67amkhm28hxh" class="textannotation disambiguated wl-event" itemid="{dataset-uri}/entity/praesent_imperdiet_odio_sed_lectus_vulputate_finibus">Praesent imperdiet odio sed lectus vulputate finibus</span>. Donec placerat ex arcu, eget fermentum metus ullamcorper vitae. Cras interdum libero a tellus sagittis, sed ultricies sapien tincidunt. Aliquam sit amet vehicula sem. Mauris neque nisl, pellentesque ut molestie id, laoreet nec tortor. Sed tempus ornare est, nec dapibus enim ornare eu. Cras risus ligula, blandit ut faucibus ut, vulputate id ipsum. In vel purus at orci hendrerit cursus. Aliquam interdum lorem id dui maximus volutpat. Vestibulum mi velit, efficitur nec neque eu, posuere porta risus.
 					',
-				'post_type'    => 'post',
-				'post_status'  => 'publish',
-			),
-		),
-	);
-
-	/**
-	 * The {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since  3.12.0
-	 * @access private
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	private $entity_type_service;
-
-	/**
-	 * The {@link Wordlift_User_Service} instance.
-	 *
-	 * @since  3.16.0
-	 * @access private
-	 * @var \Wordlift_User_Service $user_service The {@link Wordlift_User_Service} instance.
-	 */
-	private $user_service;
-
-	/**
-	 * Create a {@link Wordlift_Sample_Data_Service} instance.
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 * @param \Wordlift_User_Service        $user_service The {@link Wordlift_User_Service} instance.
-	 *
-	 * @since 3.12.0
-	 */
-	protected function __construct( $entity_type_service, $user_service ) {
-
-		$this->entity_type_service = $entity_type_service;
-		$this->user_service        = $user_service;
-
-	}
-
-	private static $instance = null;
-
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self( Wordlift_Entity_Type_Service::get_instance(), Wordlift_User_Service::get_instance() );
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Create sample data in this WordPress instance.
-	 *
-	 * @since 3.12.0
-	 */
-	public function create() {
-
-		// Get the source image path.
-		$source = plugin_dir_path( __DIR__ ) . 'images/rome.png';
-
-		// Create an attachment with the local file.
-		$attachment_id = $this->create_attachment_from_local_file( $source );
-
-		// Add a flag to signal the attachment is sample data and allow easy delete
-		// afterwards.
-		add_post_meta( $attachment_id, '_wl_sample_data', 1, true );
-
-		// Get the dataset URI, used for replacements in the `post_content`.
-		$dataset_uri = untrailingslashit( Wordlift_Configuration_Service::get_instance()->get_dataset_uri() );
-
-		// Create the author and get its id.
-		$author_id = $this->create_author();
-
-		// Create 4 entities.
-		// Create 4 posts referencing each one entity.
-		// Create 1 post referencing all the entities.
-		foreach ( $this->samples as $sample ) {
-
-			// Get the post data.
-			$post = array_replace_recursive(
-				$sample['post'],
-				array(
-					'post_content' => str_replace( '{dataset-uri}', $dataset_uri, $sample['post']['post_content'] ),
-				)
-			);
-
-			// Set the author.
-			$post['post_author'] = $author_id;
-
-			// Insert the post.
-			$post_id = wp_insert_post( $post );
-
-			// Add a flag to signal the post is sample data and allow easy delete
-			// afterwards.
-			add_post_meta( $post_id, '_wl_sample_data', 1, true );
-
-			// Set the post thumbnail.
-			set_post_thumbnail( $post_id, $attachment_id );
-
-			// If the `entity_type_uri` property is set, set it on the post.
-			if ( isset( $sample['entity_type_uri'] ) ) {
-				$this->entity_type_service->set( $post_id, $sample['entity_type_uri'] );
-			}
-		}
-
-	}
-
-	/**
-	 * Create an author to bind to posts.
-	 *
-	 * @return int The {@link WP_User}'s id.
-	 * @since 3.16.0
-	 */
-	private function create_author() {
-
-		$user_id        = wp_create_user( 'wl-sample-data', wp_generate_password() );
-		$author_post_id = wp_insert_post(
-			array(
-				'post_type'  => 'entity',
-				'post_title' => 'WordLift Sample Data Person',
-			)
-		);
-		// Add a flag to signal the attachment is sample data and allow easy delete
-		// afterwards.
-		add_post_meta( $author_post_id, '_wl_sample_data', 1, true );
-
-		$this->entity_type_service->set( $author_post_id, 'http://schema.org/Person' );
-		$this->user_service->set_entity( $user_id, $author_post_id );
-
-		return $user_id;
-	}
-
-	/**
-	 * Remove the sample data from this WordPress instance.
-	 *
-	 * @since 3.12.0
-	 */
-	public function delete() {
-
-		$this->delete_by_type( 'post' );
-		$this->delete_by_type( 'entity' );
-		$this->delete_by_type( 'attachment' );
-
-		// Get and delete the user.
-		$user = get_user_by( 'login', 'wl-sample-data' );
-		wp_delete_user( $user->ID );
-
-	}
-
-	/**
-	 * Remove the sample data of the specified type (e.g. `post`, `entity`, `attachment`)
-	 * from the local WordPress instance.
-	 *
-	 * @param string $type WordPress {@link WP_Post}'s type, e.g. `post`, `entity`, `attachment`.
-	 *
-	 * @since 3.12.0
-	 */
-	private function delete_by_type( $type ) {
-
-		$posts = get_posts(
-			array(
-				'meta_key'    => '_wl_sample_data',
-				'meta_value'  => 1,
-				'post_status' => 'any',
-				'post_type'   => $type,
-			)
-		);
-
-		foreach ( $posts as $post ) {
-			wp_delete_post( $post->ID, true );
-		}
-
-	}
-
-	/**
-	 * Create a WordPress' attachment using the specified file.
-	 *
-	 * @param string $source The source file path.
-	 *
-	 * @return int WordPress' attachment's id.
-	 * @since 3.12.0
-	 */
-	private function create_attachment_from_local_file( $source ) {
-
-		// Get the path to the upload directory.
-		$upload_dir  = wp_upload_dir();
-		$upload_path = $upload_dir['path'];
-
-		// Get the destination image path.
-		$destination = $upload_path . '/wl-sample-data.png';
-
-		// Copy the source file to the destination.
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@copy( $source, $destination );
-
-		return $this->create_attachment( $destination );
-	}
-
-	/**
-	 * Create a WordPress attachment using the specified file in the upload folder.
-	 *
-	 * @see   https://codex.wordpress.org/Function_Reference/wp_insert_attachment
-	 *
-	 * @since 3.12.0
-	 *
-	 * @param string $filename The image filename.
-	 *
-	 * @return int The attachment id.
-	 */
-	private function create_attachment( $filename ) {
-
-		// Check the type of file. We'll use this as the 'post_mime_type'.
-		$filetype = wp_check_filetype( basename( $filename ), null );
-
-		// Get the path to the upload directory.
-		$wp_upload_dir = wp_upload_dir();
-
-		// Prepare an array of post data for the attachment.
-		$attachment = array(
-			'guid'           => $wp_upload_dir['url'] . '/' . basename( $filename ),
-			'post_mime_type' => $filetype['type'],
-			'post_title'     => preg_replace( '/\.[^.]+$/', '', basename( $filename ) ),
-			'post_content'   => '',
-			'post_status'    => 'inherit',
-		);
-
-		// Insert the attachment.
-		$attachment_id = wp_insert_attachment( $attachment, $filename );
-
-		// Generate the metadata for the attachment, and update the database record.
-		$attachment_data = wp_generate_attachment_metadata( $attachment_id, $filename );
-
-		// Update the attachment metadata.
-		wp_update_attachment_metadata( $attachment_id, $attachment_data );
-
-		return $attachment_id;
-	}
+                'post_type'    => 'post',
+                'post_status'  => 'publish',
+            ),
+        ),
+    );
+
+    /**
+     * The {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since  3.12.0
+     * @access private
+     * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     */
+    private $entity_type_service;
+
+    /**
+     * The {@link Wordlift_User_Service} instance.
+     *
+     * @since  3.16.0
+     * @access private
+     * @var \Wordlift_User_Service $user_service The {@link Wordlift_User_Service} instance.
+     */
+    private $user_service;
+
+    /**
+     * Create a {@link Wordlift_Sample_Data_Service} instance.
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     * @param \Wordlift_User_Service        $user_service The {@link Wordlift_User_Service} instance.
+     *
+     * @since 3.12.0
+     */
+    protected function __construct( $entity_type_service, $user_service ) {
+
+        $this->entity_type_service = $entity_type_service;
+        $this->user_service        = $user_service;
+
+    }
+
+    private static $instance = null;
+
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self( Wordlift_Entity_Type_Service::get_instance(), Wordlift_User_Service::get_instance() );
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Create sample data in this WordPress instance.
+     *
+     * @since 3.12.0
+     */
+    public function create() {
+
+        // Get the source image path.
+        $source = plugin_dir_path( __DIR__ ) . 'images/rome.png';
+
+        // Create an attachment with the local file.
+        $attachment_id = $this->create_attachment_from_local_file( $source );
+
+        // Add a flag to signal the attachment is sample data and allow easy delete
+        // afterwards.
+        add_post_meta( $attachment_id, '_wl_sample_data', 1, true );
+
+        // Get the dataset URI, used for replacements in the `post_content`.
+        $dataset_uri = untrailingslashit( Wordlift_Configuration_Service::get_instance()->get_dataset_uri() );
+
+        // Create the author and get its id.
+        $author_id = $this->create_author();
+
+        // Create 4 entities.
+        // Create 4 posts referencing each one entity.
+        // Create 1 post referencing all the entities.
+        foreach ( $this->samples as $sample ) {
+
+            // Get the post data.
+            $post = array_replace_recursive(
+                $sample['post'],
+                array(
+                    'post_content' => str_replace( '{dataset-uri}', $dataset_uri, $sample['post']['post_content'] ),
+                )
+            );
+
+            // Set the author.
+            $post['post_author'] = $author_id;
+
+            // Insert the post.
+            $post_id = wp_insert_post( $post );
+
+            // Add a flag to signal the post is sample data and allow easy delete
+            // afterwards.
+            add_post_meta( $post_id, '_wl_sample_data', 1, true );
+
+            // Set the post thumbnail.
+            set_post_thumbnail( $post_id, $attachment_id );
+
+            // If the `entity_type_uri` property is set, set it on the post.
+            if ( isset( $sample['entity_type_uri'] ) ) {
+                $this->entity_type_service->set( $post_id, $sample['entity_type_uri'] );
+            }
+        }
+
+    }
+
+    /**
+     * Create an author to bind to posts.
+     *
+     * @return int The {@link WP_User}'s id.
+     * @since 3.16.0
+     */
+    private function create_author() {
+
+        $user_id        = wp_create_user( 'wl-sample-data', wp_generate_password() );
+        $author_post_id = wp_insert_post(
+            array(
+                'post_type'  => 'entity',
+                'post_title' => 'WordLift Sample Data Person',
+            )
+        );
+        // Add a flag to signal the attachment is sample data and allow easy delete
+        // afterwards.
+        add_post_meta( $author_post_id, '_wl_sample_data', 1, true );
+
+        $this->entity_type_service->set( $author_post_id, 'http://schema.org/Person' );
+        $this->user_service->set_entity( $user_id, $author_post_id );
+
+        return $user_id;
+    }
+
+    /**
+     * Remove the sample data from this WordPress instance.
+     *
+     * @since 3.12.0
+     */
+    public function delete() {
+
+        $this->delete_by_type( 'post' );
+        $this->delete_by_type( 'entity' );
+        $this->delete_by_type( 'attachment' );
+
+        // Get and delete the user.
+        $user = get_user_by( 'login', 'wl-sample-data' );
+        wp_delete_user( $user->ID );
+
+    }
+
+    /**
+     * Remove the sample data of the specified type (e.g. `post`, `entity`, `attachment`)
+     * from the local WordPress instance.
+     *
+     * @param string $type WordPress {@link WP_Post}'s type, e.g. `post`, `entity`, `attachment`.
+     *
+     * @since 3.12.0
+     */
+    private function delete_by_type( $type ) {
+
+        $posts = get_posts(
+            array(
+                'meta_key'    => '_wl_sample_data',
+                'meta_value'  => 1,
+                'post_status' => 'any',
+                'post_type'   => $type,
+            )
+        );
+
+        foreach ( $posts as $post ) {
+            wp_delete_post( $post->ID, true );
+        }
+
+    }
+
+    /**
+     * Create a WordPress' attachment using the specified file.
+     *
+     * @param string $source The source file path.
+     *
+     * @return int WordPress' attachment's id.
+     * @since 3.12.0
+     */
+    private function create_attachment_from_local_file( $source ) {
+
+        // Get the path to the upload directory.
+        $upload_dir  = wp_upload_dir();
+        $upload_path = $upload_dir['path'];
+
+        // Get the destination image path.
+        $destination = $upload_path . '/wl-sample-data.png';
+
+        // Copy the source file to the destination.
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @copy( $source, $destination );
+
+        return $this->create_attachment( $destination );
+    }
+
+    /**
+     * Create a WordPress attachment using the specified file in the upload folder.
+     *
+     * @see   https://codex.wordpress.org/Function_Reference/wp_insert_attachment
+     *
+     * @since 3.12.0
+     *
+     * @param string $filename The image filename.
+     *
+     * @return int The attachment id.
+     */
+    private function create_attachment( $filename ) {
+
+        // Check the type of file. We'll use this as the 'post_mime_type'.
+        $filetype = wp_check_filetype( basename( $filename ), null );
+
+        // Get the path to the upload directory.
+        $wp_upload_dir = wp_upload_dir();
+
+        // Prepare an array of post data for the attachment.
+        $attachment = array(
+            'guid'           => $wp_upload_dir['url'] . '/' . basename( $filename ),
+            'post_mime_type' => $filetype['type'],
+            'post_title'     => preg_replace( '/\.[^.]+$/', '', basename( $filename ) ),
+            'post_content'   => '',
+            'post_status'    => 'inherit',
+        );
+
+        // Insert the attachment.
+        $attachment_id = wp_insert_attachment( $attachment, $filename );
+
+        // Generate the metadata for the attachment, and update the database record.
+        $attachment_data = wp_generate_attachment_metadata( $attachment_id, $filename );
+
+        // Update the attachment metadata.
+        wp_update_attachment_metadata( $attachment_id, $attachment_data );
+
+        return $attachment_id;
+    }
 
 }

Spacing +37 added lines, -37 removed lines

@@ -155,7 +155,7 @@ 
 	 *
 	 * @since 3.12.0
 	 */
-	protected function __construct( $entity_type_service, $user_service ) {
+	protected function __construct($entity_type_service, $user_service) {
 
 		$this->entity_type_service = $entity_type_service;
 		$this->user_service        = $user_service;
@@ -166,8 +166,8 @@ 
 
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self( Wordlift_Entity_Type_Service::get_instance(), Wordlift_User_Service::get_instance() );
+		if ( ! isset(self::$instance)) {
+			self::$instance = new self(Wordlift_Entity_Type_Service::get_instance(), Wordlift_User_Service::get_instance());
 		}
 
 		return self::$instance;
@@ -181,17 +181,17 @@ 
 	public function create() {
 
 		// Get the source image path.
-		$source = plugin_dir_path( __DIR__ ) . 'images/rome.png';
+		$source = plugin_dir_path(__DIR__).'images/rome.png';
 
 		// Create an attachment with the local file.
-		$attachment_id = $this->create_attachment_from_local_file( $source );
+		$attachment_id = $this->create_attachment_from_local_file($source);
 
 		// Add a flag to signal the attachment is sample data and allow easy delete
 		// afterwards.
-		add_post_meta( $attachment_id, '_wl_sample_data', 1, true );
+		add_post_meta($attachment_id, '_wl_sample_data', 1, true);
 
 		// Get the dataset URI, used for replacements in the `post_content`.
-		$dataset_uri = untrailingslashit( Wordlift_Configuration_Service::get_instance()->get_dataset_uri() );
+		$dataset_uri = untrailingslashit(Wordlift_Configuration_Service::get_instance()->get_dataset_uri());
 
 		// Create the author and get its id.
 		$author_id = $this->create_author();
@@ -199,13 +199,13 @@ 
 		// Create 4 entities.
 		// Create 4 posts referencing each one entity.
 		// Create 1 post referencing all the entities.
-		foreach ( $this->samples as $sample ) {
+		foreach ($this->samples as $sample) {
 
 			// Get the post data.
 			$post = array_replace_recursive(
 				$sample['post'],
 				array(
-					'post_content' => str_replace( '{dataset-uri}', $dataset_uri, $sample['post']['post_content'] ),
+					'post_content' => str_replace('{dataset-uri}', $dataset_uri, $sample['post']['post_content']),
 				)
 			);
 
@@ -213,18 +213,18 @@ 
 			$post['post_author'] = $author_id;
 
 			// Insert the post.
-			$post_id = wp_insert_post( $post );
+			$post_id = wp_insert_post($post);
 
 			// Add a flag to signal the post is sample data and allow easy delete
 			// afterwards.
-			add_post_meta( $post_id, '_wl_sample_data', 1, true );
+			add_post_meta($post_id, '_wl_sample_data', 1, true);
 
 			// Set the post thumbnail.
-			set_post_thumbnail( $post_id, $attachment_id );
+			set_post_thumbnail($post_id, $attachment_id);
 
 			// If the `entity_type_uri` property is set, set it on the post.
-			if ( isset( $sample['entity_type_uri'] ) ) {
-				$this->entity_type_service->set( $post_id, $sample['entity_type_uri'] );
+			if (isset($sample['entity_type_uri'])) {
+				$this->entity_type_service->set($post_id, $sample['entity_type_uri']);
 			}
 		}
 
@@ -238,7 +238,7 @@ 
 	 */
 	private function create_author() {
 
-		$user_id        = wp_create_user( 'wl-sample-data', wp_generate_password() );
+		$user_id        = wp_create_user('wl-sample-data', wp_generate_password());
 		$author_post_id = wp_insert_post(
 			array(
 				'post_type'  => 'entity',
@@ -247,10 +247,10 @@ 
 		);
 		// Add a flag to signal the attachment is sample data and allow easy delete
 		// afterwards.
-		add_post_meta( $author_post_id, '_wl_sample_data', 1, true );
+		add_post_meta($author_post_id, '_wl_sample_data', 1, true);
 
-		$this->entity_type_service->set( $author_post_id, 'http://schema.org/Person' );
-		$this->user_service->set_entity( $user_id, $author_post_id );
+		$this->entity_type_service->set($author_post_id, 'http://schema.org/Person');
+		$this->user_service->set_entity($user_id, $author_post_id);
 
 		return $user_id;
 	}
@@ -262,13 +262,13 @@ 
 	 */
 	public function delete() {
 
-		$this->delete_by_type( 'post' );
-		$this->delete_by_type( 'entity' );
-		$this->delete_by_type( 'attachment' );
+		$this->delete_by_type('post');
+		$this->delete_by_type('entity');
+		$this->delete_by_type('attachment');
 
 		// Get and delete the user.
-		$user = get_user_by( 'login', 'wl-sample-data' );
-		wp_delete_user( $user->ID );
+		$user = get_user_by('login', 'wl-sample-data');
+		wp_delete_user($user->ID);
 
 	}
 
@@ -280,7 +280,7 @@ 
 	 *
 	 * @since 3.12.0
 	 */
-	private function delete_by_type( $type ) {
+	private function delete_by_type($type) {
 
 		$posts = get_posts(
 			array(
@@ -291,8 +291,8 @@ 
 			)
 		);
 
-		foreach ( $posts as $post ) {
-			wp_delete_post( $post->ID, true );
+		foreach ($posts as $post) {
+			wp_delete_post($post->ID, true);
 		}
 
 	}
@@ -305,20 +305,20 @@ 
 	 * @return int WordPress' attachment's id.
 	 * @since 3.12.0
 	 */
-	private function create_attachment_from_local_file( $source ) {
+	private function create_attachment_from_local_file($source) {
 
 		// Get the path to the upload directory.
 		$upload_dir  = wp_upload_dir();
 		$upload_path = $upload_dir['path'];
 
 		// Get the destination image path.
-		$destination = $upload_path . '/wl-sample-data.png';
+		$destination = $upload_path.'/wl-sample-data.png';
 
 		// Copy the source file to the destination.
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@copy( $source, $destination );
+		@copy($source, $destination);
 
-		return $this->create_attachment( $destination );
+		return $this->create_attachment($destination);
 	}
 
 	/**
@@ -332,31 +332,31 @@ 
 	 *
 	 * @return int The attachment id.
 	 */
-	private function create_attachment( $filename ) {
+	private function create_attachment($filename) {
 
 		// Check the type of file. We'll use this as the 'post_mime_type'.
-		$filetype = wp_check_filetype( basename( $filename ), null );
+		$filetype = wp_check_filetype(basename($filename), null);
 
 		// Get the path to the upload directory.
 		$wp_upload_dir = wp_upload_dir();
 
 		// Prepare an array of post data for the attachment.
 		$attachment = array(
-			'guid'           => $wp_upload_dir['url'] . '/' . basename( $filename ),
+			'guid'           => $wp_upload_dir['url'].'/'.basename($filename),
 			'post_mime_type' => $filetype['type'],
-			'post_title'     => preg_replace( '/\.[^.]+$/', '', basename( $filename ) ),
+			'post_title'     => preg_replace('/\.[^.]+$/', '', basename($filename)),
 			'post_content'   => '',
 			'post_status'    => 'inherit',
 		);
 
 		// Insert the attachment.
-		$attachment_id = wp_insert_attachment( $attachment, $filename );
+		$attachment_id = wp_insert_attachment($attachment, $filename);
 
 		// Generate the metadata for the attachment, and update the database record.
-		$attachment_data = wp_generate_attachment_metadata( $attachment_id, $filename );
+		$attachment_data = wp_generate_attachment_metadata($attachment_id, $filename);
 
 		// Update the attachment metadata.
-		wp_update_attachment_metadata( $attachment_id, $attachment_data );
+		wp_update_attachment_metadata($attachment_id, $attachment_data);
 
 		return $attachment_id;
 	}

src/includes/class-wordlift-content-filter-service.php

Indentation +252 added lines, -252 removed lines

@@ -23,257 +23,257 @@
  */
 class Wordlift_Content_Filter_Service {
 
-	/**
-	 * The pattern to find entities in text.
-	 *
-	 * @since 3.8.0
-	 */
-	const PATTERN = '/<(\\w+)[^<]*class="([^"]*)"\\sitemid=\"([^"]+)\"[^>]*>([^<]*)<\\/\\1>/i';
-
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * The `link by default` setting.
-	 *
-	 * @since  3.13.0
-	 * @access private
-	 * @var bool True if link by default is enabled otherwise false.
-	 */
-	private $is_link_by_default;
-
-	private $linked_entity_uris = array();
-
-	/**
-	 * The {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-	/**
-	 * @var Object_Link_Provider
-	 */
-	private $object_link_provider;
-
-	/**
-	 * Create a {@link Wordlift_Content_Filter_Service} instance.
-	 *
-	 * @param \Wordlift_Entity_Service     $entity_service The {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since 3.8.0
-	 */
-	protected function __construct( $entity_service, $entity_uri_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->entity_service       = $entity_service;
-		$this->entity_uri_service   = $entity_uri_service;
-		$this->object_link_provider = Object_Link_Provider::get_instance();
-
-	}
-
-	private static $instance = null;
-
-	/**
-	 * Get the {@link Wordlift_Content_Filter_Service} singleton instance.
-	 *
-	 * @return \Wordlift_Content_Filter_Service The {@link Wordlift_Content_Filter_Service} singleton instance.
-	 * @since 3.14.2
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self( Wordlift_Entity_Service::get_instance(), Wordlift_Entity_Uri_Service::get_instance() );
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Mangle the content by adding links to the entity pages. This function is
-	 * hooked to the 'the_content' WP's filter.
-	 *
-	 * @param string $content The content being filtered.
-	 *
-	 * @return string The filtered content.
-	 * @since 3.8.0
-	 */
-	public function the_content( $content ) {
-		$this->log->trace( 'Filtering content [ ' . ( is_singular() ? 'yes' : 'no' ) . ' ]...' );
-
-		// Links should be added only on the front end and not for RSS.
-		if ( is_feed() || is_admin() || is_search() ) {
-			return $content;
-		}
-
-		// Preload the `link by default` setting.
-		$this->is_link_by_default = Wordlift_Configuration_Service::get_instance()->is_link_by_default();
-
-		// Reset the array of of entity post ids linked from the post content.
-		// This is used to avoid linking more the once the same post.
-		$this->linked_entity_uris = array();
-
-		// Preload URIs.
-		$matches = array();
-		preg_match_all( self::PATTERN, $content, $matches );
-
-		// Bail out if there are no URIs.
-		if ( empty( $matches[3] ) ) {
-			return $content;
-		}
-
-		// Replace each match of the entity tag with the entity link. If an error
-		// occurs fail silently returning the original content.
-		$maybe_content = preg_replace_callback(
-			self::PATTERN,
-			array(
-				$this,
-				'link',
-			),
-			$content
-		);
-
-		return $maybe_content ? $maybe_content : $content;
-	}
-
-	/**
-	 * Get the entity match and replace it with a page link.
-	 *
-	 * @param array $matches An array of matches.
-	 *
-	 * @return string The replaced text with the link to the entity page.
-	 * @since 3.8.0
-	 */
-	private function link( $matches ) {
-
-		// Get the entity itemid URI and label.
-		$css_class = $matches[2];
-		$uri       = $matches[3];
-		$label     = $matches[4];
-
-		/**
-		 * If the entity is already linked, dont send query to the db.
-		 */
-		if ( $this->is_already_linked( $uri ) ) {
-			return $label;
-		}
-
-		$link = - 1 < strpos( $css_class, 'wl-link' );
-
-		// If the entity should not be linked and link by default is also disabled,
-		// then don't lookup the entity on the table.
-		if ( ! $this->is_link_by_default && ! $link ) {
-			return $label;
-		}
-
-		$content_service = Wordpress_Content_Service::get_instance();
-		$content         = $content_service->get_by_entity_id_or_same_as( $uri );
-
-		// If no content is found, return the label, that is _remove the annotation_.
-		if ( ! is_object( $content ) ) {
-			return $label;
-		}
-
-		$object_id   = $content->get_id();
-		$object_type = $content->get_object_type_enum();
-
-		$no_link = - 1 < strpos( $css_class, 'wl-no-link' );
-
-		// Don't link if links are disabled and the entity is not link or the
-		// entity is do not link.
-		$dont_link = ( ! $this->is_link_by_default && ! $link ) || $no_link;
-
-		// Return the label if it's don't link.
-		if ( $dont_link ) {
-			return $label;
-		}
-
-		/**
-		 * @since 3.32.0
-		 * Object_ids are prefixed with object_type to prevent conflicts.
-		 */
-		$this->linked_entity_uris[] = $uri;
-
-		// Get the link.
-		$href = Wordlift_Post_Adapter::get_production_permalink( $object_id, $object_type );
-
-		// Bail out if the `$href` has been reset.
-		if ( empty( $href ) ) {
-			return $label;
-		}
-
-		return Link_Builder::create( $uri, $object_id )
-						   ->label( $label )
-						   ->href( $href )
-						   ->generate_link();
-	}
-
-	/**
-	 * Get a string to be used as a title attribute in links to a post
-	 *
-	 * @param int    $post_id The post id of the post being linked.
-	 * @param string $ignore_label A label to ignore.
-	 *
-	 * @return string    The title to be used in the link. An empty string when
-	 *                    there is no alternative that is not the $ignore_label.
-	 * @deprecated 3.32.0 Use object link provider to get the link title for getting link
-	 * title for different types.
-	 * @since 3.15.0
-	 *
-	 * As of 3.32.0 this method is not used anywhere in the core, this should be removed
-	 * from tests and companion plugins.
-	 */
-	public function get_link_title( $post_id, $ignore_label, $object_type = Object_Type_Enum::POST ) {
-		return $this->object_link_provider->get_link_title( $post_id, $ignore_label, $object_type );
-	}
-
-	/**
-	 * Get the entity URIs (configured in the `itemid` attribute) contained in
-	 * the provided content.
-	 *
-	 * @param string $content The content.
-	 *
-	 * @return array An array of URIs.
-	 * @since 3.14.2
-	 */
-	public function get_entity_uris( $content ) {
-
-		$matches = array();
-		preg_match_all( self::PATTERN, $content, $matches );
-
-		// We need to use `array_values` here in order to avoid further `json_encode`
-		// to turn it into an object (since if the 3rd match isn't found the index
-		// is not sequential.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/646.
-		return array_values( array_unique( $matches[3] ) );
-	}
-
-	/**
-	 * @param $entity_uri
-	 *
-	 * @return bool
-	 */
-	private function is_already_linked( $entity_uri ) {
-		return in_array( $entity_uri, $this->linked_entity_uris, true );
-	}
+    /**
+     * The pattern to find entities in text.
+     *
+     * @since 3.8.0
+     */
+    const PATTERN = '/<(\\w+)[^<]*class="([^"]*)"\\sitemid=\"([^"]+)\"[^>]*>([^<]*)<\\/\\1>/i';
+
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * The `link by default` setting.
+     *
+     * @since  3.13.0
+     * @access private
+     * @var bool True if link by default is enabled otherwise false.
+     */
+    private $is_link_by_default;
+
+    private $linked_entity_uris = array();
+
+    /**
+     * The {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    private $entity_uri_service;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+    /**
+     * @var Object_Link_Provider
+     */
+    private $object_link_provider;
+
+    /**
+     * Create a {@link Wordlift_Content_Filter_Service} instance.
+     *
+     * @param \Wordlift_Entity_Service     $entity_service The {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since 3.8.0
+     */
+    protected function __construct( $entity_service, $entity_uri_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->entity_service       = $entity_service;
+        $this->entity_uri_service   = $entity_uri_service;
+        $this->object_link_provider = Object_Link_Provider::get_instance();
+
+    }
+
+    private static $instance = null;
+
+    /**
+     * Get the {@link Wordlift_Content_Filter_Service} singleton instance.
+     *
+     * @return \Wordlift_Content_Filter_Service The {@link Wordlift_Content_Filter_Service} singleton instance.
+     * @since 3.14.2
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self( Wordlift_Entity_Service::get_instance(), Wordlift_Entity_Uri_Service::get_instance() );
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Mangle the content by adding links to the entity pages. This function is
+     * hooked to the 'the_content' WP's filter.
+     *
+     * @param string $content The content being filtered.
+     *
+     * @return string The filtered content.
+     * @since 3.8.0
+     */
+    public function the_content( $content ) {
+        $this->log->trace( 'Filtering content [ ' . ( is_singular() ? 'yes' : 'no' ) . ' ]...' );
+
+        // Links should be added only on the front end and not for RSS.
+        if ( is_feed() || is_admin() || is_search() ) {
+            return $content;
+        }
+
+        // Preload the `link by default` setting.
+        $this->is_link_by_default = Wordlift_Configuration_Service::get_instance()->is_link_by_default();
+
+        // Reset the array of of entity post ids linked from the post content.
+        // This is used to avoid linking more the once the same post.
+        $this->linked_entity_uris = array();
+
+        // Preload URIs.
+        $matches = array();
+        preg_match_all( self::PATTERN, $content, $matches );
+
+        // Bail out if there are no URIs.
+        if ( empty( $matches[3] ) ) {
+            return $content;
+        }
+
+        // Replace each match of the entity tag with the entity link. If an error
+        // occurs fail silently returning the original content.
+        $maybe_content = preg_replace_callback(
+            self::PATTERN,
+            array(
+                $this,
+                'link',
+            ),
+            $content
+        );
+
+        return $maybe_content ? $maybe_content : $content;
+    }
+
+    /**
+     * Get the entity match and replace it with a page link.
+     *
+     * @param array $matches An array of matches.
+     *
+     * @return string The replaced text with the link to the entity page.
+     * @since 3.8.0
+     */
+    private function link( $matches ) {
+
+        // Get the entity itemid URI and label.
+        $css_class = $matches[2];
+        $uri       = $matches[3];
+        $label     = $matches[4];
+
+        /**
+         * If the entity is already linked, dont send query to the db.
+         */
+        if ( $this->is_already_linked( $uri ) ) {
+            return $label;
+        }
+
+        $link = - 1 < strpos( $css_class, 'wl-link' );
+
+        // If the entity should not be linked and link by default is also disabled,
+        // then don't lookup the entity on the table.
+        if ( ! $this->is_link_by_default && ! $link ) {
+            return $label;
+        }
+
+        $content_service = Wordpress_Content_Service::get_instance();
+        $content         = $content_service->get_by_entity_id_or_same_as( $uri );
+
+        // If no content is found, return the label, that is _remove the annotation_.
+        if ( ! is_object( $content ) ) {
+            return $label;
+        }
+
+        $object_id   = $content->get_id();
+        $object_type = $content->get_object_type_enum();
+
+        $no_link = - 1 < strpos( $css_class, 'wl-no-link' );
+
+        // Don't link if links are disabled and the entity is not link or the
+        // entity is do not link.
+        $dont_link = ( ! $this->is_link_by_default && ! $link ) || $no_link;
+
+        // Return the label if it's don't link.
+        if ( $dont_link ) {
+            return $label;
+        }
+
+        /**
+         * @since 3.32.0
+         * Object_ids are prefixed with object_type to prevent conflicts.
+         */
+        $this->linked_entity_uris[] = $uri;
+
+        // Get the link.
+        $href = Wordlift_Post_Adapter::get_production_permalink( $object_id, $object_type );
+
+        // Bail out if the `$href` has been reset.
+        if ( empty( $href ) ) {
+            return $label;
+        }
+
+        return Link_Builder::create( $uri, $object_id )
+                            ->label( $label )
+                            ->href( $href )
+                            ->generate_link();
+    }
+
+    /**
+     * Get a string to be used as a title attribute in links to a post
+     *
+     * @param int    $post_id The post id of the post being linked.
+     * @param string $ignore_label A label to ignore.
+     *
+     * @return string    The title to be used in the link. An empty string when
+     *                    there is no alternative that is not the $ignore_label.
+     * @deprecated 3.32.0 Use object link provider to get the link title for getting link
+     * title for different types.
+     * @since 3.15.0
+     *
+     * As of 3.32.0 this method is not used anywhere in the core, this should be removed
+     * from tests and companion plugins.
+     */
+    public function get_link_title( $post_id, $ignore_label, $object_type = Object_Type_Enum::POST ) {
+        return $this->object_link_provider->get_link_title( $post_id, $ignore_label, $object_type );
+    }
+
+    /**
+     * Get the entity URIs (configured in the `itemid` attribute) contained in
+     * the provided content.
+     *
+     * @param string $content The content.
+     *
+     * @return array An array of URIs.
+     * @since 3.14.2
+     */
+    public function get_entity_uris( $content ) {
+
+        $matches = array();
+        preg_match_all( self::PATTERN, $content, $matches );
+
+        // We need to use `array_values` here in order to avoid further `json_encode`
+        // to turn it into an object (since if the 3rd match isn't found the index
+        // is not sequential.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/646.
+        return array_values( array_unique( $matches[3] ) );
+    }
+
+    /**
+     * @param $entity_uri
+     *
+     * @return bool
+     */
+    private function is_already_linked( $entity_uri ) {
+        return in_array( $entity_uri, $this->linked_entity_uris, true );
+    }
 
 }

Spacing +30 added lines, -30 removed lines

@@ -80,9 +80,9 @@ 
 	 *
 	 * @since 3.8.0
 	 */
-	protected function __construct( $entity_service, $entity_uri_service ) {
+	protected function __construct($entity_service, $entity_uri_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->entity_service       = $entity_service;
 		$this->entity_uri_service   = $entity_uri_service;
@@ -100,8 +100,8 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self( Wordlift_Entity_Service::get_instance(), Wordlift_Entity_Uri_Service::get_instance() );
+		if ( ! isset(self::$instance)) {
+			self::$instance = new self(Wordlift_Entity_Service::get_instance(), Wordlift_Entity_Uri_Service::get_instance());
 		}
 
 		return self::$instance;
@@ -116,11 +116,11 @@ 
 	 * @return string The filtered content.
 	 * @since 3.8.0
 	 */
-	public function the_content( $content ) {
-		$this->log->trace( 'Filtering content [ ' . ( is_singular() ? 'yes' : 'no' ) . ' ]...' );
+	public function the_content($content) {
+		$this->log->trace('Filtering content [ '.(is_singular() ? 'yes' : 'no').' ]...');
 
 		// Links should be added only on the front end and not for RSS.
-		if ( is_feed() || is_admin() || is_search() ) {
+		if (is_feed() || is_admin() || is_search()) {
 			return $content;
 		}
 
@@ -133,10 +133,10 @@ 
 
 		// Preload URIs.
 		$matches = array();
-		preg_match_all( self::PATTERN, $content, $matches );
+		preg_match_all(self::PATTERN, $content, $matches);
 
 		// Bail out if there are no URIs.
-		if ( empty( $matches[3] ) ) {
+		if (empty($matches[3])) {
 			return $content;
 		}
 
@@ -162,7 +162,7 @@ 
 	 * @return string The replaced text with the link to the entity page.
 	 * @since 3.8.0
 	 */
-	private function link( $matches ) {
+	private function link($matches) {
 
 		// Get the entity itemid URI and label.
 		$css_class = $matches[2];
@@ -172,37 +172,37 @@ 
 		/**
 		 * If the entity is already linked, dont send query to the db.
 		 */
-		if ( $this->is_already_linked( $uri ) ) {
+		if ($this->is_already_linked($uri)) {
 			return $label;
 		}
 
-		$link = - 1 < strpos( $css_class, 'wl-link' );
+		$link = - 1 < strpos($css_class, 'wl-link');
 
 		// If the entity should not be linked and link by default is also disabled,
 		// then don't lookup the entity on the table.
-		if ( ! $this->is_link_by_default && ! $link ) {
+		if ( ! $this->is_link_by_default && ! $link) {
 			return $label;
 		}
 
 		$content_service = Wordpress_Content_Service::get_instance();
-		$content         = $content_service->get_by_entity_id_or_same_as( $uri );
+		$content         = $content_service->get_by_entity_id_or_same_as($uri);
 
 		// If no content is found, return the label, that is _remove the annotation_.
-		if ( ! is_object( $content ) ) {
+		if ( ! is_object($content)) {
 			return $label;
 		}
 
 		$object_id   = $content->get_id();
 		$object_type = $content->get_object_type_enum();
 
-		$no_link = - 1 < strpos( $css_class, 'wl-no-link' );
+		$no_link = - 1 < strpos($css_class, 'wl-no-link');
 
 		// Don't link if links are disabled and the entity is not link or the
 		// entity is do not link.
-		$dont_link = ( ! $this->is_link_by_default && ! $link ) || $no_link;
+		$dont_link = ( ! $this->is_link_by_default && ! $link) || $no_link;
 
 		// Return the label if it's don't link.
-		if ( $dont_link ) {
+		if ($dont_link) {
 			return $label;
 		}
 
@@ -213,16 +213,16 @@ 
 		$this->linked_entity_uris[] = $uri;
 
 		// Get the link.
-		$href = Wordlift_Post_Adapter::get_production_permalink( $object_id, $object_type );
+		$href = Wordlift_Post_Adapter::get_production_permalink($object_id, $object_type);
 
 		// Bail out if the `$href` has been reset.
-		if ( empty( $href ) ) {
+		if (empty($href)) {
 			return $label;
 		}
 
-		return Link_Builder::create( $uri, $object_id )
-						   ->label( $label )
-						   ->href( $href )
+		return Link_Builder::create($uri, $object_id)
+						   ->label($label)
+						   ->href($href)
 						   ->generate_link();
 	}
 
@@ -241,8 +241,8 @@ 
 	 * As of 3.32.0 this method is not used anywhere in the core, this should be removed
 	 * from tests and companion plugins.
 	 */
-	public function get_link_title( $post_id, $ignore_label, $object_type = Object_Type_Enum::POST ) {
-		return $this->object_link_provider->get_link_title( $post_id, $ignore_label, $object_type );
+	public function get_link_title($post_id, $ignore_label, $object_type = Object_Type_Enum::POST) {
+		return $this->object_link_provider->get_link_title($post_id, $ignore_label, $object_type);
 	}
 
 	/**
@@ -254,17 +254,17 @@ 
 	 * @return array An array of URIs.
 	 * @since 3.14.2
 	 */
-	public function get_entity_uris( $content ) {
+	public function get_entity_uris($content) {
 
 		$matches = array();
-		preg_match_all( self::PATTERN, $content, $matches );
+		preg_match_all(self::PATTERN, $content, $matches);
 
 		// We need to use `array_values` here in order to avoid further `json_encode`
 		// to turn it into an object (since if the 3rd match isn't found the index
 		// is not sequential.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/646.
-		return array_values( array_unique( $matches[3] ) );
+		return array_values(array_unique($matches[3]));
 	}
 
 	/**
@@ -272,8 +272,8 @@ 
 	 *
 	 * @return bool
 	 */
-	private function is_already_linked( $entity_uri ) {
-		return in_array( $entity_uri, $this->linked_entity_uris, true );
+	private function is_already_linked($entity_uri) {
+		return in_array($entity_uri, $this->linked_entity_uris, true);
 	}
 
 }

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

Indentation +498 added lines, -498 removed lines

@@ -19,522 +19,522 @@
  */
 class Wordlift_Post_To_Jsonld_Converter extends Wordlift_Abstract_Post_To_Jsonld_Converter {
 
-	/**
-	 * @var Wordlift_Post_To_Jsonld_Converter
-	 */
-	private static $instance;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * @var false
-	 */
-	private $disable_convert_filters;
-	/**
-	 * @var Object_Relation_Service
-	 */
-	private $object_relation_service;
-
-	/**
-	 * Wordlift_Post_To_Jsonld_Converter constructor.
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 * @param \Wordlift_User_Service        $user_service A {@link Wordlift_User_Service} instance.
-	 * @param \Wordlift_Attachment_Service  $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 *
-	 * @since 3.10.0
-	 */
-	public function __construct( $entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false ) {
-		parent::__construct( $entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create() );
-		$this->disable_convert_filters = $disable_convert_filters;
-		$this->object_relation_service = Object_Relation_Service::get_instance();
-		// Set a reference to the logger.
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
-
-		self::$instance = $this;
-
-	}
-
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	public function new_instance_with_filters_disabled() {
-		return new static( $this->entity_type_service, $this->user_service, $this->attachment_service, true );
-	}
-
-	/**
-	 * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
-	 * found while processing the post is set in the $references array.
-	 *
-	 * @param int              $post_id The post id.
-	 * @param array<Reference> $references An array of entity references.
-	 * @param array            $references_infos
-	 *
-	 * @return array A JSON-LD array.
-	 * @since 3.10.0
-	 */
-	public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
-
-		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
-			// Post not found.
-			return null;
-		}
-
-		// Get the base JSON-LD and the list of entities referenced by this entity.
-		$jsonld = parent::convert( $post_id, $references, $references_infos );
-
-		// Set WebPage by default.
-		if ( empty( $jsonld['@type'] ) ) {
-			$jsonld['@type'] = 'WebPage';
-		}
-
-		// Get the entity name.
-		$jsonld['headline'] = $post->post_title;
-
-		$custom_fields = $this->entity_type_service->get_custom_fields_for_post( $post_id );
-
-		if ( isset( $custom_fields ) ) {
-			$this->process_type_custom_fields( $jsonld, $custom_fields, $post, $references, $references_infos );
-		}
-
-		// Set the published and modified dates.
-		/*
+    /**
+     * @var Wordlift_Post_To_Jsonld_Converter
+     */
+    private static $instance;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * @var false
+     */
+    private $disable_convert_filters;
+    /**
+     * @var Object_Relation_Service
+     */
+    private $object_relation_service;
+
+    /**
+     * Wordlift_Post_To_Jsonld_Converter constructor.
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     * @param \Wordlift_User_Service        $user_service A {@link Wordlift_User_Service} instance.
+     * @param \Wordlift_Attachment_Service  $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     *
+     * @since 3.10.0
+     */
+    public function __construct( $entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false ) {
+        parent::__construct( $entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create() );
+        $this->disable_convert_filters = $disable_convert_filters;
+        $this->object_relation_service = Object_Relation_Service::get_instance();
+        // Set a reference to the logger.
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
+
+        self::$instance = $this;
+
+    }
+
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    public function new_instance_with_filters_disabled() {
+        return new static( $this->entity_type_service, $this->user_service, $this->attachment_service, true );
+    }
+
+    /**
+     * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
+     * found while processing the post is set in the $references array.
+     *
+     * @param int              $post_id The post id.
+     * @param array<Reference> $references An array of entity references.
+     * @param array            $references_infos
+     *
+     * @return array A JSON-LD array.
+     * @since 3.10.0
+     */
+    public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
+
+        // Get the post instance.
+        $post = get_post( $post_id );
+        if ( null === $post ) {
+            // Post not found.
+            return null;
+        }
+
+        // Get the base JSON-LD and the list of entities referenced by this entity.
+        $jsonld = parent::convert( $post_id, $references, $references_infos );
+
+        // Set WebPage by default.
+        if ( empty( $jsonld['@type'] ) ) {
+            $jsonld['@type'] = 'WebPage';
+        }
+
+        // Get the entity name.
+        $jsonld['headline'] = $post->post_title;
+
+        $custom_fields = $this->entity_type_service->get_custom_fields_for_post( $post_id );
+
+        if ( isset( $custom_fields ) ) {
+            $this->process_type_custom_fields( $jsonld, $custom_fields, $post, $references, $references_infos );
+        }
+
+        // Set the published and modified dates.
+        /*
 		 * Set the `datePublished` and `dateModified` using the local timezone.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/887
 		 *
 		 * @since 3.20.0
 		 */
-		try {
-			$default_timezone = date_default_timezone_get();
-			$timezone         = get_option( 'timezone_string' );
-			if ( ! empty( $timezone ) ) {
-				date_default_timezone_set( $timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
-				date_default_timezone_set( $default_timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
-			} else {
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
-			}
-		} catch ( Exception $e ) {
-			$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-			$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
-		}
-
-		// Get the word count for the post.
-		/*
+        try {
+            $default_timezone = date_default_timezone_get();
+            $timezone         = get_option( 'timezone_string' );
+            if ( ! empty( $timezone ) ) {
+                date_default_timezone_set( $timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+                $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
+                $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
+                date_default_timezone_set( $default_timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+            } else {
+                $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
+                $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+            }
+        } catch ( Exception $e ) {
+            $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
+            $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+        }
+
+        // Get the word count for the post.
+        /*
 		 * Do not display the `wordCount` on a `WebPage`.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/888
 		 *
 		 * @since 3.20.0
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter        = new Wordlift_Post_Adapter( $post_id );
-			$jsonld['wordCount'] = $post_adapter->word_count();
-		}
+        if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
+            $post_adapter        = new Wordlift_Post_Adapter( $post_id );
+            $jsonld['wordCount'] = $post_adapter->word_count();
+        }
 
-		/*
+        /*
 		 * Add keywords, articleSection, commentCount and inLanguage properties to `Article` JSON-LD
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/1140
 		 *
 		 * @since 3.27.2
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter    = new Wordlift_Post_Adapter( $post_id );
-			$keywords        = $post_adapter->keywords();
-			$article_section = $post_adapter->article_section();
-			$comment_count   = $post_adapter->comment_count();
-			$locale          = $post_adapter->locale();
-
-			if ( isset( $keywords ) ) {
-				$jsonld['keywords'] = $keywords;
-			}
-			if ( ! empty( $article_section ) ) {
-				$jsonld['articleSection'] = $article_section;
-			}
-			$jsonld['commentCount'] = $comment_count;
-			$jsonld['inLanguage']   = $locale;
-			$post_adapter->add_references( $post_id, $references );
-		}
-
-		// Set the publisher.
-		$this->set_publisher( $jsonld );
-
-		$references = $this->convert_references( $references );
-
-		// Process the references if any.
-		$this->set_mentions_and_about( $references, $post, $jsonld );
-
-		// Finally set the author.
-		$jsonld['author'] = $this->get_author( $post->post_author, $references );
-
-		// Return the JSON-LD if filters are disabled by the client.
-		if ( $this->disable_convert_filters ) {
-			return $jsonld;
-		}
-
-		/**
-		 * Call the `wl_post_jsonld_array` filter. This filter allows 3rd parties to also modify the references.
-		 *
-		 * @param array $value {
-		 *
-		 * @type array $jsonld The JSON-LD structure.
-		 * @type int[] $references An array of post IDs.
-		 * }
-		 * @since 3.25.0
-		 *
-		 * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
-		 *
-		 * @api
-		 */
-		$ret_val = apply_filters(
-			'wl_post_jsonld_array',
-			array(
-				'jsonld'     => $jsonld,
-				'references' => $references,
-			),
-			$post_id
-		);
-
-		$jsonld     = $ret_val['jsonld'];
-		$references = $ret_val['references'];
-
-		/**
-		 * Call the `wl_post_jsonld` filter.
-		 *
-		 * @param array $jsonld The JSON-LD structure.
-		 * @param int $post_id The {@link WP_Post} `id`.
-		 * @param array $references The array of referenced entities.
-		 *
-		 * @since 3.14.0
-		 *
-		 * @api
-		 */
-		return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
-	}
-
-	/**
-	 * Get the author's JSON-LD fragment.
-	 *
-	 * The JSON-LD fragment is generated using the {@link WP_User}'s data or
-	 * the referenced entity if configured for the {@link WP_User}.
-	 *
-	 * @param int   $author_id The author {@link WP_User}'s `id`.
-	 * @param array $references An array of referenced entities.
-	 *
-	 * @return string|array A JSON-LD structure.
-	 * @since 3.14.0
-	 */
-	public function get_author( $author_id, &$references ) {
-
-		// Get the entity bound to this user.
-		$entity_id = $this->user_service->get_entity( $author_id );
-
-		// If there's no entity bound return a simple author structure.
-		if ( empty( $entity_id ) || 'publish' !== get_post_status( $entity_id ) ) {
-
-			$author            = get_the_author_meta( 'display_name', $author_id );
-			$author_first_name = get_the_author_meta( 'first_name', $author_id );
-			$author_last_name  = get_the_author_meta( 'last_name', $author_id );
-			$author_uri        = $this->user_service->get_uri( $author_id );
-
-			return array(
-				'@type'      => 'Person',
-				'@id'        => $author_uri,
-				'name'       => $author,
-				'givenName'  => $author_first_name,
-				'familyName' => $author_last_name,
-				'url'        => get_author_posts_url( $author_id ),
-			);
-		}
-
-		// Add the author to the references.
-		$author_uri   = Wordlift_Entity_Service::get_instance()->get_uri( $entity_id );
-		$references[] = $entity_id;
-
-		// Return the JSON-LD for the referenced entity.
-		return array(
-			'@id' => $author_uri,
-		);
-	}
-
-	/**
-	 * Enrich the provided params array with publisher data, if available.
-	 *
-	 * @param array $params The parameters array.
-	 *
-	 * @since 3.10.0
-	 */
-	protected function set_publisher( &$params ) {
-
-		// If the publisher id isn't set don't do anything.
-		$publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
-		if ( null === $publisher_id ) {
-			return;
-		}
-
-		// Get the post instance.
-		$post = get_post( $publisher_id );
-		if ( null === $post ) {
-			// Publisher not found.
-			return;
-		}
-
-		// Get the item id.
-		$id = Wordlift_Entity_Service::get_instance()->get_uri( $publisher_id );
-
-		// Get the type.
-		$type = $this->entity_type_service->get( $publisher_id );
-
-		// Get the name.
-		$name = $post->post_title;
-
-		// Set the publisher data.
-		$params['publisher'] = array(
-			'@type' => $this->relative_to_context( $type['uri'] ),
-			'@id'   => $id,
-			'name'  => $name,
-		);
-
-		// Add the sameAs values associated with the publisher.
-		$storage_factory = Wordlift_Storage_Factory::get_instance();
-		$sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
-		if ( ! empty( $sameas ) ) {
-			$params['publisher']['sameAs'] = $sameas;
-		}
-
-		// Set the logo, only for http://schema.org/Organization as Person doesn't
-		// support the logo property.
-		//
-		// See http://schema.org/logo.
-		if ( 1 !== preg_match( '~Organization$~', $type['uri'] ) ) {
-			return;
-		}
-
-		// Get the publisher logo.
-		$publisher_logo = $this->get_publisher_logo( $post->ID );
-
-		// Bail out if the publisher logo isn't set.
-		if ( false === $publisher_logo ) {
-			return;
-		}
-
-		// Copy over some useful properties.
-		//
-		// See https://developers.google.com/search/docs/data-types/articles.
-		$params['publisher']['logo']['@type'] = 'ImageObject';
-		$params['publisher']['logo']['url']   = $publisher_logo['url'];
-
-		// If you specify a "width" or "height" value you should leave out
-		// 'px'. For example: "width":"4608px" should be "width":"4608".
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/451.
-		$params['publisher']['logo']['width']  = $publisher_logo['width'];
-		$params['publisher']['logo']['height'] = $publisher_logo['height'];
-
-	}
-
-	/**
-	 * Get the publisher logo structure.
-	 *
-	 * The function returns false when the publisher logo cannot be determined, i.e.:
-	 *  - the post has no featured image.
-	 *  - the featured image has no file.
-	 *  - a wp_image_editor instance cannot be instantiated on the original file or on the publisher logo file.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|false Returns an array with the `url`, `width` and `height` for the publisher logo or false in case
-	 *  of errors.
-	 * @since 3.19.2
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
-	 */
-	private function get_publisher_logo( $post_id ) {
-
-		// Get the featured image for the post.
-		$thumbnail_id = get_post_thumbnail_id( $post_id );
-
-		// Bail out if thumbnail not available.
-		if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
-			$this->log->info( "Featured image not set for post $post_id." );
-
-			return false;
-		}
-
-		// Get the uploads base URL.
-		$uploads_dir = wp_upload_dir();
-
-		// Get the attachment metadata.
-		$metadata = wp_get_attachment_metadata( $thumbnail_id );
-
-		// Bail out if the file isn't set.
-		if ( ! isset( $metadata['file'] ) ) {
-			$this->log->warn( "Featured image file not found for post $post_id." );
-
-			return false;
-		}
-
-		// Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
-		$path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
-
-		// Use image src, if local file does not exist. @see https://github.com/insideout10/wordlift-plugin/issues/1149
-		if ( ! file_exists( $path ) ) {
-			$this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
-
-			$attachment_image_src = wp_get_attachment_image_src( $thumbnail_id, '' );
-			if ( $attachment_image_src ) {
-				return array(
-					'url'    => $attachment_image_src[0],
-					'width'  => $attachment_image_src[1],
-					'height' => $attachment_image_src[2],
-				);
-			}
-
-			// Bail out if we cant fetch wp_get_attachment_image_src
-			return false;
-
-		}
-
-		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$original_file_editor = wp_get_image_editor( $path );
-		if ( is_wp_error( $original_file_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
-
-			return false;
-		}
-
-		// Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
-		// and we don't actually know the end values.
-		$publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
-
-		// If the file doesn't exist yet, create it.
-		if ( ! file_exists( $publisher_logo_path ) ) {
-			$original_file_editor->resize( 600, 60 );
-			$original_file_editor->save( $publisher_logo_path );
-		}
-
-		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
-		if ( is_wp_error( $publisher_logo_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
-
-			return false;
-		}
-
-		// Get the actual size.
-		$size = $publisher_logo_editor->get_size();
-
-		// Finally return the array with data.
-		return array(
-			'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
-			'width'  => $size['width'],
-			'height' => $size['height'],
-		);
-	}
-
-	/**
-	 * @param $references
-	 * @param $post
-	 * @param $jsonld
-	 *
-	 * @return void
-	 */
-	private function set_mentions_and_about( $references, $post, &$jsonld ) {
-
-		if ( count( $references ) === 0 ) {
-			return;
-		}
-
-		// Prepare the `about` and `mentions` array.
-		$mentions = array();
-		$about    = array();
-
-		// If the entity is in the title, then it should be an `about`.
-		foreach ( $references as $reference ) {
-
-			if ( ! $reference instanceof Reference ) {
-				// This condition should never be reached.
-				continue;
-			}
-
-			// Get the entity labels.
-			$labels = Wordlift_Entity_Service::get_instance()->get_labels( $reference->get_id(), $reference->get_type() );
-			// Get the entity URI.
-			$item = array(
-				'@id' => Wordlift_Entity_Service::get_instance()->get_uri( $reference->get_id(), $reference->get_type() ),
-			);
-
-			$escaped_labels = array_map(
-				function ( $value ) {
-					return preg_quote( $value, '/' );
-				},
-				$labels
-			);
-
-			$matches = false;
-
-			// When the title is empty, then we shouldn't yield a match to about section.
-			if ( array_filter( $escaped_labels ) ) {
-				// Check if the labels match any part of the title.
-				$matches = 1 === preg_match( '/' . implode( '|', $escaped_labels ) . '/', $post->post_title );
-			}
-
-			// If the title matches, assign the entity to the about, otherwise to the mentions.
-			if ( $matches ) {
-				$about[] = $item;
-			} else {
-				$mentions[] = $item;
-			}
-		}
-
-		// If we have abouts, assign them to the JSON-LD.
-		if ( 0 < count( $about ) ) {
-			$jsonld['about'] = $about;
-		}
-
-		// If we have mentions, assign them to the JSON-LD.
-		if ( 0 < count( $mentions ) ) {
-			$jsonld['mentions'] = $mentions;
-		}
-
-		return $jsonld;
-	}
-
-	/**
-	 * Convert references to abstract data type if we find any.
-	 *
-	 * @param $references array<int|Reference>
-	 *
-	 * @return Reference[]
-	 */
-	private function convert_references( $references ) {
-		return array_map(
-			function ( $reference ) {
-				// Legacy code may still push numerical references to this
-				// $references variable, so convert it to post references.
-				if ( is_numeric( $reference ) ) {
-					  return new Post_Reference( $reference );
-				}
-
-				return $reference;
-
-			},
-			$references
-		);
-	}
+        if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
+            $post_adapter    = new Wordlift_Post_Adapter( $post_id );
+            $keywords        = $post_adapter->keywords();
+            $article_section = $post_adapter->article_section();
+            $comment_count   = $post_adapter->comment_count();
+            $locale          = $post_adapter->locale();
+
+            if ( isset( $keywords ) ) {
+                $jsonld['keywords'] = $keywords;
+            }
+            if ( ! empty( $article_section ) ) {
+                $jsonld['articleSection'] = $article_section;
+            }
+            $jsonld['commentCount'] = $comment_count;
+            $jsonld['inLanguage']   = $locale;
+            $post_adapter->add_references( $post_id, $references );
+        }
+
+        // Set the publisher.
+        $this->set_publisher( $jsonld );
+
+        $references = $this->convert_references( $references );
+
+        // Process the references if any.
+        $this->set_mentions_and_about( $references, $post, $jsonld );
+
+        // Finally set the author.
+        $jsonld['author'] = $this->get_author( $post->post_author, $references );
+
+        // Return the JSON-LD if filters are disabled by the client.
+        if ( $this->disable_convert_filters ) {
+            return $jsonld;
+        }
+
+        /**
+         * Call the `wl_post_jsonld_array` filter. This filter allows 3rd parties to also modify the references.
+         *
+         * @param array $value {
+         *
+         * @type array $jsonld The JSON-LD structure.
+         * @type int[] $references An array of post IDs.
+         * }
+         * @since 3.25.0
+         *
+         * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
+         *
+         * @api
+         */
+        $ret_val = apply_filters(
+            'wl_post_jsonld_array',
+            array(
+                'jsonld'     => $jsonld,
+                'references' => $references,
+            ),
+            $post_id
+        );
+
+        $jsonld     = $ret_val['jsonld'];
+        $references = $ret_val['references'];
+
+        /**
+         * Call the `wl_post_jsonld` filter.
+         *
+         * @param array $jsonld The JSON-LD structure.
+         * @param int $post_id The {@link WP_Post} `id`.
+         * @param array $references The array of referenced entities.
+         *
+         * @since 3.14.0
+         *
+         * @api
+         */
+        return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
+    }
+
+    /**
+     * Get the author's JSON-LD fragment.
+     *
+     * The JSON-LD fragment is generated using the {@link WP_User}'s data or
+     * the referenced entity if configured for the {@link WP_User}.
+     *
+     * @param int   $author_id The author {@link WP_User}'s `id`.
+     * @param array $references An array of referenced entities.
+     *
+     * @return string|array A JSON-LD structure.
+     * @since 3.14.0
+     */
+    public function get_author( $author_id, &$references ) {
+
+        // Get the entity bound to this user.
+        $entity_id = $this->user_service->get_entity( $author_id );
+
+        // If there's no entity bound return a simple author structure.
+        if ( empty( $entity_id ) || 'publish' !== get_post_status( $entity_id ) ) {
+
+            $author            = get_the_author_meta( 'display_name', $author_id );
+            $author_first_name = get_the_author_meta( 'first_name', $author_id );
+            $author_last_name  = get_the_author_meta( 'last_name', $author_id );
+            $author_uri        = $this->user_service->get_uri( $author_id );
+
+            return array(
+                '@type'      => 'Person',
+                '@id'        => $author_uri,
+                'name'       => $author,
+                'givenName'  => $author_first_name,
+                'familyName' => $author_last_name,
+                'url'        => get_author_posts_url( $author_id ),
+            );
+        }
+
+        // Add the author to the references.
+        $author_uri   = Wordlift_Entity_Service::get_instance()->get_uri( $entity_id );
+        $references[] = $entity_id;
+
+        // Return the JSON-LD for the referenced entity.
+        return array(
+            '@id' => $author_uri,
+        );
+    }
+
+    /**
+     * Enrich the provided params array with publisher data, if available.
+     *
+     * @param array $params The parameters array.
+     *
+     * @since 3.10.0
+     */
+    protected function set_publisher( &$params ) {
+
+        // If the publisher id isn't set don't do anything.
+        $publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
+        if ( null === $publisher_id ) {
+            return;
+        }
+
+        // Get the post instance.
+        $post = get_post( $publisher_id );
+        if ( null === $post ) {
+            // Publisher not found.
+            return;
+        }
+
+        // Get the item id.
+        $id = Wordlift_Entity_Service::get_instance()->get_uri( $publisher_id );
+
+        // Get the type.
+        $type = $this->entity_type_service->get( $publisher_id );
+
+        // Get the name.
+        $name = $post->post_title;
+
+        // Set the publisher data.
+        $params['publisher'] = array(
+            '@type' => $this->relative_to_context( $type['uri'] ),
+            '@id'   => $id,
+            'name'  => $name,
+        );
+
+        // Add the sameAs values associated with the publisher.
+        $storage_factory = Wordlift_Storage_Factory::get_instance();
+        $sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
+        if ( ! empty( $sameas ) ) {
+            $params['publisher']['sameAs'] = $sameas;
+        }
+
+        // Set the logo, only for http://schema.org/Organization as Person doesn't
+        // support the logo property.
+        //
+        // See http://schema.org/logo.
+        if ( 1 !== preg_match( '~Organization$~', $type['uri'] ) ) {
+            return;
+        }
+
+        // Get the publisher logo.
+        $publisher_logo = $this->get_publisher_logo( $post->ID );
+
+        // Bail out if the publisher logo isn't set.
+        if ( false === $publisher_logo ) {
+            return;
+        }
+
+        // Copy over some useful properties.
+        //
+        // See https://developers.google.com/search/docs/data-types/articles.
+        $params['publisher']['logo']['@type'] = 'ImageObject';
+        $params['publisher']['logo']['url']   = $publisher_logo['url'];
+
+        // If you specify a "width" or "height" value you should leave out
+        // 'px'. For example: "width":"4608px" should be "width":"4608".
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/451.
+        $params['publisher']['logo']['width']  = $publisher_logo['width'];
+        $params['publisher']['logo']['height'] = $publisher_logo['height'];
+
+    }
+
+    /**
+     * Get the publisher logo structure.
+     *
+     * The function returns false when the publisher logo cannot be determined, i.e.:
+     *  - the post has no featured image.
+     *  - the featured image has no file.
+     *  - a wp_image_editor instance cannot be instantiated on the original file or on the publisher logo file.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|false Returns an array with the `url`, `width` and `height` for the publisher logo or false in case
+     *  of errors.
+     * @since 3.19.2
+     * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
+     */
+    private function get_publisher_logo( $post_id ) {
+
+        // Get the featured image for the post.
+        $thumbnail_id = get_post_thumbnail_id( $post_id );
+
+        // Bail out if thumbnail not available.
+        if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
+            $this->log->info( "Featured image not set for post $post_id." );
+
+            return false;
+        }
+
+        // Get the uploads base URL.
+        $uploads_dir = wp_upload_dir();
+
+        // Get the attachment metadata.
+        $metadata = wp_get_attachment_metadata( $thumbnail_id );
+
+        // Bail out if the file isn't set.
+        if ( ! isset( $metadata['file'] ) ) {
+            $this->log->warn( "Featured image file not found for post $post_id." );
+
+            return false;
+        }
+
+        // Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
+        $path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
+
+        // Use image src, if local file does not exist. @see https://github.com/insideout10/wordlift-plugin/issues/1149
+        if ( ! file_exists( $path ) ) {
+            $this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
+
+            $attachment_image_src = wp_get_attachment_image_src( $thumbnail_id, '' );
+            if ( $attachment_image_src ) {
+                return array(
+                    'url'    => $attachment_image_src[0],
+                    'width'  => $attachment_image_src[1],
+                    'height' => $attachment_image_src[2],
+                );
+            }
+
+            // Bail out if we cant fetch wp_get_attachment_image_src
+            return false;
+
+        }
+
+        // Try to get the image editor and bail out if the editor cannot be instantiated.
+        $original_file_editor = wp_get_image_editor( $path );
+        if ( is_wp_error( $original_file_editor ) ) {
+            $this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
+
+            return false;
+        }
+
+        // Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
+        // and we don't actually know the end values.
+        $publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
+
+        // If the file doesn't exist yet, create it.
+        if ( ! file_exists( $publisher_logo_path ) ) {
+            $original_file_editor->resize( 600, 60 );
+            $original_file_editor->save( $publisher_logo_path );
+        }
+
+        // Try to get the image editor and bail out if the editor cannot be instantiated.
+        $publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
+        if ( is_wp_error( $publisher_logo_editor ) ) {
+            $this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
+
+            return false;
+        }
+
+        // Get the actual size.
+        $size = $publisher_logo_editor->get_size();
+
+        // Finally return the array with data.
+        return array(
+            'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
+            'width'  => $size['width'],
+            'height' => $size['height'],
+        );
+    }
+
+    /**
+     * @param $references
+     * @param $post
+     * @param $jsonld
+     *
+     * @return void
+     */
+    private function set_mentions_and_about( $references, $post, &$jsonld ) {
+
+        if ( count( $references ) === 0 ) {
+            return;
+        }
+
+        // Prepare the `about` and `mentions` array.
+        $mentions = array();
+        $about    = array();
+
+        // If the entity is in the title, then it should be an `about`.
+        foreach ( $references as $reference ) {
+
+            if ( ! $reference instanceof Reference ) {
+                // This condition should never be reached.
+                continue;
+            }
+
+            // Get the entity labels.
+            $labels = Wordlift_Entity_Service::get_instance()->get_labels( $reference->get_id(), $reference->get_type() );
+            // Get the entity URI.
+            $item = array(
+                '@id' => Wordlift_Entity_Service::get_instance()->get_uri( $reference->get_id(), $reference->get_type() ),
+            );
+
+            $escaped_labels = array_map(
+                function ( $value ) {
+                    return preg_quote( $value, '/' );
+                },
+                $labels
+            );
+
+            $matches = false;
+
+            // When the title is empty, then we shouldn't yield a match to about section.
+            if ( array_filter( $escaped_labels ) ) {
+                // Check if the labels match any part of the title.
+                $matches = 1 === preg_match( '/' . implode( '|', $escaped_labels ) . '/', $post->post_title );
+            }
+
+            // If the title matches, assign the entity to the about, otherwise to the mentions.
+            if ( $matches ) {
+                $about[] = $item;
+            } else {
+                $mentions[] = $item;
+            }
+        }
+
+        // If we have abouts, assign them to the JSON-LD.
+        if ( 0 < count( $about ) ) {
+            $jsonld['about'] = $about;
+        }
+
+        // If we have mentions, assign them to the JSON-LD.
+        if ( 0 < count( $mentions ) ) {
+            $jsonld['mentions'] = $mentions;
+        }
+
+        return $jsonld;
+    }
+
+    /**
+     * Convert references to abstract data type if we find any.
+     *
+     * @param $references array<int|Reference>
+     *
+     * @return Reference[]
+     */
+    private function convert_references( $references ) {
+        return array_map(
+            function ( $reference ) {
+                // Legacy code may still push numerical references to this
+                // $references variable, so convert it to post references.
+                if ( is_numeric( $reference ) ) {
+                        return new Post_Reference( $reference );
+                }
+
+                return $reference;
+
+            },
+            $references
+        );
+    }
 
 }

Spacing +97 added lines, -97 removed lines

@@ -51,12 +51,12 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	public function __construct( $entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false ) {
-		parent::__construct( $entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create() );
+	public function __construct($entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false) {
+		parent::__construct($entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create());
 		$this->disable_convert_filters = $disable_convert_filters;
 		$this->object_relation_service = Object_Relation_Service::get_instance();
 		// Set a reference to the logger.
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Post_To_Jsonld_Converter');
 
 		self::$instance = $this;
 
@@ -68,7 +68,7 @@ 
 	}
 
 	public function new_instance_with_filters_disabled() {
-		return new static( $this->entity_type_service, $this->user_service, $this->attachment_service, true );
+		return new static($this->entity_type_service, $this->user_service, $this->attachment_service, true);
 	}
 
 	/**
@@ -82,30 +82,30 @@ 
 	 * @return array A JSON-LD array.
 	 * @since 3.10.0
 	 */
-	public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
+	public function convert($post_id, &$references = array(), &$references_infos = array()) {
 
 		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
+		$post = get_post($post_id);
+		if (null === $post) {
 			// Post not found.
 			return null;
 		}
 
 		// Get the base JSON-LD and the list of entities referenced by this entity.
-		$jsonld = parent::convert( $post_id, $references, $references_infos );
+		$jsonld = parent::convert($post_id, $references, $references_infos);
 
 		// Set WebPage by default.
-		if ( empty( $jsonld['@type'] ) ) {
+		if (empty($jsonld['@type'])) {
 			$jsonld['@type'] = 'WebPage';
 		}
 
 		// Get the entity name.
 		$jsonld['headline'] = $post->post_title;
 
-		$custom_fields = $this->entity_type_service->get_custom_fields_for_post( $post_id );
+		$custom_fields = $this->entity_type_service->get_custom_fields_for_post($post_id);
 
-		if ( isset( $custom_fields ) ) {
-			$this->process_type_custom_fields( $jsonld, $custom_fields, $post, $references, $references_infos );
+		if (isset($custom_fields)) {
+			$this->process_type_custom_fields($jsonld, $custom_fields, $post, $references, $references_infos);
 		}
 
 		// Set the published and modified dates.
@@ -118,19 +118,19 @@ 
 		 */
 		try {
 			$default_timezone = date_default_timezone_get();
-			$timezone         = get_option( 'timezone_string' );
-			if ( ! empty( $timezone ) ) {
-				date_default_timezone_set( $timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
-				date_default_timezone_set( $default_timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+			$timezone         = get_option('timezone_string');
+			if ( ! empty($timezone)) {
+				date_default_timezone_set($timezone); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+				$jsonld['datePublished'] = get_post_time('Y-m-d\TH:i:sP', false, $post);
+				$jsonld['dateModified']  = get_post_modified_time('Y-m-d\TH:i:sP', false, $post);
+				date_default_timezone_set($default_timezone); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
 			} else {
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+				$jsonld['datePublished'] = get_post_time('Y-m-d\TH:i', true, $post, false);
+				$jsonld['dateModified']  = get_post_modified_time('Y-m-d\TH:i', true, $post, false);
 			}
-		} catch ( Exception $e ) {
-			$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-			$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+		} catch (Exception $e) {
+			$jsonld['datePublished'] = get_post_time('Y-m-d\TH:i', true, $post, false);
+			$jsonld['dateModified']  = get_post_modified_time('Y-m-d\TH:i', true, $post, false);
 		}
 
 		// Get the word count for the post.
@@ -141,8 +141,8 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter        = new Wordlift_Post_Adapter( $post_id );
+		if ( ! empty($jsonld['@type']) && 'WebPage' !== $jsonld['@type']) {
+			$post_adapter        = new Wordlift_Post_Adapter($post_id);
 			$jsonld['wordCount'] = $post_adapter->word_count();
 		}
 
@@ -153,37 +153,37 @@ 
 		 *
 		 * @since 3.27.2
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter    = new Wordlift_Post_Adapter( $post_id );
+		if ( ! empty($jsonld['@type']) && 'WebPage' !== $jsonld['@type']) {
+			$post_adapter    = new Wordlift_Post_Adapter($post_id);
 			$keywords        = $post_adapter->keywords();
 			$article_section = $post_adapter->article_section();
 			$comment_count   = $post_adapter->comment_count();
 			$locale          = $post_adapter->locale();
 
-			if ( isset( $keywords ) ) {
+			if (isset($keywords)) {
 				$jsonld['keywords'] = $keywords;
 			}
-			if ( ! empty( $article_section ) ) {
+			if ( ! empty($article_section)) {
 				$jsonld['articleSection'] = $article_section;
 			}
 			$jsonld['commentCount'] = $comment_count;
 			$jsonld['inLanguage']   = $locale;
-			$post_adapter->add_references( $post_id, $references );
+			$post_adapter->add_references($post_id, $references);
 		}
 
 		// Set the publisher.
-		$this->set_publisher( $jsonld );
+		$this->set_publisher($jsonld);
 
-		$references = $this->convert_references( $references );
+		$references = $this->convert_references($references);
 
 		// Process the references if any.
-		$this->set_mentions_and_about( $references, $post, $jsonld );
+		$this->set_mentions_and_about($references, $post, $jsonld);
 
 		// Finally set the author.
-		$jsonld['author'] = $this->get_author( $post->post_author, $references );
+		$jsonld['author'] = $this->get_author($post->post_author, $references);
 
 		// Return the JSON-LD if filters are disabled by the client.
-		if ( $this->disable_convert_filters ) {
+		if ($this->disable_convert_filters) {
 			return $jsonld;
 		}
 
@@ -224,7 +224,7 @@ 
 		 *
 		 * @api
 		 */
-		return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
+		return apply_filters('wl_post_jsonld', $jsonld, $post_id, $references);
 	}
 
 	/**
@@ -239,18 +239,18 @@ 
 	 * @return string|array A JSON-LD structure.
 	 * @since 3.14.0
 	 */
-	public function get_author( $author_id, &$references ) {
+	public function get_author($author_id, &$references) {
 
 		// Get the entity bound to this user.
-		$entity_id = $this->user_service->get_entity( $author_id );
+		$entity_id = $this->user_service->get_entity($author_id);
 
 		// If there's no entity bound return a simple author structure.
-		if ( empty( $entity_id ) || 'publish' !== get_post_status( $entity_id ) ) {
+		if (empty($entity_id) || 'publish' !== get_post_status($entity_id)) {
 
-			$author            = get_the_author_meta( 'display_name', $author_id );
-			$author_first_name = get_the_author_meta( 'first_name', $author_id );
-			$author_last_name  = get_the_author_meta( 'last_name', $author_id );
-			$author_uri        = $this->user_service->get_uri( $author_id );
+			$author            = get_the_author_meta('display_name', $author_id);
+			$author_first_name = get_the_author_meta('first_name', $author_id);
+			$author_last_name  = get_the_author_meta('last_name', $author_id);
+			$author_uri        = $this->user_service->get_uri($author_id);
 
 			return array(
 				'@type'      => 'Person',
@@ -258,12 +258,12 @@ 
 				'name'       => $author,
 				'givenName'  => $author_first_name,
 				'familyName' => $author_last_name,
-				'url'        => get_author_posts_url( $author_id ),
+				'url'        => get_author_posts_url($author_id),
 			);
 		}
 
 		// Add the author to the references.
-		$author_uri   = Wordlift_Entity_Service::get_instance()->get_uri( $entity_id );
+		$author_uri   = Wordlift_Entity_Service::get_instance()->get_uri($entity_id);
 		$references[] = $entity_id;
 
 		// Return the JSON-LD for the referenced entity.
@@ -279,41 +279,41 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	protected function set_publisher( &$params ) {
+	protected function set_publisher(&$params) {
 
 		// If the publisher id isn't set don't do anything.
 		$publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
-		if ( null === $publisher_id ) {
+		if (null === $publisher_id) {
 			return;
 		}
 
 		// Get the post instance.
-		$post = get_post( $publisher_id );
-		if ( null === $post ) {
+		$post = get_post($publisher_id);
+		if (null === $post) {
 			// Publisher not found.
 			return;
 		}
 
 		// Get the item id.
-		$id = Wordlift_Entity_Service::get_instance()->get_uri( $publisher_id );
+		$id = Wordlift_Entity_Service::get_instance()->get_uri($publisher_id);
 
 		// Get the type.
-		$type = $this->entity_type_service->get( $publisher_id );
+		$type = $this->entity_type_service->get($publisher_id);
 
 		// Get the name.
 		$name = $post->post_title;
 
 		// Set the publisher data.
 		$params['publisher'] = array(
-			'@type' => $this->relative_to_context( $type['uri'] ),
+			'@type' => $this->relative_to_context($type['uri']),
 			'@id'   => $id,
 			'name'  => $name,
 		);
 
 		// Add the sameAs values associated with the publisher.
 		$storage_factory = Wordlift_Storage_Factory::get_instance();
-		$sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
-		if ( ! empty( $sameas ) ) {
+		$sameas          = $storage_factory->post_meta(Wordlift_Schema_Service::FIELD_SAME_AS)->get($publisher_id);
+		if ( ! empty($sameas)) {
 			$params['publisher']['sameAs'] = $sameas;
 		}
 
@@ -321,15 +321,15 @@ 
 		// support the logo property.
 		//
 		// See http://schema.org/logo.
-		if ( 1 !== preg_match( '~Organization$~', $type['uri'] ) ) {
+		if (1 !== preg_match('~Organization$~', $type['uri'])) {
 			return;
 		}
 
 		// Get the publisher logo.
-		$publisher_logo = $this->get_publisher_logo( $post->ID );
+		$publisher_logo = $this->get_publisher_logo($post->ID);
 
 		// Bail out if the publisher logo isn't set.
-		if ( false === $publisher_logo ) {
+		if (false === $publisher_logo) {
 			return;
 		}
 
@@ -363,14 +363,14 @@ 
 	 * @since 3.19.2
 	 * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
 	 */
-	private function get_publisher_logo( $post_id ) {
+	private function get_publisher_logo($post_id) {
 
 		// Get the featured image for the post.
-		$thumbnail_id = get_post_thumbnail_id( $post_id );
+		$thumbnail_id = get_post_thumbnail_id($post_id);
 
 		// Bail out if thumbnail not available.
-		if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
-			$this->log->info( "Featured image not set for post $post_id." );
+		if (empty($thumbnail_id) || 0 === $thumbnail_id) {
+			$this->log->info("Featured image not set for post $post_id.");
 
 			return false;
 		}
@@ -379,24 +379,24 @@ 
 		$uploads_dir = wp_upload_dir();
 
 		// Get the attachment metadata.
-		$metadata = wp_get_attachment_metadata( $thumbnail_id );
+		$metadata = wp_get_attachment_metadata($thumbnail_id);
 
 		// Bail out if the file isn't set.
-		if ( ! isset( $metadata['file'] ) ) {
-			$this->log->warn( "Featured image file not found for post $post_id." );
+		if ( ! isset($metadata['file'])) {
+			$this->log->warn("Featured image file not found for post $post_id.");
 
 			return false;
 		}
 
 		// Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
-		$path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
+		$path = $uploads_dir['basedir'].DIRECTORY_SEPARATOR.$metadata['file'];
 
 		// Use image src, if local file does not exist. @see https://github.com/insideout10/wordlift-plugin/issues/1149
-		if ( ! file_exists( $path ) ) {
-			$this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
+		if ( ! file_exists($path)) {
+			$this->log->warn("Featured image file $path doesn't exist for post $post_id.");
 
-			$attachment_image_src = wp_get_attachment_image_src( $thumbnail_id, '' );
-			if ( $attachment_image_src ) {
+			$attachment_image_src = wp_get_attachment_image_src($thumbnail_id, '');
+			if ($attachment_image_src) {
 				return array(
 					'url'    => $attachment_image_src[0],
 					'width'  => $attachment_image_src[1],
@@ -410,27 +410,27 @@ 
 		}
 
 		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$original_file_editor = wp_get_image_editor( $path );
-		if ( is_wp_error( $original_file_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
+		$original_file_editor = wp_get_image_editor($path);
+		if (is_wp_error($original_file_editor)) {
+			$this->log->warn("Cannot instantiate WP Image Editor on file $path for post $post_id.");
 
 			return false;
 		}
 
 		// Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
 		// and we don't actually know the end values.
-		$publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
+		$publisher_logo_path = $original_file_editor->generate_filename('-publisher-logo');
 
 		// If the file doesn't exist yet, create it.
-		if ( ! file_exists( $publisher_logo_path ) ) {
-			$original_file_editor->resize( 600, 60 );
-			$original_file_editor->save( $publisher_logo_path );
+		if ( ! file_exists($publisher_logo_path)) {
+			$original_file_editor->resize(600, 60);
+			$original_file_editor->save($publisher_logo_path);
 		}
 
 		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
-		if ( is_wp_error( $publisher_logo_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
+		$publisher_logo_editor = wp_get_image_editor($publisher_logo_path);
+		if (is_wp_error($publisher_logo_editor)) {
+			$this->log->warn("Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id.");
 
 			return false;
 		}
@@ -440,7 +440,7 @@ 
 
 		// Finally return the array with data.
 		return array(
-			'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
+			'url'    => $uploads_dir['baseurl'].substr($publisher_logo_path, strlen($uploads_dir['basedir'])),
 			'width'  => $size['width'],
 			'height' => $size['height'],
 		);
@@ -453,9 +453,9 @@ 
 	 *
 	 * @return void
 	 */
-	private function set_mentions_and_about( $references, $post, &$jsonld ) {
+	private function set_mentions_and_about($references, $post, &$jsonld) {
 
-		if ( count( $references ) === 0 ) {
+		if (count($references) === 0) {
 			return;
 		}
 
@@ -464,23 +464,23 @@ 
 		$about    = array();
 
 		// If the entity is in the title, then it should be an `about`.
-		foreach ( $references as $reference ) {
+		foreach ($references as $reference) {
 
-			if ( ! $reference instanceof Reference ) {
+			if ( ! $reference instanceof Reference) {
 				// This condition should never be reached.
 				continue;
 			}
 
 			// Get the entity labels.
-			$labels = Wordlift_Entity_Service::get_instance()->get_labels( $reference->get_id(), $reference->get_type() );
+			$labels = Wordlift_Entity_Service::get_instance()->get_labels($reference->get_id(), $reference->get_type());
 			// Get the entity URI.
 			$item = array(
-				'@id' => Wordlift_Entity_Service::get_instance()->get_uri( $reference->get_id(), $reference->get_type() ),
+				'@id' => Wordlift_Entity_Service::get_instance()->get_uri($reference->get_id(), $reference->get_type()),
 			);
 
 			$escaped_labels = array_map(
-				function ( $value ) {
-					return preg_quote( $value, '/' );
+				function($value) {
+					return preg_quote($value, '/');
 				},
 				$labels
 			);
@@ -488,13 +488,13 @@ 
 			$matches = false;
 
 			// When the title is empty, then we shouldn't yield a match to about section.
-			if ( array_filter( $escaped_labels ) ) {
+			if (array_filter($escaped_labels)) {
 				// Check if the labels match any part of the title.
-				$matches = 1 === preg_match( '/' . implode( '|', $escaped_labels ) . '/', $post->post_title );
+				$matches = 1 === preg_match('/'.implode('|', $escaped_labels).'/', $post->post_title);
 			}
 
 			// If the title matches, assign the entity to the about, otherwise to the mentions.
-			if ( $matches ) {
+			if ($matches) {
 				$about[] = $item;
 			} else {
 				$mentions[] = $item;
@@ -502,12 +502,12 @@ 
 		}
 
 		// If we have abouts, assign them to the JSON-LD.
-		if ( 0 < count( $about ) ) {
+		if (0 < count($about)) {
 			$jsonld['about'] = $about;
 		}
 
 		// If we have mentions, assign them to the JSON-LD.
-		if ( 0 < count( $mentions ) ) {
+		if (0 < count($mentions)) {
 			$jsonld['mentions'] = $mentions;
 		}
 
@@ -521,13 +521,13 @@ 
 	 *
 	 * @return Reference[]
 	 */
-	private function convert_references( $references ) {
+	private function convert_references($references) {
 		return array_map(
-			function ( $reference ) {
+			function($reference) {
 				// Legacy code may still push numerical references to this
 				// $references variable, so convert it to post references.
-				if ( is_numeric( $reference ) ) {
-					  return new Post_Reference( $reference );
+				if (is_numeric($reference)) {
+					  return new Post_Reference($reference);
 				}
 
 				return $reference;

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

Indentation +47 added lines, -47 removed lines

@@ -13,64 +13,64 @@
  */
 class Wordlift_Debug_Service {
 
-	/**
-	 * The {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.7.2
-	 * @access private
-	 * @var Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
+    /**
+     * The {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.7.2
+     * @access private
+     * @var Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
 
-	/**
-	 * A {@link Wordlift_Uri_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_Uri_Service $uri_service A {@link Wordlift_Uri_Service} instance.
-	 */
-	private $uri_service;
+    /**
+     * A {@link Wordlift_Uri_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_Uri_Service $uri_service A {@link Wordlift_Uri_Service} instance.
+     */
+    private $uri_service;
 
-	/**
-	 * Wordlift_Debug_Service constructor.
-	 *
-	 * @since 3.7.2
-	 *
-	 * @param Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Uri_Service   $uri_service    A {@link Wordlift_Uri_Service} instance.
-	 */
-	public function __construct( $entity_service, $uri_service ) {
+    /**
+     * Wordlift_Debug_Service constructor.
+     *
+     * @since 3.7.2
+     *
+     * @param Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Uri_Service   $uri_service    A {@link Wordlift_Uri_Service} instance.
+     */
+    public function __construct( $entity_service, $uri_service ) {
 
-		$this->entity_service = $entity_service;
-		$this->uri_service    = $uri_service;
+        $this->entity_service = $entity_service;
+        $this->uri_service    = $uri_service;
 
-		add_action( 'wp_ajax_wl_dump_uri', array( $this, 'dump_uri' ) );
+        add_action( 'wp_ajax_wl_dump_uri', array( $this, 'dump_uri' ) );
 
-	}
+    }
 
-	public function dump_uri() {
+    public function dump_uri() {
 
-		if ( ! isset( $_GET['id'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			wp_send_json_error( 'id not set' );
-		}
+        if ( ! isset( $_GET['id'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            wp_send_json_error( 'id not set' );
+        }
 
-		$post_id = (int) $_GET['id']; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $post_id = (int) $_GET['id']; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
-		$post = get_post( $post_id );
+        $post = get_post( $post_id );
 
-		$uri       = $this->entity_service->get_uri( $post_id );
-		$build_uri = $this->uri_service->build_uri( $post->post_title, $post->post_type );
+        $uri       = $this->entity_service->get_uri( $post_id );
+        $build_uri = $this->uri_service->build_uri( $post->post_title, $post->post_type );
 
-		wp_send_json_success(
-			array(
-				'uri'               => $uri,
-				'post_title'        => sprintf( '%s (%s)', $post->post_title, mb_detect_encoding( $post->post_title ) ),
-				'post_title_ascii'  => mb_convert_encoding( $post->post_title, 'ASCII' ),
-				'build_uri'         => $build_uri,
-				'build_uri_convert' => mb_convert_encoding( $build_uri, 'ASCII' ),
-			)
-		);
+        wp_send_json_success(
+            array(
+                'uri'               => $uri,
+                'post_title'        => sprintf( '%s (%s)', $post->post_title, mb_detect_encoding( $post->post_title ) ),
+                'post_title_ascii'  => mb_convert_encoding( $post->post_title, 'ASCII' ),
+                'build_uri'         => $build_uri,
+                'build_uri_convert' => mb_convert_encoding( $build_uri, 'ASCII' ),
+            )
+        );
 
-	}
+    }
 
 }

Spacing +10 added lines, -10 removed lines

@@ -39,35 +39,35 @@
 	 * @param Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
 	 * @param \Wordlift_Uri_Service   $uri_service    A {@link Wordlift_Uri_Service} instance.
 	 */
-	public function __construct( $entity_service, $uri_service ) {
+	public function __construct($entity_service, $uri_service) {
 
 		$this->entity_service = $entity_service;
 		$this->uri_service    = $uri_service;
 
-		add_action( 'wp_ajax_wl_dump_uri', array( $this, 'dump_uri' ) );
+		add_action('wp_ajax_wl_dump_uri', array($this, 'dump_uri'));
 
 	}
 
 	public function dump_uri() {
 
-		if ( ! isset( $_GET['id'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			wp_send_json_error( 'id not set' );
+		if ( ! isset($_GET['id'])) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			wp_send_json_error('id not set');
 		}
 
 		$post_id = (int) $_GET['id']; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
-		$post = get_post( $post_id );
+		$post = get_post($post_id);
 
-		$uri       = $this->entity_service->get_uri( $post_id );
-		$build_uri = $this->uri_service->build_uri( $post->post_title, $post->post_type );
+		$uri       = $this->entity_service->get_uri($post_id);
+		$build_uri = $this->uri_service->build_uri($post->post_title, $post->post_type);
 
 		wp_send_json_success(
 			array(
 				'uri'               => $uri,
-				'post_title'        => sprintf( '%s (%s)', $post->post_title, mb_detect_encoding( $post->post_title ) ),
-				'post_title_ascii'  => mb_convert_encoding( $post->post_title, 'ASCII' ),
+				'post_title'        => sprintf('%s (%s)', $post->post_title, mb_detect_encoding($post->post_title)),
+				'post_title_ascii'  => mb_convert_encoding($post->post_title, 'ASCII'),
 				'build_uri'         => $build_uri,
-				'build_uri_convert' => mb_convert_encoding( $build_uri, 'ASCII' ),
+				'build_uri_convert' => mb_convert_encoding($build_uri, 'ASCII'),
 			)
 		);
 

src/includes/class-wordlift-property-factory.php

Indentation +43 added lines, -43 removed lines

@@ -11,58 +11,58 @@
  */
 class Wordlift_Property_Factory {
 
-	/**
-	 * The default {@link Wordlift_Property_Service}.
-	 *
-	 * @since 3.7.0
-	 * @access private
-	 * @var \Wordlift_Property_Service $default_property_service The default {@link Wordlift_Property_Service}.
-	 */
-	private $default_property_service;
+    /**
+     * The default {@link Wordlift_Property_Service}.
+     *
+     * @since 3.7.0
+     * @access private
+     * @var \Wordlift_Property_Service $default_property_service The default {@link Wordlift_Property_Service}.
+     */
+    private $default_property_service;
 
-	private $property_services = array();
+    private $property_services = array();
 
-	/**
-	 * Wordlift_Property_Factory constructor.
-	 *
-	 * @since 3.7.0
-	 *
-	 * @param \Wordlift_Property_Service $default_property_service
-	 */
-	public function __construct( $default_property_service ) {
+    /**
+     * Wordlift_Property_Factory constructor.
+     *
+     * @since 3.7.0
+     *
+     * @param \Wordlift_Property_Service $default_property_service
+     */
+    public function __construct( $default_property_service ) {
 
-		$this->default_property_service = $default_property_service;
+        $this->default_property_service = $default_property_service;
 
-	}
+    }
 
-	/**
-	 * Set the {@link Wordlift_Property_Service} which handles that meta key.
-	 *
-	 * @since 3.7.0
-	 *
-	 * @param string                     $meta_key WordPress' meta key.
-	 * @param \Wordlift_Property_Service $property_service A {@link Wordlift_Property_Service} instance.
-	 */
-	public function register( $meta_key, $property_service ) {
+    /**
+     * Set the {@link Wordlift_Property_Service} which handles that meta key.
+     *
+     * @since 3.7.0
+     *
+     * @param string                     $meta_key WordPress' meta key.
+     * @param \Wordlift_Property_Service $property_service A {@link Wordlift_Property_Service} instance.
+     */
+    public function register( $meta_key, $property_service ) {
 
-		$this->property_services[ $meta_key ] = $property_service;
+        $this->property_services[ $meta_key ] = $property_service;
 
-	}
+    }
 
-	/**
-	 * Get the {@link Wordlift_Property_Service} which handles the specified meta key.
-	 *
-	 * @since 3.7.0
-	 *
-	 * @param $meta_key
-	 *
-	 * @return \Wordlift_Property_Service The {@link Wordlift_Property_Service} which handles the specified meta key.
-	 */
-	public function get( $meta_key ) {
+    /**
+     * Get the {@link Wordlift_Property_Service} which handles the specified meta key.
+     *
+     * @since 3.7.0
+     *
+     * @param $meta_key
+     *
+     * @return \Wordlift_Property_Service The {@link Wordlift_Property_Service} which handles the specified meta key.
+     */
+    public function get( $meta_key ) {
 
-		$service = $this->property_services[ $meta_key ];
+        $service = $this->property_services[ $meta_key ];
 
-		return $service ? $service : $this->default_property_service;
-	}
+        return $service ? $service : $this->default_property_service;
+    }
 
 }

Spacing +5 added lines, -5 removed lines

@@ -29,7 +29,7 @@ 
 	 *
 	 * @param \Wordlift_Property_Service $default_property_service
 	 */
-	public function __construct( $default_property_service ) {
+	public function __construct($default_property_service) {
 
 		$this->default_property_service = $default_property_service;
 
@@ -43,9 +43,9 @@ 
 	 * @param string                     $meta_key WordPress' meta key.
 	 * @param \Wordlift_Property_Service $property_service A {@link Wordlift_Property_Service} instance.
 	 */
-	public function register( $meta_key, $property_service ) {
+	public function register($meta_key, $property_service) {
 
-		$this->property_services[ $meta_key ] = $property_service;
+		$this->property_services[$meta_key] = $property_service;
 
 	}
 
@@ -58,9 +58,9 @@ 
 	 *
 	 * @return \Wordlift_Property_Service The {@link Wordlift_Property_Service} which handles the specified meta key.
 	 */
-	public function get( $meta_key ) {
+	public function get($meta_key) {
 
-		$service = $this->property_services[ $meta_key ];
+		$service = $this->property_services[$meta_key];
 
 		return $service ? $service : $this->default_property_service;
 	}