insideout10 / wordlift-plugin

src/install/class-wordlift-install-3-44-4.php

Indentation +11 added lines, -11 removed lines

@@ -10,23 +10,23 @@
  */
 class Wordlift_Install_3_44_4 extends Wordlift_Install {
 
-	/**
-	 * {@inheritdoc}
-	 */
-	protected static $version = '3.44.4';
+    /**
+     * {@inheritdoc}
+     */
+    protected static $version = '3.44.4';
 
-	public function install() {
+    public function install() {
 
-		global $wpdb;
+        global $wpdb;
 
-		$wpdb->query(
-			"
+        $wpdb->query(
+            "
 			UPDATE {$wpdb->prefix}wl_entities
 			SET about_jsonld = NULL
 			WHERE about_jsonld = '' OR about_jsonld = 'null'
 		"
-		);
+        );
 
-		Ttl_Cache::flush_all();
-	}
+        Ttl_Cache::flush_all();
+    }
 }

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

Indentation +587 added lines, -587 removed lines

@@ -21,508 +21,508 @@ 
  */
 class Wordlift_Entity_Service {
 
-	/**
-	 * The Log service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log The Log service.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_Relation_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
-	 */
-	private $relation_service;
-
-	/**
-	 * The {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * The entity post type name.
-	 *
-	 * @since 3.1.0
-	 */
-	const TYPE_NAME = 'entity';
-
-	/**
-	 * The alternative label meta key.
-	 *
-	 * @since 3.2.0
-	 */
-	const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';
-
-	/**
-	 * The alternative label input template.
-	 *
-	 * @since 3.2.0
-	 */
-	// TODO: this should be moved to a class that deals with HTML code.
-	const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
+    /**
+     * The Log service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_Log_Service $log The Log service.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_Relation_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
+     */
+    private $relation_service;
+
+    /**
+     * The {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    private $entity_uri_service;
+
+    /**
+     * The entity post type name.
+     *
+     * @since 3.1.0
+     */
+    const TYPE_NAME = 'entity';
+
+    /**
+     * The alternative label meta key.
+     *
+     * @since 3.2.0
+     */
+    const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';
+
+    /**
+     * The alternative label input template.
+     *
+     * @since 3.2.0
+     */
+    // TODO: this should be moved to a class that deals with HTML code.
+    const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
                 <label class="screen-reader-text" id="wl-alternative-label-prompt-text" for="wl-alternative-label">Enter alternative label here</label>
                 <input name="wl_alternative_label[]" size="30" value="%s" id="wl-alternative-label" type="text">
                 <button class="button wl-delete-button">%s</button>
                 </div>';
 
-	/**
-	 * Create a Wordlift_Entity_Service instance.
-	 *
-	 * @throws Exception if the `$content_service` is not of the `Content_Service` type.
-	 * @since 3.2.0
-	 */
-	protected function __construct() {
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
-
-		$this->entity_uri_service = Wordlift_Entity_Uri_Service::get_instance();
-		$this->relation_service   = Wordlift_Relation_Service::get_instance();
-
-	}
-
-	/**
-	 * A singleton instance of the Entity service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var Wordlift_Entity_Service $instance A singleton instance of the Entity service.
-	 */
-	private static $instance = null;
-
-	/**
-	 * Get the singleton instance of the Entity service.
-	 *
-	 * @return Wordlift_Entity_Service The singleton instance of the Entity service.
-	 * @since 3.2.0
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Determines whether a post is an entity or not. Entity is in this context
-	 * something which is not an article.
-	 *
-	 * @param int $post_id A post id.
-	 *
-	 * @return bool Return true if the post is an entity otherwise false.
-	 * @since 3.1.0
-	 */
-	public function is_entity( $post_id ) {
-
-		// Improve performance by giving for granted that a product is an entity.
-		if ( 'product' === get_post_type( $post_id ) ) {
-			return true;
-		}
-
-		$terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-
-		if ( is_wp_error( $terms ) ) {
-			$this->log->error( "Cannot get the terms for post $post_id: " . $terms->get_error_message() );
-
-			return false;
-		}
-
-		if ( empty( $terms ) ) {
-			return false;
-		}
-
-		/*
+    /**
+     * Create a Wordlift_Entity_Service instance.
+     *
+     * @throws Exception if the `$content_service` is not of the `Content_Service` type.
+     * @since 3.2.0
+     */
+    protected function __construct() {
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+
+        $this->entity_uri_service = Wordlift_Entity_Uri_Service::get_instance();
+        $this->relation_service   = Wordlift_Relation_Service::get_instance();
+
+    }
+
+    /**
+     * A singleton instance of the Entity service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var Wordlift_Entity_Service $instance A singleton instance of the Entity service.
+     */
+    private static $instance = null;
+
+    /**
+     * Get the singleton instance of the Entity service.
+     *
+     * @return Wordlift_Entity_Service The singleton instance of the Entity service.
+     * @since 3.2.0
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Determines whether a post is an entity or not. Entity is in this context
+     * something which is not an article.
+     *
+     * @param int $post_id A post id.
+     *
+     * @return bool Return true if the post is an entity otherwise false.
+     * @since 3.1.0
+     */
+    public function is_entity( $post_id ) {
+
+        // Improve performance by giving for granted that a product is an entity.
+        if ( 'product' === get_post_type( $post_id ) ) {
+            return true;
+        }
+
+        $terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+
+        if ( is_wp_error( $terms ) ) {
+            $this->log->error( "Cannot get the terms for post $post_id: " . $terms->get_error_message() );
+
+            return false;
+        }
+
+        if ( empty( $terms ) ) {
+            return false;
+        }
+
+        /*
 		 * We don't consider an `article` to be an entity.
 		 *
 		 * @since 3.20.0 At least one associated mustn't be an `article`.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 */
-		foreach ( $terms as $term ) {
-			if ( 1 !== preg_match( '~(^|-)article$~', $term->slug ) ) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get the proper classification scope for a given entity post
-	 *
-	 * @param integer $post_id An entity post id.
-	 *
-	 * @param string  $default The default classification scope, `what` if not
-	 *                              provided.
-	 *
-	 * @return string Returns a classification scope (e.g. 'what').
-	 * @since 3.5.0
-	 */
-	public function get_classification_scope_for( $post_id, $default = WL_WHAT_RELATION ) {
-
-		if ( false === $this->is_entity( $post_id ) ) {
-			return $default;
-		}
-
-		// Retrieve the entity type
-		$entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
-		$entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
-		// Retrieve classification boxes configuration
-		// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'], true ) ) {
-				return $cb['id'];
-			}
-		}
-
-		return $default;
-	}
-
-	/**
-	 * Check whether a {@link WP_Post} is used.
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 *
-	 * @return bool|null Null if it's not an entity, otherwise true if it's used.
-	 */
-	public function is_used( $post_id ) {
-
-		if ( false === $this->is_entity( $post_id ) ) {
-			return null;
-		}
-		// Retrieve the post
-		$entity = get_post( $post_id );
-
-		global $wpdb;
-
-		// Perform the query
-		$relation_instances = (int) $wpdb->get_var(
-			$wpdb->prepare(
-				"SELECT COUNT(*) FROM {$wpdb->prefix}wl_relation_instances WHERE  object_id = %d",
-				$entity->ID
-			)
-		);
-		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
-			return true;
-		}
-
-		// Perform the query
-		$meta_instances = (int) $wpdb->get_var(
-			$wpdb->prepare(
-				"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
-				$entity->ID,
-				wl_get_entity_uri( $entity->ID )
-			)
-		);
-
-		// If there is at least one meta that refers the current entity uri, then current entity is used
-		if ( 0 < $meta_instances ) {
-			return true;
-		}
-
-		// If we are here, it means the current entity is not used at the moment
-		return false;
-	}
-
-	/**
-	 * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
-	 *
-	 * @param string $uri The entity URI.
-	 *
-	 * @return WP_Post|null A WP_Post instance or null if not found.
-	 * @deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
-	 *
-	 * @since      3.16.3 deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
-	 * @since      3.2.0
-	 */
-	public function get_entity_post_by_uri( $uri ) {
-
-		return $this->entity_uri_service->get_entity( $uri );
-	}
-
-	/**
-	 * Fires once a post has been saved. This function uses the $_REQUEST, therefore
-	 * we check that the post we're saving is the current post.
-	 *
-	 * This function is called by a hook, so we're not the ones that need to check the `nonce`.
-	 *
-	 * @see   https://github.com/insideout10/wordlift-plugin/issues/363
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param int     $post_id Post ID.
-	 * @param WP_Post $post Post object.
-	 */
-	public function save_post( $post_id, $post ) {
-		// Avoid doing anything if post is autosave or a revision.
-		if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
-			return;
-		}
-
-		// We expect a numeric value here.
-		if ( ! isset( $_REQUEST['post_ID'] ) || ! is_numeric( $_REQUEST['post_ID'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			return;
-		}
-
-		// Get the numeric post ID from the request.
-		$request_post_id = intval( $_REQUEST['post_ID'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-
-		// We're setting the alternative label that have been provided via the UI
-		// (in fact we're using $_REQUEST), while save_post may be also called
-		// programmatically by some other function: we need to check therefore if
-		// the $post_id in the save_post call matches the post id set in the request.
-		//
-		// If this is not the current post being saved or if it's not an entity, return.
-		if ( $request_post_id !== $post_id || ! $this->is_entity( $post_id ) ) {
-			return;
-		}
-
-		if ( isset( $_REQUEST['wl_alternative_label'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			$data = filter_var_array( $_REQUEST, array( 'wl_alternative_label' => array( 'flags' => FILTER_REQUIRE_ARRAY ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			// Get the alt labels from the request (or empty array).
-			$alt_labels = isset( $data['wl_alternative_label'] ) ? $data['wl_alternative_label'] : array();
-			// This is via classic editor, so set the alternative labels.
-			$this->set_alternative_labels( $post_id, $alt_labels );
-		}
-
-	}
-
-	/**
-	 * Set the alternative labels.
-	 *
-	 * @param int   $post_id The post id.
-	 * @param array $alt_labels An array of labels.
-	 *
-	 * @since 3.2.0
-	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
-
-		// Bail out if post id is not numeric. We add this check as we found a WP install that was sending a WP_Error
-		// instead of post id.
-		if ( ! is_numeric( $post_id ) ) {
-			return;
-		}
-
-		// Force $alt_labels to be an array
-		if ( ! is_array( $alt_labels ) ) {
-			$alt_labels = array( $alt_labels );
-		}
-
-		$this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . ' ]' );
-
-		// Delete all the existing alternate labels.
-		delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
-
-		// Save only unique synonymns.
-		$alt_labels = array_unique( $alt_labels );
-
-		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-
-			// Strip html code from synonym.
-			$alt_label = wp_strip_all_tags( $alt_label );
-
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, (string) $alt_label );
-			}
-		}
-
-	}
-
-	public function append_alternative_labels( $post_id, $labels_to_append ) {
-
-		$merged_labels = $this->get_alternative_labels( $post_id );
-
-		// Append new synonyms to the end.
-		$merged_labels = array_merge( $merged_labels, $labels_to_append );
-
-		$this->set_alternative_labels( $post_id, $merged_labels );
-
-	}
-
-	/**
-	 * Retrieve the alternate labels.
-	 *
-	 * @param int $post_id Post id.
-	 *
-	 * @return mixed An array  of alternative labels.
-	 * @since 3.2.0
-	 */
-	public function get_alternative_labels( $post_id ) {
-		$alternative_labels = get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
-
-		return $alternative_labels ? (array) $alternative_labels : array();
-	}
-
-	/**
-	 * Retrieve the labels for an entity, i.e. the title + the synonyms.
-	 *
-	 * @param int $id The entity {@link WP_Post} id.
-	 * @param int $object_type The object type {@link Object_Type_Enum}
-	 *
-	 * @return array An array with the entity title and labels.
-	 * @since 3.12.0
-	 */
-	public function get_labels( $id, $object_type = Object_Type_Enum::POST ) {
-		if ( Object_Type_Enum::POST === $object_type ) {
-			return array_merge( (array) get_the_title( $id ), $this->get_alternative_labels( $id ) );
-		}
-
-		if ( Object_Type_Enum::TERM === $object_type ) {
-			$term = get_term( $id );
-			if ( ! is_a( $term, 'WP_Term' ) ) {
-				return array();
-			}
-
-			// @@todo add support for terms' synonyms.
-			return (array) $term->name;
-		}
-
-		return array();
-	}
-
-	/**
-	 * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
-	 *
-	 * @param WP_Post $post Post object.
-	 *
-	 * @since 3.2.0
-	 */
-	public function edit_form_before_permalink( $post ) {
-
-		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
-			return;
-		}
-
-		// If disabled by filter, return.
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__add-synonyms', true ) ) {
-			return;
-		}
-
-		// Print the input template.
-		Wordlift_UI_Service::print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
-
-		// Print all the currently set alternative labels.
-		foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
-
-			echo wp_kses( $this->get_alternative_label_input( $alt_label ), Wordlift_UI_Service::get_template_allowed_html() );
-
-		};
-
-		// Print the button.
-		Wordlift_UI_Service::print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
-
-	}
-
-	public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {
-		$content_service = Wordpress_Content_Service::get_instance();
-		$entity_id       = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
-		$dataset_uri     = Wordlift_Configuration_Service::get_instance()->get_dataset_uri();
-
-		if ( ! isset( $entity_id ) ||
-			 ( ! empty( $dataset_uri ) && 0 !== strpos( $entity_id, $dataset_uri ) ) ) {
-			$rel_uri = Entity_Uri_Generator::create_uri( $type, $object_id );
-			try {
-				$content_service->set_entity_id( new Wordpress_Content_Id( $object_id, $type ), $rel_uri );
-				$entity_id = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
-			} catch ( Exception $e ) {
-				return null;
-			}
-		}
-
-		return $entity_id;
-	}
-
-	/**
-	 * Get the alternative label input HTML code.
-	 *
-	 * @param string $value The input value.
-	 *
-	 * @return string The input HTML code.
-	 * @since 3.2.0
-	 */
-	private function get_alternative_label_input( $value = '' ) {
-
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), esc_html__( 'Delete', 'wordlift' ) );
-	}
-
-	/**
-	 * Get the number of entity posts published in this blog.
-	 *
-	 * @return int The number of published entity posts.
-	 * @since 3.6.0
-	 */
-	public function count() {
-		global $wpdb;
-
-		// Try to get the count from the transient.
-		$count = get_transient( '_wl_entity_service__count' );
-		if ( false !== $count ) {
-			return $count;
-		}
-
-		// Query the count.
-		$count = $wpdb->get_var(
-			$wpdb->prepare(
-				'SELECT COUNT( DISTINCT( tr.object_id ) )'
-				. " FROM {$wpdb->term_relationships} tr"
-				. " INNER JOIN {$wpdb->term_taxonomy} tt"
-				. '  ON tt.taxonomy = %s AND tt.term_taxonomy_id = tr.term_taxonomy_id'
-				. " INNER JOIN {$wpdb->terms} t"
-				. '  ON t.term_id = tt.term_id AND t.name != %s',
-				Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'article'
-			)
-		);
-
-		// Store the count in cache.
-		set_transient( '_wl_entity_service__count', $count, 900 );
-
-		return $count;
-	}
-
-	/**
-	 * Add the entity filtering criterias to the arguments for a `get_posts`
-	 * call.
-	 *
-	 * @param array $args The arguments for a `get_posts` call.
-	 *
-	 * @return array The arguments for a `get_posts` call.
-	 * @since 3.15.0
-	 */
-	public static function add_criterias( $args ) {
-
-		// Build an optimal tax-query.
-		$tax_query = array(
-			'relation' => 'AND',
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'operator' => 'EXISTS',
-			),
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'field'    => 'slug',
-				'terms'    => 'article',
-				'operator' => 'NOT IN',
-			),
-		);
-
-		return $args + array(
-			'post_type' => self::valid_entity_post_types(),
-			/*
+        foreach ( $terms as $term ) {
+            if ( 1 !== preg_match( '~(^|-)article$~', $term->slug ) ) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Get the proper classification scope for a given entity post
+     *
+     * @param integer $post_id An entity post id.
+     *
+     * @param string  $default The default classification scope, `what` if not
+     *                              provided.
+     *
+     * @return string Returns a classification scope (e.g. 'what').
+     * @since 3.5.0
+     */
+    public function get_classification_scope_for( $post_id, $default = WL_WHAT_RELATION ) {
+
+        if ( false === $this->is_entity( $post_id ) ) {
+            return $default;
+        }
+
+        // Retrieve the entity type
+        $entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
+        $entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
+        // Retrieve classification boxes configuration
+        // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
+        $classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
+        foreach ( $classification_boxes as $cb ) {
+            if ( in_array( $entity_type, $cb['registeredTypes'], true ) ) {
+                return $cb['id'];
+            }
+        }
+
+        return $default;
+    }
+
+    /**
+     * Check whether a {@link WP_Post} is used.
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     *
+     * @return bool|null Null if it's not an entity, otherwise true if it's used.
+     */
+    public function is_used( $post_id ) {
+
+        if ( false === $this->is_entity( $post_id ) ) {
+            return null;
+        }
+        // Retrieve the post
+        $entity = get_post( $post_id );
+
+        global $wpdb;
+
+        // Perform the query
+        $relation_instances = (int) $wpdb->get_var(
+            $wpdb->prepare(
+                "SELECT COUNT(*) FROM {$wpdb->prefix}wl_relation_instances WHERE  object_id = %d",
+                $entity->ID
+            )
+        );
+        // If there is at least one relation instance for the current entity, then it's used
+        if ( 0 < $relation_instances ) {
+            return true;
+        }
+
+        // Perform the query
+        $meta_instances = (int) $wpdb->get_var(
+            $wpdb->prepare(
+                "SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
+                $entity->ID,
+                wl_get_entity_uri( $entity->ID )
+            )
+        );
+
+        // If there is at least one meta that refers the current entity uri, then current entity is used
+        if ( 0 < $meta_instances ) {
+            return true;
+        }
+
+        // If we are here, it means the current entity is not used at the moment
+        return false;
+    }
+
+    /**
+     * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
+     *
+     * @param string $uri The entity URI.
+     *
+     * @return WP_Post|null A WP_Post instance or null if not found.
+     * @deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
+     *
+     * @since      3.16.3 deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
+     * @since      3.2.0
+     */
+    public function get_entity_post_by_uri( $uri ) {
+
+        return $this->entity_uri_service->get_entity( $uri );
+    }
+
+    /**
+     * Fires once a post has been saved. This function uses the $_REQUEST, therefore
+     * we check that the post we're saving is the current post.
+     *
+     * This function is called by a hook, so we're not the ones that need to check the `nonce`.
+     *
+     * @see   https://github.com/insideout10/wordlift-plugin/issues/363
+     *
+     * @since 3.2.0
+     *
+     * @param int     $post_id Post ID.
+     * @param WP_Post $post Post object.
+     */
+    public function save_post( $post_id, $post ) {
+        // Avoid doing anything if post is autosave or a revision.
+        if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
+            return;
+        }
+
+        // We expect a numeric value here.
+        if ( ! isset( $_REQUEST['post_ID'] ) || ! is_numeric( $_REQUEST['post_ID'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            return;
+        }
+
+        // Get the numeric post ID from the request.
+        $request_post_id = intval( $_REQUEST['post_ID'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+        // We're setting the alternative label that have been provided via the UI
+        // (in fact we're using $_REQUEST), while save_post may be also called
+        // programmatically by some other function: we need to check therefore if
+        // the $post_id in the save_post call matches the post id set in the request.
+        //
+        // If this is not the current post being saved or if it's not an entity, return.
+        if ( $request_post_id !== $post_id || ! $this->is_entity( $post_id ) ) {
+            return;
+        }
+
+        if ( isset( $_REQUEST['wl_alternative_label'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            $data = filter_var_array( $_REQUEST, array( 'wl_alternative_label' => array( 'flags' => FILTER_REQUIRE_ARRAY ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            // Get the alt labels from the request (or empty array).
+            $alt_labels = isset( $data['wl_alternative_label'] ) ? $data['wl_alternative_label'] : array();
+            // This is via classic editor, so set the alternative labels.
+            $this->set_alternative_labels( $post_id, $alt_labels );
+        }
+
+    }
+
+    /**
+     * Set the alternative labels.
+     *
+     * @param int   $post_id The post id.
+     * @param array $alt_labels An array of labels.
+     *
+     * @since 3.2.0
+     */
+    public function set_alternative_labels( $post_id, $alt_labels ) {
+
+        // Bail out if post id is not numeric. We add this check as we found a WP install that was sending a WP_Error
+        // instead of post id.
+        if ( ! is_numeric( $post_id ) ) {
+            return;
+        }
+
+        // Force $alt_labels to be an array
+        if ( ! is_array( $alt_labels ) ) {
+            $alt_labels = array( $alt_labels );
+        }
+
+        $this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . ' ]' );
+
+        // Delete all the existing alternate labels.
+        delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+
+        // Save only unique synonymns.
+        $alt_labels = array_unique( $alt_labels );
+
+        // Set the alternative labels.
+        foreach ( $alt_labels as $alt_label ) {
+
+            // Strip html code from synonym.
+            $alt_label = wp_strip_all_tags( $alt_label );
+
+            if ( ! empty( $alt_label ) ) {
+                add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, (string) $alt_label );
+            }
+        }
+
+    }
+
+    public function append_alternative_labels( $post_id, $labels_to_append ) {
+
+        $merged_labels = $this->get_alternative_labels( $post_id );
+
+        // Append new synonyms to the end.
+        $merged_labels = array_merge( $merged_labels, $labels_to_append );
+
+        $this->set_alternative_labels( $post_id, $merged_labels );
+
+    }
+
+    /**
+     * Retrieve the alternate labels.
+     *
+     * @param int $post_id Post id.
+     *
+     * @return mixed An array  of alternative labels.
+     * @since 3.2.0
+     */
+    public function get_alternative_labels( $post_id ) {
+        $alternative_labels = get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+
+        return $alternative_labels ? (array) $alternative_labels : array();
+    }
+
+    /**
+     * Retrieve the labels for an entity, i.e. the title + the synonyms.
+     *
+     * @param int $id The entity {@link WP_Post} id.
+     * @param int $object_type The object type {@link Object_Type_Enum}
+     *
+     * @return array An array with the entity title and labels.
+     * @since 3.12.0
+     */
+    public function get_labels( $id, $object_type = Object_Type_Enum::POST ) {
+        if ( Object_Type_Enum::POST === $object_type ) {
+            return array_merge( (array) get_the_title( $id ), $this->get_alternative_labels( $id ) );
+        }
+
+        if ( Object_Type_Enum::TERM === $object_type ) {
+            $term = get_term( $id );
+            if ( ! is_a( $term, 'WP_Term' ) ) {
+                return array();
+            }
+
+            // @@todo add support for terms' synonyms.
+            return (array) $term->name;
+        }
+
+        return array();
+    }
+
+    /**
+     * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
+     *
+     * @param WP_Post $post Post object.
+     *
+     * @since 3.2.0
+     */
+    public function edit_form_before_permalink( $post ) {
+
+        // If it's not an entity, return.
+        if ( ! $this->is_entity( $post->ID ) ) {
+            return;
+        }
+
+        // If disabled by filter, return.
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( ! apply_filters( 'wl_feature__enable__add-synonyms', true ) ) {
+            return;
+        }
+
+        // Print the input template.
+        Wordlift_UI_Service::print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+
+        // Print all the currently set alternative labels.
+        foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
+
+            echo wp_kses( $this->get_alternative_label_input( $alt_label ), Wordlift_UI_Service::get_template_allowed_html() );
+
+        };
+
+        // Print the button.
+        Wordlift_UI_Service::print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+
+    }
+
+    public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {
+        $content_service = Wordpress_Content_Service::get_instance();
+        $entity_id       = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
+        $dataset_uri     = Wordlift_Configuration_Service::get_instance()->get_dataset_uri();
+
+        if ( ! isset( $entity_id ) ||
+             ( ! empty( $dataset_uri ) && 0 !== strpos( $entity_id, $dataset_uri ) ) ) {
+            $rel_uri = Entity_Uri_Generator::create_uri( $type, $object_id );
+            try {
+                $content_service->set_entity_id( new Wordpress_Content_Id( $object_id, $type ), $rel_uri );
+                $entity_id = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
+            } catch ( Exception $e ) {
+                return null;
+            }
+        }
+
+        return $entity_id;
+    }
+
+    /**
+     * Get the alternative label input HTML code.
+     *
+     * @param string $value The input value.
+     *
+     * @return string The input HTML code.
+     * @since 3.2.0
+     */
+    private function get_alternative_label_input( $value = '' ) {
+
+        return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), esc_html__( 'Delete', 'wordlift' ) );
+    }
+
+    /**
+     * Get the number of entity posts published in this blog.
+     *
+     * @return int The number of published entity posts.
+     * @since 3.6.0
+     */
+    public function count() {
+        global $wpdb;
+
+        // Try to get the count from the transient.
+        $count = get_transient( '_wl_entity_service__count' );
+        if ( false !== $count ) {
+            return $count;
+        }
+
+        // Query the count.
+        $count = $wpdb->get_var(
+            $wpdb->prepare(
+                'SELECT COUNT( DISTINCT( tr.object_id ) )'
+                . " FROM {$wpdb->term_relationships} tr"
+                . " INNER JOIN {$wpdb->term_taxonomy} tt"
+                . '  ON tt.taxonomy = %s AND tt.term_taxonomy_id = tr.term_taxonomy_id'
+                . " INNER JOIN {$wpdb->terms} t"
+                . '  ON t.term_id = tt.term_id AND t.name != %s',
+                Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'article'
+            )
+        );
+
+        // Store the count in cache.
+        set_transient( '_wl_entity_service__count', $count, 900 );
+
+        return $count;
+    }
+
+    /**
+     * Add the entity filtering criterias to the arguments for a `get_posts`
+     * call.
+     *
+     * @param array $args The arguments for a `get_posts` call.
+     *
+     * @return array The arguments for a `get_posts` call.
+     * @since 3.15.0
+     */
+    public static function add_criterias( $args ) {
+
+        // Build an optimal tax-query.
+        $tax_query = array(
+            'relation' => 'AND',
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'operator' => 'EXISTS',
+            ),
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'field'    => 'slug',
+                'terms'    => 'article',
+                'operator' => 'NOT IN',
+            ),
+        );
+
+        return $args + array(
+            'post_type' => self::valid_entity_post_types(),
+            /*
 			 * Ensure compatibility with Polylang.
 			 *
 			 * @see https://github.com/insideout10/wordlift-plugin/issues/855.
@@ -530,101 +530,101 @@ 
 			 *
 			 * @since 3.19.5
 			 */
-			'lang'      => '',
-			'tax_query' => $tax_query,
-		);
-	}
-
-	/**
-	 * Create a new entity.
-	 *
-	 * @param string $name The entity name.
-	 * @param string $type_uri The entity's type URI.
-	 * @param null   $logo The entity logo id (or NULL if none).
-	 * @param string $status The post status, by default 'publish'.
-	 *
-	 * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
-	 * @since 3.9.0
-	 */
-	public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
-
-		// Create an entity for the publisher.
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		$post_id = @wp_insert_post(
-			array(
-				'post_type'    => self::TYPE_NAME,
-				'post_title'   => $name,
-				'post_status'  => $status,
-				'post_content' => '',
-			)
-		);
-
-		// Return the error if any.
-		if ( is_wp_error( $post_id ) ) {
-			return $post_id;
-		}
-
-		// Set the entity logo.
-		if ( $logo && is_numeric( $logo ) ) {
-			set_post_thumbnail( $post_id, $logo );
-		}
-
-		// Set the entity type.
-		Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
-
-		return $post_id;
-	}
-
-	/**
-	 * Get the entities related to the one with the specified id. By default only
-	 * published entities will be returned.
-	 *
-	 * @param int    $id The post id.
-	 * @param string $post_status The target post status (default = publish).
-	 *
-	 * @return array An array of post ids.
-	 * @since 3.10.0
-	 */
-	public function get_related_entities( $id, $post_status = 'publish' ) {
-
-		return $this->relation_service->get_objects( $id, 'ids', null, $post_status );
-	}
-
-	/**
-	 * Get the list of entities.
-	 *
-	 * @param array $params Custom parameters for WordPress' own {@link get_posts} function.
-	 *
-	 * @return array An array of entity posts.
-	 * @since 3.12.2
-	 */
-	public function get( $params = array() ) {
-
-		// Set the defaults.
-		$defaults = array( 'post_type' => 'entity' );
-
-		// Merge the defaults with the provided parameters.
-		$args = wp_parse_args( $params, $defaults );
-
-		// Call the `get_posts` function.
-		return get_posts( $args );
-	}
-
-	/**
-	 * The list of post type names which 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.
-	 *
-	 * @return array Array containing the names of the valid post types.
-	 * @since 3.15.0
-	 */
-	public static function valid_entity_post_types() {
-
-		// Ignore builtins in the call to avoid getting attachments.
-		$post_types = array( 'post', 'page', self::TYPE_NAME, 'product' );
-
-		return apply_filters( 'wl_valid_entity_post_types', $post_types );
-	}
+            'lang'      => '',
+            'tax_query' => $tax_query,
+        );
+    }
+
+    /**
+     * Create a new entity.
+     *
+     * @param string $name The entity name.
+     * @param string $type_uri The entity's type URI.
+     * @param null   $logo The entity logo id (or NULL if none).
+     * @param string $status The post status, by default 'publish'.
+     *
+     * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
+     * @since 3.9.0
+     */
+    public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
+
+        // Create an entity for the publisher.
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        $post_id = @wp_insert_post(
+            array(
+                'post_type'    => self::TYPE_NAME,
+                'post_title'   => $name,
+                'post_status'  => $status,
+                'post_content' => '',
+            )
+        );
+
+        // Return the error if any.
+        if ( is_wp_error( $post_id ) ) {
+            return $post_id;
+        }
+
+        // Set the entity logo.
+        if ( $logo && is_numeric( $logo ) ) {
+            set_post_thumbnail( $post_id, $logo );
+        }
+
+        // Set the entity type.
+        Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
+
+        return $post_id;
+    }
+
+    /**
+     * Get the entities related to the one with the specified id. By default only
+     * published entities will be returned.
+     *
+     * @param int    $id The post id.
+     * @param string $post_status The target post status (default = publish).
+     *
+     * @return array An array of post ids.
+     * @since 3.10.0
+     */
+    public function get_related_entities( $id, $post_status = 'publish' ) {
+
+        return $this->relation_service->get_objects( $id, 'ids', null, $post_status );
+    }
+
+    /**
+     * Get the list of entities.
+     *
+     * @param array $params Custom parameters for WordPress' own {@link get_posts} function.
+     *
+     * @return array An array of entity posts.
+     * @since 3.12.2
+     */
+    public function get( $params = array() ) {
+
+        // Set the defaults.
+        $defaults = array( 'post_type' => 'entity' );
+
+        // Merge the defaults with the provided parameters.
+        $args = wp_parse_args( $params, $defaults );
+
+        // Call the `get_posts` function.
+        return get_posts( $args );
+    }
+
+    /**
+     * The list of post type names which 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.
+     *
+     * @return array Array containing the names of the valid post types.
+     * @since 3.15.0
+     */
+    public static function valid_entity_post_types() {
+
+        // Ignore builtins in the call to avoid getting attachments.
+        $post_types = array( 'post', 'page', self::TYPE_NAME, 'product' );
+
+        return apply_filters( 'wl_valid_entity_post_types', $post_types );
+    }
 
 }

