insideout10 / wordlift-plugin

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

Indentation +167 added lines, -167 removed lines

@@ -7,172 +7,172 @@
  */
 class Wordlift_Topic_Taxonomy_Service {
 
-	/**
-	 * The Log service.
-	 *
-	 * @since 3.5.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log_service The Log service.
-	 */
-	private $log_service;
-
-	/**
-	 * Taxonomy name.
-	 *
-	 * @since 3.5.0
-	 */
-	const TAXONOMY_NAME = 'wl_topic';
-
-	/**
-	 * Taxonomy object type.
-	 *
-	 * @since 3.5.0
-	 */
-	const TAXONOMY_OBJECT_TYPE = 'post';
-
-	/**
-	 * Taxonomy slug.
-	 *
-	 * @since 3.5.0
-	 */
-	const TAXONOMY_SLUG = 'wl_topic';
-
-	/**
-	 * A singleton instance of the Wordlift_Topic_Taxonomy_Service service.
-	 *
-	 * @since 3.5.0
-	 * @access private
-	 * @var \Wordlift_Topic_Taxonomy_Service $instance A singleton instance of Wordlift_Topic_Taxonomy_Service.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a Wordlift_Topic_Taxonomy_Service instance.
-	 *
-	 * @since 3.5.0
-	 */
-	public function __construct() {
-
-		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
-
-		// Set the singleton instance.
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance of the Entity service.
-	 *
-	 * @since 3.5.0
-	 * @return Wordlift_Topic_Taxonomy_Service
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Just register the topic taxonomy.
-	 *
-	 * @since 3.5.0
-	 */
-	public function init() {
-
-		// See https://codex.wordpress.org/Function_Reference/register_taxonomy
-		$labels = array(
-			'name'              => _x( 'Topics', 'taxonomy general name', 'wordlift' ),
-			'singular_name'     => _x( 'Topic', 'taxonomy singular name', 'wordlift' ),
-			'search_items'      => __( 'Search Topics', 'wordlift' ),
-			'all_items'         => __( 'All Topics', 'wordlift' ),
-			'parent_item'       => __( 'Parent Topic', 'wordlift' ),
-			'parent_item_colon' => __( 'Parent Topic:', 'wordlift' ),
-			'edit_item'         => __( 'Edit Topic', 'wordlift' ),
-			'update_item'       => __( 'Update Topic', 'wordlift' ),
-			'add_new_item'      => __( 'Add New Topic', 'wordlift' ),
-			'new_item_name'     => __( 'New Topic', 'wordlift' ),
-			'menu_name'         => __( 'Topics', 'wordlift' ),
-		);
-
-		$capabilities = array(
-			'manage_terms' => null,
-			'edit_terms'   => null,
-			'delete_terms' => null,
-			'assign_terms' => 'edit_posts',
-		);
-
-		$args = array(
-			'labels'            => $labels,
-			'capabilities'      => $capabilities,
-			'hierarchical'      => true,
-			'show_admin_column' => false,
-			'show_ui'           => false,
-			'rewrite'           => array(
-				'slug' => self::TAXONOMY_SLUG,
-			),
-		);
-
-		// Register taxonomy
-		register_taxonomy(
-			self::TAXONOMY_NAME,
-			self::TAXONOMY_OBJECT_TYPE,
-			$args
-		);
-
-	}
-
-	/**
-	 * Get or create a taxonomy term from a given entity topic.
-	 *
-	 * @since 3.5.0
-	 */
-	public function get_or_create_term_from_topic_entity( $topic ) {
-
-		// Define taxonomy term slug
-		$term_slug = sanitize_title( $topic->post_title );
-		// Look for an existing taxonomy term with a given slug
-		$term = get_term_by( 'slug', $term_slug, self::TAXONOMY_NAME );
-		if ( $term ) {
-			return (int) $term->term_id;
-		}
-		// Otherwise create a new term and return it
-		$result = wp_insert_term(
-			$topic->post_title,
-			self::TAXONOMY_NAME,
-			array(
-				'slug'        => $term_slug,
-				'description' => $topic->post_content,
-			)
-		);
-
-		return (int) $result['term_id'];
-	}
-
-	/**
-	 * Set a topic for a given post.
-	 *
-	 * @since 3.5.0
-	 */
-	public function set_topic_for( $post_id, $topic_id ) {
-		// Retrieve the topic entity post
-		$topic_entity_post = get_post( $topic_id );
-		// If current topic does not exist in db false is returned
-		if ( null === $topic_entity_post ) {
-			return false;
-		}
-		// Create the proper taxonomy term if needed
-		$term_id = $this->get_or_create_term_from_topic_entity( $topic_entity_post );
-		// Link the term to the current post
-		wp_set_post_terms( $post_id, $term_id, self::TAXONOMY_NAME, false );
-		return true;
-	}
-
-	/**
-	 * Unlink any topic for a given post.
-	 *
-	 * @since 3.5.0
-	 */
-	public function unlink_topic_for( $post_id ) {
-		wp_delete_object_term_relationships( $post_id, self::TAXONOMY_NAME );
-	}
+    /**
+     * The Log service.
+     *
+     * @since 3.5.0
+     * @access private
+     * @var \Wordlift_Log_Service $log_service The Log service.
+     */
+    private $log_service;
+
+    /**
+     * Taxonomy name.
+     *
+     * @since 3.5.0
+     */
+    const TAXONOMY_NAME = 'wl_topic';
+
+    /**
+     * Taxonomy object type.
+     *
+     * @since 3.5.0
+     */
+    const TAXONOMY_OBJECT_TYPE = 'post';
+
+    /**
+     * Taxonomy slug.
+     *
+     * @since 3.5.0
+     */
+    const TAXONOMY_SLUG = 'wl_topic';
+
+    /**
+     * A singleton instance of the Wordlift_Topic_Taxonomy_Service service.
+     *
+     * @since 3.5.0
+     * @access private
+     * @var \Wordlift_Topic_Taxonomy_Service $instance A singleton instance of Wordlift_Topic_Taxonomy_Service.
+     */
+    private static $instance;
+
+    /**
+     * Create a Wordlift_Topic_Taxonomy_Service instance.
+     *
+     * @since 3.5.0
+     */
+    public function __construct() {
+
+        $this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+
+        // Set the singleton instance.
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance of the Entity service.
+     *
+     * @since 3.5.0
+     * @return Wordlift_Topic_Taxonomy_Service
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Just register the topic taxonomy.
+     *
+     * @since 3.5.0
+     */
+    public function init() {
+
+        // See https://codex.wordpress.org/Function_Reference/register_taxonomy
+        $labels = array(
+            'name'              => _x( 'Topics', 'taxonomy general name', 'wordlift' ),
+            'singular_name'     => _x( 'Topic', 'taxonomy singular name', 'wordlift' ),
+            'search_items'      => __( 'Search Topics', 'wordlift' ),
+            'all_items'         => __( 'All Topics', 'wordlift' ),
+            'parent_item'       => __( 'Parent Topic', 'wordlift' ),
+            'parent_item_colon' => __( 'Parent Topic:', 'wordlift' ),
+            'edit_item'         => __( 'Edit Topic', 'wordlift' ),
+            'update_item'       => __( 'Update Topic', 'wordlift' ),
+            'add_new_item'      => __( 'Add New Topic', 'wordlift' ),
+            'new_item_name'     => __( 'New Topic', 'wordlift' ),
+            'menu_name'         => __( 'Topics', 'wordlift' ),
+        );
+
+        $capabilities = array(
+            'manage_terms' => null,
+            'edit_terms'   => null,
+            'delete_terms' => null,
+            'assign_terms' => 'edit_posts',
+        );
+
+        $args = array(
+            'labels'            => $labels,
+            'capabilities'      => $capabilities,
+            'hierarchical'      => true,
+            'show_admin_column' => false,
+            'show_ui'           => false,
+            'rewrite'           => array(
+                'slug' => self::TAXONOMY_SLUG,
+            ),
+        );
+
+        // Register taxonomy
+        register_taxonomy(
+            self::TAXONOMY_NAME,
+            self::TAXONOMY_OBJECT_TYPE,
+            $args
+        );
+
+    }
+
+    /**
+     * Get or create a taxonomy term from a given entity topic.
+     *
+     * @since 3.5.0
+     */
+    public function get_or_create_term_from_topic_entity( $topic ) {
+
+        // Define taxonomy term slug
+        $term_slug = sanitize_title( $topic->post_title );
+        // Look for an existing taxonomy term with a given slug
+        $term = get_term_by( 'slug', $term_slug, self::TAXONOMY_NAME );
+        if ( $term ) {
+            return (int) $term->term_id;
+        }
+        // Otherwise create a new term and return it
+        $result = wp_insert_term(
+            $topic->post_title,
+            self::TAXONOMY_NAME,
+            array(
+                'slug'        => $term_slug,
+                'description' => $topic->post_content,
+            )
+        );
+
+        return (int) $result['term_id'];
+    }
+
+    /**
+     * Set a topic for a given post.
+     *
+     * @since 3.5.0
+     */
+    public function set_topic_for( $post_id, $topic_id ) {
+        // Retrieve the topic entity post
+        $topic_entity_post = get_post( $topic_id );
+        // If current topic does not exist in db false is returned
+        if ( null === $topic_entity_post ) {
+            return false;
+        }
+        // Create the proper taxonomy term if needed
+        $term_id = $this->get_or_create_term_from_topic_entity( $topic_entity_post );
+        // Link the term to the current post
+        wp_set_post_terms( $post_id, $term_id, self::TAXONOMY_NAME, false );
+        return true;
+    }
+
+    /**
+     * Unlink any topic for a given post.
+     *
+     * @since 3.5.0
+     */
+    public function unlink_topic_for( $post_id ) {
+        wp_delete_object_term_relationships( $post_id, self::TAXONOMY_NAME );
+    }
 
 }

Spacing +23 added lines, -23 removed lines

@@ -53,7 +53,7 @@ 
 	 */
 	public function __construct() {
 
-		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+		$this->log_service = Wordlift_Log_Service::get_logger('Wordlift_Entity_Service');
 
 		// Set the singleton instance.
 		self::$instance = $this;
@@ -80,17 +80,17 @@ 
 
 		// See https://codex.wordpress.org/Function_Reference/register_taxonomy
 		$labels = array(
-			'name'              => _x( 'Topics', 'taxonomy general name', 'wordlift' ),
-			'singular_name'     => _x( 'Topic', 'taxonomy singular name', 'wordlift' ),
-			'search_items'      => __( 'Search Topics', 'wordlift' ),
-			'all_items'         => __( 'All Topics', 'wordlift' ),
-			'parent_item'       => __( 'Parent Topic', 'wordlift' ),
-			'parent_item_colon' => __( 'Parent Topic:', 'wordlift' ),
-			'edit_item'         => __( 'Edit Topic', 'wordlift' ),
-			'update_item'       => __( 'Update Topic', 'wordlift' ),
-			'add_new_item'      => __( 'Add New Topic', 'wordlift' ),
-			'new_item_name'     => __( 'New Topic', 'wordlift' ),
-			'menu_name'         => __( 'Topics', 'wordlift' ),
+			'name'              => _x('Topics', 'taxonomy general name', 'wordlift'),
+			'singular_name'     => _x('Topic', 'taxonomy singular name', 'wordlift'),
+			'search_items'      => __('Search Topics', 'wordlift'),
+			'all_items'         => __('All Topics', 'wordlift'),
+			'parent_item'       => __('Parent Topic', 'wordlift'),
+			'parent_item_colon' => __('Parent Topic:', 'wordlift'),
+			'edit_item'         => __('Edit Topic', 'wordlift'),
+			'update_item'       => __('Update Topic', 'wordlift'),
+			'add_new_item'      => __('Add New Topic', 'wordlift'),
+			'new_item_name'     => __('New Topic', 'wordlift'),
+			'menu_name'         => __('Topics', 'wordlift'),
 		);
 
 		$capabilities = array(
@@ -125,13 +125,13 @@ 
 	 *
 	 * @since 3.5.0
 	 */
-	public function get_or_create_term_from_topic_entity( $topic ) {
+	public function get_or_create_term_from_topic_entity($topic) {
 
 		// Define taxonomy term slug
-		$term_slug = sanitize_title( $topic->post_title );
+		$term_slug = sanitize_title($topic->post_title);
 		// Look for an existing taxonomy term with a given slug
-		$term = get_term_by( 'slug', $term_slug, self::TAXONOMY_NAME );
-		if ( $term ) {
+		$term = get_term_by('slug', $term_slug, self::TAXONOMY_NAME);
+		if ($term) {
 			return (int) $term->term_id;
 		}
 		// Otherwise create a new term and return it
@@ -152,17 +152,17 @@ 
 	 *
 	 * @since 3.5.0
 	 */
-	public function set_topic_for( $post_id, $topic_id ) {
+	public function set_topic_for($post_id, $topic_id) {
 		// Retrieve the topic entity post
-		$topic_entity_post = get_post( $topic_id );
+		$topic_entity_post = get_post($topic_id);
 		// If current topic does not exist in db false is returned
-		if ( null === $topic_entity_post ) {
+		if (null === $topic_entity_post) {
 			return false;
 		}
 		// Create the proper taxonomy term if needed
-		$term_id = $this->get_or_create_term_from_topic_entity( $topic_entity_post );
+		$term_id = $this->get_or_create_term_from_topic_entity($topic_entity_post);
 		// Link the term to the current post
-		wp_set_post_terms( $post_id, $term_id, self::TAXONOMY_NAME, false );
+		wp_set_post_terms($post_id, $term_id, self::TAXONOMY_NAME, false);
 		return true;
 	}
 
@@ -171,8 +171,8 @@ 
 	 *
 	 * @since 3.5.0
 	 */
-	public function unlink_topic_for( $post_id ) {
-		wp_delete_object_term_relationships( $post_id, self::TAXONOMY_NAME );
+	public function unlink_topic_for($post_id) {
+		wp_delete_object_term_relationships($post_id, self::TAXONOMY_NAME);
 	}
 
 }

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

Indentation +364 added lines, -364 removed lines

@@ -14,369 +14,369 @@
  */
 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_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
-	 */
-	protected function __construct() {
-
-		$this->entity_type_service = Wordlift_Entity_Type_Service::get_instance();
-		$this->notice_service      = Wordlift_Notice_Service::get_instance();
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Rating_Service' );
-
-	}
-
-	private static $instance;
-
-	public static function get_instance() {
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Set rating for a given entity.
-	 *
-	 * @param int $post_id The entity post id.
-	 *
-	 * @return array An array representing the rating obj.
-	 * @since 3.3.0
-	 */
-	public function set_rating_for( $post_id ) {
-
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__entity-rating', true ) ) {
-			return;
-		}
-
-		if ( ! Wordlift_Entity_Service::get_instance()->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
-	 *
-	 * @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.
-	 * @since 3.3.0
-	 */
-	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.
-	 *
-	 * @param int $post_id The entity post id.
-	 *
-	 * @return array An array representing the rating obj.
-	 * @since 3.3.0
-	 */
-	private function calculate_rating_for( $post_id ) {
-
-		// If it's not an entity, return.
-		if ( ! Wordlift_Entity_Service::get_instance()->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;
-
-		// Check intersection between available meta keys and expected ones
-		// arrays to detect missing values.
-		$available_meta_keys = $wpdb->get_col(
-			$wpdb->prepare(
-				"SELECT DISTINCT (meta_key) FROM $wpdb->postmeta  WHERE post_id = %d",
-				$post->ID
-			)
-		);
-
-		// If each expected key is contained in available keys array ...
-		( in_array( Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys, true ) ) ?
-			$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
-	 *
-	 * @param int $score The rating score for a given entity.
-	 *
-	 * @return string The input HTML code.
-	 * @since 3.3.0
-	 */
-	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
-	 *
-	 * @param int $score The rating score for a given entity.
-	 *
-	 * @return string The input HTML code.
-	 * @since 3.3.0
-	 */
-	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 ( ! Wordlift_Entity_Service::get_instance()->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_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
+     */
+    protected function __construct() {
+
+        $this->entity_type_service = Wordlift_Entity_Type_Service::get_instance();
+        $this->notice_service      = Wordlift_Notice_Service::get_instance();
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Rating_Service' );
+
+    }
+
+    private static $instance;
+
+    public static function get_instance() {
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Set rating for a given entity.
+     *
+     * @param int $post_id The entity post id.
+     *
+     * @return array An array representing the rating obj.
+     * @since 3.3.0
+     */
+    public function set_rating_for( $post_id ) {
+
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( ! apply_filters( 'wl_feature__enable__entity-rating', true ) ) {
+            return;
+        }
+
+        if ( ! Wordlift_Entity_Service::get_instance()->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
+     *
+     * @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.
+     * @since 3.3.0
+     */
+    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.
+     *
+     * @param int $post_id The entity post id.
+     *
+     * @return array An array representing the rating obj.
+     * @since 3.3.0
+     */
+    private function calculate_rating_for( $post_id ) {
+
+        // If it's not an entity, return.
+        if ( ! Wordlift_Entity_Service::get_instance()->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;
+
+        // Check intersection between available meta keys and expected ones
+        // arrays to detect missing values.
+        $available_meta_keys = $wpdb->get_col(
+            $wpdb->prepare(
+                "SELECT DISTINCT (meta_key) FROM $wpdb->postmeta  WHERE post_id = %d",
+                $post->ID
+            )
+        );
+
+        // If each expected key is contained in available keys array ...
+        ( in_array( Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys, true ) ) ?
+            $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
+     *
+     * @param int $score The rating score for a given entity.
+     *
+     * @return string The input HTML code.
+     * @since 3.3.0
+     */
+    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
+     *
+     * @param int $score The rating score for a given entity.
+     *
+     * @return string The input HTML code.
+     * @since 3.3.0
+     */
+    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 ( ! Wordlift_Entity_Service::get_instance()->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

@@ -121,14 +121,14 @@ 
 		$this->entity_type_service = Wordlift_Entity_Type_Service::get_instance();
 		$this->notice_service      = Wordlift_Notice_Service::get_instance();
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Rating_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Rating_Service');
 
 	}
 
 	private static $instance;
 
 	public static function get_instance() {
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -143,28 +143,28 @@ 
 	 * @return array An array representing the rating obj.
 	 * @since 3.3.0
 	 */
-	public function set_rating_for( $post_id ) {
+	public function set_rating_for($post_id) {
 
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__entity-rating', true ) ) {
+		if ( ! apply_filters('wl_feature__enable__entity-rating', true)) {
 			return;
 		}
 
-		if ( ! Wordlift_Entity_Service::get_instance()->is_entity( $post_id ) ) {
+		if ( ! Wordlift_Entity_Service::get_instance()->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;
@@ -179,30 +179,30 @@ 
 	 * @return array An array representing the rating obj.
 	 * @since 3.3.0
 	 */
-	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,
 		);
 
@@ -228,14 +228,14 @@ 
 	 * @return array An array representing the rating obj.
 	 * @since 3.3.0
 	 */
-	private function calculate_rating_for( $post_id ) {
+	private function calculate_rating_for($post_id) {
 
 		// If it's not an entity, return.
-		if ( ! Wordlift_Entity_Service::get_instance()->is_entity( $post_id ) ) {
+		if ( ! Wordlift_Entity_Service::get_instance()->is_entity($post_id)) {
 			return array();
 		}
 		// Retrieve the post object.
-		$post = get_post( $post_id );
+		$post = get_post($post_id);
 
 		// Rating value.
 		$score = 0;
@@ -244,30 +244,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;
@@ -282,27 +277,24 @@ 
 		);
 
 		// If each expected key is contained in available keys array ...
-		( in_array( Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys, true ) ) ?
-			$score ++ :
-			array_push( $warnings, __( 'There are no sameAs configured for this entity.', 'wordlift' ) );
+		(in_array(Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys, true)) ?
+			$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,
 		);
 
@@ -316,13 +308,13 @@ 
 	 * @return string The input HTML code.
 	 * @since 3.3.0
 	 */
-	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;
 
 	}
 
@@ -334,10 +326,10 @@ 
 	 * @return string The input HTML code.
 	 * @since 3.3.0
 	 */
-	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);
 	}
 
 	/**
@@ -348,33 +340,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 ( ! Wordlift_Entity_Service::get_instance()->is_entity( $post->ID ) ) {
+		if ( ! Wordlift_Entity_Service::get_instance()->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/ext/dependencies/deliciousbrains/wp-background-processing/classes/wp-background-process.php

Indentation +487 added lines, -487 removed lines

@@ -13,492 +13,492 @@
  */
 abstract class Wordlift_Plugin_WP_Background_Process extends Wordlift_Plugin_WP_Async_Request {
 
-	/**
-	 * Action
-	 *
-	 * (default value: 'background_process')
-	 *
-	 * @var string
-	 * @access protected
-	 */
-	protected $action = 'background_process';
-
-	/**
-	 * Start time of current process.
-	 *
-	 * (default value: 0)
-	 *
-	 * @var int
-	 * @access protected
-	 */
-	protected $start_time = 0;
-
-	/**
-	 * Cron_hook_identifier
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $cron_hook_identifier;
-
-	/**
-	 * Cron_interval_identifier
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $cron_interval_identifier;
-
-	/**
-	 * Initiate new background process
-	 */
-	public function __construct() {
-		parent::__construct();
-
-		$this->cron_hook_identifier     = $this->identifier . '_cron';
-		$this->cron_interval_identifier = $this->identifier . '_cron_interval';
-
-		add_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) );
-		add_filter( 'cron_schedules', array( $this, 'schedule_cron_healthcheck' ) );
-	}
-
-	/**
-	 * Dispatch
-	 *
-	 * @access public
-	 * @return void
-	 */
-	public function dispatch() {
-		// Schedule the cron healthcheck.
-		$this->schedule_event();
-
-		// Perform remote post.
-		return parent::dispatch();
-	}
-
-	/**
-	 * Push to queue
-	 *
-	 * @param mixed $data Data.
-	 *
-	 * @return $this
-	 */
-	public function push_to_queue( $data ) {
-		$this->data[] = $data;
-
-		return $this;
-	}
-
-	/**
-	 * Save queue
-	 *
-	 * @return $this
-	 */
-	public function save() {
-		$key = $this->generate_key();
-
-		if ( ! empty( $this->data ) ) {
-			update_site_option( $key, $this->data );
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Update queue
-	 *
-	 * @param string $key  Key.
-	 * @param array  $data Data.
-	 *
-	 * @return $this
-	 */
-	public function update( $key, $data ) {
-		if ( ! empty( $data ) ) {
-			update_site_option( $key, $data );
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Delete queue
-	 *
-	 * @param string $key Key.
-	 *
-	 * @return $this
-	 */
-	public function delete( $key ) {
-		delete_site_option( $key );
-
-		return $this;
-	}
-
-	/**
-	 * Generate key
-	 *
-	 * Generates a unique key based on microtime. Queue items are
-	 * given a unique key so that they can be merged upon save.
-	 *
-	 * @param int $length Length.
-	 *
-	 * @return string
-	 */
-	protected function generate_key( $length = 64 ) {
-		$unique  = md5( microtime() . rand() );
-		$prepend = $this->identifier . '_batch_';
-
-		return substr( $prepend . $unique, 0, $length );
-	}
-
-	/**
-	 * Maybe process queue
-	 *
-	 * Checks whether data exists within the queue and that
-	 * the process is not already running.
-	 */
-	public function maybe_handle() {
-		// Don't lock up other requests while processing
-		session_write_close();
-
-		if ( $this->is_process_running() ) {
-			// Background process already running.
-			wp_die();
-		}
-
-		if ( $this->is_queue_empty() ) {
-			// No data to process.
-			wp_die();
-		}
-
-		check_ajax_referer( $this->identifier, 'nonce' );
-
-		$this->handle();
-
-		wp_die();
-	}
-
-	/**
-	 * Is queue empty
-	 *
-	 * @return bool
-	 */
-	protected function is_queue_empty() {
-		global $wpdb;
-
-		$table  = $wpdb->options;
-		$column = 'option_name';
-
-		if ( is_multisite() ) {
-			$table  = $wpdb->sitemeta;
-			$column = 'meta_key';
-		}
-
-		$key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
-
-		$count = $wpdb->get_var(
-			$wpdb->prepare(
-				"SELECT COUNT(*) FROM {$table} WHERE {$column} LIKE %s", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-				$key
-			)
-		);
-
-		return ( $count > 0 ) ? false : true;
-	}
-
-	/**
-	 * Is process running
-	 *
-	 * Check whether the current process is already running
-	 * in a background process.
-	 */
-	protected function is_process_running() {
-		if ( get_site_transient( $this->identifier . '_process_lock' ) ) {
-			// Process already running.
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Lock process
-	 *
-	 * Lock the process so that multiple instances can't run simultaneously.
-	 * Override if applicable, but the duration should be greater than that
-	 * defined in the time_exceeded() method.
-	 */
-	protected function lock_process() {
-		$this->start_time = time(); // Set start time of current process.
-
-		$lock_duration = ( property_exists( $this, 'queue_lock_time' ) ) ? $this->queue_lock_time : 60; // 1 minute
-		$lock_duration = apply_filters( $this->identifier . '_queue_lock_time', $lock_duration );
-
-		set_site_transient( $this->identifier . '_process_lock', microtime(), $lock_duration );
-	}
-
-	/**
-	 * Unlock process
-	 *
-	 * Unlock the process so that other instances can spawn.
-	 *
-	 * @return $this
-	 */
-	protected function unlock_process() {
-		delete_site_transient( $this->identifier . '_process_lock' );
-
-		return $this;
-	}
-
-	/**
-	 * Get batch
-	 *
-	 * @return stdClass Return the first batch from the queue
-	 */
-	protected function get_batch() {
-		global $wpdb;
-
-		$table        = $wpdb->options;
-		$column       = 'option_name';
-		$key_column   = 'option_id';
-		$value_column = 'option_value';
-
-		if ( is_multisite() ) {
-			$table        = $wpdb->sitemeta;
-			$column       = 'meta_key';
-			$key_column   = 'meta_id';
-			$value_column = 'meta_value';
-		}
-
-		$key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
-
-		$query = $wpdb->get_row(
-			$wpdb->prepare(
-				"SELECT * FROM {$table} WHERE {$column} LIKE %s ORDER BY {$key_column} ASC LIMIT 1", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-				$key
-			)
-		);
-
-		$batch       = new stdClass();
-		$batch->key  = $query->$column;
-		$batch->data = maybe_unserialize( $query->$value_column );
-
-		return $batch;
-	}
-
-	/**
-	 * Handle
-	 *
-	 * Pass each queue item to the task handler, while remaining
-	 * within server memory and time limit constraints.
-	 */
-	protected function handle() {
-		$this->lock_process();
-
-		do {
-			$batch = $this->get_batch();
-
-			foreach ( $batch->data as $key => $value ) {
-				$task = $this->task( $value );
-
-				if ( false !== $task ) {
-					$batch->data[ $key ] = $task;
-				} else {
-					unset( $batch->data[ $key ] );
-				}
-
-				if ( $this->time_exceeded() || $this->memory_exceeded() ) {
-					// Batch limits reached.
-					break;
-				}
-			}
-
-			// Update or delete current batch.
-			if ( ! empty( $batch->data ) ) {
-				$this->update( $batch->key, $batch->data );
-			} else {
-				$this->delete( $batch->key );
-			}
-		} while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty() );
-
-		$this->unlock_process();
-
-		// Start next batch or complete process.
-		if ( ! $this->is_queue_empty() ) {
-			$this->dispatch();
-		} else {
-			$this->complete();
-		}
-
-		wp_die();
-	}
-
-	/**
-	 * Memory exceeded
-	 *
-	 * Ensures the batch process never exceeds 90%
-	 * of the maximum WordPress memory.
-	 *
-	 * @return bool
-	 */
-	protected function memory_exceeded() {
-		$memory_limit   = $this->get_memory_limit() * 0.9; // 90% of max memory
-		$current_memory = memory_get_usage( true );
-		$return         = false;
-
-		if ( $current_memory >= $memory_limit ) {
-			$return = true;
-		}
-
-		return apply_filters( $this->identifier . '_memory_exceeded', $return );
-	}
-
-	/**
-	 * Get memory limit
-	 *
-	 * @return int
-	 */
-	protected function get_memory_limit() {
-		if ( function_exists( 'ini_get' ) ) {
-			$memory_limit = ini_get( 'memory_limit' );
-		} else {
-			// Sensible default.
-			$memory_limit = '128M';
-		}
-
-		if ( ! $memory_limit || - 1 === intval( $memory_limit ) ) {
-			// Unlimited, set to 32GB.
-			$memory_limit = '32000M';
-		}
-
-		return wp_convert_hr_to_bytes( $memory_limit );
-	}
-
-	/**
-	 * Time exceeded.
-	 *
-	 * Ensures the batch never exceeds a sensible time limit.
-	 * A timeout limit of 30s is common on shared hosting.
-	 *
-	 * @return bool
-	 */
-	protected function time_exceeded() {
-		$finish = $this->start_time + apply_filters( $this->identifier . '_default_time_limit', 20 ); // 20 seconds
-		$return = false;
-
-		if ( time() >= $finish ) {
-			$return = true;
-		}
-
-		return apply_filters( $this->identifier . '_time_exceeded', $return );
-	}
-
-	/**
-	 * Complete.
-	 *
-	 * Override if applicable, but ensure that the below actions are
-	 * performed, or, call parent::complete().
-	 */
-	protected function complete() {
-		// Unschedule the cron healthcheck.
-		$this->clear_scheduled_event();
-	}
-
-	/**
-	 * Schedule cron healthcheck
-	 *
-	 * @access public
-	 *
-	 * @param mixed $schedules Schedules.
-	 *
-	 * @return mixed
-	 */
-	public function schedule_cron_healthcheck( $schedules ) {
-		$interval = apply_filters( $this->identifier . '_cron_interval', 5 );
-
-		if ( property_exists( $this, 'cron_interval' ) ) {
-			$interval = apply_filters( $this->identifier . '_cron_interval', $this->cron_interval );
-		}
-
-		// Adds every 5 minutes to the existing schedules.
-		$schedules[ $this->identifier . '_cron_interval' ] = array(
-			'interval' => MINUTE_IN_SECONDS * $interval,
-			'display'  => sprintf( __( 'Every %d Minutes' ), $interval ),
-		);
-
-		return $schedules;
-	}
-
-	/**
-	 * Handle cron healthcheck
-	 *
-	 * Restart the background process if not already running
-	 * and data exists in the queue.
-	 */
-	public function handle_cron_healthcheck() {
-		if ( $this->is_process_running() ) {
-			// Background process already running.
-			exit;
-		}
-
-		if ( $this->is_queue_empty() ) {
-			// No data to process.
-			$this->clear_scheduled_event();
-			exit;
-		}
-
-		$this->handle();
-
-		exit;
-	}
-
-	/**
-	 * Schedule event
-	 */
-	protected function schedule_event() {
-		if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {
-			wp_schedule_event( time(), $this->cron_interval_identifier, $this->cron_hook_identifier );
-		}
-	}
-
-	/**
-	 * Clear scheduled event
-	 */
-	protected function clear_scheduled_event() {
-		$timestamp = wp_next_scheduled( $this->cron_hook_identifier );
-
-		if ( $timestamp ) {
-			wp_unschedule_event( $timestamp, $this->cron_hook_identifier );
-		}
-	}
-
-	/**
-	 * Cancel Process
-	 *
-	 * Stop processing queue items, clear cronjob and delete batch.
-	 */
-	public function cancel_process() {
-		if ( ! $this->is_queue_empty() ) {
-			$batch = $this->get_batch();
-
-			$this->delete( $batch->key );
-
-			wp_clear_scheduled_hook( $this->cron_hook_identifier );
-		}
-
-	}
-
-	/**
-	 * Task
-	 *
-	 * Override this method to perform any actions required on each
-	 * queue item. Return the modified item for further processing
-	 * in the next pass through. Or, return false to remove the
-	 * item from the queue.
-	 *
-	 * @param mixed $item Queue item to iterate over.
-	 *
-	 * @return mixed
-	 */
-	abstract protected function task( $item );
+    /**
+     * Action
+     *
+     * (default value: 'background_process')
+     *
+     * @var string
+     * @access protected
+     */
+    protected $action = 'background_process';
+
+    /**
+     * Start time of current process.
+     *
+     * (default value: 0)
+     *
+     * @var int
+     * @access protected
+     */
+    protected $start_time = 0;
+
+    /**
+     * Cron_hook_identifier
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $cron_hook_identifier;
+
+    /**
+     * Cron_interval_identifier
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $cron_interval_identifier;
+
+    /**
+     * Initiate new background process
+     */
+    public function __construct() {
+        parent::__construct();
+
+        $this->cron_hook_identifier     = $this->identifier . '_cron';
+        $this->cron_interval_identifier = $this->identifier . '_cron_interval';
+
+        add_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) );
+        add_filter( 'cron_schedules', array( $this, 'schedule_cron_healthcheck' ) );
+    }
+
+    /**
+     * Dispatch
+     *
+     * @access public
+     * @return void
+     */
+    public function dispatch() {
+        // Schedule the cron healthcheck.
+        $this->schedule_event();
+
+        // Perform remote post.
+        return parent::dispatch();
+    }
+
+    /**
+     * Push to queue
+     *
+     * @param mixed $data Data.
+     *
+     * @return $this
+     */
+    public function push_to_queue( $data ) {
+        $this->data[] = $data;
+
+        return $this;
+    }
+
+    /**
+     * Save queue
+     *
+     * @return $this
+     */
+    public function save() {
+        $key = $this->generate_key();
+
+        if ( ! empty( $this->data ) ) {
+            update_site_option( $key, $this->data );
+        }
+
+        return $this;
+    }
+
+    /**
+     * Update queue
+     *
+     * @param string $key  Key.
+     * @param array  $data Data.
+     *
+     * @return $this
+     */
+    public function update( $key, $data ) {
+        if ( ! empty( $data ) ) {
+            update_site_option( $key, $data );
+        }
+
+        return $this;
+    }
+
+    /**
+     * Delete queue
+     *
+     * @param string $key Key.
+     *
+     * @return $this
+     */
+    public function delete( $key ) {
+        delete_site_option( $key );
+
+        return $this;
+    }
+
+    /**
+     * Generate key
+     *
+     * Generates a unique key based on microtime. Queue items are
+     * given a unique key so that they can be merged upon save.
+     *
+     * @param int $length Length.
+     *
+     * @return string
+     */
+    protected function generate_key( $length = 64 ) {
+        $unique  = md5( microtime() . rand() );
+        $prepend = $this->identifier . '_batch_';
+
+        return substr( $prepend . $unique, 0, $length );
+    }
+
+    /**
+     * Maybe process queue
+     *
+     * Checks whether data exists within the queue and that
+     * the process is not already running.
+     */
+    public function maybe_handle() {
+        // Don't lock up other requests while processing
+        session_write_close();
+
+        if ( $this->is_process_running() ) {
+            // Background process already running.
+            wp_die();
+        }
+
+        if ( $this->is_queue_empty() ) {
+            // No data to process.
+            wp_die();
+        }
+
+        check_ajax_referer( $this->identifier, 'nonce' );
+
+        $this->handle();
+
+        wp_die();
+    }
+
+    /**
+     * Is queue empty
+     *
+     * @return bool
+     */
+    protected function is_queue_empty() {
+        global $wpdb;
+
+        $table  = $wpdb->options;
+        $column = 'option_name';
+
+        if ( is_multisite() ) {
+            $table  = $wpdb->sitemeta;
+            $column = 'meta_key';
+        }
+
+        $key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
+
+        $count = $wpdb->get_var(
+            $wpdb->prepare(
+                "SELECT COUNT(*) FROM {$table} WHERE {$column} LIKE %s", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+                $key
+            )
+        );
+
+        return ( $count > 0 ) ? false : true;
+    }
+
+    /**
+     * Is process running
+     *
+     * Check whether the current process is already running
+     * in a background process.
+     */
+    protected function is_process_running() {
+        if ( get_site_transient( $this->identifier . '_process_lock' ) ) {
+            // Process already running.
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Lock process
+     *
+     * Lock the process so that multiple instances can't run simultaneously.
+     * Override if applicable, but the duration should be greater than that
+     * defined in the time_exceeded() method.
+     */
+    protected function lock_process() {
+        $this->start_time = time(); // Set start time of current process.
+
+        $lock_duration = ( property_exists( $this, 'queue_lock_time' ) ) ? $this->queue_lock_time : 60; // 1 minute
+        $lock_duration = apply_filters( $this->identifier . '_queue_lock_time', $lock_duration );
+
+        set_site_transient( $this->identifier . '_process_lock', microtime(), $lock_duration );
+    }
+
+    /**
+     * Unlock process
+     *
+     * Unlock the process so that other instances can spawn.
+     *
+     * @return $this
+     */
+    protected function unlock_process() {
+        delete_site_transient( $this->identifier . '_process_lock' );
+
+        return $this;
+    }
+
+    /**
+     * Get batch
+     *
+     * @return stdClass Return the first batch from the queue
+     */
+    protected function get_batch() {
+        global $wpdb;
+
+        $table        = $wpdb->options;
+        $column       = 'option_name';
+        $key_column   = 'option_id';
+        $value_column = 'option_value';
+
+        if ( is_multisite() ) {
+            $table        = $wpdb->sitemeta;
+            $column       = 'meta_key';
+            $key_column   = 'meta_id';
+            $value_column = 'meta_value';
+        }
+
+        $key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
+
+        $query = $wpdb->get_row(
+            $wpdb->prepare(
+                "SELECT * FROM {$table} WHERE {$column} LIKE %s ORDER BY {$key_column} ASC LIMIT 1", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+                $key
+            )
+        );
+
+        $batch       = new stdClass();
+        $batch->key  = $query->$column;
+        $batch->data = maybe_unserialize( $query->$value_column );
+
+        return $batch;
+    }
+
+    /**
+     * Handle
+     *
+     * Pass each queue item to the task handler, while remaining
+     * within server memory and time limit constraints.
+     */
+    protected function handle() {
+        $this->lock_process();
+
+        do {
+            $batch = $this->get_batch();
+
+            foreach ( $batch->data as $key => $value ) {
+                $task = $this->task( $value );
+
+                if ( false !== $task ) {
+                    $batch->data[ $key ] = $task;
+                } else {
+                    unset( $batch->data[ $key ] );
+                }
+
+                if ( $this->time_exceeded() || $this->memory_exceeded() ) {
+                    // Batch limits reached.
+                    break;
+                }
+            }
+
+            // Update or delete current batch.
+            if ( ! empty( $batch->data ) ) {
+                $this->update( $batch->key, $batch->data );
+            } else {
+                $this->delete( $batch->key );
+            }
+        } while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty() );
+
+        $this->unlock_process();
+
+        // Start next batch or complete process.
+        if ( ! $this->is_queue_empty() ) {
+            $this->dispatch();
+        } else {
+            $this->complete();
+        }
+
+        wp_die();
+    }
+
+    /**
+     * Memory exceeded
+     *
+     * Ensures the batch process never exceeds 90%
+     * of the maximum WordPress memory.
+     *
+     * @return bool
+     */
+    protected function memory_exceeded() {
+        $memory_limit   = $this->get_memory_limit() * 0.9; // 90% of max memory
+        $current_memory = memory_get_usage( true );
+        $return         = false;
+
+        if ( $current_memory >= $memory_limit ) {
+            $return = true;
+        }
+
+        return apply_filters( $this->identifier . '_memory_exceeded', $return );
+    }
+
+    /**
+     * Get memory limit
+     *
+     * @return int
+     */
+    protected function get_memory_limit() {
+        if ( function_exists( 'ini_get' ) ) {
+            $memory_limit = ini_get( 'memory_limit' );
+        } else {
+            // Sensible default.
+            $memory_limit = '128M';
+        }
+
+        if ( ! $memory_limit || - 1 === intval( $memory_limit ) ) {
+            // Unlimited, set to 32GB.
+            $memory_limit = '32000M';
+        }
+
+        return wp_convert_hr_to_bytes( $memory_limit );
+    }
+
+    /**
+     * Time exceeded.
+     *
+     * Ensures the batch never exceeds a sensible time limit.
+     * A timeout limit of 30s is common on shared hosting.
+     *
+     * @return bool
+     */
+    protected function time_exceeded() {
+        $finish = $this->start_time + apply_filters( $this->identifier . '_default_time_limit', 20 ); // 20 seconds
+        $return = false;
+
+        if ( time() >= $finish ) {
+            $return = true;
+        }
+
+        return apply_filters( $this->identifier . '_time_exceeded', $return );
+    }
+
+    /**
+     * Complete.
+     *
+     * Override if applicable, but ensure that the below actions are
+     * performed, or, call parent::complete().
+     */
+    protected function complete() {
+        // Unschedule the cron healthcheck.
+        $this->clear_scheduled_event();
+    }
+
+    /**
+     * Schedule cron healthcheck
+     *
+     * @access public
+     *
+     * @param mixed $schedules Schedules.
+     *
+     * @return mixed
+     */
+    public function schedule_cron_healthcheck( $schedules ) {
+        $interval = apply_filters( $this->identifier . '_cron_interval', 5 );
+
+        if ( property_exists( $this, 'cron_interval' ) ) {
+            $interval = apply_filters( $this->identifier . '_cron_interval', $this->cron_interval );
+        }
+
+        // Adds every 5 minutes to the existing schedules.
+        $schedules[ $this->identifier . '_cron_interval' ] = array(
+            'interval' => MINUTE_IN_SECONDS * $interval,
+            'display'  => sprintf( __( 'Every %d Minutes' ), $interval ),
+        );
+
+        return $schedules;
+    }
+
+    /**
+     * Handle cron healthcheck
+     *
+     * Restart the background process if not already running
+     * and data exists in the queue.
+     */
+    public function handle_cron_healthcheck() {
+        if ( $this->is_process_running() ) {
+            // Background process already running.
+            exit;
+        }
+
+        if ( $this->is_queue_empty() ) {
+            // No data to process.
+            $this->clear_scheduled_event();
+            exit;
+        }
+
+        $this->handle();
+
+        exit;
+    }
+
+    /**
+     * Schedule event
+     */
+    protected function schedule_event() {
+        if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {
+            wp_schedule_event( time(), $this->cron_interval_identifier, $this->cron_hook_identifier );
+        }
+    }
+
+    /**
+     * Clear scheduled event
+     */
+    protected function clear_scheduled_event() {
+        $timestamp = wp_next_scheduled( $this->cron_hook_identifier );
+
+        if ( $timestamp ) {
+            wp_unschedule_event( $timestamp, $this->cron_hook_identifier );
+        }
+    }
+
+    /**
+     * Cancel Process
+     *
+     * Stop processing queue items, clear cronjob and delete batch.
+     */
+    public function cancel_process() {
+        if ( ! $this->is_queue_empty() ) {
+            $batch = $this->get_batch();
+
+            $this->delete( $batch->key );
+
+            wp_clear_scheduled_hook( $this->cron_hook_identifier );
+        }
+
+    }
+
+    /**
+     * Task
+     *
+     * Override this method to perform any actions required on each
+     * queue item. Return the modified item for further processing
+     * in the next pass through. Or, return false to remove the
+     * item from the queue.
+     *
+     * @param mixed $item Queue item to iterate over.
+     *
+     * @return mixed
+     */
+    abstract protected function task( $item );
 
 }

Spacing +68 added lines, -68 removed lines

@@ -55,11 +55,11 @@ 
 	public function __construct() {
 		parent::__construct();
 
-		$this->cron_hook_identifier     = $this->identifier . '_cron';
-		$this->cron_interval_identifier = $this->identifier . '_cron_interval';
+		$this->cron_hook_identifier     = $this->identifier.'_cron';
+		$this->cron_interval_identifier = $this->identifier.'_cron_interval';
 
-		add_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) );
-		add_filter( 'cron_schedules', array( $this, 'schedule_cron_healthcheck' ) );
+		add_action($this->cron_hook_identifier, array($this, 'handle_cron_healthcheck'));
+		add_filter('cron_schedules', array($this, 'schedule_cron_healthcheck'));
 	}
 
 	/**
@@ -83,7 +83,7 @@ 
 	 *
 	 * @return $this
 	 */
-	public function push_to_queue( $data ) {
+	public function push_to_queue($data) {
 		$this->data[] = $data;
 
 		return $this;
@@ -97,8 +97,8 @@ 
 	public function save() {
 		$key = $this->generate_key();
 
-		if ( ! empty( $this->data ) ) {
-			update_site_option( $key, $this->data );
+		if ( ! empty($this->data)) {
+			update_site_option($key, $this->data);
 		}
 
 		return $this;
@@ -112,9 +112,9 @@ 
 	 *
 	 * @return $this
 	 */
-	public function update( $key, $data ) {
-		if ( ! empty( $data ) ) {
-			update_site_option( $key, $data );
+	public function update($key, $data) {
+		if ( ! empty($data)) {
+			update_site_option($key, $data);
 		}
 
 		return $this;
@@ -127,8 +127,8 @@ 
 	 *
 	 * @return $this
 	 */
-	public function delete( $key ) {
-		delete_site_option( $key );
+	public function delete($key) {
+		delete_site_option($key);
 
 		return $this;
 	}
@@ -143,11 +143,11 @@ 
 	 *
 	 * @return string
 	 */
-	protected function generate_key( $length = 64 ) {
-		$unique  = md5( microtime() . rand() );
-		$prepend = $this->identifier . '_batch_';
+	protected function generate_key($length = 64) {
+		$unique  = md5(microtime().rand());
+		$prepend = $this->identifier.'_batch_';
 
-		return substr( $prepend . $unique, 0, $length );
+		return substr($prepend.$unique, 0, $length);
 	}
 
 	/**
@@ -160,17 +160,17 @@ 
 		// Don't lock up other requests while processing
 		session_write_close();
 
-		if ( $this->is_process_running() ) {
+		if ($this->is_process_running()) {
 			// Background process already running.
 			wp_die();
 		}
 
-		if ( $this->is_queue_empty() ) {
+		if ($this->is_queue_empty()) {
 			// No data to process.
 			wp_die();
 		}
 
-		check_ajax_referer( $this->identifier, 'nonce' );
+		check_ajax_referer($this->identifier, 'nonce');
 
 		$this->handle();
 
@@ -188,12 +188,12 @@ 
 		$table  = $wpdb->options;
 		$column = 'option_name';
 
-		if ( is_multisite() ) {
+		if (is_multisite()) {
 			$table  = $wpdb->sitemeta;
 			$column = 'meta_key';
 		}
 
-		$key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
+		$key = $wpdb->esc_like($this->identifier.'_batch_').'%';
 
 		$count = $wpdb->get_var(
 			$wpdb->prepare(
@@ -202,7 +202,7 @@ 
 			)
 		);
 
-		return ( $count > 0 ) ? false : true;
+		return ($count > 0) ? false : true;
 	}
 
 	/**
@@ -212,7 +212,7 @@ 
 	 * in a background process.
 	 */
 	protected function is_process_running() {
-		if ( get_site_transient( $this->identifier . '_process_lock' ) ) {
+		if (get_site_transient($this->identifier.'_process_lock')) {
 			// Process already running.
 			return true;
 		}
@@ -230,10 +230,10 @@ 
 	protected function lock_process() {
 		$this->start_time = time(); // Set start time of current process.
 
-		$lock_duration = ( property_exists( $this, 'queue_lock_time' ) ) ? $this->queue_lock_time : 60; // 1 minute
-		$lock_duration = apply_filters( $this->identifier . '_queue_lock_time', $lock_duration );
+		$lock_duration = (property_exists($this, 'queue_lock_time')) ? $this->queue_lock_time : 60; // 1 minute
+		$lock_duration = apply_filters($this->identifier.'_queue_lock_time', $lock_duration);
 
-		set_site_transient( $this->identifier . '_process_lock', microtime(), $lock_duration );
+		set_site_transient($this->identifier.'_process_lock', microtime(), $lock_duration);
 	}
 
 	/**
@@ -244,7 +244,7 @@ 
 	 * @return $this
 	 */
 	protected function unlock_process() {
-		delete_site_transient( $this->identifier . '_process_lock' );
+		delete_site_transient($this->identifier.'_process_lock');
 
 		return $this;
 	}
@@ -262,14 +262,14 @@ 
 		$key_column   = 'option_id';
 		$value_column = 'option_value';
 
-		if ( is_multisite() ) {
+		if (is_multisite()) {
 			$table        = $wpdb->sitemeta;
 			$column       = 'meta_key';
 			$key_column   = 'meta_id';
 			$value_column = 'meta_value';
 		}
 
-		$key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
+		$key = $wpdb->esc_like($this->identifier.'_batch_').'%';
 
 		$query = $wpdb->get_row(
 			$wpdb->prepare(
@@ -280,7 +280,7 @@ 
 
 		$batch       = new stdClass();
 		$batch->key  = $query->$column;
-		$batch->data = maybe_unserialize( $query->$value_column );
+		$batch->data = maybe_unserialize($query->$value_column);
 
 		return $batch;
 	}
@@ -297,33 +297,33 @@ 
 		do {
 			$batch = $this->get_batch();
 
-			foreach ( $batch->data as $key => $value ) {
-				$task = $this->task( $value );
+			foreach ($batch->data as $key => $value) {
+				$task = $this->task($value);
 
-				if ( false !== $task ) {
-					$batch->data[ $key ] = $task;
+				if (false !== $task) {
+					$batch->data[$key] = $task;
 				} else {
-					unset( $batch->data[ $key ] );
+					unset($batch->data[$key]);
 				}
 
-				if ( $this->time_exceeded() || $this->memory_exceeded() ) {
+				if ($this->time_exceeded() || $this->memory_exceeded()) {
 					// Batch limits reached.
 					break;
 				}
 			}
 
 			// Update or delete current batch.
-			if ( ! empty( $batch->data ) ) {
-				$this->update( $batch->key, $batch->data );
+			if ( ! empty($batch->data)) {
+				$this->update($batch->key, $batch->data);
 			} else {
-				$this->delete( $batch->key );
+				$this->delete($batch->key);
 			}
-		} while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty() );
+		} while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty());
 
 		$this->unlock_process();
 
 		// Start next batch or complete process.
-		if ( ! $this->is_queue_empty() ) {
+		if ( ! $this->is_queue_empty()) {
 			$this->dispatch();
 		} else {
 			$this->complete();
@@ -342,14 +342,14 @@ 
 	 */
 	protected function memory_exceeded() {
 		$memory_limit   = $this->get_memory_limit() * 0.9; // 90% of max memory
-		$current_memory = memory_get_usage( true );
+		$current_memory = memory_get_usage(true);
 		$return         = false;
 
-		if ( $current_memory >= $memory_limit ) {
+		if ($current_memory >= $memory_limit) {
 			$return = true;
 		}
 
-		return apply_filters( $this->identifier . '_memory_exceeded', $return );
+		return apply_filters($this->identifier.'_memory_exceeded', $return);
 	}
 
 	/**
@@ -358,19 +358,19 @@ 
 	 * @return int
 	 */
 	protected function get_memory_limit() {
-		if ( function_exists( 'ini_get' ) ) {
-			$memory_limit = ini_get( 'memory_limit' );
+		if (function_exists('ini_get')) {
+			$memory_limit = ini_get('memory_limit');
 		} else {
 			// Sensible default.
 			$memory_limit = '128M';
 		}
 
-		if ( ! $memory_limit || - 1 === intval( $memory_limit ) ) {
+		if ( ! $memory_limit || - 1 === intval($memory_limit)) {
 			// Unlimited, set to 32GB.
 			$memory_limit = '32000M';
 		}
 
-		return wp_convert_hr_to_bytes( $memory_limit );
+		return wp_convert_hr_to_bytes($memory_limit);
 	}
 
 	/**
@@ -382,14 +382,14 @@ 
 	 * @return bool
 	 */
 	protected function time_exceeded() {
-		$finish = $this->start_time + apply_filters( $this->identifier . '_default_time_limit', 20 ); // 20 seconds
+		$finish = $this->start_time + apply_filters($this->identifier.'_default_time_limit', 20); // 20 seconds
 		$return = false;
 
-		if ( time() >= $finish ) {
+		if (time() >= $finish) {
 			$return = true;
 		}
 
-		return apply_filters( $this->identifier . '_time_exceeded', $return );
+		return apply_filters($this->identifier.'_time_exceeded', $return);
 	}
 
 	/**
@@ -412,17 +412,17 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function schedule_cron_healthcheck( $schedules ) {
-		$interval = apply_filters( $this->identifier . '_cron_interval', 5 );
+	public function schedule_cron_healthcheck($schedules) {
+		$interval = apply_filters($this->identifier.'_cron_interval', 5);
 
-		if ( property_exists( $this, 'cron_interval' ) ) {
-			$interval = apply_filters( $this->identifier . '_cron_interval', $this->cron_interval );
+		if (property_exists($this, 'cron_interval')) {
+			$interval = apply_filters($this->identifier.'_cron_interval', $this->cron_interval);
 		}
 
 		// Adds every 5 minutes to the existing schedules.
-		$schedules[ $this->identifier . '_cron_interval' ] = array(
+		$schedules[$this->identifier.'_cron_interval'] = array(
 			'interval' => MINUTE_IN_SECONDS * $interval,
-			'display'  => sprintf( __( 'Every %d Minutes' ), $interval ),
+			'display'  => sprintf(__('Every %d Minutes'), $interval),
 		);
 
 		return $schedules;
@@ -435,12 +435,12 @@ 
 	 * and data exists in the queue.
 	 */
 	public function handle_cron_healthcheck() {
-		if ( $this->is_process_running() ) {
+		if ($this->is_process_running()) {
 			// Background process already running.
 			exit;
 		}
 
-		if ( $this->is_queue_empty() ) {
+		if ($this->is_queue_empty()) {
 			// No data to process.
 			$this->clear_scheduled_event();
 			exit;
@@ -455,8 +455,8 @@ 
 	 * Schedule event
 	 */
 	protected function schedule_event() {
-		if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {
-			wp_schedule_event( time(), $this->cron_interval_identifier, $this->cron_hook_identifier );
+		if ( ! wp_next_scheduled($this->cron_hook_identifier)) {
+			wp_schedule_event(time(), $this->cron_interval_identifier, $this->cron_hook_identifier);
 		}
 	}
 
@@ -464,10 +464,10 @@ 
 	 * Clear scheduled event
 	 */
 	protected function clear_scheduled_event() {
-		$timestamp = wp_next_scheduled( $this->cron_hook_identifier );
+		$timestamp = wp_next_scheduled($this->cron_hook_identifier);
 
-		if ( $timestamp ) {
-			wp_unschedule_event( $timestamp, $this->cron_hook_identifier );
+		if ($timestamp) {
+			wp_unschedule_event($timestamp, $this->cron_hook_identifier);
 		}
 	}
 
@@ -477,12 +477,12 @@ 
 	 * Stop processing queue items, clear cronjob and delete batch.
 	 */
 	public function cancel_process() {
-		if ( ! $this->is_queue_empty() ) {
+		if ( ! $this->is_queue_empty()) {
 			$batch = $this->get_batch();
 
-			$this->delete( $batch->key );
+			$this->delete($batch->key);
 
-			wp_clear_scheduled_hook( $this->cron_hook_identifier );
+			wp_clear_scheduled_hook($this->cron_hook_identifier);
 		}
 
 	}
@@ -499,6 +499,6 @@ 
 	 *
 	 * @return mixed
 	 */
-	abstract protected function task( $item );
+	abstract protected function task($item);
 
 }

src/widgets/class-wordlift-timeline-widget.php

Indentation +42 added lines, -42 removed lines

@@ -2,53 +2,53 @@
 
 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
-		);
-	}
+    /**
+     * 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
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function widget( $args, $instance ) {
-		// outputs the content of the widget
-		echo do_shortcode( '[wl_timeline global=true]' );
-	}
+    /**
+     * Outputs the content of the widget
+     *
+     * @param array $args
+     * @param array $instance
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    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
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function form( $instance ) {
-		// outputs the options form on admin
-	}
+    /**
+     * Outputs the options form on admin
+     *
+     * @param array $instance The widget options
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    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
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function update( $new_instance, $old_instance ) {
-		// processes widget options to be saved
-	}
+    /**
+     * Processing widget options on save
+     *
+     * @param array $new_instance The new options
+     * @param array $old_instance The previous options
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    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' );
 }

Spacing +7 added lines, -7 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
 		);
 	}
 
@@ -21,9 +21,9 @@ 
 	 * @param array $instance
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	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]');
 	}
 
 	/**
@@ -32,7 +32,7 @@ 
 	 * @param array $instance The widget options
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function form( $instance ) {
+	public function form($instance) {
 		// outputs the options form on admin
 	}
 
@@ -43,12 +43,12 @@ 
 	 * @param array $old_instance The previous options
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	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');
 }

src/widgets/class-wordlift-chord-widget.php

Indentation +48 added lines, -48 removed lines

@@ -10,56 +10,56 @@ 
  */
 class Wordlift_Chord_Widget extends WP_Widget {
 
-	/**
-	 * Sets up the widgets name etc
-	 */
-	public function __construct() {
-		// widget actual processes.
-		parent::__construct(
-			'wl_chord_widget', // Base ID.
-			__( 'Chord Widget', 'wordlift' ), // Name.
-			array(
-				'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ),
-			) // Args.
-		);
-	}
+    /**
+     * Sets up the widgets name etc
+     */
+    public function __construct() {
+        // widget actual processes.
+        parent::__construct(
+            'wl_chord_widget', // Base ID.
+            __( 'Chord Widget', 'wordlift' ), // Name.
+            array(
+                'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ),
+            ) // Args.
+        );
+    }
 
-	/**
-	 * Outputs the content of the widget
-	 *
-	 * @param array $args widget args.
-	 * @param array $instance widget instance.
-	 */
-	// @codingStandardsIgnoreLine Generic.CodeAnalysis.UnusedFunctionParameter.Found
-	public function widget( $args, $instance ) {
-		// outputs the content of the widget.
-		echo do_shortcode( '[wl_chord global=true]' );
-	}
+    /**
+     * Outputs the content of the widget
+     *
+     * @param array $args widget args.
+     * @param array $instance widget instance.
+     */
+    // @codingStandardsIgnoreLine Generic.CodeAnalysis.UnusedFunctionParameter.Found
+    public function widget( $args, $instance ) {
+        // outputs the content of the widget.
+        echo do_shortcode( '[wl_chord global=true]' );
+    }
 
-	/**
-	 * Outputs the options form on admin
-	 *
-	 * @param array $instance The widget options.
-	 *
-	 * @return string|void
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function form( $instance ) {
-		// outputs the options form on admin.
-	}
+    /**
+     * Outputs the options form on admin
+     *
+     * @param array $instance The widget options.
+     *
+     * @return string|void
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    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.
-	 *
-	 * @return array|void
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function update( $new_instance, $old_instance ) {
-		// processes widget options to be saved.
-	}
+    /**
+     * Processing widget options on save
+     *
+     * @param array $new_instance The new options.
+     * @param array $old_instance The previous options.
+     *
+     * @return array|void
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function update( $new_instance, $old_instance ) {
+        // processes widget options to be saved.
+    }
 }
 
 /**
@@ -69,5 +69,5 @@ 
  */
 function wl_register_chord_widget() {
 
-	register_widget( 'WordLift_Chord_Widget' );
+    register_widget( 'WordLift_Chord_Widget' );
 }

Spacing +7 added lines, -7 removed lines

@@ -17,9 +17,9 @@ 
 		// widget actual processes.
 		parent::__construct(
 			'wl_chord_widget', // Base ID.
-			__( 'Chord Widget', 'wordlift' ), // Name.
+			__('Chord Widget', 'wordlift'), // Name.
 			array(
-				'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ),
+				'description' => __('The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift'),
 			) // Args.
 		);
 	}
@@ -31,9 +31,9 @@ 
 	 * @param array $instance widget instance.
 	 */
 	// @codingStandardsIgnoreLine Generic.CodeAnalysis.UnusedFunctionParameter.Found
-	public function widget( $args, $instance ) {
+	public function widget($args, $instance) {
 		// outputs the content of the widget.
-		echo do_shortcode( '[wl_chord global=true]' );
+		echo do_shortcode('[wl_chord global=true]');
 	}
 
 	/**
@@ -44,7 +44,7 @@ 
 	 * @return string|void
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function form( $instance ) {
+	public function form($instance) {
 		// outputs the options form on admin.
 	}
 
@@ -57,7 +57,7 @@ 
 	 * @return array|void
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function update( $new_instance, $old_instance ) {
+	public function update($new_instance, $old_instance) {
 		// processes widget options to be saved.
 	}
 }
@@ -69,5 +69,5 @@ 
  */
 function wl_register_chord_widget() {
 
-	register_widget( 'WordLift_Chord_Widget' );
+	register_widget('WordLift_Chord_Widget');
 }

src/wordlift-constants.php

Indentation +10 added lines, -10 removed lines

@@ -13,7 +13,7 @@ 
 
 // Use the WordLift API URL set on the command line.
 if ( ! defined( 'WORDLIFT_API_URL' ) && false !== getenv( 'WORDLIFT_API_URL' ) ) {
-	define( 'WORDLIFT_API_URL', getenv( 'WORDLIFT_API_URL' ) );
+    define( 'WORDLIFT_API_URL', getenv( 'WORDLIFT_API_URL' ) );
 }
 
 // 3.13.0, we use by default WLS 1.11 which provides us with the new, faster
@@ -52,15 +52,15 @@ 
  * @since 3.16.0
  */
 function wl_temp_dir() {
-	$tempdir         = get_temp_dir();
-	$unique          = md5( site_url() . get_current_blog_id() );
-	$unique_temp_dir = $tempdir . 'wl_' . $unique; // $tempdir should have a trailing slash.
+    $tempdir         = get_temp_dir();
+    $unique          = md5( site_url() . get_current_blog_id() );
+    $unique_temp_dir = $tempdir . 'wl_' . $unique; // $tempdir should have a trailing slash.
 
-	// If directory do not exist, create it.
-	if ( ! file_exists( $unique_temp_dir ) ) {
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@mkdir( $unique_temp_dir );
-	}
+    // If directory do not exist, create it.
+    if ( ! file_exists( $unique_temp_dir ) ) {
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @mkdir( $unique_temp_dir );
+    }
 
-	return $unique_temp_dir . '/';
+    return $unique_temp_dir . '/';
 }

Spacing +15 added lines, -15 removed lines

@@ -6,43 +6,43 @@ 
  */
 
 // Set the temporary files folder.
-defined( 'WL_TEMP_DIR' ) || define( 'WL_TEMP_DIR', wl_temp_dir() );
+defined('WL_TEMP_DIR') || define('WL_TEMP_DIR', wl_temp_dir());
 
 // Define the meta name used to store the entity URL.
-define( 'WL_ENTITY_URL_META_NAME', 'entity_url' );
+define('WL_ENTITY_URL_META_NAME', 'entity_url');
 
 // WordLift Directory URL.
-defined( 'WL_DIR_URL' ) || define( 'WL_DIR_URL', plugin_dir_url( __FILE__ ) );
+defined('WL_DIR_URL') || define('WL_DIR_URL', plugin_dir_url(__FILE__));
 
 // Use the WordLift API URL set on the command line.
-if ( ! defined( 'WORDLIFT_API_URL' ) && false !== getenv( 'WORDLIFT_API_URL' ) ) {
-	define( 'WORDLIFT_API_URL', getenv( 'WORDLIFT_API_URL' ) );
+if ( ! defined('WORDLIFT_API_URL') && false !== getenv('WORDLIFT_API_URL')) {
+	define('WORDLIFT_API_URL', getenv('WORDLIFT_API_URL'));
 }
 
 // 3.13.0, we use by default WLS 1.11 which provides us with the new, faster
 // chunked analysis.
-define( 'WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE', defined( 'WORDLIFT_API_URL' ) ? WORDLIFT_API_URL . '/' : 'https://api.wordlift.io/' );
+define('WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE', defined('WORDLIFT_API_URL') ? WORDLIFT_API_URL . '/' : 'https://api.wordlift.io/');
 
 // @since 3.29.0 we do not use https://developers.google.com/structured-data/testing-tool/?url=
-define( 'WL_CONFIG_TEST_GOOGLE_RICH_SNIPPETS_URL', 'https://search.google.com/test/rich-results?url=' );
+define('WL_CONFIG_TEST_GOOGLE_RICH_SNIPPETS_URL', 'https://search.google.com/test/rich-results?url=');
 
 // If is set to true, there will be additional button in 'Download Your Data' page
 // that will allow users to download their data in JSON-LD format.
-defined( 'WL_CONFIG_DOWNLOAD_GA_CONTENT_DATA' ) || define( 'WL_CONFIG_DOWNLOAD_GA_CONTENT_DATA', false );
+defined('WL_CONFIG_DOWNLOAD_GA_CONTENT_DATA') || define('WL_CONFIG_DOWNLOAD_GA_CONTENT_DATA', false);
 
 /*
  * Define the default scope for autocomplete requests.
  *
  * @see https://github.com/insideout10/wordlift-plugin/issues/839
  */
-defined( 'WL_AUTOCOMPLETE_SCOPE' ) || define( 'WL_AUTOCOMPLETE_SCOPE', 'cloud' );
+defined('WL_AUTOCOMPLETE_SCOPE') || define('WL_AUTOCOMPLETE_SCOPE', 'cloud');
 
 /*
  * Enable/disable the `all entity types` feature. Initially we keep the feature disabled to enture proper Q/A.
  *
  * @see https://github.com/insideout10/wordlift-plugin/issues/835
  */
-defined( 'WL_ALL_ENTITY_TYPES' ) || define( 'WL_ALL_ENTITY_TYPES', false );
+defined('WL_ALL_ENTITY_TYPES') || define('WL_ALL_ENTITY_TYPES', false);
 
 /**
  * Get a site unique directory under the system or WordPress temporary directory.
@@ -56,14 +56,14 @@ 
  */
 function wl_temp_dir() {
 	$tempdir         = get_temp_dir();
-	$unique          = md5( site_url() . get_current_blog_id() );
-	$unique_temp_dir = $tempdir . 'wl_' . $unique; // $tempdir should have a trailing slash.
+	$unique          = md5(site_url().get_current_blog_id());
+	$unique_temp_dir = $tempdir.'wl_'.$unique; // $tempdir should have a trailing slash.
 
 	// If directory do not exist, create it.
-	if ( ! file_exists( $unique_temp_dir ) ) {
+	if ( ! file_exists($unique_temp_dir)) {
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@mkdir( $unique_temp_dir );
+		@mkdir($unique_temp_dir);
 	}
 
-	return $unique_temp_dir . '/';
+	return $unique_temp_dir.'/';
 }

src/deprecations.php

Indentation +96 added lines, -96 removed lines

@@ -17,7 +17,7 @@ 
  */
 function wl_write_log( $log ) {
 
-	Wordlift_Log_Service::get_instance()->debug( $log );
+    Wordlift_Log_Service::get_instance()->debug( $log );
 
 }
 
@@ -26,21 +26,21 @@ 
  * see http://vip.wordpress.com/documentation/register-additional-html-attributes-for-tinymce-and-wp-kses/
  */
 function wordlift_allowed_post_tags() {
-	global $allowedposttags;
-
-	$tags           = array( 'span' );
-	$new_attributes = array(
-		'itemscope' => array(),
-		'itemtype'  => array(),
-		'itemprop'  => array(),
-		'itemid'    => array(),
-	);
-
-	foreach ( $tags as $tag ) {
-		if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
-			$allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
-		}
-	}
+    global $allowedposttags;
+
+    $tags           = array( 'span' );
+    $new_attributes = array(
+        'itemscope' => array(),
+        'itemtype'  => array(),
+        'itemprop'  => array(),
+        'itemid'    => array(),
+    );
+
+    foreach ( $tags as $tag ) {
+        if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
+            $allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
+        }
+    }
 }
 
 // add allowed post tags.
@@ -51,18 +51,18 @@ 
  */
 function wordlift_admin_enqueue_scripts() {
 
-	// Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
-	wp_enqueue_script( 'wpdialogs' );
-	wp_enqueue_style( 'wp-jquery-ui-dialog' );
+    // Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
+    wp_enqueue_script( 'wpdialogs' );
+    wp_enqueue_style( 'wp-jquery-ui-dialog' );
 
-	wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css', array(), WORDLIFT_VERSION );
+    wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css', array(), WORDLIFT_VERSION );
 
-	wp_enqueue_script( 'jquery-ui-autocomplete' );
+    wp_enqueue_script( 'jquery-ui-autocomplete' );
 
-	// Disable auto-save for custom entity posts only
-	if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
-		wp_dequeue_script( 'autosave' );
-	}
+    // Disable auto-save for custom entity posts only
+    if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
+        wp_dequeue_script( 'autosave' );
+    }
 
 }
 
@@ -78,21 +78,21 @@ 
  */
 function wordlift_allowed_html( $allowedtags, $context ) {
 
-	if ( 'post' !== $context ) {
-		return $allowedtags;
-	}
-
-	return array_merge_recursive(
-		$allowedtags,
-		array(
-			'span' => array(
-				'itemscope' => true,
-				'itemtype'  => true,
-				'itemid'    => true,
-				'itemprop'  => true,
-			),
-		)
-	);
+    if ( 'post' !== $context ) {
+        return $allowedtags;
+    }
+
+    return array_merge_recursive(
+        $allowedtags,
+        array(
+            'span' => array(
+                'itemscope' => true,
+                'itemtype'  => true,
+                'itemid'    => true,
+                'itemprop'  => true,
+            ),
+        )
+    );
 }
 
 add_filter( 'wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2 );
@@ -107,9 +107,9 @@ 
  */
 function wl_get_image_urls( $post_id ) {
 
-	return Wordlift_Storage_Factory::get_instance()
-								   ->post_images()
-								   ->get( $post_id );
+    return Wordlift_Storage_Factory::get_instance()
+                                    ->post_images()
+                                    ->get( $post_id );
 
 }
 
@@ -123,26 +123,26 @@ 
  */
 function wl_get_attachment_for_source_url( $parent_post_id, $source_url ) {
 
-	// wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
-
-	$posts = get_posts(
-		array(
-			'post_type'      => 'attachment',
-			'posts_per_page' => 1,
-			'post_status'    => 'any',
-			'post_parent'    => $parent_post_id,
-			'meta_key'       => 'wl_source_url',
-			'meta_value'     => $source_url,
-		)
-	);
-
-	// Return the found post.
-	if ( 1 === count( $posts ) ) {
-		return $posts[0];
-	}
-
-	// Return null.
-	return null;
+    // wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
+
+    $posts = get_posts(
+        array(
+            'post_type'      => 'attachment',
+            'posts_per_page' => 1,
+            'post_status'    => 'any',
+            'post_parent'    => $parent_post_id,
+            'meta_key'       => 'wl_source_url',
+            'meta_value'     => $source_url,
+        )
+    );
+
+    // Return the found post.
+    if ( 1 === count( $posts ) ) {
+        return $posts[0];
+    }
+
+    // Return null.
+    return null;
 }
 
 /**
@@ -153,8 +153,8 @@ 
  */
 function wl_set_source_url( $post_id, $source_url ) {
 
-	delete_post_meta( $post_id, 'wl_source_url' );
-	add_post_meta( $post_id, 'wl_source_url', $source_url );
+    delete_post_meta( $post_id, 'wl_source_url' );
+    add_post_meta( $post_id, 'wl_source_url', $source_url );
 }
 
 /**
@@ -170,7 +170,7 @@ 
  */
 function wl_sanitize_uri_path( $path, $char = '_' ) {
 
-	return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
+    return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
 }
 
 /**
@@ -182,47 +182,47 @@ 
  */
 function wl_replace_item_id_with_uri( $content ) {
 
-	$log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
-	$log->trace( 'Replacing item IDs with URIs...' );
+    $log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
+    $log->trace( 'Replacing item IDs with URIs...' );
 
-	// Strip slashes, see https://core.trac.wordpress.org/ticket/21767
-	$content = stripslashes( $content );
+    // Strip slashes, see https://core.trac.wordpress.org/ticket/21767
+    $content = stripslashes( $content );
 
-	// If any match are found.
-	$matches = array();
-	if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
+    // If any match are found.
+    $matches = array();
+    if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
 
-		foreach ( $matches as $match ) {
+        foreach ( $matches as $match ) {
 
-			// Get the item ID.
-			$item_id = $match[1];
+            // Get the item ID.
+            $item_id = $match[1];
 
-			// Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
-			$post = Wordlift_Entity_Service::get_instance()
-										   ->get_entity_post_by_uri( $item_id );
+            // Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
+            $post = Wordlift_Entity_Service::get_instance()
+                                            ->get_entity_post_by_uri( $item_id );
 
-			// If no entity is found, continue to the next one.
-			if ( null === $post ) {
-				continue;
-			}
+            // If no entity is found, continue to the next one.
+            if ( null === $post ) {
+                continue;
+            }
 
-			// Get the URI for that post.
-			$uri = wl_get_entity_uri( $post->ID );
+            // Get the URI for that post.
+            $uri = wl_get_entity_uri( $post->ID );
 
-			// wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
+            // wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
 
-			// If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
-			if ( ! empty( $uri ) && $item_id !== $uri ) {
-				$uri_e   = esc_html( $uri );
-				$content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
-			}
-		}
-	}
+            // If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
+            if ( ! empty( $uri ) && $item_id !== $uri ) {
+                $uri_e   = esc_html( $uri );
+                $content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
+            }
+        }
+    }
 
-	// Reapply slashes.
-	$content = addslashes( $content );
+    // Reapply slashes.
+    $content = addslashes( $content );
 
-	return $content;
+    return $content;
 }
 
 add_filter( 'content_save_pre', 'wl_replace_item_id_with_uri', 1, 1 );

Spacing +40 added lines, -40 removed lines

@@ -15,9 +15,9 @@ 
  *
  * @deprecated use Wordlift_Log_Service::get_instance()->info( $log );
  */
-function wl_write_log( $log ) {
+function wl_write_log($log) {
 
-	Wordlift_Log_Service::get_instance()->debug( $log );
+	Wordlift_Log_Service::get_instance()->debug($log);
 
 }
 
@@ -28,7 +28,7 @@ 
 function wordlift_allowed_post_tags() {
 	global $allowedposttags;
 
-	$tags           = array( 'span' );
+	$tags           = array('span');
 	$new_attributes = array(
 		'itemscope' => array(),
 		'itemtype'  => array(),
@@ -36,15 +36,15 @@ 
 		'itemid'    => array(),
 	);
 
-	foreach ( $tags as $tag ) {
-		if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
-			$allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
+	foreach ($tags as $tag) {
+		if (isset($allowedposttags[$tag]) && is_array($allowedposttags[$tag])) {
+			$allowedposttags[$tag] = array_merge($allowedposttags[$tag], $new_attributes); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
 		}
 	}
 }
 
 // add allowed post tags.
-add_action( 'init', 'wordlift_allowed_post_tags' );
+add_action('init', 'wordlift_allowed_post_tags');
 
 /**
  * Register additional scripts for the admin UI.
@@ -52,21 +52,21 @@ 
 function wordlift_admin_enqueue_scripts() {
 
 	// Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
-	wp_enqueue_script( 'wpdialogs' );
-	wp_enqueue_style( 'wp-jquery-ui-dialog' );
+	wp_enqueue_script('wpdialogs');
+	wp_enqueue_style('wp-jquery-ui-dialog');
 
-	wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css', array(), WORDLIFT_VERSION );
+	wp_enqueue_style('wordlift-reloaded', plugin_dir_url(__FILE__).'css/wordlift-reloaded.min.css', array(), WORDLIFT_VERSION);
 
-	wp_enqueue_script( 'jquery-ui-autocomplete' );
+	wp_enqueue_script('jquery-ui-autocomplete');
 
 	// Disable auto-save for custom entity posts only
-	if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
-		wp_dequeue_script( 'autosave' );
+	if (Wordlift_Entity_Service::TYPE_NAME === get_post_type()) {
+		wp_dequeue_script('autosave');
 	}
 
 }
 
-add_action( 'admin_enqueue_scripts', 'wordlift_admin_enqueue_scripts' );
+add_action('admin_enqueue_scripts', 'wordlift_admin_enqueue_scripts');
 
 /**
  * Hooked to *wp_kses_allowed_html* filter, adds microdata attributes.
@@ -76,9 +76,9 @@ 
  *
  * @return array An array which contains allowed microdata attributes.
  */
-function wordlift_allowed_html( $allowedtags, $context ) {
+function wordlift_allowed_html($allowedtags, $context) {
 
-	if ( 'post' !== $context ) {
+	if ('post' !== $context) {
 		return $allowedtags;
 	}
 
@@ -95,7 +95,7 @@ 
 	);
 }
 
-add_filter( 'wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2 );
+add_filter('wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2);
 
 /**
  * Get all the images bound to a post.
@@ -105,11 +105,11 @@ 
  * @return array An array of image URLs.
  * @deprecated use Wordlift_Storage_Factory::get_instance()->post_images()->get( $post_id )
  */
-function wl_get_image_urls( $post_id ) {
+function wl_get_image_urls($post_id) {
 
 	return Wordlift_Storage_Factory::get_instance()
 								   ->post_images()
-								   ->get( $post_id );
+								   ->get($post_id);
 
 }
 
@@ -121,7 +121,7 @@ 
  *
  * @return WP_Post|null A post instance or null if not found.
  */
-function wl_get_attachment_for_source_url( $parent_post_id, $source_url ) {
+function wl_get_attachment_for_source_url($parent_post_id, $source_url) {
 
 	// wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
 
@@ -137,7 +137,7 @@ 
 	);
 
 	// Return the found post.
-	if ( 1 === count( $posts ) ) {
+	if (1 === count($posts)) {
 		return $posts[0];
 	}
 
@@ -151,10 +151,10 @@ 
  * @param int    $post_id The post ID.
  * @param string $source_url The source URL.
  */
-function wl_set_source_url( $post_id, $source_url ) {
+function wl_set_source_url($post_id, $source_url) {
 
-	delete_post_meta( $post_id, 'wl_source_url' );
-	add_post_meta( $post_id, 'wl_source_url', $source_url );
+	delete_post_meta($post_id, 'wl_source_url');
+	add_post_meta($post_id, 'wl_source_url', $source_url);
 }
 
 /**
@@ -168,9 +168,9 @@ 
  * @deprecated use Wordlift_Uri_Service::get_instance()->sanitize_path();
  * @see        https://codex.wordpress.org/Function_Reference/sanitize_title
  */
-function wl_sanitize_uri_path( $path, $char = '_' ) {
+function wl_sanitize_uri_path($path, $char = '_') {
 
-	return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
+	return Wordlift_Uri_Service::get_instance()->sanitize_path($path, $char);
 }
 
 /**
@@ -180,52 +180,52 @@ 
  *
  * @return string The updated post content.
  */
-function wl_replace_item_id_with_uri( $content ) {
+function wl_replace_item_id_with_uri($content) {
 
-	$log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
-	$log->trace( 'Replacing item IDs with URIs...' );
+	$log = Wordlift_Log_Service::get_logger('wl_replace_item_id_with_uri');
+	$log->trace('Replacing item IDs with URIs...');
 
 	// Strip slashes, see https://core.trac.wordpress.org/ticket/21767
-	$content = stripslashes( $content );
+	$content = stripslashes($content);
 
 	// If any match are found.
 	$matches = array();
-	if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
+	if (0 < preg_match_all('/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER)) {
 
-		foreach ( $matches as $match ) {
+		foreach ($matches as $match) {
 
 			// Get the item ID.
 			$item_id = $match[1];
 
 			// Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
 			$post = Wordlift_Entity_Service::get_instance()
-										   ->get_entity_post_by_uri( $item_id );
+										   ->get_entity_post_by_uri($item_id);
 
 			// If no entity is found, continue to the next one.
-			if ( null === $post ) {
+			if (null === $post) {
 				continue;
 			}
 
 			// Get the URI for that post.
-			$uri = wl_get_entity_uri( $post->ID );
+			$uri = wl_get_entity_uri($post->ID);
 
 			// wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
 
 			// If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
-			if ( ! empty( $uri ) && $item_id !== $uri ) {
-				$uri_e   = esc_html( $uri );
-				$content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
+			if ( ! empty($uri) && $item_id !== $uri) {
+				$uri_e   = esc_html($uri);
+				$content = str_replace(" itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content);
 			}
 		}
 	}
 
 	// Reapply slashes.
-	$content = addslashes( $content );
+	$content = addslashes($content);
 
 	return $content;
 }
 
-add_filter( 'content_save_pre', 'wl_replace_item_id_with_uri', 1, 1 );
+add_filter('content_save_pre', 'wl_replace_item_id_with_uri', 1, 1);
 
 require_once 'wordlift-entity-functions.php';
 

src/js/dist/gutenberg-faq-plugin.asset.php

Indentation +2 added lines, -2 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'wp-polyfill', 'wp-rich-text' ),
-	'version'      => '18770cde607d785a81b65ef98e409669',
+    'dependencies' => array( 'wp-polyfill', 'wp-rich-text' ),
+    'version'      => '18770cde607d785a81b65ef98e409669',
 );

Spacing +1 added lines, -1 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'wp-polyfill', 'wp-rich-text' ),
+	'dependencies' => array('wp-polyfill', 'wp-rich-text'),
 	'version'      => '18770cde607d785a81b65ef98e409669',
 );

src/admin/class-wordlift-entity-types-taxonomy-walker.php

Indentation +109 added lines, -109 removed lines

@@ -10,7 +10,7 @@ 
  * @subpackage Wordlift/includes
  */
 if ( ! class_exists( 'Walker_Category_Checklist' ) ) {
-	require_once ABSPATH . 'wp-admin/includes/template.php';
+    require_once ABSPATH . 'wp-admin/includes/template.php';
 }
 
 /**
@@ -24,113 +24,113 @@ 
 // phpcs:ignore Generic.Classes.DuplicateClassName.Found
 class Wordlift_Entity_Types_Taxonomy_Walker extends Walker_Category_Checklist {
 
-	/**
-	 * Entity taxonomy metabox must show exclusive options, no checkboxes.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param       $args     {
-	 *                        An array of arguments.
-	 *
-	 * @type string $taxonomy The taxonomy name.
-	 *              }
-	 *
-	 * @return array An array of arguments, with this walker in case the taxonomy is the Entity Type taxonomy.
-	 */
-	public function terms_checklist_args( $args ) {
-
-		if ( ! isset( $args['taxonomy'] ) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			return $args;
-		}
-
-		// We override the way WP prints the taxonomy metabox HTML.
-		$args['walker']        = $this;
-		$args['checked_ontop'] = false;
-
-		return $args;
-
-	}
-
-	/**
-	 * Change checkboxes to radios.
-	 *
-	 * $max_depth = -1 means flatly display every element.
-	 * $max_depth = 0 means display all levels.
-	 * $max_depth > 0 specifies the number of display levels.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param array $elements  An array of elements.
-	 * @param int   $max_depth The maximum hierarchical depth.
-	 *
-	 * @param array $args      Additional arguments.
-	 *
-	 * @return string The hierarchical item output.
-	 */
-	public function walk( $elements, $max_depth, $args = array() ) {
-
-		// `max_depth` force to -1 to display a flat taxonomy.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/305
-		$output = parent::walk( $elements, - 1, $args );
-
-		$output = str_replace(
-			array( 'type="checkbox"', "type='checkbox'" ),
-			array( 'type="radio"', "type='radio'" ),
-			$output
-		);
-
-		return $output;
-	}
-
-	/**
-	 * Start the element output, output nothing in case of article term.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param string $output   Passed by reference. Used to append additional content.
-	 * @param object $category The current term object.
-	 * @param int    $depth    Depth of the term in reference to parents. Default 0.
-	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
-	 * @param int    $id       ID of the current term.
-	 */
-	public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
-		global $post;
-
-		if ( ! isset( $post ) ) {
-			return;
-		}
-
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
-			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::start_el( $output, $category, $depth, $args, $id );
-		}
-	}
-
-	/**
-	 * End the element output, output nothing in case of article term.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param string $output   Passed by reference. Used to append additional content.
-	 * @param object $category The current term object.
-	 * @param int    $depth    Depth of the term in reference to parents. Default 0.
-	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
-	 */
-	public function end_el( &$output, $category, $depth = 0, $args = array() ) {
-		global $post;
-
-		if ( ! isset( $post ) ) {
-			return;
-		}
-
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
-			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::end_el( $output, $category, $depth, $args );
-		}
-
-	}
+    /**
+     * Entity taxonomy metabox must show exclusive options, no checkboxes.
+     *
+     * @since 3.1.0
+     *
+     * @param       $args     {
+     *                        An array of arguments.
+     *
+     * @type string $taxonomy The taxonomy name.
+     *              }
+     *
+     * @return array An array of arguments, with this walker in case the taxonomy is the Entity Type taxonomy.
+     */
+    public function terms_checklist_args( $args ) {
+
+        if ( ! isset( $args['taxonomy'] ) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+            return $args;
+        }
+
+        // We override the way WP prints the taxonomy metabox HTML.
+        $args['walker']        = $this;
+        $args['checked_ontop'] = false;
+
+        return $args;
+
+    }
+
+    /**
+     * Change checkboxes to radios.
+     *
+     * $max_depth = -1 means flatly display every element.
+     * $max_depth = 0 means display all levels.
+     * $max_depth > 0 specifies the number of display levels.
+     *
+     * @since 3.1.0
+     *
+     * @param array $elements  An array of elements.
+     * @param int   $max_depth The maximum hierarchical depth.
+     *
+     * @param array $args      Additional arguments.
+     *
+     * @return string The hierarchical item output.
+     */
+    public function walk( $elements, $max_depth, $args = array() ) {
+
+        // `max_depth` force to -1 to display a flat taxonomy.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/305
+        $output = parent::walk( $elements, - 1, $args );
+
+        $output = str_replace(
+            array( 'type="checkbox"', "type='checkbox'" ),
+            array( 'type="radio"', "type='radio'" ),
+            $output
+        );
+
+        return $output;
+    }
+
+    /**
+     * Start the element output, output nothing in case of article term.
+     *
+     * @since 3.15.0
+     *
+     * @param string $output   Passed by reference. Used to append additional content.
+     * @param object $category The current term object.
+     * @param int    $depth    Depth of the term in reference to parents. Default 0.
+     * @param array  $args     An array of arguments. @see wp_terms_checklist()
+     * @param int    $id       ID of the current term.
+     */
+    public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
+        global $post;
+
+        if ( ! isset( $post ) ) {
+            return;
+        }
+
+        if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+             || 'article' !== $category->slug
+             || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+            parent::start_el( $output, $category, $depth, $args, $id );
+        }
+    }
+
+    /**
+     * End the element output, output nothing in case of article term.
+     *
+     * @since 3.15.0
+     *
+     * @param string $output   Passed by reference. Used to append additional content.
+     * @param object $category The current term object.
+     * @param int    $depth    Depth of the term in reference to parents. Default 0.
+     * @param array  $args     An array of arguments. @see wp_terms_checklist()
+     */
+    public function end_el( &$output, $category, $depth = 0, $args = array() ) {
+        global $post;
+
+        if ( ! isset( $post ) ) {
+            return;
+        }
+
+        if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+             || 'article' !== $category->slug
+             || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+            parent::end_el( $output, $category, $depth, $args );
+        }
+
+    }
 
 }

Spacing +18 added lines, -18 removed lines

@@ -9,8 +9,8 @@ 
  * @package    Wordlift
  * @subpackage Wordlift/includes
  */
-if ( ! class_exists( 'Walker_Category_Checklist' ) ) {
-	require_once ABSPATH . 'wp-admin/includes/template.php';
+if ( ! class_exists('Walker_Category_Checklist')) {
+	require_once ABSPATH.'wp-admin/includes/template.php';
 }
 
 /**
@@ -37,9 +37,9 @@ 
 	 *
 	 * @return array An array of arguments, with this walker in case the taxonomy is the Entity Type taxonomy.
 	 */
-	public function terms_checklist_args( $args ) {
+	public function terms_checklist_args($args) {
 
-		if ( ! isset( $args['taxonomy'] ) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+		if ( ! isset($args['taxonomy']) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy']) {
 			return $args;
 		}
 
@@ -67,16 +67,16 @@ 
 	 *
 	 * @return string The hierarchical item output.
 	 */
-	public function walk( $elements, $max_depth, $args = array() ) {
+	public function walk($elements, $max_depth, $args = array()) {
 
 		// `max_depth` force to -1 to display a flat taxonomy.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/305
-		$output = parent::walk( $elements, - 1, $args );
+		$output = parent::walk($elements, - 1, $args);
 
 		$output = str_replace(
-			array( 'type="checkbox"', "type='checkbox'" ),
-			array( 'type="radio"', "type='radio'" ),
+			array('type="checkbox"', "type='checkbox'"),
+			array('type="radio"', "type='radio'"),
 			$output
 		);
 
@@ -94,17 +94,17 @@ 
 	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
 	 * @param int    $id       ID of the current term.
 	 */
-	public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
+	public function start_el(&$output, $category, $depth = 0, $args = array(), $id = 0) {
 		global $post;
 
-		if ( ! isset( $post ) ) {
+		if ( ! isset($post)) {
 			return;
 		}
 
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+		if (Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
 			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::start_el( $output, $category, $depth, $args, $id );
+			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy']) {
+			parent::start_el($output, $category, $depth, $args, $id);
 		}
 	}
 
@@ -118,17 +118,17 @@ 
 	 * @param int    $depth    Depth of the term in reference to parents. Default 0.
 	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
 	 */
-	public function end_el( &$output, $category, $depth = 0, $args = array() ) {
+	public function end_el(&$output, $category, $depth = 0, $args = array()) {
 		global $post;
 
-		if ( ! isset( $post ) ) {
+		if ( ! isset($post)) {
 			return;
 		}
 
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+		if (Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
 			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::end_el( $output, $category, $depth, $args );
+			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy']) {
+			parent::end_el($output, $category, $depth, $args);
 		}
 
 	}