insideout10 / wordlift-plugin

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

Doc Comments +1 added lines, -1 removed lines

@@ -482,7 +482,7 @@
 	 * @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.
+	 * @return integer 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' ) {
 

Indentation +542 added lines, -542 removed lines

@@ -7,461 +7,461 @@ 
  */
 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_Types_Taxonomy_Service::TAXONOMY_NAME );
-
-		if ( 0 === count( $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_Types_Taxonomy_Service::TAXONOMY_NAME,
-				'operator' => 'EXISTS',
-			),
-			array(
-				'taxonomy' => Wordlift_Entity_Types_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_Types_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_Types_Taxonomy_Service::TAXONOMY_NAME );
+
+        if ( 0 === count( $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_Types_Taxonomy_Service::TAXONOMY_NAME,
+                'operator' => 'EXISTS',
+            ),
+            array(
+                'taxonomy' => Wordlift_Entity_Types_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_Types_Taxonomy_Service::TAXONOMY_NAME,
+                //						'terms'    => self::get_entity_terms(),
+                //					),
+                //				),
+            );
+    }
 
 //	/**
 //	 * Get the entity terms IDs which represent an entity.
@@ -491,97 +491,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 +76 added lines, -76 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,16 +120,16 @@ 
 	 *
 	 * @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_Types_Taxonomy_Service::TAXONOMY_NAME );
+		$terms = wp_get_object_terms($post_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME);
 
-		if ( 0 === count( $terms ) ) {
+		if (0 === count($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;
 		}
 
@@ -148,19 +148,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'];
 			}
 		}
@@ -175,13 +175,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
@@ -194,9 +194,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;
 		}
 
@@ -204,13 +204,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;
 		}
 
