insideout10 / wordlift-plugin

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

Indentation +469 added lines, -469 removed lines

@@ -19,147 +19,147 @@ 
  */
 class Wordlift_Entity_Type_Service {
 
-	/**
-	 * The {@link Wordlift_Schema_Service} instance.
-	 *
-	 * @since  3.7.0
-	 * @access private
-	 * @var \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
-	 */
-	private $schema_service;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Wordlift_Entity_Type_Service constructor.
-	 *
-	 * @since 3.7.0
-	 */
-	protected function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Service' );
-
-		$this->schema_service = Wordlift_Schema_Service::get_instance();
-
-		$this->prepare_post_types();
-
-	}
-
-	/**
-	 * Prepare post types for Gutenberg use
-	 *
-	 * @since 3.26.0
-	 */
-	private function prepare_post_types() {
-
-		add_action(
-			'init',
-			function () {
-				// Add post type support for 'custom-fields' for all post types. Specifically needed in Gutenberg
-				$post_types = get_post_types();
-				foreach ( $post_types as $post_type ) {
-					add_post_type_support( $post_type, 'custom-fields' );
-				}
-			}
-		);
-	}
-
-	/**
-	 * The {@link Wordlift_Entity_Type_Service} singleton instance.
-	 *
-	 * @since  3.7.0
-	 * @access private
-	 * @var \Wordlift_Entity_Type_Service $instance The {@link Wordlift_Entity_Type_Service} singleton instance.
-	 */
-	private static $instance = null;
-
-	/**
-	 * Get the {@link Wordlift_Entity_Type_Service} singleton instance.
-	 *
-	 * @return \Wordlift_Entity_Type_Service The {@link Wordlift_Entity_Type_Service} singleton instance.
-	 * @since 3.7.0
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get the types associated with the specified entity post id.
-	 *
-	 * We have a strategy to define the entity type, given that everything is
-	 * an entity, i.e. also posts/pages and custom post types.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|null {
-	 * An array of type properties or null if no term is associated
-	 *
-	 * @type string css_class     The css class, e.g. `wl-thing`.
-	 * @type string uri           The schema.org class URI, e.g. `http://schema.org/Thing`.
-	 * @type array  same_as       An array of same as attributes.
-	 * @type array  custom_fields An array of custom fields.
-	 * }
-	 * @since 3.33.9 The `linked_data` key has been removed.
-	 *
-	 * @since 3.20.0 This function will **not** return entity types introduced with 3.20.0.
-	 *
-	 * @since 3.18.0 The cases are the following:
-	 *  1. the post has a term from the Entity Types Taxonomy: the term defines
-	 *     the entity type, e.g. Organization, Person, ...
-	 *  2. the post doesn't have a term from the Entity Types Taxonomy:
-	 *      a) the post is a `wl_entity` custom post type, then the post is
-	 *           assigned the `Thing` entity type by default.
-	 *      b) the post is a `post` post type, then the post is
-	 *           assigned the `Article` entity type by default.
-	 *      c) the post is a custom post type then it is
-	 *          assigned the `WebPage` entity type by default.
-	 */
-	public function get( $post_id ) {
-
-		$this->log->trace( "Getting the post type for post $post_id..." );
-
-		// Get the post type.
-		$post_type = get_post_type( $post_id );
-
-		// Return `web-page` for non entities.
-		if ( ! self::is_valid_entity_post_type( $post_type ) ) {
-			$this->log->info( "Returning `web-page` for post $post_id." );
-
-			return $this->schema_service->get_schema( 'web-page' );
-		}
-
-		// Get the type from the associated classification.
-		$terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-
-		// Return the schema type if there is a term found.
-		if ( ! is_wp_error( $terms ) && ! empty( $terms ) ) {
-			// Cycle through the terms and return the first one with a valid schema.
-			foreach ( $terms as $term ) {
-				$this->log->debug( "Found `{$term->slug}` term for post $post_id." );
-
-				// Try to get the schema for the term.
-				$schema = $this->schema_service->get_schema( $term->slug );
-
-				// If found, return it, ignoring the other types.
-				if ( null !== $schema ) {
-					// Return the entity type with the specified id.
-					return $schema;
-				}
-			}
-
-			/*
+    /**
+     * The {@link Wordlift_Schema_Service} instance.
+     *
+     * @since  3.7.0
+     * @access private
+     * @var \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
+     */
+    private $schema_service;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Wordlift_Entity_Type_Service constructor.
+     *
+     * @since 3.7.0
+     */
+    protected function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Service' );
+
+        $this->schema_service = Wordlift_Schema_Service::get_instance();
+
+        $this->prepare_post_types();
+
+    }
+
+    /**
+     * Prepare post types for Gutenberg use
+     *
+     * @since 3.26.0
+     */
+    private function prepare_post_types() {
+
+        add_action(
+            'init',
+            function () {
+                // Add post type support for 'custom-fields' for all post types. Specifically needed in Gutenberg
+                $post_types = get_post_types();
+                foreach ( $post_types as $post_type ) {
+                    add_post_type_support( $post_type, 'custom-fields' );
+                }
+            }
+        );
+    }
+
+    /**
+     * The {@link Wordlift_Entity_Type_Service} singleton instance.
+     *
+     * @since  3.7.0
+     * @access private
+     * @var \Wordlift_Entity_Type_Service $instance The {@link Wordlift_Entity_Type_Service} singleton instance.
+     */
+    private static $instance = null;
+
+    /**
+     * Get the {@link Wordlift_Entity_Type_Service} singleton instance.
+     *
+     * @return \Wordlift_Entity_Type_Service The {@link Wordlift_Entity_Type_Service} singleton instance.
+     * @since 3.7.0
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Get the types associated with the specified entity post id.
+     *
+     * We have a strategy to define the entity type, given that everything is
+     * an entity, i.e. also posts/pages and custom post types.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|null {
+     * An array of type properties or null if no term is associated
+     *
+     * @type string css_class     The css class, e.g. `wl-thing`.
+     * @type string uri           The schema.org class URI, e.g. `http://schema.org/Thing`.
+     * @type array  same_as       An array of same as attributes.
+     * @type array  custom_fields An array of custom fields.
+     * }
+     * @since 3.33.9 The `linked_data` key has been removed.
+     *
+     * @since 3.20.0 This function will **not** return entity types introduced with 3.20.0.
+     *
+     * @since 3.18.0 The cases are the following:
+     *  1. the post has a term from the Entity Types Taxonomy: the term defines
+     *     the entity type, e.g. Organization, Person, ...
+     *  2. the post doesn't have a term from the Entity Types Taxonomy:
+     *      a) the post is a `wl_entity` custom post type, then the post is
+     *           assigned the `Thing` entity type by default.
+     *      b) the post is a `post` post type, then the post is
+     *           assigned the `Article` entity type by default.
+     *      c) the post is a custom post type then it is
+     *          assigned the `WebPage` entity type by default.
+     */
+    public function get( $post_id ) {
+
+        $this->log->trace( "Getting the post type for post $post_id..." );
+
+        // Get the post type.
+        $post_type = get_post_type( $post_id );
+
+        // Return `web-page` for non entities.
+        if ( ! self::is_valid_entity_post_type( $post_type ) ) {
+            $this->log->info( "Returning `web-page` for post $post_id." );
+
+            return $this->schema_service->get_schema( 'web-page' );
+        }
+
+        // Get the type from the associated classification.
+        $terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+
+        // Return the schema type if there is a term found.
+        if ( ! is_wp_error( $terms ) && ! empty( $terms ) ) {
+            // Cycle through the terms and return the first one with a valid schema.
+            foreach ( $terms as $term ) {
+                $this->log->debug( "Found `{$term->slug}` term for post $post_id." );
+
+                // Try to get the schema for the term.
+                $schema = $this->schema_service->get_schema( $term->slug );
+
+                // If found, return it, ignoring the other types.
+                if ( null !== $schema ) {
+                    // Return the entity type with the specified id.
+                    return $schema;
+                }
+            }
+
+            /*
 			 * When a schema isn't found, we return `thing`. Schema may not be found because
 			 * the new schema classes that we support since #852 aren't configured in the schema
 			 * service.
@@ -169,93 +169,93 @@ 
 			 * @since 3.20.0
 			 */
 
-			return $this->schema_service->get_schema( 'thing' );
-		}
-
-		// If it's a page or post return `Article`.
-		if ( in_array( $post_type, array( 'post', 'page' ), true ) ) {
-			$this->log->debug( "Post $post_id has no terms, and it's a `post` type, returning `Article`." );
-
-			// Return "Article" schema type for posts.
-			return $this->schema_service->get_schema( 'article' );
-		}
-
-		// Return "Thing" schema type for entities.
-		$this->log->debug( "Post $post_id has no terms, but it's a `wl_entity` type, returning `Thing`." );
-
-		// Return the entity type with the specified id.
-		return $this->schema_service->get_schema( 'thing' );
-
-	}
-
-	/**
-	 * Get the term ids of the entity types associated to the specified post.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|WP_Error An array of entity types ids or a {@link WP_Error}.
-	 * @since 3.20.0
-	 */
-	public function get_ids( $post_id ) {
-
-		return wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, array( 'fields' => 'ids' ) );
-	}
-
-	/**
-	 * Get the camel case names of the entity types associated to the specified post.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|WP_Error An array of entity types camel case names or a {@link WP_Error}.
-	 * @since 3.20.0
-	 */
-	public function get_names( $post_id ) {
-
-		$ids = $this->get_ids( $post_id );
-
-		// Filter out invalid terms (ones without _wl_name term meta)
-		return array_values(
-			array_filter(
-				array_map(
-					function ( $id ) {
-						return get_term_meta( $id, '_wl_name', true );
-					},
-					$ids
-				)
-			)
-		);
-	}
-
-	/**
-	 * Set the main type for the specified entity post, given the type URI.
-	 *
-	 * @param int    $post_id The post id.
-	 * @param string $type_uri The type URI.
-	 * @param bool   $replace Whether the provided type must replace the existing types, by default `true`.
-	 *
-	 * @since 3.8.0
-	 */
-	public function set( $post_id, $type_uri, $replace = true ) {
-
-		// If the type URI is empty we remove the type.
-		if ( empty( $type_uri ) ) {
-			$this->log->debug( "Removing entity type for post $post_id..." );
-
-			wp_set_object_terms( $post_id, null, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-
-			return;
-		}
-
-		$this->log->debug( "Setting entity type for post $post_id..." );
-
-		// if the `$type_uri` starts with `wl-`, we're looking at the class name, which is `wl-` + slug.
-		$term = ( 0 === strpos( $type_uri, 'wl-' ) )
-			// Get term by slug.
-			? $this->get_term_by_slug( substr( $type_uri, 3 ) )
-			// Get term by URI.
-			: $this->get_term_by_uri( $type_uri );
-
-		/*
+            return $this->schema_service->get_schema( 'thing' );
+        }
+
+        // If it's a page or post return `Article`.
+        if ( in_array( $post_type, array( 'post', 'page' ), true ) ) {
+            $this->log->debug( "Post $post_id has no terms, and it's a `post` type, returning `Article`." );
+
+            // Return "Article" schema type for posts.
+            return $this->schema_service->get_schema( 'article' );
+        }
+
+        // Return "Thing" schema type for entities.
+        $this->log->debug( "Post $post_id has no terms, but it's a `wl_entity` type, returning `Thing`." );
+
+        // Return the entity type with the specified id.
+        return $this->schema_service->get_schema( 'thing' );
+
+    }
+
+    /**
+     * Get the term ids of the entity types associated to the specified post.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|WP_Error An array of entity types ids or a {@link WP_Error}.
+     * @since 3.20.0
+     */
+    public function get_ids( $post_id ) {
+
+        return wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, array( 'fields' => 'ids' ) );
+    }
+
+    /**
+     * Get the camel case names of the entity types associated to the specified post.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|WP_Error An array of entity types camel case names or a {@link WP_Error}.
+     * @since 3.20.0
+     */
+    public function get_names( $post_id ) {
+
+        $ids = $this->get_ids( $post_id );
+
+        // Filter out invalid terms (ones without _wl_name term meta)
+        return array_values(
+            array_filter(
+                array_map(
+                    function ( $id ) {
+                        return get_term_meta( $id, '_wl_name', true );
+                    },
+                    $ids
+                )
+            )
+        );
+    }
+
+    /**
+     * Set the main type for the specified entity post, given the type URI.
+     *
+     * @param int    $post_id The post id.
+     * @param string $type_uri The type URI.
+     * @param bool   $replace Whether the provided type must replace the existing types, by default `true`.
+     *
+     * @since 3.8.0
+     */
+    public function set( $post_id, $type_uri, $replace = true ) {
+
+        // If the type URI is empty we remove the type.
+        if ( empty( $type_uri ) ) {
+            $this->log->debug( "Removing entity type for post $post_id..." );
+
+            wp_set_object_terms( $post_id, null, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+
+            return;
+        }
+
+        $this->log->debug( "Setting entity type for post $post_id..." );
+
+        // if the `$type_uri` starts with `wl-`, we're looking at the class name, which is `wl-` + slug.
+        $term = ( 0 === strpos( $type_uri, 'wl-' ) )
+            // Get term by slug.
+            ? $this->get_term_by_slug( substr( $type_uri, 3 ) )
+            // Get term by URI.
+            : $this->get_term_by_uri( $type_uri );
+
+        /*
 		 * We always want to assign a type to an entity otherwise it won't show in the Vocabulary and it won't be
 		 * connected to Articles via mentions. We realized that the client JS code is passing `wl-other` when the
 		 * entity type isn't "notable". In which case we couldn't find an entity type.
@@ -266,246 +266,246 @@ 
 		 *
 		 * @since 3.23.4
 		 */
-		if ( false === $term ) {
-			$this->log->warn( "No term found for URI $type_uri, will use Thing." );
-
-			$term = $this->get_term_by_slug( 'thing' );
-
-			// We still need to be able to bali out here, for example WordPress 5.1 tests create posts before our taxonomy
-			// is installed.
-			if ( false === $term ) {
-				return;
-			}
-		}
-
-		$this->log->debug( "Setting entity type [ post id :: $post_id ][ term id :: $term->term_id ][ term slug :: $term->slug ][ type uri :: $type_uri ]..." );
-
-		// `$replace` is passed to decide whether to replace or append the term.
-		wp_set_object_terms( $post_id, $term->term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, ! $replace );
-
-	}
-
-	/**
-	 * Get an entity type term given its slug.
-	 *
-	 * @param string $slug The slug.
-	 *
-	 * @return false|WP_Term WP_Term instance on success. Will return false if `$taxonomy` does not exist
-	 *                             or `$term` was not found.
-	 * @since 3.20.0
-	 */
-	private function get_term_by_slug( $slug ) {
-
-		return get_term_by( 'slug', $slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-	}
-
-	/**
-	 * Get an entity type term given its URI.
-	 *
-	 * @param string $uri The uri.
-	 *
-	 * @return false|WP_Term WP_Term instance on success. Will return false if `$taxonomy` does not exist
-	 *                             or `$term` was not found.
-	 * @since 3.20.0
-	 */
-	public function get_term_by_uri( $uri ) {
-
-		$terms = get_terms(
-			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-			array(
-				'fields'     => 'all',
-				'get'        => 'all',
-				'number'     => 1,
-				'meta_query' => array(
-					array(
-						// Don't use a reference to Wordlift_Schemaorg_Class_Service, unless
-						// `WL_ALL_ENTITY_TYPES` is set to true.
-						'key'   => '_wl_uri',
-						'value' => $uri,
-					),
-				),
-				'orderby'    => 'term_id',
-				'order'      => 'ASC',
-			)
-		);
-
-		return is_array( $terms ) && ! empty( $terms ) ? $terms[0] : false;
-	}
-
-	/**
-	 * Check whether an entity type is set for the {@link WP_Post} with the
-	 * specified id.
-	 *
-	 * @param int    $post_id The {@link WP_Post}'s `id`.
-	 * @param string $uri The entity type URI.
-	 *
-	 * @return bool True if an entity type is set otherwise false.
-	 * @since 3.15.0
-	 */
-	public function has_entity_type( $post_id, $uri = null ) {
-
-		$this->log->debug( "Checking if post $post_id has an entity type [ $uri ]..." );
-
-		// If an URI hasn't been specified just check whether we have at least
-		// one entity type.
-		if ( null === $uri ) {
-			return has_term( '', Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $post_id );
-		}
-
-		$has_entity_type = ( null !== $this->has_post_term_by_uri( $post_id, $uri ) );
-
-		$this->log->debug( "Post $post_id has $uri type: " . ( $has_entity_type ? 'yes' : 'no' ) );
-
-		// Check whether the post has an entity type with that URI.
-		return $has_entity_type;
-	}
-
-	/**
-	 * Get the list of entity types' terms for the specified {@link WP_Post}.
-	 *
-	 * @param int $post_id The {@link WP_Post} id.
-	 *
-	 * @return array|WP_Error An array of entity types' terms or {@link WP_Error}.
-	 * @since 3.15.0
-	 */
-	private function get_post_terms( $post_id ) {
-
-		return wp_get_object_terms(
-			$post_id,
-			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-			array(
-				'hide_empty' => false,
-				// Because of #334 (and the AAM plugin) we changed fields from 'id=>slug' to 'all'.
-				// An issue has been opened with the AAM plugin author as well.
-				//
-				// see https://github.com/insideout10/wordlift-plugin/issues/334
-				// see https://wordpress.org/support/topic/idslug-not-working-anymore?replies=1#post-8806863
-				'fields'     => 'all',
-			)
-		);
-	}
-
-	/**
-	 * Get an entity type term given its URI.
-	 *
-	 * @param int    $post_id The {@link WP_Post} id.
-	 * @param string $uri The entity type URI.
-	 *
-	 * @return bool True if the post has that type URI bound to it otherwise false.
-	 * @since 3.15.0
-	 *
-	 * @since 3.20.0 function renamed to `has_post_term_by_uri` and return type changed to `bool`.
-	 */
-	private function has_post_term_by_uri( $post_id, $uri ) {
-
-		// Get the post terms bound to the specified post.
-		$terms = $this->get_post_terms( $post_id );
-
-		// Look for a term if the specified URI.
-		foreach ( $terms as $term ) {
-			$term_uri = get_term_meta( $term->term_id, '_wl_uri', true );
-
-			if ( $uri === $term_uri ) {
-				return true;
-			}
-		}
-
-		// Return null.
-		return false;
-	}
-
-	/**
-	 * Get the custom fields for a specific post.
-	 *
-	 * @param int $post_id The post ID.
-	 *
-	 * @return array An array of custom fields (see `custom_fields` in Wordlift_Schema_Service).
-	 * @since 3.25.2
-	 */
-	public function get_custom_fields_for_post( $post_id ) {
-
-		// Return custom fields for this specific entity's type.
-		$types = $this->get_ids( $post_id );
-
-		/** @var WP_Term[] $terms */
-		$terms = array_filter(
-			array_map(
-				function ( $item ) {
-					return get_term( $item );
-				},
-				$types
-			),
-			function ( $item ) {
-				return isset( $item ) && is_a( $item, 'WP_Term' );
-			}
-		);
-
-		$term_slugs = array_map(
-			function ( $item ) {
-				return $item->slug;
-			},
-			$terms
-		);
-
-		$term_slugs[] = 'thing';
-
-		return $this->get_custom_fields_by_term_slugs( $term_slugs );
-	}
-
-	/**
-	 * Get the custom fields for a specific term.
-	 *
-	 * @param int $term_id The term ID.
-	 *
-	 * @return array An array of custom fields (see `custom_fields` in Wordlift_Schema_Service).
-	 * @since 3.32.0
-	 */
-	public function get_custom_fields_for_term( $term_id ) {
-		$selected_entity_types   = get_term_meta( $term_id, 'wl_entity_type' );
-		$selected_entity_types[] = 'thing';
-		$selected_entity_types   = array_unique( $selected_entity_types );
-
-		return $this->get_custom_fields_by_term_slugs( $selected_entity_types );
-	}
-
-	/**
-	 * Determines whether a post type can be used for entities.
-	 *
-	 * Criteria is that the post type is public. The list of valid post types
-	 * can be overridden with a filter.
-	 *
-	 * @param string $post_type A post type name.
-	 *
-	 * @return bool Return true if the post type can be used for entities, otherwise false.
-	 * @since 3.15.0
-	 */
-	public static function is_valid_entity_post_type( $post_type ) {
-
-		return in_array( $post_type, Wordlift_Entity_Service::valid_entity_post_types(), true );
-	}
-
-	/**
-	 * @param $term_slugs
-	 *
-	 * @return array
-	 */
-	private function get_custom_fields_by_term_slugs( $term_slugs ) {
-		$schema_service = Wordlift_Schema_Service::get_instance();
-
-		return array_reduce(
-			$term_slugs,
-			function ( $carry, $item ) use ( $schema_service ) {
-
-				$schema = $schema_service->get_schema( $item );
-
-				if ( ! isset( $schema['custom_fields'] ) ) {
-					return $carry;
-				}
-
-				return $carry + $schema['custom_fields'];
-			},
-			array()
-		);
-	}
+        if ( false === $term ) {
+            $this->log->warn( "No term found for URI $type_uri, will use Thing." );
+
+            $term = $this->get_term_by_slug( 'thing' );
+
+            // We still need to be able to bali out here, for example WordPress 5.1 tests create posts before our taxonomy
+            // is installed.
+            if ( false === $term ) {
+                return;
+            }
+        }
+
+        $this->log->debug( "Setting entity type [ post id :: $post_id ][ term id :: $term->term_id ][ term slug :: $term->slug ][ type uri :: $type_uri ]..." );
+
+        // `$replace` is passed to decide whether to replace or append the term.
+        wp_set_object_terms( $post_id, $term->term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, ! $replace );
+
+    }
+
+    /**
+     * Get an entity type term given its slug.
+     *
+     * @param string $slug The slug.
+     *
+     * @return false|WP_Term WP_Term instance on success. Will return false if `$taxonomy` does not exist
+     *                             or `$term` was not found.
+     * @since 3.20.0
+     */
+    private function get_term_by_slug( $slug ) {
+
+        return get_term_by( 'slug', $slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+    }
+
+    /**
+     * Get an entity type term given its URI.
+     *
+     * @param string $uri The uri.
+     *
+     * @return false|WP_Term WP_Term instance on success. Will return false if `$taxonomy` does not exist
+     *                             or `$term` was not found.
+     * @since 3.20.0
+     */
+    public function get_term_by_uri( $uri ) {
+
+        $terms = get_terms(
+            Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+            array(
+                'fields'     => 'all',
+                'get'        => 'all',
+                'number'     => 1,
+                'meta_query' => array(
+                    array(
+                        // Don't use a reference to Wordlift_Schemaorg_Class_Service, unless
+                        // `WL_ALL_ENTITY_TYPES` is set to true.
+                        'key'   => '_wl_uri',
+                        'value' => $uri,
+                    ),
+                ),
+                'orderby'    => 'term_id',
+                'order'      => 'ASC',
+            )
+        );
+
+        return is_array( $terms ) && ! empty( $terms ) ? $terms[0] : false;
+    }
+
+    /**
+     * Check whether an entity type is set for the {@link WP_Post} with the
+     * specified id.
+     *
+     * @param int    $post_id The {@link WP_Post}'s `id`.
+     * @param string $uri The entity type URI.
+     *
+     * @return bool True if an entity type is set otherwise false.
+     * @since 3.15.0
+     */
+    public function has_entity_type( $post_id, $uri = null ) {
+
+        $this->log->debug( "Checking if post $post_id has an entity type [ $uri ]..." );
+
+        // If an URI hasn't been specified just check whether we have at least
+        // one entity type.
+        if ( null === $uri ) {
+            return has_term( '', Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $post_id );
+        }
+
+        $has_entity_type = ( null !== $this->has_post_term_by_uri( $post_id, $uri ) );
+
+        $this->log->debug( "Post $post_id has $uri type: " . ( $has_entity_type ? 'yes' : 'no' ) );
+
+        // Check whether the post has an entity type with that URI.
+        return $has_entity_type;
+    }
+
+    /**
+     * Get the list of entity types' terms for the specified {@link WP_Post}.
+     *
+     * @param int $post_id The {@link WP_Post} id.
+     *
+     * @return array|WP_Error An array of entity types' terms or {@link WP_Error}.
+     * @since 3.15.0
+     */
+    private function get_post_terms( $post_id ) {
+
+        return wp_get_object_terms(
+            $post_id,
+            Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+            array(
+                'hide_empty' => false,
+                // Because of #334 (and the AAM plugin) we changed fields from 'id=>slug' to 'all'.
+                // An issue has been opened with the AAM plugin author as well.
+                //
+                // see https://github.com/insideout10/wordlift-plugin/issues/334
+                // see https://wordpress.org/support/topic/idslug-not-working-anymore?replies=1#post-8806863
+                'fields'     => 'all',
+            )
+        );
+    }
+
+    /**
+     * Get an entity type term given its URI.
+     *
+     * @param int    $post_id The {@link WP_Post} id.
+     * @param string $uri The entity type URI.
+     *
+     * @return bool True if the post has that type URI bound to it otherwise false.
+     * @since 3.15.0
+     *
+     * @since 3.20.0 function renamed to `has_post_term_by_uri` and return type changed to `bool`.
+     */
+    private function has_post_term_by_uri( $post_id, $uri ) {
+
+        // Get the post terms bound to the specified post.
+        $terms = $this->get_post_terms( $post_id );
+
+        // Look for a term if the specified URI.
+        foreach ( $terms as $term ) {
+            $term_uri = get_term_meta( $term->term_id, '_wl_uri', true );
+
+            if ( $uri === $term_uri ) {
+                return true;
+            }
+        }
+
+        // Return null.
+        return false;
+    }
+
+    /**
+     * Get the custom fields for a specific post.
+     *
+     * @param int $post_id The post ID.
+     *
+     * @return array An array of custom fields (see `custom_fields` in Wordlift_Schema_Service).
+     * @since 3.25.2
+     */
+    public function get_custom_fields_for_post( $post_id ) {
+
+        // Return custom fields for this specific entity's type.
+        $types = $this->get_ids( $post_id );
+
+        /** @var WP_Term[] $terms */
+        $terms = array_filter(
+            array_map(
+                function ( $item ) {
+                    return get_term( $item );
+                },
+                $types
+            ),
+            function ( $item ) {
+                return isset( $item ) && is_a( $item, 'WP_Term' );
+            }
+        );
+
+        $term_slugs = array_map(
+            function ( $item ) {
+                return $item->slug;
+            },
+            $terms
+        );
+
+        $term_slugs[] = 'thing';
+
+        return $this->get_custom_fields_by_term_slugs( $term_slugs );
+    }
+
+    /**
+     * Get the custom fields for a specific term.
+     *
+     * @param int $term_id The term ID.
+     *
+     * @return array An array of custom fields (see `custom_fields` in Wordlift_Schema_Service).
+     * @since 3.32.0
+     */
+    public function get_custom_fields_for_term( $term_id ) {
+        $selected_entity_types   = get_term_meta( $term_id, 'wl_entity_type' );
+        $selected_entity_types[] = 'thing';
+        $selected_entity_types   = array_unique( $selected_entity_types );
+
+        return $this->get_custom_fields_by_term_slugs( $selected_entity_types );
+    }
+
+    /**
+     * Determines whether a post type can be used for entities.
+     *
+     * Criteria is that the post type is public. The list of valid post types
+     * can be overridden with a filter.
+     *
+     * @param string $post_type A post type name.
+     *
+     * @return bool Return true if the post type can be used for entities, otherwise false.
+     * @since 3.15.0
+     */
+    public static function is_valid_entity_post_type( $post_type ) {
+
+        return in_array( $post_type, Wordlift_Entity_Service::valid_entity_post_types(), true );
+    }
+
+    /**
+     * @param $term_slugs
+     *
+     * @return array
+     */
+    private function get_custom_fields_by_term_slugs( $term_slugs ) {
+        $schema_service = Wordlift_Schema_Service::get_instance();
+
+        return array_reduce(
+            $term_slugs,
+            function ( $carry, $item ) use ( $schema_service ) {
+
+                $schema = $schema_service->get_schema( $item );
+
+                if ( ! isset( $schema['custom_fields'] ) ) {
+                    return $carry;
+                }
+
+                return $carry + $schema['custom_fields'];
+            },
+            array()
+        );
+    }
 
 }

Spacing +77 added lines, -77 removed lines

@@ -44,7 +44,7 @@ 
 	 */
 	protected function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Entity_Type_Service');
 
 		$this->schema_service = Wordlift_Schema_Service::get_instance();
 
@@ -61,11 +61,11 @@ 
 
 		add_action(
 			'init',
-			function () {
+			function() {
 				// Add post type support for 'custom-fields' for all post types. Specifically needed in Gutenberg
 				$post_types = get_post_types();
-				foreach ( $post_types as $post_type ) {
-					add_post_type_support( $post_type, 'custom-fields' );
+				foreach ($post_types as $post_type) {
+					add_post_type_support($post_type, 'custom-fields');
 				}
 			}
 		);
@@ -88,7 +88,7 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -126,34 +126,34 @@ 
 	 *      c) the post is a custom post type then it is
 	 *          assigned the `WebPage` entity type by default.
 	 */
-	public function get( $post_id ) {
+	public function get($post_id) {
 
-		$this->log->trace( "Getting the post type for post $post_id..." );
+		$this->log->trace("Getting the post type for post $post_id...");
 
 		// Get the post type.
-		$post_type = get_post_type( $post_id );
+		$post_type = get_post_type($post_id);
 
 		// Return `web-page` for non entities.
-		if ( ! self::is_valid_entity_post_type( $post_type ) ) {
-			$this->log->info( "Returning `web-page` for post $post_id." );
+		if ( ! self::is_valid_entity_post_type($post_type)) {
+			$this->log->info("Returning `web-page` for post $post_id.");
 
-			return $this->schema_service->get_schema( 'web-page' );
+			return $this->schema_service->get_schema('web-page');
 		}
 
 		// Get the type from the associated classification.
-		$terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+		$terms = wp_get_object_terms($post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 
 		// Return the schema type if there is a term found.
-		if ( ! is_wp_error( $terms ) && ! empty( $terms ) ) {
+		if ( ! is_wp_error($terms) && ! empty($terms)) {
 			// Cycle through the terms and return the first one with a valid schema.
-			foreach ( $terms as $term ) {
-				$this->log->debug( "Found `{$term->slug}` term for post $post_id." );
+			foreach ($terms as $term) {
+				$this->log->debug("Found `{$term->slug}` term for post $post_id.");
 
 				// Try to get the schema for the term.
-				$schema = $this->schema_service->get_schema( $term->slug );
+				$schema = $this->schema_service->get_schema($term->slug);
 
 				// If found, return it, ignoring the other types.
-				if ( null !== $schema ) {
+				if (null !== $schema) {
 					// Return the entity type with the specified id.
 					return $schema;
 				}
@@ -169,22 +169,22 @@ 
 			 * @since 3.20.0
 			 */
 
-			return $this->schema_service->get_schema( 'thing' );
+			return $this->schema_service->get_schema('thing');
 		}
 
 		// If it's a page or post return `Article`.
-		if ( in_array( $post_type, array( 'post', 'page' ), true ) ) {
-			$this->log->debug( "Post $post_id has no terms, and it's a `post` type, returning `Article`." );
+		if (in_array($post_type, array('post', 'page'), true)) {
+			$this->log->debug("Post $post_id has no terms, and it's a `post` type, returning `Article`.");
 
 			// Return "Article" schema type for posts.
-			return $this->schema_service->get_schema( 'article' );
+			return $this->schema_service->get_schema('article');
 		}
 
 		// Return "Thing" schema type for entities.
-		$this->log->debug( "Post $post_id has no terms, but it's a `wl_entity` type, returning `Thing`." );
+		$this->log->debug("Post $post_id has no terms, but it's a `wl_entity` type, returning `Thing`.");
 
 		// Return the entity type with the specified id.
-		return $this->schema_service->get_schema( 'thing' );
+		return $this->schema_service->get_schema('thing');
 
 	}
 
@@ -196,9 +196,9 @@ 
 	 * @return array|WP_Error An array of entity types ids or a {@link WP_Error}.
 	 * @since 3.20.0
 	 */
-	public function get_ids( $post_id ) {
+	public function get_ids($post_id) {
 
-		return wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, array( 'fields' => 'ids' ) );
+		return wp_get_object_terms($post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, array('fields' => 'ids'));
 	}
 
 	/**
@@ -209,16 +209,16 @@ 
 	 * @return array|WP_Error An array of entity types camel case names or a {@link WP_Error}.
 	 * @since 3.20.0
 	 */
-	public function get_names( $post_id ) {
+	public function get_names($post_id) {
 
-		$ids = $this->get_ids( $post_id );
+		$ids = $this->get_ids($post_id);
 
 		// Filter out invalid terms (ones without _wl_name term meta)
 		return array_values(
 			array_filter(
 				array_map(
-					function ( $id ) {
-						return get_term_meta( $id, '_wl_name', true );
+					function($id) {
+						return get_term_meta($id, '_wl_name', true);
 					},
 					$ids
 				)
@@ -235,25 +235,25 @@ 
 	 *
 	 * @since 3.8.0
 	 */
-	public function set( $post_id, $type_uri, $replace = true ) {
+	public function set($post_id, $type_uri, $replace = true) {
 
 		// If the type URI is empty we remove the type.
-		if ( empty( $type_uri ) ) {
-			$this->log->debug( "Removing entity type for post $post_id..." );
+		if (empty($type_uri)) {
+			$this->log->debug("Removing entity type for post $post_id...");
 
-			wp_set_object_terms( $post_id, null, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+			wp_set_object_terms($post_id, null, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 
 			return;
 		}
 
-		$this->log->debug( "Setting entity type for post $post_id..." );
+		$this->log->debug("Setting entity type for post $post_id...");
 
 		// if the `$type_uri` starts with `wl-`, we're looking at the class name, which is `wl-` + slug.
-		$term = ( 0 === strpos( $type_uri, 'wl-' ) )
+		$term = (0 === strpos($type_uri, 'wl-'))
 			// Get term by slug.
-			? $this->get_term_by_slug( substr( $type_uri, 3 ) )
+			? $this->get_term_by_slug(substr($type_uri, 3))
 			// Get term by URI.
-			: $this->get_term_by_uri( $type_uri );
+			: $this->get_term_by_uri($type_uri);
 
 		/*
 		 * We always want to assign a type to an entity otherwise it won't show in the Vocabulary and it won't be
@@ -266,22 +266,22 @@ 
 		 *
 		 * @since 3.23.4
 		 */
-		if ( false === $term ) {
-			$this->log->warn( "No term found for URI $type_uri, will use Thing." );
+		if (false === $term) {
+			$this->log->warn("No term found for URI $type_uri, will use Thing.");
 
-			$term = $this->get_term_by_slug( 'thing' );
+			$term = $this->get_term_by_slug('thing');
 
 			// We still need to be able to bali out here, for example WordPress 5.1 tests create posts before our taxonomy
 			// is installed.
-			if ( false === $term ) {
+			if (false === $term) {
 				return;
 			}
 		}
 
-		$this->log->debug( "Setting entity type [ post id :: $post_id ][ term id :: $term->term_id ][ term slug :: $term->slug ][ type uri :: $type_uri ]..." );
+		$this->log->debug("Setting entity type [ post id :: $post_id ][ term id :: $term->term_id ][ term slug :: $term->slug ][ type uri :: $type_uri ]...");
 
 		// `$replace` is passed to decide whether to replace or append the term.
-		wp_set_object_terms( $post_id, $term->term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, ! $replace );
+		wp_set_object_terms($post_id, $term->term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, ! $replace);
 
 	}
 
@@ -294,9 +294,9 @@ 
 	 *                             or `$term` was not found.
 	 * @since 3.20.0
 	 */
-	private function get_term_by_slug( $slug ) {
+	private function get_term_by_slug($slug) {
 
-		return get_term_by( 'slug', $slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+		return get_term_by('slug', $slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 	}
 
 	/**
@@ -308,7 +308,7 @@ 
 	 *                             or `$term` was not found.
 	 * @since 3.20.0
 	 */
-	public function get_term_by_uri( $uri ) {
+	public function get_term_by_uri($uri) {
 
 		$terms = get_terms(
 			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
@@ -329,7 +329,7 @@ 
 			)
 		);
 
-		return is_array( $terms ) && ! empty( $terms ) ? $terms[0] : false;
+		return is_array($terms) && ! empty($terms) ? $terms[0] : false;
 	}
 
 	/**
@@ -342,19 +342,19 @@ 
 	 * @return bool True if an entity type is set otherwise false.
 	 * @since 3.15.0
 	 */
-	public function has_entity_type( $post_id, $uri = null ) {
+	public function has_entity_type($post_id, $uri = null) {
 
-		$this->log->debug( "Checking if post $post_id has an entity type [ $uri ]..." );
+		$this->log->debug("Checking if post $post_id has an entity type [ $uri ]...");
 
 		// If an URI hasn't been specified just check whether we have at least
 		// one entity type.
-		if ( null === $uri ) {
-			return has_term( '', Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $post_id );
+		if (null === $uri) {
+			return has_term('', Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $post_id);
 		}
 
-		$has_entity_type = ( null !== $this->has_post_term_by_uri( $post_id, $uri ) );
+		$has_entity_type = (null !== $this->has_post_term_by_uri($post_id, $uri));
 
-		$this->log->debug( "Post $post_id has $uri type: " . ( $has_entity_type ? 'yes' : 'no' ) );
+		$this->log->debug("Post $post_id has $uri type: ".($has_entity_type ? 'yes' : 'no'));
 
 		// Check whether the post has an entity type with that URI.
 		return $has_entity_type;
@@ -368,7 +368,7 @@ 
 	 * @return array|WP_Error An array of entity types' terms or {@link WP_Error}.
 	 * @since 3.15.0
 	 */
-	private function get_post_terms( $post_id ) {
+	private function get_post_terms($post_id) {
 
 		return wp_get_object_terms(
 			$post_id,
@@ -396,16 +396,16 @@ 
 	 *
 	 * @since 3.20.0 function renamed to `has_post_term_by_uri` and return type changed to `bool`.
 	 */
-	private function has_post_term_by_uri( $post_id, $uri ) {
+	private function has_post_term_by_uri($post_id, $uri) {
 
 		// Get the post terms bound to the specified post.
-		$terms = $this->get_post_terms( $post_id );
+		$terms = $this->get_post_terms($post_id);
 
 		// Look for a term if the specified URI.
-		foreach ( $terms as $term ) {
-			$term_uri = get_term_meta( $term->term_id, '_wl_uri', true );
+		foreach ($terms as $term) {
+			$term_uri = get_term_meta($term->term_id, '_wl_uri', true);
 
-			if ( $uri === $term_uri ) {
+			if ($uri === $term_uri) {
 				return true;
 			}
 		}
@@ -422,26 +422,26 @@ 
 	 * @return array An array of custom fields (see `custom_fields` in Wordlift_Schema_Service).
 	 * @since 3.25.2
 	 */
-	public function get_custom_fields_for_post( $post_id ) {
+	public function get_custom_fields_for_post($post_id) {
 
 		// Return custom fields for this specific entity's type.
-		$types = $this->get_ids( $post_id );
+		$types = $this->get_ids($post_id);
 
 		/** @var WP_Term[] $terms */
 		$terms = array_filter(
 			array_map(
-				function ( $item ) {
-					return get_term( $item );
+				function($item) {
+					return get_term($item);
 				},
 				$types
 			),
-			function ( $item ) {
-				return isset( $item ) && is_a( $item, 'WP_Term' );
+			function($item) {
+				return isset($item) && is_a($item, 'WP_Term');
 			}
 		);
 
 		$term_slugs = array_map(
-			function ( $item ) {
+			function($item) {
 				return $item->slug;
 			},
 			$terms
@@ -449,7 +449,7 @@ 
 
 		$term_slugs[] = 'thing';
 
-		return $this->get_custom_fields_by_term_slugs( $term_slugs );
+		return $this->get_custom_fields_by_term_slugs($term_slugs);
 	}
 
 	/**
@@ -460,12 +460,12 @@ 
 	 * @return array An array of custom fields (see `custom_fields` in Wordlift_Schema_Service).
 	 * @since 3.32.0
 	 */
-	public function get_custom_fields_for_term( $term_id ) {
-		$selected_entity_types   = get_term_meta( $term_id, 'wl_entity_type' );
+	public function get_custom_fields_for_term($term_id) {
+		$selected_entity_types   = get_term_meta($term_id, 'wl_entity_type');
 		$selected_entity_types[] = 'thing';
-		$selected_entity_types   = array_unique( $selected_entity_types );
+		$selected_entity_types   = array_unique($selected_entity_types);
 
-		return $this->get_custom_fields_by_term_slugs( $selected_entity_types );
+		return $this->get_custom_fields_by_term_slugs($selected_entity_types);
 	}
 
 	/**
@@ -479,9 +479,9 @@ 
 	 * @return bool Return true if the post type can be used for entities, otherwise false.
 	 * @since 3.15.0
 	 */
-	public static function is_valid_entity_post_type( $post_type ) {
+	public static function is_valid_entity_post_type($post_type) {
 
-		return in_array( $post_type, Wordlift_Entity_Service::valid_entity_post_types(), true );
+		return in_array($post_type, Wordlift_Entity_Service::valid_entity_post_types(), true);
 	}
 
 	/**
@@ -489,16 +489,16 @@ 
 	 *
 	 * @return array
 	 */
-	private function get_custom_fields_by_term_slugs( $term_slugs ) {
+	private function get_custom_fields_by_term_slugs($term_slugs) {
 		$schema_service = Wordlift_Schema_Service::get_instance();
 
 		return array_reduce(
 			$term_slugs,
-			function ( $carry, $item ) use ( $schema_service ) {
+			function($carry, $item) use ($schema_service) {
 
-				$schema = $schema_service->get_schema( $item );
+				$schema = $schema_service->get_schema($item);
 
-				if ( ! isset( $schema['custom_fields'] ) ) {
+				if ( ! isset($schema['custom_fields'])) {
 					return $carry;
 				}
 

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

Indentation +76 added lines, -76 removed lines

@@ -13,7 +13,7 @@ 
 use Wordlift\Autocomplete\Autocomplete_Service;
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -23,79 +23,79 @@ 
  */
 class Wordlift_Autocomplete_Adapter {
 
-	/**
-	 * The {@link Autocomplete_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var Autocomplete_Service $configuration_service The {@link Autocomplete_Service} instance.
-	 */
-	private $autocomplete_service;
-
-	/**
-	 * Wordlift_Autocomplete_Adapter constructor.
-	 *
-	 * @param Autocomplete_Service $autocomplete_service The {@link Autocomplete_Service} instance.
-	 *
-	 * @since 3.14.2
-	 */
-	public function __construct( $autocomplete_service ) {
-		$this->autocomplete_service = $autocomplete_service;
-	}
-
-	/**
-	 * Handle the autocomplete ajax request.
-	 *
-	 * @since 3.15.0
-	 */
-	public function wl_autocomplete() {
-
-		check_ajax_referer( 'wl_autocomplete' );
-
-		// Return error if the query param is empty.
-		if ( ! empty( $_REQUEST['query'] ) ) { // Input var okay.
-			$query = sanitize_text_field( wp_unslash( $_REQUEST['query'] ) ); // Input var okay.
-		} else {
-			wp_send_json_error(
-				array(
-					'message' => __( 'The query param is empty.', 'wordlift' ),
-				)
-			);
-		}
-
-		// Get the exclude parameter.
-		$exclude = ! empty( $_REQUEST['exclude'] )
-			? sanitize_text_field( wp_unslash( $_REQUEST['exclude'] ) ) : '';
-
-		$scope = ! empty( $_REQUEST['scope'] )
-			? sanitize_text_field( wp_unslash( $_REQUEST['scope'] ) ) : WL_AUTOCOMPLETE_SCOPE;
-
-		/**
-		 * @since 3.26.1
-		 * Providing a way for term pages to show and save local entities.
-		 */
-		$show_local_entities = false;
-
-		if ( isset( $_REQUEST['show_local_entities'] )
-			 && ! empty( $_REQUEST['show_local_entities'] ) ) { // Make request.
-			$show_local_entities = filter_var( wp_unslash( $_REQUEST['show_local_entities'] ), FILTER_VALIDATE_BOOLEAN );
-		}
-
-		// Add the filter to check if we need to show local entities or not.
-		add_filter(
-			'wl_show_local_entities',
-			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			function ( $state ) use ( $show_local_entities ) {
-				return $show_local_entities;
-			}
-		);
-
-		$results = $this->autocomplete_service->query( $query, $scope, $exclude );
-
-		// Clear any buffer.
-		ob_clean();
-
-		wp_send_json_success( $results );
-
-	}
+    /**
+     * The {@link Autocomplete_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var Autocomplete_Service $configuration_service The {@link Autocomplete_Service} instance.
+     */
+    private $autocomplete_service;
+
+    /**
+     * Wordlift_Autocomplete_Adapter constructor.
+     *
+     * @param Autocomplete_Service $autocomplete_service The {@link Autocomplete_Service} instance.
+     *
+     * @since 3.14.2
+     */
+    public function __construct( $autocomplete_service ) {
+        $this->autocomplete_service = $autocomplete_service;
+    }
+
+    /**
+     * Handle the autocomplete ajax request.
+     *
+     * @since 3.15.0
+     */
+    public function wl_autocomplete() {
+
+        check_ajax_referer( 'wl_autocomplete' );
+
+        // Return error if the query param is empty.
+        if ( ! empty( $_REQUEST['query'] ) ) { // Input var okay.
+            $query = sanitize_text_field( wp_unslash( $_REQUEST['query'] ) ); // Input var okay.
+        } else {
+            wp_send_json_error(
+                array(
+                    'message' => __( 'The query param is empty.', 'wordlift' ),
+                )
+            );
+        }
+
+        // Get the exclude parameter.
+        $exclude = ! empty( $_REQUEST['exclude'] )
+            ? sanitize_text_field( wp_unslash( $_REQUEST['exclude'] ) ) : '';
+
+        $scope = ! empty( $_REQUEST['scope'] )
+            ? sanitize_text_field( wp_unslash( $_REQUEST['scope'] ) ) : WL_AUTOCOMPLETE_SCOPE;
+
+        /**
+         * @since 3.26.1
+         * Providing a way for term pages to show and save local entities.
+         */
+        $show_local_entities = false;
+
+        if ( isset( $_REQUEST['show_local_entities'] )
+             && ! empty( $_REQUEST['show_local_entities'] ) ) { // Make request.
+            $show_local_entities = filter_var( wp_unslash( $_REQUEST['show_local_entities'] ), FILTER_VALIDATE_BOOLEAN );
+        }
+
+        // Add the filter to check if we need to show local entities or not.
+        add_filter(
+            'wl_show_local_entities',
+            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+            function ( $state ) use ( $show_local_entities ) {
+                return $show_local_entities;
+            }
+        );
+
+        $results = $this->autocomplete_service->query( $query, $scope, $exclude );
+
+        // Clear any buffer.
+        ob_clean();
+
+        wp_send_json_success( $results );
+
+    }
 }

Spacing +16 added lines, -16 removed lines

@@ -12,7 +12,7 @@ 
 
 use Wordlift\Autocomplete\Autocomplete_Service;
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -39,7 +39,7 @@ 
 	 *
 	 * @since 3.14.2
 	 */
-	public function __construct( $autocomplete_service ) {
+	public function __construct($autocomplete_service) {
 		$this->autocomplete_service = $autocomplete_service;
 	}
 
@@ -50,25 +50,25 @@ 
 	 */
 	public function wl_autocomplete() {
 
-		check_ajax_referer( 'wl_autocomplete' );
+		check_ajax_referer('wl_autocomplete');
 
 		// Return error if the query param is empty.
-		if ( ! empty( $_REQUEST['query'] ) ) { // Input var okay.
-			$query = sanitize_text_field( wp_unslash( $_REQUEST['query'] ) ); // Input var okay.
+		if ( ! empty($_REQUEST['query'])) { // Input var okay.
+			$query = sanitize_text_field(wp_unslash($_REQUEST['query'])); // Input var okay.
 		} else {
 			wp_send_json_error(
 				array(
-					'message' => __( 'The query param is empty.', 'wordlift' ),
+					'message' => __('The query param is empty.', 'wordlift'),
 				)
 			);
 		}
 
 		// Get the exclude parameter.
-		$exclude = ! empty( $_REQUEST['exclude'] )
-			? sanitize_text_field( wp_unslash( $_REQUEST['exclude'] ) ) : '';
+		$exclude = ! empty($_REQUEST['exclude'])
+			? sanitize_text_field(wp_unslash($_REQUEST['exclude'])) : '';
 
-		$scope = ! empty( $_REQUEST['scope'] )
-			? sanitize_text_field( wp_unslash( $_REQUEST['scope'] ) ) : WL_AUTOCOMPLETE_SCOPE;
+		$scope = ! empty($_REQUEST['scope'])
+			? sanitize_text_field(wp_unslash($_REQUEST['scope'])) : WL_AUTOCOMPLETE_SCOPE;
 
 		/**
 		 * @since 3.26.1
@@ -76,26 +76,26 @@ 
 		 */
 		$show_local_entities = false;
 
-		if ( isset( $_REQUEST['show_local_entities'] )
-			 && ! empty( $_REQUEST['show_local_entities'] ) ) { // Make request.
-			$show_local_entities = filter_var( wp_unslash( $_REQUEST['show_local_entities'] ), FILTER_VALIDATE_BOOLEAN );
+		if (isset($_REQUEST['show_local_entities'])
+			 && ! empty($_REQUEST['show_local_entities'])) { // Make request.
+			$show_local_entities = filter_var(wp_unslash($_REQUEST['show_local_entities']), FILTER_VALIDATE_BOOLEAN);
 		}
 
 		// Add the filter to check if we need to show local entities or not.
 		add_filter(
 			'wl_show_local_entities',
 			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			function ( $state ) use ( $show_local_entities ) {
+			function($state) use ($show_local_entities) {
 				return $show_local_entities;
 			}
 		);
 
-		$results = $this->autocomplete_service->query( $query, $scope, $exclude );
+		$results = $this->autocomplete_service->query($query, $scope, $exclude);
 
 		// Clear any buffer.
 		ob_clean();
 
-		wp_send_json_success( $results );
+		wp_send_json_success($results);
 
 	}
 }

src/includes/class-wordlift-schema-location-property-service.php

Indentation +82 added lines, -82 removed lines

@@ -13,87 +13,87 @@
  */
 class Wordlift_Schema_Location_Property_Service extends Wordlift_Property_Service {
 
-	/**
-	 * The meta key used to store data for this property. We don't use wl_url to
-	 * avoid potential confusion about other URLs.
-	 *
-	 * @since 3.7.0
-	 */
-	const META_KEY = 'wl_location';
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_rdf_predicate() {
-
-		return 'http://schema.org/location';
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_rdf_data_type() {
-
-		return 'xsd:anyURI';
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_data_type() {
-
-		return Wordlift_Schema_Service::DATA_TYPE_URI;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_cardinality() {
-
-		return INF;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_metabox_class() {
-
-		return 'Wl_Metabox_Field';
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_metabox_label() {
-
-		return 'Location(s)';
-	}
-
-	/**
-	 * Get the schema:url value for the specified post/entity.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|NULL The schema:url value or NULL if not set.
-	 * @since 3.7.0
-	 */
-	public function get( $post_id ) {
-
-		// Get the schema:url values set in WP.
-		$values = get_post_meta( $post_id, self::META_KEY, false );
-
-		// Finally return whatever values the editor set.
-		return $values;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function sanitize( $value ) {
-
-		// TODO: check that it's an URL or that is <permalink>
-
-		return $value;
-	}
+    /**
+     * The meta key used to store data for this property. We don't use wl_url to
+     * avoid potential confusion about other URLs.
+     *
+     * @since 3.7.0
+     */
+    const META_KEY = 'wl_location';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_rdf_predicate() {
+
+        return 'http://schema.org/location';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_rdf_data_type() {
+
+        return 'xsd:anyURI';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_data_type() {
+
+        return Wordlift_Schema_Service::DATA_TYPE_URI;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_cardinality() {
+
+        return INF;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_metabox_class() {
+
+        return 'Wl_Metabox_Field';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_metabox_label() {
+
+        return 'Location(s)';
+    }
+
+    /**
+     * Get the schema:url value for the specified post/entity.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|NULL The schema:url value or NULL if not set.
+     * @since 3.7.0
+     */
+    public function get( $post_id ) {
+
+        // Get the schema:url values set in WP.
+        $values = get_post_meta( $post_id, self::META_KEY, false );
+
+        // Finally return whatever values the editor set.
+        return $values;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function sanitize( $value ) {
+
+        // TODO: check that it's an URL or that is <permalink>
+
+        return $value;
+    }
 
 }

Spacing +3 added lines, -3 removed lines

@@ -77,10 +77,10 @@ 
 	 * @return array|NULL The schema:url value or NULL if not set.
 	 * @since 3.7.0
 	 */
-	public function get( $post_id ) {
+	public function get($post_id) {
 
 		// Get the schema:url values set in WP.
-		$values = get_post_meta( $post_id, self::META_KEY, false );
+		$values = get_post_meta($post_id, self::META_KEY, false);
 
 		// Finally return whatever values the editor set.
 		return $values;
@@ -89,7 +89,7 @@ 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function sanitize( $value ) {
+	public function sanitize($value) {
 
 		// TODO: check that it's an URL or that is <permalink>
 

src/includes/cache/intf-wordlift-cache-service.php

Indentation +43 added lines, -43 removed lines

@@ -17,52 +17,52 @@
  */
 interface Wordlift_Cache_Service {
 
-	/**
-	 * Get the cached response for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param string $id The cache `id`.
-	 *
-	 * @return mixed|false The cached contents or false if the cache isn't found.
-	 */
-	public function get_cache( $id );
+    /**
+     * Get the cached response for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param string $id The cache `id`.
+     *
+     * @return mixed|false The cached contents or false if the cache isn't found.
+     */
+    public function get_cache( $id );
 
-	/**
-	 * Check whether we have cached results for the provided id.
-	 *
-	 * @since 3.16.3
-	 *
-	 * @param string $id The cache `id`.
-	 *
-	 * @return bool True if we have cached results otherwise false.
-	 */
-	public function has_cache( $id );
+    /**
+     * Check whether we have cached results for the provided id.
+     *
+     * @since 3.16.3
+     *
+     * @param string $id The cache `id`.
+     *
+     * @return bool True if we have cached results otherwise false.
+     */
+    public function has_cache( $id );
 
-	/**
-	 * Set the cache contents for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param string $id       The cache id.
-	 * @param mixed  $contents The cache contents.
-	 */
-	public function set_cache( $id, $contents );
+    /**
+     * Set the cache contents for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param string $id       The cache id.
+     * @param mixed  $contents The cache contents.
+     */
+    public function set_cache( $id, $contents );
 
-	/**
-	 * Delete the cache for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param string $id The cache `id`.
-	 */
-	public function delete_cache( $id );
+    /**
+     * Delete the cache for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param string $id The cache `id`.
+     */
+    public function delete_cache( $id );
 
-	/**
-	 * Flush the whole cache.
-	 *
-	 * @since 3.16.0
-	 */
-	public function flush();
+    /**
+     * Flush the whole cache.
+     *
+     * @since 3.16.0
+     */
+    public function flush();
 
 }

Spacing +4 added lines, -4 removed lines

@@ -26,7 +26,7 @@ 
 	 *
 	 * @return mixed|false The cached contents or false if the cache isn't found.
 	 */
-	public function get_cache( $id );
+	public function get_cache($id);
 
 	/**
 	 * Check whether we have cached results for the provided id.
@@ -37,7 +37,7 @@ 
 	 *
 	 * @return bool True if we have cached results otherwise false.
 	 */
-	public function has_cache( $id );
+	public function has_cache($id);
 
 	/**
 	 * Set the cache contents for the specified `id`.
@@ -47,7 +47,7 @@ 
 	 * @param string $id       The cache id.
 	 * @param mixed  $contents The cache contents.
 	 */
-	public function set_cache( $id, $contents );
+	public function set_cache($id, $contents);
 
 	/**
 	 * Delete the cache for the specified `id`.
@@ -56,7 +56,7 @@ 
 	 *
 	 * @param string $id The cache `id`.
 	 */
-	public function delete_cache( $id );
+	public function delete_cache($id);
 
 	/**
 	 * Flush the whole cache.

src/includes/cache/require.php

Spacing +4 added lines, -4 removed lines

@@ -8,7 +8,7 @@
  * @package    Wordlift
  * @subpackage Wordlift/includes/cache
  */
-require_once plugin_dir_path( dirname( __DIR__ ) ) . 'includes/cache/intf-wordlift-cache-service.php';
-require_once plugin_dir_path( dirname( __DIR__ ) ) . 'includes/cache/class-wordlift-file-cache-service.php';
-require_once plugin_dir_path( dirname( __DIR__ ) ) . 'includes/cache/class-wordlift-cached-post-converter.php';
-require_once plugin_dir_path( dirname( __DIR__ ) ) . 'includes/cache/class-wordlift-cached-entity-uri-service.php';
+require_once plugin_dir_path(dirname(__DIR__)).'includes/cache/intf-wordlift-cache-service.php';
+require_once plugin_dir_path(dirname(__DIR__)).'includes/cache/class-wordlift-file-cache-service.php';
+require_once plugin_dir_path(dirname(__DIR__)).'includes/cache/class-wordlift-cached-post-converter.php';
+require_once plugin_dir_path(dirname(__DIR__)).'includes/cache/class-wordlift-cached-entity-uri-service.php';

src/includes/cache/class-wordlift-cached-entity-uri-service.php

Indentation +198 added lines, -198 removed lines

@@ -14,203 +14,203 @@
  */
 class Wordlift_Cached_Entity_Uri_Service extends Wordlift_Entity_Uri_Service {
 
-	/**
-	 * The {@link Wordlift_Cache_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Cache_Service $cache_service The {@link Wordlift_Cache_Service} instance.
-	 */
-	private $cache_service;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a {@link Wordlift_Cached_Entity_Uri_Service} instance.
-	 *
-	 * @param \Wordlift_Cache_Service $cache_service
-	 *
-	 * @since 3.16.3
-	 */
-	public function __construct( $cache_service ) {
-		parent::__construct();
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		// Add hooks for meta being added/modified/deleted.
-		$this->cache_service = $cache_service;
-
-		add_action( 'add_post_meta', array( $this, 'on_before_post_meta_add' ), 10, 3 );
-		add_action( 'update_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
-		add_action( 'delete_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
-
-	}
-
-	/**
-	 * Preload the URIs.
-	 *
-	 * @param array $uris Preload an array of URIs.
-	 *
-	 * @since 3.16.3
-	 */
-	public function preload_uris( $uris ) {
-
-		// Filter the URIs which aren't yet cached.
-		$cache_service = $this->cache_service;
-		$uris_to_cache = array_filter(
-			(array) $uris,
-			function ( $item ) use ( $cache_service ) {
-				return ! $cache_service->has_cache( $item );
-			}
-		);
-
-		// Preload the URIs.
-		parent::preload_uris( $uris_to_cache );
-
-		// Store them in cache.
-		if ( is_array( $this->uri_to_post ) && ! empty( $this->uri_to_post ) ) {
-			foreach ( $this->uri_to_post as $uri => $post_id ) {
-				$this->set_cache( $uri, $post_id );
-			}
-		}
-
-	}
-
-	/**
-	 * Get the entity post for the specified URI.
-	 *
-	 * @param string $uri The URI.
-	 *
-	 * @return null|WP_Post The {@link WP_Post} or null if not found.
-	 * @since 3.16.3
-	 */
-	public function get_entity( $uri ) {
-
-		$this->log->trace( "Getting entity for uri $uri..." );
-
-		// Get the cached post for the specified URI.
-		$cache = $this->cache_service->get_cache( $uri );
-
-		// Return the cached data if valid.
-		if ( false !== $cache && is_numeric( $cache ) ) {
-			$this->log->debug( "Cached entity $cache for uri $uri found." );
-
-			return get_post( $cache );
-		}
-
-		// Get the actual result.
-		$post = parent::get_entity( $uri );
-
-		// Cache the result.
-		if ( null !== $post ) {
-			$this->set_cache( $uri, $post->ID );
-		}
-
-		// Return the result.
-		return $post;
-	}
-
-	/**
-	 * Set the cached URI for the specified {@link WP_Post}.
-	 *
-	 * @param string $uri The URI.
-	 * @param int    $post_id The post ID.
-	 *
-	 * @since 3.16.3
-	 * @since 3.29.0 takes a post ID as input.
-	 */
-	private function set_cache( $uri, $post_id ) {
-
-		// Cache the result.
-		$this->cache_service->set_cache( $uri, $post_id );
-
-	}
-
-	/**
-	 * Delete the cache for the specified URIs.
-	 *
-	 * @param array $uris An array of URIs.
-	 *
-	 * @since 3.16.3
-	 */
-	private function delete_cache( $uris ) {
-
-		// Delete the cache for each URI.
-		foreach ( $uris as $uri ) {
-			// Delete the single cache file.
-			$this->cache_service->delete_cache( $uri );
-		}
-
-	}
-
-	/**
-	 * Before post meta change.
-	 *
-	 * When a post meta is going to be changed, we check if the `meta_key` is
-	 * either the `entity_url` or the `same_as` in which case we delete the cache
-	 * for all the associated URIs.
-	 *
-	 * @param int|array $meta_ids The {@link WP_Post} meta id(s).
-	 * @param int       $post_id The {@link WP_Post} id.
-	 * @param string    $meta_key The meta key.
-	 * @param mixed     $meta_value The meta value(s).
-	 *
-	 * @since 3.16.3
-	 */
-	public function on_before_post_meta_change( $meta_ids, $post_id, $meta_key, $meta_value ) {
-
-		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
-			return;
-		}
-
-		$this->log->trace( "Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache..." );
-
-		// The list of existing URIs, plus the list of URIs being deleted/updated.
-		$old_value = get_post_meta( $post_id, $meta_key );
-
-		// We expect an array here from the `get_post_meta` signature. However `get_post_meta` is prone to side effects
-		// because of filters. So if it's not we return an empty array.
-		if ( ! is_array( $old_value ) ) {
-			$old_value = array();
-		}
-		$new_value = isset( $meta_value ) ? (array) $meta_value : array();
-		$uris      = array_merge( $old_value, $new_value );
-
-		// Delete the cache for those URIs.
-		$this->delete_cache( $uris );
-
-	}
-
-	/**
-	 * Hook to meta add for a {@link WP_Post}, will cause the cache to
-	 * invalidate.
-	 *
-	 * @param int    $post_id The {@link WP_Post} id.
-	 * @param string $meta_key The meta key.
-	 * @param mixed  $meta_value The meta value(s).
-	 *
-	 * @since 3.16.3
-	 */
-	public function on_before_post_meta_add( $post_id, $meta_key, $meta_value ) {
-
-		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
-			return;
-		}
-
-		$this->log->trace( "Adding $meta_key for post $post_id ($meta_key), invalidating cache..." );
-
-		// Delete the cache for the URIs being added.
-		$this->delete_cache( (array) $meta_value );
-
-	}
+    /**
+     * The {@link Wordlift_Cache_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Cache_Service $cache_service The {@link Wordlift_Cache_Service} instance.
+     */
+    private $cache_service;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a {@link Wordlift_Cached_Entity_Uri_Service} instance.
+     *
+     * @param \Wordlift_Cache_Service $cache_service
+     *
+     * @since 3.16.3
+     */
+    public function __construct( $cache_service ) {
+        parent::__construct();
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        // Add hooks for meta being added/modified/deleted.
+        $this->cache_service = $cache_service;
+
+        add_action( 'add_post_meta', array( $this, 'on_before_post_meta_add' ), 10, 3 );
+        add_action( 'update_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
+        add_action( 'delete_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
+
+    }
+
+    /**
+     * Preload the URIs.
+     *
+     * @param array $uris Preload an array of URIs.
+     *
+     * @since 3.16.3
+     */
+    public function preload_uris( $uris ) {
+
+        // Filter the URIs which aren't yet cached.
+        $cache_service = $this->cache_service;
+        $uris_to_cache = array_filter(
+            (array) $uris,
+            function ( $item ) use ( $cache_service ) {
+                return ! $cache_service->has_cache( $item );
+            }
+        );
+
+        // Preload the URIs.
+        parent::preload_uris( $uris_to_cache );
+
+        // Store them in cache.
+        if ( is_array( $this->uri_to_post ) && ! empty( $this->uri_to_post ) ) {
+            foreach ( $this->uri_to_post as $uri => $post_id ) {
+                $this->set_cache( $uri, $post_id );
+            }
+        }
+
+    }
+
+    /**
+     * Get the entity post for the specified URI.
+     *
+     * @param string $uri The URI.
+     *
+     * @return null|WP_Post The {@link WP_Post} or null if not found.
+     * @since 3.16.3
+     */
+    public function get_entity( $uri ) {
+
+        $this->log->trace( "Getting entity for uri $uri..." );
+
+        // Get the cached post for the specified URI.
+        $cache = $this->cache_service->get_cache( $uri );
+
+        // Return the cached data if valid.
+        if ( false !== $cache && is_numeric( $cache ) ) {
+            $this->log->debug( "Cached entity $cache for uri $uri found." );
+
+            return get_post( $cache );
+        }
+
+        // Get the actual result.
+        $post = parent::get_entity( $uri );
+
+        // Cache the result.
+        if ( null !== $post ) {
+            $this->set_cache( $uri, $post->ID );
+        }
+
+        // Return the result.
+        return $post;
+    }
+
+    /**
+     * Set the cached URI for the specified {@link WP_Post}.
+     *
+     * @param string $uri The URI.
+     * @param int    $post_id The post ID.
+     *
+     * @since 3.16.3
+     * @since 3.29.0 takes a post ID as input.
+     */
+    private function set_cache( $uri, $post_id ) {
+
+        // Cache the result.
+        $this->cache_service->set_cache( $uri, $post_id );
+
+    }
+
+    /**
+     * Delete the cache for the specified URIs.
+     *
+     * @param array $uris An array of URIs.
+     *
+     * @since 3.16.3
+     */
+    private function delete_cache( $uris ) {
+
+        // Delete the cache for each URI.
+        foreach ( $uris as $uri ) {
+            // Delete the single cache file.
+            $this->cache_service->delete_cache( $uri );
+        }
+
+    }
+
+    /**
+     * Before post meta change.
+     *
+     * When a post meta is going to be changed, we check if the `meta_key` is
+     * either the `entity_url` or the `same_as` in which case we delete the cache
+     * for all the associated URIs.
+     *
+     * @param int|array $meta_ids The {@link WP_Post} meta id(s).
+     * @param int       $post_id The {@link WP_Post} id.
+     * @param string    $meta_key The meta key.
+     * @param mixed     $meta_value The meta value(s).
+     *
+     * @since 3.16.3
+     */
+    public function on_before_post_meta_change( $meta_ids, $post_id, $meta_key, $meta_value ) {
+
+        // Bail out if we're not interested in the meta key.
+        if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+            return;
+        }
+
+        $this->log->trace( "Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache..." );
+
+        // The list of existing URIs, plus the list of URIs being deleted/updated.
+        $old_value = get_post_meta( $post_id, $meta_key );
+
+        // We expect an array here from the `get_post_meta` signature. However `get_post_meta` is prone to side effects
+        // because of filters. So if it's not we return an empty array.
+        if ( ! is_array( $old_value ) ) {
+            $old_value = array();
+        }
+        $new_value = isset( $meta_value ) ? (array) $meta_value : array();
+        $uris      = array_merge( $old_value, $new_value );
+
+        // Delete the cache for those URIs.
+        $this->delete_cache( $uris );
+
+    }
+
+    /**
+     * Hook to meta add for a {@link WP_Post}, will cause the cache to
+     * invalidate.
+     *
+     * @param int    $post_id The {@link WP_Post} id.
+     * @param string $meta_key The meta key.
+     * @param mixed  $meta_value The meta value(s).
+     *
+     * @since 3.16.3
+     */
+    public function on_before_post_meta_add( $post_id, $meta_key, $meta_value ) {
+
+        // Bail out if we're not interested in the meta key.
+        if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+            return;
+        }
+
+        $this->log->trace( "Adding $meta_key for post $post_id ($meta_key), invalidating cache..." );
+
+        // Delete the cache for the URIs being added.
+        $this->delete_cache( (array) $meta_value );
+
+    }
 
 }

Spacing +38 added lines, -38 removed lines

@@ -39,17 +39,17 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function __construct( $cache_service ) {
+	public function __construct($cache_service) {
 		parent::__construct();
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		// Add hooks for meta being added/modified/deleted.
 		$this->cache_service = $cache_service;
 
-		add_action( 'add_post_meta', array( $this, 'on_before_post_meta_add' ), 10, 3 );
-		add_action( 'update_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
-		add_action( 'delete_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
+		add_action('add_post_meta', array($this, 'on_before_post_meta_add'), 10, 3);
+		add_action('update_post_meta', array($this, 'on_before_post_meta_change'), 10, 4);
+		add_action('delete_post_meta', array($this, 'on_before_post_meta_change'), 10, 4);
 
 	}
 
@@ -60,24 +60,24 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function preload_uris( $uris ) {
+	public function preload_uris($uris) {
 
 		// Filter the URIs which aren't yet cached.
 		$cache_service = $this->cache_service;
 		$uris_to_cache = array_filter(
 			(array) $uris,
-			function ( $item ) use ( $cache_service ) {
-				return ! $cache_service->has_cache( $item );
+			function($item) use ($cache_service) {
+				return ! $cache_service->has_cache($item);
 			}
 		);
 
 		// Preload the URIs.
-		parent::preload_uris( $uris_to_cache );
+		parent::preload_uris($uris_to_cache);
 
 		// Store them in cache.
-		if ( is_array( $this->uri_to_post ) && ! empty( $this->uri_to_post ) ) {
-			foreach ( $this->uri_to_post as $uri => $post_id ) {
-				$this->set_cache( $uri, $post_id );
+		if (is_array($this->uri_to_post) && ! empty($this->uri_to_post)) {
+			foreach ($this->uri_to_post as $uri => $post_id) {
+				$this->set_cache($uri, $post_id);
 			}
 		}
 
@@ -91,26 +91,26 @@ 
 	 * @return null|WP_Post The {@link WP_Post} or null if not found.
 	 * @since 3.16.3
 	 */
-	public function get_entity( $uri ) {
+	public function get_entity($uri) {
 
-		$this->log->trace( "Getting entity for uri $uri..." );
+		$this->log->trace("Getting entity for uri $uri...");
 
 		// Get the cached post for the specified URI.
-		$cache = $this->cache_service->get_cache( $uri );
+		$cache = $this->cache_service->get_cache($uri);
 
 		// Return the cached data if valid.
-		if ( false !== $cache && is_numeric( $cache ) ) {
-			$this->log->debug( "Cached entity $cache for uri $uri found." );
+		if (false !== $cache && is_numeric($cache)) {
+			$this->log->debug("Cached entity $cache for uri $uri found.");
 
-			return get_post( $cache );
+			return get_post($cache);
 		}
 
 		// Get the actual result.
-		$post = parent::get_entity( $uri );
+		$post = parent::get_entity($uri);
 
 		// Cache the result.
-		if ( null !== $post ) {
-			$this->set_cache( $uri, $post->ID );
+		if (null !== $post) {
+			$this->set_cache($uri, $post->ID);
 		}
 
 		// Return the result.
@@ -126,10 +126,10 @@ 
 	 * @since 3.16.3
 	 * @since 3.29.0 takes a post ID as input.
 	 */
-	private function set_cache( $uri, $post_id ) {
+	private function set_cache($uri, $post_id) {
 
 		// Cache the result.
-		$this->cache_service->set_cache( $uri, $post_id );
+		$this->cache_service->set_cache($uri, $post_id);
 
 	}
 
@@ -140,12 +140,12 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	private function delete_cache( $uris ) {
+	private function delete_cache($uris) {
 
 		// Delete the cache for each URI.
-		foreach ( $uris as $uri ) {
+		foreach ($uris as $uri) {
 			// Delete the single cache file.
-			$this->cache_service->delete_cache( $uri );
+			$this->cache_service->delete_cache($uri);
 		}
 
 	}
@@ -164,28 +164,28 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function on_before_post_meta_change( $meta_ids, $post_id, $meta_key, $meta_value ) {
+	public function on_before_post_meta_change($meta_ids, $post_id, $meta_key, $meta_value) {
 
 		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+		if (WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key) {
 			return;
 		}
 
-		$this->log->trace( "Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache..." );
+		$this->log->trace("Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache...");
 
 		// The list of existing URIs, plus the list of URIs being deleted/updated.
-		$old_value = get_post_meta( $post_id, $meta_key );
+		$old_value = get_post_meta($post_id, $meta_key);
 
 		// We expect an array here from the `get_post_meta` signature. However `get_post_meta` is prone to side effects
 		// because of filters. So if it's not we return an empty array.
-		if ( ! is_array( $old_value ) ) {
+		if ( ! is_array($old_value)) {
 			$old_value = array();
 		}
-		$new_value = isset( $meta_value ) ? (array) $meta_value : array();
-		$uris      = array_merge( $old_value, $new_value );
+		$new_value = isset($meta_value) ? (array) $meta_value : array();
+		$uris      = array_merge($old_value, $new_value);
 
 		// Delete the cache for those URIs.
-		$this->delete_cache( $uris );
+		$this->delete_cache($uris);
 
 	}
 
@@ -199,17 +199,17 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function on_before_post_meta_add( $post_id, $meta_key, $meta_value ) {
+	public function on_before_post_meta_add($post_id, $meta_key, $meta_value) {
 
 		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+		if (WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key) {
 			return;
 		}
 
-		$this->log->trace( "Adding $meta_key for post $post_id ($meta_key), invalidating cache..." );
+		$this->log->trace("Adding $meta_key for post $post_id ($meta_key), invalidating cache...");
 
 		// Delete the cache for the URIs being added.
-		$this->delete_cache( (array) $meta_value );
+		$this->delete_cache((array) $meta_value);
 
 	}
 

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

Indentation +349 added lines, -349 removed lines

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

Spacing +43 added lines, -43 removed lines

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

src/includes/class-wordlift-http-api.php

Indentation +180 added lines, -180 removed lines

@@ -16,185 +16,185 @@
  */
 class Wordlift_Http_Api {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.15.3
-	 *
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a {@link Wordlift_End_Point} instance.
-	 *
-	 * @since 3.15.3
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		add_action( 'init', array( $this, 'add_rewrite_endpoint' ) );
-		add_action( 'template_redirect', array( $this, 'template_redirect' ) );
-
-		// region SAMPLE ACTIONS.
-		add_action(
-			'admin_post_wl_hello_world',
-			array(
-				$this,
-				'hello_world',
-			)
-		);
-		add_action(
-			'admin_post_nopriv_wl_hello_world',
-			array(
-				$this,
-				'nopriv_hello_world',
-			)
-		);
-		// endregion
-	}
-
-	/**
-	 * Add the `wl-api` rewrite end-point.
-	 *
-	 * @since 3.15.3
-	 */
-	public function add_rewrite_endpoint() {
-
-		add_rewrite_endpoint( 'wl-api', EP_ROOT );
-		$this->ensure_rewrite_rules_are_flushed();
-
-	}
-
-	/**
-	 * Handle `template_redirect` hooks.
-	 *
-	 * @since 3.15.3
-	 */
-	public function template_redirect() {
-
-		global $wp_query;
-
-		if ( ! isset( $wp_query->query_vars['wl-api'] ) ) {
-			$this->log->trace( 'Skipping, not a `wl-api` call.' );
-
-			return;
-		}
-
-		$action = isset( $_REQUEST['action'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$this->do_action( $action );
-
-		exit;
-
-	}
-
-	/**
-	 * Do the requested action.
-	 *
-	 * @param string $action The action to execute.
-	 *
-	 * @since 3.15.3
-	 */
-	private function do_action( $action ) {
-
-		if ( empty( $action ) ) {
-			return;
-		}
-
-		if ( ! wp_validate_auth_cookie( '', 'logged_in' ) ) {
-			/**
-			 * Fires on a non-authenticated admin post request for the given action.
-			 *
-			 * The dynamic portion of the hook name, `$action`, refers to the given
-			 * request action.
-			 *
-			 * @since 2.6.0
-			 */
-			do_action( "admin_post_nopriv_{$action}" );
-		} else {
-			/**
-			 * Fires on an authenticated admin post request for the given action.
-			 *
-			 * The dynamic portion of the hook name, `$action`, refers to the given
-			 * request action.
-			 *
-			 * @since 2.6.0
-			 */
-			do_action( "admin_post_{$action}" );
-		}
-
-	}
-
-	/**
-	 * Test function, anonymous.
-	 *
-	 * @since 3.15.3
-	 */
-	public function nopriv_hello_world() {
-
-		wp_die( 'Hello World! (from anonymous)' );
-
-	}
-
-	/**
-	 * Test function, authenticated.
-	 *
-	 * @since 3.15.3
-	 */
-	public function hello_world() {
-
-		wp_die( 'Hello World! (from authenticated)' );
-
-	}
-
-	/**
-	 * Ensure that the rewrite rules are flushed the first time.
-	 *
-	 * @since 3.16.0 changed the value from 1 to `yes` to avoid type juggling issues.
-	 * @since 3.15.3
-	 */
-	public static function ensure_rewrite_rules_are_flushed() {
-
-		// See https://github.com/insideout10/wordlift-plugin/issues/698.
-		if ( 'yes' !== get_option( 'wl_http_api' ) ) {
-			update_option( 'wl_http_api', 'yes' );
-			add_action(
-				'wp_loaded',
-				function () {
-					flush_rewrite_rules();
-				}
-			);
-		}
-
-	}
-
-	/**
-	 * Called by {@see activate_wordlift}, resets the `wl_http_api` option flag in order to force WordLift to
-	 * reinitialize the `wl-api` route.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
-	 *
-	 * @since 3.19.2
-	 */
-	public static function activate() {
-
-		// Force the plugin to reinitialize the rewrite rules.
-		update_option( 'wl_http_api', 'no' );
-
-	}
-
-	/**
-	 * Delete the option when the plugin is deactivated.
-	 *
-	 * @since 3.19.4
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/846
-	 */
-	public static function deactivate() {
-
-		delete_option( 'wl_http_api' );
-
-	}
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.15.3
+     *
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a {@link Wordlift_End_Point} instance.
+     *
+     * @since 3.15.3
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        add_action( 'init', array( $this, 'add_rewrite_endpoint' ) );
+        add_action( 'template_redirect', array( $this, 'template_redirect' ) );
+
+        // region SAMPLE ACTIONS.
+        add_action(
+            'admin_post_wl_hello_world',
+            array(
+                $this,
+                'hello_world',
+            )
+        );
+        add_action(
+            'admin_post_nopriv_wl_hello_world',
+            array(
+                $this,
+                'nopriv_hello_world',
+            )
+        );
+        // endregion
+    }
+
+    /**
+     * Add the `wl-api` rewrite end-point.
+     *
+     * @since 3.15.3
+     */
+    public function add_rewrite_endpoint() {
+
+        add_rewrite_endpoint( 'wl-api', EP_ROOT );
+        $this->ensure_rewrite_rules_are_flushed();
+
+    }
+
+    /**
+     * Handle `template_redirect` hooks.
+     *
+     * @since 3.15.3
+     */
+    public function template_redirect() {
+
+        global $wp_query;
+
+        if ( ! isset( $wp_query->query_vars['wl-api'] ) ) {
+            $this->log->trace( 'Skipping, not a `wl-api` call.' );
+
+            return;
+        }
+
+        $action = isset( $_REQUEST['action'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $this->do_action( $action );
+
+        exit;
+
+    }
+
+    /**
+     * Do the requested action.
+     *
+     * @param string $action The action to execute.
+     *
+     * @since 3.15.3
+     */
+    private function do_action( $action ) {
+
+        if ( empty( $action ) ) {
+            return;
+        }
+
+        if ( ! wp_validate_auth_cookie( '', 'logged_in' ) ) {
+            /**
+             * Fires on a non-authenticated admin post request for the given action.
+             *
+             * The dynamic portion of the hook name, `$action`, refers to the given
+             * request action.
+             *
+             * @since 2.6.0
+             */
+            do_action( "admin_post_nopriv_{$action}" );
+        } else {
+            /**
+             * Fires on an authenticated admin post request for the given action.
+             *
+             * The dynamic portion of the hook name, `$action`, refers to the given
+             * request action.
+             *
+             * @since 2.6.0
+             */
+            do_action( "admin_post_{$action}" );
+        }
+
+    }
+
+    /**
+     * Test function, anonymous.
+     *
+     * @since 3.15.3
+     */
+    public function nopriv_hello_world() {
+
+        wp_die( 'Hello World! (from anonymous)' );
+
+    }
+
+    /**
+     * Test function, authenticated.
+     *
+     * @since 3.15.3
+     */
+    public function hello_world() {
+
+        wp_die( 'Hello World! (from authenticated)' );
+
+    }
+
+    /**
+     * Ensure that the rewrite rules are flushed the first time.
+     *
+     * @since 3.16.0 changed the value from 1 to `yes` to avoid type juggling issues.
+     * @since 3.15.3
+     */
+    public static function ensure_rewrite_rules_are_flushed() {
+
+        // See https://github.com/insideout10/wordlift-plugin/issues/698.
+        if ( 'yes' !== get_option( 'wl_http_api' ) ) {
+            update_option( 'wl_http_api', 'yes' );
+            add_action(
+                'wp_loaded',
+                function () {
+                    flush_rewrite_rules();
+                }
+            );
+        }
+
+    }
+
+    /**
+     * Called by {@see activate_wordlift}, resets the `wl_http_api` option flag in order to force WordLift to
+     * reinitialize the `wl-api` route.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
+     *
+     * @since 3.19.2
+     */
+    public static function activate() {
+
+        // Force the plugin to reinitialize the rewrite rules.
+        update_option( 'wl_http_api', 'no' );
+
+    }
+
+    /**
+     * Delete the option when the plugin is deactivated.
+     *
+     * @since 3.19.4
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/846
+     */
+    public static function deactivate() {
+
+        delete_option( 'wl_http_api' );
+
+    }
 
 }

Spacing +20 added lines, -20 removed lines

@@ -32,10 +32,10 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
-		add_action( 'init', array( $this, 'add_rewrite_endpoint' ) );
-		add_action( 'template_redirect', array( $this, 'template_redirect' ) );
+		add_action('init', array($this, 'add_rewrite_endpoint'));
+		add_action('template_redirect', array($this, 'template_redirect'));
 
 		// region SAMPLE ACTIONS.
 		add_action(
@@ -62,7 +62,7 @@ 
 	 */
 	public function add_rewrite_endpoint() {
 
-		add_rewrite_endpoint( 'wl-api', EP_ROOT );
+		add_rewrite_endpoint('wl-api', EP_ROOT);
 		$this->ensure_rewrite_rules_are_flushed();
 
 	}
@@ -76,14 +76,14 @@ 
 
 		global $wp_query;
 
-		if ( ! isset( $wp_query->query_vars['wl-api'] ) ) {
-			$this->log->trace( 'Skipping, not a `wl-api` call.' );
+		if ( ! isset($wp_query->query_vars['wl-api'])) {
+			$this->log->trace('Skipping, not a `wl-api` call.');
 
 			return;
 		}
 
-		$action = isset( $_REQUEST['action'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$this->do_action( $action );
+		$action = isset($_REQUEST['action']) ? sanitize_text_field(wp_unslash((string) $_REQUEST['action'])) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$this->do_action($action);
 
 		exit;
 
@@ -96,13 +96,13 @@ 
 	 *
 	 * @since 3.15.3
 	 */
-	private function do_action( $action ) {
+	private function do_action($action) {
 
-		if ( empty( $action ) ) {
+		if (empty($action)) {
 			return;
 		}
 
-		if ( ! wp_validate_auth_cookie( '', 'logged_in' ) ) {
+		if ( ! wp_validate_auth_cookie('', 'logged_in')) {
 			/**
 			 * Fires on a non-authenticated admin post request for the given action.
 			 *
@@ -111,7 +111,7 @@ 
 			 *
 			 * @since 2.6.0
 			 */
-			do_action( "admin_post_nopriv_{$action}" );
+			do_action("admin_post_nopriv_{$action}");
 		} else {
 			/**
 			 * Fires on an authenticated admin post request for the given action.
@@ -121,7 +121,7 @@ 
 			 *
 			 * @since 2.6.0
 			 */
-			do_action( "admin_post_{$action}" );
+			do_action("admin_post_{$action}");
 		}
 
 	}
@@ -133,7 +133,7 @@ 
 	 */
 	public function nopriv_hello_world() {
 
-		wp_die( 'Hello World! (from anonymous)' );
+		wp_die('Hello World! (from anonymous)');
 
 	}
 
@@ -144,7 +144,7 @@ 
 	 */
 	public function hello_world() {
 
-		wp_die( 'Hello World! (from authenticated)' );
+		wp_die('Hello World! (from authenticated)');
 
 	}
 
@@ -157,11 +157,11 @@ 
 	public static function ensure_rewrite_rules_are_flushed() {
 
 		// See https://github.com/insideout10/wordlift-plugin/issues/698.
-		if ( 'yes' !== get_option( 'wl_http_api' ) ) {
-			update_option( 'wl_http_api', 'yes' );
+		if ('yes' !== get_option('wl_http_api')) {
+			update_option('wl_http_api', 'yes');
 			add_action(
 				'wp_loaded',
-				function () {
+				function() {
 					flush_rewrite_rules();
 				}
 			);
@@ -180,7 +180,7 @@ 
 	public static function activate() {
 
 		// Force the plugin to reinitialize the rewrite rules.
-		update_option( 'wl_http_api', 'no' );
+		update_option('wl_http_api', 'no');
 
 	}
 
@@ -193,7 +193,7 @@ 
 	 */
 	public static function deactivate() {
 
-		delete_option( 'wl_http_api' );
+		delete_option('wl_http_api');
 
 	}
 

src/includes/mapping/class-wordlift-mapping-ajax-adapter.php

Indentation +54 added lines, -54 removed lines

@@ -8,80 +8,80 @@
 
 class Wordlift_Mapping_Ajax_Adapter {
 
-	/**
-	 * The {@link Wordlift_Mapping_Service} instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
-	 */
-	private $mapping_service;
+    /**
+     * The {@link Wordlift_Mapping_Service} instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
+     */
+    private $mapping_service;
 
-	/**
-	 * Create a {@link Wordlift_Mapping_Ajax_Adapter} instance.
-	 *
-	 * @param Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
-	 *
-	 * @since 3.20.0
-	 */
-	public function __construct( $mapping_service ) {
+    /**
+     * Create a {@link Wordlift_Mapping_Ajax_Adapter} instance.
+     *
+     * @param Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
+     *
+     * @since 3.20.0
+     */
+    public function __construct( $mapping_service ) {
 
-		$this->mapping_service = $mapping_service;
+        $this->mapping_service = $mapping_service;
 
-		add_action( 'wp_ajax_wl_set_entity_types_for_post_type', array( $this, 'set_entity_types_for_post_type' ) );
-		add_action( 'wp_ajax_wl_update_post_type_entity_types', array( $this, 'update_post_type_entity_types' ) );
+        add_action( 'wp_ajax_wl_set_entity_types_for_post_type', array( $this, 'set_entity_types_for_post_type' ) );
+        add_action( 'wp_ajax_wl_update_post_type_entity_types', array( $this, 'update_post_type_entity_types' ) );
 
-	}
+    }
 
-	public function set_entity_types_for_post_type() {
+    public function set_entity_types_for_post_type() {
 
-		if ( ! isset( $_REQUEST['post_type'] ) || ! isset( $_REQUEST['entity_types'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			return;
-		}
+        if ( ! isset( $_REQUEST['post_type'] ) || ! isset( $_REQUEST['entity_types'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            return;
+        }
 
-		$post_type    = sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$entity_types = array_map( 'sanitize_text_field', wp_unslash( (array) $_REQUEST['entity_types'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $post_type    = sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $entity_types = array_map( 'sanitize_text_field', wp_unslash( (array) $_REQUEST['entity_types'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
-		$this->mapping_service->set_entity_types_for_post_type( $post_type, $entity_types );
+        $this->mapping_service->set_entity_types_for_post_type( $post_type, $entity_types );
 
-		wp_send_json_success();
+        wp_send_json_success();
 
-	}
+    }
 
-	public function update_post_type_entity_types() {
+    public function update_post_type_entity_types() {
 
-		// If the nonce is invalid, return an error.
-		$nonce = isset( $_REQUEST['_nonce'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['_nonce'] ) ) : '';
-		if ( ! wp_verify_nonce( $nonce, 'update_post_type_entity_types' ) ) {
-			wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
-		}
+        // If the nonce is invalid, return an error.
+        $nonce = isset( $_REQUEST['_nonce'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['_nonce'] ) ) : '';
+        if ( ! wp_verify_nonce( $nonce, 'update_post_type_entity_types' ) ) {
+            wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
+        }
 
-		if ( empty( $_REQUEST['post_type'] ) ) {
-			wp_send_json_error( __( '`post_type` is required', 'wordlift' ) );
-		}
+        if ( empty( $_REQUEST['post_type'] ) ) {
+            wp_send_json_error( __( '`post_type` is required', 'wordlift' ) );
+        }
 
-		if ( empty( $_REQUEST['entity_types'] ) ) {
-			wp_send_json_error( __( '`entity_types` is required', 'wordlift' ) );
-		}
+        if ( empty( $_REQUEST['entity_types'] ) ) {
+            wp_send_json_error( __( '`entity_types` is required', 'wordlift' ) );
+        }
 
-		// Get the post type.
-		$post_type = isset( $_REQUEST['post_type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ) : '';
+        // Get the post type.
+        $post_type = isset( $_REQUEST['post_type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ) : '';
 
-		// Get the entity types URIs.
-		$entity_types = isset( $_REQUEST['entity_types'] ) ? filter_var( wp_unslash( $_REQUEST['entity_types'] ), FILTER_REQUIRE_ARRAY ) : array();
+        // Get the entity types URIs.
+        $entity_types = isset( $_REQUEST['entity_types'] ) ? filter_var( wp_unslash( $_REQUEST['entity_types'] ), FILTER_REQUIRE_ARRAY ) : array();
 
-		// Get the offset.
-		$offset = isset( $_REQUEST['offset'] ) ? intval( $_REQUEST['offset'] ) : 0;
+        // Get the offset.
+        $offset = isset( $_REQUEST['offset'] ) ? intval( $_REQUEST['offset'] ) : 0;
 
-		// Update and get the results.
-		$result = $this->mapping_service->update( $post_type, $entity_types, $offset );
+        // Update and get the results.
+        $result = $this->mapping_service->update( $post_type, $entity_types, $offset );
 
-		// Add our nonce to the result.
-		$result['_nonce'] = wp_create_nonce( 'update_post_type_entity_types' );
+        // Add our nonce to the result.
+        $result['_nonce'] = wp_create_nonce( 'update_post_type_entity_types' );
 
-		// Finally send the results.
-		wp_send_json_success( $result );
+        // Finally send the results.
+        wp_send_json_success( $result );
 
-	}
+    }
 
 }

Spacing +20 added lines, -20 removed lines

@@ -24,25 +24,25 @@ 
 	 *
 	 * @since 3.20.0
 	 */
-	public function __construct( $mapping_service ) {
+	public function __construct($mapping_service) {
 
 		$this->mapping_service = $mapping_service;
 
-		add_action( 'wp_ajax_wl_set_entity_types_for_post_type', array( $this, 'set_entity_types_for_post_type' ) );
-		add_action( 'wp_ajax_wl_update_post_type_entity_types', array( $this, 'update_post_type_entity_types' ) );
+		add_action('wp_ajax_wl_set_entity_types_for_post_type', array($this, 'set_entity_types_for_post_type'));
+		add_action('wp_ajax_wl_update_post_type_entity_types', array($this, 'update_post_type_entity_types'));
 
 	}
 
 	public function set_entity_types_for_post_type() {
 
-		if ( ! isset( $_REQUEST['post_type'] ) || ! isset( $_REQUEST['entity_types'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( ! isset($_REQUEST['post_type']) || ! isset($_REQUEST['entity_types'])) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 			return;
 		}
 
-		$post_type    = sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$entity_types = array_map( 'sanitize_text_field', wp_unslash( (array) $_REQUEST['entity_types'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$post_type    = sanitize_text_field(wp_unslash($_REQUEST['post_type'])); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$entity_types = array_map('sanitize_text_field', wp_unslash((array) $_REQUEST['entity_types'])); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
-		$this->mapping_service->set_entity_types_for_post_type( $post_type, $entity_types );
+		$this->mapping_service->set_entity_types_for_post_type($post_type, $entity_types);
 
 		wp_send_json_success();
 
@@ -51,36 +51,36 @@ 
 	public function update_post_type_entity_types() {
 
 		// If the nonce is invalid, return an error.
-		$nonce = isset( $_REQUEST['_nonce'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['_nonce'] ) ) : '';
-		if ( ! wp_verify_nonce( $nonce, 'update_post_type_entity_types' ) ) {
-			wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
+		$nonce = isset($_REQUEST['_nonce']) ? sanitize_text_field(wp_unslash($_REQUEST['_nonce'])) : '';
+		if ( ! wp_verify_nonce($nonce, 'update_post_type_entity_types')) {
+			wp_send_json_error(__('Nonce Security Check Failed!', 'wordlift'));
 		}
 
-		if ( empty( $_REQUEST['post_type'] ) ) {
-			wp_send_json_error( __( '`post_type` is required', 'wordlift' ) );
+		if (empty($_REQUEST['post_type'])) {
+			wp_send_json_error(__('`post_type` is required', 'wordlift'));
 		}
 
-		if ( empty( $_REQUEST['entity_types'] ) ) {
-			wp_send_json_error( __( '`entity_types` is required', 'wordlift' ) );
+		if (empty($_REQUEST['entity_types'])) {
+			wp_send_json_error(__('`entity_types` is required', 'wordlift'));
 		}
 
 		// Get the post type.
-		$post_type = isset( $_REQUEST['post_type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ) : '';
+		$post_type = isset($_REQUEST['post_type']) ? sanitize_text_field(wp_unslash($_REQUEST['post_type'])) : '';
 
 		// Get the entity types URIs.
-		$entity_types = isset( $_REQUEST['entity_types'] ) ? filter_var( wp_unslash( $_REQUEST['entity_types'] ), FILTER_REQUIRE_ARRAY ) : array();
+		$entity_types = isset($_REQUEST['entity_types']) ? filter_var(wp_unslash($_REQUEST['entity_types']), FILTER_REQUIRE_ARRAY) : array();
 
 		// Get the offset.
-		$offset = isset( $_REQUEST['offset'] ) ? intval( $_REQUEST['offset'] ) : 0;
+		$offset = isset($_REQUEST['offset']) ? intval($_REQUEST['offset']) : 0;
 
 		// Update and get the results.
-		$result = $this->mapping_service->update( $post_type, $entity_types, $offset );
+		$result = $this->mapping_service->update($post_type, $entity_types, $offset);
 
 		// Add our nonce to the result.
-		$result['_nonce'] = wp_create_nonce( 'update_post_type_entity_types' );
+		$result['_nonce'] = wp_create_nonce('update_post_type_entity_types');
 
 		// Finally send the results.
-		wp_send_json_success( $result );
+		wp_send_json_success($result);
 
 	}