insideout10 / wordlift-plugin

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

Doc Comments +1 added lines, -2 removed lines

@@ -173,7 +173,6 @@ 
 	 * @since 3.3.0
 	 *
 	 * @param int $post_id      The entity post id.
-	 * @param     $force_reload $warnings_needed If true, detailed warnings collection is provided with the rating obj.
 	 *
 	 * @return array An array representing the rating obj.
 	 */
@@ -332,7 +331,7 @@ 
 	 *
 	 * @param int $score The rating score for a given entity.
 	 *
-	 * @return string The input HTML code.
+	 * @return double The input HTML code.
 	 */
 	public function convert_raw_score_to_percentage( $score ) {
 

Indentation +369 added lines, -369 removed lines

@@ -14,374 +14,374 @@
  */
 class Wordlift_Rating_Service {
 
-	/**
-	 * Entity rating max.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_MAX = 7;
-
-	/**
-	 * Entity rating score meta key.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_RAW_SCORE_META_KEY = '_wl_entity_rating_raw_score';
-
-	/**
-	 * Entity rating warnings meta key.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNINGS_META_KEY = '_wl_entity_rating_warnings';
-
-	/**
-	 * Entity warning has related post identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_RELATED_POSTS = 'There are no related posts for the current entity.';
-
-	/**
-	 * Entity warning has content post identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_CONTENT_POST = 'This entity has not description.';
-
-	/**
-	 * Entity warning has related entities identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_RELATED_ENTITIES = 'There are no related entities for the current entity.';
-
-	/**
-	 * Entity warning is published identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_IS_PUBLISHED = 'This entity is not published. It will not appear within analysis results.';
-
-	/**
-	 * Entity warning has thumbnail identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_THUMBNAIL = 'This entity has no featured image yet.';
-
-	/**
-	 * Entity warning has same as identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_SAME_AS = 'There are no sameAs configured for this entity.';
-
-	/**
-	 * Entity warning has completed metadata identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_COMPLETED_METADATA = 'Schema.org metadata for this entity are not completed.';
-
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 *  A {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	private $entity_type_service;
-
-	/**
-	 * The Notice service.
-	 *
-	 * @since  3.3.0
-	 * @access private
-	 * @var \Wordlift_Notice_Service $notice_service The Notice service.
-	 */
-	private $notice_service;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a {@link Wordlift_Rating_Service} instance.
-	 *
-	 * @since 3.10.0
-	 *
-	 * @param \Wordlift_Entity_Service      $entity_service      A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 * @param \Wordlift_Notice_Service      $notice_service      A {@link Wordlift_Notice_Service} instance.
-	 */
-	public function __construct( $entity_service, $entity_type_service, $notice_service ) {
-
-		$this->entity_service      = $entity_service;
-		$this->entity_type_service = $entity_type_service;
-		$this->notice_service      = $notice_service;
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Rating_Service' );
-
-	}
-
-	/**
-	 * Set rating for a given entity.
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param int $post_id The entity post id.
-	 *
-	 * @return array An array representing the rating obj.
-	 */
-	public function set_rating_for( $post_id ) {
-
-		if ( ! $this->entity_service->is_entity( $post_id ) ) {
-			return;
-		}
-
-		// Calculate rating for the given post.
-		$rating = $this->calculate_rating_for( $post_id );
-
-		// Store the rating on db as post meta. Please notice that RATING_RAW_SCORE_META_KEY
-		// is saved on a different meta to allow score sorting. Both meta are managed as unique.
-		//
-		// See https://codex.wordpress.org/Function_Reference/update_post_meta
-		update_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, $rating['raw_score'] );
-		update_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, $rating['warnings'] );
-
-		$this->log->trace( sprintf( "Rating set for [ post_id :: $post_id ] [ rating :: %s ]", $rating['raw_score'] ) );
-
-		// Finally returns the rating
-		return $rating;
-	}
-
-
-	/**
-	 * Get or calculate rating for a given entity
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param int $post_id      The entity post id.
-	 * @param     $force_reload $warnings_needed If true, detailed warnings collection is provided with the rating obj.
-	 *
-	 * @return array An array representing the rating obj.
-	 */
-	public function get_rating_for( $post_id, $force_reload = false ) {
-
-		// If forced reload is required or rating is missing.
-		if ( $force_reload ) {
-			$this->log->trace( "Force rating reload [ post_id :: $post_id ]" );
-
-			return $this->set_rating_for( $post_id );
-		}
-
-		$current_raw_score = get_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, true );
-
-		if ( ! is_numeric( $current_raw_score ) ) {
-			$this->log->trace( "Rating missing for [ post_id :: $post_id ] [ current_raw_score :: $current_raw_score ]" );
-
-			return $this->set_rating_for( $post_id );
-		}
-
-		$current_warnings = get_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, true );
-
-		// Finally return score and warnings
-		return array(
-			'raw_score'           => $current_raw_score,
-			'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $current_raw_score ),
-			'percentage_score'    => $this->convert_raw_score_to_percentage( $current_raw_score ),
-			'warnings'            => $current_warnings,
-		);
-
-	}
-
-	/**
-	 * Calculate rating for a given entity.
-	 *
-	 * Rating depends from following criteria:
-	 *
-	 * 1. Is the current entity related to at least 1 post?
-	 * 2. Is the current entity content post not empty?
-	 * 3. Is the current entity related to at least 1 entity?
-	 * 4. Is the entity published?
-	 * 5. There is a a thumbnail associated to the entity?
-	 * 6. Has the entity a sameas defined?
-	 * 7. Are all schema.org required metadata compiled?
-	 *
-	 * Each positive check means +1 in terms of rating score.
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param int $post_id The entity post id.
-	 *
-	 * @return array An array representing the rating obj.
-	 */
-	private function calculate_rating_for( $post_id ) {
-
-		// If it's not an entity, return.
-		if ( ! $this->entity_service->is_entity( $post_id ) ) {
-			return array();
-		}
-		// Retrieve the post object.
-		$post = get_post( $post_id );
-
-		// Rating value.
-		$score = 0;
-
-		// Store warning messages.
-		$warnings = array();
-
-		// Is the current entity related to at least 1 post?
-		( 0 < count( wl_core_get_related_post_ids( $post->ID ) ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'There are no related posts for the current entity.', 'wordlift' ) );
-
-		// Is the post content not empty?
-		( ! empty( $post->post_content ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'This entity has not description.', 'wordlift' ) );
-
-		// Is the current entity related to at least 1 entity?
-		// Was the current entity already disambiguated?
-		( 0 < count( wl_core_get_related_entity_ids( $post->ID ) ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'There are no related entities for the current entity.', 'wordlift' ) );
-
-		// Is the entity published?
-		( 'publish' === get_post_status( $post->ID ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'This entity is not published. It will not appear within analysis results.', 'wordlift' ) );
-
-		// Has a thumbnail?
-		( has_post_thumbnail( $post->ID ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'This entity has no featured image yet.', 'wordlift' ) );
-
-		// Get all post meta keys for the current post
-		global $wpdb;
-
-		$query = $wpdb->prepare(
-			"SELECT DISTINCT (meta_key) FROM $wpdb->postmeta  WHERE post_id = %d", $post->ID
-		);
-
-		// Check intersection between available meta keys and expected ones
-		// arrays to detect missing values.
-		$available_meta_keys = $wpdb->get_col( $query );
-
-		// If each expected key is contained in available keys array ...
-		( in_array( Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'There are no sameAs configured for this entity.', 'wordlift' ) );
-
-		$schema = $this->entity_type_service->get( $post_id );
-
-		$expected_meta_keys = ( null === $schema['custom_fields'] ) ?
-			array() :
-			array_keys( $schema['custom_fields'] );
-
-		$intersection = array_intersect( $expected_meta_keys, $available_meta_keys );
-		// If each expected key is contained in available keys array ...
-		( count( $intersection ) === count( $expected_meta_keys ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'Schema.org metadata for this entity are not completed.', 'wordlift' ) );
-
-		// Finally return score and warnings
-		return array(
-			'raw_score'           => $score,
-			'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $score ),
-			'percentage_score'    => $this->convert_raw_score_to_percentage( $score ),
-			'warnings'            => $warnings,
-		);
-
-	}
-
-	/**
-	 * Get as rating as input and convert in a traffic-light rating
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param int $score The rating score for a given entity.
-	 *
-	 * @return string The input HTML code.
-	 */
-	private function convert_raw_score_to_traffic_light( $score ) {
-		// RATING_MAX : $score = 3 : x
-		// See http://php.net/manual/en/function.round.php
-		$rating = round( ( $score * 3 ) / self::RATING_MAX, 0, PHP_ROUND_HALF_UP );
-
-		// If rating is 0, return 1, otherwise return rating
-		return ( 0 == $rating ) ? 1 : $rating;
-
-	}
-
-	/**
-	 * Get as rating as input and convert in a traffic-light rating
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param int $score The rating score for a given entity.
-	 *
-	 * @return string The input HTML code.
-	 */
-	public function convert_raw_score_to_percentage( $score ) {
-
-		// RATING_MAX : $score = 100 : x
-		return round( ( $score * 100 ) / self::RATING_MAX, 0, PHP_ROUND_HALF_UP );
-	}
-
-
-	/**
-	 * Add admin notices for the current entity depending on the current rating.
-	 *
-	 * @since 3.3.0
-	 */
-	public function in_admin_header() {
-
-		// Return safely if get_current_screen() is not defined (yet)
-		if ( false === function_exists( 'get_current_screen' ) ) {
-			return;
-		}
-
-		$screen = get_current_screen();
-		// If there is any valid screen nothing to do
-		if ( null === $screen ) {
-			return;
-		}
-
-		// If you're not in the entity post edit page, return.
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $screen->id ) {
-			return;
-		}
-		// Retrieve the current global post
-		global $post;
-		// If it's not an entity, return.
-		if ( ! $this->entity_service->is_entity( $post->ID ) ) {
-			return;
-		}
-		// Retrieve an updated rating for the current entity
-		$rating = $this->get_rating_for( $post->ID, true );
-
-		// If there is at least 1 warning
-		if ( isset( $rating['warnings'] ) && 0 < count( $rating['warnings'] ) ) {
-			// TODO - Pass Wordlift_Notice_Service trough the service constructor
-			$this->notice_service->add_suggestion( $rating['warnings'] );
-		}
-
-	}
+    /**
+     * Entity rating max.
+     *
+     * @since 3.3.0
+     */
+    const RATING_MAX = 7;
+
+    /**
+     * Entity rating score meta key.
+     *
+     * @since 3.3.0
+     */
+    const RATING_RAW_SCORE_META_KEY = '_wl_entity_rating_raw_score';
+
+    /**
+     * Entity rating warnings meta key.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNINGS_META_KEY = '_wl_entity_rating_warnings';
+
+    /**
+     * Entity warning has related post identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_RELATED_POSTS = 'There are no related posts for the current entity.';
+
+    /**
+     * Entity warning has content post identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_CONTENT_POST = 'This entity has not description.';
+
+    /**
+     * Entity warning has related entities identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_RELATED_ENTITIES = 'There are no related entities for the current entity.';
+
+    /**
+     * Entity warning is published identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_IS_PUBLISHED = 'This entity is not published. It will not appear within analysis results.';
+
+    /**
+     * Entity warning has thumbnail identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_THUMBNAIL = 'This entity has no featured image yet.';
+
+    /**
+     * Entity warning has same as identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_SAME_AS = 'There are no sameAs configured for this entity.';
+
+    /**
+     * Entity warning has completed metadata identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_COMPLETED_METADATA = 'Schema.org metadata for this entity are not completed.';
+
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     *  A {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     */
+    private $entity_type_service;
+
+    /**
+     * The Notice service.
+     *
+     * @since  3.3.0
+     * @access private
+     * @var \Wordlift_Notice_Service $notice_service The Notice service.
+     */
+    private $notice_service;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a {@link Wordlift_Rating_Service} instance.
+     *
+     * @since 3.10.0
+     *
+     * @param \Wordlift_Entity_Service      $entity_service      A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     * @param \Wordlift_Notice_Service      $notice_service      A {@link Wordlift_Notice_Service} instance.
+     */
+    public function __construct( $entity_service, $entity_type_service, $notice_service ) {
+
+        $this->entity_service      = $entity_service;
+        $this->entity_type_service = $entity_type_service;
+        $this->notice_service      = $notice_service;
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Rating_Service' );
+
+    }
+
+    /**
+     * Set rating for a given entity.
+     *
+     * @since 3.3.0
+     *
+     * @param int $post_id The entity post id.
+     *
+     * @return array An array representing the rating obj.
+     */
+    public function set_rating_for( $post_id ) {
+
+        if ( ! $this->entity_service->is_entity( $post_id ) ) {
+            return;
+        }
+
+        // Calculate rating for the given post.
+        $rating = $this->calculate_rating_for( $post_id );
+
+        // Store the rating on db as post meta. Please notice that RATING_RAW_SCORE_META_KEY
+        // is saved on a different meta to allow score sorting. Both meta are managed as unique.
+        //
+        // See https://codex.wordpress.org/Function_Reference/update_post_meta
+        update_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, $rating['raw_score'] );
+        update_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, $rating['warnings'] );
+
+        $this->log->trace( sprintf( "Rating set for [ post_id :: $post_id ] [ rating :: %s ]", $rating['raw_score'] ) );
+
+        // Finally returns the rating
+        return $rating;
+    }
+
+
+    /**
+     * Get or calculate rating for a given entity
+     *
+     * @since 3.3.0
+     *
+     * @param int $post_id      The entity post id.
+     * @param     $force_reload $warnings_needed If true, detailed warnings collection is provided with the rating obj.
+     *
+     * @return array An array representing the rating obj.
+     */
+    public function get_rating_for( $post_id, $force_reload = false ) {
+
+        // If forced reload is required or rating is missing.
+        if ( $force_reload ) {
+            $this->log->trace( "Force rating reload [ post_id :: $post_id ]" );
+
+            return $this->set_rating_for( $post_id );
+        }
+
+        $current_raw_score = get_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, true );
+
+        if ( ! is_numeric( $current_raw_score ) ) {
+            $this->log->trace( "Rating missing for [ post_id :: $post_id ] [ current_raw_score :: $current_raw_score ]" );
+
+            return $this->set_rating_for( $post_id );
+        }
+
+        $current_warnings = get_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, true );
+
+        // Finally return score and warnings
+        return array(
+            'raw_score'           => $current_raw_score,
+            'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $current_raw_score ),
+            'percentage_score'    => $this->convert_raw_score_to_percentage( $current_raw_score ),
+            'warnings'            => $current_warnings,
+        );
+
+    }
+
+    /**
+     * Calculate rating for a given entity.
+     *
+     * Rating depends from following criteria:
+     *
+     * 1. Is the current entity related to at least 1 post?
+     * 2. Is the current entity content post not empty?
+     * 3. Is the current entity related to at least 1 entity?
+     * 4. Is the entity published?
+     * 5. There is a a thumbnail associated to the entity?
+     * 6. Has the entity a sameas defined?
+     * 7. Are all schema.org required metadata compiled?
+     *
+     * Each positive check means +1 in terms of rating score.
+     *
+     * @since 3.3.0
+     *
+     * @param int $post_id The entity post id.
+     *
+     * @return array An array representing the rating obj.
+     */
+    private function calculate_rating_for( $post_id ) {
+
+        // If it's not an entity, return.
+        if ( ! $this->entity_service->is_entity( $post_id ) ) {
+            return array();
+        }
+        // Retrieve the post object.
+        $post = get_post( $post_id );
+
+        // Rating value.
+        $score = 0;
+
+        // Store warning messages.
+        $warnings = array();
+
+        // Is the current entity related to at least 1 post?
+        ( 0 < count( wl_core_get_related_post_ids( $post->ID ) ) ) ?
+            $score ++ :
+            array_push( $warnings, __( 'There are no related posts for the current entity.', 'wordlift' ) );
+
+        // Is the post content not empty?
+        ( ! empty( $post->post_content ) ) ?
+            $score ++ :
+            array_push( $warnings, __( 'This entity has not description.', 'wordlift' ) );
+
+        // Is the current entity related to at least 1 entity?
+        // Was the current entity already disambiguated?
+        ( 0 < count( wl_core_get_related_entity_ids( $post->ID ) ) ) ?
+            $score ++ :
+            array_push( $warnings, __( 'There are no related entities for the current entity.', 'wordlift' ) );
+
+        // Is the entity published?
+        ( 'publish' === get_post_status( $post->ID ) ) ?
+            $score ++ :
+            array_push( $warnings, __( 'This entity is not published. It will not appear within analysis results.', 'wordlift' ) );
+
+        // Has a thumbnail?
+        ( has_post_thumbnail( $post->ID ) ) ?
+            $score ++ :
+            array_push( $warnings, __( 'This entity has no featured image yet.', 'wordlift' ) );
+
+        // Get all post meta keys for the current post
+        global $wpdb;
+
+        $query = $wpdb->prepare(
+            "SELECT DISTINCT (meta_key) FROM $wpdb->postmeta  WHERE post_id = %d", $post->ID
+        );
+
+        // Check intersection between available meta keys and expected ones
+        // arrays to detect missing values.
+        $available_meta_keys = $wpdb->get_col( $query );
+
+        // If each expected key is contained in available keys array ...
+        ( in_array( Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys ) ) ?
+            $score ++ :
+            array_push( $warnings, __( 'There are no sameAs configured for this entity.', 'wordlift' ) );
+
+        $schema = $this->entity_type_service->get( $post_id );
+
+        $expected_meta_keys = ( null === $schema['custom_fields'] ) ?
+            array() :
+            array_keys( $schema['custom_fields'] );
+
+        $intersection = array_intersect( $expected_meta_keys, $available_meta_keys );
+        // If each expected key is contained in available keys array ...
+        ( count( $intersection ) === count( $expected_meta_keys ) ) ?
+            $score ++ :
+            array_push( $warnings, __( 'Schema.org metadata for this entity are not completed.', 'wordlift' ) );
+
+        // Finally return score and warnings
+        return array(
+            'raw_score'           => $score,
+            'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $score ),
+            'percentage_score'    => $this->convert_raw_score_to_percentage( $score ),
+            'warnings'            => $warnings,
+        );
+
+    }
+
+    /**
+     * Get as rating as input and convert in a traffic-light rating
+     *
+     * @since 3.3.0
+     *
+     * @param int $score The rating score for a given entity.
+     *
+     * @return string The input HTML code.
+     */
+    private function convert_raw_score_to_traffic_light( $score ) {
+        // RATING_MAX : $score = 3 : x
+        // See http://php.net/manual/en/function.round.php
+        $rating = round( ( $score * 3 ) / self::RATING_MAX, 0, PHP_ROUND_HALF_UP );
+
+        // If rating is 0, return 1, otherwise return rating
+        return ( 0 == $rating ) ? 1 : $rating;
+
+    }
+
+    /**
+     * Get as rating as input and convert in a traffic-light rating
+     *
+     * @since 3.3.0
+     *
+     * @param int $score The rating score for a given entity.
+     *
+     * @return string The input HTML code.
+     */
+    public function convert_raw_score_to_percentage( $score ) {
+
+        // RATING_MAX : $score = 100 : x
+        return round( ( $score * 100 ) / self::RATING_MAX, 0, PHP_ROUND_HALF_UP );
+    }
+
+
+    /**
+     * Add admin notices for the current entity depending on the current rating.
+     *
+     * @since 3.3.0
+     */
+    public function in_admin_header() {
+
+        // Return safely if get_current_screen() is not defined (yet)
+        if ( false === function_exists( 'get_current_screen' ) ) {
+            return;
+        }
+
+        $screen = get_current_screen();
+        // If there is any valid screen nothing to do
+        if ( null === $screen ) {
+            return;
+        }
+
+        // If you're not in the entity post edit page, return.
+        if ( Wordlift_Entity_Service::TYPE_NAME !== $screen->id ) {
+            return;
+        }
+        // Retrieve the current global post
+        global $post;
+        // If it's not an entity, return.
+        if ( ! $this->entity_service->is_entity( $post->ID ) ) {
+            return;
+        }
+        // Retrieve an updated rating for the current entity
+        $rating = $this->get_rating_for( $post->ID, true );
+
+        // If there is at least 1 warning
+        if ( isset( $rating['warnings'] ) && 0 < count( $rating['warnings'] ) ) {
+            // TODO - Pass Wordlift_Notice_Service trough the service constructor
+            $this->notice_service->add_suggestion( $rating['warnings'] );
+        }
+
+    }
 
 }

