insideout10 / wordlift-plugin

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

Indentation +376 added lines, -376 removed lines

@@ -19,129 +19,129 @@ 
  */
 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;
-
-	/**
-	 * 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;
-
-	/**
-	 * Wordlift_Entity_Type_Service constructor.
-	 *
-	 * @param \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
-	 *
-	 * @since 3.7.0
-	 *
-	 */
-	public function __construct( $schema_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Service' );
-
-		$this->schema_service = $schema_service;
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * 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() {
-
-		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.
-	 * @type array  linked_data   An array of {@link Wordlift_Sparql_Tuple_Rendition}.
-	 * }
-	 * @since 3.7.0
-	 *
-	 * @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;
+
+    /**
+     * 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;
+
+    /**
+     * Wordlift_Entity_Type_Service constructor.
+     *
+     * @param \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
+     *
+     * @since 3.7.0
+     *
+     */
+    public function __construct( $schema_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Service' );
+
+        $this->schema_service = $schema_service;
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * 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() {
+
+        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.
+     * @type array  linked_data   An array of {@link Wordlift_Sparql_Tuple_Rendition}.
+     * }
+     * @since 3.7.0
+     *
+     * @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.
@@ -151,90 +151,90 @@ 
 			 * @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' ) ) ) {
-			$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 );
-
-		$camel_case_names = array_map( function ( $id ) {
-			return get_term_meta( $id, '_wl_name', true );
-		}, $ids );
-
-		return $camel_case_names;
-	}
-
-	/**
-	 * 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' ) ) ) {
+            $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 );
+
+        $camel_case_names = array_map( function ( $id ) {
+            return get_term_meta( $id, '_wl_name', true );
+        }, $ids );
+
+        return $camel_case_names;
+    }
+
+    /**
+     * 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.
@@ -245,174 +245,174 @@ 
 		 *
 		 * @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 ) {
-
-			// Get the post terms for the specified post ID.
-			$terms = $this->get_post_terms( $post_id );
-
-			$this->log->debug( "Post $post_id has " . count( $terms ) . ' type(s).' );
-
-			// True if there's at least one term bound to the post.
-			return ( 0 < count( $terms ) );
-		}
-
-		$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;
-	}
-
-
-	/**
-	 * 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 );
-	}
+        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 ) {
+
+            // Get the post terms for the specified post ID.
+            $terms = $this->get_post_terms( $post_id );
+
+            $this->log->debug( "Post $post_id has " . count( $terms ) . ' type(s).' );
+
+            // True if there's at least one term bound to the post.
+            return ( 0 < count( $terms ) );
+        }
+
+        $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;
+    }
+
+
+    /**
+     * 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 );
+    }
 
 }

Spacing +65 added lines, -65 removed lines

@@ -54,9 +54,9 @@ 
 	 * @since 3.7.0
 	 *
 	 */
-	public function __construct( $schema_service ) {
+	public function __construct($schema_service) {
 
-		$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 = $schema_service;
 
@@ -108,34 +108,34 @@ 
 	 *          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;
 				}
@@ -151,22 +151,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' ) ) ) {
-			$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'))) {
+			$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');
 
 	}
 
@@ -179,9 +179,9 @@ 
 	 * @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',));
 	}
 
 	/**
@@ -193,13 +193,13 @@ 
 	 * @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);
 
-		$camel_case_names = array_map( function ( $id ) {
-			return get_term_meta( $id, '_wl_name', true );
-		}, $ids );
+		$camel_case_names = array_map(function($id) {
+			return get_term_meta($id, '_wl_name', true);
+		}, $ids);
 
 		return $camel_case_names;
 	}
@@ -214,25 +214,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
@@ -245,22 +245,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);
 
 	}
 
@@ -274,9 +274,9 @@ 
 	 * @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);
 	}
 
 	/**
@@ -289,9 +289,9 @@ 
 	 * @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, array(
+		$terms = get_terms(Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, array(
 			'fields'     => 'all',
 			'get'        => 'all',
 			'number'     => 1,
@@ -305,9 +305,9 @@ 
 			),
 			'orderby'    => 'term_id',
 			'order'      => 'ASC',
-		) );
+		));
 
-		return is_array( $terms ) && ! empty( $terms ) ? $terms[0] : false;
+		return is_array($terms) && ! empty($terms) ? $terms[0] : false;
 	}
 
 	/**
@@ -321,26 +321,26 @@ 
 	 * @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 ) {
+		if (null === $uri) {
 
 			// Get the post terms for the specified post ID.
-			$terms = $this->get_post_terms( $post_id );
+			$terms = $this->get_post_terms($post_id);
 
-			$this->log->debug( "Post $post_id has " . count( $terms ) . ' type(s).' );
+			$this->log->debug("Post $post_id has ".count($terms).' type(s).');
 
 			// True if there's at least one term bound to the post.
-			return ( 0 < count( $terms ) );
+			return (0 < count($terms));
 		}
 
-		$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;
@@ -355,9 +355,9 @@ 
 	 * @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, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, array(
+		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.
@@ -365,7 +365,7 @@ 
 			// 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',
-		) );
+		));
 	}
 
 	/**
@@ -379,16 +379,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;
 			}
 		}
@@ -410,9 +410,9 @@ 
 	 * @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);
 	}
 
 }