insideout10 / wordlift-plugin

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

Indentation +49 added lines, -49 removed lines

@@ -10,59 +10,59 @@
 
 interface Content_Service {
 
-	/**
-	 * Get an {@link Content} given a URI.
-	 *
-	 * @param string $uri The URI.
-	 *
-	 * @return Content|null The found {@link Content} or null if not found.
-	 * @throws Exception if the URI is absolute and not within the dataset URI scope or the dataset URI isn't set.
-	 */
-	public function get_by_entity_id( $uri );
+    /**
+     * Get an {@link Content} given a URI.
+     *
+     * @param string $uri The URI.
+     *
+     * @return Content|null The found {@link Content} or null if not found.
+     * @throws Exception if the URI is absolute and not within the dataset URI scope or the dataset URI isn't set.
+     */
+    public function get_by_entity_id( $uri );
 
-	/**
-	 * Get an {@link Content} given a URI. The search is performed also in sameAs.
-	 *
-	 * @param string $uri The URI.
-	 *
-	 * @return Content|null The found {@link Content} or null if not found.
-	 */
-	public function get_by_entity_id_or_same_as( $uri );
+    /**
+     * Get an {@link Content} given a URI. The search is performed also in sameAs.
+     *
+     * @param string $uri The URI.
+     *
+     * @return Content|null The found {@link Content} or null if not found.
+     */
+    public function get_by_entity_id_or_same_as( $uri );
 
-	/**
-	 * Get the {@link Content}'s URI given an {@link Content_Id}.
-	 *
-	 * @param Content_Id $content_id An {@link Content_Id}.
-	 *
-	 * @return string|null An absolute URI or null if not found.
-	 */
-	public function get_entity_id( $content_id );
+    /**
+     * Get the {@link Content}'s URI given an {@link Content_Id}.
+     *
+     * @param Content_Id $content_id An {@link Content_Id}.
+     *
+     * @return string|null An absolute URI or null if not found.
+     */
+    public function get_entity_id( $content_id );
 
-	/**
-	 * Set the {@link Content}'s URI for the specified {@link Content_Id}.
-	 *
-	 * @param Content_Id $content_id An {@link Content_Id}.
-	 * @param string     $uri The URI.
-	 *
-	 * @return void
-	 * @throws Exception if the URI is absolute and not within the dataset URI scope or the dataset URI isn't set.
-	 */
-	public function set_entity_id( $content_id, $uri );
+    /**
+     * Set the {@link Content}'s URI for the specified {@link Content_Id}.
+     *
+     * @param Content_Id $content_id An {@link Content_Id}.
+     * @param string     $uri The URI.
+     *
+     * @return void
+     * @throws Exception if the URI is absolute and not within the dataset URI scope or the dataset URI isn't set.
+     */
+    public function set_entity_id( $content_id, $uri );
 
-	/**
-	 * Whether the {@link Content_Service} supports the provided {@link Content_Id}.
-	 *
-	 * @param Content_Id $content_id
-	 *
-	 * @return bool
-	 */
-	public function supports( $content_id );
+    /**
+     * Whether the {@link Content_Service} supports the provided {@link Content_Id}.
+     *
+     * @param Content_Id $content_id
+     *
+     * @return bool
+     */
+    public function supports( $content_id );
 
-	/**
-	 * Delete the content with the specified ID.
-	 *
-	 * @param Content_Id $content_id
-	 */
-	public function delete( $content_id );
+    /**
+     * Delete the content with the specified ID.
+     *
+     * @param Content_Id $content_id
+     */
+    public function delete( $content_id );
 
 }

Spacing +6 added lines, -6 removed lines

@@ -18,7 +18,7 @@ 
 	 * @return Content|null The found {@link Content} or null if not found.
 	 * @throws Exception if the URI is absolute and not within the dataset URI scope or the dataset URI isn't set.
 	 */
-	public function get_by_entity_id( $uri );
+	public function get_by_entity_id($uri);
 
 	/**
 	 * Get an {@link Content} given a URI. The search is performed also in sameAs.
@@ -27,7 +27,7 @@ 
 	 *
 	 * @return Content|null The found {@link Content} or null if not found.
 	 */
-	public function get_by_entity_id_or_same_as( $uri );
+	public function get_by_entity_id_or_same_as($uri);
 
 	/**
 	 * Get the {@link Content}'s URI given an {@link Content_Id}.
@@ -36,7 +36,7 @@ 
 	 *
 	 * @return string|null An absolute URI or null if not found.
 	 */
-	public function get_entity_id( $content_id );
+	public function get_entity_id($content_id);
 
 	/**
 	 * Set the {@link Content}'s URI for the specified {@link Content_Id}.
@@ -47,7 +47,7 @@ 
 	 * @return void
 	 * @throws Exception if the URI is absolute and not within the dataset URI scope or the dataset URI isn't set.
 	 */
-	public function set_entity_id( $content_id, $uri );
+	public function set_entity_id($content_id, $uri);
 
 	/**
 	 * Whether the {@link Content_Service} supports the provided {@link Content_Id}.
@@ -56,13 +56,13 @@ 
 	 *
 	 * @return bool
 	 */
-	public function supports( $content_id );
+	public function supports($content_id);
 
 	/**
 	 * Delete the content with the specified ID.
 	 *
 	 * @param Content_Id $content_id
 	 */
-	public function delete( $content_id );
+	public function delete($content_id);
 
 }

src/wordlift/features/class-features-registry.php

Indentation +50 added lines, -50 removed lines

