insideout10 / wordlift-plugin

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

Indentation +198 added lines, -198 removed lines

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

Spacing +38 added lines, -38 removed lines

@@ -39,17 +39,17 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function __construct( $cache_service ) {
+	public function __construct($cache_service) {
 		parent::__construct();
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		// Add hooks for meta being added/modified/deleted.
 		$this->cache_service = $cache_service;
 
-		add_action( 'add_post_meta', array( $this, 'on_before_post_meta_add' ), 10, 3 );
-		add_action( 'update_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
-		add_action( 'delete_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
+		add_action('add_post_meta', array($this, 'on_before_post_meta_add'), 10, 3);
+		add_action('update_post_meta', array($this, 'on_before_post_meta_change'), 10, 4);
+		add_action('delete_post_meta', array($this, 'on_before_post_meta_change'), 10, 4);
 
 	}
 
@@ -60,24 +60,24 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function preload_uris( $uris ) {
+	public function preload_uris($uris) {
 
 		// Filter the URIs which aren't yet cached.
 		$cache_service = $this->cache_service;
 		$uris_to_cache = array_filter(
 			(array) $uris,
-			function ( $item ) use ( $cache_service ) {
-				return ! $cache_service->has_cache( $item );
+			function($item) use ($cache_service) {
+				return ! $cache_service->has_cache($item);
 			}
 		);
 
 		// Preload the URIs.
-		parent::preload_uris( $uris_to_cache );
+		parent::preload_uris($uris_to_cache);
 
 		// Store them in cache.
-		if ( is_array( $this->uri_to_post ) && ! empty( $this->uri_to_post ) ) {
-			foreach ( $this->uri_to_post as $uri => $post_id ) {
-				$this->set_cache( $uri, $post_id );
+		if (is_array($this->uri_to_post) && ! empty($this->uri_to_post)) {
+			foreach ($this->uri_to_post as $uri => $post_id) {
+				$this->set_cache($uri, $post_id);
 			}
 		}
 
@@ -91,26 +91,26 @@ 
 	 * @return null|WP_Post The {@link WP_Post} or null if not found.
 	 * @since 3.16.3
 	 */
-	public function get_entity( $uri ) {
+	public function get_entity($uri) {
 
-		$this->log->trace( "Getting entity for uri $uri..." );
+		$this->log->trace("Getting entity for uri $uri...");
 
 		// Get the cached post for the specified URI.
-		$cache = $this->cache_service->get_cache( $uri );
+		$cache = $this->cache_service->get_cache($uri);
 
 		// Return the cached data if valid.
-		if ( false !== $cache && is_numeric( $cache ) ) {
-			$this->log->debug( "Cached entity $cache for uri $uri found." );
+		if (false !== $cache && is_numeric($cache)) {
+			$this->log->debug("Cached entity $cache for uri $uri found.");
 
-			return get_post( $cache );
+			return get_post($cache);
 		}
 
 		// Get the actual result.
-		$post = parent::get_entity( $uri );
+		$post = parent::get_entity($uri);
 
 		// Cache the result.
-		if ( null !== $post ) {
-			$this->set_cache( $uri, $post->ID );
+		if (null !== $post) {
+			$this->set_cache($uri, $post->ID);
 		}
 
 		// Return the result.
@@ -126,10 +126,10 @@ 
 	 * @since 3.16.3
 	 * @since 3.29.0 takes a post ID as input.
 	 */
-	private function set_cache( $uri, $post_id ) {
+	private function set_cache($uri, $post_id) {
 
 		// Cache the result.
-		$this->cache_service->set_cache( $uri, $post_id );
+		$this->cache_service->set_cache($uri, $post_id);
 
 	}
 
@@ -140,12 +140,12 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	private function delete_cache( $uris ) {
+	private function delete_cache($uris) {
 
 		// Delete the cache for each URI.
-		foreach ( $uris as $uri ) {
+		foreach ($uris as $uri) {
 			// Delete the single cache file.
-			$this->cache_service->delete_cache( $uri );
+			$this->cache_service->delete_cache($uri);
 		}
 
 	}
@@ -164,28 +164,28 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function on_before_post_meta_change( $meta_ids, $post_id, $meta_key, $meta_value ) {
+	public function on_before_post_meta_change($meta_ids, $post_id, $meta_key, $meta_value) {
 
 		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+		if (WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key) {
 			return;
 		}
 
-		$this->log->trace( "Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache..." );
+		$this->log->trace("Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache...");
 
 		// The list of existing URIs, plus the list of URIs being deleted/updated.
-		$old_value = get_post_meta( $post_id, $meta_key );
+		$old_value = get_post_meta($post_id, $meta_key);
 
 		// We expect an array here from the `get_post_meta` signature. However `get_post_meta` is prone to side effects
 		// because of filters. So if it's not we return an empty array.
-		if ( ! is_array( $old_value ) ) {
+		if ( ! is_array($old_value)) {
 			$old_value = array();
 		}
-		$new_value = isset( $meta_value ) ? (array) $meta_value : array();
-		$uris      = array_merge( $old_value, $new_value );
+		$new_value = isset($meta_value) ? (array) $meta_value : array();
+		$uris      = array_merge($old_value, $new_value);
 
 		// Delete the cache for those URIs.
-		$this->delete_cache( $uris );
+		$this->delete_cache($uris);
 
 	}
 
@@ -199,17 +199,17 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function on_before_post_meta_add( $post_id, $meta_key, $meta_value ) {
+	public function on_before_post_meta_add($post_id, $meta_key, $meta_value) {
 
 		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+		if (WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key) {
 			return;
 		}
 
-		$this->log->trace( "Adding $meta_key for post $post_id ($meta_key), invalidating cache..." );
+		$this->log->trace("Adding $meta_key for post $post_id ($meta_key), invalidating cache...");
 
 		// Delete the cache for the URIs being added.
-		$this->delete_cache( (array) $meta_value );
+		$this->delete_cache((array) $meta_value);
 
 	}
 

src/includes/class-wordlift-http-api.php

Indentation +180 added lines, -180 removed lines

@@ -16,185 +16,185 @@
  */
 class Wordlift_Http_Api {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.15.3
-	 *
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a {@link Wordlift_End_Point} instance.
-	 *
-	 * @since 3.15.3
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		add_action( 'init', array( $this, 'add_rewrite_endpoint' ) );
-		add_action( 'template_redirect', array( $this, 'template_redirect' ) );
-
-		// region SAMPLE ACTIONS.
-		add_action(
-			'admin_post_wl_hello_world',
-			array(
-				$this,
-				'hello_world',
-			)
-		);
-		add_action(
-			'admin_post_nopriv_wl_hello_world',
-			array(
-				$this,
-				'nopriv_hello_world',
-			)
-		);
-		// endregion
-	}
-
-	/**
-	 * Add the `wl-api` rewrite end-point.
-	 *
-	 * @since 3.15.3
-	 */
-	public function add_rewrite_endpoint() {
-
-		add_rewrite_endpoint( 'wl-api', EP_ROOT );
-		$this->ensure_rewrite_rules_are_flushed();
-
-	}
-
-	/**
-	 * Handle `template_redirect` hooks.
-	 *
-	 * @since 3.15.3
-	 */
-	public function template_redirect() {
-
-		global $wp_query;
-
-		if ( ! isset( $wp_query->query_vars['wl-api'] ) ) {
-			$this->log->trace( 'Skipping, not a `wl-api` call.' );
-
-			return;
-		}
-
-		$action = isset( $_REQUEST['action'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$this->do_action( $action );
-
-		exit;
-
-	}
-
-	/**
-	 * Do the requested action.
-	 *
-	 * @param string $action The action to execute.
-	 *
-	 * @since 3.15.3
-	 */
-	private function do_action( $action ) {
-
-		if ( empty( $action ) ) {
-			return;
-		}
-
-		if ( ! wp_validate_auth_cookie( '', 'logged_in' ) ) {
-			/**
-			 * Fires on a non-authenticated admin post request for the given action.
-			 *
-			 * The dynamic portion of the hook name, `$action`, refers to the given
-			 * request action.
-			 *
-			 * @since 2.6.0
-			 */
-			do_action( "admin_post_nopriv_{$action}" );
-		} else {
-			/**
-			 * Fires on an authenticated admin post request for the given action.
-			 *
-			 * The dynamic portion of the hook name, `$action`, refers to the given
-			 * request action.
-			 *
-			 * @since 2.6.0
-			 */
-			do_action( "admin_post_{$action}" );
-		}
-
-	}
-
-	/**
-	 * Test function, anonymous.
-	 *
-	 * @since 3.15.3
-	 */
-	public function nopriv_hello_world() {
-
-		wp_die( 'Hello World! (from anonymous)' );
-
-	}
-
-	/**
-	 * Test function, authenticated.
-	 *
-	 * @since 3.15.3
-	 */
-	public function hello_world() {
-
-		wp_die( 'Hello World! (from authenticated)' );
-
-	}
-
-	/**
-	 * Ensure that the rewrite rules are flushed the first time.
-	 *
-	 * @since 3.16.0 changed the value from 1 to `yes` to avoid type juggling issues.
-	 * @since 3.15.3
-	 */
-	public static function ensure_rewrite_rules_are_flushed() {
-
-		// See https://github.com/insideout10/wordlift-plugin/issues/698.
-		if ( 'yes' !== get_option( 'wl_http_api' ) ) {
-			update_option( 'wl_http_api', 'yes' );
-			add_action(
-				'wp_loaded',
-				function () {
-					flush_rewrite_rules();
-				}
-			);
-		}
-
-	}
-
-	/**
-	 * Called by {@see activate_wordlift}, resets the `wl_http_api` option flag in order to force WordLift to
-	 * reinitialize the `wl-api` route.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
-	 *
-	 * @since 3.19.2
-	 */
-	public static function activate() {
-
-		// Force the plugin to reinitialize the rewrite rules.
-		update_option( 'wl_http_api', 'no' );
-
-	}
-
-	/**
-	 * Delete the option when the plugin is deactivated.
-	 *
-	 * @since 3.19.4
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/846
-	 */
-	public static function deactivate() {
-
-		delete_option( 'wl_http_api' );
-
-	}
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.15.3
+     *
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a {@link Wordlift_End_Point} instance.
+     *
+     * @since 3.15.3
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        add_action( 'init', array( $this, 'add_rewrite_endpoint' ) );
+        add_action( 'template_redirect', array( $this, 'template_redirect' ) );
+
+        // region SAMPLE ACTIONS.
+        add_action(
+            'admin_post_wl_hello_world',
+            array(
+                $this,
+                'hello_world',
+            )
+        );
+        add_action(
+            'admin_post_nopriv_wl_hello_world',
+            array(
+                $this,
+                'nopriv_hello_world',
+            )
+        );
+        // endregion
+    }
+
+    /**
+     * Add the `wl-api` rewrite end-point.
+     *
+     * @since 3.15.3
+     */
+    public function add_rewrite_endpoint() {
+
+        add_rewrite_endpoint( 'wl-api', EP_ROOT );
+        $this->ensure_rewrite_rules_are_flushed();
+
+    }
+
+    /**
+     * Handle `template_redirect` hooks.
+     *
+     * @since 3.15.3
+     */
+    public function template_redirect() {
+
+        global $wp_query;
+
+        if ( ! isset( $wp_query->query_vars['wl-api'] ) ) {
+            $this->log->trace( 'Skipping, not a `wl-api` call.' );
+
+            return;
+        }
+
+        $action = isset( $_REQUEST['action'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $this->do_action( $action );
+
+        exit;
+
+    }
+
+    /**
+     * Do the requested action.
+     *
+     * @param string $action The action to execute.
+     *
+     * @since 3.15.3
+     */
+    private function do_action( $action ) {
+
+        if ( empty( $action ) ) {
+            return;
+        }
+
+        if ( ! wp_validate_auth_cookie( '', 'logged_in' ) ) {
+            /**
+             * Fires on a non-authenticated admin post request for the given action.
+             *
+             * The dynamic portion of the hook name, `$action`, refers to the given
+             * request action.
+             *
+             * @since 2.6.0
+             */
+            do_action( "admin_post_nopriv_{$action}" );
+        } else {
+            /**
+             * Fires on an authenticated admin post request for the given action.
+             *
+             * The dynamic portion of the hook name, `$action`, refers to the given
+             * request action.
+             *
+             * @since 2.6.0
+             */
+            do_action( "admin_post_{$action}" );
+        }
+
+    }
+
+    /**
+     * Test function, anonymous.
+     *
+     * @since 3.15.3
+     */
+    public function nopriv_hello_world() {
+
+        wp_die( 'Hello World! (from anonymous)' );
+
+    }
+
+    /**
+     * Test function, authenticated.
+     *
+     * @since 3.15.3
+     */
+    public function hello_world() {
+
+        wp_die( 'Hello World! (from authenticated)' );
+
+    }
+
+    /**
+     * Ensure that the rewrite rules are flushed the first time.
+     *
+     * @since 3.16.0 changed the value from 1 to `yes` to avoid type juggling issues.
+     * @since 3.15.3
+     */
+    public static function ensure_rewrite_rules_are_flushed() {
+
+        // See https://github.com/insideout10/wordlift-plugin/issues/698.
+        if ( 'yes' !== get_option( 'wl_http_api' ) ) {
+            update_option( 'wl_http_api', 'yes' );
+            add_action(
+                'wp_loaded',
+                function () {
+                    flush_rewrite_rules();
+                }
+            );
+        }
+
+    }
+
+    /**
+     * Called by {@see activate_wordlift}, resets the `wl_http_api` option flag in order to force WordLift to
+     * reinitialize the `wl-api` route.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
+     *
+     * @since 3.19.2
+     */
+    public static function activate() {
+
+        // Force the plugin to reinitialize the rewrite rules.
+        update_option( 'wl_http_api', 'no' );
+
+    }
+
+    /**
+     * Delete the option when the plugin is deactivated.
+     *
+     * @since 3.19.4
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/846
+     */
+    public static function deactivate() {
+
+        delete_option( 'wl_http_api' );
+
+    }
 
 }

Spacing +20 added lines, -20 removed lines

@@ -32,10 +32,10 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
-		add_action( 'init', array( $this, 'add_rewrite_endpoint' ) );
-		add_action( 'template_redirect', array( $this, 'template_redirect' ) );
+		add_action('init', array($this, 'add_rewrite_endpoint'));
+		add_action('template_redirect', array($this, 'template_redirect'));
 
 		// region SAMPLE ACTIONS.
 		add_action(
@@ -62,7 +62,7 @@ 
 	 */
 	public function add_rewrite_endpoint() {
 
-		add_rewrite_endpoint( 'wl-api', EP_ROOT );
+		add_rewrite_endpoint('wl-api', EP_ROOT);
 		$this->ensure_rewrite_rules_are_flushed();
 
 	}
@@ -76,14 +76,14 @@ 
 
 		global $wp_query;
 
-		if ( ! isset( $wp_query->query_vars['wl-api'] ) ) {
-			$this->log->trace( 'Skipping, not a `wl-api` call.' );
+		if ( ! isset($wp_query->query_vars['wl-api'])) {
+			$this->log->trace('Skipping, not a `wl-api` call.');
 
 			return;
 		}
 
-		$action = isset( $_REQUEST['action'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$this->do_action( $action );
+		$action = isset($_REQUEST['action']) ? sanitize_text_field(wp_unslash((string) $_REQUEST['action'])) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$this->do_action($action);
 
 		exit;
 
@@ -96,13 +96,13 @@ 
 	 *
 	 * @since 3.15.3
 	 */
-	private function do_action( $action ) {
+	private function do_action($action) {
 
-		if ( empty( $action ) ) {
+		if (empty($action)) {
 			return;
 		}
 
-		if ( ! wp_validate_auth_cookie( '', 'logged_in' ) ) {
+		if ( ! wp_validate_auth_cookie('', 'logged_in')) {
 			/**
 			 * Fires on a non-authenticated admin post request for the given action.
 			 *
@@ -111,7 +111,7 @@ 
 			 *
 			 * @since 2.6.0
 			 */
-			do_action( "admin_post_nopriv_{$action}" );
+			do_action("admin_post_nopriv_{$action}");
 		} else {
 			/**
 			 * Fires on an authenticated admin post request for the given action.
@@ -121,7 +121,7 @@ 
 			 *
 			 * @since 2.6.0
 			 */
-			do_action( "admin_post_{$action}" );
+			do_action("admin_post_{$action}");
 		}
 
 	}
@@ -133,7 +133,7 @@ 
 	 */
 	public function nopriv_hello_world() {
 
-		wp_die( 'Hello World! (from anonymous)' );
+		wp_die('Hello World! (from anonymous)');
 
 	}
 
@@ -144,7 +144,7 @@ 
 	 */
 	public function hello_world() {
 
-		wp_die( 'Hello World! (from authenticated)' );
+		wp_die('Hello World! (from authenticated)');
 
 	}
 
@@ -157,11 +157,11 @@ 
 	public static function ensure_rewrite_rules_are_flushed() {
 
 		// See https://github.com/insideout10/wordlift-plugin/issues/698.
-		if ( 'yes' !== get_option( 'wl_http_api' ) ) {
-			update_option( 'wl_http_api', 'yes' );
+		if ('yes' !== get_option('wl_http_api')) {
+			update_option('wl_http_api', 'yes');
 			add_action(
 				'wp_loaded',
-				function () {
+				function() {
 					flush_rewrite_rules();
 				}
 			);
@@ -180,7 +180,7 @@ 
 	public static function activate() {
 
 		// Force the plugin to reinitialize the rewrite rules.
-		update_option( 'wl_http_api', 'no' );
+		update_option('wl_http_api', 'no');
 
 	}
 
@@ -193,7 +193,7 @@ 
 	 */
 	public static function deactivate() {
 
-		delete_option( 'wl_http_api' );
+		delete_option('wl_http_api');
 
 	}
 

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

Indentation +54 added lines, -54 removed lines

@@ -8,80 +8,80 @@
 
 class Wordlift_Mapping_Ajax_Adapter {
 
-	/**
-	 * The {@link Wordlift_Mapping_Service} instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
-	 */
-	private $mapping_service;
+    /**
+     * The {@link Wordlift_Mapping_Service} instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
+     */
+    private $mapping_service;
 
-	/**
-	 * Create a {@link Wordlift_Mapping_Ajax_Adapter} instance.
-	 *
-	 * @param Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
-	 *
-	 * @since 3.20.0
-	 */
-	public function __construct( $mapping_service ) {
+    /**
+     * Create a {@link Wordlift_Mapping_Ajax_Adapter} instance.
+     *
+     * @param Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
+     *
+     * @since 3.20.0
+     */
+    public function __construct( $mapping_service ) {
 
-		$this->mapping_service = $mapping_service;
+        $this->mapping_service = $mapping_service;
 
-		add_action( 'wp_ajax_wl_set_entity_types_for_post_type', array( $this, 'set_entity_types_for_post_type' ) );
-		add_action( 'wp_ajax_wl_update_post_type_entity_types', array( $this, 'update_post_type_entity_types' ) );
+        add_action( 'wp_ajax_wl_set_entity_types_for_post_type', array( $this, 'set_entity_types_for_post_type' ) );
+        add_action( 'wp_ajax_wl_update_post_type_entity_types', array( $this, 'update_post_type_entity_types' ) );
 
-	}
+    }
 
-	public function set_entity_types_for_post_type() {
+    public function set_entity_types_for_post_type() {
 
-		if ( ! isset( $_REQUEST['post_type'] ) || ! isset( $_REQUEST['entity_types'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			return;
-		}
+        if ( ! isset( $_REQUEST['post_type'] ) || ! isset( $_REQUEST['entity_types'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            return;
+        }
 
-		$post_type    = sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$entity_types = array_map( 'sanitize_text_field', wp_unslash( (array) $_REQUEST['entity_types'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $post_type    = sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $entity_types = array_map( 'sanitize_text_field', wp_unslash( (array) $_REQUEST['entity_types'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
-		$this->mapping_service->set_entity_types_for_post_type( $post_type, $entity_types );
+        $this->mapping_service->set_entity_types_for_post_type( $post_type, $entity_types );
 
-		wp_send_json_success();
+        wp_send_json_success();
 
-	}
+    }
 
-	public function update_post_type_entity_types() {
+    public function update_post_type_entity_types() {
 
-		// If the nonce is invalid, return an error.
-		$nonce = isset( $_REQUEST['_nonce'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['_nonce'] ) ) : '';
-		if ( ! wp_verify_nonce( $nonce, 'update_post_type_entity_types' ) ) {
-			wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
-		}
+        // If the nonce is invalid, return an error.
+        $nonce = isset( $_REQUEST['_nonce'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['_nonce'] ) ) : '';
+        if ( ! wp_verify_nonce( $nonce, 'update_post_type_entity_types' ) ) {
+            wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
+        }
 
-		if ( empty( $_REQUEST['post_type'] ) ) {
-			wp_send_json_error( __( '`post_type` is required', 'wordlift' ) );
-		}
+        if ( empty( $_REQUEST['post_type'] ) ) {
+            wp_send_json_error( __( '`post_type` is required', 'wordlift' ) );
+        }
 
-		if ( empty( $_REQUEST['entity_types'] ) ) {
-			wp_send_json_error( __( '`entity_types` is required', 'wordlift' ) );
-		}
+        if ( empty( $_REQUEST['entity_types'] ) ) {
+            wp_send_json_error( __( '`entity_types` is required', 'wordlift' ) );
+        }
 
-		// Get the post type.
-		$post_type = isset( $_REQUEST['post_type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ) : '';
+        // Get the post type.
+        $post_type = isset( $_REQUEST['post_type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ) : '';
 
-		// Get the entity types URIs.
-		$entity_types = isset( $_REQUEST['entity_types'] ) ? filter_var( wp_unslash( $_REQUEST['entity_types'] ), FILTER_REQUIRE_ARRAY ) : array();
+        // Get the entity types URIs.
+        $entity_types = isset( $_REQUEST['entity_types'] ) ? filter_var( wp_unslash( $_REQUEST['entity_types'] ), FILTER_REQUIRE_ARRAY ) : array();
 
-		// Get the offset.
-		$offset = isset( $_REQUEST['offset'] ) ? intval( $_REQUEST['offset'] ) : 0;
+        // Get the offset.
+        $offset = isset( $_REQUEST['offset'] ) ? intval( $_REQUEST['offset'] ) : 0;
 
-		// Update and get the results.
-		$result = $this->mapping_service->update( $post_type, $entity_types, $offset );
+        // Update and get the results.
+        $result = $this->mapping_service->update( $post_type, $entity_types, $offset );
 
-		// Add our nonce to the result.
-		$result['_nonce'] = wp_create_nonce( 'update_post_type_entity_types' );
+        // Add our nonce to the result.
+        $result['_nonce'] = wp_create_nonce( 'update_post_type_entity_types' );
 
-		// Finally send the results.
-		wp_send_json_success( $result );
+        // Finally send the results.
+        wp_send_json_success( $result );
 
-	}
+    }
 
 }

Spacing +20 added lines, -20 removed lines

@@ -24,25 +24,25 @@ 
 	 *
 	 * @since 3.20.0
 	 */
-	public function __construct( $mapping_service ) {
+	public function __construct($mapping_service) {
 
 		$this->mapping_service = $mapping_service;
 
-		add_action( 'wp_ajax_wl_set_entity_types_for_post_type', array( $this, 'set_entity_types_for_post_type' ) );
-		add_action( 'wp_ajax_wl_update_post_type_entity_types', array( $this, 'update_post_type_entity_types' ) );
+		add_action('wp_ajax_wl_set_entity_types_for_post_type', array($this, 'set_entity_types_for_post_type'));
+		add_action('wp_ajax_wl_update_post_type_entity_types', array($this, 'update_post_type_entity_types'));
 
 	}
 
 	public function set_entity_types_for_post_type() {
 
-		if ( ! isset( $_REQUEST['post_type'] ) || ! isset( $_REQUEST['entity_types'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( ! isset($_REQUEST['post_type']) || ! isset($_REQUEST['entity_types'])) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 			return;
 		}
 
-		$post_type    = sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$entity_types = array_map( 'sanitize_text_field', wp_unslash( (array) $_REQUEST['entity_types'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$post_type    = sanitize_text_field(wp_unslash($_REQUEST['post_type'])); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$entity_types = array_map('sanitize_text_field', wp_unslash((array) $_REQUEST['entity_types'])); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
-		$this->mapping_service->set_entity_types_for_post_type( $post_type, $entity_types );
+		$this->mapping_service->set_entity_types_for_post_type($post_type, $entity_types);
 
 		wp_send_json_success();
 
@@ -51,36 +51,36 @@ 
 	public function update_post_type_entity_types() {
 
 		// If the nonce is invalid, return an error.
-		$nonce = isset( $_REQUEST['_nonce'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['_nonce'] ) ) : '';
-		if ( ! wp_verify_nonce( $nonce, 'update_post_type_entity_types' ) ) {
-			wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
+		$nonce = isset($_REQUEST['_nonce']) ? sanitize_text_field(wp_unslash($_REQUEST['_nonce'])) : '';
+		if ( ! wp_verify_nonce($nonce, 'update_post_type_entity_types')) {
+			wp_send_json_error(__('Nonce Security Check Failed!', 'wordlift'));
 		}
 
-		if ( empty( $_REQUEST['post_type'] ) ) {
-			wp_send_json_error( __( '`post_type` is required', 'wordlift' ) );
+		if (empty($_REQUEST['post_type'])) {
+			wp_send_json_error(__('`post_type` is required', 'wordlift'));
 		}
 
-		if ( empty( $_REQUEST['entity_types'] ) ) {
-			wp_send_json_error( __( '`entity_types` is required', 'wordlift' ) );
+		if (empty($_REQUEST['entity_types'])) {
+			wp_send_json_error(__('`entity_types` is required', 'wordlift'));
 		}
 
 		// Get the post type.
-		$post_type = isset( $_REQUEST['post_type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ) : '';
+		$post_type = isset($_REQUEST['post_type']) ? sanitize_text_field(wp_unslash($_REQUEST['post_type'])) : '';
 
 		// Get the entity types URIs.
-		$entity_types = isset( $_REQUEST['entity_types'] ) ? filter_var( wp_unslash( $_REQUEST['entity_types'] ), FILTER_REQUIRE_ARRAY ) : array();
+		$entity_types = isset($_REQUEST['entity_types']) ? filter_var(wp_unslash($_REQUEST['entity_types']), FILTER_REQUIRE_ARRAY) : array();
 
 		// Get the offset.
-		$offset = isset( $_REQUEST['offset'] ) ? intval( $_REQUEST['offset'] ) : 0;
+		$offset = isset($_REQUEST['offset']) ? intval($_REQUEST['offset']) : 0;
 
 		// Update and get the results.
-		$result = $this->mapping_service->update( $post_type, $entity_types, $offset );
+		$result = $this->mapping_service->update($post_type, $entity_types, $offset);
 
 		// Add our nonce to the result.
-		$result['_nonce'] = wp_create_nonce( 'update_post_type_entity_types' );
+		$result['_nonce'] = wp_create_nonce('update_post_type_entity_types');
 
 		// Finally send the results.
-		wp_send_json_success( $result );
+		wp_send_json_success($result);
 
 	}
 

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

Indentation +218 added lines, -218 removed lines

@@ -14,223 +14,223 @@
  */
 class Wordlift_Mapping_Service {
 
-	/**
-	 * The mapping's options.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var array $options The mapping's options.
-	 */
-	private $options;
-
-	/**
-	 * The {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	private $entity_type_service;
-
-	/**
-	 * The singleton instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Mapping_Service $instance The singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a {@link Wordlift_Mapping_Service} instance.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	public function __construct( $entity_type_service ) {
-
-		// Set the entity type service instance.
-		$this->entity_type_service = $entity_type_service;
-
-		// Load the options.
-		$this->options = get_option( 'wl_mappings', array() );
-
-		// Hook to `wl_valid_entity_post_types` and to `wl_default_entity_types_for_post_type`.
-		add_filter( 'wl_valid_entity_post_types', array( $this, 'valid_entity_post_types' ), 9 );
-		add_filter(
-			'wl_default_entity_types_for_post_type',
-			array(
-				$this,
-				'default_entity_types_for_post_type',
-			),
-			9,
-			2
-		);
-
-		// Set the singleton instance.
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @return \Wordlift_Mapping_Service The singleton instance.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Save the options.
-	 *
-	 * @since 3.20.0
-	 */
-	private function save_options() {
-
-		update_option( 'wl_mappings', $this->options, true );
-
-	}
-
-	/**
-	 * Set the default entity types for a post type.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param string $post_type Post type.
-	 * @param array  $entity_types An array of entity types slugs.
-	 */
-	public function set_entity_types_for_post_type( $post_type, $entity_types ) {
-
-		$this->options[ $post_type ] = $entity_types;
-		$this->save_options();
-
-	}
-
-	/**
-	 * Hook to `wl_valid_entity_post_types` to declare schema.org support for the configured post types.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param array $post_types The default post types.
-	 *
-	 * @return array The supported post types.
-	 */
-	public function valid_entity_post_types( $post_types ) {
-
-		return array_merge( $post_types, array_keys( $this->options ) );
-	}
-
-	/**
-	 * Hook to `wl_default_entity_types_for_post_type` to declare the entity types for a post type.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param array  $default The default entity types.
-	 * @param string $post_type The post type.
-	 *
-	 * @return array The default entity types.
-	 */
-	public function default_entity_types_for_post_type( $default, $post_type ) {
-
-		return isset( $this->options[ $post_type ] ) ? $this->options[ $post_type ] : $default;
-	}
-
-	/**
-	 * Update the post type with the entity types, starting at the specified offset.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param string $post_type The post type.
-	 * @param array  $entity_types The entity types.
-	 * @param int    $offset The offset (0 by default).
-	 *
-	 * @return array {
-	 * The result array.
-	 *
-	 * @type int     $current The current offset.
-	 * @type int     $next The next offset.
-	 * @type int     $count The total element count.
-	 * }
-	 */
-	public function update( $post_type, $entity_types, $offset = 0 ) {
-
-		$entity_type_service = $this->entity_type_service;
-		$tax_query           = $this->get_tax_query( $entity_types );
-
-		return Wordlift_Batch_Action::process(
-			$post_type,
-			$offset,
-			$tax_query,
-			function ( $post_id ) use ( $entity_type_service, $entity_types ) {
-				foreach ( $entity_types as $entity_type ) {
-					$entity_type_service->set( $post_id, $entity_type, false );
-				}
-			}
-		);
-	}
-
-	/**
-	 * Count the number of posts that need to be assigned with the entity types.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param string $post_type The post type.
-	 * @param array  $entity_types An array of entity types.
-	 *
-	 * @return int The number of posts to be assigned with entity types.
-	 */
-	public function count( $post_type, $entity_types ) {
-
-		$tax_query = $this->get_tax_query( $entity_types );
-
-		return Wordlift_Batch_Action::count( $post_type, $tax_query );
-	}
-
-	/**
-	 * Get the taxonomy query for the specified entity types.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param array $entity_types The entity types.
-	 *
-	 * @return array The tax query.
-	 */
-	private function get_tax_query( $entity_types ) {
-
-		$entity_type_service = $this->entity_type_service;
-		$entity_types_terms  = array_filter(
-			array_map(
-				function ( $item ) use ( $entity_type_service ) {
-					return $entity_type_service->get_term_by_uri( $item );
-				},
-				$entity_types
-			)
-		);
-
-		$entity_types_terms_ids = array_map(
-			function ( $term ) {
-				return $term->term_id;
-			},
-			$entity_types_terms
-		);
-
-		$tax_query = array(
-			'tax_query' => array(
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'field'    => 'term_id',
-					'terms'    => $entity_types_terms_ids,
-					'operator' => 'NOT IN',
-				),
-			),
-		);
-
-		return $tax_query;
-	}
+    /**
+     * The mapping's options.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var array $options The mapping's options.
+     */
+    private $options;
+
+    /**
+     * The {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     */
+    private $entity_type_service;
+
+    /**
+     * The singleton instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Mapping_Service $instance The singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * Create a {@link Wordlift_Mapping_Service} instance.
+     *
+     * @since 3.20.0
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     */
+    public function __construct( $entity_type_service ) {
+
+        // Set the entity type service instance.
+        $this->entity_type_service = $entity_type_service;
+
+        // Load the options.
+        $this->options = get_option( 'wl_mappings', array() );
+
+        // Hook to `wl_valid_entity_post_types` and to `wl_default_entity_types_for_post_type`.
+        add_filter( 'wl_valid_entity_post_types', array( $this, 'valid_entity_post_types' ), 9 );
+        add_filter(
+            'wl_default_entity_types_for_post_type',
+            array(
+                $this,
+                'default_entity_types_for_post_type',
+            ),
+            9,
+            2
+        );
+
+        // Set the singleton instance.
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance.
+     *
+     * @since 3.20.0
+     *
+     * @return \Wordlift_Mapping_Service The singleton instance.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Save the options.
+     *
+     * @since 3.20.0
+     */
+    private function save_options() {
+
+        update_option( 'wl_mappings', $this->options, true );
+
+    }
+
+    /**
+     * Set the default entity types for a post type.
+     *
+     * @since 3.20.0
+     *
+     * @param string $post_type Post type.
+     * @param array  $entity_types An array of entity types slugs.
+     */
+    public function set_entity_types_for_post_type( $post_type, $entity_types ) {
+
+        $this->options[ $post_type ] = $entity_types;
+        $this->save_options();
+
+    }
+
+    /**
+     * Hook to `wl_valid_entity_post_types` to declare schema.org support for the configured post types.
+     *
+     * @since 3.20.0
+     *
+     * @param array $post_types The default post types.
+     *
+     * @return array The supported post types.
+     */
+    public function valid_entity_post_types( $post_types ) {
+
+        return array_merge( $post_types, array_keys( $this->options ) );
+    }
+
+    /**
+     * Hook to `wl_default_entity_types_for_post_type` to declare the entity types for a post type.
+     *
+     * @since 3.20.0
+     *
+     * @param array  $default The default entity types.
+     * @param string $post_type The post type.
+     *
+     * @return array The default entity types.
+     */
+    public function default_entity_types_for_post_type( $default, $post_type ) {
+
+        return isset( $this->options[ $post_type ] ) ? $this->options[ $post_type ] : $default;
+    }
+
+    /**
+     * Update the post type with the entity types, starting at the specified offset.
+     *
+     * @since 3.20.0
+     *
+     * @param string $post_type The post type.
+     * @param array  $entity_types The entity types.
+     * @param int    $offset The offset (0 by default).
+     *
+     * @return array {
+     * The result array.
+     *
+     * @type int     $current The current offset.
+     * @type int     $next The next offset.
+     * @type int     $count The total element count.
+     * }
+     */
+    public function update( $post_type, $entity_types, $offset = 0 ) {
+
+        $entity_type_service = $this->entity_type_service;
+        $tax_query           = $this->get_tax_query( $entity_types );
+
+        return Wordlift_Batch_Action::process(
+            $post_type,
+            $offset,
+            $tax_query,
+            function ( $post_id ) use ( $entity_type_service, $entity_types ) {
+                foreach ( $entity_types as $entity_type ) {
+                    $entity_type_service->set( $post_id, $entity_type, false );
+                }
+            }
+        );
+    }
+
+    /**
+     * Count the number of posts that need to be assigned with the entity types.
+     *
+     * @since 3.20.0
+     *
+     * @param string $post_type The post type.
+     * @param array  $entity_types An array of entity types.
+     *
+     * @return int The number of posts to be assigned with entity types.
+     */
+    public function count( $post_type, $entity_types ) {
+
+        $tax_query = $this->get_tax_query( $entity_types );
+
+        return Wordlift_Batch_Action::count( $post_type, $tax_query );
+    }
+
+    /**
+     * Get the taxonomy query for the specified entity types.
+     *
+     * @since 3.20.0
+     *
+     * @param array $entity_types The entity types.
+     *
+     * @return array The tax query.
+     */
+    private function get_tax_query( $entity_types ) {
+
+        $entity_type_service = $this->entity_type_service;
+        $entity_types_terms  = array_filter(
+            array_map(
+                function ( $item ) use ( $entity_type_service ) {
+                    return $entity_type_service->get_term_by_uri( $item );
+                },
+                $entity_types
+            )
+        );
+
+        $entity_types_terms_ids = array_map(
+            function ( $term ) {
+                return $term->term_id;
+            },
+            $entity_types_terms
+        );
+
+        $tax_query = array(
+            'tax_query' => array(
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'field'    => 'term_id',
+                    'terms'    => $entity_types_terms_ids,
+                    'operator' => 'NOT IN',
+                ),
+            ),
+        );
+
+        return $tax_query;
+    }
 
 }

Spacing +22 added lines, -22 removed lines

@@ -48,16 +48,16 @@ 
 	 *
 	 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
 	 */
-	public function __construct( $entity_type_service ) {
+	public function __construct($entity_type_service) {
 
 		// Set the entity type service instance.
 		$this->entity_type_service = $entity_type_service;
 
 		// Load the options.
-		$this->options = get_option( 'wl_mappings', array() );
+		$this->options = get_option('wl_mappings', array());
 
 		// Hook to `wl_valid_entity_post_types` and to `wl_default_entity_types_for_post_type`.
-		add_filter( 'wl_valid_entity_post_types', array( $this, 'valid_entity_post_types' ), 9 );
+		add_filter('wl_valid_entity_post_types', array($this, 'valid_entity_post_types'), 9);
 		add_filter(
 			'wl_default_entity_types_for_post_type',
 			array(
@@ -92,7 +92,7 @@ 
 	 */
 	private function save_options() {
 
-		update_option( 'wl_mappings', $this->options, true );
+		update_option('wl_mappings', $this->options, true);
 
 	}
 
@@ -104,9 +104,9 @@ 
 	 * @param string $post_type Post type.
 	 * @param array  $entity_types An array of entity types slugs.
 	 */
-	public function set_entity_types_for_post_type( $post_type, $entity_types ) {
+	public function set_entity_types_for_post_type($post_type, $entity_types) {
 
-		$this->options[ $post_type ] = $entity_types;
+		$this->options[$post_type] = $entity_types;
 		$this->save_options();
 
 	}
@@ -120,9 +120,9 @@ 
 	 *
 	 * @return array The supported post types.
 	 */
-	public function valid_entity_post_types( $post_types ) {
+	public function valid_entity_post_types($post_types) {
 
-		return array_merge( $post_types, array_keys( $this->options ) );
+		return array_merge($post_types, array_keys($this->options));
 	}
 
 	/**
@@ -135,9 +135,9 @@ 
 	 *
 	 * @return array The default entity types.
 	 */
-	public function default_entity_types_for_post_type( $default, $post_type ) {
+	public function default_entity_types_for_post_type($default, $post_type) {
 
-		return isset( $this->options[ $post_type ] ) ? $this->options[ $post_type ] : $default;
+		return isset($this->options[$post_type]) ? $this->options[$post_type] : $default;
 	}
 
 	/**
@@ -157,18 +157,18 @@ 
 	 * @type int     $count The total element count.
 	 * }
 	 */
-	public function update( $post_type, $entity_types, $offset = 0 ) {
+	public function update($post_type, $entity_types, $offset = 0) {
 
 		$entity_type_service = $this->entity_type_service;
-		$tax_query           = $this->get_tax_query( $entity_types );
+		$tax_query           = $this->get_tax_query($entity_types);
 
 		return Wordlift_Batch_Action::process(
 			$post_type,
 			$offset,
 			$tax_query,
-			function ( $post_id ) use ( $entity_type_service, $entity_types ) {
-				foreach ( $entity_types as $entity_type ) {
-					$entity_type_service->set( $post_id, $entity_type, false );
+			function($post_id) use ($entity_type_service, $entity_types) {
+				foreach ($entity_types as $entity_type) {
+					$entity_type_service->set($post_id, $entity_type, false);
 				}
 			}
 		);
@@ -184,11 +184,11 @@ 
 	 *
 	 * @return int The number of posts to be assigned with entity types.
 	 */
-	public function count( $post_type, $entity_types ) {
+	public function count($post_type, $entity_types) {
 
-		$tax_query = $this->get_tax_query( $entity_types );
+		$tax_query = $this->get_tax_query($entity_types);
 
-		return Wordlift_Batch_Action::count( $post_type, $tax_query );
+		return Wordlift_Batch_Action::count($post_type, $tax_query);
 	}
 
 	/**
@@ -200,20 +200,20 @@ 
 	 *
 	 * @return array The tax query.
 	 */
-	private function get_tax_query( $entity_types ) {
+	private function get_tax_query($entity_types) {
 
 		$entity_type_service = $this->entity_type_service;
 		$entity_types_terms  = array_filter(
 			array_map(
-				function ( $item ) use ( $entity_type_service ) {
-					return $entity_type_service->get_term_by_uri( $item );
+				function($item) use ($entity_type_service) {
+					return $entity_type_service->get_term_by_uri($item);
 				},
 				$entity_types
 			)
 		);
 
 		$entity_types_terms_ids = array_map(
-			function ( $term ) {
+			function($term) {
 				return $term->term_id;
 			},
 			$entity_types_terms

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

Indentation +111 added lines, -111 removed lines

@@ -7,148 +7,148 @@
  */
 class Wordlift_Log_Service {
 
-	const MESSAGE_TEMPLATE = '%-6s [%-40.40s] %s';
-
-	const ERROR = 4;
-	const WARN  = 3;
-	const INFO  = 2;
-	const DEBUG = 1;
-	const TRACE = 0;
-
-	/**
-	 * The class related to the logs.
-	 *
-	 * @since  1.0.0
-	 * @access private
-	 * @var string $class_name The class related to the logs.
-	 */
-	private $class_name;
-
-	/**
-	 * The log levels for printing in log lines.
-	 *
-	 * @var array $levels An array of log levels.
-	 */
-	private static $levels = array(
-		self::TRACE => 'TRACE',
-		self::DEBUG => 'DEBUG',
-		self::INFO  => 'INFO',
-		self::WARN  => 'WARN',
-		self::ERROR => 'ERROR',
-	);
-
-	/**
-	 * A singleton instance for legacy logging.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $instance A singleton instance for legacy logging.
-	 */
-	private static $instance = null;
+    const MESSAGE_TEMPLATE = '%-6s [%-40.40s] %s';
+
+    const ERROR = 4;
+    const WARN  = 3;
+    const INFO  = 2;
+    const DEBUG = 1;
+    const TRACE = 0;
+
+    /**
+     * The class related to the logs.
+     *
+     * @since  1.0.0
+     * @access private
+     * @var string $class_name The class related to the logs.
+     */
+    private $class_name;
+
+    /**
+     * The log levels for printing in log lines.
+     *
+     * @var array $levels An array of log levels.
+     */
+    private static $levels = array(
+        self::TRACE => 'TRACE',
+        self::DEBUG => 'DEBUG',
+        self::INFO  => 'INFO',
+        self::WARN  => 'WARN',
+        self::ERROR => 'ERROR',
+    );
+
+    /**
+     * A singleton instance for legacy logging.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_Log_Service $instance A singleton instance for legacy logging.
+     */
+    private static $instance = null;
 
-	/**
-	 * Create an instance of the Log service.
-	 *
-	 * @param string $class_name The class related to the logs.
-	 *
-	 * @since 1.0.0
-	 */
-	public function __construct( $class_name ) {
+    /**
+     * Create an instance of the Log service.
+     *
+     * @param string $class_name The class related to the logs.
+     *
+     * @since 1.0.0
+     */
+    public function __construct( $class_name ) {
 
-		$this->class_name = $class_name;
+        $this->class_name = $class_name;
 
-	}
+    }
 
-	/**
-	 * Get the ROOT logger.
-	 *
-	 * @return \Wordlift_Log_Service A singleton instance for legacy logging.
-	 * @since 3.10.0
-	 */
-	public static function get_instance() {
+    /**
+     * Get the ROOT logger.
+     *
+     * @return \Wordlift_Log_Service A singleton instance for legacy logging.
+     * @since 3.10.0
+     */
+    public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new Wordlift_Log_Service( 'ROOT' );
-		}
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new Wordlift_Log_Service( 'ROOT' );
+        }
 
-		return self::$instance;
-	}
+        return self::$instance;
+    }
 
-	public static function get_logger( $class_name ) {
+    public static function get_logger( $class_name ) {
 
-		return new Wordlift_Log_Service( $class_name );
+        return new Wordlift_Log_Service( $class_name );
 
-	}
+    }
 
-	/**
-	 * Log a message.
-	 *
-	 * @param string $level The log level.
-	 * @param string $message The message to log.
-	 *
-	 * @since 1.0.0
-	 */
-	public function log( $level, $message ) {
+    /**
+     * Log a message.
+     *
+     * @param string $level The log level.
+     * @param string $message The message to log.
+     *
+     * @since 1.0.0
+     */
+    public function log( $level, $message ) {
 
-		// echo( sprintf( self::MESSAGE_TEMPLATE . "\n", self::$levels[ $level ], $this->class_name, is_array( $message ) ? implode( ', ', $message ) : $message ) );
+        // echo( sprintf( self::MESSAGE_TEMPLATE . "\n", self::$levels[ $level ], $this->class_name, is_array( $message ) ? implode( ', ', $message ) : $message ) );
 
-		// Bail out if `WL_DEBUG` isn't defined or it's false.
-		if ( ! defined( 'WL_DEBUG' ) || false === WL_DEBUG ) {
-			return;
-		}
+        // Bail out if `WL_DEBUG` isn't defined or it's false.
+        if ( ! defined( 'WL_DEBUG' ) || false === WL_DEBUG ) {
+            return;
+        }
 
-		// Bail out if WordLift log level isn't defined, and WP debug is disabled.
-		if ( ! defined( 'WL_LOG_LEVEL' ) && $level < self::ERROR
-			 && ( ! defined( 'WP_DEBUG' ) || false === WP_DEBUG ) ) {
-			return;
-		}
+        // Bail out if WordLift log level isn't defined, and WP debug is disabled.
+        if ( ! defined( 'WL_LOG_LEVEL' ) && $level < self::ERROR
+             && ( ! defined( 'WP_DEBUG' ) || false === WP_DEBUG ) ) {
+            return;
+        }
 
-		// Bail out if the log message is below the minimum log level.
-		if ( defined( 'WL_LOG_LEVEL' ) && $level < intval( WL_LOG_LEVEL ) ) {
-			return;
-		}
+        // Bail out if the log message is below the minimum log level.
+        if ( defined( 'WL_LOG_LEVEL' ) && $level < intval( WL_LOG_LEVEL ) ) {
+            return;
+        }
 
-		// Bail out if there's a filter and we don't match it.
-		$class_name = wp_slash( $this->class_name );
-		if ( defined( 'WL_LOG_FILTER' ) && 1 !== preg_match( "/(^|,)$class_name($|,)/", WL_LOG_FILTER ) ) {
-			return;
-		}
+        // Bail out if there's a filter and we don't match it.
+        $class_name = wp_slash( $this->class_name );
+        if ( defined( 'WL_LOG_FILTER' ) && 1 !== preg_match( "/(^|,)$class_name($|,)/", WL_LOG_FILTER ) ) {
+            return;
+        }
 
-		// Finally log the message.
-		// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
-		error_log( sprintf( self::MESSAGE_TEMPLATE, self::$levels[ $level ], $this->class_name, is_array( $message ) ? implode( ', ', $message ) : $message ) );
+        // Finally log the message.
+        // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
+        error_log( sprintf( self::MESSAGE_TEMPLATE, self::$levels[ $level ], $this->class_name, is_array( $message ) ? implode( ', ', $message ) : $message ) );
 
-	}
+    }
 
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function error( $message, $exception = null ) {
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function error( $message, $exception = null ) {
 
-		$this->log( self::ERROR, $message );
+        $this->log( self::ERROR, $message );
 
-	}
+    }
 
-	public function warn( $message ) {
+    public function warn( $message ) {
 
-		$this->log( self::WARN, $message );
+        $this->log( self::WARN, $message );
 
-	}
+    }
 
-	public function info( $message ) {
+    public function info( $message ) {
 
-		$this->log( self::INFO, $message );
+        $this->log( self::INFO, $message );
 
-	}
+    }
 
-	public function debug( $message ) {
+    public function debug( $message ) {
 
-		$this->log( self::DEBUG, $message );
+        $this->log( self::DEBUG, $message );
 
-	}
+    }
 
-	public function trace( $message ) {
+    public function trace( $message ) {
 
-		$this->log( self::TRACE, $message );
+        $this->log( self::TRACE, $message );
 
-	}
+    }
 
 }

Spacing +23 added lines, -23 removed lines

@@ -53,7 +53,7 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	public function __construct( $class_name ) {
+	public function __construct($class_name) {
 
 		$this->class_name = $class_name;
 
@@ -67,16 +67,16 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new Wordlift_Log_Service( 'ROOT' );
+		if ( ! isset(self::$instance)) {
+			self::$instance = new Wordlift_Log_Service('ROOT');
 		}
 
 		return self::$instance;
 	}
 
-	public static function get_logger( $class_name ) {
+	public static function get_logger($class_name) {
 
-		return new Wordlift_Log_Service( $class_name );
+		return new Wordlift_Log_Service($class_name);
 
 	}
 
@@ -88,66 +88,66 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	public function log( $level, $message ) {
+	public function log($level, $message) {
 
 		// echo( sprintf( self::MESSAGE_TEMPLATE . "\n", self::$levels[ $level ], $this->class_name, is_array( $message ) ? implode( ', ', $message ) : $message ) );
 
 		// Bail out if `WL_DEBUG` isn't defined or it's false.
-		if ( ! defined( 'WL_DEBUG' ) || false === WL_DEBUG ) {
+		if ( ! defined('WL_DEBUG') || false === WL_DEBUG) {
 			return;
 		}
 
 		// Bail out if WordLift log level isn't defined, and WP debug is disabled.
-		if ( ! defined( 'WL_LOG_LEVEL' ) && $level < self::ERROR
-			 && ( ! defined( 'WP_DEBUG' ) || false === WP_DEBUG ) ) {
+		if ( ! defined('WL_LOG_LEVEL') && $level < self::ERROR
+			 && ( ! defined('WP_DEBUG') || false === WP_DEBUG)) {
 			return;
 		}
 
 		// Bail out if the log message is below the minimum log level.
-		if ( defined( 'WL_LOG_LEVEL' ) && $level < intval( WL_LOG_LEVEL ) ) {
+		if (defined('WL_LOG_LEVEL') && $level < intval(WL_LOG_LEVEL)) {
 			return;
 		}
 
 		// Bail out if there's a filter and we don't match it.
-		$class_name = wp_slash( $this->class_name );
-		if ( defined( 'WL_LOG_FILTER' ) && 1 !== preg_match( "/(^|,)$class_name($|,)/", WL_LOG_FILTER ) ) {
+		$class_name = wp_slash($this->class_name);
+		if (defined('WL_LOG_FILTER') && 1 !== preg_match("/(^|,)$class_name($|,)/", WL_LOG_FILTER)) {
 			return;
 		}
 
 		// Finally log the message.
 		// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
-		error_log( sprintf( self::MESSAGE_TEMPLATE, self::$levels[ $level ], $this->class_name, is_array( $message ) ? implode( ', ', $message ) : $message ) );
+		error_log(sprintf(self::MESSAGE_TEMPLATE, self::$levels[$level], $this->class_name, is_array($message) ? implode(', ', $message) : $message));
 
 	}
 
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function error( $message, $exception = null ) {
+	public function error($message, $exception = null) {
 
-		$this->log( self::ERROR, $message );
+		$this->log(self::ERROR, $message);
 
 	}
 
-	public function warn( $message ) {
+	public function warn($message) {
 
-		$this->log( self::WARN, $message );
+		$this->log(self::WARN, $message);
 
 	}
 
-	public function info( $message ) {
+	public function info($message) {
 
-		$this->log( self::INFO, $message );
+		$this->log(self::INFO, $message);
 
 	}
 
-	public function debug( $message ) {
+	public function debug($message) {
 
-		$this->log( self::DEBUG, $message );
+		$this->log(self::DEBUG, $message);
 
 	}
 
-	public function trace( $message ) {
+	public function trace($message) {
 
-		$this->log( self::TRACE, $message );
+		$this->log(self::TRACE, $message);
 
 	}
 

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

Indentation +40 added lines, -40 removed lines

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

Spacing +7 added lines, -7 removed lines

@@ -32,7 +32,7 @@ 
 	 *
 	 * @since 3.11.0
 	 */
-	public function __construct( $publisher_service ) {
+	public function __construct($publisher_service) {
 
 		$this->publisher_service = $publisher_service;
 
@@ -50,20 +50,20 @@ 
 		ob_clean();
 
 		// Check if the current user can `manage_options`.
-		if ( ! current_user_can( 'manage_options' ) ) {
-			wp_send_json_error( 'Access denied.' );
+		if ( ! current_user_can('manage_options')) {
+			wp_send_json_error('Access denied.');
 		}
 
 		// No actual search parameter was passed, bail out.
-		if ( ! isset( $_POST['q'] ) || empty( $_POST['q'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			wp_send_json_error( 'The q parameter is required.' );
+		if ( ! isset($_POST['q']) || empty($_POST['q'])) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
+			wp_send_json_error('The q parameter is required.');
 		}
 
 		// Get the response.
-		$response = $this->publisher_service->query( sanitize_text_field( wp_unslash( (string) $_POST['q'] ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Missing
+		$response = $this->publisher_service->query(sanitize_text_field(wp_unslash((string) $_POST['q']))); //phpcs:ignore WordPress.Security.NonceVerification.Missing
 
 		// Finally output the response.
-		wp_send_json_success( $response );
+		wp_send_json_success($response);
 
 	}
 

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);
 
 }