insideout10 / wordlift-plugin

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

Indentation +548 added lines, -548 removed lines

@@ -7,467 +7,467 @@ 
  */
 class Wordlift_Entity_Service {
 
-	/**
-	 * The Log service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log The Log service.
-	 */
-	private $log;
-
-	/**
-	 * The UI service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_UI_Service $ui_service The UI service.
-	 */
-	private $ui_service;
-
-	/**
-	 * 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 UI service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_UI_Service $ui_service The UI service.
+     */
+    private $ui_service;
+
+    /**
+     * 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>';
 
-	/**
-	 * 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;
-
-	/**
-	 * Create a Wordlift_Entity_Service instance.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param \Wordlift_UI_Service         $ui_service         The UI service.
-	 * @param \Wordlift_Relation_Service   $relation_service   The {@link Wordlift_Relation_Service} instance.
-	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	public function __construct( $ui_service, $relation_service, $entity_uri_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
-
-		$this->ui_service         = $ui_service;
-		$this->relation_service   = $relation_service;
-		$this->entity_uri_service = $entity_uri_service;
-
-		// Set the singleton instance.
-		self::$instance = $this;
-	}
-
-	/**
-	 * Get the singleton instance of the Entity service.
-	 *
-	 * @since 3.2.0
-	 * @return \Wordlift_Entity_Service The singleton instance of the Entity service.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Determines whether a post is an entity or not. Entity is in this context
-	 * something which is not an article.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param int $post_id A post id.
-	 *
-	 * @return bool Return true if the post is an entity otherwise false.
-	 */
-	public function is_entity( $post_id ) {
-
-		$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.
-		if ( 'article' !== $terms[0]->slug ) {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get the proper classification scope for a given entity post
-	 *
-	 * @since 3.5.0
-	 *
-	 * @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').
-	 */
-	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
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
-				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;
-		// Retrieve Wordlift relation instances table name
-		$table_name = wl_core_get_relation_instances_table_name();
-
-		// Check is it's referenced / related to another post / entity
-		$stmt = $wpdb->prepare(
-			"SELECT COUNT(*) FROM $table_name WHERE  object_id = %d",
-			$entity->ID
-		);
-
-		// Perform the query
-		$relation_instances = (int) $wpdb->get_var( $stmt );
-		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
-			return true;
-		}
-
-		// Check if the entity uri is used as meta_value
-		$stmt = $wpdb->prepare(
-			"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
-			$entity->ID,
-			wl_get_entity_uri( $entity->ID )
-		);
-		// Perform the query
-		$meta_instances = (int) $wpdb->get_var( $stmt );
-
-		// 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.
-	 *
-	 * @since      3.16.3 deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
-	 * @since      3.2.0
-	 *
-	 * @deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
-	 *
-	 * @param string $uri The entity URI.
-	 *
-	 * @return WP_Post|null A WP_Post instance or null if not found.
-	 */
-	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.
-	 *
-	 * @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.
-	 * @param bool    $update  Whether this is an existing post being updated or not.
-	 */
-	public function save_post( $post_id, $post, $update ) {
-
-		// Avoid doing anything if post is autosave or a revision.
-		if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
-			return;
-		}
-
-		// 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 ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
-			return;
-		}
-
-		// Get the alt labels from the request (or empty array).
-		$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
-
-		// Set the alternative labels.
-		$this->set_alternative_labels( $post_id, $alt_labels );
-
-	}
-
-	/**
-	 * Set the alternative labels.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param int   $post_id    The post id.
-	 * @param array $alt_labels An array of labels.
-	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
-
-		// 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 );
-
-		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
-			}
-		}
-
-	}
-
-	/**
-	 * Retrieve the alternate labels.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param int $post_id Post id.
-	 *
-	 * @return mixed An array  of alternative labels.
-	 */
-	public function get_alternative_labels( $post_id ) {
-
-		return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
-	}
-
-	/**
-	 * Retrieve the labels for an entity, i.e. the title + the synonyms.
-	 *
-	 * @since 3.12.0
-	 *
-	 * @param int $post_id The entity {@link WP_Post} id.
-	 *
-	 * @return array An array with the entity title and labels.
-	 */
-	public function get_labels( $post_id ) {
-
-		return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
-	}
-
-	/**
-	 * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param WP_Post $post Post object.
-	 */
-	public function edit_form_before_permalink( $post ) {
-
-		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
-			return;
-		}
-
-		// Print the input template.
-		$this->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 $this->get_alternative_label_input( $alt_label );
-
-		};
-
-		// Print the button.
-		$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
-
-	}
-
-	/**
-	 * Get the URI for the entity with the specified post id.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param int $post_id The entity post id.
-	 *
-	 * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
-	 */
-	public function get_uri( $post_id ) {
-
-		// If a null is given, nothing to do
-		if ( null == $post_id ) {
-			return null;
-		}
-
-		$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
-
-		// If the dataset uri is not properly configured, null is returned
-		if ( '' === wl_configuration_get_redlink_dataset_uri() ) {
-			return null;
-		}
-
-		// Set the URI if it isn't set yet.
-		$post_status = get_post_status( $post_id );
-		if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
-			$uri = wl_build_entity_uri( $post_id );
-			wl_set_entity_uri( $post_id, $uri );
-		}
-
-		return $uri;
-	}
-
-
-	/**
-	 * Get the alternative label input HTML code.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param string $value The input value.
-	 *
-	 * @return string The input HTML code.
-	 */
-	private function get_alternative_label_input( $value = '' ) {
-
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
-	}
-
-	/**
-	 * Get the number of entity posts published in this blog.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @return int The number of published entity posts.
-	 */
-	public function count() {
-
-		$posts = get_posts( $this->add_criterias( array(
-			'post_status' => 'any',
-			'numberposts' => - 1,
-		) ) );
-
-		return count( $posts );
-	}
-
-	/**
-	 * Add the entity filtering criterias to the arguments for a `get_posts`
-	 * call.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param array $args The arguments for a `get_posts` call.
-	 *
-	 * @return array The arguments for a `get_posts` call.
-	 */
-	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' => Wordlift_Entity_Service::valid_entity_post_types(),
-				// Since 3.17.0: should this be faster?
-				'tax_query' => $tax_query,
-				//				'tax_query' => array(
-				//					array(
-				//						'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				//						'terms'    => self::get_entity_terms(),
-				//					),
-				//				),
-			);
-	}
+    /**
+     * 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;
+
+    /**
+     * Create a Wordlift_Entity_Service instance.
+     *
+     * @since 3.2.0
+     *
+     * @param \Wordlift_UI_Service         $ui_service         The UI service.
+     * @param \Wordlift_Relation_Service   $relation_service   The {@link Wordlift_Relation_Service} instance.
+     * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    public function __construct( $ui_service, $relation_service, $entity_uri_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+
+        $this->ui_service         = $ui_service;
+        $this->relation_service   = $relation_service;
+        $this->entity_uri_service = $entity_uri_service;
+
+        // Set the singleton instance.
+        self::$instance = $this;
+    }
+
+    /**
+     * Get the singleton instance of the Entity service.
+     *
+     * @since 3.2.0
+     * @return \Wordlift_Entity_Service The singleton instance of the Entity service.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Determines whether a post is an entity or not. Entity is in this context
+     * something which is not an article.
+     *
+     * @since 3.1.0
+     *
+     * @param int $post_id A post id.
+     *
+     * @return bool Return true if the post is an entity otherwise false.
+     */
+    public function is_entity( $post_id ) {
+
+        $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.
+        if ( 'article' !== $terms[0]->slug ) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Get the proper classification scope for a given entity post
+     *
+     * @since 3.5.0
+     *
+     * @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').
+     */
+    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
+        $classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
+        foreach ( $classification_boxes as $cb ) {
+            if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
+                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;
+        // Retrieve Wordlift relation instances table name
+        $table_name = wl_core_get_relation_instances_table_name();
+
+        // Check is it's referenced / related to another post / entity
+        $stmt = $wpdb->prepare(
+            "SELECT COUNT(*) FROM $table_name WHERE  object_id = %d",
+            $entity->ID
+        );
+
+        // Perform the query
+        $relation_instances = (int) $wpdb->get_var( $stmt );
+        // If there is at least one relation instance for the current entity, then it's used
+        if ( 0 < $relation_instances ) {
+            return true;
+        }
+
+        // Check if the entity uri is used as meta_value
+        $stmt = $wpdb->prepare(
+            "SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
+            $entity->ID,
+            wl_get_entity_uri( $entity->ID )
+        );
+        // Perform the query
+        $meta_instances = (int) $wpdb->get_var( $stmt );
+
+        // 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.
+     *
+     * @since      3.16.3 deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
+     * @since      3.2.0
+     *
+     * @deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
+     *
+     * @param string $uri The entity URI.
+     *
+     * @return WP_Post|null A WP_Post instance or null if not found.
+     */
+    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.
+     *
+     * @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.
+     * @param bool    $update  Whether this is an existing post being updated or not.
+     */
+    public function save_post( $post_id, $post, $update ) {
+
+        // Avoid doing anything if post is autosave or a revision.
+        if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
+            return;
+        }
+
+        // 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 ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
+            return;
+        }
+
+        // Get the alt labels from the request (or empty array).
+        $alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
+
+        // Set the alternative labels.
+        $this->set_alternative_labels( $post_id, $alt_labels );
+
+    }
+
+    /**
+     * Set the alternative labels.
+     *
+     * @since 3.2.0
+     *
+     * @param int   $post_id    The post id.
+     * @param array $alt_labels An array of labels.
+     */
+    public function set_alternative_labels( $post_id, $alt_labels ) {
+
+        // 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 );
+
+        // Set the alternative labels.
+        foreach ( $alt_labels as $alt_label ) {
+            if ( ! empty( $alt_label ) ) {
+                add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
+            }
+        }
+
+    }
+
+    /**
+     * Retrieve the alternate labels.
+     *
+     * @since 3.2.0
+     *
+     * @param int $post_id Post id.
+     *
+     * @return mixed An array  of alternative labels.
+     */
+    public function get_alternative_labels( $post_id ) {
+
+        return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+    }
+
+    /**
+     * Retrieve the labels for an entity, i.e. the title + the synonyms.
+     *
+     * @since 3.12.0
+     *
+     * @param int $post_id The entity {@link WP_Post} id.
+     *
+     * @return array An array with the entity title and labels.
+     */
+    public function get_labels( $post_id ) {
+
+        return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
+    }
+
+    /**
+     * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
+     *
+     * @since 3.2.0
+     *
+     * @param WP_Post $post Post object.
+     */
+    public function edit_form_before_permalink( $post ) {
+
+        // If it's not an entity, return.
+        if ( ! $this->is_entity( $post->ID ) ) {
+            return;
+        }
+
+        // Print the input template.
+        $this->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 $this->get_alternative_label_input( $alt_label );
+
+        };
+
+        // Print the button.
+        $this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+
+    }
+
+    /**
+     * Get the URI for the entity with the specified post id.
+     *
+     * @since 3.6.0
+     *
+     * @param int $post_id The entity post id.
+     *
+     * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
+     */
+    public function get_uri( $post_id ) {
+
+        // If a null is given, nothing to do
+        if ( null == $post_id ) {
+            return null;
+        }
+
+        $uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
+
+        // If the dataset uri is not properly configured, null is returned
+        if ( '' === wl_configuration_get_redlink_dataset_uri() ) {
+            return null;
+        }
+
+        // Set the URI if it isn't set yet.
+        $post_status = get_post_status( $post_id );
+        if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
+            $uri = wl_build_entity_uri( $post_id );
+            wl_set_entity_uri( $post_id, $uri );
+        }
+
+        return $uri;
+    }
+
+
+    /**
+     * Get the alternative label input HTML code.
+     *
+     * @since 3.2.0
+     *
+     * @param string $value The input value.
+     *
+     * @return string The input HTML code.
+     */
+    private function get_alternative_label_input( $value = '' ) {
+
+        return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
+    }
+
+    /**
+     * Get the number of entity posts published in this blog.
+     *
+     * @since 3.6.0
+     *
+     * @return int The number of published entity posts.
+     */
+    public function count() {
+
+        $posts = get_posts( $this->add_criterias( array(
+            'post_status' => 'any',
+            'numberposts' => - 1,
+        ) ) );
+
+        return count( $posts );
+    }
+
+    /**
+     * Add the entity filtering criterias to the arguments for a `get_posts`
+     * call.
+     *
+     * @since 3.15.0
+     *
+     * @param array $args The arguments for a `get_posts` call.
+     *
+     * @return array The arguments for a `get_posts` call.
+     */
+    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' => Wordlift_Entity_Service::valid_entity_post_types(),
+                // Since 3.17.0: should this be faster?
+                'tax_query' => $tax_query,
+                //				'tax_query' => array(
+                //					array(
+                //						'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                //						'terms'    => self::get_entity_terms(),
+                //					),
+                //				),
+            );
+    }
 
 //	/**
 //	 * Get the entity terms IDs which represent an entity.
@@ -497,97 +497,97 @@ 
 //		} ) );
 //	}
 
-	/**
-	 * Create a new entity.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @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.
-	 */
-	public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
-
-		// Create an entity for the publisher.
-		$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.
-	 *
-	 * @since 3.10.0
-	 *
-	 * @param int    $id          The post id.
-	 * @param string $post_status The target post status (default = publish).
-	 *
-	 * @return array An array of post ids.
-	 */
-	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.
-	 *
-	 * @since 3.12.2
-	 *
-	 * @param array $params Custom parameters for WordPress' own {@link get_posts} function.
-	 *
-	 * @return array An array of entity posts.
-	 */
-	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.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @return array Array containing the names of the valid post types.
-	 */
-	static function valid_entity_post_types() {
-
-		// Ignore builtins in the call to avoid getting attachments.
-		$post_types = array( 'post', 'page', self::TYPE_NAME );
-
-		return apply_filters( 'wl_valid_entity_post_types', $post_types );
-	}
+    /**
+     * Create a new entity.
+     *
+     * @since 3.9.0
+     *
+     * @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.
+     */
+    public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
+
+        // Create an entity for the publisher.
+        $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.
+     *
+     * @since 3.10.0
+     *
+     * @param int    $id          The post id.
+     * @param string $post_status The target post status (default = publish).
+     *
+     * @return array An array of post ids.
+     */
+    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.
+     *
+     * @since 3.12.2
+     *
+     * @param array $params Custom parameters for WordPress' own {@link get_posts} function.
+     *
+     * @return array An array of entity posts.
+     */
+    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.
+     *
+     * @since 3.15.0
+     *
+     * @return array Array containing the names of the valid post types.
+     */
+    static function valid_entity_post_types() {
+
+        // Ignore builtins in the call to avoid getting attachments.
+        $post_types = array( 'post', 'page', self::TYPE_NAME );
+
+        return apply_filters( 'wl_valid_entity_post_types', $post_types );
+    }
 
 }

Spacing +78 added lines, -78 removed lines

@@ -87,9 +87,9 @@ 
 	 * @param \Wordlift_Relation_Service   $relation_service   The {@link Wordlift_Relation_Service} instance.
 	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
 	 */
-	public function __construct( $ui_service, $relation_service, $entity_uri_service ) {
+	public function __construct($ui_service, $relation_service, $entity_uri_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Entity_Service');
 
 		$this->ui_service         = $ui_service;
 		$this->relation_service   = $relation_service;
@@ -120,22 +120,22 @@ 
 	 *
 	 * @return bool Return true if the post is an entity otherwise false.
 	 */
-	public function is_entity( $post_id ) {
+	public function is_entity($post_id) {
 
-		$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;
 		}
 
 		// We don't consider an `article` to be an entity.
-		if ( 'article' !== $terms[0]->slug ) {
+		if ('article' !== $terms[0]->slug) {
 			return true;
 		}
 
@@ -154,19 +154,19 @@ 
 	 *
 	 * @return string Returns a classification scope (e.g. 'what').
 	 */
-	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
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
+		$classification_boxes = unserialize(WL_CORE_POST_CLASSIFICATION_BOXES);
+		foreach ($classification_boxes as $cb) {
+			if (in_array($entity_type, $cb['registeredTypes'])) {
 				return $cb['id'];
 			}
 		}
@@ -181,13 +181,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;
 		// Retrieve Wordlift relation instances table name
@@ -200,9 +200,9 @@ 
 		);
 
 		// Perform the query
-		$relation_instances = (int) $wpdb->get_var( $stmt );
+		$relation_instances = (int) $wpdb->get_var($stmt);
 		// 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;
 		}
 
@@ -210,13 +210,13 @@ 
 		$stmt = $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)
 		);
 		// Perform the query
-		$meta_instances = (int) $wpdb->get_var( $stmt );
+		$meta_instances = (int) $wpdb->get_var($stmt);
 
 		// 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;
 		}
 
@@ -236,9 +236,9 @@ 
 	 *
 	 * @return WP_Post|null A WP_Post instance or null if not found.
 	 */
-	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);
 	}
 
 	/**
@@ -253,10 +253,10 @@ 
 	 * @param WP_Post $post    Post object.
 	 * @param bool    $update  Whether this is an existing post being updated or not.
 	 */
-	public function save_post( $post_id, $post, $update ) {
+	public function save_post($post_id, $post, $update) {
 
 		// 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;
 		}
 
@@ -266,15 +266,15 @@ 
 		// 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 ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
+		if ( ! isset($_REQUEST['post_ID']) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity($post_id)) {
 			return;
 		}
 
 		// Get the alt labels from the request (or empty array).
-		$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
+		$alt_labels = isset($_REQUEST['wl_alternative_label']) ? $_REQUEST['wl_alternative_label'] : array();
 
 		// Set the alternative labels.
-		$this->set_alternative_labels( $post_id, $alt_labels );
+		$this->set_alternative_labels($post_id, $alt_labels);
 
 	}
 
@@ -286,22 +286,22 @@ 
 	 * @param int   $post_id    The post id.
 	 * @param array $alt_labels An array of labels.
 	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
+	public function set_alternative_labels($post_id, $alt_labels) {
 
 		// 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);
 
 		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
+		foreach ($alt_labels as $alt_label) {
+			if ( ! empty($alt_label)) {
+				add_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label);
 			}
 		}
 
@@ -316,9 +316,9 @@ 
 	 *
 	 * @return mixed An array  of alternative labels.
 	 */
-	public function get_alternative_labels( $post_id ) {
+	public function get_alternative_labels($post_id) {
 
-		return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+		return get_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY);
 	}
 
 	/**
@@ -330,9 +330,9 @@ 
 	 *
 	 * @return array An array with the entity title and labels.
 	 */
-	public function get_labels( $post_id ) {
+	public function get_labels($post_id) {
 
-		return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
+		return array_merge((array) get_the_title($post_id), $this->get_alternative_labels($post_id));
 	}
 
 	/**
@@ -342,25 +342,25 @@ 
 	 *
 	 * @param WP_Post $post Post object.
 	 */
-	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;
 		}
 
 		// Print the input template.
-		$this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+		$this->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 $this->get_alternative_label_input( $alt_label );
+			echo $this->get_alternative_label_input($alt_label);
 
 		};
 
 		// Print the button.
-		$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+		$this->ui_service->print_button('wl-add-alternative-labels-button', __('Add more titles', 'wordlift'));
 
 	}
 
@@ -373,25 +373,25 @@ 
 	 *
 	 * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
 	 */