Spacing +55 added lines, -63 removed lines

@@ -129,13 +129,13 @@ 
 	 * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
 	 * @param \Wordlift_Notice_Service      $notice_service      A {@link Wordlift_Notice_Service} instance.
 	 */
-	public function __construct( $entity_service, $entity_type_service, $notice_service ) {
+	public function __construct($entity_service, $entity_type_service, $notice_service) {
 
 		$this->entity_service      = $entity_service;
 		$this->entity_type_service = $entity_type_service;
 		$this->notice_service      = $notice_service;
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Rating_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Rating_Service');
 
 	}
 
@@ -148,23 +148,23 @@ 
 	 *
 	 * @return array An array representing the rating obj.
 	 */
-	public function set_rating_for( $post_id ) {
+	public function set_rating_for($post_id) {
 
-		if ( ! $this->entity_service->is_entity( $post_id ) ) {
+		if ( ! $this->entity_service->is_entity($post_id)) {
 			return;
 		}
 
 		// Calculate rating for the given post.
-		$rating = $this->calculate_rating_for( $post_id );
+		$rating = $this->calculate_rating_for($post_id);
 
 		// Store the rating on db as post meta. Please notice that RATING_RAW_SCORE_META_KEY
 		// is saved on a different meta to allow score sorting. Both meta are managed as unique.
 		//
 		// See https://codex.wordpress.org/Function_Reference/update_post_meta
-		update_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, $rating['raw_score'] );
-		update_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, $rating['warnings'] );
+		update_post_meta($post_id, self::RATING_RAW_SCORE_META_KEY, $rating['raw_score']);
+		update_post_meta($post_id, self::RATING_WARNINGS_META_KEY, $rating['warnings']);
 
-		$this->log->trace( sprintf( "Rating set for [ post_id :: $post_id ] [ rating :: %s ]", $rating['raw_score'] ) );
+		$this->log->trace(sprintf("Rating set for [ post_id :: $post_id ] [ rating :: %s ]", $rating['raw_score']));
 
 		// Finally returns the rating
 		return $rating;
@@ -181,30 +181,30 @@ 
 	 *
 	 * @return array An array representing the rating obj.
 	 */
-	public function get_rating_for( $post_id, $force_reload = false ) {
+	public function get_rating_for($post_id, $force_reload = false) {
 
 		// If forced reload is required or rating is missing.
-		if ( $force_reload ) {
-			$this->log->trace( "Force rating reload [ post_id :: $post_id ]" );
+		if ($force_reload) {
+			$this->log->trace("Force rating reload [ post_id :: $post_id ]");
 
-			return $this->set_rating_for( $post_id );
+			return $this->set_rating_for($post_id);
 		}
 
-		$current_raw_score = get_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, true );
+		$current_raw_score = get_post_meta($post_id, self::RATING_RAW_SCORE_META_KEY, true);
 
-		if ( ! is_numeric( $current_raw_score ) ) {
-			$this->log->trace( "Rating missing for [ post_id :: $post_id ] [ current_raw_score :: $current_raw_score ]" );
+		if ( ! is_numeric($current_raw_score)) {
+			$this->log->trace("Rating missing for [ post_id :: $post_id ] [ current_raw_score :: $current_raw_score ]");
 
-			return $this->set_rating_for( $post_id );
+			return $this->set_rating_for($post_id);
 		}
 
-		$current_warnings = get_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, true );
+		$current_warnings = get_post_meta($post_id, self::RATING_WARNINGS_META_KEY, true);
 
 		// Finally return score and warnings
 		return array(
 			'raw_score'           => $current_raw_score,
-			'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $current_raw_score ),
-			'percentage_score'    => $this->convert_raw_score_to_percentage( $current_raw_score ),
+			'traffic_light_score' => $this->convert_raw_score_to_traffic_light($current_raw_score),
+			'percentage_score'    => $this->convert_raw_score_to_percentage($current_raw_score),
 			'warnings'            => $current_warnings,
 		);
 
@@ -231,14 +231,14 @@ 
 	 *
 	 * @return array An array representing the rating obj.
 	 */
-	private function calculate_rating_for( $post_id ) {
+	private function calculate_rating_for($post_id) {
 
 		// If it's not an entity, return.
-		if ( ! $this->entity_service->is_entity( $post_id ) ) {
+		if ( ! $this->entity_service->is_entity($post_id)) {
 			return array();
 		}
 		// Retrieve the post object.
-		$post = get_post( $post_id );
+		$post = get_post($post_id);
 
 		// Rating value.
 		$score = 0;
@@ -247,30 +247,25 @@ 
 		$warnings = array();
 
 		// Is the current entity related to at least 1 post?
-		( 0 < count( wl_core_get_related_post_ids( $post->ID ) ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'There are no related posts for the current entity.', 'wordlift' ) );
+		(0 < count(wl_core_get_related_post_ids($post->ID))) ?
+			$score++ : array_push($warnings, __('There are no related posts for the current entity.', 'wordlift'));
 
 		// Is the post content not empty?
-		( ! empty( $post->post_content ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'This entity has not description.', 'wordlift' ) );
+		( ! empty($post->post_content)) ?
+			$score++ : array_push($warnings, __('This entity has not description.', 'wordlift'));
 
 		// Is the current entity related to at least 1 entity?
 		// Was the current entity already disambiguated?
-		( 0 < count( wl_core_get_related_entity_ids( $post->ID ) ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'There are no related entities for the current entity.', 'wordlift' ) );
+		(0 < count(wl_core_get_related_entity_ids($post->ID))) ?
+			$score++ : array_push($warnings, __('There are no related entities for the current entity.', 'wordlift'));
 
 		// Is the entity published?
-		( 'publish' === get_post_status( $post->ID ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'This entity is not published. It will not appear within analysis results.', 'wordlift' ) );
+		('publish' === get_post_status($post->ID)) ?
+			$score++ : array_push($warnings, __('This entity is not published. It will not appear within analysis results.', 'wordlift'));
 
 		// Has a thumbnail?
-		( has_post_thumbnail( $post->ID ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'This entity has no featured image yet.', 'wordlift' ) );
+		(has_post_thumbnail($post->ID)) ?
+			$score++ : array_push($warnings, __('This entity has no featured image yet.', 'wordlift'));
 
 		// Get all post meta keys for the current post
 		global $wpdb;
@@ -281,30 +276,27 @@ 
 
 		// Check intersection between available meta keys and expected ones
 		// arrays to detect missing values.
-		$available_meta_keys = $wpdb->get_col( $query );
+		$available_meta_keys = $wpdb->get_col($query);
 
 		// If each expected key is contained in available keys array ...
-		( in_array( Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'There are no sameAs configured for this entity.', 'wordlift' ) );
+		(in_array(Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys)) ?
+			$score++ : array_push($warnings, __('There are no sameAs configured for this entity.', 'wordlift'));
 
-		$schema = $this->entity_type_service->get( $post_id );
+		$schema = $this->entity_type_service->get($post_id);
 
-		$expected_meta_keys = ( null === $schema['custom_fields'] ) ?
-			array() :
-			array_keys( $schema['custom_fields'] );
+		$expected_meta_keys = (null === $schema['custom_fields']) ?
+			array() : array_keys($schema['custom_fields']);
 
-		$intersection = array_intersect( $expected_meta_keys, $available_meta_keys );
+		$intersection = array_intersect($expected_meta_keys, $available_meta_keys);
 		// If each expected key is contained in available keys array ...
-		( count( $intersection ) === count( $expected_meta_keys ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'Schema.org metadata for this entity are not completed.', 'wordlift' ) );
+		(count($intersection) === count($expected_meta_keys)) ?
+			$score++ : array_push($warnings, __('Schema.org metadata for this entity are not completed.', 'wordlift'));
 
 		// Finally return score and warnings
 		return array(
 			'raw_score'           => $score,
-			'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $score ),
-			'percentage_score'    => $this->convert_raw_score_to_percentage( $score ),
+			'traffic_light_score' => $this->convert_raw_score_to_traffic_light($score),
+			'percentage_score'    => $this->convert_raw_score_to_percentage($score),
 			'warnings'            => $warnings,
 		);
 
@@ -319,13 +311,13 @@ 
 	 *
 	 * @return string The input HTML code.
 	 */
-	private function convert_raw_score_to_traffic_light( $score ) {
+	private function convert_raw_score_to_traffic_light($score) {
 		// RATING_MAX : $score = 3 : x
 		// See http://php.net/manual/en/function.round.php
-		$rating = round( ( $score * 3 ) / self::RATING_MAX, 0, PHP_ROUND_HALF_UP );
+		$rating = round(($score * 3) / self::RATING_MAX, 0, PHP_ROUND_HALF_UP);
 
 		// If rating is 0, return 1, otherwise return rating
-		return ( 0 == $rating ) ? 1 : $rating;
+		return (0 == $rating) ? 1 : $rating;
 
 	}
 
@@ -338,10 +330,10 @@ 
 	 *
 	 * @return string The input HTML code.
 	 */
-	public function convert_raw_score_to_percentage( $score ) {
+	public function convert_raw_score_to_percentage($score) {
 
 		// RATING_MAX : $score = 100 : x
-		return round( ( $score * 100 ) / self::RATING_MAX, 0, PHP_ROUND_HALF_UP );
+		return round(($score * 100) / self::RATING_MAX, 0, PHP_ROUND_HALF_UP);
 	}
 
 
@@ -353,33 +345,33 @@ 
 	public function in_admin_header() {
 
 		// Return safely if get_current_screen() is not defined (yet)
-		if ( false === function_exists( 'get_current_screen' ) ) {
+		if (false === function_exists('get_current_screen')) {
 			return;
 		}
 
 		$screen = get_current_screen();
 		// If there is any valid screen nothing to do
-		if ( null === $screen ) {
+		if (null === $screen) {
 			return;
 		}
 
 		// If you're not in the entity post edit page, return.
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $screen->id ) {
+		if (Wordlift_Entity_Service::TYPE_NAME !== $screen->id) {
 			return;
 		}
 		// Retrieve the current global post
 		global $post;
 		// If it's not an entity, return.
-		if ( ! $this->entity_service->is_entity( $post->ID ) ) {
+		if ( ! $this->entity_service->is_entity($post->ID)) {
 			return;
 		}
 		// Retrieve an updated rating for the current entity
-		$rating = $this->get_rating_for( $post->ID, true );
+		$rating = $this->get_rating_for($post->ID, true);
 
 		// If there is at least 1 warning
-		if ( isset( $rating['warnings'] ) && 0 < count( $rating['warnings'] ) ) {
+		if (isset($rating['warnings']) && 0 < count($rating['warnings'])) {
 			// TODO - Pass Wordlift_Notice_Service trough the service constructor
-			$this->notice_service->add_suggestion( $rating['warnings'] );
+			$this->notice_service->add_suggestion($rating['warnings']);
 		}
 
 	}

src/includes/properties/class-wordlift-property-entity-reference.php

Indentation +48 added lines, -48 removed lines

@@ -16,61 +16,61 @@
  */
 class Wordlift_Property_Entity_Reference {
 
-	/**
-	 * The URL associated with this entity reference.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var string $url The URL associated with the entity reference.
-	 */
-	private $url;
+    /**
+     * The URL associated with this entity reference.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var string $url The URL associated with the entity reference.
+     */
+    private $url;
 
-	/**
-	 * The entity post id.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var int $id The entity post id.
-	 */
-	private $id;
+    /**
+     * The entity post id.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var int $id The entity post id.
+     */
+    private $id;
 
-	/**
-	 * Create a Wordlift_Property_Entity_Reference instance with the provided URL.
-	 *
-	 * @since 3.8.0
-	 *
-	 * @param string $url The URL.
-	 * @param int    $id  The entity post id.
-	 */
-	public function __construct( $url, $id ) {
+    /**
+     * Create a Wordlift_Property_Entity_Reference instance with the provided URL.
+     *
+     * @since 3.8.0
+     *
+     * @param string $url The URL.
+     * @param int    $id  The entity post id.
+     */
+    public function __construct( $url, $id ) {
 
-		$this->url = $url;
-		$this->id  = $id;
+        $this->url = $url;
+        $this->id  = $id;
 
-	}
+    }
 
-	/**
-	 * Get the URL associated with this entity reference.
-	 *
-	 * @since 3.8.0
-	 *
-	 * @return string The URL associated with the entity reference.
-	 */
-	public function getURL() {
+    /**
+     * Get the URL associated with this entity reference.
+     *
+     * @since 3.8.0
+     *
+     * @return string The URL associated with the entity reference.
+     */
+    public function getURL() {
 
-		return $this->url;
-	}
+        return $this->url;
+    }
 
-	/**
-	 * Get the entity id.
-	 *
-	 * @since 3.10.0
-	 *
-	 * @return int The entity id.
-	 */
-	public function getID() {
+    /**
+     * Get the entity id.
+     *
+     * @since 3.10.0
+     *
+     * @return int The entity id.
+     */
+    public function getID() {
 
-		return $this->id;
-	}
+        return $this->id;
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
 	 * @param string $url The URL.
 	 * @param int    $id  The entity post id.
 	 */
-	public function __construct( $url, $id ) {
+	public function __construct($url, $id) {
 
 		$this->url = $url;
 		$this->id  = $id;

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

Indentation +33 added lines, -33 removed lines

@@ -7,38 +7,38 @@
  * @since 3.8.0
  */
 class Wordlift_Entity_Property_Service extends Wordlift_Simple_Property_Service {
-	/**
-	 * @var \Wordlift_Entity_Service $entity_service
-	 */
-	private $entity_service;
-
-	/**
-	 * Wordlift_Entity_Property_Service constructor.
-	 *
-	 * @param \Wordlift_Entity_Service $entity_service
-	 */
-	public function __construct( $entity_service ) {
-
-		$this->entity_service = $entity_service;
-
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get( $post_id, $meta_key ) {
-
-		$entity_service = $this->entity_service;
-
-		// Map each returned value to a Wordlift_Property_Entity_Reference.
-		return array_map( function ( $item ) use ( $entity_service ) {
-
-			// If the $item is a number and it's an existing post, return the
-			// URI of the referenced entity. Otherwise return the value.
-			return is_numeric( $item ) && null !== get_post( $item )
-				? new Wordlift_Property_Entity_Reference( $entity_service->get_uri( $item ), $item )
-				: $item;
-		}, get_post_meta( $post_id, $meta_key ) );
-	}
+    /**
+     * @var \Wordlift_Entity_Service $entity_service
+     */
+    private $entity_service;
+
+    /**
+     * Wordlift_Entity_Property_Service constructor.
+     *
+     * @param \Wordlift_Entity_Service $entity_service
+     */
+    public function __construct( $entity_service ) {
+
+        $this->entity_service = $entity_service;
+
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get( $post_id, $meta_key ) {
+
+        $entity_service = $this->entity_service;
+
+        // Map each returned value to a Wordlift_Property_Entity_Reference.
+        return array_map( function ( $item ) use ( $entity_service ) {
+
+            // If the $item is a number and it's an existing post, return the
+            // URI of the referenced entity. Otherwise return the value.
+            return is_numeric( $item ) && null !== get_post( $item )
+                ? new Wordlift_Property_Entity_Reference( $entity_service->get_uri( $item ), $item )
+                : $item;
+        }, get_post_meta( $post_id, $meta_key ) );
+    }
 
 }

Spacing +6 added lines, -6 removed lines

@@ -17,7 +17,7 @@ 
 	 *
 	 * @param \Wordlift_Entity_Service $entity_service
 	 */
-	public function __construct( $entity_service ) {
+	public function __construct($entity_service) {
 
 		$this->entity_service = $entity_service;
 
@@ -26,19 +26,19 @@ 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function get( $post_id, $meta_key ) {
+	public function get($post_id, $meta_key) {
 
 		$entity_service = $this->entity_service;
 
 		// Map each returned value to a Wordlift_Property_Entity_Reference.
-		return array_map( function ( $item ) use ( $entity_service ) {
+		return array_map(function($item) use ($entity_service) {
 
 			// If the $item is a number and it's an existing post, return the
 			// URI of the referenced entity. Otherwise return the value.
-			return is_numeric( $item ) && null !== get_post( $item )
-				? new Wordlift_Property_Entity_Reference( $entity_service->get_uri( $item ), $item )
+			return is_numeric($item) && null !== get_post($item)
+				? new Wordlift_Property_Entity_Reference($entity_service->get_uri($item), $item)
 				: $item;
-		}, get_post_meta( $post_id, $meta_key ) );
+		}, get_post_meta($post_id, $meta_key));
 	}
 
 }

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

Indentation +61 added lines, -61 removed lines

@@ -13,66 +13,66 @@
  */
 class Wordlift_Debug_Service {
 
-	/**
-	 * The {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.7.2
-	 * @access private
-	 * @var Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Uri_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_Uri_Service $uri_service A {@link Wordlift_Uri_Service} instance.
-	 */
-	private $uri_service;
-
-	/**
-	 * Wordlift_Debug_Service constructor.
-	 *
-	 * @since 3.7.2
-	 *
-	 * @param Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Uri_Service   $uri_service    A {@link Wordlift_Uri_Service} instance.
-	 */
-	public function __construct( $entity_service, $uri_service ) {
-
-		$this->entity_service = $entity_service;
-		$this->uri_service    = $uri_service;
-
-		add_action( 'wp_ajax_wl_dump_uri', array( $this, 'dump_uri' ) );
-
-	}
-
-	public function dump_uri() {
-
-		if ( ! isset( $_GET['id'] ) ) {
-			wp_send_json_error( 'id not set' );
-		}
-
-		$post_id = $_GET['id'];
-
-		$post = get_post( $post_id );
-
-		$uri       = $this->entity_service->get_uri( $post_id );
-		$encoding  = mb_detect_encoding( $uri );
-		$build_uri = $this->uri_service->build_uri( $post->post_title, $post->post_type );
-
-
-		var_dump( $uri );
-
-		wp_send_json_success( array(
-			'uri'               => $uri,
-			'post_title'        => sprintf( '%s (%s)', $post->post_title, mb_detect_encoding( $post->post_title ) ),
-			'post_title_ascii'  => mb_convert_encoding( $post->post_title, 'ASCII' ),
-			'build_uri'         => $build_uri,
-			'build_uri_convert' => mb_convert_encoding( $build_uri, 'ASCII' ),
-		) );
-
-	}
+    /**
+     * The {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.7.2
+     * @access private
+     * @var Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Uri_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_Uri_Service $uri_service A {@link Wordlift_Uri_Service} instance.
+     */
+    private $uri_service;
+
+    /**
+     * Wordlift_Debug_Service constructor.
+     *
+     * @since 3.7.2
+     *
+     * @param Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Uri_Service   $uri_service    A {@link Wordlift_Uri_Service} instance.
+     */
+    public function __construct( $entity_service, $uri_service ) {
+
+        $this->entity_service = $entity_service;
+        $this->uri_service    = $uri_service;
+
+        add_action( 'wp_ajax_wl_dump_uri', array( $this, 'dump_uri' ) );
+
+    }
+
+    public function dump_uri() {
+
+        if ( ! isset( $_GET['id'] ) ) {
+            wp_send_json_error( 'id not set' );
+        }
+
+        $post_id = $_GET['id'];
+
+        $post = get_post( $post_id );
+
+        $uri       = $this->entity_service->get_uri( $post_id );
+        $encoding  = mb_detect_encoding( $uri );
+        $build_uri = $this->uri_service->build_uri( $post->post_title, $post->post_type );
+
+
+        var_dump( $uri );
+
+        wp_send_json_success( array(
+            'uri'               => $uri,
+            'post_title'        => sprintf( '%s (%s)', $post->post_title, mb_detect_encoding( $post->post_title ) ),
+            'post_title_ascii'  => mb_convert_encoding( $post->post_title, 'ASCII' ),
+            'build_uri'         => $build_uri,
+            'build_uri_convert' => mb_convert_encoding( $build_uri, 'ASCII' ),
+        ) );
+
+    }
 
 }
\ No newline at end of file

Spacing +14 added lines, -14 removed lines

@@ -39,39 +39,39 @@
 	 * @param Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
 	 * @param \Wordlift_Uri_Service   $uri_service    A {@link Wordlift_Uri_Service} instance.
 	 */
-	public function __construct( $entity_service, $uri_service ) {
+	public function __construct($entity_service, $uri_service) {
 
 		$this->entity_service = $entity_service;
 		$this->uri_service    = $uri_service;
 
-		add_action( 'wp_ajax_wl_dump_uri', array( $this, 'dump_uri' ) );
+		add_action('wp_ajax_wl_dump_uri', array($this, 'dump_uri'));
 
 	}
 
 	public function dump_uri() {
 
-		if ( ! isset( $_GET['id'] ) ) {
-			wp_send_json_error( 'id not set' );
+		if ( ! isset($_GET['id'])) {
+			wp_send_json_error('id not set');
 		}
 
 		$post_id = $_GET['id'];
 
-		$post = get_post( $post_id );
+		$post = get_post($post_id);
 
-		$uri       = $this->entity_service->get_uri( $post_id );
-		$encoding  = mb_detect_encoding( $uri );
-		$build_uri = $this->uri_service->build_uri( $post->post_title, $post->post_type );
+		$uri       = $this->entity_service->get_uri($post_id);
+		$encoding  = mb_detect_encoding($uri);
+		$build_uri = $this->uri_service->build_uri($post->post_title, $post->post_type);
 
 
-		var_dump( $uri );
+		var_dump($uri);
 
-		wp_send_json_success( array(
+		wp_send_json_success(array(
 			'uri'               => $uri,
-			'post_title'        => sprintf( '%s (%s)', $post->post_title, mb_detect_encoding( $post->post_title ) ),
-			'post_title_ascii'  => mb_convert_encoding( $post->post_title, 'ASCII' ),
+			'post_title'        => sprintf('%s (%s)', $post->post_title, mb_detect_encoding($post->post_title)),
+			'post_title_ascii'  => mb_convert_encoding($post->post_title, 'ASCII'),
 			'build_uri'         => $build_uri,
-			'build_uri_convert' => mb_convert_encoding( $build_uri, 'ASCII' ),
-		) );
+			'build_uri_convert' => mb_convert_encoding($build_uri, 'ASCII'),
+		));
 
 	}
 

src/public/class-wordlift-seo-service.php

Indentation +46 added lines, -46 removed lines

@@ -21,66 +21,66 @@
  */
 class Wordlift_Seo_Service {
 
-	/**
-	 * @inheritdoc
-	 */
-	function __construct() {
+    /**
+     * @inheritdoc
+     */
+    function __construct() {
 
-		// If we are not on the admin, run the get_term filter for entity type terms.
-		add_filter( 'get_wl_entity_type', array(
-			$this,
-			'get_wl_entity_type',
-		), 10, 2 );
+        // If we are not on the admin, run the get_term filter for entity type terms.
+        add_filter( 'get_wl_entity_type', array(
+            $this,
+            'get_wl_entity_type',
+        ), 10, 2 );
 
-	}
+    }
 
-	/**
-	 * Filter the entity term object, and when not in admin context replace title
-	 * and description with whatever was set in the entity settings page.
-	 *
-	 * @since    3.11
-	 *
-	 * @param WP_Term $term     The term to filters.
-	 * @param string  $taxonomy The taxonomy name.
-	 *
-	 * @return WP_Term The {@link WP_Term} with fields changed.
-	 */
-	function get_wl_entity_type( $term, $taxonomy ) {
+    /**
+     * Filter the entity term object, and when not in admin context replace title
+     * and description with whatever was set in the entity settings page.
+     *
+     * @since    3.11
+     *
+     * @param WP_Term $term     The term to filters.
+     * @param string  $taxonomy The taxonomy name.
+     *
+     * @return WP_Term The {@link WP_Term} with fields changed.
+     */
+    function get_wl_entity_type( $term, $taxonomy ) {
 
-		// Do nothing when in admin.
-		if ( is_admin() ) {
-			return $term;
-		}
+        // Do nothing when in admin.
+        if ( is_admin() ) {
+            return $term;
+        }
 
-		// Get the terms' settings.
-		$entity_settings = get_option( 'wl_entity_type_settings', array() );
+        // Get the terms' settings.
+        $entity_settings = get_option( 'wl_entity_type_settings', array() );
 
-		// If we have no settings for the specified term, then return the original
-		// term.
-		if ( ! isset( $entity_settings[ $term->term_id ] ) ) {
+        // If we have no settings for the specified term, then return the original
+        // term.
+        if ( ! isset( $entity_settings[ $term->term_id ] ) ) {
 
-			return $term;
-		}
+            return $term;
+        }
 
-		// Get the settings for the specified term.
-		$settings = $entity_settings[ $term->term_id ];
+        // Get the settings for the specified term.
+        $settings = $entity_settings[ $term->term_id ];
 
-		// Update the name.
-		if ( ! empty( $settings['title'] ) ) {
+        // Update the name.
+        if ( ! empty( $settings['title'] ) ) {
 
-			$term->name = $settings['title'];
+            $term->name = $settings['title'];
 
-		}
+        }
 
-		// Update the description.
-		if ( ! empty( $settings['description'] ) ) {
+        // Update the description.
+        if ( ! empty( $settings['description'] ) ) {
 
-			$term->description = $settings['description'];
+            $term->description = $settings['description'];
 
-		}
+        }
 
-		// Return the updated term.
-		return $term;
-	}
+        // Return the updated term.
+        return $term;
+    }
 
 }

Spacing +9 added lines, -9 removed lines

@@ -27,10 +27,10 @@ 
 	function __construct() {
 
 		// If we are not on the admin, run the get_term filter for entity type terms.
-		add_filter( 'get_wl_entity_type', array(
+		add_filter('get_wl_entity_type', array(
 			$this,
 			'get_wl_entity_type',
-		), 10, 2 );
+		), 10, 2);
 
 	}
 
@@ -45,35 +45,35 @@ 
 	 *
 	 * @return WP_Term The {@link WP_Term} with fields changed.
 	 */
-	function get_wl_entity_type( $term, $taxonomy ) {
+	function get_wl_entity_type($term, $taxonomy) {
 
 		// Do nothing when in admin.
-		if ( is_admin() ) {
+		if (is_admin()) {
 			return $term;
 		}
 
 		// Get the terms' settings.
-		$entity_settings = get_option( 'wl_entity_type_settings', array() );
+		$entity_settings = get_option('wl_entity_type_settings', array());
 
 		// If we have no settings for the specified term, then return the original
 		// term.
-		if ( ! isset( $entity_settings[ $term->term_id ] ) ) {
+		if ( ! isset($entity_settings[$term->term_id])) {
 
 			return $term;
 		}
 
 		// Get the settings for the specified term.
-		$settings = $entity_settings[ $term->term_id ];
+		$settings = $entity_settings[$term->term_id];
 
 		// Update the name.
-		if ( ! empty( $settings['title'] ) ) {
+		if ( ! empty($settings['title'])) {
 
 			$term->name = $settings['title'];
 
 		}
 
 		// Update the description.
-		if ( ! empty( $settings['description'] ) ) {
+		if ( ! empty($settings['description'])) {
 
 			$term->description = $settings['description'];
 

src/public/class-wordlift-widget.php

Indentation +16 added lines, -16 removed lines

@@ -16,26 +16,26 @@
  */
 abstract class Wordlift_Widget extends WP_Widget {
 
-	/**
-	 * @inheritdoc
-	 */
-	public function __construct( $id_base, $name, array $widget_options = array(), array $control_options = array() ) {
-		parent::__construct( $id_base, $name, $widget_options, $control_options );
+    /**
+     * @inheritdoc
+     */
+    public function __construct( $id_base, $name, array $widget_options = array(), array $control_options = array() ) {
+        parent::__construct( $id_base, $name, $widget_options, $control_options );
 
-		// Initialize the Related Entities Cloud Widget.
-		add_action( 'widgets_init', array( $this, 'widget_init' ) );
+        // Initialize the Related Entities Cloud Widget.
+        add_action( 'widgets_init', array( $this, 'widget_init' ) );
 
-	}
+    }
 
-	/**
-	 * Register the related entities cloud widget
-	 *
-	 * @since 3.11.0
-	 */
-	public function widget_init() {
+    /**
+     * Register the related entities cloud widget
+     *
+     * @since 3.11.0
+     */
+    public function widget_init() {
 
-		register_widget( get_class( $this ) );
+        register_widget( get_class( $this ) );
 
-	}
+    }
 
 }

Spacing +4 added lines, -4 removed lines

@@ -19,11 +19,11 @@ 
 	/**
 	 * @inheritdoc
 	 */
-	public function __construct( $id_base, $name, array $widget_options = array(), array $control_options = array() ) {
-		parent::__construct( $id_base, $name, $widget_options, $control_options );
+	public function __construct($id_base, $name, array $widget_options = array(), array $control_options = array()) {
+		parent::__construct($id_base, $name, $widget_options, $control_options);
 
 		// Initialize the Related Entities Cloud Widget.
-		add_action( 'widgets_init', array( $this, 'widget_init' ) );
+		add_action('widgets_init', array($this, 'widget_init'));
 
 	}
 
@@ -34,7 +34,7 @@ 
 	 */
 	public function widget_init() {
 
-		register_widget( get_class( $this ) );
+		register_widget(get_class($this));
 
 	}
 

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

Indentation +40 added lines, -40 removed lines

@@ -16,55 +16,55 @@
  */
 class Wordlift_Publisher_Ajax_Adapter {
 
-	/**
-	 * The {@link Wordlift_Publisher_Service} instance.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var Wordlift_Publisher_Service $publisher_service The {@link Wordlift_Publisher_Service} instance.
-	 */
-	private $publisher_service;
+    /**
+     * The {@link Wordlift_Publisher_Service} instance.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var Wordlift_Publisher_Service $publisher_service The {@link Wordlift_Publisher_Service} instance.
+     */
+    private $publisher_service;
 
-	/**
-	 * Create a {@link Wordlift_Publisher_Ajax_Adapter} instance.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param \Wordlift_Publisher_Service $publisher_service The {@link Wordlift_Publisher_Service} instance.
-	 */
-	function __construct( $publisher_service ) {
+    /**
+     * Create a {@link Wordlift_Publisher_Ajax_Adapter} instance.
+     *
+     * @since 3.11.0
+     *
+     * @param \Wordlift_Publisher_Service $publisher_service The {@link Wordlift_Publisher_Service} instance.
+     */
+    function __construct( $publisher_service ) {
 
-		$this->publisher_service = $publisher_service;
+        $this->publisher_service = $publisher_service;
 
-	}
+    }
 
-	/**
-	 * The publisher AJAX action. This function is hook to the `wl_publisher`
-	 * action.
-	 *
-	 * @since 3.11.0
-	 */
-	public function publisher() {
+    /**
+     * The publisher AJAX action. This function is hook to the `wl_publisher`
+     * action.
+     *
+     * @since 3.11.0
+     */
+    public function publisher() {
 
-		// Ensure we don't have garbage before us.
-		ob_clean();
+        // Ensure we don't have garbage before us.
+        ob_clean();
 
-		// Check if the current user can `manage_options`.
-		if ( ! current_user_can( 'manage_options' ) ) {
-			wp_send_json_error( 'Access denied.' );
-		}
+        // Check if the current user can `manage_options`.
+        if ( ! current_user_can( 'manage_options' ) ) {
+            wp_send_json_error( 'Access denied.' );
+        }
 
-		// No actual search parameter was passed, bail out.
-		if ( ! isset( $_POST['q'] ) || empty( $_POST['q'] ) ) {
-			wp_send_json_error( 'The q parameter is required.' );
-		}
+        // No actual search parameter was passed, bail out.
+        if ( ! isset( $_POST['q'] ) || empty( $_POST['q'] ) ) {
+            wp_send_json_error( 'The q parameter is required.' );
+        }
 
-		// Get the response.
-		$response = $this->publisher_service->query( $_POST['q'] );
+        // Get the response.
+        $response = $this->publisher_service->query( $_POST['q'] );
 
-		// Finally output the response.
-		wp_send_json_success( $response );
+        // Finally output the response.
+        wp_send_json_success( $response );
 
-	}
+    }
 
 }

Spacing +7 added lines, -7 removed lines

@@ -32,7 +32,7 @@ 
 	 *
 	 * @param \Wordlift_Publisher_Service $publisher_service The {@link Wordlift_Publisher_Service} instance.
 	 */
-	function __construct( $publisher_service ) {
+	function __construct($publisher_service) {
 
 		$this->publisher_service = $publisher_service;
 
@@ -50,20 +50,20 @@ 
 		ob_clean();
 
 		// Check if the current user can `manage_options`.
-		if ( ! current_user_can( 'manage_options' ) ) {
-			wp_send_json_error( 'Access denied.' );
+		if ( ! current_user_can('manage_options')) {
+			wp_send_json_error('Access denied.');
 		}
 
 		// No actual search parameter was passed, bail out.
-		if ( ! isset( $_POST['q'] ) || empty( $_POST['q'] ) ) {
-			wp_send_json_error( 'The q parameter is required.' );
+		if ( ! isset($_POST['q']) || empty($_POST['q'])) {
+			wp_send_json_error('The q parameter is required.');
 		}
 
 		// Get the response.
-		$response = $this->publisher_service->query( $_POST['q'] );
+		$response = $this->publisher_service->query($_POST['q']);
 
 		// Finally output the response.
-		wp_send_json_success( $response );
+		wp_send_json_success($response);
 
 	}
 

src/includes/class-wordlift-category-taxonomy-service.php

Indentation +59 added lines, -59 removed lines

@@ -18,74 +18,74 @@
  */
 class Wordlift_Category_Taxonomy_Service {
 
-	/**
-	 * The {@link Wordlift_Entity_Post_Type_Service} instance.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
-	 */
-	private $entity_post_type_service;
+    /**
+     * The {@link Wordlift_Entity_Post_Type_Service} instance.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
+     */
+    private $entity_post_type_service;
 
-	/**
-	 * Create a {@link Wordlift_Category_Taxonomy_Service} instance.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
-	 */
-	function __construct( $entity_post_type_service ) {
+    /**
+     * Create a {@link Wordlift_Category_Taxonomy_Service} instance.
+     *
+     * @since 3.11.0
+     *
+     * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
+     */
+    function __construct( $entity_post_type_service ) {
 
-		$this->entity_post_type_service = $entity_post_type_service;
+        $this->entity_post_type_service = $entity_post_type_service;
 
-	}
+    }
 
-	/**
-	 * Set the entity post types as one to be included in archive pages.
-	 *
-	 * In order to have entities show up in standard WP categories (Posts categories)
-	 * we configure the `entity` post type, but we also need to alter the main
-	 * WP query (which by default queries posts only) to include the `entities`.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param WP_Query $query WP's {@link WP_Query} instance.
-	 */
-	public function pre_get_posts( $query ) {
+    /**
+     * Set the entity post types as one to be included in archive pages.
+     *
+     * In order to have entities show up in standard WP categories (Posts categories)
+     * we configure the `entity` post type, but we also need to alter the main
+     * WP query (which by default queries posts only) to include the `entities`.
+     *
+     * @since 3.11.0
+     *
+     * @param WP_Query $query WP's {@link WP_Query} instance.
+     */
+    public function pre_get_posts( $query ) {
 
-		// Only for the main query, avoid problems with widgets and what not.
-		if ( ! $query->is_main_query() ) {
-			return;
-		}
+        // Only for the main query, avoid problems with widgets and what not.
+        if ( ! $query->is_main_query() ) {
+            return;
+        }
 
-		// We don't want to alter the query if we're in the admin UI, if this is
-		// not a category query, or if the `suppress_filters` is set.
-		//
-		// Note that it is unlikely for `suppress_filter` to be set on the front
-		// end, but let's be safe if it is set the calling code assumes no
-		// modifications of queries.
-		//
-		// is_admin is needed, otherwise category based post filters will show
-		// both types and at the current release (4.7) it causes PHP errors.
-		if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) {
-			return;
-		}
+        // We don't want to alter the query if we're in the admin UI, if this is
+        // not a category query, or if the `suppress_filters` is set.
+        //
+        // Note that it is unlikely for `suppress_filter` to be set on the front
+        // end, but let's be safe if it is set the calling code assumes no
+        // modifications of queries.
+        //
+        // is_admin is needed, otherwise category based post filters will show
+        // both types and at the current release (4.7) it causes PHP errors.
+        if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) {
+            return;
+        }
 
-		// Check the current post types, maybe the category archive pages
-		// are already associated with other post types.
-		//
-		// If `post_type` isn't set, WP assumes `post` by default.
-		$post_types = (array) ( $query->get( 'post_type' ) ?: 'post' );
+        // Check the current post types, maybe the category archive pages
+        // are already associated with other post types.
+        //
+        // If `post_type` isn't set, WP assumes `post` by default.
+        $post_types = (array) ( $query->get( 'post_type' ) ?: 'post' );
 
-		// Add the entities post type only if the post post type is used in the query
-		// since we only want `entities` to appear alongside posts.
-		if ( in_array( 'post', $post_types ) ) {
-			$post_types[] = $this->entity_post_type_service->get_post_type();
-		}
+        // Add the entities post type only if the post post type is used in the query
+        // since we only want `entities` to appear alongside posts.
+        if ( in_array( 'post', $post_types ) ) {
+            $post_types[] = $this->entity_post_type_service->get_post_type();
+        }
 
-		// Update the query post types.
-		$query->set( 'post_type', $post_types );
+        // Update the query post types.
+        $query->set( 'post_type', $post_types );
 
-	}
+    }
 
 }

Spacing +7 added lines, -7 removed lines

@@ -34,7 +34,7 @@ 
 	 *
 	 * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
 	 */
-	function __construct( $entity_post_type_service ) {
+	function __construct($entity_post_type_service) {
 
 		$this->entity_post_type_service = $entity_post_type_service;
 
@@ -51,10 +51,10 @@ 
 	 *
 	 * @param WP_Query $query WP's {@link WP_Query} instance.
 	 */
-	public function pre_get_posts( $query ) {
+	public function pre_get_posts($query) {
 
 		// Only for the main query, avoid problems with widgets and what not.
-		if ( ! $query->is_main_query() ) {
+		if ( ! $query->is_main_query()) {
 			return;
 		}
 
@@ -67,7 +67,7 @@ 
 		//
 		// is_admin is needed, otherwise category based post filters will show
 		// both types and at the current release (4.7) it causes PHP errors.
-		if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) {
+		if (is_admin() || ! is_category() || ! empty($query->query_vars['suppress_filters'])) {
 			return;
 		}
 
@@ -75,16 +75,16 @@ 
 		// are already associated with other post types.
 		//
 		// If `post_type` isn't set, WP assumes `post` by default.
-		$post_types = (array) ( $query->get( 'post_type' ) ?: 'post' );
+		$post_types = (array) ($query->get('post_type') ?: 'post');
 
 		// Add the entities post type only if the post post type is used in the query
 		// since we only want `entities` to appear alongside posts.
-		if ( in_array( 'post', $post_types ) ) {
+		if (in_array('post', $post_types)) {
 			$post_types[] = $this->entity_post_type_service->get_post_type();
 		}
 
 		// Update the query post types.
-		$query->set( 'post_type', $post_types );
+		$query->set('post_type', $post_types);
 
 	}
 

src/widgets/wordlift_widget_timeline.php

Indentation +42 added lines, -42 removed lines

@@ -2,52 +2,52 @@
 
 class Wordlift_Timeline_Widget extends WP_Widget {
 
-	/**
-	 * Sets up the widgets name etc
-	 */
-	public function __construct() {
-		// widget actual processes
-		parent::__construct(
-			'wl_timeline_widget', // Base ID
-			__( 'WordLift Timeline Widget', 'wordlift' ), // Name
-			array( 'description' => __( 'Displays entities of type event using an interactive timeline.', 'wordlift' ), ) // Args
-		);
-	}
-
-	/**
-	 * Outputs the content of the widget
-	 *
-	 * @param array $args
-	 * @param array $instance
-	 */
-	public function widget( $args, $instance ) {
-		// outputs the content of the widget	
-		echo do_shortcode( '[wl_timeline global=true]' );
-	}
-
-	/**
-	 * Outputs the options form on admin
-	 *
-	 * @param array $instance The widget options
-	 */
-	public function form( $instance ) {
-		// outputs the options form on admin
-	}
-
-	/**
-	 * Processing widget options on save
-	 *
-	 * @param array $new_instance The new options
-	 * @param array $old_instance The previous options
-	 */
-	public function update( $new_instance, $old_instance ) {
-		// processes widget options to be saved
-	}
+    /**
+     * Sets up the widgets name etc
+     */
+    public function __construct() {
+        // widget actual processes
+        parent::__construct(
+            'wl_timeline_widget', // Base ID
+            __( 'WordLift Timeline Widget', 'wordlift' ), // Name
+            array( 'description' => __( 'Displays entities of type event using an interactive timeline.', 'wordlift' ), ) // Args
+        );
+    }
+
+    /**
+     * Outputs the content of the widget
+     *
+     * @param array $args
+     * @param array $instance
+     */
+    public function widget( $args, $instance ) {
+        // outputs the content of the widget	
+        echo do_shortcode( '[wl_timeline global=true]' );
+    }
+
+    /**
+     * Outputs the options form on admin
+     *
+     * @param array $instance The widget options
+     */
+    public function form( $instance ) {
+        // outputs the options form on admin
+    }
+
+    /**
+     * Processing widget options on save
+     *
+     * @param array $new_instance The new options
+     * @param array $old_instance The previous options
+     */
+    public function update( $new_instance, $old_instance ) {
+        // processes widget options to be saved
+    }
 }
 
 function wl_register_timeline_widget() {
 
-	register_widget( 'WordLift_Timeline_Widget' );
+    register_widget( 'WordLift_Timeline_Widget' );
 }
 
 add_action( 'widgets_init', 'wl_register_timeline_widget' );

Spacing +9 added lines, -9 removed lines

@@ -9,8 +9,8 @@ 
 		// widget actual processes
 		parent::__construct(
 			'wl_timeline_widget', // Base ID
-			__( 'WordLift Timeline Widget', 'wordlift' ), // Name
-			array( 'description' => __( 'Displays entities of type event using an interactive timeline.', 'wordlift' ), ) // Args
+			__('WordLift Timeline Widget', 'wordlift'), // Name
+			array('description' => __('Displays entities of type event using an interactive timeline.', 'wordlift'),) // Args
 		);
 	}
 
@@ -20,9 +20,9 @@ 
 	 * @param array $args
 	 * @param array $instance
 	 */
-	public function widget( $args, $instance ) {
+	public function widget($args, $instance) {
 		// outputs the content of the widget	
-		echo do_shortcode( '[wl_timeline global=true]' );
+		echo do_shortcode('[wl_timeline global=true]');
 	}
 
 	/**
@@ -30,7 +30,7 @@ 
 	 *
 	 * @param array $instance The widget options
 	 */
-	public function form( $instance ) {
+	public function form($instance) {
 		// outputs the options form on admin
 	}
 
@@ -40,15 +40,15 @@ 
 	 * @param array $new_instance The new options
 	 * @param array $old_instance The previous options
 	 */
-	public function update( $new_instance, $old_instance ) {
+	public function update($new_instance, $old_instance) {
 		// processes widget options to be saved
 	}
 }
 
 function wl_register_timeline_widget() {
 
-	register_widget( 'WordLift_Timeline_Widget' );
+	register_widget('WordLift_Timeline_Widget');
 }
 
-add_action( 'widgets_init', 'wl_register_timeline_widget' );
-add_filter( 'widget_text', 'do_shortcode' );
+add_action('widgets_init', 'wl_register_timeline_widget');
+add_filter('widget_text', 'do_shortcode');