@@ -230,9 +230,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);
 	}
 
 	/**
@@ -247,10 +247,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;
 		}
 
@@ -260,15 +260,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);
 
 	}
 
@@ -280,22 +280,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);
 			}
 		}
 
@@ -310,9 +310,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);
 	}
 
 	/**
@@ -324,9 +324,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));
 	}
 
 	/**
@@ -336,25 +336,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'));
 
 	}
 
@@ -367,25 +367,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;
@@ -401,9 +401,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'));
 	}
 
 	/**
@@ -415,12 +415,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);
 	}
 
 	/**
@@ -433,7 +433,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(
@@ -503,28 +503,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;
 	}
@@ -540,9 +540,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);
 	}
 
 	/**
@@ -554,16 +554,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);
 	}
 
 	/**
@@ -579,9 +579,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-entity-uri-service.php

Doc Comments +1 added lines, -1 removed lines

@@ -215,7 +215,7 @@
 	 *
 	 * @param int $uri An uri.
 	 *
-	 * @return true if the uri internal to the current dataset otherwise false.
+	 * @return boolean if the uri internal to the current dataset otherwise false.
 	 */
 	public function is_internal( $uri ) {
 

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 ( 0 === count( $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 ( 0 === count( $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 ( 0 === count( $posts ) ) {
-			$this->log->warn( "No post for URI $uri." );
+		if (0 === count($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-content-filter-service.php

Indentation +268 added lines, -268 removed lines

@@ -18,276 +18,276 @@
  */
 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;
-
-	/**
-	 * 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();
-
-		// Preload URIs.
-		$matches = array();
-		preg_match_all( self::PATTERN, $content, $matches );
-
-		// Bail out if there are no URIs.
-		if ( 0 === count( $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 );
-		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' );
-		$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;
-		}
-
-		// 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;
+
+    /**
+     * 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();
+
+        // Preload URIs.
+        $matches = array();
+        preg_match_all( self::PATTERN, $content, $matches );
+
+        // Bail out if there are no URIs.
+        if ( 0 === count( $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 );
+        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' );
+        $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;
+        }
+
+        // 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 +32 added lines, -32 removed lines

@@ -88,9 +88,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;
@@ -121,12 +121,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;
 		}
 
@@ -135,22 +135,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 ( 0 === count( $matches[3] ) ) {
+		if (0 === count($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();
 
@@ -166,7 +166,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];
@@ -174,8 +174,8 @@ 
 		$label     = $matches[4];
 
 		// Get the entity post by URI.
-		$post = $this->entity_service->get_entity_post_by_uri( $uri );
-		if ( null === $post ) {
+		$post = $this->entity_service->get_entity_post_by_uri($uri);
+		if (null === $post) {
 
 			// If the entity post is not found return the label w/o the markup
 			// around it.
@@ -184,23 +184,23 @@ 
 			return $label;
 		}
 
-		$no_link = - 1 < strpos( $css_class, 'wl-no-link' );
-		$link    = - 1 < strpos( $css_class, 'wl-link' );
+		$no_link = - 1 < strpos($css_class, 'wl-no-link');
+		$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;
 		}
 
 		// 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>";
@@ -219,12 +219,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 '';
@@ -241,24 +241,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;
 			}
@@ -277,17 +277,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-rebuild-service.php

Indentation +155 added lines, -155 removed lines

@@ -20,134 +20,134 @@ 
  */
 class Wordlift_Rebuild_Service extends Wordlift_Listable {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * A {@link Wordlift_Sparql_Service} instance.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var \Wordlift_Sparql_Service $sparql_service A {@link Wordlift_Sparql_Service} instance.
-	 */
-	private $sparql_service;
-
-	/**
-	 * The {@link Wordlift_Uri_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Uri_Service $uri_service The {@link Wordlift_Uri_Service} instance.
-	 */
-	private $uri_service;
-
-	/**
-	 * Create an instance of Wordlift_Rebuild_Service.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param \Wordlift_Sparql_Service $sparql_service A {@link Wordlift_Sparql_Service} instance used to query the remote dataset.
-	 * @param \Wordlift_Uri_Service    $uri_service
-	 */
-	public function __construct( $sparql_service, $uri_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Rebuild_Service' );
-
-		$this->sparql_service = $sparql_service;
-		$this->uri_service    = $uri_service;
-	}
-
-	/**
-	 * Rebuild the Linked Data remote dataset by clearing it out and repopulating
-	 * it with local data.
-	 *
-	 * @since 3.6.0
-	 */
-	public function rebuild() {
-
-		ob_clean();
-
-		// Give ourselves some time to process the data.
-		set_time_limit( 21600 ); // 6 hours
-
-		// Send textual output.
-		header( 'Content-type: text/plain; charset=utf-8' );
-
-		// We start at 0 by default and get to max.
-		$offset = $_GET['offset'] ?: 0;
-		$limit  = $_GET['limit'] ?: 1;
-		$max    = $offset + $limit;
-
-		// Whether we should run queries asynchronously, this is handled in `wordlift_constants.php`.
-		$asynchronous = isset( $_GET['wl-async'] ) && 'true' === $_GET['wl-async'];
-
-		// If we're starting at offset 0, then delete existing URIs and data from
-		// the remote dataset.
-		if ( 0 === $offset ) {
-
-			// Clear out all generated URIs, since the dataset URI might have changed
-			// in the process.
-			$this->uri_service->delete_all();
-
-			// Delete all the triples in the remote dataset.
-			$this->sparql_service->execute( 'DELETE { ?s ?p ?o } WHERE { ?s ?p ?o };' );
-
-		}
-
-		// Go through the list of published entities and posts and call the (legacy)
-		// `wl_linked_data_save_post` function for each one. We're using the `process`
-		// function which is provided by the parent `Wordlift_Listable` abstract class
-		// and will cycle through all the posts w/ a very small memory footprint
-		// in order to avoid memory errors.
-
-		$count = 0;
-		$log   = $this->log;
-		$this->process( function ( $post ) use ( &$count, $log ) {
-			$count ++;
-			$log->trace( "Going to save post $count, ID $post->ID..." );
-			wl_linked_data_save_post( $post->ID );
-		}, array(
-			'post_status' => 'publish',
-		), $offset, $max );
-
-		// Redirect to the next chunk.
-		if ( $count == $limit ) {
-			$log->trace( 'Redirecting to post #' . ( $offset + 1 ) . '...' );
-			$this->redirect( admin_url( 'admin-ajax.php?action=wl_rebuild&offset=' . ( $offset + $limit ) . '&limit=' . $limit . '&wl-async=' . ( $asynchronous ? 'true' : 'false' ) ) );
-		}
-
-		// Flush the cache.
-		Wordlift_File_Cache_Service::flush_all();
-
-		$this->log->info( "Rebuild complete [ count :: $count ][ limit :: $limit ]" );
-		echo( "Rebuild complete [ count :: $count ][ limit :: $limit ]" );
-
-		// If we're being called as AJAX, die here.
-		if ( DOING_AJAX ) {
-			wp_die();
-		}
-
-	}
-
-	/**
-	 * Redirect using a client-side meta to avoid browsers' redirect restrictions.
-	 *
-	 * @since 3.9.8
-	 *
-	 * @param string $url The URL to redirect to.
-	 */
-	private function redirect( $url ) {
-
-		ob_clean();
-
-		@header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
-		?>
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * A {@link Wordlift_Sparql_Service} instance.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var \Wordlift_Sparql_Service $sparql_service A {@link Wordlift_Sparql_Service} instance.
+     */
+    private $sparql_service;
+
+    /**
+     * The {@link Wordlift_Uri_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Uri_Service $uri_service The {@link Wordlift_Uri_Service} instance.
+     */
+    private $uri_service;
+
+    /**
+     * Create an instance of Wordlift_Rebuild_Service.
+     *
+     * @since 3.6.0
+     *
+     * @param \Wordlift_Sparql_Service $sparql_service A {@link Wordlift_Sparql_Service} instance used to query the remote dataset.
+     * @param \Wordlift_Uri_Service    $uri_service
+     */
+    public function __construct( $sparql_service, $uri_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Rebuild_Service' );
+
+        $this->sparql_service = $sparql_service;
+        $this->uri_service    = $uri_service;
+    }
+
+    /**
+     * Rebuild the Linked Data remote dataset by clearing it out and repopulating
+     * it with local data.
+     *
+     * @since 3.6.0
+     */
+    public function rebuild() {
+
+        ob_clean();
+
+        // Give ourselves some time to process the data.
+        set_time_limit( 21600 ); // 6 hours
+
+        // Send textual output.
+        header( 'Content-type: text/plain; charset=utf-8' );
+
+        // We start at 0 by default and get to max.
+        $offset = $_GET['offset'] ?: 0;
+        $limit  = $_GET['limit'] ?: 1;
+        $max    = $offset + $limit;
+
+        // Whether we should run queries asynchronously, this is handled in `wordlift_constants.php`.
+        $asynchronous = isset( $_GET['wl-async'] ) && 'true' === $_GET['wl-async'];
+
+        // If we're starting at offset 0, then delete existing URIs and data from
+        // the remote dataset.
+        if ( 0 === $offset ) {
+
+            // Clear out all generated URIs, since the dataset URI might have changed
+            // in the process.
+            $this->uri_service->delete_all();
+
+            // Delete all the triples in the remote dataset.
+            $this->sparql_service->execute( 'DELETE { ?s ?p ?o } WHERE { ?s ?p ?o };' );
+
+        }
+
+        // Go through the list of published entities and posts and call the (legacy)
+        // `wl_linked_data_save_post` function for each one. We're using the `process`
+        // function which is provided by the parent `Wordlift_Listable` abstract class
+        // and will cycle through all the posts w/ a very small memory footprint
+        // in order to avoid memory errors.
+
+        $count = 0;
+        $log   = $this->log;
+        $this->process( function ( $post ) use ( &$count, $log ) {
+            $count ++;
+            $log->trace( "Going to save post $count, ID $post->ID..." );
+            wl_linked_data_save_post( $post->ID );
+        }, array(
+            'post_status' => 'publish',
+        ), $offset, $max );
+
+        // Redirect to the next chunk.
+        if ( $count == $limit ) {
+            $log->trace( 'Redirecting to post #' . ( $offset + 1 ) . '...' );
+            $this->redirect( admin_url( 'admin-ajax.php?action=wl_rebuild&offset=' . ( $offset + $limit ) . '&limit=' . $limit . '&wl-async=' . ( $asynchronous ? 'true' : 'false' ) ) );
+        }
+
+        // Flush the cache.
+        Wordlift_File_Cache_Service::flush_all();
+
+        $this->log->info( "Rebuild complete [ count :: $count ][ limit :: $limit ]" );
+        echo( "Rebuild complete [ count :: $count ][ limit :: $limit ]" );
+
+        // If we're being called as AJAX, die here.
+        if ( DOING_AJAX ) {
+            wp_die();
+        }
+
+    }
+
+    /**
+     * Redirect using a client-side meta to avoid browsers' redirect restrictions.
+     *
+     * @since 3.9.8
+     *
+     * @param string $url The URL to redirect to.
+     */
+    private function redirect( $url ) {
+
+        ob_clean();
+
+        @header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
+        ?>
 		<html>
 		<head>
 			<meta http-equiv="refresh"
@@ -159,32 +159,32 @@ 
 		</html>
 		<?php
 
-		exit;
-
-	}
-
-	/**
-	 * List the items starting at the specified offset and up to the specified limit.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param int   $offset The start offset.
-	 * @param int   $limit  The maximum number of items to return.
-	 * @param array $args   Additional arguments.
-	 *
-	 * @return array A array of items (or an empty array if no items are found).
-	 */
-	function find( $offset = 0, $limit = 10, $args = array() ) {
-
-		return get_posts( wp_parse_args( $args, Wordlift_Entity_Service::add_criterias( array(
-			'offset'        => $offset,
-			'numberposts'   => $limit,
-			'fields'        => 'all',
-			'orderby'       => 'ID',
-			'order'         => 'ASC',
-			'post_status'   => 'any',
-			'cache_results' => false,
-		) ) ) );
-	}
+        exit;
+
+    }
+
+    /**
+     * List the items starting at the specified offset and up to the specified limit.
+     *
+     * @since 3.6.0
+     *
+     * @param int   $offset The start offset.
+     * @param int   $limit  The maximum number of items to return.
+     * @param array $args   Additional arguments.
+     *
+     * @return array A array of items (or an empty array if no items are found).
+     */
+    function find( $offset = 0, $limit = 10, $args = array() ) {
+
+        return get_posts( wp_parse_args( $args, Wordlift_Entity_Service::add_criterias( array(
+            'offset'        => $offset,
+            'numberposts'   => $limit,
+            'fields'        => 'all',
+            'orderby'       => 'ID',
+            'order'         => 'ASC',
+            'post_status'   => 'any',
+            'cache_results' => false,
+        ) ) ) );
+    }
 
 }

Spacing +24 added lines, -24 removed lines

@@ -55,9 +55,9 @@ 
 	 * @param \Wordlift_Sparql_Service $sparql_service A {@link Wordlift_Sparql_Service} instance used to query the remote dataset.
 	 * @param \Wordlift_Uri_Service    $uri_service
 	 */
-	public function __construct( $sparql_service, $uri_service ) {
+	public function __construct($sparql_service, $uri_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Rebuild_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Rebuild_Service');
 
 		$this->sparql_service = $sparql_service;
 		$this->uri_service    = $uri_service;
@@ -74,10 +74,10 @@ 
 		ob_clean();
 
 		// Give ourselves some time to process the data.
-		set_time_limit( 21600 ); // 6 hours
+		set_time_limit(21600); // 6 hours
 
 		// Send textual output.
-		header( 'Content-type: text/plain; charset=utf-8' );
+		header('Content-type: text/plain; charset=utf-8');
 
 		// We start at 0 by default and get to max.
 		$offset = $_GET['offset'] ?: 0;
@@ -85,18 +85,18 @@ 
 		$max    = $offset + $limit;
 
 		// Whether we should run queries asynchronously, this is handled in `wordlift_constants.php`.
-		$asynchronous = isset( $_GET['wl-async'] ) && 'true' === $_GET['wl-async'];
+		$asynchronous = isset($_GET['wl-async']) && 'true' === $_GET['wl-async'];
 
 		// If we're starting at offset 0, then delete existing URIs and data from
 		// the remote dataset.
-		if ( 0 === $offset ) {
+		if (0 === $offset) {
 
 			// Clear out all generated URIs, since the dataset URI might have changed
 			// in the process.
 			$this->uri_service->delete_all();
 
 			// Delete all the triples in the remote dataset.
-			$this->sparql_service->execute( 'DELETE { ?s ?p ?o } WHERE { ?s ?p ?o };' );
+			$this->sparql_service->execute('DELETE { ?s ?p ?o } WHERE { ?s ?p ?o };');
 
 		}
 
@@ -108,28 +108,28 @@ 
 
 		$count = 0;
 		$log   = $this->log;
-		$this->process( function ( $post ) use ( &$count, $log ) {
-			$count ++;
-			$log->trace( "Going to save post $count, ID $post->ID..." );
-			wl_linked_data_save_post( $post->ID );
+		$this->process(function($post) use (&$count, $log) {
+			$count++;
+			$log->trace("Going to save post $count, ID $post->ID...");
+			wl_linked_data_save_post($post->ID);
 		}, array(
 			'post_status' => 'publish',
-		), $offset, $max );
+		), $offset, $max);
 
 		// Redirect to the next chunk.
-		if ( $count == $limit ) {
-			$log->trace( 'Redirecting to post #' . ( $offset + 1 ) . '...' );
-			$this->redirect( admin_url( 'admin-ajax.php?action=wl_rebuild&offset=' . ( $offset + $limit ) . '&limit=' . $limit . '&wl-async=' . ( $asynchronous ? 'true' : 'false' ) ) );
+		if ($count == $limit) {
+			$log->trace('Redirecting to post #'.($offset + 1).'...');
+			$this->redirect(admin_url('admin-ajax.php?action=wl_rebuild&offset='.($offset + $limit).'&limit='.$limit.'&wl-async='.($asynchronous ? 'true' : 'false')));
 		}
 
 		// Flush the cache.
 		Wordlift_File_Cache_Service::flush_all();
 
-		$this->log->info( "Rebuild complete [ count :: $count ][ limit :: $limit ]" );
-		echo( "Rebuild complete [ count :: $count ][ limit :: $limit ]" );
+		$this->log->info("Rebuild complete [ count :: $count ][ limit :: $limit ]");
+		echo("Rebuild complete [ count :: $count ][ limit :: $limit ]");
 
 		// If we're being called as AJAX, die here.
-		if ( DOING_AJAX ) {
+		if (DOING_AJAX) {
 			wp_die();
 		}
 
@@ -142,16 +142,16 @@ 
 	 *
 	 * @param string $url The URL to redirect to.
 	 */
-	private function redirect( $url ) {
+	private function redirect($url) {
 
 		ob_clean();
 
-		@header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
+		@header('Content-Type: text/html; charset='.get_option('blog_charset'));
 		?>
 		<html>
 		<head>
 			<meta http-equiv="refresh"
-			      content="0; <?php echo esc_attr( $url ); ?>">
+			      content="0; <?php echo esc_attr($url); ?>">
 		</head>
 		<body>
 		Rebuilding, please wait...
@@ -174,9 +174,9 @@ 
 	 *
 	 * @return array A array of items (or an empty array if no items are found).
 	 */
-	function find( $offset = 0, $limit = 10, $args = array() ) {
+	function find($offset = 0, $limit = 10, $args = array()) {
 
-		return get_posts( wp_parse_args( $args, Wordlift_Entity_Service::add_criterias( array(
+		return get_posts(wp_parse_args($args, Wordlift_Entity_Service::add_criterias(array(
 			'offset'        => $offset,
 			'numberposts'   => $limit,
 			'fields'        => 'all',
@@ -184,7 +184,7 @@ 
 			'order'         => 'ASC',
 			'post_status'   => 'any',
 			'cache_results' => false,
-		) ) ) );
+		))));
 	}
 
 }

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

Indentation +160 added lines, -160 removed lines

@@ -16,165 +16,165 @@
  */
 class Wordlift_Entity_Post_Type_Service {
 
-	/**
-	 * The entity post type.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var string $post_type The entity post type.
-	 */
-	private $post_type;
-
-	/**
-	 * The entity type slug.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var string $slug The entity type slug.
-	 */
-	private $slug;
-
-	/**
-	 * 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;
-
-	/**
-	 * A singleton instance of the entity type service.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var Wordlift_Entity_Post_Type_Service
-	 */
-	private static $instance;
-
-	/**
-	 * Create an entity type service instance.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param string $post_type The post type, e.g. entity.
-	 * @param string $slug      The entity type slug, if the slug is empty, the default slug will be used.
-	 */
-	public function __construct( $post_type, $slug ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->post_type = $post_type;
-
-		// We cannot assign an empty slug to the register_post_type function, therefore if the slug is empty we default
-		// to the type name.
-		$this->slug = $slug ?: $post_type;
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the entity type service singleton instance.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @return Wordlift_Entity_Post_Type_Service The entity type service singleton instance.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get the entity type slug.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @return string The entity type slug.
-	 */
-	public function get_slug() {
-
-		return $this->slug;
-	}
-
-	/**
-	 * Get the entity post type name.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @return string The entity post type.
-	 */
-	public function get_post_type() {
-
-		return $this->post_type;
-	}
-
-
-	/**
-	 * Register the WordLift entity post type. This method is hooked to WordPress' init action.
-	 *
-	 * @since 3.6.0
-	 */
-	public function register() {
-
-		$this->log->debug( "Registering post type $this->post_type..." );
-
-		$labels = array(
-			'name'               => _x( 'Vocabulary', 'post type general name', 'wordlift' ),
-			'singular_name'      => _x( 'Entity', 'post type singular name', 'wordlift' ),
-			'add_new'            => _x( 'Add New Entity', 'entity', 'wordlift' ),
-			'add_new_item'       => __( 'Add New Entity', 'wordlift' ),
-			'edit_item'          => __( 'Edit Entity', 'wordlift' ),
-			'new_item'           => __( 'New Entity', 'wordlift' ),
-			'all_items'          => __( 'All Entities', 'wordlift' ),
-			'view_item'          => __( 'View Entity', 'wordlift' ),
-			'search_items'       => __( 'Search in Vocabulary', 'wordlift' ),
-			'not_found'          => __( 'No entities found', 'wordlift' ),
-			'not_found_in_trash' => __( 'No entities found in the Trash', 'wordlift' ),
-			'parent_item_colon'  => '',
-			'menu_name'          => __( 'Vocabulary', 'wordlift' ),
-		);
-
-		$args = array(
-			'labels'          => $labels,
-			'description'     => 'Holds our vocabulary (set of entities) and entity specific data',
-			'public'          => true,
-			'menu_position'   => 20,
-			// after the pages menu.
-			// Add support for 'authors' and 'revisions':
-			// * see https://github.com/insideout10/wordlift-plugin/issues/395
-			// * see https://github.com/insideout10/wordlift-plugin/issues/376
-			'supports'        => array(
-				'title',
-				'editor',
-				'thumbnail',
-				'excerpt',
-				'comments',
-				'author',
-				'revisions',
-			),
-			'has_archive'     => true,
-			'menu_icon'       => WP_CONTENT_URL . '/plugins/wordlift/images/svg/wl-vocabulary-icon.svg',
-			// Although we define our slug here, we further manage linking to entities using the Wordlift_Entity_Link_Service.
-			'rewrite'         => array( 'slug' => $this->slug ),
-			'capability_type' => array(
-				'wordlift_entity',
-				'wordlift_entities',
-			),
-		);
-
-		register_post_type( $this->post_type, $args );
-
-		// Enable WP's standard `category` taxonomy for entities.
-		//
-		// While this enables editors to bind entities to the WP posts' category
-		// taxonomy, in Wordlift_Category_Taxonomy_Service we also need to alter
-		// WP's main category query to include the `entity` post type.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/442
-		register_taxonomy_for_object_type( 'category', $this->post_type );
-
-	}
+    /**
+     * The entity post type.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var string $post_type The entity post type.
+     */
+    private $post_type;
+
+    /**
+     * The entity type slug.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var string $slug The entity type slug.
+     */
+    private $slug;
+
+    /**
+     * 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;
+
+    /**
+     * A singleton instance of the entity type service.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var Wordlift_Entity_Post_Type_Service
+     */
+    private static $instance;
+
+    /**
+     * Create an entity type service instance.
+     *
+     * @since 3.6.0
+     *
+     * @param string $post_type The post type, e.g. entity.
+     * @param string $slug      The entity type slug, if the slug is empty, the default slug will be used.
+     */
+    public function __construct( $post_type, $slug ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->post_type = $post_type;
+
+        // We cannot assign an empty slug to the register_post_type function, therefore if the slug is empty we default
+        // to the type name.
+        $this->slug = $slug ?: $post_type;
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the entity type service singleton instance.
+     *
+     * @since 3.6.0
+     *
+     * @return Wordlift_Entity_Post_Type_Service The entity type service singleton instance.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Get the entity type slug.
+     *
+     * @since 3.6.0
+     *
+     * @return string The entity type slug.
+     */
+    public function get_slug() {
+
+        return $this->slug;
+    }
+
+    /**
+     * Get the entity post type name.
+     *
+     * @since 3.6.0
+     *
+     * @return string The entity post type.
+     */
+    public function get_post_type() {
+
+        return $this->post_type;
+    }
+
+
+    /**
+     * Register the WordLift entity post type. This method is hooked to WordPress' init action.
+     *
+     * @since 3.6.0
+     */
+    public function register() {
+
+        $this->log->debug( "Registering post type $this->post_type..." );
+
+        $labels = array(
+            'name'               => _x( 'Vocabulary', 'post type general name', 'wordlift' ),
+            'singular_name'      => _x( 'Entity', 'post type singular name', 'wordlift' ),
+            'add_new'            => _x( 'Add New Entity', 'entity', 'wordlift' ),
+            'add_new_item'       => __( 'Add New Entity', 'wordlift' ),
+            'edit_item'          => __( 'Edit Entity', 'wordlift' ),
+            'new_item'           => __( 'New Entity', 'wordlift' ),
+            'all_items'          => __( 'All Entities', 'wordlift' ),
+            'view_item'          => __( 'View Entity', 'wordlift' ),
+            'search_items'       => __( 'Search in Vocabulary', 'wordlift' ),
+            'not_found'          => __( 'No entities found', 'wordlift' ),
+            'not_found_in_trash' => __( 'No entities found in the Trash', 'wordlift' ),
+            'parent_item_colon'  => '',
+            'menu_name'          => __( 'Vocabulary', 'wordlift' ),
+        );
+
+        $args = array(
+            'labels'          => $labels,
+            'description'     => 'Holds our vocabulary (set of entities) and entity specific data',
+            'public'          => true,
+            'menu_position'   => 20,
+            // after the pages menu.
+            // Add support for 'authors' and 'revisions':
+            // * see https://github.com/insideout10/wordlift-plugin/issues/395
+            // * see https://github.com/insideout10/wordlift-plugin/issues/376
+            'supports'        => array(
+                'title',
+                'editor',
+                'thumbnail',
+                'excerpt',
+                'comments',
+                'author',
+                'revisions',
+            ),
+            'has_archive'     => true,
+            'menu_icon'       => WP_CONTENT_URL . '/plugins/wordlift/images/svg/wl-vocabulary-icon.svg',
+            // Although we define our slug here, we further manage linking to entities using the Wordlift_Entity_Link_Service.
+            'rewrite'         => array( 'slug' => $this->slug ),
+            'capability_type' => array(
+                'wordlift_entity',
+                'wordlift_entities',
+            ),
+        );
+
+        register_post_type( $this->post_type, $args );
+
+        // Enable WP's standard `category` taxonomy for entities.
+        //
+        // While this enables editors to bind entities to the WP posts' category
+        // taxonomy, in Wordlift_Category_Taxonomy_Service we also need to alter
+        // WP's main category query to include the `entity` post type.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/442
+        register_taxonomy_for_object_type( 'category', $this->post_type );
+
+    }
 
 }

Spacing +19 added lines, -19 removed lines

@@ -60,9 +60,9 @@ 
 	 * @param string $post_type The post type, e.g. entity.
 	 * @param string $slug      The entity type slug, if the slug is empty, the default slug will be used.
 	 */
-	public function __construct( $post_type, $slug ) {
+	public function __construct($post_type, $slug) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->post_type = $post_type;
 
@@ -118,22 +118,22 @@ 
 	 */
 	public function register() {
 
-		$this->log->debug( "Registering post type $this->post_type..." );
+		$this->log->debug("Registering post type $this->post_type...");
 
 		$labels = array(
-			'name'               => _x( 'Vocabulary', 'post type general name', 'wordlift' ),
-			'singular_name'      => _x( 'Entity', 'post type singular name', 'wordlift' ),
-			'add_new'            => _x( 'Add New Entity', 'entity', 'wordlift' ),
-			'add_new_item'       => __( 'Add New Entity', 'wordlift' ),
-			'edit_item'          => __( 'Edit Entity', 'wordlift' ),
-			'new_item'           => __( 'New Entity', 'wordlift' ),
-			'all_items'          => __( 'All Entities', 'wordlift' ),
-			'view_item'          => __( 'View Entity', 'wordlift' ),
-			'search_items'       => __( 'Search in Vocabulary', 'wordlift' ),
-			'not_found'          => __( 'No entities found', 'wordlift' ),
-			'not_found_in_trash' => __( 'No entities found in the Trash', 'wordlift' ),
+			'name'               => _x('Vocabulary', 'post type general name', 'wordlift'),
+			'singular_name'      => _x('Entity', 'post type singular name', 'wordlift'),
+			'add_new'            => _x('Add New Entity', 'entity', 'wordlift'),
+			'add_new_item'       => __('Add New Entity', 'wordlift'),
+			'edit_item'          => __('Edit Entity', 'wordlift'),
+			'new_item'           => __('New Entity', 'wordlift'),
+			'all_items'          => __('All Entities', 'wordlift'),
+			'view_item'          => __('View Entity', 'wordlift'),
+			'search_items'       => __('Search in Vocabulary', 'wordlift'),
+			'not_found'          => __('No entities found', 'wordlift'),
+			'not_found_in_trash' => __('No entities found in the Trash', 'wordlift'),
 			'parent_item_colon'  => '',
-			'menu_name'          => __( 'Vocabulary', 'wordlift' ),
+			'menu_name'          => __('Vocabulary', 'wordlift'),
 		);
 
 		$args = array(
@@ -155,16 +155,16 @@ 
 				'revisions',
 			),
 			'has_archive'     => true,
-			'menu_icon'       => WP_CONTENT_URL . '/plugins/wordlift/images/svg/wl-vocabulary-icon.svg',
+			'menu_icon'       => WP_CONTENT_URL.'/plugins/wordlift/images/svg/wl-vocabulary-icon.svg',
 			// Although we define our slug here, we further manage linking to entities using the Wordlift_Entity_Link_Service.
-			'rewrite'         => array( 'slug' => $this->slug ),
+			'rewrite'         => array('slug' => $this->slug),
 			'capability_type' => array(
 				'wordlift_entity',
 				'wordlift_entities',
 			),
 		);
 
-		register_post_type( $this->post_type, $args );
+		register_post_type($this->post_type, $args);
 
 		// Enable WP's standard `category` taxonomy for entities.
 		//
@@ -173,7 +173,7 @@ 
 		// WP's main category query to include the `entity` post type.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/442
-		register_taxonomy_for_object_type( 'category', $this->post_type );
+		register_taxonomy_for_object_type('category', $this->post_type);
 
 	}
 

src/includes/class-wordlift-deactivator.php

Indentation +11 added lines, -11 removed lines

@@ -21,18 +21,18 @@
  */
 class Wordlift_Deactivator {
 
-	/**
-	 * Short Description. (use period)
-	 *
-	 * Long Description.
-	 *
-	 * @since    1.0.0
-	 */
-	public static function deactivate() {
+    /**
+     * Short Description. (use period)
+     *
+     * Long Description.
+     *
+     * @since    1.0.0
+     */
+    public static function deactivate() {
 
-		// Clear caches.
-		Wordlift_File_Cache_Service::flush_all();
+        // Clear caches.
+        Wordlift_File_Cache_Service::flush_all();
 
-	}
+    }
 
 }

src/includes/cache/require.php

Spacing +4 added lines, -4 removed lines

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

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

Indentation +43 added lines, -43 removed lines

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

Spacing +4 added lines, -4 removed lines

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

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

Indentation +195 added lines, -195 removed lines

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

Spacing +38 added lines, -38 removed lines

@@ -40,26 +40,26 @@ 
 	 * @param \Wordlift_Configuration_Service $configuration_service
 	 * @param \Wordlift_Cache_Service         $cache_service
 	 */
-	public function __construct( $configuration_service, $cache_service ) {
-		parent::__construct( $configuration_service );
+	public function __construct($configuration_service, $cache_service) {
+		parent::__construct($configuration_service);
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		// Add hooks for meta being added/modified/deleted.
 		$this->cache_service = $cache_service;
 
-		add_action( 'add_post_meta', array(
+		add_action('add_post_meta', array(
 			$this,
 			'on_before_post_meta_add',
-		), 10, 3 );
-		add_action( 'update_post_meta', array(
+		), 10, 3);
+		add_action('update_post_meta', array(
 			$this,
 			'on_before_post_meta_change',
-		), 10, 4 );
-		add_action( 'delete_post_meta', array(
+		), 10, 4);
+		add_action('delete_post_meta', array(
 			$this,
 			'on_before_post_meta_change',
-		), 10, 4 );
+		), 10, 4);
 
 	}
 
@@ -70,21 +70,21 @@ 
 	 *
 	 * @param array $uris Preload an array of URIs.
 	 */
-	public function preload_uris( $uris ) {
+	public function preload_uris($uris) {
 
 		// Filter the URIs which aren't yet cached.
 		$cache_service = $this->cache_service;
-		$uris_to_cache = array_filter( (array) $uris, function ( $item ) use ( $cache_service ) {
-			return ! $cache_service->has_cache( $item );
+		$uris_to_cache = array_filter((array) $uris, function($item) use ($cache_service) {
+			return ! $cache_service->has_cache($item);
 		} );
 
 		// Preload the URIs.
-		parent::preload_uris( $uris_to_cache );
+		parent::preload_uris($uris_to_cache);
 
 		// Store them in cache.
-		if ( is_array( $this->uri_to_post ) && ! empty( $this->uri_to_post ) ) {
-			foreach ( $this->uri_to_post as $uri => $post ) {
-				$this->set_cache( $uri, $post );
+		if (is_array($this->uri_to_post) && ! empty($this->uri_to_post)) {
+			foreach ($this->uri_to_post as $uri => $post) {
+				$this->set_cache($uri, $post);
 			}
 		}
 
@@ -99,25 +99,25 @@ 
 	 *
 	 * @return null|WP_Post The {@link WP_Post} or null if not found.
 	 */
-	public function get_entity( $uri ) {
+	public function get_entity($uri) {
 
-		$this->log->trace( "Getting entity for uri $uri..." );
+		$this->log->trace("Getting entity for uri $uri...");
 
 		// Get the cached post for the specified URI.
-		$cache = $this->cache_service->get_cache( $uri );
+		$cache = $this->cache_service->get_cache($uri);
 
 		// Return the cached data if valid.
-		if ( false !== $cache && is_numeric( $cache ) ) {
-			$this->log->debug( "Cached entity $cache for uri $uri found." );
+		if (false !== $cache && is_numeric($cache)) {
+			$this->log->debug("Cached entity $cache for uri $uri found.");
 
-			return get_post( $cache );
+			return get_post($cache);
 		}
 
 		// Get the actual result.
-		$post = parent::get_entity( $uri );
+		$post = parent::get_entity($uri);
 
 		// Cache the result, if a post is not found we cache -1.
-		$this->set_cache( $uri, $post );
+		$this->set_cache($uri, $post);
 
 		// Return the result.
 		return $post;
@@ -131,10 +131,10 @@ 
 	 * @param string  $uri  The URI.
 	 * @param WP_Post $post The post.
 	 */
-	private function set_cache( $uri, $post ) {
+	private function set_cache($uri, $post) {
 
 		// Cache the result, if a post is not found we cache -1.
-		$this->cache_service->set_cache( $uri, ( null === $post ? - 1 : $post->ID ) );
+		$this->cache_service->set_cache($uri, (null === $post ? -1 : $post->ID));
 
 	}
 
@@ -145,12 +145,12 @@ 
 	 *
 	 * @param array $uris An array of URIs.
 	 */
-	private function delete_cache( $uris ) {
+	private function delete_cache($uris) {
 
 		// Delete the cache for each URI.
-		foreach ( $uris as $uri ) {
+		foreach ($uris as $uri) {
 			// Delete the single cache file.
-			$this->cache_service->delete_cache( $uri );
+			$this->cache_service->delete_cache($uri);
 		}
 
 	}
@@ -169,20 +169,20 @@ 
 	 * @param string    $meta_key   The meta key.
 	 * @param mixed     $meta_value The meta value(s).
 	 */
-	public function on_before_post_meta_change( $meta_ids, $post_id, $meta_key, $meta_value ) {
+	public function on_before_post_meta_change($meta_ids, $post_id, $meta_key, $meta_value) {
 
 		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+		if (WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key) {
 			return;
 		}
 
-		$this->log->trace( "Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache..." );
+		$this->log->trace("Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache...");
 
 		// The list of existing URIs, plus the list of URIs being deleted/updated.
-		$uris = get_post_meta( $post_id, $meta_key ) + (array) $meta_value;
+		$uris = get_post_meta($post_id, $meta_key) + (array) $meta_value;
 
 		// Delete the cache for those URIs.
-		$this->delete_cache( $uris );
+		$this->delete_cache($uris);
 
 	}
 
@@ -196,17 +196,17 @@ 
 	 * @param string $meta_key   The meta key.
 	 * @param mixed  $meta_value The meta value(s).
 	 */
-	public function on_before_post_meta_add( $post_id, $meta_key, $meta_value ) {
+	public function on_before_post_meta_add($post_id, $meta_key, $meta_value) {
 
 		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+		if (WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key) {
 			return;
 		}
 
-		$this->log->trace( "Adding $meta_key for post $post_id ($meta_key), invalidating cache..." );
+		$this->log->trace("Adding $meta_key for post $post_id ($meta_key), invalidating cache...");
 
 		// Delete the cache for the URIs being added.
-		$this->delete_cache( (array) $meta_value );
+		$this->delete_cache((array) $meta_value);
 
 	}