-	public function get_uri( $post_id ) {
+	public function get_uri($post_id) {
 
 		// If a null is given, nothing to do
-		if ( null == $post_id ) {
+		if (null == $post_id) {
 			return null;
 		}
 
-		$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
+		$uri = get_post_meta($post_id, WL_ENTITY_URL_META_NAME, true);
 
 		// If the dataset uri is not properly configured, null is returned
-		if ( '' === wl_configuration_get_redlink_dataset_uri() ) {
+		if ('' === wl_configuration_get_redlink_dataset_uri()) {
 			return null;
 		}
 
 		// Set the URI if it isn't set yet.
-		$post_status = get_post_status( $post_id );
-		if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
-			$uri = wl_build_entity_uri( $post_id );
-			wl_set_entity_uri( $post_id, $uri );
+		$post_status = get_post_status($post_id);
+		if (empty($uri) && 'auto-draft' !== $post_status && 'revision' !== $post_status) {
+			$uri = wl_build_entity_uri($post_id);
+			wl_set_entity_uri($post_id, $uri);
 		}
 
 		return $uri;
@@ -407,9 +407,9 @@ 
 	 *
 	 * @return string The input HTML code.
 	 */
-	private function get_alternative_label_input( $value = '' ) {
+	private function get_alternative_label_input($value = '') {
 
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
+		return sprintf(self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr($value), __('Delete', 'wordlift'));
 	}
 
 	/**
@@ -421,12 +421,12 @@ 
 	 */
 	public function count() {
 
-		$posts = get_posts( $this->add_criterias( array(
+		$posts = get_posts($this->add_criterias(array(
 			'post_status' => 'any',
-			'numberposts' => - 1,
-		) ) );
+			'numberposts' => -1,
+		)));
 
-		return count( $posts );
+		return count($posts);
 	}
 
 	/**
@@ -439,7 +439,7 @@ 
 	 *
 	 * @return array The arguments for a `get_posts` call.
 	 */
-	public static function add_criterias( $args ) {
+	public static function add_criterias($args) {
 
 		// Build an optimal tax-query.
 		$tax_query = array(
@@ -509,28 +509,28 @@ 
 	 *
 	 * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
 	 */
-	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.
-		$post_id = wp_insert_post( array(
+		$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 ) ) {
+		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;
 	}
@@ -546,9 +546,9 @@ 
 	 *
 	 * @return array An array of post ids.
 	 */
-	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);
 	}
 
 	/**
@@ -560,16 +560,16 @@ 
 	 *
 	 * @return array An array of entity posts.
 	 */
-	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);
 	}
 
 	/**
@@ -585,9 +585,9 @@ 
 	static function valid_entity_post_types() {
 
 		// Ignore builtins in the call to avoid getting attachments.
-		$post_types = array( 'post', 'page', self::TYPE_NAME );
+		$post_types = array('post', 'page', self::TYPE_NAME);
 
-		return apply_filters( 'wl_valid_entity_post_types', $post_types );
+		return apply_filters('wl_valid_entity_post_types', $post_types);
 	}
 
 }

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

Indentation +204 added lines, -204 removed lines

@@ -13,209 +13,209 @@
  */
 class Wordlift_Schema_Url_Property_Service extends Wordlift_Property_Service {
 
-	/**
-	 * The meta key used to store data for this property. We don't use wl_url to
-	 * avoid potential confusion about other URLs.
-	 *
-	 * @since 3.6.0
-	 */
-	const META_KEY = 'wl_schema_url';
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_rdf_predicate() {
-
-		return 'http://schema.org/url';
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_rdf_data_type() {
-
-		return 'xsd:anyURI';
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_data_type() {
-
-		return Wordlift_Schema_Service::DATA_TYPE_URI;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_cardinality() {
-
-		return INF;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_metabox_class() {
-
-		return 'WL_Metabox_Field';
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_metabox_label() {
-
-		return __( 'Web Site(s)', 'wordlift' );
-	}
-
-	/**
-	 * @var
-	 */
-	private $sparql_service;
-
-	/**
-	 * Create a Wordlift_Schema_Url_Property_Service instance.
-	 * @since 3.6.0
-	 *
-	 * @param Wordlift_Sparql_Service $sparql_service
-	 */
-	public function __construct( $sparql_service ) {
-		parent::__construct();
-
-		// Finally listen for metadata requests for this field.
-		$this->add_filter_get_post_metadata();
-
-		$this->sparql_service = $sparql_service;
-	}
-
-	/**
-	 * Get the schema:url value for the specified post/entity.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|NULL The schema:url value or NULL if not set.
-	 */
-	public function get( $post_id ) {
-
-		// Get the schema:url values set in WP.
-		$values = get_post_meta( $post_id, self::META_KEY, false );
-
-		// If the property has never been set, we set its default value the first
-		// time to <permalink>.
-		if ( empty( $values ) ) {
-			return array( '<permalink>' );
-		}
-
-		// If there's only one value and that value is empty, we return NULL, i.e.
-		// variable not set.
-		if ( 1 === count( $values ) && empty( $values[0] ) ) {
-			return null;
-		}
-
-		// Finally return whatever values the editor set.
-		return $values;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function sanitize( $value ) {
-
-		// TODO: check that it's an URL or that is <permalink>
-
-		return $value;
-	}
-
-	/**
-	 * Generate an insert query that inserts the schema:url values for the specified
-	 * post.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param string $s       The subject URI.
-	 * @param int    $post_id The post id.
-	 *
-	 * @return string The insert query or an empty string.
-	 */
-	public function get_insert_query( $s, $post_id ) {
-
-		// If we have no value, return an empty string (no query).
-		if ( null === ( $values = $this->get( $post_id ) ) ) {
-			return '';
-		}
-
-		// Create the insert query.
-		$q = Wordlift_Query_Builder::new_instance()->insert();
-
-		// Add each schema:url, replacing <permalink> with the actual post permalink.
-		foreach ( $values as $value ) {
-			$q = $q->statement( $s, $this->get_rdf_predicate(), '<permalink>' === $value ? get_permalink( $post_id ) : $value, Wordlift_Query_Builder::OBJECT_URI );
-		}
-
-		// Build and return the query.
-		return $q->build();
-	}
-
-	/**
-	 * Get direct calls to read this meta and alter the response according to our
-	 * own strategy, i.e. if a value has never been set for this meta, then return
-	 * <permalink>.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param mixed  $value     The original value.
-	 * @param int    $object_id The post id.
-	 * @param string $meta_key  The meta key. We expect wl_schema_url or we return straight the value.
-	 * @param bool   $single    Whether to return a single value.
-	 *
-	 * @return array|mixed|NULL|string
-	 */
-	public function get_post_metadata( $value, $object_id, $meta_key, $single ) {
-
-		// It's not us, return the value.
-		if ( self::META_KEY !== $meta_key ) {
-			return $value;
-		}
-
-		$this->remove_filter_get_post_metadata();
-
-		$new_value = $this->get( $object_id );
-
-		$this->add_filter_get_post_metadata();
-
-		// If we must return a single value, but we don't have a value, then return an empty string.
-		if ( $single && ( is_null( $new_value ) || empty( $new_value ) ) ) {
-			return '';
-		}
-
-		// If we have a value and we need to return it as single, return the first value.
-		if ( $single ) {
-			return $new_value[0];
-		}
-
-		// Otherwise return the array.
-		return $new_value;
-	}
-
-	private function add_filter_get_post_metadata() {
-
-		add_filter( 'get_post_metadata', array(
-			$this,
-			'get_post_metadata',
-		), 10, 4 );
-
-	}
-
-	private function remove_filter_get_post_metadata() {
-
-		remove_filter( 'get_post_metadata', array(
-			$this,
-			'get_post_metadata',
-		), 10 );
-
-	}
+    /**
+     * The meta key used to store data for this property. We don't use wl_url to
+     * avoid potential confusion about other URLs.
+     *
+     * @since 3.6.0
+     */
+    const META_KEY = 'wl_schema_url';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_rdf_predicate() {
+
+        return 'http://schema.org/url';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_rdf_data_type() {
+
+        return 'xsd:anyURI';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_data_type() {
+
+        return Wordlift_Schema_Service::DATA_TYPE_URI;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_cardinality() {
+
+        return INF;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_metabox_class() {
+
+        return 'WL_Metabox_Field';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_metabox_label() {
+
+        return __( 'Web Site(s)', 'wordlift' );
+    }
+
+    /**
+     * @var
+     */
+    private $sparql_service;
+
+    /**
+     * Create a Wordlift_Schema_Url_Property_Service instance.
+     * @since 3.6.0
+     *
+     * @param Wordlift_Sparql_Service $sparql_service
+     */
+    public function __construct( $sparql_service ) {
+        parent::__construct();
+
+        // Finally listen for metadata requests for this field.
+        $this->add_filter_get_post_metadata();
+
+        $this->sparql_service = $sparql_service;
+    }
+
+    /**
+     * Get the schema:url value for the specified post/entity.
+     *
+     * @since 3.6.0
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|NULL The schema:url value or NULL if not set.
+     */
+    public function get( $post_id ) {
+
+        // Get the schema:url values set in WP.
+        $values = get_post_meta( $post_id, self::META_KEY, false );
+
+        // If the property has never been set, we set its default value the first
+        // time to <permalink>.
+        if ( empty( $values ) ) {
+            return array( '<permalink>' );
+        }
+
+        // If there's only one value and that value is empty, we return NULL, i.e.
+        // variable not set.
+        if ( 1 === count( $values ) && empty( $values[0] ) ) {
+            return null;
+        }
+
+        // Finally return whatever values the editor set.
+        return $values;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function sanitize( $value ) {
+
+        // TODO: check that it's an URL or that is <permalink>
+
+        return $value;
+    }
+
+    /**
+     * Generate an insert query that inserts the schema:url values for the specified
+     * post.
+     *
+     * @since 3.6.0
+     *
+     * @param string $s       The subject URI.
+     * @param int    $post_id The post id.
+     *
+     * @return string The insert query or an empty string.
+     */
+    public function get_insert_query( $s, $post_id ) {
+
+        // If we have no value, return an empty string (no query).
+        if ( null === ( $values = $this->get( $post_id ) ) ) {
+            return '';
+        }
+
+        // Create the insert query.
+        $q = Wordlift_Query_Builder::new_instance()->insert();
+
+        // Add each schema:url, replacing <permalink> with the actual post permalink.
+        foreach ( $values as $value ) {
+            $q = $q->statement( $s, $this->get_rdf_predicate(), '<permalink>' === $value ? get_permalink( $post_id ) : $value, Wordlift_Query_Builder::OBJECT_URI );
+        }
+
+        // Build and return the query.
+        return $q->build();
+    }
+
+    /**
+     * Get direct calls to read this meta and alter the response according to our
+     * own strategy, i.e. if a value has never been set for this meta, then return
+     * <permalink>.
+     *
+     * @since 3.6.0
+     *
+     * @param mixed  $value     The original value.
+     * @param int    $object_id The post id.
+     * @param string $meta_key  The meta key. We expect wl_schema_url or we return straight the value.
+     * @param bool   $single    Whether to return a single value.
+     *
+     * @return array|mixed|NULL|string
+     */
+    public function get_post_metadata( $value, $object_id, $meta_key, $single ) {
+
+        // It's not us, return the value.
+        if ( self::META_KEY !== $meta_key ) {
+            return $value;
+        }
+
+        $this->remove_filter_get_post_metadata();
+
+        $new_value = $this->get( $object_id );
+
+        $this->add_filter_get_post_metadata();
+
+        // If we must return a single value, but we don't have a value, then return an empty string.
+        if ( $single && ( is_null( $new_value ) || empty( $new_value ) ) ) {
+            return '';
+        }
+
+        // If we have a value and we need to return it as single, return the first value.
+        if ( $single ) {
+            return $new_value[0];
+        }
+
+        // Otherwise return the array.
+        return $new_value;
+    }
+
+    private function add_filter_get_post_metadata() {
+
+        add_filter( 'get_post_metadata', array(
+            $this,
+            'get_post_metadata',
+        ), 10, 4 );
+
+    }
+
+    private function remove_filter_get_post_metadata() {
+
+        remove_filter( 'get_post_metadata', array(
+            $this,
+            'get_post_metadata',
+        ), 10 );
+
+    }
 
 }

Spacing +21 added lines, -21 removed lines

@@ -66,7 +66,7 @@ 
 	 */
 	public function get_metabox_label() {
 
-		return __( 'Web Site(s)', 'wordlift' );
+		return __('Web Site(s)', 'wordlift');
 	}
 
 	/**
@@ -80,7 +80,7 @@ 
 	 *
 	 * @param Wordlift_Sparql_Service $sparql_service
 	 */
-	public function __construct( $sparql_service ) {
+	public function __construct($sparql_service) {
 		parent::__construct();
 
 		// Finally listen for metadata requests for this field.
@@ -98,20 +98,20 @@ 
 	 *
 	 * @return array|NULL The schema:url value or NULL if not set.
 	 */
-	public function get( $post_id ) {
+	public function get($post_id) {
 
 		// Get the schema:url values set in WP.
-		$values = get_post_meta( $post_id, self::META_KEY, false );
+		$values = get_post_meta($post_id, self::META_KEY, false);
 
 		// If the property has never been set, we set its default value the first
 		// time to <permalink>.
-		if ( empty( $values ) ) {
-			return array( '<permalink>' );
+		if (empty($values)) {
+			return array('<permalink>');
 		}
 
 		// If there's only one value and that value is empty, we return NULL, i.e.
 		// variable not set.
-		if ( 1 === count( $values ) && empty( $values[0] ) ) {
+		if (1 === count($values) && empty($values[0])) {
 			return null;
 		}
 
@@ -122,7 +122,7 @@ 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function sanitize( $value ) {
+	public function sanitize($value) {
 
 		// TODO: check that it's an URL or that is <permalink>
 
@@ -140,10 +140,10 @@ 
 	 *
 	 * @return string The insert query or an empty string.
 	 */
-	public function get_insert_query( $s, $post_id ) {
+	public function get_insert_query($s, $post_id) {
 
 		// If we have no value, return an empty string (no query).
-		if ( null === ( $values = $this->get( $post_id ) ) ) {
+		if (null === ($values = $this->get($post_id))) {
 			return '';
 		}
 
@@ -151,8 +151,8 @@ 
 		$q = Wordlift_Query_Builder::new_instance()->insert();
 
 		// Add each schema:url, replacing <permalink> with the actual post permalink.
-		foreach ( $values as $value ) {
-			$q = $q->statement( $s, $this->get_rdf_predicate(), '<permalink>' === $value ? get_permalink( $post_id ) : $value, Wordlift_Query_Builder::OBJECT_URI );
+		foreach ($values as $value) {
+			$q = $q->statement($s, $this->get_rdf_predicate(), '<permalink>' === $value ? get_permalink($post_id) : $value, Wordlift_Query_Builder::OBJECT_URI);
 		}
 
 		// Build and return the query.
@@ -173,26 +173,26 @@ 
 	 *
 	 * @return array|mixed|NULL|string
 	 */
-	public function get_post_metadata( $value, $object_id, $meta_key, $single ) {
+	public function get_post_metadata($value, $object_id, $meta_key, $single) {
 
 		// It's not us, return the value.
-		if ( self::META_KEY !== $meta_key ) {
+		if (self::META_KEY !== $meta_key) {
 			return $value;
 		}
 
 		$this->remove_filter_get_post_metadata();
 
-		$new_value = $this->get( $object_id );
+		$new_value = $this->get($object_id);
 
 		$this->add_filter_get_post_metadata();
 
 		// If we must return a single value, but we don't have a value, then return an empty string.
-		if ( $single && ( is_null( $new_value ) || empty( $new_value ) ) ) {
+		if ($single && (is_null($new_value) || empty($new_value))) {
 			return '';
 		}
 
 		// If we have a value and we need to return it as single, return the first value.
-		if ( $single ) {
+		if ($single) {
 			return $new_value[0];
 		}
 
@@ -202,19 +202,19 @@ 
 
 	private function add_filter_get_post_metadata() {
 
-		add_filter( 'get_post_metadata', array(
+		add_filter('get_post_metadata', array(
 			$this,
 			'get_post_metadata',
-		), 10, 4 );
+		), 10, 4);
 
 	}
 
 	private function remove_filter_get_post_metadata() {
 
-		remove_filter( 'get_post_metadata', array(
+		remove_filter('get_post_metadata', array(
 			$this,
 			'get_post_metadata',
-		), 10 );
+		), 10);
 
 	}
 

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

Indentation +204 added lines, -204 removed lines

@@ -17,209 +17,209 @@
  */
 class Wordlift_Entity_Uri_Service {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * An array of URIs to post ID valid for the current request.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var array $uri_to_post An array of URIs to post ID valid for the current request.
-	 */
-	protected $uri_to_post;
-
-	/**
-	 * Create a {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since 3.16.3
-	 *
-	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	public function __construct( $configuration_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->configuration_service = $configuration_service;
-
-	}
-
-	/**
-	 * Preload the provided URIs in the local cache.
-	 *
-	 * This function will populate the local `$uri_to_post` array by running a
-	 * single query with all the URIs and returning the mappings in the array.
-	 *
-	 * @since 3.16.3
-	 *
-	 * @param array $uris An array of URIs.
-	 */
-	public function preload_uris( $uris ) {
-
-		// Bail out if there are no URIs.
-		if ( 0 === count( $uris ) ) {
-			return;
-		}
-
-		$this->log->trace( 'Preloading ' . count( $uris ) . ' URI(s)...' );
-
-		$that          = $this;
-		$external_uris = array_filter( $uris, function ( $item ) use ( $that ) {
-			return ! $that->is_internal( $item );
-		} );
-
-		$query_args = array(
-			// See https://github.com/insideout10/wordlift-plugin/issues/654.
-			'ignore_sticky_posts' => 1,
-			'cache_results'       => false,
-			'numberposts'         => - 1,
-			'post_status'         => 'any',
-			'post_type'           => Wordlift_Entity_Service::valid_entity_post_types(),
-			'meta_query'          => array(
-				array(
-					'key'     => WL_ENTITY_URL_META_NAME,
-					'value'   => $uris,
-					'compare' => 'IN',
-				),
-			),
-		);
-
-		// Only if the current uri is not an internal uri, entity search is
-		// performed also looking at sameAs values.
-		//
-		// This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
-		if ( 0 < count( $external_uris ) ) {
-
-			$query_args['meta_query']['relation'] = 'OR';
-			$query_args['meta_query'][]           = array(
-				'key'     => Wordlift_Schema_Service::FIELD_SAME_AS,
-				'value'   => $external_uris,
-				'compare' => 'IN',
-			);
-
-		}
-
-		// Get the posts.
-		$posts = get_posts( $query_args );
-
-		// Populate the array. We reinitialize the array on purpose because
-		// we don't want these data to long live.
-		$this->uri_to_post = array_reduce( $posts, function ( $carry, $item ) use ( $that ) {
-			$uris = get_post_meta( $item->ID, WL_ENTITY_URL_META_NAME )
-					+ get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_SAME_AS );
-
-			return $carry
-				   // Get the URI related to the post and fill them with the item id.
-				   + array_fill_keys( $uris, $item );
-		}, array() );
-
-		// Add the not found URIs.
-		$this->uri_to_post += array_fill_keys( $uris, null );
-
-		$this->log->debug( count( $this->uri_to_post ) . " URI(s) preloaded." );
-
-	}
-
-	/**
-	 * Reset the URI to post local cache.
-	 *
-	 * @since 3.16.3
-	 */
-	public function reset_uris() {
-
-		$this->uri_to_post = array();
-
-	}
-
-	/**
-	 * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param string $uri The entity URI.
-	 *
-	 * @return WP_Post|null A WP_Post instance or null if not found.
-	 */
-	public function get_entity( $uri ) {
-
-		$this->log->trace( "Getting an entity post for URI $uri..." );
-
-		// Check if we've been provided with a value otherwise return null.
-		if ( empty( $uri ) ) {
-			return null;
-		}
-
-		$this->log->debug( "Querying post for $uri..." );
-
-		$query_args = array(
-			// See https://github.com/insideout10/wordlift-plugin/issues/654.
-			'ignore_sticky_posts' => 1,
-			'posts_per_page'      => 1,
-			'post_status'         => 'any',
-			'post_type'           => Wordlift_Entity_Service::valid_entity_post_types(),
-			'meta_query'          => array(
-				array(
-					'key'     => WL_ENTITY_URL_META_NAME,
-					'value'   => $uri,
-					'compare' => '=',
-				),
-			),
-		);
-
-		// Only if the current uri is not an internal uri, entity search is
-		// performed also looking at sameAs values.
-		//
-		// This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
-		if ( ! $this->is_internal( $uri ) ) {
-
-			$query_args['meta_query']['relation'] = 'OR';
-			$query_args['meta_query'][]           = array(
-				'key'     => Wordlift_Schema_Service::FIELD_SAME_AS,
-				'value'   => $uri,
-				'compare' => '=',
-			);
-		}
-
-		$posts = get_posts( $query_args );
-
-		// Return null if no post is found.
-		if ( empty( $posts ) ) {
-			$this->log->warn( "No post for URI $uri." );
-
-			return null;
-		}
-
-		// Return the found post.
-		return current( $posts );
-	}
-
-	/**
-	 * Determines whether a given uri is an internal uri or not.
-	 *
-	 * @since 3.16.3
-	 *
-	 * @param int $uri An uri.
-	 *
-	 * @return true if the uri internal to the current dataset otherwise false.
-	 */
-	public function is_internal( $uri ) {
-
-		return ( 0 === strrpos( $uri, $this->configuration_service->get_dataset_uri() ) );
-	}
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * An array of URIs to post ID valid for the current request.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var array $uri_to_post An array of URIs to post ID valid for the current request.
+     */
+    protected $uri_to_post;
+
+    /**
+     * Create a {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since 3.16.3
+     *
+     * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    public function __construct( $configuration_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->configuration_service = $configuration_service;
+
+    }
+
+    /**
+     * Preload the provided URIs in the local cache.
+     *
+     * This function will populate the local `$uri_to_post` array by running a
+     * single query with all the URIs and returning the mappings in the array.
+     *
+     * @since 3.16.3
+     *
+     * @param array $uris An array of URIs.
+     */
+    public function preload_uris( $uris ) {
+
+        // Bail out if there are no URIs.
+        if ( 0 === count( $uris ) ) {
+            return;
+        }
+
+        $this->log->trace( 'Preloading ' . count( $uris ) . ' URI(s)...' );
+
+        $that          = $this;
+        $external_uris = array_filter( $uris, function ( $item ) use ( $that ) {
+            return ! $that->is_internal( $item );
+        } );
+
+        $query_args = array(
+            // See https://github.com/insideout10/wordlift-plugin/issues/654.
+            'ignore_sticky_posts' => 1,
+            'cache_results'       => false,
+            'numberposts'         => - 1,
+            'post_status'         => 'any',
+            'post_type'           => Wordlift_Entity_Service::valid_entity_post_types(),
+            'meta_query'          => array(
+                array(
+                    'key'     => WL_ENTITY_URL_META_NAME,
+                    'value'   => $uris,
+                    'compare' => 'IN',
+                ),
+            ),
+        );
+
+        // Only if the current uri is not an internal uri, entity search is
+        // performed also looking at sameAs values.
+        //
+        // This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
+        if ( 0 < count( $external_uris ) ) {
+
+            $query_args['meta_query']['relation'] = 'OR';
+            $query_args['meta_query'][]           = array(
+                'key'     => Wordlift_Schema_Service::FIELD_SAME_AS,
+                'value'   => $external_uris,
+                'compare' => 'IN',
+            );
+
+        }
+
+        // Get the posts.
+        $posts = get_posts( $query_args );
+
+        // Populate the array. We reinitialize the array on purpose because
+        // we don't want these data to long live.
+        $this->uri_to_post = array_reduce( $posts, function ( $carry, $item ) use ( $that ) {
+            $uris = get_post_meta( $item->ID, WL_ENTITY_URL_META_NAME )
+                    + get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_SAME_AS );
+
+            return $carry
+                    // Get the URI related to the post and fill them with the item id.
+                   + array_fill_keys( $uris, $item );
+        }, array() );
+
+        // Add the not found URIs.
+        $this->uri_to_post += array_fill_keys( $uris, null );
+
+        $this->log->debug( count( $this->uri_to_post ) . " URI(s) preloaded." );
+
+    }
+
+    /**
+     * Reset the URI to post local cache.
+     *
+     * @since 3.16.3
+     */
+    public function reset_uris() {
+
+        $this->uri_to_post = array();
+
+    }
+
+    /**
+     * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
+     *
+     * @since 3.2.0
+     *
+     * @param string $uri The entity URI.
+     *
+     * @return WP_Post|null A WP_Post instance or null if not found.
+     */
+    public function get_entity( $uri ) {
+
+        $this->log->trace( "Getting an entity post for URI $uri..." );
+
+        // Check if we've been provided with a value otherwise return null.
+        if ( empty( $uri ) ) {
+            return null;
+        }
+
+        $this->log->debug( "Querying post for $uri..." );
+
+        $query_args = array(
+            // See https://github.com/insideout10/wordlift-plugin/issues/654.
+            'ignore_sticky_posts' => 1,
+            'posts_per_page'      => 1,
+            'post_status'         => 'any',
+            'post_type'           => Wordlift_Entity_Service::valid_entity_post_types(),
+            'meta_query'          => array(
+                array(
+                    'key'     => WL_ENTITY_URL_META_NAME,
+                    'value'   => $uri,
+                    'compare' => '=',
+                ),
+            ),
+        );
+
+        // Only if the current uri is not an internal uri, entity search is
+        // performed also looking at sameAs values.
+        //
+        // This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
+        if ( ! $this->is_internal( $uri ) ) {
+
+            $query_args['meta_query']['relation'] = 'OR';
+            $query_args['meta_query'][]           = array(
+                'key'     => Wordlift_Schema_Service::FIELD_SAME_AS,
+                'value'   => $uri,
+                'compare' => '=',
+            );
+        }
+
+        $posts = get_posts( $query_args );
+
+        // Return null if no post is found.
+        if ( empty( $posts ) ) {
+            $this->log->warn( "No post for URI $uri." );
+
+            return null;
+        }
+
+        // Return the found post.
+        return current( $posts );
+    }
+
+    /**
+     * Determines whether a given uri is an internal uri or not.
+     *
+     * @since 3.16.3
+     *
+     * @param int $uri An uri.
+     *
+     * @return true if the uri internal to the current dataset otherwise false.
+     */
+    public function is_internal( $uri ) {
+
+        return ( 0 === strrpos( $uri, $this->configuration_service->get_dataset_uri() ) );
+    }
 
 }
\ No newline at end of file

Spacing +28 added lines, -28 removed lines

@@ -51,9 +51,9 @@ 
 	 *
 	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
 	 */
-	public function __construct( $configuration_service ) {
+	public function __construct($configuration_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->configuration_service = $configuration_service;
 
@@ -69,25 +69,25 @@ 
 	 *
 	 * @param array $uris An array of URIs.
 	 */
-	public function preload_uris( $uris ) {
+	public function preload_uris($uris) {
 
 		// Bail out if there are no URIs.
-		if ( 0 === count( $uris ) ) {
+		if (0 === count($uris)) {
 			return;
 		}
 
-		$this->log->trace( 'Preloading ' . count( $uris ) . ' URI(s)...' );
+		$this->log->trace('Preloading '.count($uris).' URI(s)...');
 
 		$that          = $this;
-		$external_uris = array_filter( $uris, function ( $item ) use ( $that ) {
-			return ! $that->is_internal( $item );
+		$external_uris = array_filter($uris, function($item) use ($that) {
+			return ! $that->is_internal($item);
 		} );
 
 		$query_args = array(
 			// See https://github.com/insideout10/wordlift-plugin/issues/654.
 			'ignore_sticky_posts' => 1,
 			'cache_results'       => false,
-			'numberposts'         => - 1,
+			'numberposts'         => -1,
 			'post_status'         => 'any',
 			'post_type'           => Wordlift_Entity_Service::valid_entity_post_types(),
 			'meta_query'          => array(
@@ -103,7 +103,7 @@ 
 		// performed also looking at sameAs values.
 		//
 		// This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
-		if ( 0 < count( $external_uris ) ) {
+		if (0 < count($external_uris)) {
 
 			$query_args['meta_query']['relation'] = 'OR';
 			$query_args['meta_query'][]           = array(
@@ -115,23 +115,23 @@ 
 		}
 
 		// Get the posts.
-		$posts = get_posts( $query_args );
+		$posts = get_posts($query_args);
 
 		// Populate the array. We reinitialize the array on purpose because
 		// we don't want these data to long live.
-		$this->uri_to_post = array_reduce( $posts, function ( $carry, $item ) use ( $that ) {
-			$uris = get_post_meta( $item->ID, WL_ENTITY_URL_META_NAME )
-					+ get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_SAME_AS );
+		$this->uri_to_post = array_reduce($posts, function($carry, $item) use ($that) {
+			$uris = get_post_meta($item->ID, WL_ENTITY_URL_META_NAME)
+					+ get_post_meta($item->ID, Wordlift_Schema_Service::FIELD_SAME_AS);
 
 			return $carry
 				   // Get the URI related to the post and fill them with the item id.
-				   + array_fill_keys( $uris, $item );
-		}, array() );
+				   + array_fill_keys($uris, $item);
+		}, array());
 
 		// Add the not found URIs.
-		$this->uri_to_post += array_fill_keys( $uris, null );
+		$this->uri_to_post += array_fill_keys($uris, null);
 
-		$this->log->debug( count( $this->uri_to_post ) . " URI(s) preloaded." );
+		$this->log->debug(count($this->uri_to_post)." URI(s) preloaded.");
 
 	}
 
@@ -155,16 +155,16 @@ 
 	 *
 	 * @return WP_Post|null A WP_Post instance or null if not found.
 	 */
-	public function get_entity( $uri ) {
+	public function get_entity($uri) {
 
-		$this->log->trace( "Getting an entity post for URI $uri..." );
+		$this->log->trace("Getting an entity post for URI $uri...");
 
 		// Check if we've been provided with a value otherwise return null.
-		if ( empty( $uri ) ) {
+		if (empty($uri)) {
 			return null;
 		}
 
-		$this->log->debug( "Querying post for $uri..." );
+		$this->log->debug("Querying post for $uri...");
 
 		$query_args = array(
 			// See https://github.com/insideout10/wordlift-plugin/issues/654.
@@ -185,7 +185,7 @@ 
 		// performed also looking at sameAs values.
 		//
 		// This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
-		if ( ! $this->is_internal( $uri ) ) {
+		if ( ! $this->is_internal($uri)) {
 
 			$query_args['meta_query']['relation'] = 'OR';
 			$query_args['meta_query'][]           = array(
@@ -195,17 +195,17 @@ 
 			);
 		}
 
-		$posts = get_posts( $query_args );
+		$posts = get_posts($query_args);
 
 		// Return null if no post is found.
-		if ( empty( $posts ) ) {
-			$this->log->warn( "No post for URI $uri." );
+		if (empty($posts)) {
+			$this->log->warn("No post for URI $uri.");
 
 			return null;
 		}
 
 		// Return the found post.
-		return current( $posts );
+		return current($posts);
 	}
 
 	/**
@@ -217,9 +217,9 @@ 
 	 *
 	 * @return true if the uri internal to the current dataset otherwise false.
 	 */
-	public function is_internal( $uri ) {
+	public function is_internal($uri) {
 
-		return ( 0 === strrpos( $uri, $this->configuration_service->get_dataset_uri() ) );
+		return (0 === strrpos($uri, $this->configuration_service->get_dataset_uri()));
 	}
 
 }
\ No newline at end of file

src/includes/class-wordlift-query-builder.php

Indentation +317 added lines, -317 removed lines

@@ -7,322 +7,322 @@
  */
 class Wordlift_Query_Builder {
 
-	/**
-	 * The INSERT statement template.
-	 *
-	 * @since 3.1.7
-	 */
-	const INSERT = 'INSERT DATA { %s };';
-
-	/**
-	 * The DELETE statement template (it repeats the statements in the WHERE clause.
-	 *
-	 * @since 3.1.7
-	 */
-	const DELETE = 'DELETE { %s } WHERE { %1$s };';
-
-	/**
-	 * Tell the statement function to guess the object type (URI, value or parameter).
-	 *
-	 * @since 3.1.7
-	 */
-	const OBJECT_AUTO = - 1;
-
-	/**
-	 * Tell the statement function that the object is a URI.
-	 *
-	 * @since 3.1.7
-	 */
-	const OBJECT_URI = 0;
-
-	/**
-	 * Tell the statement function that the object is a value.
-	 *
-	 * @since 3.1.7
-	 */
-	const OBJECT_VALUE = 1;
-
-	/**
-	 * Tell the statement function that the object is a parameter.
-	 *
-	 * @since 3.1.7
-	 */
-	const OBJECT_PARAMETER = 2;
-
-	/**
-	 * The RDFS type.
-	 *
-	 * @since 3.1.7
-	 */
-	const RDFS_TYPE_URI = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#type';
-
-	/**
-	 * The schema.org/Person type.
-	 *
-	 * @since 3.1.7
-	 */
-	const SCHEMA_PERSON_URI = 'http://schema.org/Person';
-
-	/**
-	 * The schema.org given name predicate.
-	 *
-	 * @since 3.1.7
-	 */
-	const SCHEMA_GIVEN_NAME_URI = 'http://schema.org/givenName';
-
-	/**
-	 * The schema.org family name predicate.
-	 *
-	 * @since 3.1.7
-	 */
-	const SCHEMA_FAMILY_NAME_URI = 'http://schema.org/familyName';
-
-	/**
-	 * The schema.org url predicate.
-	 *
-	 * @since 3.1.7
-	 */
-	const SCHEMA_URL_URI = 'http://schema.org/url';
-
-	/**
-	 * @since 3.14.0
-	 */
-	const SCHEMA_IMAGE_URI = 'http://schema.org/image';
-
-	/**
-	 * The location created predicate.
-	 *
-	 * @since 3.14.0
-	 */
-	const SCHEMA_LOCATION_CREATED_URI = 'http://schema.org/locationCreated';
-
-	/**
-	 * @since 3.14.0
-	 */
-	const SCHEMA_AUTHOR_URI = 'http://schema.org/author';
-
-	/**
-	 * @since 3.14.0
-	 */
-	const SCHEMA_INTERACTION_COUNT_URI = 'http://schema.org/interactionCount';
-
-	/**
-	 * @since 3.14.0
-	 */
-	const DCTERMS_SUBJECT_URI = 'http://purl.org/dc/terms/subject';
-
-	/**
-	 * @since 3.14.0
-	 */
-	const DCTERMS_REFERENCES_URI = 'http://purl.org/dc/terms/references';
-
-	/**
-	 * @since 3.15.0
-	 */
-	const DCTERMS_RELATION_URI = 'http://purl.org/dc/terms/relation';
-
-	/**
-	 * The RDF label.
-	 *
-	 * @since 3.1.7
-	 */
-	const RDFS_LABEL_URI = 'http://www.w3.org/2000/01/rdf-schema#label';
-
-	/**
-	 * The schema.org headline.
-	 *
-	 * @since 3.18.0
-	 */
-	const SCHEMA_HEADLINE_URI = 'http://schema.org/headline';
-
-	/**
-	 * Hold the template (INSERT or DELETE).
-	 *
-	 * @since  3.1.7
-	 * @access private
-	 * @var string $template The query template.
-	 */
-	private $template;
-
-	/**
-	 * An array of statements (in the form of subject, predicate, object).
-	 *
-	 * @since  3.1.7
-	 * @access private
-	 * @var array $statements An array of statements.
-	 */
-	private $statements = array();
-
-	/**
-	 * Create a new instance of the Query builder (compatible with PHP 5.3).
-	 *
-	 * @since 3.1.7
-	 * @return Wordlift_Query_Builder A new instance of the Query builder.
-	 */
-	public static function new_instance() {
-
-		return new Wordlift_Query_Builder();
-	}
-
-	/**
-	 * Set the query to INSERT.
-	 *
-	 * @since 3.1.7
-	 * @return Wordlift_Query_Builder The Query builder.
-	 */
-	public function insert() {
-
-		$this->template = self::INSERT;
-
-		return $this;
-	}
-
-	/**
-	 * Set the query to DELETE.
-	 *
-	 * @since 3.1.7
-	 * @return $this \Wordlift_Query_Builder The Query builder.
-	 */
-	public function delete() {
-
-		$this->template = self::DELETE;
-
-		return $this;
-	}
-
-	/**
-	 * Set the query to SELECT.
-	 *
-	 * @since 3.12.2
-	 *
-	 * @param string $props The list of properties to read.
-	 *
-	 * @return $this \Wordlift_Query_Builder The Query builder.
-	 */
-	public function select( $props = '*' ) {
-
-		$this->template = "SELECT $props WHERE { %s }";
-
-		return $this;
-	}
-
-	/**
-	 * Add a statement.
-	 *
-	 * @since 3.1.7
-	 *
-	 * @param string      $subject     The subject of the statement (must be a URI).
-	 * @param string      $predicate   The predicate (must be a URI).
-	 * @param string      $object      The object, can be a URI or a value.
-	 * @param int         $object_type The object type, either a {@link OBJECT_URI} or a value {@link OBJECT_VALUE}. If set to {@link OBJECT_AUTO}, the Query builder will try to guess.
-	 * @param string|null $data_type   The data type (or null).
-	 * @param string|null $language    The language code (or null).
-	 *
-	 * @return $this \Wordlift_Query_Builder The Query builder.
-	 */
-	public function statement( $subject, $predicate, $object, $object_type = self::OBJECT_AUTO, $data_type = null, $language = null ) {
-
-		// If no value has been provided, we don't set any statement.
-		if ( empty( $object ) ) {
-			return $this;
-		}
-
-		// Guess the subject type.
-		$subject_value_type = $this->guess_subject_type( $subject );
-
-		// Get the object type if set, otherwise try to guess it.
-		$object_value_type = ( self::OBJECT_AUTO === $object_type ? $this->guess_object_type( $predicate, $object ) : $object_type );
-
-		// Prepare the statement template.
-		$template =
-			// Subject as a parameter, no `<`, `>`.
-			( self::OBJECT_PARAMETER === $subject_value_type ? '%1$s' : '<%1$s>' ) .
-			// Predicate.
-			' <%2$s> ' .
-			// Object.
-			( self::OBJECT_URI === $object_value_type ? '<%3$s>' :
-				( self::OBJECT_PARAMETER === $object_value_type ? '%3$s' :
-					// self::OBJECT_VALUE === $object_value_type
-					'"%3$s"' . ( isset( $data_type ) ? '^^%4$s' : '' ) . ( isset( $language ) ? '@%5$s' : '' ) ) );
-
-		// Escape the subject, predicate and object.
-		$escaped_subject   = Wordlift_Sparql_Service::escape_uri( $subject );
-		$escaped_predicate = Wordlift_Sparql_Service::escape_uri( $predicate );
-		$escaped_object    = ( self::OBJECT_URI === $object_value_type ? Wordlift_Sparql_Service::escape_uri( $object ) : Wordlift_Sparql_Service::escape( $object ) );
-
-		// Prepare the statement and add it to the list of statements.
-		$this->statements[] = sprintf( $template, $escaped_subject, $escaped_predicate, $escaped_object, $data_type, $language );
-
-		return $this;
-	}
-
-	/**
-	 * Build the query.
-	 *
-	 * @since 3.1.7
-	 * @return string The query string.
-	 */
-	public function build() {
-
-		// If there are no statements return an empty string.
-		if ( empty( $this->statements ) ) {
-			return '';
-		}
-
-		return sprintf( $this->template, implode( ' . ', $this->statements ) ) . "\n";
-	}
-
-	/**
-	 * Guess the statement object type.
-	 *
-	 * @since 3.1.7
-	 *
-	 * @param string $predicate The predicate.
-	 * @param string $object    The object.
-	 *
-	 * @return int {@link Wordlift_Query_Builder::OBJECT_URI} if the Query builder thinks the object must be an URI, {@link Wordlift_Query_Builder::OBJECT_VALUE} otherwise.
-	 */
-	private function guess_object_type( $predicate, $object ) {
-
-		// If the object starts with a question mark, it's a parameter.
-		if ( 0 === strpos( $object, '?' ) ) {
-			return self::OBJECT_PARAMETER;
-		}
-
-		// Guess based on the predicate.
-		switch ( $predicate ) {
-
-			case self::DCTERMS_REFERENCES_URI:
-			case self::DCTERMS_SUBJECT_URI:
-			case self::RDFS_TYPE_URI:
-			case self::SCHEMA_AUTHOR_URI:
-			case self::SCHEMA_LOCATION_CREATED_URI:
-			case self::SCHEMA_URL_URI:
-			case self::SCHEMA_IMAGE_URI:
-				return self::OBJECT_URI;
-
-		}
-
-		return self::OBJECT_VALUE;
-	}
-
-	/**
-	 * Guess the subject type.
-	 *
-	 * @since 3.12.3
-	 *
-	 * @param string $subject The subject string.
-	 *
-	 * @return int {@link Wordlift_Query_Builder::OBJECT_PARAMETER} if the Query builder thinks the subject is a parameter (starts with ?), otherwise {@link Wordlift_Query_Builder::OBJECT_URI}.
-	 */
-	private function guess_subject_type( $subject ) {
-
-		// If the object starts with a question mark, it's a parameter.
-		if ( 0 === strpos( $subject, '?' ) ) {
-			return self::OBJECT_PARAMETER;
-		}
-
-		return self::OBJECT_URI;
-	}
+    /**
+     * The INSERT statement template.
+     *
+     * @since 3.1.7
+     */
+    const INSERT = 'INSERT DATA { %s };';
+
+    /**
+     * The DELETE statement template (it repeats the statements in the WHERE clause.
+     *
+     * @since 3.1.7
+     */
+    const DELETE = 'DELETE { %s } WHERE { %1$s };';
+
+    /**
+     * Tell the statement function to guess the object type (URI, value or parameter).
+     *
+     * @since 3.1.7
+     */
+    const OBJECT_AUTO = - 1;
+
+    /**
+     * Tell the statement function that the object is a URI.
+     *
+     * @since 3.1.7
+     */
+    const OBJECT_URI = 0;
+
+    /**
+     * Tell the statement function that the object is a value.
+     *
+     * @since 3.1.7
+     */
+    const OBJECT_VALUE = 1;
+
+    /**
+     * Tell the statement function that the object is a parameter.
+     *
+     * @since 3.1.7
+     */
+    const OBJECT_PARAMETER = 2;
+
+    /**
+     * The RDFS type.
+     *
+     * @since 3.1.7
+     */
+    const RDFS_TYPE_URI = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#type';
+
+    /**
+     * The schema.org/Person type.
+     *
+     * @since 3.1.7
+     */
+    const SCHEMA_PERSON_URI = 'http://schema.org/Person';
+
+    /**
+     * The schema.org given name predicate.
+     *
+     * @since 3.1.7
+     */
+    const SCHEMA_GIVEN_NAME_URI = 'http://schema.org/givenName';
+
+    /**
+     * The schema.org family name predicate.
+     *
+     * @since 3.1.7
+     */
+    const SCHEMA_FAMILY_NAME_URI = 'http://schema.org/familyName';
+
+    /**
+     * The schema.org url predicate.
+     *
+     * @since 3.1.7
+     */
+    const SCHEMA_URL_URI = 'http://schema.org/url';
+
+    /**
+     * @since 3.14.0
+     */
+    const SCHEMA_IMAGE_URI = 'http://schema.org/image';
+
+    /**
+     * The location created predicate.
+     *
+     * @since 3.14.0
+     */
+    const SCHEMA_LOCATION_CREATED_URI = 'http://schema.org/locationCreated';
+
+    /**
+     * @since 3.14.0
+     */
+    const SCHEMA_AUTHOR_URI = 'http://schema.org/author';
+
+    /**
+     * @since 3.14.0
+     */
+    const SCHEMA_INTERACTION_COUNT_URI = 'http://schema.org/interactionCount';
+
+    /**
+     * @since 3.14.0
+     */
+    const DCTERMS_SUBJECT_URI = 'http://purl.org/dc/terms/subject';
+
+    /**
+     * @since 3.14.0
+     */
+    const DCTERMS_REFERENCES_URI = 'http://purl.org/dc/terms/references';
+
+    /**
+     * @since 3.15.0
+     */
+    const DCTERMS_RELATION_URI = 'http://purl.org/dc/terms/relation';
+
+    /**
+     * The RDF label.
+     *
+     * @since 3.1.7
+     */
+    const RDFS_LABEL_URI = 'http://www.w3.org/2000/01/rdf-schema#label';
+
+    /**
+     * The schema.org headline.
+     *
+     * @since 3.18.0
+     */
+    const SCHEMA_HEADLINE_URI = 'http://schema.org/headline';
+
+    /**
+     * Hold the template (INSERT or DELETE).
+     *
+     * @since  3.1.7
+     * @access private
+     * @var string $template The query template.
+     */
+    private $template;
+
+    /**
+     * An array of statements (in the form of subject, predicate, object).
+     *
+     * @since  3.1.7
+     * @access private
+     * @var array $statements An array of statements.
+     */
+    private $statements = array();
+
+    /**
+     * Create a new instance of the Query builder (compatible with PHP 5.3).
+     *
+     * @since 3.1.7
+     * @return Wordlift_Query_Builder A new instance of the Query builder.
+     */
+    public static function new_instance() {
+
+        return new Wordlift_Query_Builder();
+    }
+
+    /**
+     * Set the query to INSERT.
+     *
+     * @since 3.1.7
+     * @return Wordlift_Query_Builder The Query builder.
+     */
+    public function insert() {
+
+        $this->template = self::INSERT;
+
+        return $this;
+    }
+
+    /**
+     * Set the query to DELETE.
+     *
+     * @since 3.1.7
+     * @return $this \Wordlift_Query_Builder The Query builder.
+     */
+    public function delete() {
+
+        $this->template = self::DELETE;
+
+        return $this;
+    }
+
+    /**
+     * Set the query to SELECT.
+     *
+     * @since 3.12.2
+     *
+     * @param string $props The list of properties to read.
+     *
+     * @return $this \Wordlift_Query_Builder The Query builder.
+     */
+    public function select( $props = '*' ) {
+
+        $this->template = "SELECT $props WHERE { %s }";
+
+        return $this;
+    }
+
+    /**
+     * Add a statement.
+     *
+     * @since 3.1.7
+     *
+     * @param string      $subject     The subject of the statement (must be a URI).
+     * @param string      $predicate   The predicate (must be a URI).
+     * @param string      $object      The object, can be a URI or a value.
+     * @param int         $object_type The object type, either a {@link OBJECT_URI} or a value {@link OBJECT_VALUE}. If set to {@link OBJECT_AUTO}, the Query builder will try to guess.
+     * @param string|null $data_type   The data type (or null).
+     * @param string|null $language    The language code (or null).
+     *
+     * @return $this \Wordlift_Query_Builder The Query builder.
+     */
+    public function statement( $subject, $predicate, $object, $object_type = self::OBJECT_AUTO, $data_type = null, $language = null ) {
+
+        // If no value has been provided, we don't set any statement.
+        if ( empty( $object ) ) {
+            return $this;
+        }
+
+        // Guess the subject type.
+        $subject_value_type = $this->guess_subject_type( $subject );
+
+        // Get the object type if set, otherwise try to guess it.
+        $object_value_type = ( self::OBJECT_AUTO === $object_type ? $this->guess_object_type( $predicate, $object ) : $object_type );
+
+        // Prepare the statement template.
+        $template =
+            // Subject as a parameter, no `<`, `>`.
+            ( self::OBJECT_PARAMETER === $subject_value_type ? '%1$s' : '<%1$s>' ) .
+            // Predicate.
+            ' <%2$s> ' .
+            // Object.
+            ( self::OBJECT_URI === $object_value_type ? '<%3$s>' :
+                ( self::OBJECT_PARAMETER === $object_value_type ? '%3$s' :
+                    // self::OBJECT_VALUE === $object_value_type
+                    '"%3$s"' . ( isset( $data_type ) ? '^^%4$s' : '' ) . ( isset( $language ) ? '@%5$s' : '' ) ) );
+
+        // Escape the subject, predicate and object.
+        $escaped_subject   = Wordlift_Sparql_Service::escape_uri( $subject );
+        $escaped_predicate = Wordlift_Sparql_Service::escape_uri( $predicate );
+        $escaped_object    = ( self::OBJECT_URI === $object_value_type ? Wordlift_Sparql_Service::escape_uri( $object ) : Wordlift_Sparql_Service::escape( $object ) );
+
+        // Prepare the statement and add it to the list of statements.
+        $this->statements[] = sprintf( $template, $escaped_subject, $escaped_predicate, $escaped_object, $data_type, $language );
+
+        return $this;
+    }
+
+    /**
+     * Build the query.
+     *
+     * @since 3.1.7
+     * @return string The query string.
+     */
+    public function build() {
+
+        // If there are no statements return an empty string.
+        if ( empty( $this->statements ) ) {
+            return '';
+        }
+
+        return sprintf( $this->template, implode( ' . ', $this->statements ) ) . "\n";
+    }
+
+    /**
+     * Guess the statement object type.
+     *
+     * @since 3.1.7
+     *
+     * @param string $predicate The predicate.
+     * @param string $object    The object.
+     *
+     * @return int {@link Wordlift_Query_Builder::OBJECT_URI} if the Query builder thinks the object must be an URI, {@link Wordlift_Query_Builder::OBJECT_VALUE} otherwise.
+     */
+    private function guess_object_type( $predicate, $object ) {
+
+        // If the object starts with a question mark, it's a parameter.
+        if ( 0 === strpos( $object, '?' ) ) {
+            return self::OBJECT_PARAMETER;
+        }
+
+        // Guess based on the predicate.
+        switch ( $predicate ) {
+
+            case self::DCTERMS_REFERENCES_URI:
+            case self::DCTERMS_SUBJECT_URI:
+            case self::RDFS_TYPE_URI:
+            case self::SCHEMA_AUTHOR_URI:
+            case self::SCHEMA_LOCATION_CREATED_URI:
+            case self::SCHEMA_URL_URI:
+            case self::SCHEMA_IMAGE_URI:
+                return self::OBJECT_URI;
+
+        }
+
+        return self::OBJECT_VALUE;
+    }
+
+    /**
+     * Guess the subject type.
+     *
+     * @since 3.12.3
+     *
+     * @param string $subject The subject string.
+     *
+     * @return int {@link Wordlift_Query_Builder::OBJECT_PARAMETER} if the Query builder thinks the subject is a parameter (starts with ?), otherwise {@link Wordlift_Query_Builder::OBJECT_URI}.
+     */
+    private function guess_subject_type( $subject ) {
+
+        // If the object starts with a question mark, it's a parameter.
+        if ( 0 === strpos( $subject, '?' ) ) {
+            return self::OBJECT_PARAMETER;
+        }
+
+        return self::OBJECT_URI;
+    }
 
 }

Spacing +20 added lines, -22 removed lines

@@ -199,7 +199,7 @@ 
 	 *
 	 * @return $this \Wordlift_Query_Builder The Query builder.
 	 */
-	public function select( $props = '*' ) {
+	public function select($props = '*') {
 
 		$this->template = "SELECT $props WHERE { %s }";
 
@@ -220,38 +220,36 @@ 
 	 *
 	 * @return $this \Wordlift_Query_Builder The Query builder.
 	 */
-	public function statement( $subject, $predicate, $object, $object_type = self::OBJECT_AUTO, $data_type = null, $language = null ) {
+	public function statement($subject, $predicate, $object, $object_type = self::OBJECT_AUTO, $data_type = null, $language = null) {
 
 		// If no value has been provided, we don't set any statement.
-		if ( empty( $object ) ) {
+		if (empty($object)) {
 			return $this;
 		}
 
 		// Guess the subject type.
-		$subject_value_type = $this->guess_subject_type( $subject );
+		$subject_value_type = $this->guess_subject_type($subject);
 
 		// Get the object type if set, otherwise try to guess it.
-		$object_value_type = ( self::OBJECT_AUTO === $object_type ? $this->guess_object_type( $predicate, $object ) : $object_type );
+		$object_value_type = (self::OBJECT_AUTO === $object_type ? $this->guess_object_type($predicate, $object) : $object_type);
 
 		// Prepare the statement template.
 		$template =
 			// Subject as a parameter, no `<`, `>`.
-			( self::OBJECT_PARAMETER === $subject_value_type ? '%1$s' : '<%1$s>' ) .
+			(self::OBJECT_PARAMETER === $subject_value_type ? '%1$s' : '<%1$s>').
 			// Predicate.
-			' <%2$s> ' .
+			' <%2$s> '.
 			// Object.
-			( self::OBJECT_URI === $object_value_type ? '<%3$s>' :
-				( self::OBJECT_PARAMETER === $object_value_type ? '%3$s' :
-					// self::OBJECT_VALUE === $object_value_type
-					'"%3$s"' . ( isset( $data_type ) ? '^^%4$s' : '' ) . ( isset( $language ) ? '@%5$s' : '' ) ) );
+			(self::OBJECT_URI === $object_value_type ? '<%3$s>' : (self::OBJECT_PARAMETER === $object_value_type ? '%3$s' : // self::OBJECT_VALUE === $object_value_type
+					'"%3$s"'.(isset($data_type) ? '^^%4$s' : '').(isset($language) ? '@%5$s' : '')));
 
 		// Escape the subject, predicate and object.
-		$escaped_subject   = Wordlift_Sparql_Service::escape_uri( $subject );
-		$escaped_predicate = Wordlift_Sparql_Service::escape_uri( $predicate );
-		$escaped_object    = ( self::OBJECT_URI === $object_value_type ? Wordlift_Sparql_Service::escape_uri( $object ) : Wordlift_Sparql_Service::escape( $object ) );
+		$escaped_subject   = Wordlift_Sparql_Service::escape_uri($subject);
+		$escaped_predicate = Wordlift_Sparql_Service::escape_uri($predicate);
+		$escaped_object    = (self::OBJECT_URI === $object_value_type ? Wordlift_Sparql_Service::escape_uri($object) : Wordlift_Sparql_Service::escape($object));
 
 		// Prepare the statement and add it to the list of statements.
-		$this->statements[] = sprintf( $template, $escaped_subject, $escaped_predicate, $escaped_object, $data_type, $language );
+		$this->statements[] = sprintf($template, $escaped_subject, $escaped_predicate, $escaped_object, $data_type, $language);
 
 		return $this;
 	}
@@ -265,11 +263,11 @@ 
 	public function build() {
 
 		// If there are no statements return an empty string.
-		if ( empty( $this->statements ) ) {
+		if (empty($this->statements)) {
 			return '';
 		}
 
-		return sprintf( $this->template, implode( ' . ', $this->statements ) ) . "\n";
+		return sprintf($this->template, implode(' . ', $this->statements))."\n";
 	}
 
 	/**
@@ -282,15 +280,15 @@ 
 	 *
 	 * @return int {@link Wordlift_Query_Builder::OBJECT_URI} if the Query builder thinks the object must be an URI, {@link Wordlift_Query_Builder::OBJECT_VALUE} otherwise.
 	 */
-	private function guess_object_type( $predicate, $object ) {
+	private function guess_object_type($predicate, $object) {
 
 		// If the object starts with a question mark, it's a parameter.
-		if ( 0 === strpos( $object, '?' ) ) {
+		if (0 === strpos($object, '?')) {
 			return self::OBJECT_PARAMETER;
 		}
 
 		// Guess based on the predicate.
-		switch ( $predicate ) {
+		switch ($predicate) {
 
 			case self::DCTERMS_REFERENCES_URI:
 			case self::DCTERMS_SUBJECT_URI:
@@ -315,10 +313,10 @@ 
 	 *
 	 * @return int {@link Wordlift_Query_Builder::OBJECT_PARAMETER} if the Query builder thinks the subject is a parameter (starts with ?), otherwise {@link Wordlift_Query_Builder::OBJECT_URI}.
 	 */
-	private function guess_subject_type( $subject ) {
+	private function guess_subject_type($subject) {
 
 		// If the object starts with a question mark, it's a parameter.
-		if ( 0 === strpos( $subject, '?' ) ) {
+		if (0 === strpos($subject, '?')) {
 			return self::OBJECT_PARAMETER;
 		}
 

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

Indentation +288 added lines, -288 removed lines

@@ -18,296 +18,296 @@
  */
 class Wordlift_Content_Filter_Service {
 
-	/**
-	 * The pattern to find entities in text.
-	 *
-	 * @since 3.8.0
-	 */
-	const PATTERN = '/<(\\w+)[^<]*class="([^"]*)"\\sitemid=\"([^"]+)\"[^>]*>([^<]*)<\\/\\1>/i';
-
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.13.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * The `link by default` setting.
-	 *
-	 * @since  3.13.0
-	 * @access private
-	 * @var bool True if link by default is enabled otherwise false.
-	 */
-	private $is_link_by_default;
-
-	private $entity_post_ids_linked_from_post_content = array();
-
-	/**
-	 * The {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_Content_Filter_Service} singleton instance.
-	 *
-	 * @since  3.14.2
-	 * @access private
-	 * @var \Wordlift_Content_Filter_Service $instance The {@link Wordlift_Content_Filter_Service} singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a {@link Wordlift_Content_Filter_Service} instance.
-	 *
-	 * @since 3.8.0
-	 *
-	 * @param \Wordlift_Entity_Service        $entity_service        The {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 * @param \Wordlift_Entity_Uri_Service    $entity_uri_service    The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	public function __construct( $entity_service, $configuration_service, $entity_uri_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->entity_service        = $entity_service;
-		$this->configuration_service = $configuration_service;
-		$this->entity_uri_service    = $entity_uri_service;
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the {@link Wordlift_Content_Filter_Service} singleton instance.
-	 *
-	 * @since 3.14.2
-	 * @return \Wordlift_Content_Filter_Service The {@link Wordlift_Content_Filter_Service} singleton instance.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Mangle the content by adding links to the entity pages. This function is
-	 * hooked to the 'the_content' WP's filter.
-	 *
-	 * @since 3.8.0
-	 *
-	 * @param string $content The content being filtered.
-	 *
-	 * @return string The filtered content.
-	 */
-	public function the_content( $content ) {
-
-		$this->log->trace( "Filtering content [ " . ( is_singular() ? 'yes' : 'no' ) . " ]..." );
-
-		// Links should be added only on the front end and not for RSS.
-		if ( is_feed() ) {
-			return $content;
-		}
-
-		// Preload the `link by default` setting.
-		$this->is_link_by_default = $this->configuration_service->is_link_by_default();
-
-		// Reset the array of of entity post ids linked from the post content.
-		// This is used to avoid linking more the once the same post.
-		$this->entity_post_ids_linked_from_post_content = array();
-
-		// Preload URIs.
-		$matches = array();
-		preg_match_all( self::PATTERN, $content, $matches );
-
-		// Bail out if there are no URIs.
-		if ( empty( $matches[3] ) ) {
-			return $content;
-		}
-
-		// Preload the URIs.
-		$this->entity_uri_service->preload_uris( $matches[3] );
-
-		// Replace each match of the entity tag with the entity link. If an error
-		// occurs fail silently returning the original content.
-		$result = preg_replace_callback( self::PATTERN, array(
-			$this,
-			'link',
-		), $content ) ?: $content;
-
-		$this->entity_uri_service->reset_uris();
-
-		return $result;
-	}
-
-	/**
-	 * Get the entity match and replace it with a page link.
-	 *
-	 * @since 3.8.0
-	 *
-	 * @param array $matches An array of matches.
-	 *
-	 * @return string The replaced text with the link to the entity page.
-	 */
-	private function link( $matches ) {
-
-		// Get the entity itemid URI and label.
-		$css_class = $matches[2];
-		$uri       = $matches[3];
-		$label     = $matches[4];
-
-		// Get the entity post by URI.
-		$post = $this->entity_service->get_entity_post_by_uri( $uri );
-
-		// @todo: revise the `test-content-filter-service.php` before switching
-		// to the `entity_uri_service`. This is required, because the test injects
-		// itself as `entity_service` to mock the requests to get a post by
-		// entity uri.
-		//
-		// $post = $this->entity_uri_service->get_entity( $uri );
-
-		if ( null === $post ) {
-
-			// If the entity post is not found return the label w/o the markup
-			// around it.
-			//
-			// See https://github.com/insideout10/wordlift-plugin/issues/461.
-			return $label;
-		}
-
-		$no_link = - 1 < strpos( $css_class, 'wl-no-link' )
-				   // Do not link if already linked.
-				   || in_array( $post->ID, $this->entity_post_ids_linked_from_post_content );
-		$link = - 1 < strpos( $css_class, 'wl-link' );
-
-		// Don't link if links are disabled and the entity is not link or the
-		// entity is do not link.
-		$dont_link = ( ! $this->is_link_by_default && ! $link ) || $no_link;
-
-		// Return the label if it's don't link.
-		if ( $dont_link ) {
-			return $label;
-		}
-
-		// Add the entity post id to the array of already linked entities, so that
-		// only the first entity occurrence is linked.
-		$this->entity_post_ids_linked_from_post_content[] = $post->ID;
-
-		// Get the link.
-		$href = get_permalink( $post );
-
-		// Get an alternative title attribute.
-		$title_attribute = $this->get_title_attribute( $post->ID, $label );
-
-		// Return the link.
-		return "<a class='wl-entity-page-link' $title_attribute href='$href'>$label</a>";
-	}
-
-	/**
-	 * Get a `title` attribute with an alternative label for the link.
-	 *
-	 * If an alternative title isn't available an empty string is returned.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param int    $post_id The {@link WP_Post}'s id.
-	 * @param string $label   The main link label.
-	 *
-	 * @return string A `title` attribute with an alternative label or an empty
-	 *                string if none available.
-	 */
-	private function get_title_attribute( $post_id, $label ) {
-
-		// Get an alternative title.
-		$title = $this->get_link_title( $post_id, $label );
-		if ( ! empty( $title ) ) {
-			return 'title="' . esc_attr( $title ) . '"';
-		}
-
-		return '';
-	}
-
-	/**
-	 * Get a string to be used as a title attribute in links to a post
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param int    $post_id      The post id of the post being linked.
-	 * @param string $ignore_label A label to ignore.
-	 *
-	 * @return string    The title to be used in the link. An empty string when
-	 *                    there is no alternative that is not the $ignore_label.
-	 */
-	function get_link_title( $post_id, $ignore_label ) {
-
-		// Get possible alternative labels we can select from.
-		$labels = $this->entity_service->get_alternative_labels( $post_id );
-
-		/*
+    /**
+     * The pattern to find entities in text.
+     *
+     * @since 3.8.0
+     */
+    const PATTERN = '/<(\\w+)[^<]*class="([^"]*)"\\sitemid=\"([^"]+)\"[^>]*>([^<]*)<\\/\\1>/i';
+
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.13.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * The `link by default` setting.
+     *
+     * @since  3.13.0
+     * @access private
+     * @var bool True if link by default is enabled otherwise false.
+     */
+    private $is_link_by_default;
+
+    private $entity_post_ids_linked_from_post_content = array();
+
+    /**
+     * The {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    private $entity_uri_service;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_Content_Filter_Service} singleton instance.
+     *
+     * @since  3.14.2
+     * @access private
+     * @var \Wordlift_Content_Filter_Service $instance The {@link Wordlift_Content_Filter_Service} singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * Create a {@link Wordlift_Content_Filter_Service} instance.
+     *
+     * @since 3.8.0
+     *
+     * @param \Wordlift_Entity_Service        $entity_service        The {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     * @param \Wordlift_Entity_Uri_Service    $entity_uri_service    The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    public function __construct( $entity_service, $configuration_service, $entity_uri_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->entity_service        = $entity_service;
+        $this->configuration_service = $configuration_service;
+        $this->entity_uri_service    = $entity_uri_service;
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the {@link Wordlift_Content_Filter_Service} singleton instance.
+     *
+     * @since 3.14.2
+     * @return \Wordlift_Content_Filter_Service The {@link Wordlift_Content_Filter_Service} singleton instance.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Mangle the content by adding links to the entity pages. This function is
+     * hooked to the 'the_content' WP's filter.
+     *
+     * @since 3.8.0
+     *
+     * @param string $content The content being filtered.
+     *
+     * @return string The filtered content.
+     */
+    public function the_content( $content ) {
+
+        $this->log->trace( "Filtering content [ " . ( is_singular() ? 'yes' : 'no' ) . " ]..." );
+
+        // Links should be added only on the front end and not for RSS.
+        if ( is_feed() ) {
+            return $content;
+        }
+
+        // Preload the `link by default` setting.
+        $this->is_link_by_default = $this->configuration_service->is_link_by_default();
+
+        // Reset the array of of entity post ids linked from the post content.
+        // This is used to avoid linking more the once the same post.
+        $this->entity_post_ids_linked_from_post_content = array();
+
+        // Preload URIs.
+        $matches = array();
+        preg_match_all( self::PATTERN, $content, $matches );
+
+        // Bail out if there are no URIs.
+        if ( empty( $matches[3] ) ) {
+            return $content;
+        }
+
+        // Preload the URIs.
+        $this->entity_uri_service->preload_uris( $matches[3] );
+
+        // Replace each match of the entity tag with the entity link. If an error
+        // occurs fail silently returning the original content.
+        $result = preg_replace_callback( self::PATTERN, array(
+            $this,
+            'link',
+        ), $content ) ?: $content;
+
+        $this->entity_uri_service->reset_uris();
+
+        return $result;
+    }
+
+    /**
+     * Get the entity match and replace it with a page link.
+     *
+     * @since 3.8.0
+     *
+     * @param array $matches An array of matches.
+     *
+     * @return string The replaced text with the link to the entity page.
+     */
+    private function link( $matches ) {
+
+        // Get the entity itemid URI and label.
+        $css_class = $matches[2];
+        $uri       = $matches[3];
+        $label     = $matches[4];
+
+        // Get the entity post by URI.
+        $post = $this->entity_service->get_entity_post_by_uri( $uri );
+
+        // @todo: revise the `test-content-filter-service.php` before switching
+        // to the `entity_uri_service`. This is required, because the test injects
+        // itself as `entity_service` to mock the requests to get a post by
+        // entity uri.
+        //
+        // $post = $this->entity_uri_service->get_entity( $uri );
+
+        if ( null === $post ) {
+
+            // If the entity post is not found return the label w/o the markup
+            // around it.
+            //
+            // See https://github.com/insideout10/wordlift-plugin/issues/461.
+            return $label;
+        }
+
+        $no_link = - 1 < strpos( $css_class, 'wl-no-link' )
+                    // Do not link if already linked.
+                   || in_array( $post->ID, $this->entity_post_ids_linked_from_post_content );
+        $link = - 1 < strpos( $css_class, 'wl-link' );
+
+        // Don't link if links are disabled and the entity is not link or the
+        // entity is do not link.
+        $dont_link = ( ! $this->is_link_by_default && ! $link ) || $no_link;
+
+        // Return the label if it's don't link.
+        if ( $dont_link ) {
+            return $label;
+        }
+
+        // Add the entity post id to the array of already linked entities, so that
+        // only the first entity occurrence is linked.
+        $this->entity_post_ids_linked_from_post_content[] = $post->ID;
+
+        // Get the link.
+        $href = get_permalink( $post );
+
+        // Get an alternative title attribute.
+        $title_attribute = $this->get_title_attribute( $post->ID, $label );
+
+        // Return the link.
+        return "<a class='wl-entity-page-link' $title_attribute href='$href'>$label</a>";
+    }
+
+    /**
+     * Get a `title` attribute with an alternative label for the link.
+     *
+     * If an alternative title isn't available an empty string is returned.
+     *
+     * @since 3.15.0
+     *
+     * @param int    $post_id The {@link WP_Post}'s id.
+     * @param string $label   The main link label.
+     *
+     * @return string A `title` attribute with an alternative label or an empty
+     *                string if none available.
+     */
+    private function get_title_attribute( $post_id, $label ) {
+
+        // Get an alternative title.
+        $title = $this->get_link_title( $post_id, $label );
+        if ( ! empty( $title ) ) {
+            return 'title="' . esc_attr( $title ) . '"';
+        }
+
+        return '';
+    }
+
+    /**
+     * Get a string to be used as a title attribute in links to a post
+     *
+     * @since 3.15.0
+     *
+     * @param int    $post_id      The post id of the post being linked.
+     * @param string $ignore_label A label to ignore.
+     *
+     * @return string    The title to be used in the link. An empty string when
+     *                    there is no alternative that is not the $ignore_label.
+     */
+    function get_link_title( $post_id, $ignore_label ) {
+
+        // Get possible alternative labels we can select from.
+        $labels = $this->entity_service->get_alternative_labels( $post_id );
+
+        /*
 		 * Since the original text might use an alternative label than the
 		 * Entity title, add the title itself which is not returned by the api.
 		 */
-		$labels[] = get_the_title( $post_id );
-
-		// Add some randomness to the label selection.
-		shuffle( $labels );
-
-		// Select the first label which is not to be ignored.
-		$title = '';
-		foreach ( $labels as $label ) {
-			if ( 0 !== strcasecmp( $label, $ignore_label ) ) {
-				$title = $label;
-				break;
-			}
-		}
-
-		return $title;
-	}
-
-	/**
-	 * Get the entity URIs (configured in the `itemid` attribute) contained in
-	 * the provided content.
-	 *
-	 * @since 3.14.2
-	 *
-	 * @param string $content The content.
-	 *
-	 * @return array An array of URIs.
-	 */
-	public function get_entity_uris( $content ) {
-
-		$matches = array();
-		preg_match_all( Wordlift_Content_Filter_Service::PATTERN, $content, $matches );
-
-		// We need to use `array_values` here in order to avoid further `json_encode`
-		// to turn it into an object (since if the 3rd match isn't found the index
-		// is not sequential.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/646.
-		return array_values( array_unique( $matches[3] ) );
-	}
+        $labels[] = get_the_title( $post_id );
+
+        // Add some randomness to the label selection.
+        shuffle( $labels );
+
+        // Select the first label which is not to be ignored.
+        $title = '';
+        foreach ( $labels as $label ) {
+            if ( 0 !== strcasecmp( $label, $ignore_label ) ) {
+                $title = $label;
+                break;
+            }
+        }
+
+        return $title;
+    }
+
+    /**
+     * Get the entity URIs (configured in the `itemid` attribute) contained in
+     * the provided content.
+     *
+     * @since 3.14.2
+     *
+     * @param string $content The content.
+     *
+     * @return array An array of URIs.
+     */
+    public function get_entity_uris( $content ) {
+
+        $matches = array();
+        preg_match_all( Wordlift_Content_Filter_Service::PATTERN, $content, $matches );
+
+        // We need to use `array_values` here in order to avoid further `json_encode`
+        // to turn it into an object (since if the 3rd match isn't found the index
+        // is not sequential.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/646.
+        return array_values( array_unique( $matches[3] ) );
+    }
 
 }

Spacing +33 added lines, -33 removed lines

@@ -90,9 +90,9 @@ 
 	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
 	 * @param \Wordlift_Entity_Uri_Service    $entity_uri_service    The {@link Wordlift_Entity_Uri_Service} instance.
 	 */
-	public function __construct( $entity_service, $configuration_service, $entity_uri_service ) {
+	public function __construct($entity_service, $configuration_service, $entity_uri_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->entity_service        = $entity_service;
 		$this->configuration_service = $configuration_service;
@@ -123,12 +123,12 @@ 
 	 *
 	 * @return string The filtered content.
 	 */
-	public function the_content( $content ) {
+	public function the_content($content) {
 
-		$this->log->trace( "Filtering content [ " . ( is_singular() ? 'yes' : 'no' ) . " ]..." );
+		$this->log->trace("Filtering content [ ".(is_singular() ? 'yes' : 'no')." ]...");
 
 		// Links should be added only on the front end and not for RSS.
-		if ( is_feed() ) {
+		if (is_feed()) {
 			return $content;
 		}
 
@@ -141,22 +141,22 @@ 
 
 		// Preload URIs.
 		$matches = array();
-		preg_match_all( self::PATTERN, $content, $matches );
+		preg_match_all(self::PATTERN, $content, $matches);
 
 		// Bail out if there are no URIs.
-		if ( empty( $matches[3] ) ) {
+		if (empty($matches[3])) {
 			return $content;
 		}
 
 		// Preload the URIs.
-		$this->entity_uri_service->preload_uris( $matches[3] );
+		$this->entity_uri_service->preload_uris($matches[3]);
 
 		// Replace each match of the entity tag with the entity link. If an error
 		// occurs fail silently returning the original content.
-		$result = preg_replace_callback( self::PATTERN, array(
+		$result = preg_replace_callback(self::PATTERN, array(
 			$this,
 			'link',
-		), $content ) ?: $content;
+		), $content) ?: $content;
 
 		$this->entity_uri_service->reset_uris();
 
@@ -172,7 +172,7 @@ 
 	 *
 	 * @return string The replaced text with the link to the entity page.
 	 */
-	private function link( $matches ) {
+	private function link($matches) {
 
 		// Get the entity itemid URI and label.
 		$css_class = $matches[2];
@@ -180,7 +180,7 @@ 
 		$label     = $matches[4];
 
 		// Get the entity post by URI.
-		$post = $this->entity_service->get_entity_post_by_uri( $uri );
+		$post = $this->entity_service->get_entity_post_by_uri($uri);
 
 		// @todo: revise the `test-content-filter-service.php` before switching
 		// to the `entity_uri_service`. This is required, because the test injects
@@ -189,7 +189,7 @@ 
 		//
 		// $post = $this->entity_uri_service->get_entity( $uri );
 
-		if ( null === $post ) {
+		if (null === $post) {
 
 			// If the entity post is not found return the label w/o the markup
 			// around it.
@@ -198,17 +198,17 @@ 
 			return $label;
 		}
 
-		$no_link = - 1 < strpos( $css_class, 'wl-no-link' )
+		$no_link = - 1 < strpos($css_class, 'wl-no-link')
 				   // Do not link if already linked.
-				   || in_array( $post->ID, $this->entity_post_ids_linked_from_post_content );
-		$link = - 1 < strpos( $css_class, 'wl-link' );
+				   || in_array($post->ID, $this->entity_post_ids_linked_from_post_content);
+		$link = - 1 < strpos($css_class, 'wl-link');
 
 		// Don't link if links are disabled and the entity is not link or the
 		// entity is do not link.
-		$dont_link = ( ! $this->is_link_by_default && ! $link ) || $no_link;
+		$dont_link = ( ! $this->is_link_by_default && ! $link) || $no_link;
 
 		// Return the label if it's don't link.
-		if ( $dont_link ) {
+		if ($dont_link) {
 			return $label;
 		}
 
@@ -217,10 +217,10 @@ 
 		$this->entity_post_ids_linked_from_post_content[] = $post->ID;
 
 		// Get the link.
-		$href = get_permalink( $post );
+		$href = get_permalink($post);
 
 		// Get an alternative title attribute.
-		$title_attribute = $this->get_title_attribute( $post->ID, $label );
+		$title_attribute = $this->get_title_attribute($post->ID, $label);
 
 		// Return the link.
 		return "<a class='wl-entity-page-link' $title_attribute href='$href'>$label</a>";
@@ -239,12 +239,12 @@ 
 	 * @return string A `title` attribute with an alternative label or an empty
 	 *                string if none available.
 	 */
-	private function get_title_attribute( $post_id, $label ) {
+	private function get_title_attribute($post_id, $label) {
 
 		// Get an alternative title.
-		$title = $this->get_link_title( $post_id, $label );
-		if ( ! empty( $title ) ) {
-			return 'title="' . esc_attr( $title ) . '"';
+		$title = $this->get_link_title($post_id, $label);
+		if ( ! empty($title)) {
+			return 'title="'.esc_attr($title).'"';
 		}
 
 		return '';
@@ -261,24 +261,24 @@ 
 	 * @return string    The title to be used in the link. An empty string when
 	 *                    there is no alternative that is not the $ignore_label.
 	 */
-	function get_link_title( $post_id, $ignore_label ) {
+	function get_link_title($post_id, $ignore_label) {
 
 		// Get possible alternative labels we can select from.
-		$labels = $this->entity_service->get_alternative_labels( $post_id );
+		$labels = $this->entity_service->get_alternative_labels($post_id);
 
 		/*
 		 * Since the original text might use an alternative label than the
 		 * Entity title, add the title itself which is not returned by the api.
 		 */
-		$labels[] = get_the_title( $post_id );
+		$labels[] = get_the_title($post_id);
 
 		// Add some randomness to the label selection.
-		shuffle( $labels );
+		shuffle($labels);
 
 		// Select the first label which is not to be ignored.
 		$title = '';
-		foreach ( $labels as $label ) {
-			if ( 0 !== strcasecmp( $label, $ignore_label ) ) {
+		foreach ($labels as $label) {
+			if (0 !== strcasecmp($label, $ignore_label)) {
 				$title = $label;
 				break;
 			}
@@ -297,17 +297,17 @@ 
 	 *
 	 * @return array An array of URIs.
 	 */
-	public function get_entity_uris( $content ) {
+	public function get_entity_uris($content) {
 
 		$matches = array();
-		preg_match_all( Wordlift_Content_Filter_Service::PATTERN, $content, $matches );
+		preg_match_all(Wordlift_Content_Filter_Service::PATTERN, $content, $matches);
 
 		// We need to use `array_values` here in order to avoid further `json_encode`
 		// to turn it into an object (since if the 3rd match isn't found the index
 		// is not sequential.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/646.
-		return array_values( array_unique( $matches[3] ) );
+		return array_values(array_unique($matches[3]));
 	}
 
 }

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

Indentation +158 added lines, -158 removed lines

@@ -13,163 +13,163 @@
  */
 class Wordlift_Entity_Post_To_Jsonld_Converter extends Wordlift_Abstract_Post_To_Jsonld_Converter {
 
-	/**
-	 * A {@link Wordlift_Property_Getter} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var \Wordlift_Property_Getter $property_getter A {@link Wordlift_Property_Getter} instance.
-	 */
-	private $property_getter;
-
-	/**
-	 * Wordlift_Entity_To_Jsonld_Converter constructor.
-	 *
-	 * @since 3.8.0
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 * @param \Wordlift_Entity_Service      $entity_service      A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_User_Service        $user_service        A {@link Wordlift_User_Service} instance.
-	 * @param \Wordlift_Attachment_Service  $attachment_service  A {@link Wordlift_Attachment_Service} instance.
-	 * @param \Wordlift_Property_Getter     $property_getter     A {@link Wordlift_Property_Getter} instance.
-	 */
-	public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service, $property_getter ) {
-		parent::__construct( $entity_type_service, $entity_service, $user_service, $attachment_service );
-
-		$this->property_getter = $property_getter;
-
-	}
-
-	/**
-	 * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
-	 * found while processing the post is set in the $references array.
-	 *
-	 * @since 3.8.0
-	 *
-	 * @param int   $post_id    The {@link WP_Post} id.
-	 *
-	 * @param array $references An array of entity references.
-	 *
-	 * @return array A JSON-LD array.
-	 */
-	public function convert( $post_id, &$references = array() ) {
-
-		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
-			// Post not found.
-			return null;
-		}
-
-		// Get the base JSON-LD and the list of entities referenced by this entity.
-		$jsonld = parent::convert( $post_id, $references );
-
-		// Get the entity name.
-		$jsonld['name'] = $post->post_title;
-
-		// 3.13.0, add alternate names.
-		$alternative_labels = $this->entity_service->get_alternative_labels( $post_id );
-		if ( 0 < count( $alternative_labels ) ) {
-			$jsonld['alternateName'] = $alternative_labels;
-		}
-
-		// Get the entity @type.
-		$type = $this->entity_type_service->get( $post_id );
-
-		// Get the configured type custom fields.
-		$fields = $type['custom_fields'];
-
-		// Set a reference to use in closures.
-		$converter = $this;
-
-		// Try each field on the entity.
-		foreach ( $fields as $key => $value ) {
-
-			// Get the predicate.
-			$name = $this->relative_to_context( $value['predicate'] );
-
-			// Get the value, the property service will get the right extractor
-			// for that property.
-			$value = $this->property_getter->get( $post->ID, $key );
-
-			if ( empty( $value ) ) {
-				continue;
-			}
-
-			// Map the value to the property name.
-			// If we got an array with just one value, we return that one value.
-			// If we got a Wordlift_Property_Entity_Reference we get the URL.
-			$jsonld[ $name ] = $this->make_one( array_map( function ( $item ) use ( $converter, &$references ) {
-
-				if ( $item instanceof Wordlift_Property_Entity_Reference ) {
-
-					$url = $item->getURL();
-
-					// The refactored converters require the entity id.
-					$references[] = $item->getID();
-
-					return array(
-						'@id' => $url,
-					);
-				}
-
-				return $converter->relative_to_context( $item );
-			}, $value ) );
-
-		}
-
-		return $this->post_process( $jsonld );
-	}
-
-	/**
-	 * If the provided array of values contains only one value, then one single
-	 * value is returned, otherwise the original array is returned.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 *
-	 * @param array $value An array of values.
-	 *
-	 * @return mixed|array A single value or the original array.
-	 */
-	private function make_one( $value ) {
-
-		return 1 === count( $value ) ? $value[0] : $value;
-	}
-
-	/**
-	 * Post process the generated JSON to reorganize values which are stored as 1st
-	 * level in WP but are really 2nd level.
-	 *
-	 * @since 3.8.0
-	 *
-	 * @param array $jsonld An array of JSON-LD properties and values.
-	 *
-	 * @return array The array remapped.
-	 */
-	private function post_process( $jsonld ) {
-
-		foreach ( $jsonld as $key => $value ) {
-			if ( 'streetAddress' === $key || 'postalCode' === $key || 'addressLocality' === $key || 'addressRegion' === $key || 'addressCountry' === $key || 'postOfficeBoxNumber' === $key ) {
-				$jsonld['address']['@type'] = 'PostalAddress';
-				$jsonld['address'][ $key ]  = $value;
-				unset( $jsonld[ $key ] );
-			}
-
-			if ( 'latitude' === $key || 'longitude' === $key ) {
-				$jsonld['geo']['@type'] = 'GeoCoordinates';
-				$jsonld['geo'][ $key ]  = $value;
-				unset( $jsonld[ $key ] );
-			}
-
-			if ( 'calories' === $key ) {
-				$jsonld['nutrition']['@type'] = 'NutritionInformation';
-				$jsonld['nutrition'][ $key ]  = $value;
-				unset( $jsonld[ $key ] );
-			}
-		}
-
-		return $jsonld;
-	}
+    /**
+     * A {@link Wordlift_Property_Getter} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var \Wordlift_Property_Getter $property_getter A {@link Wordlift_Property_Getter} instance.
+     */
+    private $property_getter;
+
+    /**
+     * Wordlift_Entity_To_Jsonld_Converter constructor.
+     *
+     * @since 3.8.0
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     * @param \Wordlift_Entity_Service      $entity_service      A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_User_Service        $user_service        A {@link Wordlift_User_Service} instance.
+     * @param \Wordlift_Attachment_Service  $attachment_service  A {@link Wordlift_Attachment_Service} instance.
+     * @param \Wordlift_Property_Getter     $property_getter     A {@link Wordlift_Property_Getter} instance.
+     */
+    public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service, $property_getter ) {
+        parent::__construct( $entity_type_service, $entity_service, $user_service, $attachment_service );
+
+        $this->property_getter = $property_getter;
+
+    }
+
+    /**
+     * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
+     * found while processing the post is set in the $references array.
+     *
+     * @since 3.8.0
+     *
+     * @param int   $post_id    The {@link WP_Post} id.
+     *
+     * @param array $references An array of entity references.
+     *
+     * @return array A JSON-LD array.
+     */
+    public function convert( $post_id, &$references = array() ) {
+
+        // Get the post instance.
+        $post = get_post( $post_id );
+        if ( null === $post ) {
+            // Post not found.
+            return null;
+        }
+
+        // Get the base JSON-LD and the list of entities referenced by this entity.
+        $jsonld = parent::convert( $post_id, $references );
+
+        // Get the entity name.
+        $jsonld['name'] = $post->post_title;
+
+        // 3.13.0, add alternate names.
+        $alternative_labels = $this->entity_service->get_alternative_labels( $post_id );
+        if ( 0 < count( $alternative_labels ) ) {
+            $jsonld['alternateName'] = $alternative_labels;
+        }
+
+        // Get the entity @type.
+        $type = $this->entity_type_service->get( $post_id );
+
+        // Get the configured type custom fields.
+        $fields = $type['custom_fields'];
+
+        // Set a reference to use in closures.
+        $converter = $this;
+
+        // Try each field on the entity.
+        foreach ( $fields as $key => $value ) {
+
+            // Get the predicate.
+            $name = $this->relative_to_context( $value['predicate'] );
+
+            // Get the value, the property service will get the right extractor
+            // for that property.
+            $value = $this->property_getter->get( $post->ID, $key );
+
+            if ( empty( $value ) ) {
+                continue;
+            }
+
+            // Map the value to the property name.
+            // If we got an array with just one value, we return that one value.
+            // If we got a Wordlift_Property_Entity_Reference we get the URL.
+            $jsonld[ $name ] = $this->make_one( array_map( function ( $item ) use ( $converter, &$references ) {
+
+                if ( $item instanceof Wordlift_Property_Entity_Reference ) {
+
+                    $url = $item->getURL();
+
+                    // The refactored converters require the entity id.
+                    $references[] = $item->getID();
+
+                    return array(
+                        '@id' => $url,
+                    );
+                }
+
+                return $converter->relative_to_context( $item );
+            }, $value ) );
+
+        }
+
+        return $this->post_process( $jsonld );
+    }
+
+    /**
+     * If the provided array of values contains only one value, then one single
+     * value is returned, otherwise the original array is returned.
+     *
+     * @since  3.8.0
+     * @access private
+     *
+     * @param array $value An array of values.
+     *
+     * @return mixed|array A single value or the original array.
+     */
+    private function make_one( $value ) {
+
+        return 1 === count( $value ) ? $value[0] : $value;
+    }
+
+    /**
+     * Post process the generated JSON to reorganize values which are stored as 1st
+     * level in WP but are really 2nd level.
+     *
+     * @since 3.8.0
+     *
+     * @param array $jsonld An array of JSON-LD properties and values.
+     *
+     * @return array The array remapped.
+     */
+    private function post_process( $jsonld ) {
+
+        foreach ( $jsonld as $key => $value ) {
+            if ( 'streetAddress' === $key || 'postalCode' === $key || 'addressLocality' === $key || 'addressRegion' === $key || 'addressCountry' === $key || 'postOfficeBoxNumber' === $key ) {
+                $jsonld['address']['@type'] = 'PostalAddress';
+                $jsonld['address'][ $key ]  = $value;
+                unset( $jsonld[ $key ] );
+            }
+
+            if ( 'latitude' === $key || 'longitude' === $key ) {
+                $jsonld['geo']['@type'] = 'GeoCoordinates';
+                $jsonld['geo'][ $key ]  = $value;
+                unset( $jsonld[ $key ] );
+            }
+
+            if ( 'calories' === $key ) {
+                $jsonld['nutrition']['@type'] = 'NutritionInformation';
+                $jsonld['nutrition'][ $key ]  = $value;
+                unset( $jsonld[ $key ] );
+            }
+        }
+
+        return $jsonld;
+    }
 
 }

Spacing +31 added lines, -31 removed lines

@@ -33,8 +33,8 @@ 
 	 * @param \Wordlift_Attachment_Service  $attachment_service  A {@link Wordlift_Attachment_Service} instance.
 	 * @param \Wordlift_Property_Getter     $property_getter     A {@link Wordlift_Property_Getter} instance.
 	 */
-	public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service, $property_getter ) {
-		parent::__construct( $entity_type_service, $entity_service, $user_service, $attachment_service );
+	public function __construct($entity_type_service, $entity_service, $user_service, $attachment_service, $property_getter) {
+		parent::__construct($entity_type_service, $entity_service, $user_service, $attachment_service);
 
 		$this->property_getter = $property_getter;
 
@@ -52,29 +52,29 @@ 
 	 *
 	 * @return array A JSON-LD array.
 	 */
-	public function convert( $post_id, &$references = array() ) {
+	public function convert($post_id, &$references = array()) {
 
 		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
+		$post = get_post($post_id);
+		if (null === $post) {
 			// Post not found.
 			return null;
 		}
 
 		// Get the base JSON-LD and the list of entities referenced by this entity.
-		$jsonld = parent::convert( $post_id, $references );
+		$jsonld = parent::convert($post_id, $references);
 
 		// Get the entity name.
 		$jsonld['name'] = $post->post_title;
 
 		// 3.13.0, add alternate names.
-		$alternative_labels = $this->entity_service->get_alternative_labels( $post_id );
-		if ( 0 < count( $alternative_labels ) ) {
+		$alternative_labels = $this->entity_service->get_alternative_labels($post_id);
+		if (0 < count($alternative_labels)) {
 			$jsonld['alternateName'] = $alternative_labels;
 		}
 
 		// Get the entity @type.
-		$type = $this->entity_type_service->get( $post_id );
+		$type = $this->entity_type_service->get($post_id);
 
 		// Get the configured type custom fields.
 		$fields = $type['custom_fields'];
@@ -83,25 +83,25 @@ 
 		$converter = $this;
 
 		// Try each field on the entity.
-		foreach ( $fields as $key => $value ) {
+		foreach ($fields as $key => $value) {
 
 			// Get the predicate.
-			$name = $this->relative_to_context( $value['predicate'] );
+			$name = $this->relative_to_context($value['predicate']);
 
 			// Get the value, the property service will get the right extractor
 			// for that property.
-			$value = $this->property_getter->get( $post->ID, $key );
+			$value = $this->property_getter->get($post->ID, $key);
 
-			if ( empty( $value ) ) {
+			if (empty($value)) {
 				continue;
 			}
 
 			// Map the value to the property name.
 			// If we got an array with just one value, we return that one value.
 			// If we got a Wordlift_Property_Entity_Reference we get the URL.
-			$jsonld[ $name ] = $this->make_one( array_map( function ( $item ) use ( $converter, &$references ) {
+			$jsonld[$name] = $this->make_one(array_map(function($item) use ($converter, &$references) {
 
-				if ( $item instanceof Wordlift_Property_Entity_Reference ) {
+				if ($item instanceof Wordlift_Property_Entity_Reference) {
 
 					$url = $item->getURL();
 
@@ -113,12 +113,12 @@ 
 					);
 				}
 
-				return $converter->relative_to_context( $item );
-			}, $value ) );
+				return $converter->relative_to_context($item);
+			}, $value));
 
 		}
 
-		return $this->post_process( $jsonld );
+		return $this->post_process($jsonld);
 	}
 
 	/**
@@ -132,9 +132,9 @@ 
 	 *
 	 * @return mixed|array A single value or the original array.
 	 */
-	private function make_one( $value ) {
+	private function make_one($value) {
 
-		return 1 === count( $value ) ? $value[0] : $value;
+		return 1 === count($value) ? $value[0] : $value;
 	}
 
 	/**
@@ -147,25 +147,25 @@ 
 	 *
 	 * @return array The array remapped.
 	 */
-	private function post_process( $jsonld ) {
+	private function post_process($jsonld) {
 
-		foreach ( $jsonld as $key => $value ) {
-			if ( 'streetAddress' === $key || 'postalCode' === $key || 'addressLocality' === $key || 'addressRegion' === $key || 'addressCountry' === $key || 'postOfficeBoxNumber' === $key ) {
+		foreach ($jsonld as $key => $value) {
+			if ('streetAddress' === $key || 'postalCode' === $key || 'addressLocality' === $key || 'addressRegion' === $key || 'addressCountry' === $key || 'postOfficeBoxNumber' === $key) {
 				$jsonld['address']['@type'] = 'PostalAddress';
-				$jsonld['address'][ $key ]  = $value;
-				unset( $jsonld[ $key ] );
+				$jsonld['address'][$key]  = $value;
+				unset($jsonld[$key]);
 			}
 
-			if ( 'latitude' === $key || 'longitude' === $key ) {
+			if ('latitude' === $key || 'longitude' === $key) {
 				$jsonld['geo']['@type'] = 'GeoCoordinates';
-				$jsonld['geo'][ $key ]  = $value;
-				unset( $jsonld[ $key ] );
+				$jsonld['geo'][$key]  = $value;
+				unset($jsonld[$key]);
 			}
 
-			if ( 'calories' === $key ) {
+			if ('calories' === $key) {
 				$jsonld['nutrition']['@type'] = 'NutritionInformation';
-				$jsonld['nutrition'][ $key ]  = $value;
-				unset( $jsonld[ $key ] );
+				$jsonld['nutrition'][$key]  = $value;
+				unset($jsonld[$key]);
 			}
 		}
 

src/shortcodes/wordlift_shortcode_faceted_search.php

Indentation +158 added lines, -158 removed lines

@@ -14,74 +14,74 @@ 
  */
 function wl_shortcode_faceted_search( $atts ) {
 
-	// Extract attributes and set default values.
-	$shortcode_atts = shortcode_atts( array(
-		'title'          => __( 'Related articles', 'wordlift' ),
-		'show_facets'    => true,
-		'with_carousel'  => true,
-		'squared_thumbs' => false,
-		'limit'          => 20,
-
-	), $atts );
-
-	foreach (
-		array(
-			'show_facets',
-			'with_carousel',
-			'squared_thumbs',
-		) as $att
-	) {
-
-		// See http://wordpress.stackexchange.com/questions/119294/pass-boolean-value-in-shortcode.
-		$shortcode_atts[ $att ] = filter_var(
-			$shortcode_atts[ $att ], FILTER_VALIDATE_BOOLEAN
-		);
-	}
-
-	// If the current post is not an entity and has no related entities
-	// than the shortcode cannot be rendered
-	// TODO Add an alert visibile only for connected admin users.
-	$current_post = get_post();
-
-	$entity_service = Wordlift_Entity_Service::get_instance();
-	$entity_ids     = $entity_service->is_entity( $current_post->ID ) ?
-		array( $current_post->ID ) :
-		wl_core_get_related_entity_ids( $current_post->ID );
-
-	// Bail if there are no entity ids.
-	if ( 0 === count( $entity_ids ) ) {
-		return '';
-	}
-
-	$div_id = 'wordlift-faceted-entity-search-widget';
-
-	wp_enqueue_style( 'wordlift-faceted-search', dirname( plugin_dir_url( __FILE__ ) ) . '/css/wordlift-faceted-entity-search-widget.min.css' );
-	wp_enqueue_script( 'angularjs', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular.min.js' );
-	wp_enqueue_script( 'angularjs-touch', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular-touch.min.js' );
-
-	wp_enqueue_script( 'wordlift-faceted-search', dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-faceted-entity-search-widget.min.js' );
-
-	wp_localize_script(
-		'wordlift-faceted-search',
-		'wl_faceted_search_params', array(
-			'ajax_url'             => admin_url( 'admin-ajax.php' ),
-			'action'               => 'wl_faceted_search',
-			'post_id'              => $current_post->ID,
-			'entity_ids'           => $entity_ids,
-			'limit'                => apply_filters( 'wl_faceted_search_limit', $shortcode_atts['limit'] ),
-			'div_id'               => $div_id,
-			'defaultThumbnailPath' => WL_DEFAULT_THUMBNAIL_PATH,
-			'attrs'                => $shortcode_atts,
-			'l10n'                 => array(
-				'what'  => _x( 'What', 'Faceted Search Widget', 'wordlift' ),
-				'who'   => _x( 'Who', 'Faceted Search Widget', 'wordlift' ),
-				'where' => _x( 'Where', 'Faceted Search Widget', 'wordlift' ),
-				'when'  => _x( 'When', 'Faceted Search Widget', 'wordlift' ),
-			),
-		)
-	);
-
-	return '<div id="' . $div_id . '" style="width:100%"></div>';
+    // Extract attributes and set default values.
+    $shortcode_atts = shortcode_atts( array(
+        'title'          => __( 'Related articles', 'wordlift' ),
+        'show_facets'    => true,
+        'with_carousel'  => true,
+        'squared_thumbs' => false,
+        'limit'          => 20,
+
+    ), $atts );
+
+    foreach (
+        array(
+            'show_facets',
+            'with_carousel',
+            'squared_thumbs',
+        ) as $att
+    ) {
+
+        // See http://wordpress.stackexchange.com/questions/119294/pass-boolean-value-in-shortcode.
+        $shortcode_atts[ $att ] = filter_var(
+            $shortcode_atts[ $att ], FILTER_VALIDATE_BOOLEAN
+        );
+    }
+
+    // If the current post is not an entity and has no related entities
+    // than the shortcode cannot be rendered
+    // TODO Add an alert visibile only for connected admin users.
+    $current_post = get_post();
+
+    $entity_service = Wordlift_Entity_Service::get_instance();
+    $entity_ids     = $entity_service->is_entity( $current_post->ID ) ?
+        array( $current_post->ID ) :
+        wl_core_get_related_entity_ids( $current_post->ID );
+
+    // Bail if there are no entity ids.
+    if ( 0 === count( $entity_ids ) ) {
+        return '';
+    }
+
+    $div_id = 'wordlift-faceted-entity-search-widget';
+
+    wp_enqueue_style( 'wordlift-faceted-search', dirname( plugin_dir_url( __FILE__ ) ) . '/css/wordlift-faceted-entity-search-widget.min.css' );
+    wp_enqueue_script( 'angularjs', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular.min.js' );
+    wp_enqueue_script( 'angularjs-touch', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular-touch.min.js' );
+
+    wp_enqueue_script( 'wordlift-faceted-search', dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-faceted-entity-search-widget.min.js' );
+
+    wp_localize_script(
+        'wordlift-faceted-search',
+        'wl_faceted_search_params', array(
+            'ajax_url'             => admin_url( 'admin-ajax.php' ),
+            'action'               => 'wl_faceted_search',
+            'post_id'              => $current_post->ID,
+            'entity_ids'           => $entity_ids,
+            'limit'                => apply_filters( 'wl_faceted_search_limit', $shortcode_atts['limit'] ),
+            'div_id'               => $div_id,
+            'defaultThumbnailPath' => WL_DEFAULT_THUMBNAIL_PATH,
+            'attrs'                => $shortcode_atts,
+            'l10n'                 => array(
+                'what'  => _x( 'What', 'Faceted Search Widget', 'wordlift' ),
+                'who'   => _x( 'Who', 'Faceted Search Widget', 'wordlift' ),
+                'where' => _x( 'Where', 'Faceted Search Widget', 'wordlift' ),
+                'when'  => _x( 'When', 'Faceted Search Widget', 'wordlift' ),
+            ),
+        )
+    );
+
+    return '<div id="' . $div_id . '" style="width:100%"></div>';
 }
 
 add_shortcode( 'wl_faceted_search', 'wl_shortcode_faceted_search' );
@@ -92,106 +92,106 @@ 
  */
 function wl_shortcode_faceted_search_ajax( $http_raw_data = null ) {
 
-	// Post ID must be defined.
-	if ( ! isset( $_GET['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
-		wp_die( 'No post_id given' );
+    // Post ID must be defined.
+    if ( ! isset( $_GET['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
+        wp_die( 'No post_id given' );
 
-		return;
-	}
+        return;
+    }
 
-	// Extract filtering conditions.
-	$filtering_entity_uris = ( null == $http_raw_data ) ? file_get_contents( 'php://input' ) : $http_raw_data;
-	$filtering_entity_uris = json_decode( $filtering_entity_uris );
+    // Extract filtering conditions.
+    $filtering_entity_uris = ( null == $http_raw_data ) ? file_get_contents( 'php://input' ) : $http_raw_data;
+    $filtering_entity_uris = json_decode( $filtering_entity_uris );
 
-	$current_post_id = $_GET['post_id']; // WPCS: input var ok; CSRF ok.
-	$current_post    = get_post( $current_post_id );
+    $current_post_id = $_GET['post_id']; // WPCS: input var ok; CSRF ok.
+    $current_post    = get_post( $current_post_id );
 
-	// Post ID has to match an existing item.
-	if ( null === $current_post ) {
-		wp_die( 'No valid post_id given' );
+    // Post ID has to match an existing item.
+    if ( null === $current_post ) {
+        wp_die( 'No valid post_id given' );
 
-		return;
-	}
+        return;
+    }
 
-	// If the current post is an entity,
-	// the current post is used as main entity.
-	// Otherwise, current post related entities are used.
-	$entity_service = Wordlift_Entity_Service::get_instance();
-	$entity_ids     = $entity_service->is_entity( $current_post->ID ) ?
-		array( $current_post->ID ) :
-		wl_core_get_related_entity_ids( $current_post->ID );
+    // If the current post is an entity,
+    // the current post is used as main entity.
+    // Otherwise, current post related entities are used.
+    $entity_service = Wordlift_Entity_Service::get_instance();
+    $entity_ids     = $entity_service->is_entity( $current_post->ID ) ?
+        array( $current_post->ID ) :
+        wl_core_get_related_entity_ids( $current_post->ID );
 
-	// If there are no entities we cannot render the widget.
-	if ( 0 === count( $entity_ids ) ) {
-		wp_die( 'No entities available' );
+    // If there are no entities we cannot render the widget.
+    if ( 0 === count( $entity_ids ) ) {
+        wp_die( 'No entities available' );
 
-		return;
-	}
+        return;
+    }
 
-	// Retrieve requested type
-	$required_type = ( isset( $_GET['type'] ) ) ? $_GET['type'] : null; // WPCS: input var ok; CSRF ok.
+    // Retrieve requested type
+    $required_type = ( isset( $_GET['type'] ) ) ? $_GET['type'] : null; // WPCS: input var ok; CSRF ok.
 
-	$limit = ( isset( $_GET['limit'] ) ) ? (int) $_GET['limit'] : 20;  // WPCS: input var ok; CSRF ok.
+    $limit = ( isset( $_GET['limit'] ) ) ? (int) $_GET['limit'] : 20;  // WPCS: input var ok; CSRF ok.
 
-	$referencing_posts = Wordlift_Relation_Service::get_instance()->get_article_subjects(
-		$entity_ids,
-		'*',
-		null,
-		'publish',
-		array( $current_post_id ),
-		$limit
-	);
+    $referencing_posts = Wordlift_Relation_Service::get_instance()->get_article_subjects(
+        $entity_ids,
+        '*',
+        null,
+        'publish',
+        array( $current_post_id ),
+        $limit
+    );
 
-	$referencing_post_ids = array_map( function ( $p ) {
-		return $p->ID;
-	}, $referencing_posts );
-	$results              = array();
+    $referencing_post_ids = array_map( function ( $p ) {
+        return $p->ID;
+    }, $referencing_posts );
+    $results              = array();
 
-	if ( 'posts' === $required_type ) {
+    if ( 'posts' === $required_type ) {
 
-		// Required filtered posts.
-		wl_write_log( "Going to find related posts for the current post [ post ID :: $current_post_id ]" );
+        // Required filtered posts.
+        wl_write_log( "Going to find related posts for the current post [ post ID :: $current_post_id ]" );
 
-		$filtered_posts = ( empty( $filtering_entity_uris ) ) ?
-			$referencing_posts :
-			Wordlift_Relation_Service::get_instance()->get_article_subjects(
-				wl_get_entity_post_ids_by_uris( $filtering_entity_uris ),
-				'*',
-				null,
-				null,
-				array(),
-				null,
-				$referencing_post_ids
-			);
+        $filtered_posts = ( empty( $filtering_entity_uris ) ) ?
+            $referencing_posts :
+            Wordlift_Relation_Service::get_instance()->get_article_subjects(
+                wl_get_entity_post_ids_by_uris( $filtering_entity_uris ),
+                '*',
+                null,
+                null,
+                array(),
+                null,
+                $referencing_post_ids
+            );
 
-		if ( $filtered_posts ) {
-			foreach ( $filtered_posts as $post_obj ) {
+        if ( $filtered_posts ) {
+            foreach ( $filtered_posts as $post_obj ) {
 
-				$thumbnail           = wp_get_attachment_url( get_post_thumbnail_id( $post_obj->ID, 'thumbnail' ) );
-				$post_obj->thumbnail = ( $thumbnail ) ?
-					$thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-				$post_obj->permalink = get_post_permalink( $post_obj->ID );
+                $thumbnail           = wp_get_attachment_url( get_post_thumbnail_id( $post_obj->ID, 'thumbnail' ) );
+                $post_obj->thumbnail = ( $thumbnail ) ?
+                    $thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
+                $post_obj->permalink = get_post_permalink( $post_obj->ID );
 
-				$results[] = $post_obj;
-			}
-		}
-	} else {
+                $results[] = $post_obj;
+            }
+        }
+    } else {
 
-		global $wpdb;
+        global $wpdb;
 
-		wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ]" );
+        wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ]" );
 
-		// Retrieve Wordlift relation instances table name.
-		$table_name = wl_core_get_relation_instances_table_name();
+        // Retrieve Wordlift relation instances table name.
+        $table_name = wl_core_get_relation_instances_table_name();
 
-		/*
+        /*
 		 * Make sure we have some referenced post, otherwise the IN parts of
 		 * the SQL will produce an SQL error.
 		 */
-		if ( ! empty( $referencing_post_ids ) ) {
-			$subject_ids = implode( ',', $referencing_post_ids );
+        if ( ! empty( $referencing_post_ids ) ) {
+            $subject_ids = implode( ',', $referencing_post_ids );
 
-			$query = "
+            $query = "
 				SELECT
 					object_id AS ID,
 					count( object_id ) AS counter
@@ -203,29 +203,29 @@ 
 				LIMIT $limit;
 			";
 
-			wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
+            wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
 
-			$entities = $wpdb->get_results( $query, OBJECT ); // No cache ok.
+            $entities = $wpdb->get_results( $query, OBJECT ); // No cache ok.
 
-			wl_write_log( 'Entities found ' . count( $entities ) );
+            wl_write_log( 'Entities found ' . count( $entities ) );
 
-			foreach ( $entities as $obj ) {
+            foreach ( $entities as $obj ) {
 
-				$entity = get_post( $obj->ID );
-				// Ensure only valid and published entities are returned.
-				if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
+                $entity = get_post( $obj->ID );
+                // Ensure only valid and published entities are returned.
+                if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
 
-					$serialized_entity              = wl_serialize_entity( $entity );
-					$serialized_entity['counter']   = $obj->counter;
-					$serialized_entity['createdAt'] = $entity->post_date;
+                    $serialized_entity              = wl_serialize_entity( $entity );
+                    $serialized_entity['counter']   = $obj->counter;
+                    $serialized_entity['createdAt'] = $entity->post_date;
 
-					$results[] = $serialized_entity;
-				}
-			}
-		}
-	}
+                    $results[] = $serialized_entity;
+                }
+            }
+        }
+    }
 
-	wl_core_send_json( $results );
+    wl_core_send_json( $results );
 
 }
 

Spacing +61 added lines, -64 removed lines

@@ -12,17 +12,17 @@ 
  *
  * @param array $atts Shortcode attributes.
  */
-function wl_shortcode_faceted_search( $atts ) {
+function wl_shortcode_faceted_search($atts) {
 
 	// Extract attributes and set default values.
-	$shortcode_atts = shortcode_atts( array(
-		'title'          => __( 'Related articles', 'wordlift' ),
+	$shortcode_atts = shortcode_atts(array(
+		'title'          => __('Related articles', 'wordlift'),
 		'show_facets'    => true,
 		'with_carousel'  => true,
 		'squared_thumbs' => false,
 		'limit'          => 20,
 
-	), $atts );
+	), $atts);
 
 	foreach (
 		array(
@@ -33,8 +33,8 @@ 
 	) {
 
 		// See http://wordpress.stackexchange.com/questions/119294/pass-boolean-value-in-shortcode.
-		$shortcode_atts[ $att ] = filter_var(
-			$shortcode_atts[ $att ], FILTER_VALIDATE_BOOLEAN
+		$shortcode_atts[$att] = filter_var(
+			$shortcode_atts[$att], FILTER_VALIDATE_BOOLEAN
 		);
 	}
 
@@ -44,71 +44,70 @@ 
 	$current_post = get_post();
 
 	$entity_service = Wordlift_Entity_Service::get_instance();
-	$entity_ids     = $entity_service->is_entity( $current_post->ID ) ?
-		array( $current_post->ID ) :
-		wl_core_get_related_entity_ids( $current_post->ID );
+	$entity_ids     = $entity_service->is_entity($current_post->ID) ?
+		array($current_post->ID) : wl_core_get_related_entity_ids($current_post->ID);
 
 	// Bail if there are no entity ids.
-	if ( 0 === count( $entity_ids ) ) {
+	if (0 === count($entity_ids)) {
 		return '';
 	}
 
 	$div_id = 'wordlift-faceted-entity-search-widget';
 
-	wp_enqueue_style( 'wordlift-faceted-search', dirname( plugin_dir_url( __FILE__ ) ) . '/css/wordlift-faceted-entity-search-widget.min.css' );
-	wp_enqueue_script( 'angularjs', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular.min.js' );
-	wp_enqueue_script( 'angularjs-touch', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular-touch.min.js' );
+	wp_enqueue_style('wordlift-faceted-search', dirname(plugin_dir_url(__FILE__)).'/css/wordlift-faceted-entity-search-widget.min.css');
+	wp_enqueue_script('angularjs', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular.min.js');
+	wp_enqueue_script('angularjs-touch', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular-touch.min.js');
 
-	wp_enqueue_script( 'wordlift-faceted-search', dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-faceted-entity-search-widget.min.js' );
+	wp_enqueue_script('wordlift-faceted-search', dirname(plugin_dir_url(__FILE__)).'/js/wordlift-faceted-entity-search-widget.min.js');
 
 	wp_localize_script(
 		'wordlift-faceted-search',
 		'wl_faceted_search_params', array(
-			'ajax_url'             => admin_url( 'admin-ajax.php' ),
+			'ajax_url'             => admin_url('admin-ajax.php'),
 			'action'               => 'wl_faceted_search',
 			'post_id'              => $current_post->ID,
 			'entity_ids'           => $entity_ids,
-			'limit'                => apply_filters( 'wl_faceted_search_limit', $shortcode_atts['limit'] ),
+			'limit'                => apply_filters('wl_faceted_search_limit', $shortcode_atts['limit']),
 			'div_id'               => $div_id,
 			'defaultThumbnailPath' => WL_DEFAULT_THUMBNAIL_PATH,
 			'attrs'                => $shortcode_atts,
 			'l10n'                 => array(
-				'what'  => _x( 'What', 'Faceted Search Widget', 'wordlift' ),
-				'who'   => _x( 'Who', 'Faceted Search Widget', 'wordlift' ),
-				'where' => _x( 'Where', 'Faceted Search Widget', 'wordlift' ),
-				'when'  => _x( 'When', 'Faceted Search Widget', 'wordlift' ),
+				'what'  => _x('What', 'Faceted Search Widget', 'wordlift'),
+				'who'   => _x('Who', 'Faceted Search Widget', 'wordlift'),
+				'where' => _x('Where', 'Faceted Search Widget', 'wordlift'),
+				'when'  => _x('When', 'Faceted Search Widget', 'wordlift'),
 			),
 		)
 	);
 
-	return '<div id="' . $div_id . '" style="width:100%"></div>';
+	return '<div id="'.$div_id.'" style="width:100%"></div>';
 }
 
-add_shortcode( 'wl_faceted_search', 'wl_shortcode_faceted_search' );
+add_shortcode('wl_faceted_search', 'wl_shortcode_faceted_search');
 
 
 /**
  * Ajax call for the faceted search widget
  */
-function wl_shortcode_faceted_search_ajax( $http_raw_data = null ) {
+function wl_shortcode_faceted_search_ajax($http_raw_data = null) {
 
 	// Post ID must be defined.
-	if ( ! isset( $_GET['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
-		wp_die( 'No post_id given' );
+	if ( ! isset($_GET['post_id'])) { // WPCS: input var ok; CSRF ok.
+		wp_die('No post_id given');
 
 		return;
 	}
 
 	// Extract filtering conditions.
-	$filtering_entity_uris = ( null == $http_raw_data ) ? file_get_contents( 'php://input' ) : $http_raw_data;
-	$filtering_entity_uris = json_decode( $filtering_entity_uris );
+	$filtering_entity_uris = (null == $http_raw_data) ? file_get_contents('php://input') : $http_raw_data;
+	$filtering_entity_uris = json_decode($filtering_entity_uris);
 
 	$current_post_id = $_GET['post_id']; // WPCS: input var ok; CSRF ok.
-	$current_post    = get_post( $current_post_id );
+	$current_post    = get_post($current_post_id);
 
 	// Post ID has to match an existing item.
-	if ( null === $current_post ) {
-		wp_die( 'No valid post_id given' );
+	if (null === $current_post) {
+		wp_die('No valid post_id given');
 
 		return;
 	}
@@ -117,45 +116,43 @@ 
 	// the current post is used as main entity.
 	// Otherwise, current post related entities are used.
 	$entity_service = Wordlift_Entity_Service::get_instance();
-	$entity_ids     = $entity_service->is_entity( $current_post->ID ) ?
-		array( $current_post->ID ) :
-		wl_core_get_related_entity_ids( $current_post->ID );
+	$entity_ids     = $entity_service->is_entity($current_post->ID) ?
+		array($current_post->ID) : wl_core_get_related_entity_ids($current_post->ID);
 
 	// If there are no entities we cannot render the widget.
-	if ( 0 === count( $entity_ids ) ) {
-		wp_die( 'No entities available' );
+	if (0 === count($entity_ids)) {
+		wp_die('No entities available');
 
 		return;
 	}
 
 	// Retrieve requested type
-	$required_type = ( isset( $_GET['type'] ) ) ? $_GET['type'] : null; // WPCS: input var ok; CSRF ok.
+	$required_type = (isset($_GET['type'])) ? $_GET['type'] : null; // WPCS: input var ok; CSRF ok.
 
-	$limit = ( isset( $_GET['limit'] ) ) ? (int) $_GET['limit'] : 20;  // WPCS: input var ok; CSRF ok.
+	$limit = (isset($_GET['limit'])) ? (int) $_GET['limit'] : 20; // WPCS: input var ok; CSRF ok.
 
 	$referencing_posts = Wordlift_Relation_Service::get_instance()->get_article_subjects(
 		$entity_ids,
 		'*',
 		null,
 		'publish',
-		array( $current_post_id ),
+		array($current_post_id),
 		$limit
 	);
 
-	$referencing_post_ids = array_map( function ( $p ) {
+	$referencing_post_ids = array_map(function($p) {
 		return $p->ID;
-	}, $referencing_posts );
+	}, $referencing_posts);
 	$results              = array();
 
-	if ( 'posts' === $required_type ) {
+	if ('posts' === $required_type) {
 
 		// Required filtered posts.
-		wl_write_log( "Going to find related posts for the current post [ post ID :: $current_post_id ]" );
+		wl_write_log("Going to find related posts for the current post [ post ID :: $current_post_id ]");
 
-		$filtered_posts = ( empty( $filtering_entity_uris ) ) ?
-			$referencing_posts :
-			Wordlift_Relation_Service::get_instance()->get_article_subjects(
-				wl_get_entity_post_ids_by_uris( $filtering_entity_uris ),
+		$filtered_posts = (empty($filtering_entity_uris)) ?
+			$referencing_posts : Wordlift_Relation_Service::get_instance()->get_article_subjects(
+				wl_get_entity_post_ids_by_uris($filtering_entity_uris),
 				'*',
 				null,
 				null,
@@ -164,13 +161,13 @@ 
 				$referencing_post_ids
 			);
 
-		if ( $filtered_posts ) {
-			foreach ( $filtered_posts as $post_obj ) {
+		if ($filtered_posts) {
+			foreach ($filtered_posts as $post_obj) {
 
-				$thumbnail           = wp_get_attachment_url( get_post_thumbnail_id( $post_obj->ID, 'thumbnail' ) );
-				$post_obj->thumbnail = ( $thumbnail ) ?
+				$thumbnail           = wp_get_attachment_url(get_post_thumbnail_id($post_obj->ID, 'thumbnail'));
+				$post_obj->thumbnail = ($thumbnail) ?
 					$thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-				$post_obj->permalink = get_post_permalink( $post_obj->ID );
+				$post_obj->permalink = get_post_permalink($post_obj->ID);
 
 				$results[] = $post_obj;
 			}
@@ -179,7 +176,7 @@ 
 
 		global $wpdb;
 
-		wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ]" );
+		wl_write_log("Going to find related entities for the current post [ post ID :: $current_post_id ]");
 
 		// Retrieve Wordlift relation instances table name.
 		$table_name = wl_core_get_relation_instances_table_name();
@@ -188,8 +185,8 @@ 
 		 * Make sure we have some referenced post, otherwise the IN parts of
 		 * the SQL will produce an SQL error.
 		 */
-		if ( ! empty( $referencing_post_ids ) ) {
-			$subject_ids = implode( ',', $referencing_post_ids );
+		if ( ! empty($referencing_post_ids)) {
+			$subject_ids = implode(',', $referencing_post_ids);
 
 			$query = "
 				SELECT
@@ -203,19 +200,19 @@ 
 				LIMIT $limit;
 			";
 
-			wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
+			wl_write_log("Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]");
 
-			$entities = $wpdb->get_results( $query, OBJECT ); // No cache ok.
+			$entities = $wpdb->get_results($query, OBJECT); // No cache ok.
 
-			wl_write_log( 'Entities found ' . count( $entities ) );
+			wl_write_log('Entities found '.count($entities));
 
-			foreach ( $entities as $obj ) {
+			foreach ($entities as $obj) {
 
-				$entity = get_post( $obj->ID );
+				$entity = get_post($obj->ID);
 				// Ensure only valid and published entities are returned.
-				if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
+				if ((null !== $entity) && ('publish' === $entity->post_status)) {
 
-					$serialized_entity              = wl_serialize_entity( $entity );
+					$serialized_entity              = wl_serialize_entity($entity);
 					$serialized_entity['counter']   = $obj->counter;
 					$serialized_entity['createdAt'] = $entity->post_date;
 
@@ -225,9 +222,9 @@ 
 		}
 	}
 
-	wl_core_send_json( $results );
+	wl_core_send_json($results);
 
 }
 
-add_action( 'wp_ajax_wl_faceted_search', 'wl_shortcode_faceted_search_ajax' );
-add_action( 'wp_ajax_nopriv_wl_faceted_search', 'wl_shortcode_faceted_search_ajax' );
+add_action('wp_ajax_wl_faceted_search', 'wl_shortcode_faceted_search_ajax');
+add_action('wp_ajax_nopriv_wl_faceted_search', 'wl_shortcode_faceted_search_ajax');

src/public/class-wordlift-vocabulary-shortcode.php

Indentation +239 added lines, -239 removed lines

@@ -18,121 +18,121 @@ 
  */
 class Wordlift_Vocabulary_Shortcode extends Wordlift_Shortcode {
 
-	/**
-	 * The shortcode.
-	 *
-	 * @since  3.17.0
-	 */
-	const SHORTCODE = 'wl_vocabulary';
-
-	/**
-	 * The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.17.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a {@link Wordlift_Glossary_Shortcode} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	public function __construct( $configuration_service ) {
-		parent::__construct();
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->configuration_service = $configuration_service;
-
-	}
-
-	/**
-	 * Check whether the requirements for this shortcode to work are available.
-	 *
-	 * @since 3.17.0
-	 * @return bool True if the requirements are satisfied otherwise false.
-	 */
-	private static function are_requirements_satisfied() {
-
-		return function_exists( 'mb_strlen' ) &&
-			   function_exists( 'mb_substr' ) &&
-			   function_exists( 'mb_convert_case' );
-	}
-
-	/**
-	 * Render the shortcode.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param array $atts An array of shortcode attributes as set by the editor.
-	 *
-	 * @return string The output html code.
-	 */
-	public function render( $atts ) {
-
-		// Bail out if the requirements aren't satisfied: we need mbstring for
-		// the vocabulary widget to work.
-		if ( ! self::are_requirements_satisfied() ) {
-			$this->log->warn( "The vocabulary widget cannot be displayed because this WordPress installation doesn't satisfy its requirements." );
-
-			return '';
-		}
-
-		wp_enqueue_style( 'wl-vocabulary-shortcode', dirname( plugin_dir_url( __FILE__ ) ) . '/public/css/wordlift-vocabulary-shortcode.css' );
-
-		// Extract attributes and set default values.
-		$atts = shortcode_atts( array(
-			// The entity type, such as `person`, `organization`, ...
-			'type'         => 'all',
-			// Limit the number of posts to 100 by default. Use -1 to remove the limit.
-			'limit'        => 100,
-			// Sort by title.
-			'orderby'      => 'title',
-		), $atts );
-
-		// Get the posts. Note that if a `type` is specified before, then the
-		// `tax_query` from the `add_criterias` call isn't added.
-		$posts = $this->get_posts( $atts );
-
-		// Get the alphabet.
-		$language_code = $this->configuration_service->get_language_code();
-		$alphabet      = Wordlift_Alphabet_Service::get( $language_code );
-
-		// Add posts to the alphabet.
-		foreach ( $posts as $post ) {
-			$this->add_to_alphabet( $alphabet, $post->ID );
-		}
-
-		// Generate the header.
-		$header = array_reduce( array_keys( $alphabet ), function ( $carry, $item ) use ( $alphabet ) {
-			$template = ( empty( $alphabet[ $item ] )
-				? '<span class="wl-vocabulary-widget-disabled">%s</span>'
-				: '<a href="#wl-vocabulary-widget-%2$s">%1$s</a>' );
-
-			return $carry . sprintf( $template, esc_html( $item ), esc_attr( $item ) );
-		}, '' );
-
-		// Generate the sections.
-		$that     = $this;
-		$sections = array_reduce( array_keys( $alphabet ), function ( $carry, $item ) use ( $alphabet, $that ) {
-			return $carry . $that->get_section( $item, $alphabet[ $item ] );
-		}, '' );
-
-		// Return HTML template.
-		return "
+    /**
+     * The shortcode.
+     *
+     * @since  3.17.0
+     */
+    const SHORTCODE = 'wl_vocabulary';
+
+    /**
+     * The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.17.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a {@link Wordlift_Glossary_Shortcode} instance.
+     *
+     * @since 3.16.0
+     *
+     * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    public function __construct( $configuration_service ) {
+        parent::__construct();
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->configuration_service = $configuration_service;
+
+    }
+
+    /**
+     * Check whether the requirements for this shortcode to work are available.
+     *
+     * @since 3.17.0
+     * @return bool True if the requirements are satisfied otherwise false.
+     */
+    private static function are_requirements_satisfied() {
+
+        return function_exists( 'mb_strlen' ) &&
+               function_exists( 'mb_substr' ) &&
+               function_exists( 'mb_convert_case' );
+    }
+
+    /**
+     * Render the shortcode.
+     *
+     * @since 3.16.0
+     *
+     * @param array $atts An array of shortcode attributes as set by the editor.
+     *
+     * @return string The output html code.
+     */
+    public function render( $atts ) {
+
+        // Bail out if the requirements aren't satisfied: we need mbstring for
+        // the vocabulary widget to work.
+        if ( ! self::are_requirements_satisfied() ) {
+            $this->log->warn( "The vocabulary widget cannot be displayed because this WordPress installation doesn't satisfy its requirements." );
+
+            return '';
+        }
+
+        wp_enqueue_style( 'wl-vocabulary-shortcode', dirname( plugin_dir_url( __FILE__ ) ) . '/public/css/wordlift-vocabulary-shortcode.css' );
+
+        // Extract attributes and set default values.
+        $atts = shortcode_atts( array(
+            // The entity type, such as `person`, `organization`, ...
+            'type'         => 'all',
+            // Limit the number of posts to 100 by default. Use -1 to remove the limit.
+            'limit'        => 100,
+            // Sort by title.
+            'orderby'      => 'title',
+        ), $atts );
+
+        // Get the posts. Note that if a `type` is specified before, then the
+        // `tax_query` from the `add_criterias` call isn't added.
+        $posts = $this->get_posts( $atts );
+
+        // Get the alphabet.
+        $language_code = $this->configuration_service->get_language_code();
+        $alphabet      = Wordlift_Alphabet_Service::get( $language_code );
+
+        // Add posts to the alphabet.
+        foreach ( $posts as $post ) {
+            $this->add_to_alphabet( $alphabet, $post->ID );
+        }
+
+        // Generate the header.
+        $header = array_reduce( array_keys( $alphabet ), function ( $carry, $item ) use ( $alphabet ) {
+            $template = ( empty( $alphabet[ $item ] )
+                ? '<span class="wl-vocabulary-widget-disabled">%s</span>'
+                : '<a href="#wl-vocabulary-widget-%2$s">%1$s</a>' );
+
+            return $carry . sprintf( $template, esc_html( $item ), esc_attr( $item ) );
+        }, '' );
+
+        // Generate the sections.
+        $that     = $this;
+        $sections = array_reduce( array_keys( $alphabet ), function ( $carry, $item ) use ( $alphabet, $that ) {
+            return $carry . $that->get_section( $item, $alphabet[ $item ] );
+        }, '' );
+
+        // Return HTML template.
+        return "
 <div class='wl-vocabulary'>
 	<nav class='wl-vocabulary-alphabet-nav'>
 		$header
@@ -143,28 +143,28 @@ 
 </div>
 		";
 
-	}
-
-	/**
-	 * Generate the html code for the section.
-	 *
-	 * @since 3.17.0
-	 *
-	 * @param string $letter The section's letter.
-	 * @param array  $posts  An array of `$post_id => $post_title` associated with
-	 *                       the section.
-	 *
-	 * @return string The section html code (or an empty string if the section has
-	 *                no posts).
-	 */
-	private function get_section( $letter, $posts ) {
-
-		// Return an empty string if there are no posts.
-		if ( 0 === count( $posts ) ) {
-			return '';
-		}
-
-		return sprintf( '
+    }
+
+    /**
+     * Generate the html code for the section.
+     *
+     * @since 3.17.0
+     *
+     * @param string $letter The section's letter.
+     * @param array  $posts  An array of `$post_id => $post_title` associated with
+     *                       the section.
+     *
+     * @return string The section html code (or an empty string if the section has
+     *                no posts).
+     */
+    private function get_section( $letter, $posts ) {
+
+        // Return an empty string if there are no posts.
+        if ( 0 === count( $posts ) ) {
+            return '';
+        }
+
+        return sprintf( '
 			<div class="wl-vocabulary-letter-block" id="wl-vocabulary-widget-%s">
 				<aside class="wl-vocabulary-left-column">%s</aside>
 				<div class="wl-vocabulary-right-column">
@@ -174,107 +174,107 @@ 
 				</div>
 			</div>
 		', esc_attr( $letter ), esc_html( $letter ), $this->format_posts_as_list( $posts ) );
-	}
-
-	/**
-	 * Format an array post `$post_id => $post_title` as a list.
-	 *
-	 * @since 3.17.0
-	 *
-	 * @param array $posts An array of `$post_id => $post_title` key, value pairs.
-	 *
-	 * @return string A list.
-	 */
-	private function format_posts_as_list( $posts ) {
-
-		return array_reduce( array_keys( $posts ), function ( $carry, $item ) use ( $posts ) {
-			return $carry . sprintf( '<li><a href="%s">%s</a></li>', esc_attr( get_permalink( $item ) ), esc_html( $posts[ $item ] ) );
-		}, '' );
-	}
-
-	/**
-	 * Get the posts from WordPress using the provided attributes.
-	 *
-	 * @since 3.17.0
-	 *
-	 * @param array $atts The shortcode attributes.
-	 *
-	 * @return array An array of {@link WP_Post}s.
-	 */
-	private function get_posts( $atts ) {
-
-		// The default arguments for the query.
-		$args = array(
-			'numberposts'            => intval( $atts['limit'] ),
-			'update_post_meta_cache' => false,
-			'update_post_term_cache' => false,
-			// Exclude the publisher.
-			'post__not_in' => array( $this->configuration_service->get_publisher_id() ),
-		);
-
-		// Limit the based entity type if needed.
-		if ( 'all' !== $atts['type'] ) {
-			$args['tax_query'] = array(
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'field'    => 'slug',
-					'terms'    => $atts['type'],
-				),
-			);
-		}
-
-		// Get the posts. Note that if a `type` is specified before, then the
-		// `tax_query` from the `add_criterias` call isn't added.
-		return get_posts( Wordlift_Entity_Service::add_criterias( $args ) );
-
-	}
-
-	/**
-	 * Populate the alphabet with posts.
-	 *
-	 * @since 3.17.0
-	 *
-	 * @param array $alphabet An array of letters.
-	 * @param int   $post_id  The {@link WP_Post} id.
-	 */
-	private function add_to_alphabet( &$alphabet, $post_id ) {
-
-		// Get the title without accents.
-		$title = remove_accents( get_the_title( $post_id ) );
-
-		// Get the initial letter.
-		$letter = $this->get_first_letter_in_alphabet_or_hash( $alphabet, $title );
-
-		// Add the post.
-		$alphabet[ $letter ][ $post_id ] = $title;
-
-	}
-
-	/**
-	 * Find the first letter in the alphabet.
-	 *
-	 * In some alphabets a letter is a compound of letters, therefore this function
-	 * will look for groups of 2 or 3 letters in the alphabet before looking for a
-	 * single letter. In case the letter is not found a # (hash) key is returned.
-	 *
-	 * @since 3.17.0
-	 *
-	 * @param array  $alphabet An array of alphabet letters.
-	 * @param string $title    The title to match.
-	 *
-	 * @return string The initial letter or a `#` key.
-	 */
-	private function get_first_letter_in_alphabet_or_hash( $alphabet, $title ) {
-
-		// Need to handle letters which consist of 3 and 2 characters.
-		for ( $i = 3; $i > 0; $i -- ) {
-			$letter = mb_convert_case( mb_substr( $title, 0, $i ), MB_CASE_UPPER );
-			if ( isset( $alphabet[ $letter ] ) ) {
-				return $letter;
-			}
-		}
-
-		return '#';
-	}
+    }
+
+    /**
+     * Format an array post `$post_id => $post_title` as a list.
+     *
+     * @since 3.17.0
+     *
+     * @param array $posts An array of `$post_id => $post_title` key, value pairs.
+     *
+     * @return string A list.
+     */
+    private function format_posts_as_list( $posts ) {
+
+        return array_reduce( array_keys( $posts ), function ( $carry, $item ) use ( $posts ) {
+            return $carry . sprintf( '<li><a href="%s">%s</a></li>', esc_attr( get_permalink( $item ) ), esc_html( $posts[ $item ] ) );
+        }, '' );
+    }
+
+    /**
+     * Get the posts from WordPress using the provided attributes.
+     *
+     * @since 3.17.0
+     *
+     * @param array $atts The shortcode attributes.
+     *
+     * @return array An array of {@link WP_Post}s.
+     */
+    private function get_posts( $atts ) {
+
+        // The default arguments for the query.
+        $args = array(
+            'numberposts'            => intval( $atts['limit'] ),
+            'update_post_meta_cache' => false,
+            'update_post_term_cache' => false,
+            // Exclude the publisher.
+            'post__not_in' => array( $this->configuration_service->get_publisher_id() ),
+        );
+
+        // Limit the based entity type if needed.
+        if ( 'all' !== $atts['type'] ) {
+            $args['tax_query'] = array(
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'field'    => 'slug',
+                    'terms'    => $atts['type'],
+                ),
+            );
+        }
+
+        // Get the posts. Note that if a `type` is specified before, then the
+        // `tax_query` from the `add_criterias` call isn't added.
+        return get_posts( Wordlift_Entity_Service::add_criterias( $args ) );
+
+    }
+
+    /**
+     * Populate the alphabet with posts.
+     *
+     * @since 3.17.0
+     *
+     * @param array $alphabet An array of letters.
+     * @param int   $post_id  The {@link WP_Post} id.
+     */
+    private function add_to_alphabet( &$alphabet, $post_id ) {
+
+        // Get the title without accents.
+        $title = remove_accents( get_the_title( $post_id ) );
+
+        // Get the initial letter.
+        $letter = $this->get_first_letter_in_alphabet_or_hash( $alphabet, $title );
+
+        // Add the post.
+        $alphabet[ $letter ][ $post_id ] = $title;
+
+    }
+
+    /**
+     * Find the first letter in the alphabet.
+     *
+     * In some alphabets a letter is a compound of letters, therefore this function
+     * will look for groups of 2 or 3 letters in the alphabet before looking for a
+     * single letter. In case the letter is not found a # (hash) key is returned.
+     *
+     * @since 3.17.0
+     *
+     * @param array  $alphabet An array of alphabet letters.
+     * @param string $title    The title to match.
+     *
+     * @return string The initial letter or a `#` key.
+     */
+    private function get_first_letter_in_alphabet_or_hash( $alphabet, $title ) {
+
+        // Need to handle letters which consist of 3 and 2 characters.
+        for ( $i = 3; $i > 0; $i -- ) {
+            $letter = mb_convert_case( mb_substr( $title, 0, $i ), MB_CASE_UPPER );
+            if ( isset( $alphabet[ $letter ] ) ) {
+                return $letter;
+            }
+        }
+
+        return '#';
+    }
 
 }

Spacing +44 added lines, -44 removed lines

@@ -50,10 +50,10 @@ 
 	 *
 	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
 	 */
-	public function __construct( $configuration_service ) {
+	public function __construct($configuration_service) {
 		parent::__construct();
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->configuration_service = $configuration_service;
 
@@ -67,9 +67,9 @@ 
 	 */
 	private static function are_requirements_satisfied() {
 
-		return function_exists( 'mb_strlen' ) &&
-			   function_exists( 'mb_substr' ) &&
-			   function_exists( 'mb_convert_case' );
+		return function_exists('mb_strlen') &&
+			   function_exists('mb_substr') &&
+			   function_exists('mb_convert_case');
 	}
 
 	/**
@@ -81,55 +81,55 @@ 
 	 *
 	 * @return string The output html code.
 	 */
-	public function render( $atts ) {
+	public function render($atts) {
 
 		// Bail out if the requirements aren't satisfied: we need mbstring for
 		// the vocabulary widget to work.
-		if ( ! self::are_requirements_satisfied() ) {
-			$this->log->warn( "The vocabulary widget cannot be displayed because this WordPress installation doesn't satisfy its requirements." );
+		if ( ! self::are_requirements_satisfied()) {
+			$this->log->warn("The vocabulary widget cannot be displayed because this WordPress installation doesn't satisfy its requirements.");
 
 			return '';
 		}
 
-		wp_enqueue_style( 'wl-vocabulary-shortcode', dirname( plugin_dir_url( __FILE__ ) ) . '/public/css/wordlift-vocabulary-shortcode.css' );
+		wp_enqueue_style('wl-vocabulary-shortcode', dirname(plugin_dir_url(__FILE__)).'/public/css/wordlift-vocabulary-shortcode.css');
 
 		// Extract attributes and set default values.
-		$atts = shortcode_atts( array(
+		$atts = shortcode_atts(array(
 			// The entity type, such as `person`, `organization`, ...
 			'type'         => 'all',
 			// Limit the number of posts to 100 by default. Use -1 to remove the limit.
 			'limit'        => 100,
 			// Sort by title.
 			'orderby'      => 'title',
-		), $atts );
+		), $atts);
 
 		// Get the posts. Note that if a `type` is specified before, then the
 		// `tax_query` from the `add_criterias` call isn't added.
-		$posts = $this->get_posts( $atts );
+		$posts = $this->get_posts($atts);
 
 		// Get the alphabet.
 		$language_code = $this->configuration_service->get_language_code();
-		$alphabet      = Wordlift_Alphabet_Service::get( $language_code );
+		$alphabet      = Wordlift_Alphabet_Service::get($language_code);
 
 		// Add posts to the alphabet.
-		foreach ( $posts as $post ) {
-			$this->add_to_alphabet( $alphabet, $post->ID );
+		foreach ($posts as $post) {
+			$this->add_to_alphabet($alphabet, $post->ID);
 		}
 
 		// Generate the header.
-		$header = array_reduce( array_keys( $alphabet ), function ( $carry, $item ) use ( $alphabet ) {
-			$template = ( empty( $alphabet[ $item ] )
+		$header = array_reduce(array_keys($alphabet), function($carry, $item) use ($alphabet) {
+			$template = (empty($alphabet[$item])
 				? '<span class="wl-vocabulary-widget-disabled">%s</span>'
-				: '<a href="#wl-vocabulary-widget-%2$s">%1$s</a>' );
+				: '<a href="#wl-vocabulary-widget-%2$s">%1$s</a>');
 
-			return $carry . sprintf( $template, esc_html( $item ), esc_attr( $item ) );
-		}, '' );
+			return $carry.sprintf($template, esc_html($item), esc_attr($item));
+		}, '');
 
 		// Generate the sections.
 		$that     = $this;
-		$sections = array_reduce( array_keys( $alphabet ), function ( $carry, $item ) use ( $alphabet, $that ) {
-			return $carry . $that->get_section( $item, $alphabet[ $item ] );
-		}, '' );
+		$sections = array_reduce(array_keys($alphabet), function($carry, $item) use ($alphabet, $that) {
+			return $carry.$that->get_section($item, $alphabet[$item]);
+		}, '');
 
 		// Return HTML template.
 		return "
@@ -157,14 +157,14 @@ 
 	 * @return string The section html code (or an empty string if the section has
 	 *                no posts).
 	 */
-	private function get_section( $letter, $posts ) {
+	private function get_section($letter, $posts) {
 
 		// Return an empty string if there are no posts.
-		if ( 0 === count( $posts ) ) {
+		if (0 === count($posts)) {
 			return '';
 		}
 
-		return sprintf( '
+		return sprintf('
 			<div class="wl-vocabulary-letter-block" id="wl-vocabulary-widget-%s">
 				<aside class="wl-vocabulary-left-column">%s</aside>
 				<div class="wl-vocabulary-right-column">
@@ -173,7 +173,7 @@ 
 					</ul>
 				</div>
 			</div>
-		', esc_attr( $letter ), esc_html( $letter ), $this->format_posts_as_list( $posts ) );
+		', esc_attr($letter), esc_html($letter), $this->format_posts_as_list($posts));
 	}
 
 	/**
@@ -185,11 +185,11 @@ 
 	 *
 	 * @return string A list.
 	 */
-	private function format_posts_as_list( $posts ) {
+	private function format_posts_as_list($posts) {
 
-		return array_reduce( array_keys( $posts ), function ( $carry, $item ) use ( $posts ) {
-			return $carry . sprintf( '<li><a href="%s">%s</a></li>', esc_attr( get_permalink( $item ) ), esc_html( $posts[ $item ] ) );
-		}, '' );
+		return array_reduce(array_keys($posts), function($carry, $item) use ($posts) {
+			return $carry.sprintf('<li><a href="%s">%s</a></li>', esc_attr(get_permalink($item)), esc_html($posts[$item]));
+		}, '');
 	}
 
 	/**
@@ -201,19 +201,19 @@ 
 	 *
 	 * @return array An array of {@link WP_Post}s.
 	 */
-	private function get_posts( $atts ) {
+	private function get_posts($atts) {
 
 		// The default arguments for the query.
 		$args = array(
-			'numberposts'            => intval( $atts['limit'] ),
+			'numberposts'            => intval($atts['limit']),
 			'update_post_meta_cache' => false,
 			'update_post_term_cache' => false,
 			// Exclude the publisher.
-			'post__not_in' => array( $this->configuration_service->get_publisher_id() ),
+			'post__not_in' => array($this->configuration_service->get_publisher_id()),
 		);
 
 		// Limit the based entity type if needed.
-		if ( 'all' !== $atts['type'] ) {
+		if ('all' !== $atts['type']) {
 			$args['tax_query'] = array(
 				array(
 					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
@@ -225,7 +225,7 @@ 
 
 		// Get the posts. Note that if a `type` is specified before, then the
 		// `tax_query` from the `add_criterias` call isn't added.
-		return get_posts( Wordlift_Entity_Service::add_criterias( $args ) );
+		return get_posts(Wordlift_Entity_Service::add_criterias($args));
 
 	}
 
@@ -237,16 +237,16 @@ 
 	 * @param array $alphabet An array of letters.
 	 * @param int   $post_id  The {@link WP_Post} id.
 	 */
-	private function add_to_alphabet( &$alphabet, $post_id ) {
+	private function add_to_alphabet(&$alphabet, $post_id) {
 
 		// Get the title without accents.
-		$title = remove_accents( get_the_title( $post_id ) );
+		$title = remove_accents(get_the_title($post_id));
 
 		// Get the initial letter.
-		$letter = $this->get_first_letter_in_alphabet_or_hash( $alphabet, $title );
+		$letter = $this->get_first_letter_in_alphabet_or_hash($alphabet, $title);
 
 		// Add the post.
-		$alphabet[ $letter ][ $post_id ] = $title;
+		$alphabet[$letter][$post_id] = $title;
 
 	}
 
@@ -264,12 +264,12 @@ 
 	 *
 	 * @return string The initial letter or a `#` key.
 	 */
-	private function get_first_letter_in_alphabet_or_hash( $alphabet, $title ) {
+	private function get_first_letter_in_alphabet_or_hash($alphabet, $title) {
 
 		// Need to handle letters which consist of 3 and 2 characters.
-		for ( $i = 3; $i > 0; $i -- ) {
-			$letter = mb_convert_case( mb_substr( $title, 0, $i ), MB_CASE_UPPER );
-			if ( isset( $alphabet[ $letter ] ) ) {
+		for ($i = 3; $i > 0; $i--) {
+			$letter = mb_convert_case(mb_substr($title, 0, $i), MB_CASE_UPPER);
+			if (isset($alphabet[$letter])) {
 				return $letter;
 			}
 		}