Spacing +91 added lines, -91 removed lines

@@ -81,7 +81,7 @@ 
 	 * @since 3.2.0
 	 */
 	protected function __construct() {
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Entity_Service');
 
 		$this->entity_uri_service = Wordlift_Entity_Uri_Service::get_instance();
 		$this->relation_service   = Wordlift_Relation_Service::get_instance();
@@ -105,7 +105,7 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -121,22 +121,22 @@ 
 	 * @return bool Return true if the post is an entity otherwise false.
 	 * @since 3.1.0
 	 */
-	public function is_entity( $post_id ) {
+	public function is_entity($post_id) {
 
 		// Improve performance by giving for granted that a product is an entity.
-		if ( 'product' === get_post_type( $post_id ) ) {
+		if ('product' === get_post_type($post_id)) {
 			return true;
 		}
 
-		$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);
 
-		if ( is_wp_error( $terms ) ) {
-			$this->log->error( "Cannot get the terms for post $post_id: " . $terms->get_error_message() );
+		if (is_wp_error($terms)) {
+			$this->log->error("Cannot get the terms for post $post_id: ".$terms->get_error_message());
 
 			return false;
 		}
 
-		if ( empty( $terms ) ) {
+		if (empty($terms)) {
 			return false;
 		}
 
@@ -147,8 +147,8 @@ 
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 */
-		foreach ( $terms as $term ) {
-			if ( 1 !== preg_match( '~(^|-)article$~', $term->slug ) ) {
+		foreach ($terms as $term) {
+			if (1 !== preg_match('~(^|-)article$~', $term->slug)) {
 				return true;
 			}
 		}
@@ -167,20 +167,20 @@ 
 	 * @return string Returns a classification scope (e.g. 'what').
 	 * @since 3.5.0
 	 */
-	public function get_classification_scope_for( $post_id, $default = WL_WHAT_RELATION ) {
+	public function get_classification_scope_for($post_id, $default = WL_WHAT_RELATION) {
 
-		if ( false === $this->is_entity( $post_id ) ) {
+		if (false === $this->is_entity($post_id)) {
 			return $default;
 		}
 
 		// Retrieve the entity type
-		$entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
-		$entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
+		$entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get($post_id);
+		$entity_type     = str_replace('wl-', '', $entity_type_arr['css_class']);
 		// Retrieve classification boxes configuration
 		// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'], true ) ) {
+		$classification_boxes = unserialize(WL_CORE_POST_CLASSIFICATION_BOXES);
+		foreach ($classification_boxes as $cb) {
+			if (in_array($entity_type, $cb['registeredTypes'], true)) {
 				return $cb['id'];
 			}
 		}
@@ -195,13 +195,13 @@ 
 	 *
 	 * @return bool|null Null if it's not an entity, otherwise true if it's used.
 	 */
-	public function is_used( $post_id ) {
+	public function is_used($post_id) {
 
-		if ( false === $this->is_entity( $post_id ) ) {
+		if (false === $this->is_entity($post_id)) {
 			return null;
 		}
 		// Retrieve the post
-		$entity = get_post( $post_id );
+		$entity = get_post($post_id);
 
 		global $wpdb;
 
@@ -213,7 +213,7 @@ 
 			)
 		);
 		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
+		if (0 < $relation_instances) {
 			return true;
 		}
 
@@ -222,12 +222,12 @@ 
 			$wpdb->prepare(
 				"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
 				$entity->ID,
-				wl_get_entity_uri( $entity->ID )
+				wl_get_entity_uri($entity->ID)
 			)
 		);
 
 		// If there is at least one meta that refers the current entity uri, then current entity is used
-		if ( 0 < $meta_instances ) {
+		if (0 < $meta_instances) {
 			return true;
 		}
 
@@ -246,9 +246,9 @@ 
 	 * @since      3.16.3 deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
 	 * @since      3.2.0
 	 */
-	public function get_entity_post_by_uri( $uri ) {
+	public function get_entity_post_by_uri($uri) {
 
-		return $this->entity_uri_service->get_entity( $uri );
+		return $this->entity_uri_service->get_entity($uri);
 	}
 
 	/**
@@ -264,19 +264,19 @@ 
 	 * @param int     $post_id Post ID.
 	 * @param WP_Post $post Post object.
 	 */
-	public function save_post( $post_id, $post ) {
+	public function save_post($post_id, $post) {
 		// Avoid doing anything if post is autosave or a revision.
-		if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
+		if (wp_is_post_autosave($post) || wp_is_post_revision($post)) {
 			return;
 		}
 
 		// We expect a numeric value here.
-		if ( ! isset( $_REQUEST['post_ID'] ) || ! is_numeric( $_REQUEST['post_ID'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( ! isset($_REQUEST['post_ID']) || ! is_numeric($_REQUEST['post_ID'])) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 			return;
 		}
 
 		// Get the numeric post ID from the request.
-		$request_post_id = intval( $_REQUEST['post_ID'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$request_post_id = intval($_REQUEST['post_ID']); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
 		// We're setting the alternative label that have been provided via the UI
 		// (in fact we're using $_REQUEST), while save_post may be also called
@@ -284,16 +284,16 @@ 
 		// the $post_id in the save_post call matches the post id set in the request.
 		//
 		// If this is not the current post being saved or if it's not an entity, return.
-		if ( $request_post_id !== $post_id || ! $this->is_entity( $post_id ) ) {
+		if ($request_post_id !== $post_id || ! $this->is_entity($post_id)) {
 			return;
 		}
 
-		if ( isset( $_REQUEST['wl_alternative_label'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			$data = filter_var_array( $_REQUEST, array( 'wl_alternative_label' => array( 'flags' => FILTER_REQUIRE_ARRAY ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if (isset($_REQUEST['wl_alternative_label'])) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			$data = filter_var_array($_REQUEST, array('wl_alternative_label' => array('flags' => FILTER_REQUIRE_ARRAY))); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 			// Get the alt labels from the request (or empty array).
-			$alt_labels = isset( $data['wl_alternative_label'] ) ? $data['wl_alternative_label'] : array();
+			$alt_labels = isset($data['wl_alternative_label']) ? $data['wl_alternative_label'] : array();
 			// This is via classic editor, so set the alternative labels.
-			$this->set_alternative_labels( $post_id, $alt_labels );
+			$this->set_alternative_labels($post_id, $alt_labels);
 		}
 
 	}
@@ -306,48 +306,48 @@ 
 	 *
 	 * @since 3.2.0
 	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
+	public function set_alternative_labels($post_id, $alt_labels) {
 
 		// Bail out if post id is not numeric. We add this check as we found a WP install that was sending a WP_Error
 		// instead of post id.
-		if ( ! is_numeric( $post_id ) ) {
+		if ( ! is_numeric($post_id)) {
 			return;
 		}
 
 		// Force $alt_labels to be an array
-		if ( ! is_array( $alt_labels ) ) {
-			$alt_labels = array( $alt_labels );
+		if ( ! is_array($alt_labels)) {
+			$alt_labels = array($alt_labels);
 		}
 
-		$this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . ' ]' );
+		$this->log->debug("Setting alternative labels [ post id :: $post_id ][ alt labels :: ".implode(',', $alt_labels).' ]');
 
 		// Delete all the existing alternate labels.
-		delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+		delete_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY);
 
 		// Save only unique synonymns.
-		$alt_labels = array_unique( $alt_labels );
+		$alt_labels = array_unique($alt_labels);
 
 		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
+		foreach ($alt_labels as $alt_label) {
 
 			// Strip html code from synonym.
-			$alt_label = wp_strip_all_tags( $alt_label );
+			$alt_label = wp_strip_all_tags($alt_label);
 
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, (string) $alt_label );
+			if ( ! empty($alt_label)) {
+				add_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY, (string) $alt_label);
 			}
 		}
 
 	}
 
-	public function append_alternative_labels( $post_id, $labels_to_append ) {
+	public function append_alternative_labels($post_id, $labels_to_append) {
 
-		$merged_labels = $this->get_alternative_labels( $post_id );
+		$merged_labels = $this->get_alternative_labels($post_id);
 
 		// Append new synonyms to the end.
-		$merged_labels = array_merge( $merged_labels, $labels_to_append );
+		$merged_labels = array_merge($merged_labels, $labels_to_append);
 
-		$this->set_alternative_labels( $post_id, $merged_labels );
+		$this->set_alternative_labels($post_id, $merged_labels);
 
 	}
 
@@ -359,8 +359,8 @@ 
 	 * @return mixed An array  of alternative labels.
 	 * @since 3.2.0
 	 */
-	public function get_alternative_labels( $post_id ) {
-		$alternative_labels = get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+	public function get_alternative_labels($post_id) {
+		$alternative_labels = get_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY);
 
 		return $alternative_labels ? (array) $alternative_labels : array();
 	}
@@ -374,14 +374,14 @@ 
 	 * @return array An array with the entity title and labels.
 	 * @since 3.12.0
 	 */
-	public function get_labels( $id, $object_type = Object_Type_Enum::POST ) {
-		if ( Object_Type_Enum::POST === $object_type ) {
-			return array_merge( (array) get_the_title( $id ), $this->get_alternative_labels( $id ) );
+	public function get_labels($id, $object_type = Object_Type_Enum::POST) {
+		if (Object_Type_Enum::POST === $object_type) {
+			return array_merge((array) get_the_title($id), $this->get_alternative_labels($id));
 		}
 
-		if ( Object_Type_Enum::TERM === $object_type ) {
-			$term = get_term( $id );
-			if ( ! is_a( $term, 'WP_Term' ) ) {
+		if (Object_Type_Enum::TERM === $object_type) {
+			$term = get_term($id);
+			if ( ! is_a($term, 'WP_Term')) {
 				return array();
 			}
 
@@ -399,46 +399,46 @@ 
 	 *
 	 * @since 3.2.0
 	 */
-	public function edit_form_before_permalink( $post ) {
+	public function edit_form_before_permalink($post) {
 
 		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
+		if ( ! $this->is_entity($post->ID)) {
 			return;
 		}
 
 		// If disabled by filter, return.
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__add-synonyms', true ) ) {
+		if ( ! apply_filters('wl_feature__enable__add-synonyms', true)) {
 			return;
 		}
 
 		// Print the input template.
-		Wordlift_UI_Service::print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+		Wordlift_UI_Service::print_template('wl-tmpl-alternative-label-input', $this->get_alternative_label_input());
 
 		// Print all the currently set alternative labels.
-		foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
+		foreach ($this->get_alternative_labels($post->ID) as $alt_label) {
 
-			echo wp_kses( $this->get_alternative_label_input( $alt_label ), Wordlift_UI_Service::get_template_allowed_html() );
+			echo wp_kses($this->get_alternative_label_input($alt_label), Wordlift_UI_Service::get_template_allowed_html());
 
 		};
 
 		// Print the button.
-		Wordlift_UI_Service::print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+		Wordlift_UI_Service::print_button('wl-add-alternative-labels-button', __('Add more titles', 'wordlift'));
 
 	}
 
-	public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {
+	public function get_uri($object_id, $type = Object_Type_Enum::POST) {
 		$content_service = Wordpress_Content_Service::get_instance();
-		$entity_id       = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
+		$entity_id       = $content_service->get_entity_id(new Wordpress_Content_Id($object_id, $type));
 		$dataset_uri     = Wordlift_Configuration_Service::get_instance()->get_dataset_uri();
 
-		if ( ! isset( $entity_id ) ||
-			 ( ! empty( $dataset_uri ) && 0 !== strpos( $entity_id, $dataset_uri ) ) ) {
-			$rel_uri = Entity_Uri_Generator::create_uri( $type, $object_id );
+		if ( ! isset($entity_id) ||
+			 ( ! empty($dataset_uri) && 0 !== strpos($entity_id, $dataset_uri))) {
+			$rel_uri = Entity_Uri_Generator::create_uri($type, $object_id);
 			try {
-				$content_service->set_entity_id( new Wordpress_Content_Id( $object_id, $type ), $rel_uri );
-				$entity_id = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
-			} catch ( Exception $e ) {
+				$content_service->set_entity_id(new Wordpress_Content_Id($object_id, $type), $rel_uri);
+				$entity_id = $content_service->get_entity_id(new Wordpress_Content_Id($object_id, $type));
+			} catch (Exception $e) {
 				return null;
 			}
 		}
@@ -454,9 +454,9 @@ 
 	 * @return string The input HTML code.
 	 * @since 3.2.0
 	 */
-	private function get_alternative_label_input( $value = '' ) {
+	private function get_alternative_label_input($value = '') {
 
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), esc_html__( 'Delete', 'wordlift' ) );
+		return sprintf(self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr($value), esc_html__('Delete', 'wordlift'));
 	}
 
 	/**
@@ -469,8 +469,8 @@ 
 		global $wpdb;
 
 		// Try to get the count from the transient.
-		$count = get_transient( '_wl_entity_service__count' );
-		if ( false !== $count ) {
+		$count = get_transient('_wl_entity_service__count');
+		if (false !== $count) {
 			return $count;
 		}
 
@@ -489,7 +489,7 @@ 
 		);
 
 		// Store the count in cache.
-		set_transient( '_wl_entity_service__count', $count, 900 );
+		set_transient('_wl_entity_service__count', $count, 900);
 
 		return $count;
 	}
@@ -503,7 +503,7 @@ 
 	 * @return array The arguments for a `get_posts` call.
 	 * @since 3.15.0
 	 */
-	public static function add_criterias( $args ) {
+	public static function add_criterias($args) {
 
 		// Build an optimal tax-query.
 		$tax_query = array(
@@ -546,7 +546,7 @@ 
 	 * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
 	 * @since 3.9.0
 	 */
-	public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
+	public function create($name, $type_uri, $logo = null, $status = 'publish') {
 
 		// Create an entity for the publisher.
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
@@ -560,17 +560,17 @@ 
 		);
 
 		// Return the error if any.
-		if ( is_wp_error( $post_id ) ) {
+		if (is_wp_error($post_id)) {
 			return $post_id;
 		}
 
 		// Set the entity logo.
-		if ( $logo && is_numeric( $logo ) ) {
-			set_post_thumbnail( $post_id, $logo );
+		if ($logo && is_numeric($logo)) {
+			set_post_thumbnail($post_id, $logo);
 		}
 
 		// Set the entity type.
-		Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
+		Wordlift_Entity_Type_Service::get_instance()->set($post_id, $type_uri);
 
 		return $post_id;
 	}
@@ -585,9 +585,9 @@ 
 	 * @return array An array of post ids.
 	 * @since 3.10.0
 	 */
-	public function get_related_entities( $id, $post_status = 'publish' ) {
+	public function get_related_entities($id, $post_status = 'publish') {
 
-		return $this->relation_service->get_objects( $id, 'ids', null, $post_status );
+		return $this->relation_service->get_objects($id, 'ids', null, $post_status);
 	}
 
 	/**
@@ -598,16 +598,16 @@ 
 	 * @return array An array of entity posts.
 	 * @since 3.12.2
 	 */
-	public function get( $params = array() ) {
+	public function get($params = array()) {
 
 		// Set the defaults.
-		$defaults = array( 'post_type' => 'entity' );
+		$defaults = array('post_type' => 'entity');
 
 		// Merge the defaults with the provided parameters.
-		$args = wp_parse_args( $params, $defaults );
+		$args = wp_parse_args($params, $defaults);
 
 		// Call the `get_posts` function.
-		return get_posts( $args );
+		return get_posts($args);
 	}
 
 	/**
@@ -622,9 +622,9 @@ 
 	public static function valid_entity_post_types() {
 
 		// Ignore builtins in the call to avoid getting attachments.
-		$post_types = array( 'post', 'page', self::TYPE_NAME, 'product' );
+		$post_types = array('post', 'page', self::TYPE_NAME, 'product');
 
-		return apply_filters( 'wl_valid_entity_post_types', $post_types );
+		return apply_filters('wl_valid_entity_post_types', $post_types);
 	}
 
 }

src/wordlift/relation/class-post-content-relation-service.php

Indentation +42 added lines, -42 removed lines

@@ -18,57 +18,57 @@
 
 class Post_Content_Relation_Service extends Abstract_Relation_Service {
 
-	private static $instance = null;
+    private static $instance = null;
 
-	/**
-	 * The singleton instance.
-	 *
-	 * @return Relation_Service_Interface
-	 */
-	public static function get_instance() {
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
+    /**
+     * The singleton instance.
+     *
+     * @return Relation_Service_Interface
+     */
+    public static function get_instance() {
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
 
-		return self::$instance;
-	}
+        return self::$instance;
+    }
 
-	/**
-	 * @param Wordpress_Content_Id $content_id
-	 * @param Relations_Interface  $relations
-	 */
-	public function add_relations( $content_id, $relations ) {
-		if ( $content_id->get_type() !== Object_Type_Enum::POST ) {
-			return;
-		}
+    /**
+     * @param Wordpress_Content_Id $content_id
+     * @param Relations_Interface  $relations
+     */
+    public function add_relations( $content_id, $relations ) {
+        if ( $content_id->get_type() !== Object_Type_Enum::POST ) {
+            return;
+        }
 
-		$post = get_post( $content_id->get_id() );
-		if ( ! is_a( $post, 'WP_Post' ) ) {
-			return;
-		}
+        $post = get_post( $content_id->get_id() );
+        if ( ! is_a( $post, 'WP_Post' ) ) {
+            return;
+        }
 
-		$content_filter_service = \Wordlift_Content_Filter_Service::get_instance();
+        $content_filter_service = \Wordlift_Content_Filter_Service::get_instance();
 
-		$post_content    = wp_unslash( $post->post_content );
-		$entity_uris     = $content_filter_service->get_entity_uris( $post_content );
-		$content_service = Wordpress_Content_Service::get_instance();
-		$entity_service  = Wordlift_Entity_Service::get_instance();
+        $post_content    = wp_unslash( $post->post_content );
+        $entity_uris     = $content_filter_service->get_entity_uris( $post_content );
+        $content_service = Wordpress_Content_Service::get_instance();
+        $entity_service  = Wordlift_Entity_Service::get_instance();
 
-		foreach ( $entity_uris as $entity_uri ) {
-			$content = $content_service->get_by_entity_id( $entity_uri );
-			if ( ! isset( $content )
-				 || ! is_a( $content, 'Wordlift\Content\Content' )
-				 || null === $content->get_id() ) {
-				continue;
-			}
+        foreach ( $entity_uris as $entity_uri ) {
+            $content = $content_service->get_by_entity_id( $entity_uri );
+            if ( ! isset( $content )
+                 || ! is_a( $content, 'Wordlift\Content\Content' )
+                 || null === $content->get_id() ) {
+                continue;
+            }
 
-			$object_id = new Wordpress_Content_Id( $content->get_id(), $content->get_object_type_enum() );
+            $object_id = new Wordpress_Content_Id( $content->get_id(), $content->get_object_type_enum() );
 
-			$predicate = $entity_service->get_classification_scope_for( $content->get_id() );
-			$relation  = new Relation( $content_id, $object_id, $predicate );
-			$relations->add( $relation );
-		}
+            $predicate = $entity_service->get_classification_scope_for( $content->get_id() );
+            $relation  = new Relation( $content_id, $object_id, $predicate );
+            $relations->add( $relation );
+        }
 
-	}
+    }
 
 }

Spacing +16 added lines, -16 removed lines

@@ -26,7 +26,7 @@ 
 	 * @return Relation_Service_Interface
 	 */
 	public static function get_instance() {
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -37,36 +37,36 @@ 
 	 * @param Wordpress_Content_Id $content_id
 	 * @param Relations_Interface  $relations
 	 */
-	public function add_relations( $content_id, $relations ) {
-		if ( $content_id->get_type() !== Object_Type_Enum::POST ) {
+	public function add_relations($content_id, $relations) {
+		if ($content_id->get_type() !== Object_Type_Enum::POST) {
 			return;
 		}
 
-		$post = get_post( $content_id->get_id() );
-		if ( ! is_a( $post, 'WP_Post' ) ) {
+		$post = get_post($content_id->get_id());
+		if ( ! is_a($post, 'WP_Post')) {
 			return;
 		}
 
 		$content_filter_service = \Wordlift_Content_Filter_Service::get_instance();
 
-		$post_content    = wp_unslash( $post->post_content );
-		$entity_uris     = $content_filter_service->get_entity_uris( $post_content );
+		$post_content    = wp_unslash($post->post_content);
+		$entity_uris     = $content_filter_service->get_entity_uris($post_content);
 		$content_service = Wordpress_Content_Service::get_instance();
 		$entity_service  = Wordlift_Entity_Service::get_instance();
 
-		foreach ( $entity_uris as $entity_uri ) {
-			$content = $content_service->get_by_entity_id( $entity_uri );
-			if ( ! isset( $content )
-				 || ! is_a( $content, 'Wordlift\Content\Content' )
-				 || null === $content->get_id() ) {
+		foreach ($entity_uris as $entity_uri) {
+			$content = $content_service->get_by_entity_id($entity_uri);
+			if ( ! isset($content)
+				 || ! is_a($content, 'Wordlift\Content\Content')
+				 || null === $content->get_id()) {
 				continue;
 			}
 
-			$object_id = new Wordpress_Content_Id( $content->get_id(), $content->get_object_type_enum() );
+			$object_id = new Wordpress_Content_Id($content->get_id(), $content->get_object_type_enum());
 
-			$predicate = $entity_service->get_classification_scope_for( $content->get_id() );
-			$relation  = new Relation( $content_id, $object_id, $predicate );
-			$relations->add( $relation );
+			$predicate = $entity_service->get_classification_scope_for($content->get_id());
+			$relation  = new Relation($content_id, $object_id, $predicate);
+			$relations->add($relation);
 		}
 
 	}