@@ -4,54 +4,54 @@
 
 class Features_Registry {
 
-	/**
-	 * @var array<Feature>
-	 */
-	private $features = array();
-
-	private static $instance = null;
-
-	public static function get_instance() {
-		if ( null === self::$instance ) {
-			self::$instance = new Features_Registry();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * @param $feature Feature
-	 */
-	public function register_feature( $feature ) {
-		$this->features[] = $feature;
-	}
-
-	/**
-	 * @param $feature_slug string
-	 * @param $default_value bool
-	 * @param $callback callable
-	 */
-	public function register_feature_from_slug( $feature_slug, $default_value, $callback ) {
-		$this->features[] = new Feature(
-			$feature_slug,
-			$default_value,
-			$callback
-		);
-	}
-
-	public function initialize_all_features() {
-		foreach ( $this->features as $feature ) {
-			/**
-			 * @var $feature Feature
-			 */
-			$feature_slug = $feature->feature_slug;
-			if ( apply_filters( "wl_feature__enable__${feature_slug}", $feature->default_value ) ) {
-				call_user_func( $feature->callback );
-			}
-		}
-	}
-
-	public function clear_all() {
-		$this->features = array();
-	}
+    /**
+     * @var array<Feature>
+     */
+    private $features = array();
+
+    private static $instance = null;
+
+    public static function get_instance() {
+        if ( null === self::$instance ) {
+            self::$instance = new Features_Registry();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * @param $feature Feature
+     */
+    public function register_feature( $feature ) {
+        $this->features[] = $feature;
+    }
+
+    /**
+     * @param $feature_slug string
+     * @param $default_value bool
+     * @param $callback callable
+     */
+    public function register_feature_from_slug( $feature_slug, $default_value, $callback ) {
+        $this->features[] = new Feature(
+            $feature_slug,
+            $default_value,
+            $callback
+        );
+    }
+
+    public function initialize_all_features() {
+        foreach ( $this->features as $feature ) {
+            /**
+             * @var $feature Feature
+             */
+            $feature_slug = $feature->feature_slug;
+            if ( apply_filters( "wl_feature__enable__${feature_slug}", $feature->default_value ) ) {
+                call_user_func( $feature->callback );
+            }
+        }
+    }
+
+    public function clear_all() {
+        $this->features = array();
+    }
 }

Spacing +6 added lines, -6 removed lines

@@ -12,7 +12,7 @@ 
 	private static $instance = null;
 
 	public static function get_instance() {
-		if ( null === self::$instance ) {
+		if (null === self::$instance) {
 			self::$instance = new Features_Registry();
 		}
 
@@ -22,7 +22,7 @@ 
 	/**
 	 * @param $feature Feature
 	 */
-	public function register_feature( $feature ) {
+	public function register_feature($feature) {
 		$this->features[] = $feature;
 	}
 
@@ -31,7 +31,7 @@ 
 	 * @param $default_value bool
 	 * @param $callback callable
 	 */
-	public function register_feature_from_slug( $feature_slug, $default_value, $callback ) {
+	public function register_feature_from_slug($feature_slug, $default_value, $callback) {
 		$this->features[] = new Feature(
 			$feature_slug,
 			$default_value,
@@ -40,13 +40,13 @@ 
 	}
 
 	public function initialize_all_features() {
-		foreach ( $this->features as $feature ) {
+		foreach ($this->features as $feature) {
 			/**
 			 * @var $feature Feature
 			 */
 			$feature_slug = $feature->feature_slug;
-			if ( apply_filters( "wl_feature__enable__${feature_slug}", $feature->default_value ) ) {
-				call_user_func( $feature->callback );
+			if (apply_filters("wl_feature__enable__${feature_slug}", $feature->default_value)) {
+				call_user_func($feature->callback);
 			}
 		}
 	}

src/wordlift/features/class-response-adapter.php

Indentation +103 added lines, -103 removed lines

@@ -3,108 +3,108 @@
 namespace Wordlift\Features;
 
 class Response_Adapter {
-	const WL_FEATURES = '_wl_features';
-	const WL_1        = 'wl1';
-
-	public function __construct() {
-
-		// Filter responses from the API calls to update the enabled features.
-		add_filter( 'wl_api_service__response', array( $this, 'response' ), 10, 1 );
-
-		// Initialize from `$_ENV`: this is currently required for Unit Tests, since `tests/bootstrap.php` loads WordLift
-		// before it can actually query the enabled features via HTTP (mock), which would prevent files from being included.
-		// $this->init_from_env();
-
-		// Register the `wl_features__enable__{feature-name}` filters.
-		$this->register_filters();
-
-		// Hook to the updates to the features setting to refresh the features' filters.
-		add_action( 'update_option_' . self::WL_FEATURES, array( $this, 'register_filters' ), 10, 0 );
-
-	}
-
-	public function response( $response ) {
-
-		$headers = wp_remote_retrieve_headers( $response );
-
-		// Bail out if the `wl1` header isn't defined.
-		if ( ! isset( $headers[ self::WL_1 ] ) ) {
-			return $response;
-		}
-		$wl1_as_base64_string = $headers[ self::WL_1 ];
-		// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
-		$wl1 = json_decode( base64_decode( $wl1_as_base64_string ), true );
-
-		$updated_features = $wl1['features'];
-
-		$existing_features = get_option( self::WL_FEATURES, array() );
-
-		// Loop through updated features.
-		foreach ( $updated_features as $feature_slug => $new_value ) {
-
-			// We cant pass false because that indicates if the feature is active or not, null is used to represent the features which are
-			// not set before.
-			$old_value = array_key_exists( $feature_slug, $existing_features ) ? $existing_features[ $feature_slug ] : null;
-
-			if ( $old_value !== $new_value ) {
-				/**
-				 * @param $feature_slug string The feature slug.
-				 * @param $old_value null | boolean Null represents the feature flag was not set before.
-				 * @param $new_value boolean True or false.
-				 *
-				 * @since 3.32.1
-				 * Hook : `wl_feature__change__{feature_slug}`
-				 * Action hook to be fired when there is a change in feature state.
-				 */
-				do_action( "wl_feature__change__${feature_slug}", $new_value, $old_value, $feature_slug );
-			}
-		}
-
-		if ( isset( $updated_features ) ) {
-
-			if ( update_option( self::WL_FEATURES, (array) $updated_features, true ) ) {
-				$this->register_filters();
-			}
-		}
-
-		return $response;
-	}
-
-	/**
-	 * Registers the feature filters.
-	 */
-	public function register_filters() {
-
-		foreach ( (array) get_option( self::WL_FEATURES, array() ) as $name => $enabled ) {
-			// Remove previous filters.
-			remove_filter( "wl_feature__enable__${name}", '__return_true' );
-			remove_filter( "wl_feature__enable__${name}", '__return_false' );
-
-			$callback = ( $enabled ? '__return_true' : '__return_false' );
-			add_filter( "wl_feature__enable__${name}", $callback );
-		}
-
-	}
-
-	private function init_from_env() {
-		$features = array_reduce(
-			array_filter(
-				array_keys( $_ENV ),
-				function ( $key ) {
-					return preg_match( '~^WL_FEATURES__.*~', $key );
-				}
-			),
-			function ( $features, $env ) {
-				$name              = strtolower( str_replace( '_', '-', substr( $env, strlen( 'WL_FEATURES__' ) ) ) );
-				$value             = wp_validate_boolean( getenv( $env ) );
-				$features[ $name ] = $value;
-
-				return $features;
-			},
-			array()
-		);
-
-		update_option( self::WL_FEATURES, (array) $features, true );
-	}
+    const WL_FEATURES = '_wl_features';
+    const WL_1        = 'wl1';
+
+    public function __construct() {
+
+        // Filter responses from the API calls to update the enabled features.
+        add_filter( 'wl_api_service__response', array( $this, 'response' ), 10, 1 );
+
+        // Initialize from `$_ENV`: this is currently required for Unit Tests, since `tests/bootstrap.php` loads WordLift
+        // before it can actually query the enabled features via HTTP (mock), which would prevent files from being included.
+        // $this->init_from_env();
+
+        // Register the `wl_features__enable__{feature-name}` filters.
+        $this->register_filters();
+
+        // Hook to the updates to the features setting to refresh the features' filters.
+        add_action( 'update_option_' . self::WL_FEATURES, array( $this, 'register_filters' ), 10, 0 );
+
+    }
+
+    public function response( $response ) {
+
+        $headers = wp_remote_retrieve_headers( $response );
+
+        // Bail out if the `wl1` header isn't defined.
+        if ( ! isset( $headers[ self::WL_1 ] ) ) {
+            return $response;
+        }
+        $wl1_as_base64_string = $headers[ self::WL_1 ];
+        // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
+        $wl1 = json_decode( base64_decode( $wl1_as_base64_string ), true );
+
+        $updated_features = $wl1['features'];
+
+        $existing_features = get_option( self::WL_FEATURES, array() );
+
+        // Loop through updated features.
+        foreach ( $updated_features as $feature_slug => $new_value ) {
+
+            // We cant pass false because that indicates if the feature is active or not, null is used to represent the features which are
+            // not set before.
+            $old_value = array_key_exists( $feature_slug, $existing_features ) ? $existing_features[ $feature_slug ] : null;
+
+            if ( $old_value !== $new_value ) {
+                /**
+                 * @param $feature_slug string The feature slug.
+                 * @param $old_value null | boolean Null represents the feature flag was not set before.
+                 * @param $new_value boolean True or false.
+                 *
+                 * @since 3.32.1
+                 * Hook : `wl_feature__change__{feature_slug}`
+                 * Action hook to be fired when there is a change in feature state.
+                 */
+                do_action( "wl_feature__change__${feature_slug}", $new_value, $old_value, $feature_slug );
+            }
+        }
+
+        if ( isset( $updated_features ) ) {
+
+            if ( update_option( self::WL_FEATURES, (array) $updated_features, true ) ) {
+                $this->register_filters();
+            }
+        }
+
+        return $response;
+    }
+
+    /**
+     * Registers the feature filters.
+     */
+    public function register_filters() {
+
+        foreach ( (array) get_option( self::WL_FEATURES, array() ) as $name => $enabled ) {
+            // Remove previous filters.
+            remove_filter( "wl_feature__enable__${name}", '__return_true' );
+            remove_filter( "wl_feature__enable__${name}", '__return_false' );
+
+            $callback = ( $enabled ? '__return_true' : '__return_false' );
+            add_filter( "wl_feature__enable__${name}", $callback );
+        }
+
+    }
+
+    private function init_from_env() {
+        $features = array_reduce(
+            array_filter(
+                array_keys( $_ENV ),
+                function ( $key ) {
+                    return preg_match( '~^WL_FEATURES__.*~', $key );
+                }
+            ),
+            function ( $features, $env ) {
+                $name              = strtolower( str_replace( '_', '-', substr( $env, strlen( 'WL_FEATURES__' ) ) ) );
+                $value             = wp_validate_boolean( getenv( $env ) );
+                $features[ $name ] = $value;
+
+                return $features;
+            },
+            array()
+        );
+
+        update_option( self::WL_FEATURES, (array) $features, true );
+    }
 
 }

Spacing +27 added lines, -27 removed lines

@@ -9,7 +9,7 @@ 
 	public function __construct() {
 
 		// Filter responses from the API calls to update the enabled features.
-		add_filter( 'wl_api_service__response', array( $this, 'response' ), 10, 1 );
+		add_filter('wl_api_service__response', array($this, 'response'), 10, 1);
 
 		// Initialize from `$_ENV`: this is currently required for Unit Tests, since `tests/bootstrap.php` loads WordLift
 		// before it can actually query the enabled features via HTTP (mock), which would prevent files from being included.
@@ -19,34 +19,34 @@ 
 		$this->register_filters();
 
 		// Hook to the updates to the features setting to refresh the features' filters.
-		add_action( 'update_option_' . self::WL_FEATURES, array( $this, 'register_filters' ), 10, 0 );
+		add_action('update_option_'.self::WL_FEATURES, array($this, 'register_filters'), 10, 0);
 
 	}
 
-	public function response( $response ) {
+	public function response($response) {
 
-		$headers = wp_remote_retrieve_headers( $response );
+		$headers = wp_remote_retrieve_headers($response);
 
 		// Bail out if the `wl1` header isn't defined.
-		if ( ! isset( $headers[ self::WL_1 ] ) ) {
+		if ( ! isset($headers[self::WL_1])) {
 			return $response;
 		}
-		$wl1_as_base64_string = $headers[ self::WL_1 ];
+		$wl1_as_base64_string = $headers[self::WL_1];
 		// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
-		$wl1 = json_decode( base64_decode( $wl1_as_base64_string ), true );
+		$wl1 = json_decode(base64_decode($wl1_as_base64_string), true);
 
 		$updated_features = $wl1['features'];
 
-		$existing_features = get_option( self::WL_FEATURES, array() );
+		$existing_features = get_option(self::WL_FEATURES, array());
 
 		// Loop through updated features.
-		foreach ( $updated_features as $feature_slug => $new_value ) {
+		foreach ($updated_features as $feature_slug => $new_value) {
 
 			// We cant pass false because that indicates if the feature is active or not, null is used to represent the features which are
 			// not set before.
-			$old_value = array_key_exists( $feature_slug, $existing_features ) ? $existing_features[ $feature_slug ] : null;
+			$old_value = array_key_exists($feature_slug, $existing_features) ? $existing_features[$feature_slug] : null;
 
-			if ( $old_value !== $new_value ) {
+			if ($old_value !== $new_value) {
 				/**
 				 * @param $feature_slug string The feature slug.
 				 * @param $old_value null | boolean Null represents the feature flag was not set before.
@@ -56,13 +56,13 @@ 
 				 * Hook : `wl_feature__change__{feature_slug}`
 				 * Action hook to be fired when there is a change in feature state.
 				 */
-				do_action( "wl_feature__change__${feature_slug}", $new_value, $old_value, $feature_slug );
+				do_action("wl_feature__change__${feature_slug}", $new_value, $old_value, $feature_slug);
 			}
 		}
 
-		if ( isset( $updated_features ) ) {
+		if (isset($updated_features)) {
 
-			if ( update_option( self::WL_FEATURES, (array) $updated_features, true ) ) {
+			if (update_option(self::WL_FEATURES, (array) $updated_features, true)) {
 				$this->register_filters();
 			}
 		}
@@ -75,13 +75,13 @@ 
 	 */
 	public function register_filters() {
 
-		foreach ( (array) get_option( self::WL_FEATURES, array() ) as $name => $enabled ) {
+		foreach ((array) get_option(self::WL_FEATURES, array()) as $name => $enabled) {
 			// Remove previous filters.
-			remove_filter( "wl_feature__enable__${name}", '__return_true' );
-			remove_filter( "wl_feature__enable__${name}", '__return_false' );
+			remove_filter("wl_feature__enable__${name}", '__return_true');
+			remove_filter("wl_feature__enable__${name}", '__return_false');
 
-			$callback = ( $enabled ? '__return_true' : '__return_false' );
-			add_filter( "wl_feature__enable__${name}", $callback );
+			$callback = ($enabled ? '__return_true' : '__return_false');
+			add_filter("wl_feature__enable__${name}", $callback);
 		}
 
 	}
@@ -89,22 +89,22 @@ 
 	private function init_from_env() {
 		$features = array_reduce(
 			array_filter(
-				array_keys( $_ENV ),
-				function ( $key ) {
-					return preg_match( '~^WL_FEATURES__.*~', $key );
+				array_keys($_ENV),
+				function($key) {
+					return preg_match('~^WL_FEATURES__.*~', $key);
 				}
 			),
-			function ( $features, $env ) {
-				$name              = strtolower( str_replace( '_', '-', substr( $env, strlen( 'WL_FEATURES__' ) ) ) );
-				$value             = wp_validate_boolean( getenv( $env ) );
-				$features[ $name ] = $value;
+			function($features, $env) {
+				$name              = strtolower(str_replace('_', '-', substr($env, strlen('WL_FEATURES__'))));
+				$value             = wp_validate_boolean(getenv($env));
+				$features[$name] = $value;
 
 				return $features;
 			},
 			array()
 		);
 
-		update_option( self::WL_FEATURES, (array) $features, true );
+		update_option(self::WL_FEATURES, (array) $features, true);
 	}
 
 }

src/wordlift/term/class-type-service.php

Indentation +83 added lines, -83 removed lines

@@ -17,88 +17,88 @@
  * @package Wordlift\Term
  */
 class Type_Service extends Singleton {
-	/**
-	 * @var \Wordlift_Schema_Service
-	 */
-	private $schema_service;
-
-	public function __construct() {
-		parent::__construct();
-		$this->schema_service = \Wordlift_Schema_Service::get_instance();
-	}
-
-	public function get_entity_types_labels( $term_id ) {
-		$entity_types = $this->get_entity_types( $term_id );
-		return array_map(
-			function ( $entity_type ) {
-				return $entity_type->name;
-			},
-			$entity_types
-		);
-	}
-
-	/**
-	 * Returns the entity types selected for the term.
-	 *
-	 * @param $term_id int
-	 *
-	 * @return \WP_Term[]
-	 */
-	public function get_entity_types( $term_id ) {
-
-		$entity_type_slugs = get_term_meta( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-
-		$types = array_filter(
-			array_map(
-				function ( $type_slug ) {
-					$term = get_term_by( 'slug', $type_slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-					if ( ! $term ) {
-						  return false;
-					}
-
-					return $term;
-				},
-				$entity_type_slugs
-			)
-		);
-
-		$types = array_filter( $types );
-
-		if ( 0 !== count( $types ) ) {
-			return $types;
-		}
-
-		return array( get_term_by( 'slug', 'thing', Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) );
-	}
-
-	/**
-	 * @param $term_id int
-	 *
-	 * @return array|null
-	 */
-	public function get_schema( $term_id ) {
-		$entity_types = $this->get_entity_types( $term_id );
-		foreach ( $entity_types as $entity_type ) {
-			$schema = $this->schema_service->get_schema( $entity_type->slug );
-			if ( ! $schema ) {
-				break;
-			}
-		}
-
-		return $this->schema_service->get_schema( 'thing' );
-	}
-
-	/**
-	 * Removes all the existing entity types and set the entity types for the term.
-	 *
-	 * @param $term_id int
-	 * @param $entity_types array
-	 */
-	public function set_entity_types( $term_id, $entity_types ) {
-		delete_term_meta( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-		foreach ( $entity_types as $entity_type ) {
-			add_term_meta( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $entity_type );
-		}
-	}
+    /**
+     * @var \Wordlift_Schema_Service
+     */
+    private $schema_service;
+
+    public function __construct() {
+        parent::__construct();
+        $this->schema_service = \Wordlift_Schema_Service::get_instance();
+    }
+
+    public function get_entity_types_labels( $term_id ) {
+        $entity_types = $this->get_entity_types( $term_id );
+        return array_map(
+            function ( $entity_type ) {
+                return $entity_type->name;
+            },
+            $entity_types
+        );
+    }
+
+    /**
+     * Returns the entity types selected for the term.
+     *
+     * @param $term_id int
+     *
+     * @return \WP_Term[]
+     */
+    public function get_entity_types( $term_id ) {
+
+        $entity_type_slugs = get_term_meta( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+
+        $types = array_filter(
+            array_map(
+                function ( $type_slug ) {
+                    $term = get_term_by( 'slug', $type_slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+                    if ( ! $term ) {
+                            return false;
+                    }
+
+                    return $term;
+                },
+                $entity_type_slugs
+            )
+        );
+
+        $types = array_filter( $types );
+
+        if ( 0 !== count( $types ) ) {
+            return $types;
+        }
+
+        return array( get_term_by( 'slug', 'thing', Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) );
+    }
+
+    /**
+     * @param $term_id int
+     *
+     * @return array|null
+     */
+    public function get_schema( $term_id ) {
+        $entity_types = $this->get_entity_types( $term_id );
+        foreach ( $entity_types as $entity_type ) {
+            $schema = $this->schema_service->get_schema( $entity_type->slug );
+            if ( ! $schema ) {
+                break;
+            }
+        }
+
+        return $this->schema_service->get_schema( 'thing' );
+    }
+
+    /**
+     * Removes all the existing entity types and set the entity types for the term.
+     *
+     * @param $term_id int
+     * @param $entity_types array
+     */
+    public function set_entity_types( $term_id, $entity_types ) {
+        delete_term_meta( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+        foreach ( $entity_types as $entity_type ) {
+            add_term_meta( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $entity_type );
+        }
+    }
 
 }

Spacing +21 added lines, -21 removed lines

@@ -27,10 +27,10 @@ 
 		$this->schema_service = \Wordlift_Schema_Service::get_instance();
 	}
 
-	public function get_entity_types_labels( $term_id ) {
-		$entity_types = $this->get_entity_types( $term_id );
+	public function get_entity_types_labels($term_id) {
+		$entity_types = $this->get_entity_types($term_id);
 		return array_map(
-			function ( $entity_type ) {
+			function($entity_type) {
 				return $entity_type->name;
 			},
 			$entity_types
@@ -44,15 +44,15 @@ 
 	 *
 	 * @return \WP_Term[]
 	 */
-	public function get_entity_types( $term_id ) {
+	public function get_entity_types($term_id) {
 
-		$entity_type_slugs = get_term_meta( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+		$entity_type_slugs = get_term_meta($term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 
 		$types = array_filter(
 			array_map(
-				function ( $type_slug ) {
-					$term = get_term_by( 'slug', $type_slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-					if ( ! $term ) {
+				function($type_slug) {
+					$term = get_term_by('slug', $type_slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
+					if ( ! $term) {
 						  return false;
 					}
 
@@ -62,13 +62,13 @@ 
 			)
 		);
 
-		$types = array_filter( $types );
+		$types = array_filter($types);
 
-		if ( 0 !== count( $types ) ) {
+		if (0 !== count($types)) {
 			return $types;
 		}
 
-		return array( get_term_by( 'slug', 'thing', Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) );
+		return array(get_term_by('slug', 'thing', Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME));
 	}
 
 	/**
@@ -76,16 +76,16 @@ 
 	 *
 	 * @return array|null
 	 */
-	public function get_schema( $term_id ) {
-		$entity_types = $this->get_entity_types( $term_id );
-		foreach ( $entity_types as $entity_type ) {
-			$schema = $this->schema_service->get_schema( $entity_type->slug );
-			if ( ! $schema ) {
+	public function get_schema($term_id) {
+		$entity_types = $this->get_entity_types($term_id);
+		foreach ($entity_types as $entity_type) {
+			$schema = $this->schema_service->get_schema($entity_type->slug);
+			if ( ! $schema) {
 				break;
 			}
 		}
 
-		return $this->schema_service->get_schema( 'thing' );
+		return $this->schema_service->get_schema('thing');
 	}
 
 	/**
@@ -94,10 +94,10 @@ 
 	 * @param $term_id int
 	 * @param $entity_types array
 	 */
-	public function set_entity_types( $term_id, $entity_types ) {
-		delete_term_meta( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-		foreach ( $entity_types as $entity_type ) {
-			add_term_meta( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $entity_type );
+	public function set_entity_types($term_id, $entity_types) {
+		delete_term_meta($term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
+		foreach ($entity_types as $entity_type) {
+			add_term_meta($term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $entity_type);
 		}
 	}
 

src/wordlift/term/class-synonyms-service.php

Indentation +3 added lines, -3 removed lines

@@ -11,8 +11,8 @@
 
 class Synonyms_Service extends Singleton {
 
-	public function get_synonyms( $term_id ) {
-		return get_term_meta( $term_id, \Wordlift_Entity_Service::ALTERNATIVE_LABEL_META_KEY );
-	}
+    public function get_synonyms( $term_id ) {
+        return get_term_meta( $term_id, \Wordlift_Entity_Service::ALTERNATIVE_LABEL_META_KEY );
+    }
 
 }

Spacing +2 added lines, -2 removed lines

@@ -11,8 +11,8 @@
 
 class Synonyms_Service extends Singleton {
 
-	public function get_synonyms( $term_id ) {
-		return get_term_meta( $term_id, \Wordlift_Entity_Service::ALTERNATIVE_LABEL_META_KEY );
+	public function get_synonyms($term_id) {
+		return get_term_meta($term_id, \Wordlift_Entity_Service::ALTERNATIVE_LABEL_META_KEY);
 	}
 
 }

src/wordlift/post/class-post-adapter.php

Indentation +373 added lines, -373 removed lines

@@ -20,378 +20,378 @@
 
 class Post_Adapter {
 
-	/**
-	 * A {@link Wordlift_Log_Service} logging instance.
-	 *
-	 * @access private
-	 * @var \Wordlift_Log_Service A {@link Wordlift_Log_Service} logging instance.
-	 */
-	private $log;
-
-	public function __construct() {
-
-		// Bail out if block editor's functions aren't available.
-		if ( ! function_exists( 'register_block_type' ) || ! function_exists( 'parse_blocks' ) ) {
-			return;
-		}
-
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
-
-		add_action( 'init', array( $this, 'init' ) );
-		add_filter( 'wp_insert_post_data', array( $this, 'wp_insert_post_data' ), 10 );
-
-	}
-
-	/**
-	 * Initialize by registering our block type `wordlift/classification`, required for {@link parse_blocks) to work
-	 * correctly.
-	 */
-	public function init() {
-
-		register_block_type(
-			'wordlift/classification',
-			array(
-				'editor_script' => 'wl-block-editor',
-				'attributes'    => array(
-					'entities' => array( 'type' => 'array' ),
-				),
-			)
-		);
-
-	}
-
-	/**
-	 * A sample structure:
-	 *
-	 * {
-	 *   "entities": [
-	 *     {
-	 *       "annotations": {
-	 *         "urn:enhancement-7e8e66fc": {
-	 *           "start": 3480,
-	 *           "end": 3486,
-	 *           "text": "libero"
-	 *         }
-	 *       },
-	 *       "description": "Le libero ou libéro est un poste défensif du volley-ball. Des règles particulières le concernant ont été introduites à la fin des années 1990. De par sa spécificité, le libéro a un statut à part au sein d’une équipe de volley-ball. Pour être identifié, il doit porter un uniforme qui contraste avec ceux des autres membres de son équipe, titulaires ou remplaçants.",
-	 *       "id": "http://fr.dbpedia.org/resource/Libero_(volley-ball)",
-	 *       "label": "Libero (volley-ball)",
-	 *       "mainType": "other",
-	 *       "occurrences": ["urn:enhancement-7e8e66fc"],
-	 *       "sameAs": null,
-	 *       "synonyms": [],
-	 *       "types": ["other"]
-	 *     }
-	 *   ]
-	 * }
-	 *
-	 * @param array $data An array of slashed post data.
-	 *
-	 * @return array The data array.
-	 */
-	public function wp_insert_post_data( $data ) {
-		$post_status = $data['post_status'];
-		if ( 'auto-draft' === $post_status || 'inherit' === $post_status ) {
-			return $data;
-		}
-
-		try {
-			$entities = $this->parse_content( wp_unslash( $data['post_content'] ) );
-
-			foreach ( $entities as $entity ) {
-
-				$entity_id = array_key_exists( 'id', $entity ) ? $entity['id'] : '';
-
-				if ( ! $this->entity_id_valid( $entity_id ) ) {
-					continue;
-				}
-
-				$entity_uris = $this->get_entity_uris( $entity );
-
-				if ( $this->get_first_matching_entity_by_uri( $entity_uris ) === null &&
-					 Post_Entities_Validator::is_local_entity_uri_exist( Wordlift_Entity_Uri_Service::get_instance(), $entity_uris ) ) {
-					// Skip the entity
-					continue;
-				}
-
-				// If 'entity auto publish' is false, we set the status to `draft` by default.
-				// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-				$post_status = apply_filters( 'wl_feature__enable__entity-auto-publish', true )
-					? $data['post_status'] : 'draft';
-				$this->create_or_update_entity( $entity, $post_status );
-
-			}
-		} catch ( \Exception $e ) {
-			$this->log->error( $e->getMessage() );
-		}
-
-		return $data;
-	}
-
-	/**
-	 * Parse the post content to find the `wordlift/classification` block and return the entities' data.
-	 *
-	 * @param string $post_content The post content.
-	 *
-	 * @return array An array of entities' structures.
-	 * @throws \Exception when an error occurs.
-	 */
-	private function parse_content( $post_content ) {
-
-		$all_blocks = parse_blocks( $post_content );
-
-		$blocks = array_filter(
-			$all_blocks,
-			function ( $item ) {
-				return ! empty( $item['blockName'] ) && 'wordlift/classification' === $item['blockName'];
-			}
-		);
-
-		// Bail out if the blocks' array is empty.
-		if ( empty( $blocks ) ) {
-			return array();
-		}
-
-		$block = current( $blocks );
-
-		// Bail out if the entities array is empty.
-		if ( empty( $block['attrs'] ) && empty( $block['attrs']['entities'] ) ) {
-			return array();
-		}
-
-		return $block['attrs']['entities'];
-	}
-
-	/**
-	 * Collect entity labels from the entity array.
-	 *
-	 * This function expects an array with the following keys:
-	 *
-	 * array(
-	 *   'label'       => ...,
-	 *   'synonyms'    => array( ... ),
-	 *   'annotations' => array(
-	 *     ...id...      => array( text => ... ),
-	 *   ),
-	 *   'occurrences' => array( ... ),
-	 * )
-	 *
-	 * and it is going to output an array with all the labels, keeping the `label` at first position:
-	 *
-	 * array(
-	 *   ...label...,
-	 *   ...synonyms...,
-	 *   ...texts...,
-	 * )
-	 *
-	 * This function is going to collect the label from the `label` property, from the `synonyms` property and from
-	 * `annotations` property. Since the `annotations` property contains all the annotations including those that
-	 * haven't been selected, this function is going to only get the `text` for the annotations property listed in
-	 * `occurrences`.
-	 *
-	 * @param array $entity {
-	 *  The entity data.
-	 *
-	 * @type string $label The entity label.
-	 * @type array $synonyms The entity synonyms.
-	 * @type array $occurrences The selected occurrences.
-	 * @type array $annotations The annotations.
-	 * }
-	 *
-	 * @return array An array of labels.
-	 */
-	public function get_labels( $entity ) {
-
-		$args = wp_parse_args(
-			$entity,
-			array(
-				'label'       => array(),
-				'synonyms'    => array(),
-				'annotations' => array(),
-				'occurrences' => array(),
-			)
-		);
-
-		// We gather all the labels, occurrences texts and synonyms into one array.
-		$initial = array_merge(
-			(array) $args['label'],
-			(array) $args['synonyms']
-		);
-
-		$annotations = $args['annotations'];
-
-		return array_reduce(
-			$args['occurrences'],
-			function ( $carry, $item ) use ( $annotations ) {
-
-				// Bail out if occurrences->$item->text isn't set or its contents are already
-				// in `$carry`.
-				if ( ! isset( $annotations[ $item ]['text'] )
-				 || in_array( $annotations[ $item ]['text'], $carry, true ) ) {
-					return $carry;
-				}
-
-				// Push the label.
-				$carry[] = $annotations[ $item ]['text'];
-
-				return $carry;
-			},
-			$initial
-		);
-	}
-
-	/**
-	 * Create or update the entity.
-	 *
-	 * An entity lookup is performed on the local vocabulary using the `id` and `sameAs` URIs. If an entity is found
-	 * the {@link Entity_Store} update function is called to update the `labels` and the `sameAs` values.
-	 *
-	 * If an entity is not found the {@link Entity_Store} create function is called to create a new entity.
-	 *
-	 * @param array  $entity {
-	 *  The entity parameters.
-	 *
-	 * @type string The entity item id URI.
-	 * @type string|array The entity sameAs URI(s).
-	 * @type string $description The entity description.
-	 * }
-	 *
-	 * @param       $string $post_status The post status, default 'draft'.
-	 *
-	 * @return int|\WP_Error
-	 * @throws \Exception when an error occurs.
-	 */
-	private function create_or_update_entity( $entity, $post_status = 'draft' ) {
-
-		// Get only valid IDs.
-		$uris = $this->get_entity_uris( $entity );
-
-		$post = $this->get_first_matching_entity_by_uri( $uris );
-
-		// Get the labels.
-		$labels = $this->get_labels( $entity );
-
-		if ( empty( $post ) ) {
-			$entity_description = array_key_exists( 'description', $entity ) ? $entity['description'] : '';
-			// Create the entity if it doesn't exist.
-			$post_id = Entity_Store::get_instance()->create(
-				array(
-					'labels'      => $labels,
-					'description' => $entity_description,
-					'same_as'     => $uris,
-				),
-				$post_status
-			);
-
-			// Return the WP_Error if we got one.
-			if ( is_wp_error( $post_id ) ) {
-				return $post_id;
-			}
-
-			// Add the entity type.
-			if ( isset( $entity['mainType'] ) ) {
-				wp_set_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-			}
-
-			if ( isset( $entity['properties'] ) && isset( $entity['properties']['latitude'] ) && isset( $entity['properties']['longitude'] ) ) {
-				add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LATITUDE, $entity['properties']['latitude'] );
-				add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LONGITUDE, $entity['properties']['longitude'] );
-			}
-		} else {
-			// Update the entity otherwise.
-			$post_id = Entity_Store::get_instance()->update(
-				array(
-					'ID'      => $post->ID,
-					'labels'  => $labels,
-					'same_as' => $uris,
-				)
-			);
-
-			// Add the entity type.
-			if ( isset( $entity['mainType'] ) ) {
-				wp_add_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-			}
-
-			// see https://github.com/insideout10/wordlift-plugin/issues/1304
-			// Set the post status, we need to set that in order to support entities
-			// created using rest endpoint on block editor, so that they get published
-			// when the post is published.
-			// Once the entity is published don't update the post status.
-			if ( 'publish' !== $post->post_status ) {
-				wp_update_post(
-					array(
-						'ID'          => $post->ID,
-						'post_status' => $post_status,
-					)
-				);
-			}
-		}
-
-		return $post_id;
-	}
-
-	/**
-	 * Get the first matching entity for the provided URI array.
-	 *
-	 * Entities IDs and sameAs are searched.
-	 *
-	 * @param array $uris An array of URIs.
-	 *
-	 * @return \WP_Post|null The entity WP_Post if found or null if not found.
-	 */
-	private function get_first_matching_entity_by_uri( $uris ) {
-
-		foreach ( $uris as $uri ) {
-
-			$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
-
-			if ( ! $content ) {
-				continue;
-			}
-
-			$existing_entity = $content->get_bag();
-
-			if ( is_a( $existing_entity, 'WP_Post' ) ) {
-				return $existing_entity;
-			}
-		}
-
-		return null;
-	}
-
-	/**
-	 * @param $entity
-	 *
-	 * @return array
-	 */
-	private function filter_valid_entity_ids( $entity ) {
-		$id = $entity['id'];
-
-		return array_filter(
-			(array) $id,
-			function ( $id ) {
-				return preg_match( '|^https?://|', $id );
-			}
-		);
-	}
-
-	/**
-	 * @param array $entity
-	 *
-	 * @return array
-	 */
-	private function get_entity_uris( $entity ) {
-		$ids     = $this->filter_valid_entity_ids( $entity );
-		$same_as = array_key_exists( 'sameAs', $entity ) ? $entity['sameAs'] : array();
-
-		return array_merge(
-			(array) $ids,
-			(array) $same_as
-		);
-	}
-
-	private function entity_id_valid( $entity_id ) {
-		return preg_match( '#^https?://#i', $entity_id ) === 1;
-	}
+    /**
+     * A {@link Wordlift_Log_Service} logging instance.
+     *
+     * @access private
+     * @var \Wordlift_Log_Service A {@link Wordlift_Log_Service} logging instance.
+     */
+    private $log;
+
+    public function __construct() {
+
+        // Bail out if block editor's functions aren't available.
+        if ( ! function_exists( 'register_block_type' ) || ! function_exists( 'parse_blocks' ) ) {
+            return;
+        }
+
+        $this->log = \Wordlift_Log_Service::get_logger( get_class() );
+
+        add_action( 'init', array( $this, 'init' ) );
+        add_filter( 'wp_insert_post_data', array( $this, 'wp_insert_post_data' ), 10 );
+
+    }
+
+    /**
+     * Initialize by registering our block type `wordlift/classification`, required for {@link parse_blocks) to work
+     * correctly.
+     */
+    public function init() {
+
+        register_block_type(
+            'wordlift/classification',
+            array(
+                'editor_script' => 'wl-block-editor',
+                'attributes'    => array(
+                    'entities' => array( 'type' => 'array' ),
+                ),
+            )
+        );
+
+    }
+
+    /**
+     * A sample structure:
+     *
+     * {
+     *   "entities": [
+     *     {
+     *       "annotations": {
+     *         "urn:enhancement-7e8e66fc": {
+     *           "start": 3480,
+     *           "end": 3486,
+     *           "text": "libero"
+     *         }
+     *       },
+     *       "description": "Le libero ou libéro est un poste défensif du volley-ball. Des règles particulières le concernant ont été introduites à la fin des années 1990. De par sa spécificité, le libéro a un statut à part au sein d’une équipe de volley-ball. Pour être identifié, il doit porter un uniforme qui contraste avec ceux des autres membres de son équipe, titulaires ou remplaçants.",
+     *       "id": "http://fr.dbpedia.org/resource/Libero_(volley-ball)",
+     *       "label": "Libero (volley-ball)",
+     *       "mainType": "other",
+     *       "occurrences": ["urn:enhancement-7e8e66fc"],
+     *       "sameAs": null,
+     *       "synonyms": [],
+     *       "types": ["other"]
+     *     }
+     *   ]
+     * }
+     *
+     * @param array $data An array of slashed post data.
+     *
+     * @return array The data array.
+     */
+    public function wp_insert_post_data( $data ) {
+        $post_status = $data['post_status'];
+        if ( 'auto-draft' === $post_status || 'inherit' === $post_status ) {
+            return $data;
+        }
+
+        try {
+            $entities = $this->parse_content( wp_unslash( $data['post_content'] ) );
+
+            foreach ( $entities as $entity ) {
+
+                $entity_id = array_key_exists( 'id', $entity ) ? $entity['id'] : '';
+
+                if ( ! $this->entity_id_valid( $entity_id ) ) {
+                    continue;
+                }
+
+                $entity_uris = $this->get_entity_uris( $entity );
+
+                if ( $this->get_first_matching_entity_by_uri( $entity_uris ) === null &&
+                     Post_Entities_Validator::is_local_entity_uri_exist( Wordlift_Entity_Uri_Service::get_instance(), $entity_uris ) ) {
+                    // Skip the entity
+                    continue;
+                }
+
+                // If 'entity auto publish' is false, we set the status to `draft` by default.
+                // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+                $post_status = apply_filters( 'wl_feature__enable__entity-auto-publish', true )
+                    ? $data['post_status'] : 'draft';
+                $this->create_or_update_entity( $entity, $post_status );
+
+            }
+        } catch ( \Exception $e ) {
+            $this->log->error( $e->getMessage() );
+        }
+
+        return $data;
+    }
+
+    /**
+     * Parse the post content to find the `wordlift/classification` block and return the entities' data.
+     *
+     * @param string $post_content The post content.
+     *
+     * @return array An array of entities' structures.
+     * @throws \Exception when an error occurs.
+     */
+    private function parse_content( $post_content ) {
+
+        $all_blocks = parse_blocks( $post_content );
+
+        $blocks = array_filter(
+            $all_blocks,
+            function ( $item ) {
+                return ! empty( $item['blockName'] ) && 'wordlift/classification' === $item['blockName'];
+            }
+        );
+
+        // Bail out if the blocks' array is empty.
+        if ( empty( $blocks ) ) {
+            return array();
+        }
+
+        $block = current( $blocks );
+
+        // Bail out if the entities array is empty.
+        if ( empty( $block['attrs'] ) && empty( $block['attrs']['entities'] ) ) {
+            return array();
+        }
+
+        return $block['attrs']['entities'];
+    }
+
+    /**
+     * Collect entity labels from the entity array.
+     *
+     * This function expects an array with the following keys:
+     *
+     * array(
+     *   'label'       => ...,
+     *   'synonyms'    => array( ... ),
+     *   'annotations' => array(
+     *     ...id...      => array( text => ... ),
+     *   ),
+     *   'occurrences' => array( ... ),
+     * )
+     *
+     * and it is going to output an array with all the labels, keeping the `label` at first position:
+     *
+     * array(
+     *   ...label...,
+     *   ...synonyms...,
+     *   ...texts...,
+     * )
+     *
+     * This function is going to collect the label from the `label` property, from the `synonyms` property and from
+     * `annotations` property. Since the `annotations` property contains all the annotations including those that
+     * haven't been selected, this function is going to only get the `text` for the annotations property listed in
+     * `occurrences`.
+     *
+     * @param array $entity {
+     *  The entity data.
+     *
+     * @type string $label The entity label.
+     * @type array $synonyms The entity synonyms.
+     * @type array $occurrences The selected occurrences.
+     * @type array $annotations The annotations.
+     * }
+     *
+     * @return array An array of labels.
+     */
+    public function get_labels( $entity ) {
+
+        $args = wp_parse_args(
+            $entity,
+            array(
+                'label'       => array(),
+                'synonyms'    => array(),
+                'annotations' => array(),
+                'occurrences' => array(),
+            )
+        );
+
+        // We gather all the labels, occurrences texts and synonyms into one array.
+        $initial = array_merge(
+            (array) $args['label'],
+            (array) $args['synonyms']
+        );
+
+        $annotations = $args['annotations'];
+
+        return array_reduce(
+            $args['occurrences'],
+            function ( $carry, $item ) use ( $annotations ) {
+
+                // Bail out if occurrences->$item->text isn't set or its contents are already
+                // in `$carry`.
+                if ( ! isset( $annotations[ $item ]['text'] )
+                 || in_array( $annotations[ $item ]['text'], $carry, true ) ) {
+                    return $carry;
+                }
+
+                // Push the label.
+                $carry[] = $annotations[ $item ]['text'];
+
+                return $carry;
+            },
+            $initial
+        );
+    }
+
+    /**
+     * Create or update the entity.
+     *
+     * An entity lookup is performed on the local vocabulary using the `id` and `sameAs` URIs. If an entity is found
+     * the {@link Entity_Store} update function is called to update the `labels` and the `sameAs` values.
+     *
+     * If an entity is not found the {@link Entity_Store} create function is called to create a new entity.
+     *
+     * @param array  $entity {
+     *  The entity parameters.
+     *
+     * @type string The entity item id URI.
+     * @type string|array The entity sameAs URI(s).
+     * @type string $description The entity description.
+     * }
+     *
+     * @param       $string $post_status The post status, default 'draft'.
+     *
+     * @return int|\WP_Error
+     * @throws \Exception when an error occurs.
+     */
+    private function create_or_update_entity( $entity, $post_status = 'draft' ) {
+
+        // Get only valid IDs.
+        $uris = $this->get_entity_uris( $entity );
+
+        $post = $this->get_first_matching_entity_by_uri( $uris );
+
+        // Get the labels.
+        $labels = $this->get_labels( $entity );
+
+        if ( empty( $post ) ) {
+            $entity_description = array_key_exists( 'description', $entity ) ? $entity['description'] : '';
+            // Create the entity if it doesn't exist.
+            $post_id = Entity_Store::get_instance()->create(
+                array(
+                    'labels'      => $labels,
+                    'description' => $entity_description,
+                    'same_as'     => $uris,
+                ),
+                $post_status
+            );
+
+            // Return the WP_Error if we got one.
+            if ( is_wp_error( $post_id ) ) {
+                return $post_id;
+            }
+
+            // Add the entity type.
+            if ( isset( $entity['mainType'] ) ) {
+                wp_set_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+            }
+
+            if ( isset( $entity['properties'] ) && isset( $entity['properties']['latitude'] ) && isset( $entity['properties']['longitude'] ) ) {
+                add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LATITUDE, $entity['properties']['latitude'] );
+                add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LONGITUDE, $entity['properties']['longitude'] );
+            }
+        } else {
+            // Update the entity otherwise.
+            $post_id = Entity_Store::get_instance()->update(
+                array(
+                    'ID'      => $post->ID,
+                    'labels'  => $labels,
+                    'same_as' => $uris,
+                )
+            );
+
+            // Add the entity type.
+            if ( isset( $entity['mainType'] ) ) {
+                wp_add_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+            }
+
+            // see https://github.com/insideout10/wordlift-plugin/issues/1304
+            // Set the post status, we need to set that in order to support entities
+            // created using rest endpoint on block editor, so that they get published
+            // when the post is published.
+            // Once the entity is published don't update the post status.
+            if ( 'publish' !== $post->post_status ) {
+                wp_update_post(
+                    array(
+                        'ID'          => $post->ID,
+                        'post_status' => $post_status,
+                    )
+                );
+            }
+        }
+
+        return $post_id;
+    }
+
+    /**
+     * Get the first matching entity for the provided URI array.
+     *
+     * Entities IDs and sameAs are searched.
+     *
+     * @param array $uris An array of URIs.
+     *
+     * @return \WP_Post|null The entity WP_Post if found or null if not found.
+     */
+    private function get_first_matching_entity_by_uri( $uris ) {
+
+        foreach ( $uris as $uri ) {
+
+            $content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
+
+            if ( ! $content ) {
+                continue;
+            }
+
+            $existing_entity = $content->get_bag();
+
+            if ( is_a( $existing_entity, 'WP_Post' ) ) {
+                return $existing_entity;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @param $entity
+     *
+     * @return array
+     */
+    private function filter_valid_entity_ids( $entity ) {
+        $id = $entity['id'];
+
+        return array_filter(
+            (array) $id,
+            function ( $id ) {
+                return preg_match( '|^https?://|', $id );
+            }
+        );
+    }
+
+    /**
+     * @param array $entity
+     *
+     * @return array
+     */
+    private function get_entity_uris( $entity ) {
+        $ids     = $this->filter_valid_entity_ids( $entity );
+        $same_as = array_key_exists( 'sameAs', $entity ) ? $entity['sameAs'] : array();
+
+        return array_merge(
+            (array) $ids,
+            (array) $same_as
+        );
+    }
+
+    private function entity_id_valid( $entity_id ) {
+        return preg_match( '#^https?://#i', $entity_id ) === 1;
+    }
 
 }

Spacing +58 added lines, -58 removed lines

@@ -31,14 +31,14 @@ 
 	public function __construct() {
 
 		// Bail out if block editor's functions aren't available.
-		if ( ! function_exists( 'register_block_type' ) || ! function_exists( 'parse_blocks' ) ) {
+		if ( ! function_exists('register_block_type') || ! function_exists('parse_blocks')) {
 			return;
 		}
 
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = \Wordlift_Log_Service::get_logger(get_class());
 
-		add_action( 'init', array( $this, 'init' ) );
-		add_filter( 'wp_insert_post_data', array( $this, 'wp_insert_post_data' ), 10 );
+		add_action('init', array($this, 'init'));
+		add_filter('wp_insert_post_data', array($this, 'wp_insert_post_data'), 10);
 
 	}
 
@@ -53,7 +53,7 @@ 
 			array(
 				'editor_script' => 'wl-block-editor',
 				'attributes'    => array(
-					'entities' => array( 'type' => 'array' ),
+					'entities' => array('type' => 'array'),
 				),
 			)
 		);
@@ -89,40 +89,40 @@ 
 	 *
 	 * @return array The data array.
 	 */
-	public function wp_insert_post_data( $data ) {
+	public function wp_insert_post_data($data) {
 		$post_status = $data['post_status'];
-		if ( 'auto-draft' === $post_status || 'inherit' === $post_status ) {
+		if ('auto-draft' === $post_status || 'inherit' === $post_status) {
 			return $data;
 		}
 
 		try {
-			$entities = $this->parse_content( wp_unslash( $data['post_content'] ) );
+			$entities = $this->parse_content(wp_unslash($data['post_content']));
 
-			foreach ( $entities as $entity ) {
+			foreach ($entities as $entity) {
 
-				$entity_id = array_key_exists( 'id', $entity ) ? $entity['id'] : '';
+				$entity_id = array_key_exists('id', $entity) ? $entity['id'] : '';
 
-				if ( ! $this->entity_id_valid( $entity_id ) ) {
+				if ( ! $this->entity_id_valid($entity_id)) {
 					continue;
 				}
 
-				$entity_uris = $this->get_entity_uris( $entity );
+				$entity_uris = $this->get_entity_uris($entity);
 
-				if ( $this->get_first_matching_entity_by_uri( $entity_uris ) === null &&
-					 Post_Entities_Validator::is_local_entity_uri_exist( Wordlift_Entity_Uri_Service::get_instance(), $entity_uris ) ) {
+				if ($this->get_first_matching_entity_by_uri($entity_uris) === null &&
+					 Post_Entities_Validator::is_local_entity_uri_exist(Wordlift_Entity_Uri_Service::get_instance(), $entity_uris)) {
 					// Skip the entity
 					continue;
 				}
 
 				// If 'entity auto publish' is false, we set the status to `draft` by default.
 				// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-				$post_status = apply_filters( 'wl_feature__enable__entity-auto-publish', true )
+				$post_status = apply_filters('wl_feature__enable__entity-auto-publish', true)
 					? $data['post_status'] : 'draft';
-				$this->create_or_update_entity( $entity, $post_status );
+				$this->create_or_update_entity($entity, $post_status);
 
 			}
-		} catch ( \Exception $e ) {
-			$this->log->error( $e->getMessage() );
+		} catch (\Exception $e) {
+			$this->log->error($e->getMessage());
 		}
 
 		return $data;
@@ -136,26 +136,26 @@ 
 	 * @return array An array of entities' structures.
 	 * @throws \Exception when an error occurs.
 	 */
-	private function parse_content( $post_content ) {
+	private function parse_content($post_content) {
 
-		$all_blocks = parse_blocks( $post_content );
+		$all_blocks = parse_blocks($post_content);
 
 		$blocks = array_filter(
 			$all_blocks,
-			function ( $item ) {
-				return ! empty( $item['blockName'] ) && 'wordlift/classification' === $item['blockName'];
+			function($item) {
+				return ! empty($item['blockName']) && 'wordlift/classification' === $item['blockName'];
 			}
 		);
 
 		// Bail out if the blocks' array is empty.
-		if ( empty( $blocks ) ) {
+		if (empty($blocks)) {
 			return array();
 		}
 
-		$block = current( $blocks );
+		$block = current($blocks);
 
 		// Bail out if the entities array is empty.
-		if ( empty( $block['attrs'] ) && empty( $block['attrs']['entities'] ) ) {
+		if (empty($block['attrs']) && empty($block['attrs']['entities'])) {
 			return array();
 		}
 
@@ -200,7 +200,7 @@ 
 	 *
 	 * @return array An array of labels.
 	 */
-	public function get_labels( $entity ) {
+	public function get_labels($entity) {
 
 		$args = wp_parse_args(
 			$entity,
@@ -222,17 +222,17 @@ 
 
 		return array_reduce(
 			$args['occurrences'],
-			function ( $carry, $item ) use ( $annotations ) {
+			function($carry, $item) use ($annotations) {
 
 				// Bail out if occurrences->$item->text isn't set or its contents are already
 				// in `$carry`.
-				if ( ! isset( $annotations[ $item ]['text'] )
-				 || in_array( $annotations[ $item ]['text'], $carry, true ) ) {
+				if ( ! isset($annotations[$item]['text'])
+				 || in_array($annotations[$item]['text'], $carry, true)) {
 					return $carry;
 				}
 
 				// Push the label.
-				$carry[] = $annotations[ $item ]['text'];
+				$carry[] = $annotations[$item]['text'];
 
 				return $carry;
 			},
@@ -261,18 +261,18 @@ 
 	 * @return int|\WP_Error
 	 * @throws \Exception when an error occurs.
 	 */
-	private function create_or_update_entity( $entity, $post_status = 'draft' ) {
+	private function create_or_update_entity($entity, $post_status = 'draft') {
 
 		// Get only valid IDs.
-		$uris = $this->get_entity_uris( $entity );
+		$uris = $this->get_entity_uris($entity);
 
-		$post = $this->get_first_matching_entity_by_uri( $uris );
+		$post = $this->get_first_matching_entity_by_uri($uris);
 
 		// Get the labels.
-		$labels = $this->get_labels( $entity );
+		$labels = $this->get_labels($entity);
 
-		if ( empty( $post ) ) {
-			$entity_description = array_key_exists( 'description', $entity ) ? $entity['description'] : '';
+		if (empty($post)) {
+			$entity_description = array_key_exists('description', $entity) ? $entity['description'] : '';
 			// Create the entity if it doesn't exist.
 			$post_id = Entity_Store::get_instance()->create(
 				array(
@@ -284,18 +284,18 @@ 
 			);
 
 			// Return the WP_Error if we got one.
-			if ( is_wp_error( $post_id ) ) {
+			if (is_wp_error($post_id)) {
 				return $post_id;
 			}
 
 			// Add the entity type.
-			if ( isset( $entity['mainType'] ) ) {
-				wp_set_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+			if (isset($entity['mainType'])) {
+				wp_set_object_terms($post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 			}
 
-			if ( isset( $entity['properties'] ) && isset( $entity['properties']['latitude'] ) && isset( $entity['properties']['longitude'] ) ) {
-				add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LATITUDE, $entity['properties']['latitude'] );
-				add_post_meta( $post_id, \Wordlift_Schema_Service::FIELD_GEO_LONGITUDE, $entity['properties']['longitude'] );
+			if (isset($entity['properties']) && isset($entity['properties']['latitude']) && isset($entity['properties']['longitude'])) {
+				add_post_meta($post_id, \Wordlift_Schema_Service::FIELD_GEO_LATITUDE, $entity['properties']['latitude']);
+				add_post_meta($post_id, \Wordlift_Schema_Service::FIELD_GEO_LONGITUDE, $entity['properties']['longitude']);
 			}
 		} else {
 			// Update the entity otherwise.
@@ -308,8 +308,8 @@ 
 			);
 
 			// Add the entity type.
-			if ( isset( $entity['mainType'] ) ) {
-				wp_add_object_terms( $post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+			if (isset($entity['mainType'])) {
+				wp_add_object_terms($post_id, $entity['mainType'], \Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 			}
 
 			// see https://github.com/insideout10/wordlift-plugin/issues/1304
@@ -317,7 +317,7 @@ 
 			// created using rest endpoint on block editor, so that they get published
 			// when the post is published.
 			// Once the entity is published don't update the post status.
-			if ( 'publish' !== $post->post_status ) {
+			if ('publish' !== $post->post_status) {
 				wp_update_post(
 					array(
 						'ID'          => $post->ID,
@@ -339,19 +339,19 @@ 
 	 *
 	 * @return \WP_Post|null The entity WP_Post if found or null if not found.
 	 */
-	private function get_first_matching_entity_by_uri( $uris ) {
+	private function get_first_matching_entity_by_uri($uris) {
 
-		foreach ( $uris as $uri ) {
+		foreach ($uris as $uri) {
 
-			$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
+			$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as($uri);
 
-			if ( ! $content ) {
+			if ( ! $content) {
 				continue;
 			}
 
 			$existing_entity = $content->get_bag();
 
-			if ( is_a( $existing_entity, 'WP_Post' ) ) {
+			if (is_a($existing_entity, 'WP_Post')) {
 				return $existing_entity;
 			}
 		}
@@ -364,13 +364,13 @@ 
 	 *
 	 * @return array
 	 */
-	private function filter_valid_entity_ids( $entity ) {
+	private function filter_valid_entity_ids($entity) {
 		$id = $entity['id'];
 
 		return array_filter(
 			(array) $id,
-			function ( $id ) {
-				return preg_match( '|^https?://|', $id );
+			function($id) {
+				return preg_match('|^https?://|', $id);
 			}
 		);
 	}
@@ -380,9 +380,9 @@ 
 	 *
 	 * @return array
 	 */
-	private function get_entity_uris( $entity ) {
-		$ids     = $this->filter_valid_entity_ids( $entity );
-		$same_as = array_key_exists( 'sameAs', $entity ) ? $entity['sameAs'] : array();
+	private function get_entity_uris($entity) {
+		$ids     = $this->filter_valid_entity_ids($entity);
+		$same_as = array_key_exists('sameAs', $entity) ? $entity['sameAs'] : array();
 
 		return array_merge(
 			(array) $ids,
@@ -390,8 +390,8 @@ 
 		);
 	}
 
-	private function entity_id_valid( $entity_id ) {
-		return preg_match( '#^https?://#i', $entity_id ) === 1;
+	private function entity_id_valid($entity_id) {
+		return preg_match('#^https?://#i', $entity_id) === 1;
 	}
 
 }

src/wordlift/cache/class-ttl-cache.php

Indentation +163 added lines, -163 removed lines

@@ -17,183 +17,183 @@
 // @@todo: add a hook to clear the cached files now and then.
 class Ttl_Cache {
 
-	/**
-	 * The cache name.
-	 *
-	 * @var string $name The cache name.
-	 * @access private
-	 * @since 3.21.2
-	 */
-	private $name;
-
-	/**
-	 * The TTL of cached responses in seconds.
-	 *
-	 * @var int $ttl The TTL in seconds.
-	 * @access private
-	 * @since 3.21.2
-	 */
-	private $ttl;
-
-	/**
-	 * The cache dir where the cached data is written.
-	 *
-	 * @since 3.21.2
-	 * @access private
-	 * @var string $cache_dir The cache dir where the cached responses are written.
-	 */
-	private $cache_dir;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 * @access private
-	 * @since 3.21.2
-	 */
-	private $log;
-
-	/**
-	 * @var array
-	 */
-	private static $caches = array();
-
-	/**
-	 * Create a {@link Ttl_Cache} with the specified TTL, default 900 secs.
-	 *
-	 * @param string $name The cache name.
-	 * @param int    $ttl The cache TTL, default 900 secs.
-	 *
-	 * @since 3.21.2
-	 */
-	public function __construct( $name, $ttl = 900 ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->name = $name;
-		$this->ttl  = $ttl;
-
-		$this->cache_dir = self::get_cache_folder() . DIRECTORY_SEPARATOR . md5( $name );
-
-		$this->log->trace( "Creating the cache folder {$this->cache_dir}..." );
-		wp_mkdir_p( $this->cache_dir );
-
-		self::$caches[ $name ] = $this;
-
-	}
-
-	/**
-	 * Get the root cache folder.
-	 *
-	 * This is useful to introduce a cache cleaning procedure which will scan and delete older stale cache files.
-	 *
-	 * @return string The root cache folder.
-	 * @since 3.22.5
-	 */
-	public static function get_cache_folder() {
-
-		// Get the temp dir and add the directory separator if missing.
-		$temp_dir = get_temp_dir();
-		if ( DIRECTORY_SEPARATOR !== substr( $temp_dir, - strlen( DIRECTORY_SEPARATOR ) ) ) {
-			$temp_dir .= DIRECTORY_SEPARATOR;
-		}
-
-		return $temp_dir . 'wl.cache' . DIRECTORY_SEPARATOR . md5( home_url() );
-	}
-
-	/**
-	 * Get the cached data for the specified key.
-	 *
-	 * @param mixed $key A serializable key.
-	 *
-	 * @return mixed|null
-	 * @since 3.21.2
-	 */
-	public function get( $key ) {
-
-		$filename = $this->get_filename( $key );
-
-		// If the cache file exists and it's not too old, then return it.
-		if ( file_exists( $filename ) && $this->ttl >= time() - filemtime( $filename ) ) {
-			$this->log->trace( "Cache HIT.\n" );
-
-			// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
-			return json_decode( file_get_contents( $filename ), true );
-		}
-
-		$this->log->trace( "Cache MISS, filename $filename." );
-
-		return null;
-	}
-
-	public function put( $key, $data ) {
-
-		$filename = $this->get_filename( $key );
-
-		// Cache.
-		if ( file_exists( $filename ) ) {
-			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@unlink( $filename );
-		}
-
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged,WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
-		@file_put_contents( $filename, wp_json_encode( $data ) );
-
-	}
+    /**
+     * The cache name.
+     *
+     * @var string $name The cache name.
+     * @access private
+     * @since 3.21.2
+     */
+    private $name;
+
+    /**
+     * The TTL of cached responses in seconds.
+     *
+     * @var int $ttl The TTL in seconds.
+     * @access private
+     * @since 3.21.2
+     */
+    private $ttl;
+
+    /**
+     * The cache dir where the cached data is written.
+     *
+     * @since 3.21.2
+     * @access private
+     * @var string $cache_dir The cache dir where the cached responses are written.
+     */
+    private $cache_dir;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     * @access private
+     * @since 3.21.2
+     */
+    private $log;
+
+    /**
+     * @var array
+     */
+    private static $caches = array();
+
+    /**
+     * Create a {@link Ttl_Cache} with the specified TTL, default 900 secs.
+     *
+     * @param string $name The cache name.
+     * @param int    $ttl The cache TTL, default 900 secs.
+     *
+     * @since 3.21.2
+     */
+    public function __construct( $name, $ttl = 900 ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->name = $name;
+        $this->ttl  = $ttl;
+
+        $this->cache_dir = self::get_cache_folder() . DIRECTORY_SEPARATOR . md5( $name );
+
+        $this->log->trace( "Creating the cache folder {$this->cache_dir}..." );
+        wp_mkdir_p( $this->cache_dir );
+
+        self::$caches[ $name ] = $this;
+
+    }
+
+    /**
+     * Get the root cache folder.
+     *
+     * This is useful to introduce a cache cleaning procedure which will scan and delete older stale cache files.
+     *
+     * @return string The root cache folder.
+     * @since 3.22.5
+     */
+    public static function get_cache_folder() {
+
+        // Get the temp dir and add the directory separator if missing.
+        $temp_dir = get_temp_dir();
+        if ( DIRECTORY_SEPARATOR !== substr( $temp_dir, - strlen( DIRECTORY_SEPARATOR ) ) ) {
+            $temp_dir .= DIRECTORY_SEPARATOR;
+        }
+
+        return $temp_dir . 'wl.cache' . DIRECTORY_SEPARATOR . md5( home_url() );
+    }
+
+    /**
+     * Get the cached data for the specified key.
+     *
+     * @param mixed $key A serializable key.
+     *
+     * @return mixed|null
+     * @since 3.21.2
+     */
+    public function get( $key ) {
+
+        $filename = $this->get_filename( $key );
+
+        // If the cache file exists and it's not too old, then return it.
+        if ( file_exists( $filename ) && $this->ttl >= time() - filemtime( $filename ) ) {
+            $this->log->trace( "Cache HIT.\n" );
+
+            // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+            return json_decode( file_get_contents( $filename ), true );
+        }
+
+        $this->log->trace( "Cache MISS, filename $filename." );
+
+        return null;
+    }
+
+    public function put( $key, $data ) {
+
+        $filename = $this->get_filename( $key );
+
+        // Cache.
+        if ( file_exists( $filename ) ) {
+            // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+            @unlink( $filename );
+        }
+
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged,WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
+        @file_put_contents( $filename, wp_json_encode( $data ) );
+
+    }
 
-	public function delete( $key ) {
+    public function delete( $key ) {
 
-		$filename = $this->get_filename( $key );
+        $filename = $this->get_filename( $key );
 
-		// Delete.
-		if ( file_exists( $filename ) ) {
-			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@unlink( $filename );
-		}
+        // Delete.
+        if ( file_exists( $filename ) ) {
+            // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+            @unlink( $filename );
+        }
 
-	}
+    }
 
-	public function flush() {
+    public function flush() {
 
-		$files = glob( $this->cache_dir . DIRECTORY_SEPARATOR . '*' );
-		foreach ( $files as $file ) { // iterate files
-			if ( is_file( $file ) ) {
-				// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-				@unlink( $file );
-			}
-		}
+        $files = glob( $this->cache_dir . DIRECTORY_SEPARATOR . '*' );
+        foreach ( $files as $file ) { // iterate files
+            if ( is_file( $file ) ) {
+                // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+                @unlink( $file );
+            }
+        }
 
-	}
+    }
 
-	public static function flush_all() {
+    public static function flush_all() {
 
-		/** @var Ttl_Cache $cache */
-		foreach ( self::$caches as $cache ) {
-			$cache->flush();
-		}
+        /** @var Ttl_Cache $cache */
+        foreach ( self::$caches as $cache ) {
+            $cache->flush();
+        }
 
-	}
+    }
 
-	/**
-	 * Get the full path for the given `$hash`. The file is not checked for its existence.
-	 *
-	 * @param string $hash A file hash.
-	 *
-	 * @return string The full path to the file.
-	 * @since 3.21.2
-	 */
-	private function get_path( $hash ) {
+    /**
+     * Get the full path for the given `$hash`. The file is not checked for its existence.
+     *
+     * @param string $hash A file hash.
+     *
+     * @return string The full path to the file.
+     * @since 3.21.2
+     */
+    private function get_path( $hash ) {
 
-		return $this->cache_dir . DIRECTORY_SEPARATOR . $hash;
-	}
+        return $this->cache_dir . DIRECTORY_SEPARATOR . $hash;
+    }
 
-	private function get_filename( $key ) {
+    private function get_filename( $key ) {
 
-		// Create a hash and a path to the cache file.
-		$hash     = md5( wp_json_encode( $key ) );
-		$filename = $this->get_path( $hash );
+        // Create a hash and a path to the cache file.
+        $hash     = md5( wp_json_encode( $key ) );
+        $filename = $this->get_path( $hash );
 
-		return $filename;
-	}
+        return $filename;
+    }
 
 }

Spacing +33 added lines, -33 removed lines

@@ -66,19 +66,19 @@ 
 	 *
 	 * @since 3.21.2
 	 */
-	public function __construct( $name, $ttl = 900 ) {
+	public function __construct($name, $ttl = 900) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->name = $name;
 		$this->ttl  = $ttl;
 
-		$this->cache_dir = self::get_cache_folder() . DIRECTORY_SEPARATOR . md5( $name );
+		$this->cache_dir = self::get_cache_folder().DIRECTORY_SEPARATOR.md5($name);
 
-		$this->log->trace( "Creating the cache folder {$this->cache_dir}..." );
-		wp_mkdir_p( $this->cache_dir );
+		$this->log->trace("Creating the cache folder {$this->cache_dir}...");
+		wp_mkdir_p($this->cache_dir);
 
-		self::$caches[ $name ] = $this;
+		self::$caches[$name] = $this;
 
 	}
 
@@ -94,11 +94,11 @@ 
 
 		// Get the temp dir and add the directory separator if missing.
 		$temp_dir = get_temp_dir();
-		if ( DIRECTORY_SEPARATOR !== substr( $temp_dir, - strlen( DIRECTORY_SEPARATOR ) ) ) {
+		if (DIRECTORY_SEPARATOR !== substr($temp_dir, - strlen(DIRECTORY_SEPARATOR))) {
 			$temp_dir .= DIRECTORY_SEPARATOR;
 		}
 
-		return $temp_dir . 'wl.cache' . DIRECTORY_SEPARATOR . md5( home_url() );
+		return $temp_dir.'wl.cache'.DIRECTORY_SEPARATOR.md5(home_url());
 	}
 
 	/**
@@ -109,57 +109,57 @@ 
 	 * @return mixed|null
 	 * @since 3.21.2
 	 */
-	public function get( $key ) {
+	public function get($key) {
 
-		$filename = $this->get_filename( $key );
+		$filename = $this->get_filename($key);
 
 		// If the cache file exists and it's not too old, then return it.
-		if ( file_exists( $filename ) && $this->ttl >= time() - filemtime( $filename ) ) {
-			$this->log->trace( "Cache HIT.\n" );
+		if (file_exists($filename) && $this->ttl >= time() - filemtime($filename)) {
+			$this->log->trace("Cache HIT.\n");
 
 			// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
-			return json_decode( file_get_contents( $filename ), true );
+			return json_decode(file_get_contents($filename), true);
 		}
 
-		$this->log->trace( "Cache MISS, filename $filename." );
+		$this->log->trace("Cache MISS, filename $filename.");
 
 		return null;
 	}
 
-	public function put( $key, $data ) {
+	public function put($key, $data) {
 
-		$filename = $this->get_filename( $key );
+		$filename = $this->get_filename($key);
 
 		// Cache.
-		if ( file_exists( $filename ) ) {
+		if (file_exists($filename)) {
 			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@unlink( $filename );
+			@unlink($filename);
 		}
 
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged,WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
-		@file_put_contents( $filename, wp_json_encode( $data ) );
+		@file_put_contents($filename, wp_json_encode($data));
 
 	}
 
-	public function delete( $key ) {
+	public function delete($key) {
 
-		$filename = $this->get_filename( $key );
+		$filename = $this->get_filename($key);
 
 		// Delete.
-		if ( file_exists( $filename ) ) {
+		if (file_exists($filename)) {
 			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@unlink( $filename );
+			@unlink($filename);
 		}
 
 	}
 
 	public function flush() {
 
-		$files = glob( $this->cache_dir . DIRECTORY_SEPARATOR . '*' );
-		foreach ( $files as $file ) { // iterate files
-			if ( is_file( $file ) ) {
+		$files = glob($this->cache_dir.DIRECTORY_SEPARATOR.'*');
+		foreach ($files as $file) { // iterate files
+			if (is_file($file)) {
 				// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-				@unlink( $file );
+				@unlink($file);
 			}
 		}
 
@@ -168,7 +168,7 @@ 
 	public static function flush_all() {
 
 		/** @var Ttl_Cache $cache */
-		foreach ( self::$caches as $cache ) {
+		foreach (self::$caches as $cache) {
 			$cache->flush();
 		}
 
@@ -182,16 +182,16 @@ 
 	 * @return string The full path to the file.
 	 * @since 3.21.2
 	 */
-	private function get_path( $hash ) {
+	private function get_path($hash) {
 
-		return $this->cache_dir . DIRECTORY_SEPARATOR . $hash;
+		return $this->cache_dir.DIRECTORY_SEPARATOR.$hash;
 	}
 
-	private function get_filename( $key ) {
+	private function get_filename($key) {
 
 		// Create a hash and a path to the cache file.
-		$hash     = md5( wp_json_encode( $key ) );
-		$filename = $this->get_path( $hash );
+		$hash     = md5(wp_json_encode($key));
+		$filename = $this->get_path($hash);
 
 		return $filename;
 	}

src/wordlift/tasks/class-task.php

Indentation +37 added lines, -37 removed lines

@@ -15,42 +15,42 @@
  */
 interface Task {
 
-	/**
-	 * Define the task ID.
-	 *
-	 * @return string The task id.
-	 * @since 1.0.0
-	 */
-	public function get_id();
-
-	public function get_label();
-
-	/**
-	 * List the items to process.
-	 *
-	 * @param int $limit
-	 * @param int $offset
-	 *
-	 * @return array An array of items.
-	 * @since 1.0.0
-	 */
-	public function list_items( $limit = 10, $offset = 0 );
-
-	/**
-	 * Count the total number of items to process.
-	 *
-	 * @return int Total number of items to process.
-	 * @since 1.0.0
-	 */
-	public function count_items();
-
-	/**
-	 * Process the provided item.
-	 *
-	 * @param mixed $item Process the provided item.
-	 *
-	 * @since 1.0.0
-	 */
-	public function process_item( $item );
+    /**
+     * Define the task ID.
+     *
+     * @return string The task id.
+     * @since 1.0.0
+     */
+    public function get_id();
+
+    public function get_label();
+
+    /**
+     * List the items to process.
+     *
+     * @param int $limit
+     * @param int $offset
+     *
+     * @return array An array of items.
+     * @since 1.0.0
+     */
+    public function list_items( $limit = 10, $offset = 0 );
+
+    /**
+     * Count the total number of items to process.
+     *
+     * @return int Total number of items to process.
+     * @since 1.0.0
+     */
+    public function count_items();
+
+    /**
+     * Process the provided item.
+     *
+     * @param mixed $item Process the provided item.
+     *
+     * @since 1.0.0
+     */
+    public function process_item( $item );
 
 }

Spacing +2 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
 	 * @return array An array of items.
 	 * @since 1.0.0
 	 */
-	public function list_items( $limit = 10, $offset = 0 );
+	public function list_items($limit = 10, $offset = 0);
 
 	/**
 	 * Count the total number of items to process.
@@ -51,6 +51,6 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	public function process_item( $item );
+	public function process_item($item);
 
 }

src/wordlift/tasks/class-task-single-instance-task-runner.php

Indentation +191 added lines, -191 removed lines

@@ -24,196 +24,196 @@
  */
 class Task_Single_Instance_Task_Runner {
 
-	/**
-	 * Define the transient prefix.
-	 *
-	 * @since 1.0.0
-	 */
-	const IS_RUNNING_PREFIX = '_wf_task_runner__';
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 1.0.0
-	 * @var Wordlift_Log_Service A {@link Wordlift_Log_Service} instance.
-	 * @access private
-	 */
-	private $log;
-
-	/**
-	 * The {@link Task} to execute.
-	 *
-	 * @since 1.0.0
-	 * @var Task $task The {@link Task} to execute.
-	 * @access private
-	 */
-	private $task;
-
-	/**
-	 * One or more callbacks to call to update about the task progress.
-	 *
-	 * @since 1.0.0
-	 * @var Task_Progress[] $callbacks An array of {@link Wordlift_For_Bungalowparkoverzicht_Progress}.
-	 * @access private
-	 */
-	private $callbacks;
-
-	/**
-	 * Whether to force starting a task even if another instance of the task is already running.
-	 *
-	 * @since 1.0.0
-	 * @var bool $force Whether to force starting a task even if another instance of the task is already running.
-	 * @access private
-	 */
-	private $force;
-
-	/**
-	 * Create a {@link Task_Single_Instance_Task_Runner} instance.
-	 *
-	 * @param Task  $task The {@link Task} instance.
-	 * @param bool  $force Whether to force starting a task even if another instance of the task is already running, default `false`.
-	 * @param array $callbacks An array of {@link Wordlift_For_Bungalowparkoverzicht_Progress}.
-	 *
-	 * @since 1.0.0
-	 */
-	public function __construct( $task, $force = false, $callbacks = array() ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->task      = $task;
-		$this->force     = $force;
-		$this->callbacks = $callbacks;
-
-	}
-
-	/**
-	 * Get the transient name for running flag.
-	 *
-	 * @return string The transient name.
-	 * @since 1.0.0
-	 */
-	private function get_running_transient() {
-
-		return self::IS_RUNNING_PREFIX . $this->task->get_id();
-	}
-
-	/**
-	 * Check whether a task is running.
-	 *
-	 * @return bool
-	 * @since 1.0.0
-	 */
-	public function is_running() {
-		return 'yes' === get_transient( $this->get_running_transient() );
-	}
-
-	/**
-	 * Set whether the task is running or not.
-	 *
-	 * @param bool $value Whether the task is running or not.
-	 *
-	 * @since 1.0.0
-	 */
-	public function set_running( $value ) {
-		set_transient( $this->get_running_transient(), $value ? 'yes' : 'no' );
-	}
-
-	/**
-	 * Start the task.
-	 *
-	 * @param int $limit The maximum number of items to process.
-	 * @param int $offset The starting offset.
-	 *
-	 * @throws Task_Another_Instance_Is_Running_Exception if the task is already running.
-	 * @since 1.0.0
-	 */
-	public function start( $limit = 0, $offset = 0 ) {
-
-		// Bail out if the task is already running.
-		if ( ! $this->force && $this->is_running() ) {
-			throw new Task_Another_Instance_Is_Running_Exception();
-		}
-
-		// Set the task as running.
-		$this->set_running( true );
-
-		// List the chunk of elements to process.
-		$items = $this->task->list_items( $limit, $offset );
-
-		$count = count( $items );
-		for ( $i = 0; $i < $count; $i ++ ) {
-			// Process the item.
-			$this->task->process_item( $items[ $i ] );
-
-			// Update the progress.
-			$this->set_progress( $offset + $i, $items[ $i ] );
-		}
-
-		// Set the total number of elements to process.
-		$this->set_count( $this->task->count_items() );
-
-		// Unset the running flag.
-		$this->set_running( false );
-
-		// Set the task to complete.
-		$this->finish();
-
-	}
-
-	/**
-	 * Set the total number of items to process.
-	 *
-	 * @param int $value The total number of items to process.
-	 *
-	 * @since 1.0.0
-	 */
-	private function set_count( $value ) {
-
-		if ( empty( $this->callbacks ) ) {
-			return;
-		}
-
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'set_count' ), $value );
-		}
-
-	}
-
-	/**
-	 * Set the task progress.
-	 *
-	 * @param int   $index The current item index.
-	 * @param mixed $item The current item.
-	 *
-	 * @since 1.0.0
-	 */
-	private function set_progress( $index, $item ) {
-
-		if ( empty( $this->callbacks ) ) {
-			return;
-		}
-
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'set_progress' ), $index, $item );
-		}
-
-	}
-
-	/**
-	 * Inform the callbacks that the task completed.
-	 *
-	 * @since 1.0.0
-	 */
-	private function finish() {
-
-		if ( empty( $this->callbacks ) ) {
-			return;
-		}
-
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'finish' ) );
-		}
-
-	}
+    /**
+     * Define the transient prefix.
+     *
+     * @since 1.0.0
+     */
+    const IS_RUNNING_PREFIX = '_wf_task_runner__';
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 1.0.0
+     * @var Wordlift_Log_Service A {@link Wordlift_Log_Service} instance.
+     * @access private
+     */
+    private $log;
+
+    /**
+     * The {@link Task} to execute.
+     *
+     * @since 1.0.0
+     * @var Task $task The {@link Task} to execute.
+     * @access private
+     */
+    private $task;
+
+    /**
+     * One or more callbacks to call to update about the task progress.
+     *
+     * @since 1.0.0
+     * @var Task_Progress[] $callbacks An array of {@link Wordlift_For_Bungalowparkoverzicht_Progress}.
+     * @access private
+     */
+    private $callbacks;
+
+    /**
+     * Whether to force starting a task even if another instance of the task is already running.
+     *
+     * @since 1.0.0
+     * @var bool $force Whether to force starting a task even if another instance of the task is already running.
+     * @access private
+     */
+    private $force;
+
+    /**
+     * Create a {@link Task_Single_Instance_Task_Runner} instance.
+     *
+     * @param Task  $task The {@link Task} instance.
+     * @param bool  $force Whether to force starting a task even if another instance of the task is already running, default `false`.
+     * @param array $callbacks An array of {@link Wordlift_For_Bungalowparkoverzicht_Progress}.
+     *
+     * @since 1.0.0
+     */
+    public function __construct( $task, $force = false, $callbacks = array() ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->task      = $task;
+        $this->force     = $force;
+        $this->callbacks = $callbacks;
+
+    }
+
+    /**
+     * Get the transient name for running flag.
+     *
+     * @return string The transient name.
+     * @since 1.0.0
+     */
+    private function get_running_transient() {
+
+        return self::IS_RUNNING_PREFIX . $this->task->get_id();
+    }
+
+    /**
+     * Check whether a task is running.
+     *
+     * @return bool
+     * @since 1.0.0
+     */
+    public function is_running() {
+        return 'yes' === get_transient( $this->get_running_transient() );
+    }
+
+    /**
+     * Set whether the task is running or not.
+     *
+     * @param bool $value Whether the task is running or not.
+     *
+     * @since 1.0.0
+     */
+    public function set_running( $value ) {
+        set_transient( $this->get_running_transient(), $value ? 'yes' : 'no' );
+    }
+
+    /**
+     * Start the task.
+     *
+     * @param int $limit The maximum number of items to process.
+     * @param int $offset The starting offset.
+     *
+     * @throws Task_Another_Instance_Is_Running_Exception if the task is already running.
+     * @since 1.0.0
+     */
+    public function start( $limit = 0, $offset = 0 ) {
+
+        // Bail out if the task is already running.
+        if ( ! $this->force && $this->is_running() ) {
+            throw new Task_Another_Instance_Is_Running_Exception();
+        }
+
+        // Set the task as running.
+        $this->set_running( true );
+
+        // List the chunk of elements to process.
+        $items = $this->task->list_items( $limit, $offset );
+
+        $count = count( $items );
+        for ( $i = 0; $i < $count; $i ++ ) {
+            // Process the item.
+            $this->task->process_item( $items[ $i ] );
+
+            // Update the progress.
+            $this->set_progress( $offset + $i, $items[ $i ] );
+        }
+
+        // Set the total number of elements to process.
+        $this->set_count( $this->task->count_items() );
+
+        // Unset the running flag.
+        $this->set_running( false );
+
+        // Set the task to complete.
+        $this->finish();
+
+    }
+
+    /**
+     * Set the total number of items to process.
+     *
+     * @param int $value The total number of items to process.
+     *
+     * @since 1.0.0
+     */
+    private function set_count( $value ) {
+
+        if ( empty( $this->callbacks ) ) {
+            return;
+        }
+
+        foreach ( $this->callbacks as $callback ) {
+            call_user_func( array( $callback, 'set_count' ), $value );
+        }
+
+    }
+
+    /**
+     * Set the task progress.
+     *
+     * @param int   $index The current item index.
+     * @param mixed $item The current item.
+     *
+     * @since 1.0.0
+     */
+    private function set_progress( $index, $item ) {
+
+        if ( empty( $this->callbacks ) ) {
+            return;
+        }
+
+        foreach ( $this->callbacks as $callback ) {
+            call_user_func( array( $callback, 'set_progress' ), $index, $item );
+        }
+
+    }
+
+    /**
+     * Inform the callbacks that the task completed.
+     *
+     * @since 1.0.0
+     */
+    private function finish() {
+
+        if ( empty( $this->callbacks ) ) {
+            return;
+        }
+
+        foreach ( $this->callbacks as $callback ) {
+            call_user_func( array( $callback, 'finish' ) );
+        }
+
+    }
 
 }

Spacing +27 added lines, -27 removed lines

@@ -76,9 +76,9 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	public function __construct( $task, $force = false, $callbacks = array() ) {
+	public function __construct($task, $force = false, $callbacks = array()) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->task      = $task;
 		$this->force     = $force;
@@ -94,7 +94,7 @@ 
 	 */
 	private function get_running_transient() {
 
-		return self::IS_RUNNING_PREFIX . $this->task->get_id();
+		return self::IS_RUNNING_PREFIX.$this->task->get_id();
 	}
 
 	/**
@@ -104,7 +104,7 @@ 
 	 * @since 1.0.0
 	 */
 	public function is_running() {
-		return 'yes' === get_transient( $this->get_running_transient() );
+		return 'yes' === get_transient($this->get_running_transient());
 	}
 
 	/**
@@ -114,8 +114,8 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	public function set_running( $value ) {
-		set_transient( $this->get_running_transient(), $value ? 'yes' : 'no' );
+	public function set_running($value) {
+		set_transient($this->get_running_transient(), $value ? 'yes' : 'no');
 	}
 
 	/**
@@ -127,33 +127,33 @@ 
 	 * @throws Task_Another_Instance_Is_Running_Exception if the task is already running.
 	 * @since 1.0.0
 	 */
-	public function start( $limit = 0, $offset = 0 ) {
+	public function start($limit = 0, $offset = 0) {
 
 		// Bail out if the task is already running.
-		if ( ! $this->force && $this->is_running() ) {
+		if ( ! $this->force && $this->is_running()) {
 			throw new Task_Another_Instance_Is_Running_Exception();
 		}
 
 		// Set the task as running.
-		$this->set_running( true );
+		$this->set_running(true);
 
 		// List the chunk of elements to process.
-		$items = $this->task->list_items( $limit, $offset );
+		$items = $this->task->list_items($limit, $offset);
 
-		$count = count( $items );
-		for ( $i = 0; $i < $count; $i ++ ) {
+		$count = count($items);
+		for ($i = 0; $i < $count; $i++) {
 			// Process the item.
-			$this->task->process_item( $items[ $i ] );
+			$this->task->process_item($items[$i]);
 
 			// Update the progress.
-			$this->set_progress( $offset + $i, $items[ $i ] );
+			$this->set_progress($offset + $i, $items[$i]);
 		}
 
 		// Set the total number of elements to process.
-		$this->set_count( $this->task->count_items() );
+		$this->set_count($this->task->count_items());
 
 		// Unset the running flag.
-		$this->set_running( false );
+		$this->set_running(false);
 
 		// Set the task to complete.
 		$this->finish();
@@ -167,14 +167,14 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	private function set_count( $value ) {
+	private function set_count($value) {
 
-		if ( empty( $this->callbacks ) ) {
+		if (empty($this->callbacks)) {
 			return;
 		}
 
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'set_count' ), $value );
+		foreach ($this->callbacks as $callback) {
+			call_user_func(array($callback, 'set_count'), $value);
 		}
 
 	}
@@ -187,14 +187,14 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	private function set_progress( $index, $item ) {
+	private function set_progress($index, $item) {
 
-		if ( empty( $this->callbacks ) ) {
+		if (empty($this->callbacks)) {
 			return;
 		}
 
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'set_progress' ), $index, $item );
+		foreach ($this->callbacks as $callback) {
+			call_user_func(array($callback, 'set_progress'), $index, $item);
 		}
 
 	}
@@ -206,12 +206,12 @@ 
 	 */
 	private function finish() {
 
-		if ( empty( $this->callbacks ) ) {
+		if (empty($this->callbacks)) {
 			return;
 		}
 
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'finish' ) );
+		foreach ($this->callbacks as $callback) {
+			call_user_func(array($callback, 'finish'));
 		}
 
 	}