insideout10 / wordlift-plugin

src/classes/analysis/response/class-analysis-response-ops.php

Indentation +381 added lines, -381 removed lines

@@ -16,386 +16,386 @@
 
 class Analysis_Response_Ops {
 
-	/**
-	 * The analysis response json.
-	 *
-	 * @since 3.21.5
-	 * @access private
-	 * @var mixed $json Holds the analysis response json.
-	 */
-	private $json;
-
-	/**
-	 * Holds the {@link Wordlift_Entity_Uri_Service}.
-	 *
-	 * @since 3.21.5
-	 * @access private
-	 * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * @var Entity_Helper
-	 */
-	private $entity_helper;
-
-	/**
-	 * @var int $post_id
-	 */
-	private $post_id;
-
-	/**
-	 * Analysis_Response_Ops constructor.
-	 *
-	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service}.
-	 * @param Entity_Helper                $entity_helper The {@link Entity_Helper}.
-	 * @param mixed                        $json The analysis response json.
-	 *
-	 * @since 3.21.5
-	 */
-	public function __construct( $entity_uri_service, $entity_helper, $json, $post_id ) {
-		$this->json               = $json;
-		$this->entity_uri_service = $entity_uri_service;
-		$this->entity_helper      = $entity_helper;
-		$this->post_id            = $post_id;
-	}
-
-	/**
-	 * Switches remote entities, i.e. entities with id outside the local dataset, to local entities.
-	 *
-	 * The function takes all the entities that have an id which is not local. For each remote entity, a list of URIs
-	 * is built comprising the entity id and the sameAs. Then a query is issued in the local database to find potential
-	 * matches from the local vocabulary.
-	 *
-	 * If found, the entity id is swapped with the local id and the remote id is added to the sameAs.
-	 *
-	 * @return Analysis_Response_Ops The current Analysis_Response_Ops instance.
-	 */
-	public function make_entities_local() {
-
-		if ( ! isset( $this->json->entities ) ) {
-			return $this;
-		}
-
-		// Get the URIs.
-		$uris     = array_keys( get_object_vars( $this->json->entities ) );
-		$mappings = $this->entity_helper->map_many_to_local( $uris );
-
-		foreach ( $mappings as $external_uri => $internal_uri ) {
-
-			// Move the data from the external URI to the internal URI.
-			if ( ! isset( $this->json->entities->{$internal_uri} ) ) {
-				$this->json->entities->{$internal_uri} = $this->json->entities->{$external_uri};
-			}
-
-			// Ensure sameAs is an array.
-			if ( ! isset( $this->json->entities->{$internal_uri}->sameAs )
-				 || ! is_array( $this->json->entities->{$internal_uri}->sameAs ) ) {
-				$this->json->entities->{$internal_uri}->sameAs = array();
-			}
-
-			// Add the external URI as sameAs.
-			$this->json->entities->{$internal_uri}->sameAs[] = $external_uri;
-
-			// Finally remove the external URI.
-			unset( $this->json->entities->{$external_uri} );
-		}
-
-		// Set the internal uri in the annotation for the entityMatch in annotations.
-		if ( isset( $this->json->annotations ) ) {
-			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			foreach ( $this->json->annotations as $key => $annotation ) {
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( isset( $annotation->entityMatches ) ) {
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					foreach ( $annotation->entityMatches as $match ) {
-						// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-						if ( isset( $match->entityId ) && isset( $mappings[ $match->entityId ] ) ) {
-							// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-							$match->entityId = $mappings[ $match->entityId ];
-						}
-					}
-				}
-			}
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Add occurrences by parsing the provided html content.
-	 *
-	 * @param string $content The html content with annotations.
-	 *
-	 * @return Analysis_Response_Ops The {@link Analysis_Response_Ops} instance.
-	 *
-	 * @since 3.23.7 refactor the regex pattern to take into account that there might be css classes between textannotation
-	 *  and disambiguated.
-	 *
-	 * @link https://github.com/insideout10/wordlift-plugin/issues/1001
-	 */
-	public function add_occurrences( $content ) {
-
-		// Try to get all the disambiguated annotations and bail out if an error occurs.
-		if ( false === preg_match_all(
-			'|<span\s+id="([^"]+)"\s+class="textannotation\s+(?:\S+\s+)?disambiguated(?=[\s"])[^"]*"\s+itemid="([^"]*)">(.*?)</span>|',
-			$content,
-			$matches,
-			PREG_OFFSET_CAPTURE
-		) ) {
-			return $this;
-		}
-
-		if ( empty( $matches ) ) {
-			return $this;
-		}
-
-		$parse_data = array_reduce(
-			range( 0, count( $matches[1] ) - 1 ),
-			function ( $carry, $i ) use ( $matches ) {
-				if ( empty( $matches[0] ) ) {
-					return $carry;
-				}
-
-				$start         = $matches[0][ $i ][1];
-				$end           = $start + strlen( $matches[0][ $i ][0] );
-				$annotation_id = $matches[1][ $i ][0];
-				$item_id       = $matches[2][ $i ][0];
-				$text          = $matches[3][ $i ][0];
-
-				$annotation = new StdClass();
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				$annotation->annotationId = $annotation_id;
-				$annotation->start        = $start;
-				$annotation->end          = $end;
-				$annotation->text         = $text;
-
-				$entity_match             = new StdClass();
-				$entity_match->confidence = 100;
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				$entity_match->entityId = $item_id;
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				$annotation->entityMatches[] = $entity_match;
-
-				$carry['annotations'][ $annotation_id ] = $annotation;
-				$carry['occurrences'][ $item_id ][]     = $annotation_id;
-
-				return $carry;
-			},
-			array(
-				'annotations' => array(),
-				'occurrences' => array(),
-			)
-		);
-
-		$annotations = $parse_data['annotations'];
-		$occurrences = $parse_data['occurrences'];
-
-		$entity_provider_registry = Entity_Provider_Registry::get_instance();
-
-		foreach ( array_keys( $occurrences ) as $item_id ) {
-
-			// If the entity isn't there, add it.
-			if ( ! is_bool( $this->json ) && ! isset( $this->json->entities->{$item_id} ) ) {
-				$entity = $entity_provider_registry->get_local_entity( $item_id );
-
-				// Entity not found in the local vocabulary, continue to the next one.
-				if ( false === $entity ) {
-					continue;
-				}
-
-				$this->json->entities->{$item_id} = $entity;
-			}
-		}
-
-		// Here we're adding back some data structures required by the client-side code.
-		//
-		// We're adding:
-		// 1. the .entities[entity_id].occurrences array with the annotations' ids.
-		// 2. the .entities[entity_id].annotations[annotation_id] = { id: annotation_id } map.
-		//
-		// Before 3.23.0 this was done by the client-side code located in src/coffee/editpost-widget/app.services.AnalysisService.coffee
-		// function `preselect`, which was called by src/coffee/editpost-widget/app.services.EditorService.coffee in
-		// `embedAnalysis`.
-
-		if ( ! is_bool( $this->json ) && isset( $this->json->entities ) ) {
-			$occurrences_processor = Occurrences_Factory::get_instance( $this->post_id );
-			$this->json            = $occurrences_processor->add_occurrences_to_entities( $occurrences, $this->json, $this->post_id );
-		}
-
-		// Add the missing annotations. This allows the analysis response to work also if we didn't receive results
-		// from the analysis API.
-		foreach ( $annotations as $annotation_id => $annotation ) {
-
-			if ( ! is_bool( $this->json ) && ! isset( $this->json->annotations->{$annotation_id} ) ) {
-				$this->json->annotations->{$annotation_id} = $annotation;
-			}
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Add local entities
-	 *
-	 * @return Analysis_Response_Ops The {@link Analysis_Response_Ops} instance.
-	 *
-	 * @since 3.27.6
-	 *
-	 * @link https://github.com/insideout10/wordlift-plugin/issues/1178
-	 */
-	public function add_local_entities() {
-
-		// Populating the local entities object
-		$entities = array();
-		foreach ( $this->json->annotations as $annotation ) {
-			// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-			foreach ( $annotation->entityMatches as $entity_matches ) {
-
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				$entity_id         = $this->entity_uri_service->get_post_id_from_url( $entity_matches->entityId );
-				$serialized_entity = wl_serialize_entity( $entity_id );
-
-				if ( $serialized_entity ) {
-					$serialized_entity['entityId'] = $serialized_entity['id'];
-					// Keep the `id` for compatibility with existing analysis, since it appears that no-editor-analysis.js
-					// is using it, ie.:
-					// `Each child in a list should have a unique "key" prop.`
-					//
-					// unset( $serialized_entity['id'] );
-
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_matches->entityId ] = $serialized_entity;
-				}
-			}
-		}
-
-		// Adding occurrences and annotations data structures required by the client-side code.
-		foreach ( $entities as $entity_id => $entity ) {
-			foreach ( $this->json->annotations as $annotation ) {
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( $annotation->entityMatches[0]->entityId === $entity_id ) {
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_id ]['occurrences'][] = $annotation->annotationId;
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_id ]['annotations'][ $annotation->annotationId ]['id'] = $annotation->annotationId;
-				}
-			}
-		}
-
-		$this->json->entities = $entities;
-
-		return $this;
-
-	}
-
-	/**
-	 * Return the JSON response.
-	 *
-	 * @return mixed The JSON response.
-	 * @since 3.24.2
-	 */
-	public function get_json() {
-
-		return $this->json;
-	}
-
-	/**
-	 * This function should be invoked after `make_entities_local` after this
-	 * method.
-	 *
-	 * @param $excluded_uris array An array of entity URIs to be excluded.
-	 *
-	 * @return $this
-	 * @since 3.32.3.1
-	 */
-	public function remove_excluded_entities( $excluded_uris ) {
-
-		// If we didnt receive array, return early.
-		if ( ! is_array( $excluded_uris ) ) {
-			return $this;
-		}
-
-		// We may also receive an array of null, make sure to filter uris when receiving.
-		$excluded_uris = array_filter( $excluded_uris, 'is_string' );
-
-		$this->remove_entities_with_excluded_uris( $excluded_uris );
-
-		$this->remove_annotations_with_excluded_uris( $excluded_uris );
-
-		return $this;
-	}
-
-	/**
-	 * Get the string representation of the JSON.
-	 *
-	 * @return false|string The string representation or false in case of error.
-	 */
-	public function to_string() {
-
-		// Add the `JSON_UNESCAPED_UNICODE` only for PHP 5.4+.
-		$options = ( version_compare( PHP_VERSION, '5.4', '>=' )
-			? 256 : 0 );
-
-		return wp_json_encode( $this->json, $options );
-	}
-
-	/**
-	 * Remove all the entities with the excluded URIs.
-	 *
-	 * @param array $excluded_uris The array of URIs to be excluded.
-	 */
-	private function remove_entities_with_excluded_uris( array $excluded_uris ) {
-		// Remove the excluded entity uris.
-		if ( isset( $this->json->entities ) ) {
-			foreach ( $excluded_uris as $excluded_uri ) {
-
-				if ( isset( $this->json->entities->{$excluded_uri} ) ) {
-					// Remove this entity.
-					unset( $this->json->entities->{$excluded_uri} );
-					// Also remove the annotations.
-				}
-			}
-		}
-	}
-
-	/**
-	 * Remove all the annotations with the excluded entity URIs.
-	 *
-	 * @param array $excluded_uris The array of URIs to be excluded.
-	 *
-	 * @return void
-	 */
-	private function remove_annotations_with_excluded_uris( array $excluded_uris ) {
-		if ( isset( $this->json->annotations ) ) {
-			foreach ( $this->json->annotations as $annotation_key => &$annotation_data ) {
-
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( ! isset( $annotation_data->entityMatches ) ) {
-					continue;
-				}
-
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				foreach ( $annotation_data->entityMatches as $entity_match_key => $entity_match_data ) {
-
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entity_uri = $entity_match_data->entityId;
-
-					if ( ! in_array( $entity_uri, $excluded_uris, true ) ) {
-						continue;
-					}
-					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					unset( $annotation_data->entityMatches[ $entity_match_key ] );
-				}
-
-				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( count( $annotation_data->entityMatches ) === 0 ) {
-					// Remove the annotation if we have zero empty annotation matches.
-					unset( $this->json->annotations->{$annotation_key} );
-				}
-			}
-		}
-
-	}
+    /**
+     * The analysis response json.
+     *
+     * @since 3.21.5
+     * @access private
+     * @var mixed $json Holds the analysis response json.
+     */
+    private $json;
+
+    /**
+     * Holds the {@link Wordlift_Entity_Uri_Service}.
+     *
+     * @since 3.21.5
+     * @access private
+     * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    private $entity_uri_service;
+
+    /**
+     * @var Entity_Helper
+     */
+    private $entity_helper;
+
+    /**
+     * @var int $post_id
+     */
+    private $post_id;
+
+    /**
+     * Analysis_Response_Ops constructor.
+     *
+     * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service}.
+     * @param Entity_Helper                $entity_helper The {@link Entity_Helper}.
+     * @param mixed                        $json The analysis response json.
+     *
+     * @since 3.21.5
+     */
+    public function __construct( $entity_uri_service, $entity_helper, $json, $post_id ) {
+        $this->json               = $json;
+        $this->entity_uri_service = $entity_uri_service;
+        $this->entity_helper      = $entity_helper;
+        $this->post_id            = $post_id;
+    }
+
+    /**
+     * Switches remote entities, i.e. entities with id outside the local dataset, to local entities.
+     *
+     * The function takes all the entities that have an id which is not local. For each remote entity, a list of URIs
+     * is built comprising the entity id and the sameAs. Then a query is issued in the local database to find potential
+     * matches from the local vocabulary.
+     *
+     * If found, the entity id is swapped with the local id and the remote id is added to the sameAs.
+     *
+     * @return Analysis_Response_Ops The current Analysis_Response_Ops instance.
+     */
+    public function make_entities_local() {
+
+        if ( ! isset( $this->json->entities ) ) {
+            return $this;
+        }
+
+        // Get the URIs.
+        $uris     = array_keys( get_object_vars( $this->json->entities ) );
+        $mappings = $this->entity_helper->map_many_to_local( $uris );
+
+        foreach ( $mappings as $external_uri => $internal_uri ) {
+
+            // Move the data from the external URI to the internal URI.
+            if ( ! isset( $this->json->entities->{$internal_uri} ) ) {
+                $this->json->entities->{$internal_uri} = $this->json->entities->{$external_uri};
+            }
+
+            // Ensure sameAs is an array.
+            if ( ! isset( $this->json->entities->{$internal_uri}->sameAs )
+                 || ! is_array( $this->json->entities->{$internal_uri}->sameAs ) ) {
+                $this->json->entities->{$internal_uri}->sameAs = array();
+            }
+
+            // Add the external URI as sameAs.
+            $this->json->entities->{$internal_uri}->sameAs[] = $external_uri;
+
+            // Finally remove the external URI.
+            unset( $this->json->entities->{$external_uri} );
+        }
+
+        // Set the internal uri in the annotation for the entityMatch in annotations.
+        if ( isset( $this->json->annotations ) ) {
+            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+            foreach ( $this->json->annotations as $key => $annotation ) {
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                if ( isset( $annotation->entityMatches ) ) {
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    foreach ( $annotation->entityMatches as $match ) {
+                        // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                        if ( isset( $match->entityId ) && isset( $mappings[ $match->entityId ] ) ) {
+                            // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                            $match->entityId = $mappings[ $match->entityId ];
+                        }
+                    }
+                }
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Add occurrences by parsing the provided html content.
+     *
+     * @param string $content The html content with annotations.
+     *
+     * @return Analysis_Response_Ops The {@link Analysis_Response_Ops} instance.
+     *
+     * @since 3.23.7 refactor the regex pattern to take into account that there might be css classes between textannotation
+     *  and disambiguated.
+     *
+     * @link https://github.com/insideout10/wordlift-plugin/issues/1001
+     */
+    public function add_occurrences( $content ) {
+
+        // Try to get all the disambiguated annotations and bail out if an error occurs.
+        if ( false === preg_match_all(
+            '|<span\s+id="([^"]+)"\s+class="textannotation\s+(?:\S+\s+)?disambiguated(?=[\s"])[^"]*"\s+itemid="([^"]*)">(.*?)</span>|',
+            $content,
+            $matches,
+            PREG_OFFSET_CAPTURE
+        ) ) {
+            return $this;
+        }
+
+        if ( empty( $matches ) ) {
+            return $this;
+        }
+
+        $parse_data = array_reduce(
+            range( 0, count( $matches[1] ) - 1 ),
+            function ( $carry, $i ) use ( $matches ) {
+                if ( empty( $matches[0] ) ) {
+                    return $carry;
+                }
+
+                $start         = $matches[0][ $i ][1];
+                $end           = $start + strlen( $matches[0][ $i ][0] );
+                $annotation_id = $matches[1][ $i ][0];
+                $item_id       = $matches[2][ $i ][0];
+                $text          = $matches[3][ $i ][0];
+
+                $annotation = new StdClass();
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                $annotation->annotationId = $annotation_id;
+                $annotation->start        = $start;
+                $annotation->end          = $end;
+                $annotation->text         = $text;
+
+                $entity_match             = new StdClass();
+                $entity_match->confidence = 100;
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                $entity_match->entityId = $item_id;
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                $annotation->entityMatches[] = $entity_match;
+
+                $carry['annotations'][ $annotation_id ] = $annotation;
+                $carry['occurrences'][ $item_id ][]     = $annotation_id;
+
+                return $carry;
+            },
+            array(
+                'annotations' => array(),
+                'occurrences' => array(),
+            )
+        );
+
+        $annotations = $parse_data['annotations'];
+        $occurrences = $parse_data['occurrences'];
+
+        $entity_provider_registry = Entity_Provider_Registry::get_instance();
+
+        foreach ( array_keys( $occurrences ) as $item_id ) {
+
+            // If the entity isn't there, add it.
+            if ( ! is_bool( $this->json ) && ! isset( $this->json->entities->{$item_id} ) ) {
+                $entity = $entity_provider_registry->get_local_entity( $item_id );
+
+                // Entity not found in the local vocabulary, continue to the next one.
+                if ( false === $entity ) {
+                    continue;
+                }
+
+                $this->json->entities->{$item_id} = $entity;
+            }
+        }
+
+        // Here we're adding back some data structures required by the client-side code.
+        //
+        // We're adding:
+        // 1. the .entities[entity_id].occurrences array with the annotations' ids.
+        // 2. the .entities[entity_id].annotations[annotation_id] = { id: annotation_id } map.
+        //
+        // Before 3.23.0 this was done by the client-side code located in src/coffee/editpost-widget/app.services.AnalysisService.coffee
+        // function `preselect`, which was called by src/coffee/editpost-widget/app.services.EditorService.coffee in
+        // `embedAnalysis`.
+
+        if ( ! is_bool( $this->json ) && isset( $this->json->entities ) ) {
+            $occurrences_processor = Occurrences_Factory::get_instance( $this->post_id );
+            $this->json            = $occurrences_processor->add_occurrences_to_entities( $occurrences, $this->json, $this->post_id );
+        }
+
+        // Add the missing annotations. This allows the analysis response to work also if we didn't receive results
+        // from the analysis API.
+        foreach ( $annotations as $annotation_id => $annotation ) {
+
+            if ( ! is_bool( $this->json ) && ! isset( $this->json->annotations->{$annotation_id} ) ) {
+                $this->json->annotations->{$annotation_id} = $annotation;
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Add local entities
+     *
+     * @return Analysis_Response_Ops The {@link Analysis_Response_Ops} instance.
+     *
+     * @since 3.27.6
+     *
+     * @link https://github.com/insideout10/wordlift-plugin/issues/1178
+     */
+    public function add_local_entities() {
+
+        // Populating the local entities object
+        $entities = array();
+        foreach ( $this->json->annotations as $annotation ) {
+            // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+            foreach ( $annotation->entityMatches as $entity_matches ) {
+
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                $entity_id         = $this->entity_uri_service->get_post_id_from_url( $entity_matches->entityId );
+                $serialized_entity = wl_serialize_entity( $entity_id );
+
+                if ( $serialized_entity ) {
+                    $serialized_entity['entityId'] = $serialized_entity['id'];
+                    // Keep the `id` for compatibility with existing analysis, since it appears that no-editor-analysis.js
+                    // is using it, ie.:
+                    // `Each child in a list should have a unique "key" prop.`
+                    //
+                    // unset( $serialized_entity['id'] );
+
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    $entities[ $entity_matches->entityId ] = $serialized_entity;
+                }
+            }
+        }
+
+        // Adding occurrences and annotations data structures required by the client-side code.
+        foreach ( $entities as $entity_id => $entity ) {
+            foreach ( $this->json->annotations as $annotation ) {
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                if ( $annotation->entityMatches[0]->entityId === $entity_id ) {
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    $entities[ $entity_id ]['occurrences'][] = $annotation->annotationId;
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    $entities[ $entity_id ]['annotations'][ $annotation->annotationId ]['id'] = $annotation->annotationId;
+                }
+            }
+        }
+
+        $this->json->entities = $entities;
+
+        return $this;
+
+    }
+
+    /**
+     * Return the JSON response.
+     *
+     * @return mixed The JSON response.
+     * @since 3.24.2
+     */
+    public function get_json() {
+
+        return $this->json;
+    }
+
+    /**
+     * This function should be invoked after `make_entities_local` after this
+     * method.
+     *
+     * @param $excluded_uris array An array of entity URIs to be excluded.
+     *
+     * @return $this
+     * @since 3.32.3.1
+     */
+    public function remove_excluded_entities( $excluded_uris ) {
+
+        // If we didnt receive array, return early.
+        if ( ! is_array( $excluded_uris ) ) {
+            return $this;
+        }
+
+        // We may also receive an array of null, make sure to filter uris when receiving.
+        $excluded_uris = array_filter( $excluded_uris, 'is_string' );
+
+        $this->remove_entities_with_excluded_uris( $excluded_uris );
+
+        $this->remove_annotations_with_excluded_uris( $excluded_uris );
+
+        return $this;
+    }
+
+    /**
+     * Get the string representation of the JSON.
+     *
+     * @return false|string The string representation or false in case of error.
+     */
+    public function to_string() {
+
+        // Add the `JSON_UNESCAPED_UNICODE` only for PHP 5.4+.
+        $options = ( version_compare( PHP_VERSION, '5.4', '>=' )
+            ? 256 : 0 );
+
+        return wp_json_encode( $this->json, $options );
+    }
+
+    /**
+     * Remove all the entities with the excluded URIs.
+     *
+     * @param array $excluded_uris The array of URIs to be excluded.
+     */
+    private function remove_entities_with_excluded_uris( array $excluded_uris ) {
+        // Remove the excluded entity uris.
+        if ( isset( $this->json->entities ) ) {
+            foreach ( $excluded_uris as $excluded_uri ) {
+
+                if ( isset( $this->json->entities->{$excluded_uri} ) ) {
+                    // Remove this entity.
+                    unset( $this->json->entities->{$excluded_uri} );
+                    // Also remove the annotations.
+                }
+            }
+        }
+    }
+
+    /**
+     * Remove all the annotations with the excluded entity URIs.
+     *
+     * @param array $excluded_uris The array of URIs to be excluded.
+     *
+     * @return void
+     */
+    private function remove_annotations_with_excluded_uris( array $excluded_uris ) {
+        if ( isset( $this->json->annotations ) ) {
+            foreach ( $this->json->annotations as $annotation_key => &$annotation_data ) {
+
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                if ( ! isset( $annotation_data->entityMatches ) ) {
+                    continue;
+                }
+
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                foreach ( $annotation_data->entityMatches as $entity_match_key => $entity_match_data ) {
+
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    $entity_uri = $entity_match_data->entityId;
+
+                    if ( ! in_array( $entity_uri, $excluded_uris, true ) ) {
+                        continue;
+                    }
+                    // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                    unset( $annotation_data->entityMatches[ $entity_match_key ] );
+                }
+
+                // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+                if ( count( $annotation_data->entityMatches ) === 0 ) {
+                    // Remove the annotation if we have zero empty annotation matches.
+                    unset( $this->json->annotations->{$annotation_key} );
+                }
+            }
+        }
+
+    }
 
 }

Spacing +71 added lines, -71 removed lines

@@ -53,7 +53,7 @@ 
 	 *
 	 * @since 3.21.5
 	 */
-	public function __construct( $entity_uri_service, $entity_helper, $json, $post_id ) {
+	public function __construct($entity_uri_service, $entity_helper, $json, $post_id) {
 		$this->json               = $json;
 		$this->entity_uri_service = $entity_uri_service;
 		$this->entity_helper      = $entity_helper;
@@ -73,24 +73,24 @@ 
 	 */
 	public function make_entities_local() {
 
-		if ( ! isset( $this->json->entities ) ) {
+		if ( ! isset($this->json->entities)) {
 			return $this;
 		}
 
 		// Get the URIs.
-		$uris     = array_keys( get_object_vars( $this->json->entities ) );
-		$mappings = $this->entity_helper->map_many_to_local( $uris );
+		$uris     = array_keys(get_object_vars($this->json->entities));
+		$mappings = $this->entity_helper->map_many_to_local($uris);
 
-		foreach ( $mappings as $external_uri => $internal_uri ) {
+		foreach ($mappings as $external_uri => $internal_uri) {
 
 			// Move the data from the external URI to the internal URI.
-			if ( ! isset( $this->json->entities->{$internal_uri} ) ) {
+			if ( ! isset($this->json->entities->{$internal_uri} )) {
 				$this->json->entities->{$internal_uri} = $this->json->entities->{$external_uri};
 			}
 
 			// Ensure sameAs is an array.
-			if ( ! isset( $this->json->entities->{$internal_uri}->sameAs )
-				 || ! is_array( $this->json->entities->{$internal_uri}->sameAs ) ) {
+			if ( ! isset($this->json->entities->{$internal_uri}->sameAs)
+				 || ! is_array($this->json->entities->{$internal_uri}->sameAs)) {
 				$this->json->entities->{$internal_uri}->sameAs = array();
 			}
 
@@ -98,21 +98,21 @@ 
 			$this->json->entities->{$internal_uri}->sameAs[] = $external_uri;
 
 			// Finally remove the external URI.
-			unset( $this->json->entities->{$external_uri} );
+			unset($this->json->entities->{$external_uri} );
 		}
 
 		// Set the internal uri in the annotation for the entityMatch in annotations.
-		if ( isset( $this->json->annotations ) ) {
+		if (isset($this->json->annotations)) {
 			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			foreach ( $this->json->annotations as $key => $annotation ) {
+			foreach ($this->json->annotations as $key => $annotation) {
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( isset( $annotation->entityMatches ) ) {
+				if (isset($annotation->entityMatches)) {
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					foreach ( $annotation->entityMatches as $match ) {
+					foreach ($annotation->entityMatches as $match) {
 						// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-						if ( isset( $match->entityId ) && isset( $mappings[ $match->entityId ] ) ) {
+						if (isset($match->entityId) && isset($mappings[$match->entityId])) {
 							// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-							$match->entityId = $mappings[ $match->entityId ];
+							$match->entityId = $mappings[$match->entityId];
 						}
 					}
 				}
@@ -134,34 +134,34 @@ 
 	 *
 	 * @link https://github.com/insideout10/wordlift-plugin/issues/1001
 	 */
-	public function add_occurrences( $content ) {
+	public function add_occurrences($content) {
 
 		// Try to get all the disambiguated annotations and bail out if an error occurs.
-		if ( false === preg_match_all(
+		if (false === preg_match_all(
 			'|<span\s+id="([^"]+)"\s+class="textannotation\s+(?:\S+\s+)?disambiguated(?=[\s"])[^"]*"\s+itemid="([^"]*)">(.*?)</span>|',
 			$content,
 			$matches,
 			PREG_OFFSET_CAPTURE
-		) ) {
+		)) {
 			return $this;
 		}
 
-		if ( empty( $matches ) ) {
+		if (empty($matches)) {
 			return $this;
 		}
 
 		$parse_data = array_reduce(
-			range( 0, count( $matches[1] ) - 1 ),
-			function ( $carry, $i ) use ( $matches ) {
-				if ( empty( $matches[0] ) ) {
+			range(0, count($matches[1]) - 1),
+			function($carry, $i) use ($matches) {
+				if (empty($matches[0])) {
 					return $carry;
 				}
 
-				$start         = $matches[0][ $i ][1];
-				$end           = $start + strlen( $matches[0][ $i ][0] );
-				$annotation_id = $matches[1][ $i ][0];
-				$item_id       = $matches[2][ $i ][0];
-				$text          = $matches[3][ $i ][0];
+				$start         = $matches[0][$i][1];
+				$end           = $start + strlen($matches[0][$i][0]);
+				$annotation_id = $matches[1][$i][0];
+				$item_id       = $matches[2][$i][0];
+				$text          = $matches[3][$i][0];
 
 				$annotation = new StdClass();
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
@@ -177,8 +177,8 @@ 
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
 				$annotation->entityMatches[] = $entity_match;
 
-				$carry['annotations'][ $annotation_id ] = $annotation;
-				$carry['occurrences'][ $item_id ][]     = $annotation_id;
+				$carry['annotations'][$annotation_id] = $annotation;
+				$carry['occurrences'][$item_id][]     = $annotation_id;
 
 				return $carry;
 			},
@@ -193,14 +193,14 @@ 
 
 		$entity_provider_registry = Entity_Provider_Registry::get_instance();
 
-		foreach ( array_keys( $occurrences ) as $item_id ) {
+		foreach (array_keys($occurrences) as $item_id) {
 
 			// If the entity isn't there, add it.
-			if ( ! is_bool( $this->json ) && ! isset( $this->json->entities->{$item_id} ) ) {
-				$entity = $entity_provider_registry->get_local_entity( $item_id );
+			if ( ! is_bool($this->json) && ! isset($this->json->entities->{$item_id} )) {
+				$entity = $entity_provider_registry->get_local_entity($item_id);
 
 				// Entity not found in the local vocabulary, continue to the next one.
-				if ( false === $entity ) {
+				if (false === $entity) {
 					continue;
 				}
 
@@ -218,16 +218,16 @@ 
 		// function `preselect`, which was called by src/coffee/editpost-widget/app.services.EditorService.coffee in
 		// `embedAnalysis`.
 
-		if ( ! is_bool( $this->json ) && isset( $this->json->entities ) ) {
-			$occurrences_processor = Occurrences_Factory::get_instance( $this->post_id );
-			$this->json            = $occurrences_processor->add_occurrences_to_entities( $occurrences, $this->json, $this->post_id );
+		if ( ! is_bool($this->json) && isset($this->json->entities)) {
+			$occurrences_processor = Occurrences_Factory::get_instance($this->post_id);
+			$this->json            = $occurrences_processor->add_occurrences_to_entities($occurrences, $this->json, $this->post_id);
 		}
 
 		// Add the missing annotations. This allows the analysis response to work also if we didn't receive results
 		// from the analysis API.
-		foreach ( $annotations as $annotation_id => $annotation ) {
+		foreach ($annotations as $annotation_id => $annotation) {
 
-			if ( ! is_bool( $this->json ) && ! isset( $this->json->annotations->{$annotation_id} ) ) {
+			if ( ! is_bool($this->json) && ! isset($this->json->annotations->{$annotation_id} )) {
 				$this->json->annotations->{$annotation_id} = $annotation;
 			}
 		}
@@ -248,15 +248,15 @@ 
 
 		// Populating the local entities object
 		$entities = array();
-		foreach ( $this->json->annotations as $annotation ) {
+		foreach ($this->json->annotations as $annotation) {
 			// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-			foreach ( $annotation->entityMatches as $entity_matches ) {
+			foreach ($annotation->entityMatches as $entity_matches) {
 
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				$entity_id         = $this->entity_uri_service->get_post_id_from_url( $entity_matches->entityId );
-				$serialized_entity = wl_serialize_entity( $entity_id );
+				$entity_id         = $this->entity_uri_service->get_post_id_from_url($entity_matches->entityId);
+				$serialized_entity = wl_serialize_entity($entity_id);
 
-				if ( $serialized_entity ) {
+				if ($serialized_entity) {
 					$serialized_entity['entityId'] = $serialized_entity['id'];
 					// Keep the `id` for compatibility with existing analysis, since it appears that no-editor-analysis.js
 					// is using it, ie.:
@@ -265,20 +265,20 @@ 
 					// unset( $serialized_entity['id'] );
 
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_matches->entityId ] = $serialized_entity;
+					$entities[$entity_matches->entityId] = $serialized_entity;
 				}
 			}
 		}
 
 		// Adding occurrences and annotations data structures required by the client-side code.
-		foreach ( $entities as $entity_id => $entity ) {
-			foreach ( $this->json->annotations as $annotation ) {
+		foreach ($entities as $entity_id => $entity) {
+			foreach ($this->json->annotations as $annotation) {
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( $annotation->entityMatches[0]->entityId === $entity_id ) {
+				if ($annotation->entityMatches[0]->entityId === $entity_id) {
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_id ]['occurrences'][] = $annotation->annotationId;
+					$entities[$entity_id]['occurrences'][] = $annotation->annotationId;
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					$entities[ $entity_id ]['annotations'][ $annotation->annotationId ]['id'] = $annotation->annotationId;
+					$entities[$entity_id]['annotations'][$annotation->annotationId]['id'] = $annotation->annotationId;
 				}
 			}
 		}
@@ -309,19 +309,19 @@ 
 	 * @return $this
 	 * @since 3.32.3.1
 	 */
-	public function remove_excluded_entities( $excluded_uris ) {
+	public function remove_excluded_entities($excluded_uris) {
 
 		// If we didnt receive array, return early.
-		if ( ! is_array( $excluded_uris ) ) {
+		if ( ! is_array($excluded_uris)) {
 			return $this;
 		}
 
 		// We may also receive an array of null, make sure to filter uris when receiving.
-		$excluded_uris = array_filter( $excluded_uris, 'is_string' );
+		$excluded_uris = array_filter($excluded_uris, 'is_string');
 
-		$this->remove_entities_with_excluded_uris( $excluded_uris );
+		$this->remove_entities_with_excluded_uris($excluded_uris);
 
-		$this->remove_annotations_with_excluded_uris( $excluded_uris );
+		$this->remove_annotations_with_excluded_uris($excluded_uris);
 
 		return $this;
 	}
@@ -334,10 +334,10 @@ 
 	public function to_string() {
 
 		// Add the `JSON_UNESCAPED_UNICODE` only for PHP 5.4+.
-		$options = ( version_compare( PHP_VERSION, '5.4', '>=' )
-			? 256 : 0 );
+		$options = (version_compare(PHP_VERSION, '5.4', '>=')
+			? 256 : 0);
 
-		return wp_json_encode( $this->json, $options );
+		return wp_json_encode($this->json, $options);
 	}
 
 	/**
@@ -345,14 +345,14 @@ 
 	 *
 	 * @param array $excluded_uris The array of URIs to be excluded.
 	 */
-	private function remove_entities_with_excluded_uris( array $excluded_uris ) {
+	private function remove_entities_with_excluded_uris(array $excluded_uris) {
 		// Remove the excluded entity uris.
-		if ( isset( $this->json->entities ) ) {
-			foreach ( $excluded_uris as $excluded_uri ) {
+		if (isset($this->json->entities)) {
+			foreach ($excluded_uris as $excluded_uri) {
 
-				if ( isset( $this->json->entities->{$excluded_uri} ) ) {
+				if (isset($this->json->entities->{$excluded_uri} )) {
 					// Remove this entity.
-					unset( $this->json->entities->{$excluded_uri} );
+					unset($this->json->entities->{$excluded_uri} );
 					// Also remove the annotations.
 				}
 			}
@@ -366,32 +366,32 @@ 
 	 *
 	 * @return void
 	 */
-	private function remove_annotations_with_excluded_uris( array $excluded_uris ) {
-		if ( isset( $this->json->annotations ) ) {
-			foreach ( $this->json->annotations as $annotation_key => &$annotation_data ) {
+	private function remove_annotations_with_excluded_uris(array $excluded_uris) {
+		if (isset($this->json->annotations)) {
+			foreach ($this->json->annotations as $annotation_key => &$annotation_data) {
 
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( ! isset( $annotation_data->entityMatches ) ) {
+				if ( ! isset($annotation_data->entityMatches)) {
 					continue;
 				}
 
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				foreach ( $annotation_data->entityMatches as $entity_match_key => $entity_match_data ) {
+				foreach ($annotation_data->entityMatches as $entity_match_key => $entity_match_data) {
 
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
 					$entity_uri = $entity_match_data->entityId;
 
-					if ( ! in_array( $entity_uri, $excluded_uris, true ) ) {
+					if ( ! in_array($entity_uri, $excluded_uris, true)) {
 						continue;
 					}
 					// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-					unset( $annotation_data->entityMatches[ $entity_match_key ] );
+					unset($annotation_data->entityMatches[$entity_match_key]);
 				}
 
 				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-				if ( count( $annotation_data->entityMatches ) === 0 ) {
+				if (count($annotation_data->entityMatches) === 0) {
 					// Remove the annotation if we have zero empty annotation matches.
-					unset( $this->json->annotations->{$annotation_key} );
+					unset($this->json->annotations->{$annotation_key} );
 				}
 			}
 		}

src/classes/analysis/entity-provider/class-post-entity-provider.php

Indentation +38 added lines, -38 removed lines

@@ -14,41 +14,41 @@ 
 
 class Post_Entity_Provider implements Entity_Provider {
 
-	/**
-	 * @var \Wordlift_Entity_Uri_Service
-	 */
-	private $entity_uri_service;
-	/**
-	 * @var \Wordlift_Entity_Type_Service
-	 */
-	private $entity_type_service;
-	/**
-	 * @var \Wordlift_Post_Image_Storage
-	 */
-	private $post_image_storage;
+    /**
+     * @var \Wordlift_Entity_Uri_Service
+     */
+    private $entity_uri_service;
+    /**
+     * @var \Wordlift_Entity_Type_Service
+     */
+    private $entity_type_service;
+    /**
+     * @var \Wordlift_Post_Image_Storage
+     */
+    private $post_image_storage;
 
-	public function __construct( $entity_uri_service, $entity_type_service, $post_image_storage ) {
-		$this->entity_uri_service  = $entity_uri_service;
-		$this->entity_type_service = $entity_type_service;
-		$this->post_image_storage  = $post_image_storage;
-	}
+    public function __construct( $entity_uri_service, $entity_type_service, $post_image_storage ) {
+        $this->entity_uri_service  = $entity_uri_service;
+        $this->entity_type_service = $entity_type_service;
+        $this->post_image_storage  = $post_image_storage;
+    }
 
-	public function get_entity( $uri ) {
-		$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
+    public function get_entity( $uri ) {
+        $content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
 
-		if ( ! isset( $content ) || ! is_a( $content->get_bag(), '\WP_Post' ) ) {
-			return false;
-		}
+        if ( ! isset( $content ) || ! is_a( $content->get_bag(), '\WP_Post' ) ) {
+            return false;
+        }
 
-		$entity = $content->get_bag();
-		$type   = $this->entity_type_service->get( $entity->ID );
-		$images = $this->post_image_storage->get( $entity->ID );
+        $entity = $content->get_bag();
+        $type   = $this->entity_type_service->get( $entity->ID );
+        $images = $this->post_image_storage->get( $entity->ID );
 
-		return (object) array(
-			'id'          => $uri,
-			'entityId'    => $uri,
-			'label'       => $entity->post_title,
-			/*
+        return (object) array(
+            'id'          => $uri,
+            'entityId'    => $uri,
+            'label'       => $entity->post_title,
+            /*
 			 * As of 2020.06.29 we're comment out the `post_content` because Gutenberg posts will return here
 			 * the whole Gutenberg source including potentially our own wordlift/classification block, which means
 			 * that data may grow quickly to more than a 100 KBytes and could break web servers.
@@ -60,13 +60,13 @@ 
 			 *
 			 * PS: We didn't test using the WordLift Post Excerpt Helper.
 			 */
-			// 'description' => $entity->post_content,
-			'description' => '',
-			'sameAs'      => wl_schema_get_value( $entity->ID, 'sameAs' ),
-			'mainType'    => str_replace( 'wl-', '', $type['css_class'] ),
-			'types'       => wl_get_entity_rdf_types( $entity->ID ),
-			'images'      => $images,
-		);
-	}
+            // 'description' => $entity->post_content,
+            'description' => '',
+            'sameAs'      => wl_schema_get_value( $entity->ID, 'sameAs' ),
+            'mainType'    => str_replace( 'wl-', '', $type['css_class'] ),
+            'types'       => wl_get_entity_rdf_types( $entity->ID ),
+            'images'      => $images,
+        );
+    }
 
 }

src/classes/analysis/entity-provider/class-term-entity-provider.php

Indentation +37 added lines, -37 removed lines

@@ -15,42 +15,42 @@
 
 class Term_Entity_Provider implements Entity_Provider {
 
-	/**
-	 * @var Type_Service
-	 */
-	private $term_type_service;
-
-	public function __construct() {
-		$this->term_type_service = Type_Service::get_instance();
-	}
-
-	public function get_entity( $uri ) {
-
-		$content = Wordpress_Term_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
-
-		if ( ! isset( $content ) ) {
-			return false;
-		}
-
-		$term    = $content->get_bag();
-		$term_id = $term->term_id;
-
-		$schema = $this->term_type_service->get_schema( $term_id );
-		// @todo: For now we dont support images
-		// $images = $this->post_image_storage->get( $term_entity->ID );
-		$same_as = get_term_meta( $term_id, 'entity_same_as' );
-		$same_as = $same_as ? $same_as : array();
-
-		return (object) array(
-			'id'          => $uri,
-			'entityId'    => $uri,
-			'label'       => $term->name,
-			'description' => '',
-			'sameAs'      => $same_as,
-			'mainType'    => str_replace( 'wl-', '', $schema['css_class'] ),
-			'types'       => $this->term_type_service->get_entity_types_labels( $term_id ),
-			'images'      => array(),
-		);
-	}
+    /**
+     * @var Type_Service
+     */
+    private $term_type_service;
+
+    public function __construct() {
+        $this->term_type_service = Type_Service::get_instance();
+    }
+
+    public function get_entity( $uri ) {
+
+        $content = Wordpress_Term_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
+
+        if ( ! isset( $content ) ) {
+            return false;
+        }
+
+        $term    = $content->get_bag();
+        $term_id = $term->term_id;
+
+        $schema = $this->term_type_service->get_schema( $term_id );
+        // @todo: For now we dont support images
+        // $images = $this->post_image_storage->get( $term_entity->ID );
+        $same_as = get_term_meta( $term_id, 'entity_same_as' );
+        $same_as = $same_as ? $same_as : array();
+
+        return (object) array(
+            'id'          => $uri,
+            'entityId'    => $uri,
+            'label'       => $term->name,
+            'description' => '',
+            'sameAs'      => $same_as,
+            'mainType'    => str_replace( 'wl-', '', $schema['css_class'] ),
+            'types'       => $this->term_type_service->get_entity_types_labels( $term_id ),
+            'images'      => array(),
+        );
+    }
 
 }

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

Indentation +778 added lines, -778 removed lines

@@ -13,7 +13,7 @@ 
 use Wordlift\Api\Default_Api_Service;
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -23,786 +23,786 @@ 
  */
 class Wordlift_Configuration_Service {
 
-	/**
-	 * The entity base path option name.
-	 *
-	 * @since 3.6.0
-	 */
-	const ENTITY_BASE_PATH_KEY = 'wl_entity_base_path';
-
-	/**
-	 * The skip wizard (admin installation wizard) option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const SKIP_WIZARD = 'wl_skip_wizard';
-
-	/**
-	 * The skip installation notice.
-	 *
-	 * @since 3.40.3
-	 */
-	const SKIP_INSTALLATION_NOTICE = 'wl_skip_installation_notice';
-
-	/**
-	 * WordLift's key option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const KEY = 'key';
-
-	/**
-	 * WordLift's configured language option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const LANGUAGE = 'site_language';
-
-	/**
-	 * WordLift's configured country code.
-	 *
-	 * @since 3.18.0
-	 */
-	const COUNTRY_CODE = 'country_code';
-
-	/**
-	 * The alternateName option name.
-	 *
-	 * @since 3.38.6
-	 */
-	const ALTERNATE_NAME = 'wl-alternate-name';
-
-	/**
-	 * The publisher entity post ID option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const PUBLISHER_ID = 'publisher_id';
-
-	/**
-	 * The dataset URI option name
-	 *
-	 * @since 3.10.0
-	 */
-	const DATASET_URI = 'redlink_dataset_uri';
-
-	/**
-	 * The link by default option name.
-	 *
-	 * @since 3.11.0
-	 */
-	const LINK_BY_DEFAULT = 'link_by_default';
-
-	/**
-	 * The analytics enable option.
-	 *
-	 * @since 3.21.0
-	 */
-	const ANALYTICS_ENABLE = 'analytics_enable';
-
-	/**
-	 * The analytics entity uri dimension option.
-	 *
-	 * @since 3.21.0
-	 */
-	const ANALYTICS_ENTITY_URI_DIMENSION = 'analytics_entity_uri_dimension';
-
-	/**
-	 * The analytics entity type dimension option.
-	 *
-	 * @since 3.21.0
-	 */
-	const ANALYTICS_ENTITY_TYPE_DIMENSION = 'analytics_entity_type_dimension';
-
-	/**
-	 * The user preferences about sharing data option.
-	 *
-	 * @since 3.19.0
-	 */
-	const SEND_DIAGNOSTIC = 'send_diagnostic';
-
-	/**
-	 * The package type configuration key.
-	 *
-	 * @since 3.20.0
-	 */
-	const PACKAGE_TYPE = 'package_type';
-	/**
-	 * The dataset ids connected to the current key
-	 *
-	 * @since 3.38.5
-	 */
-	const NETWORK_DATASET_IDS = 'network_dataset_ids';
-
-	/**
-	 * The {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var \Wordlift_Log_Service $log The {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a Wordlift_Configuration_Service's instance.
-	 *
-	 * @since 3.6.0
-	 */
-	protected function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		// Sync some configuration properties when key is validated.
-		add_action( 'wl_key_validation_response', array( $this, 'sync' ) );
-
-	}
-
-	/**
-	 * @param $response \Wordlift\Api\Response
-	 *
-	 * @return void
-	 */
-	public function sync( $response ) {
-		if ( ! $response->is_success() ) {
-			return;
-		}
-		$data = json_decode( $response->get_body(), true );
-		if ( ! is_array( $data ) || ! array_key_exists( 'networkDatasetId', $data ) ) {
-			return;
-		}
-		$this->set_network_dataset_ids( $data['networkDatasetId'] );
-	}
-
-	/**
-	 * The Wordlift_Configuration_Service's singleton instance.
-	 *
-	 * @since  3.6.0
-	 *
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $instance Wordlift_Configuration_Service's singleton instance.
-	 */
-	private static $instance = null;
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @return \Wordlift_Configuration_Service
-	 * @since 3.6.0
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get a configuration given the option name and a key. The option value is
-	 * expected to be an array.
-	 *
-	 * @param string $option The option name.
-	 * @param string $key A key in the option value array.
-	 * @param string $default The default value in case the key is not found (by default an empty string).
-	 *
-	 * @return mixed The configuration value or the default value if not found.
-	 * @since 3.6.0
-	 */
-	private function get( $option, $key, $default = '' ) {
-
-		$options = get_option( $option, array() );
-
-		return isset( $options[ $key ] ) ? $options[ $key ] : $default;
-	}
-
-	/**
-	 * Set a configuration parameter.
-	 *
-	 * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
-	 * @param string $key The value key.
-	 * @param mixed  $value The value.
-	 *
-	 * @since 3.9.0
-	 */
-	private function set( $option, $key, $value ) {
-
-		$values         = get_option( $option );
-		$values         = isset( $values ) ? $values : array();
-		$values[ $key ] = $value;
-		update_option( $option, $values );
-
-	}
-
-	/**
-	 * Get the entity base path, by default 'entity'.
-	 *
-	 * @return string The entity base path.
-	 * @since 3.6.0
-	 */
-	public function get_entity_base_path() {
-
-		return $this->get( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity' );
-	}
-
-	/**
-	 * Get the entity base path.
-	 *
-	 * @param string $value The entity base path.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_entity_base_path( $value ) {
-
-		$this->set( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value );
-
-	}
-
-	/**
-	 * Whether the installation skip wizard should be skipped.
-	 *
-	 * @return bool True if it should be skipped otherwise false.
-	 * @since 3.9.0
-	 */
-	public function is_skip_wizard() {
-
-		return $this->get( 'wl_general_settings', self::SKIP_WIZARD, false );
-	}
-
-	/**
-	 * Set the skip wizard parameter.
-	 *
-	 * @param bool $value True to skip the wizard. We expect a boolean value.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_skip_wizard( $value ) {
-
-		$this->set( 'wl_general_settings', self::SKIP_WIZARD, true === $value );
-
-	}
-
-	/**
-	 * Get WordLift's key.
-	 *
-	 * @return string WordLift's key or an empty string if not set.
-	 * @since 3.9.0
-	 */
-	public function get_key() {
-
-		return $this->get( 'wl_general_settings', self::KEY, '' );
-	}
-
-	/**
-	 * Set WordLift's key.
-	 *
-	 * @param string $value WordLift's key.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_key( $value ) {
-
-		$this->set( 'wl_general_settings', self::KEY, $value );
-	}
-
-	/**
-	 * Get WordLift's configured language, by default 'en'.
-	 *
-	 * Note that WordLift's language is used when writing strings to the Linked Data dataset, not for the analysis.
-	 *
-	 * @return string WordLift's configured language code ('en' by default).
-	 * @since 3.9.0
-	 */
-	public function get_language_code() {
-
-		$language = get_locale();
-		if ( ! $language ) {
-			return 'en';
-		}
-
-		return substr( $language, 0, 2 );
-	}
-
-	/**
-	 * @param string $value WordLift's language code.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/1466
-	 *
-	 * Set WordLift's language code, used when storing strings to the Linked Data dataset.
-	 *
-	 * @deprecated As of 3.32.7 this below method has no effect on setting the language, we use the
-	 * language code form WordPress directly.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_language_code( $value ) {
-
-		$this->set( 'wl_general_settings', self::LANGUAGE, $value );
-
-	}
-
-	/**
-	 * Set the user preferences about sharing diagnostic with us.
-	 *
-	 * @param string $value The user preferences(yes/no).
-	 *
-	 * @since 3.19.0
-	 */
-	public function set_diagnostic_preferences( $value ) {
-
-		$this->set( 'wl_general_settings', self::SEND_DIAGNOSTIC, $value );
-
-	}
-
-	/**
-	 * Get the user preferences about sharing diagnostic.
-	 *
-	 * @since 3.19.0
-	 */
-	public function get_diagnostic_preferences() {
-
-		return $this->get( 'wl_general_settings', self::SEND_DIAGNOSTIC, 'no' );
-	}
-
-	/**
-	 * Get WordLift's configured country code, by default 'us'.
-	 *
-	 * @return string WordLift's configured country code ('us' by default).
-	 * @since 3.18.0
-	 */
-	public function get_country_code() {
-
-		return $this->get( 'wl_general_settings', self::COUNTRY_CODE, 'us' );
-	}
-
-	/**
-	 * Set WordLift's country code.
-	 *
-	 * @param string $value WordLift's country code.
-	 *
-	 * @since 3.18.0
-	 */
-	public function set_country_code( $value ) {
-
-		$this->set( 'wl_general_settings', self::COUNTRY_CODE, $value );
-
-	}
-
-	/**
-	 * Get the alternateName.
-	 *
-	 * Website markup alternateName
-	 *
-	 * @return string|NULL alternateName or NULL if not set.
-	 * @since 3.38.6
-	 */
-	public function get_alternate_name() {
-		return $this->get( 'wl_general_settings', self::ALTERNATE_NAME );
-	}
-
-	/**
-	 * Set the alternateName.
-	 *
-	 * @param int $value The alternateName value.
-	 *
-	 * @since 3.38.6
-	 */
-	public function set_alternate_name( $value ) {
-
-		$this->set( 'wl_general_settings', self::ALTERNATE_NAME, wp_strip_all_tags( $value ) );
-
-	}
-
-	/**
-	 * Get the publisher entity post id.
-	 *
-	 * The publisher entity post id points to an entity post which contains the data for the publisher used in schema.org
-	 * Article markup.
-	 *
-	 * @return int|NULL The publisher entity post id or NULL if not set.
-	 * @since 3.9.0
-	 */
-	public function get_publisher_id() {
-
-		return $this->get( 'wl_general_settings', self::PUBLISHER_ID, null );
-	}
-
-	/**
-	 * Set the publisher entity post id.
-	 *
-	 * @param int $value The publisher entity post id.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_publisher_id( $value ) {
-
-		$this->set( 'wl_general_settings', self::PUBLISHER_ID, $value );
-
-	}
-
-	/**
-	 * Get the dataset URI.
-	 *
-	 * @return string The dataset URI or an empty string if not set.
-	 * @since 3.10.0
-	 * @since 3.27.7 Always return null if `wl_features__enable__dataset` is disabled.
-	 */
-	public function get_dataset_uri() {
-
-		if ( apply_filters( 'wl_feature__enable__dataset', true ) ) {
-			return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * Set the dataset URI.
-	 *
-	 * @param string $value The dataset URI.
-	 *
-	 * @since 3.10.0
-	 */
-	public function set_dataset_uri( $value ) {
-
-		$this->set( 'wl_advanced_settings', self::DATASET_URI, $value );
-	}
-
-	/**
-	 * Get the package type.
-	 *
-	 * @return string The package type or an empty string if not set.
-	 * @since 3.20.0
-	 */
-	public function get_package_type() {
-
-		return $this->get( 'wl_advanced_settings', self::PACKAGE_TYPE, null );
-	}
-
-	/**
-	 * Set the package type.
-	 *
-	 * @param string $value The package type.
-	 *
-	 * @since 3.20.0
-	 */
-	public function set_package_type( $value ) {
-		$this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
-	}
-
-	/**
-	 * Intercept the change of the WordLift key in order to set the dataset URI.
-	 *
-	 * @since 3.20.0 as of #761, we save settings every time a key is set, not only when the key changes, so to
-	 *               store the configuration parameters such as country or language.
-	 * @since 3.11.0
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/761
-	 *
-	 * @param array $old_value The old settings.
-	 * @param array $new_value The new settings.
-	 */
-	public function update_key( $old_value, $new_value ) {
-
-		// Check the old key value and the new one. We're going to ask for the dataset URI only if the key has changed.
-		// $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $new_value['key'] ) ? trim( $new_value['key'] ) : '';
-
-		// If the key hasn't changed, don't do anything.
-		// WARN The 'update_option' hook is fired only if the new and old value are not equal.
-		// if ( $old_key === $new_key ) {
-		// return;
-		// }
-
-		// If the key is empty, empty the dataset URI.
-		if ( '' === $new_key ) {
-			$this->set_dataset_uri( '' );
-		}
-
-		// make the request to the remote server.
-		$this->get_remote_dataset_uri( $new_key );
-
-		do_action( 'wl_key_updated' );
-
-	}
-
-	/**
-	 * Handle retrieving the dataset uri from the remote server.
-	 *
-	 * If a valid dataset uri is returned it is stored in the appropriate option,
-	 * otherwise the option is set to empty string.
-	 *
-	 * @param string $key The key to be used.
-	 *
-	 * @since 3.12.0
-	 *
-	 * @since 3.17.0 send the site URL and get the dataset URI.
-	 */
-	public function get_remote_dataset_uri( $key ) {
-
-		$this->log->trace( 'Getting the remote dataset URI and package type...' );
-
-		if ( empty( $key ) ) {
-			$this->log->warn( 'Key set to empty value.' );
-
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
-
-			return;
-		}
-
-		/**
-		 * Allow 3rd parties to change the site_url.
-		 *
-		 * @param string $site_url The site url.
-		 *
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/850
-		 *
-		 * @since 3.20.0
-		 */
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
-
-		// Build the URL.
-		$url = '/accounts'
-			   . '?key=' . rawurlencode( $key )
-			   . '&url=' . rawurlencode( $site_url )
-			   . '&country=' . $this->get_country_code()
-			   . '&language=' . $this->get_language_code();
-
-		$api_service = Default_Api_Service::get_instance();
-		/**
-		 * @since 3.27.7.1
-		 * The Key should be passed to headers, otherwise api would return null.
-		 */
-		$headers  = array(
-			'Authorization' => "Key $key",
-		);
-		$response = $api_service->request( 'PUT', $url, $headers )->get_response();
-
-		// The response is an error.
-		if ( is_wp_error( $response ) ) {
-			$this->log->error( 'An error occurred setting the dataset URI: ' . $response->get_error_message() );
-
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
-
-			return;
-		}
-
-		// The response is not OK.
-		if ( ! is_array( $response ) || 200 !== (int) $response['response']['code'] ) {
-			$base_url = $api_service->get_base_url();
-
-			if ( ! is_array( $response ) ) {
-				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
-			} else {
-				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected status code when opening URL $base_url$url: " . $response['response']['code'] . "\n" . var_export( $response, true ) );
-			}
-
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
-
-			return;
-		}
-
-		/*
+    /**
+     * The entity base path option name.
+     *
+     * @since 3.6.0
+     */
+    const ENTITY_BASE_PATH_KEY = 'wl_entity_base_path';
+
+    /**
+     * The skip wizard (admin installation wizard) option name.
+     *
+     * @since 3.9.0
+     */
+    const SKIP_WIZARD = 'wl_skip_wizard';
+
+    /**
+     * The skip installation notice.
+     *
+     * @since 3.40.3
+     */
+    const SKIP_INSTALLATION_NOTICE = 'wl_skip_installation_notice';
+
+    /**
+     * WordLift's key option name.
+     *
+     * @since 3.9.0
+     */
+    const KEY = 'key';
+
+    /**
+     * WordLift's configured language option name.
+     *
+     * @since 3.9.0
+     */
+    const LANGUAGE = 'site_language';
+
+    /**
+     * WordLift's configured country code.
+     *
+     * @since 3.18.0
+     */
+    const COUNTRY_CODE = 'country_code';
+
+    /**
+     * The alternateName option name.
+     *
+     * @since 3.38.6
+     */
+    const ALTERNATE_NAME = 'wl-alternate-name';
+
+    /**
+     * The publisher entity post ID option name.
+     *
+     * @since 3.9.0
+     */
+    const PUBLISHER_ID = 'publisher_id';
+
+    /**
+     * The dataset URI option name
+     *
+     * @since 3.10.0
+     */
+    const DATASET_URI = 'redlink_dataset_uri';
+
+    /**
+     * The link by default option name.
+     *
+     * @since 3.11.0
+     */
+    const LINK_BY_DEFAULT = 'link_by_default';
+
+    /**
+     * The analytics enable option.
+     *
+     * @since 3.21.0
+     */
+    const ANALYTICS_ENABLE = 'analytics_enable';
+
+    /**
+     * The analytics entity uri dimension option.
+     *
+     * @since 3.21.0
+     */
+    const ANALYTICS_ENTITY_URI_DIMENSION = 'analytics_entity_uri_dimension';
+
+    /**
+     * The analytics entity type dimension option.
+     *
+     * @since 3.21.0
+     */
+    const ANALYTICS_ENTITY_TYPE_DIMENSION = 'analytics_entity_type_dimension';
+
+    /**
+     * The user preferences about sharing data option.
+     *
+     * @since 3.19.0
+     */
+    const SEND_DIAGNOSTIC = 'send_diagnostic';
+
+    /**
+     * The package type configuration key.
+     *
+     * @since 3.20.0
+     */
+    const PACKAGE_TYPE = 'package_type';
+    /**
+     * The dataset ids connected to the current key
+     *
+     * @since 3.38.5
+     */
+    const NETWORK_DATASET_IDS = 'network_dataset_ids';
+
+    /**
+     * The {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var \Wordlift_Log_Service $log The {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a Wordlift_Configuration_Service's instance.
+     *
+     * @since 3.6.0
+     */
+    protected function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        // Sync some configuration properties when key is validated.
+        add_action( 'wl_key_validation_response', array( $this, 'sync' ) );
+
+    }
+
+    /**
+     * @param $response \Wordlift\Api\Response
+     *
+     * @return void
+     */
+    public function sync( $response ) {
+        if ( ! $response->is_success() ) {
+            return;
+        }
+        $data = json_decode( $response->get_body(), true );
+        if ( ! is_array( $data ) || ! array_key_exists( 'networkDatasetId', $data ) ) {
+            return;
+        }
+        $this->set_network_dataset_ids( $data['networkDatasetId'] );
+    }
+
+    /**
+     * The Wordlift_Configuration_Service's singleton instance.
+     *
+     * @since  3.6.0
+     *
+     * @access private
+     * @var \Wordlift_Configuration_Service $instance Wordlift_Configuration_Service's singleton instance.
+     */
+    private static $instance = null;
+
+    /**
+     * Get the singleton instance.
+     *
+     * @return \Wordlift_Configuration_Service
+     * @since 3.6.0
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Get a configuration given the option name and a key. The option value is
+     * expected to be an array.
+     *
+     * @param string $option The option name.
+     * @param string $key A key in the option value array.
+     * @param string $default The default value in case the key is not found (by default an empty string).
+     *
+     * @return mixed The configuration value or the default value if not found.
+     * @since 3.6.0
+     */
+    private function get( $option, $key, $default = '' ) {
+
+        $options = get_option( $option, array() );
+
+        return isset( $options[ $key ] ) ? $options[ $key ] : $default;
+    }
+
+    /**
+     * Set a configuration parameter.
+     *
+     * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
+     * @param string $key The value key.
+     * @param mixed  $value The value.
+     *
+     * @since 3.9.0
+     */
+    private function set( $option, $key, $value ) {
+
+        $values         = get_option( $option );
+        $values         = isset( $values ) ? $values : array();
+        $values[ $key ] = $value;
+        update_option( $option, $values );
+
+    }
+
+    /**
+     * Get the entity base path, by default 'entity'.
+     *
+     * @return string The entity base path.
+     * @since 3.6.0
+     */
+    public function get_entity_base_path() {
+
+        return $this->get( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity' );
+    }
+
+    /**
+     * Get the entity base path.
+     *
+     * @param string $value The entity base path.
+     *
+     * @since 3.9.0
+     */
+    public function set_entity_base_path( $value ) {
+
+        $this->set( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value );
+
+    }
+
+    /**
+     * Whether the installation skip wizard should be skipped.
+     *
+     * @return bool True if it should be skipped otherwise false.
+     * @since 3.9.0
+     */
+    public function is_skip_wizard() {
+
+        return $this->get( 'wl_general_settings', self::SKIP_WIZARD, false );
+    }
+
+    /**
+     * Set the skip wizard parameter.
+     *
+     * @param bool $value True to skip the wizard. We expect a boolean value.
+     *
+     * @since 3.9.0
+     */
+    public function set_skip_wizard( $value ) {
+
+        $this->set( 'wl_general_settings', self::SKIP_WIZARD, true === $value );
+
+    }
+
+    /**
+     * Get WordLift's key.
+     *
+     * @return string WordLift's key or an empty string if not set.
+     * @since 3.9.0
+     */
+    public function get_key() {
+
+        return $this->get( 'wl_general_settings', self::KEY, '' );
+    }
+
+    /**
+     * Set WordLift's key.
+     *
+     * @param string $value WordLift's key.
+     *
+     * @since 3.9.0
+     */
+    public function set_key( $value ) {
+
+        $this->set( 'wl_general_settings', self::KEY, $value );
+    }
+
+    /**
+     * Get WordLift's configured language, by default 'en'.
+     *
+     * Note that WordLift's language is used when writing strings to the Linked Data dataset, not for the analysis.
+     *
+     * @return string WordLift's configured language code ('en' by default).
+     * @since 3.9.0
+     */
+    public function get_language_code() {
+
+        $language = get_locale();
+        if ( ! $language ) {
+            return 'en';
+        }
+
+        return substr( $language, 0, 2 );
+    }
+
+    /**
+     * @param string $value WordLift's language code.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/1466
+     *
+     * Set WordLift's language code, used when storing strings to the Linked Data dataset.
+     *
+     * @deprecated As of 3.32.7 this below method has no effect on setting the language, we use the
+     * language code form WordPress directly.
+     *
+     * @since 3.9.0
+     */
+    public function set_language_code( $value ) {
+
+        $this->set( 'wl_general_settings', self::LANGUAGE, $value );
+
+    }
+
+    /**
+     * Set the user preferences about sharing diagnostic with us.
+     *
+     * @param string $value The user preferences(yes/no).
+     *
+     * @since 3.19.0
+     */
+    public function set_diagnostic_preferences( $value ) {
+
+        $this->set( 'wl_general_settings', self::SEND_DIAGNOSTIC, $value );
+
+    }
+
+    /**
+     * Get the user preferences about sharing diagnostic.
+     *
+     * @since 3.19.0
+     */
+    public function get_diagnostic_preferences() {
+
+        return $this->get( 'wl_general_settings', self::SEND_DIAGNOSTIC, 'no' );
+    }
+
+    /**
+     * Get WordLift's configured country code, by default 'us'.
+     *
+     * @return string WordLift's configured country code ('us' by default).
+     * @since 3.18.0
+     */
+    public function get_country_code() {
+
+        return $this->get( 'wl_general_settings', self::COUNTRY_CODE, 'us' );
+    }
+
+    /**
+     * Set WordLift's country code.
+     *
+     * @param string $value WordLift's country code.
+     *
+     * @since 3.18.0
+     */
+    public function set_country_code( $value ) {
+
+        $this->set( 'wl_general_settings', self::COUNTRY_CODE, $value );
+
+    }
+
+    /**
+     * Get the alternateName.
+     *
+     * Website markup alternateName
+     *
+     * @return string|NULL alternateName or NULL if not set.
+     * @since 3.38.6
+     */
+    public function get_alternate_name() {
+        return $this->get( 'wl_general_settings', self::ALTERNATE_NAME );
+    }
+
+    /**
+     * Set the alternateName.
+     *
+     * @param int $value The alternateName value.
+     *
+     * @since 3.38.6
+     */
+    public function set_alternate_name( $value ) {
+
+        $this->set( 'wl_general_settings', self::ALTERNATE_NAME, wp_strip_all_tags( $value ) );
+
+    }
+
+    /**
+     * Get the publisher entity post id.
+     *
+     * The publisher entity post id points to an entity post which contains the data for the publisher used in schema.org
+     * Article markup.
+     *
+     * @return int|NULL The publisher entity post id or NULL if not set.
+     * @since 3.9.0
+     */
+    public function get_publisher_id() {
+
+        return $this->get( 'wl_general_settings', self::PUBLISHER_ID, null );
+    }
+
+    /**
+     * Set the publisher entity post id.
+     *
+     * @param int $value The publisher entity post id.
+     *
+     * @since 3.9.0
+     */
+    public function set_publisher_id( $value ) {
+
+        $this->set( 'wl_general_settings', self::PUBLISHER_ID, $value );
+
+    }
+
+    /**
+     * Get the dataset URI.
+     *
+     * @return string The dataset URI or an empty string if not set.
+     * @since 3.10.0
+     * @since 3.27.7 Always return null if `wl_features__enable__dataset` is disabled.
+     */
+    public function get_dataset_uri() {
+
+        if ( apply_filters( 'wl_feature__enable__dataset', true ) ) {
+            return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Set the dataset URI.
+     *
+     * @param string $value The dataset URI.
+     *
+     * @since 3.10.0
+     */
+    public function set_dataset_uri( $value ) {
+
+        $this->set( 'wl_advanced_settings', self::DATASET_URI, $value );
+    }
+
+    /**
+     * Get the package type.
+     *
+     * @return string The package type or an empty string if not set.
+     * @since 3.20.0
+     */
+    public function get_package_type() {
+
+        return $this->get( 'wl_advanced_settings', self::PACKAGE_TYPE, null );
+    }
+
+    /**
+     * Set the package type.
+     *
+     * @param string $value The package type.
+     *
+     * @since 3.20.0
+     */
+    public function set_package_type( $value ) {
+        $this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
+    }
+
+    /**
+     * Intercept the change of the WordLift key in order to set the dataset URI.
+     *
+     * @since 3.20.0 as of #761, we save settings every time a key is set, not only when the key changes, so to
+     *               store the configuration parameters such as country or language.
+     * @since 3.11.0
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/761
+     *
+     * @param array $old_value The old settings.
+     * @param array $new_value The new settings.
+     */
+    public function update_key( $old_value, $new_value ) {
+
+        // Check the old key value and the new one. We're going to ask for the dataset URI only if the key has changed.
+        // $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
+        $new_key = isset( $new_value['key'] ) ? trim( $new_value['key'] ) : '';
+
+        // If the key hasn't changed, don't do anything.
+        // WARN The 'update_option' hook is fired only if the new and old value are not equal.
+        // if ( $old_key === $new_key ) {
+        // return;
+        // }
+
+        // If the key is empty, empty the dataset URI.
+        if ( '' === $new_key ) {
+            $this->set_dataset_uri( '' );
+        }
+
+        // make the request to the remote server.
+        $this->get_remote_dataset_uri( $new_key );
+
+        do_action( 'wl_key_updated' );
+
+    }
+
+    /**
+     * Handle retrieving the dataset uri from the remote server.
+     *
+     * If a valid dataset uri is returned it is stored in the appropriate option,
+     * otherwise the option is set to empty string.
+     *
+     * @param string $key The key to be used.
+     *
+     * @since 3.12.0
+     *
+     * @since 3.17.0 send the site URL and get the dataset URI.
+     */
+    public function get_remote_dataset_uri( $key ) {
+
+        $this->log->trace( 'Getting the remote dataset URI and package type...' );
+
+        if ( empty( $key ) ) {
+            $this->log->warn( 'Key set to empty value.' );
+
+            $this->set_dataset_uri( '' );
+            $this->set_package_type( null );
+
+            return;
+        }
+
+        /**
+         * Allow 3rd parties to change the site_url.
+         *
+         * @param string $site_url The site url.
+         *
+         * @see https://github.com/insideout10/wordlift-plugin/issues/850
+         *
+         * @since 3.20.0
+         */
+        $home_url = get_option( 'home' );
+        $site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+
+        // Build the URL.
+        $url = '/accounts'
+                . '?key=' . rawurlencode( $key )
+                . '&url=' . rawurlencode( $site_url )
+                . '&country=' . $this->get_country_code()
+                . '&language=' . $this->get_language_code();
+
+        $api_service = Default_Api_Service::get_instance();
+        /**
+         * @since 3.27.7.1
+         * The Key should be passed to headers, otherwise api would return null.
+         */
+        $headers  = array(
+            'Authorization' => "Key $key",
+        );
+        $response = $api_service->request( 'PUT', $url, $headers )->get_response();
+
+        // The response is an error.
+        if ( is_wp_error( $response ) ) {
+            $this->log->error( 'An error occurred setting the dataset URI: ' . $response->get_error_message() );
+
+            $this->set_dataset_uri( '' );
+            $this->set_package_type( null );
+
+            return;
+        }
+
+        // The response is not OK.
+        if ( ! is_array( $response ) || 200 !== (int) $response['response']['code'] ) {
+            $base_url = $api_service->get_base_url();
+
+            if ( ! is_array( $response ) ) {
+                // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
+                $this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
+            } else {
+                // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
+                $this->log->error( "Unexpected status code when opening URL $base_url$url: " . $response['response']['code'] . "\n" . var_export( $response, true ) );
+            }
+
+            $this->set_dataset_uri( '' );
+            $this->set_package_type( null );
+
+            return;
+        }
+
+        /*
 		 * We also store the package type.
 		 *
 		 * @since 3.20.0
 		 */
-		$json = json_decode( $response['body'] );
-		/**
-		 * @since 3.27.7
-		 * Remove the trailing slash returned from the new platform api.
-		 */
-		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$dataset_uri = untrailingslashit( $json->datasetURI );
-		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$package_type = isset( $json->packageType ) ? $json->packageType : null;
-
-		$this->log->info( "Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]..." );
-
-		$this->set_dataset_uri( $dataset_uri );
-		$this->set_package_type( $package_type );
-	}
-
-	/**
-	 * Handle the edge case where a user submits the same key again
-	 * when he does not have the dataset uri to regain it.
-	 *
-	 * This can not be handled in the normal option update hook because
-	 * it is not being triggered when the save value equals to the one already
-	 * in the DB.
-	 *
-	 * @param mixed $value The new, unserialized option value.
-	 * @param mixed $old_value The old option value.
-	 *
-	 * @return mixed The same value in the $value parameter
-	 * @since 3.12.0
-	 */
-	public function maybe_update_dataset_uri( $value, $old_value ) {
-
-		// Check the old key value and the new one. Here we're only handling the
-		// case where the key hasn't changed and the dataset URI isn't set. The
-		// other case, i.e. a new key is inserted, is handled at `update_key`.
-		$old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $value['key'] ) ? trim( $value['key'] ) : '';
-
-		$dataset_uri = $this->get_dataset_uri();
-
-		if ( ! empty( $new_key ) && $new_key === $old_key && empty( $dataset_uri ) ) {
-
-			// make the request to the remote server to try to get the dataset uri.
-			$this->get_remote_dataset_uri( $new_key );
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Get the API URI to retrieve the dataset URI using the WordLift Key.
-	 *
-	 * @param string $key The WordLift key to use.
-	 *
-	 * @return string The API URI.
-	 * @since 3.11.0
-	 */
-	public function get_accounts_by_key_dataset_uri( $key ) {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/key=$key/dataset_uri";
-	}
-
-	/**
-	 * Get the `accounts` end point.
-	 *
-	 * @return string The `accounts` end point.
-	 * @since 3.16.0
-	 */
-	public function get_accounts() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
-	}
-
-	/**
-	 * Get the `link by default` option.
-	 *
-	 * @return bool True if entities must be linked by default otherwise false.
-	 * @since 3.13.0
-	 */
-	public function is_link_by_default() {
-
-		return 'yes' === $this->get( 'wl_general_settings', self::LINK_BY_DEFAULT, 'yes' );
-	}
-
-	/**
-	 * Set the `link by default` option.
-	 *
-	 * @param bool $value True to enabling linking by default, otherwise false.
-	 *
-	 * @since 3.13.0
-	 */
-	public function set_link_by_default( $value ) {
-
-		$this->set( 'wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no' );
-	}
-
-	/**
-	 * Get the 'analytics-enable' option.
-	 *
-	 * @return string 'no' or 'yes' representing bool.
-	 * @since 3.21.0
-	 */
-	public function is_analytics_enable() {
-		return 'yes' === $this->get( 'wl_analytics_settings', self::ANALYTICS_ENABLE, 'no' );
-	}
-
-	/**
-	 * Set the `analytics-enable` option.
-	 *
-	 * @param bool $value True to enabling analytics, otherwise false.
-	 *
-	 * @since 3.21.0
-	 */
-	public function set_is_analytics_enable( $value ) {
-
-		$this->set( 'wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no' );
-	}
-
-	/**
-	 * Get the 'analytics-entity-uri-dimention' option.
-	 *
-	 * @return int
-	 * @since 3.21.0
-	 */
-	public function get_analytics_entity_uri_dimension() {
-		return (int) $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1 );
-	}
-
-	/**
-	 * Get the 'analytics-entity-type-dimension' option.
-	 *
-	 * @return int
-	 * @since 3.21.0
-	 */
-	public function get_analytics_entity_type_dimension() {
-		return $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2 );
-	}
-
-	/**
-	 * Get the URL to perform autocomplete request.
-	 *
-	 * @return string The URL to call to perform the autocomplete request.
-	 * @since 3.15.0
-	 */
-	public function get_autocomplete_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
-
-	}
-
-	/**
-	 * Get the URL to perform feedback deactivation request.
-	 *
-	 * @return string The URL to call to perform the feedback deactivation request.
-	 * @since 3.19.0
-	 */
-	public function get_deactivation_feedback_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'feedbacks';
-
-	}
-
-	/**
-	 * Get the base API URL.
-	 *
-	 * @return string The base API URL.
-	 * @since 3.20.0
-	 */
-	public function get_api_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE;
-	}
-
-	public function get_network_dataset_ids() {
-		return $this->get( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, array() );
-	}
-
-	public function set_network_dataset_ids( $network_dataset_ids ) {
-		$this->set( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, $network_dataset_ids );
-	}
-
-	public function get_skip_installation_notice() {
-
-		return $this->get( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, false );
-	}
-
-	public function set_skip_installation_notice( $value ) {
-
-		$this->set( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, $value );
-
-	}
+        $json = json_decode( $response['body'] );
+        /**
+         * @since 3.27.7
+         * Remove the trailing slash returned from the new platform api.
+         */
+        // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+        $dataset_uri = untrailingslashit( $json->datasetURI );
+        // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+        $package_type = isset( $json->packageType ) ? $json->packageType : null;
+
+        $this->log->info( "Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]..." );
+
+        $this->set_dataset_uri( $dataset_uri );
+        $this->set_package_type( $package_type );
+    }
+
+    /**
+     * Handle the edge case where a user submits the same key again
+     * when he does not have the dataset uri to regain it.
+     *
+     * This can not be handled in the normal option update hook because
+     * it is not being triggered when the save value equals to the one already
+     * in the DB.
+     *
+     * @param mixed $value The new, unserialized option value.
+     * @param mixed $old_value The old option value.
+     *
+     * @return mixed The same value in the $value parameter
+     * @since 3.12.0
+     */
+    public function maybe_update_dataset_uri( $value, $old_value ) {
+
+        // Check the old key value and the new one. Here we're only handling the
+        // case where the key hasn't changed and the dataset URI isn't set. The
+        // other case, i.e. a new key is inserted, is handled at `update_key`.
+        $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
+        $new_key = isset( $value['key'] ) ? trim( $value['key'] ) : '';
+
+        $dataset_uri = $this->get_dataset_uri();
+
+        if ( ! empty( $new_key ) && $new_key === $old_key && empty( $dataset_uri ) ) {
+
+            // make the request to the remote server to try to get the dataset uri.
+            $this->get_remote_dataset_uri( $new_key );
+        }
+
+        return $value;
+    }
+
+    /**
+     * Get the API URI to retrieve the dataset URI using the WordLift Key.
+     *
+     * @param string $key The WordLift key to use.
+     *
+     * @return string The API URI.
+     * @since 3.11.0
+     */
+    public function get_accounts_by_key_dataset_uri( $key ) {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/key=$key/dataset_uri";
+    }
+
+    /**
+     * Get the `accounts` end point.
+     *
+     * @return string The `accounts` end point.
+     * @since 3.16.0
+     */
+    public function get_accounts() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
+    }
+
+    /**
+     * Get the `link by default` option.
+     *
+     * @return bool True if entities must be linked by default otherwise false.
+     * @since 3.13.0
+     */
+    public function is_link_by_default() {
+
+        return 'yes' === $this->get( 'wl_general_settings', self::LINK_BY_DEFAULT, 'yes' );
+    }
+
+    /**
+     * Set the `link by default` option.
+     *
+     * @param bool $value True to enabling linking by default, otherwise false.
+     *
+     * @since 3.13.0
+     */
+    public function set_link_by_default( $value ) {
+
+        $this->set( 'wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no' );
+    }
+
+    /**
+     * Get the 'analytics-enable' option.
+     *
+     * @return string 'no' or 'yes' representing bool.
+     * @since 3.21.0
+     */
+    public function is_analytics_enable() {
+        return 'yes' === $this->get( 'wl_analytics_settings', self::ANALYTICS_ENABLE, 'no' );
+    }
+
+    /**
+     * Set the `analytics-enable` option.
+     *
+     * @param bool $value True to enabling analytics, otherwise false.
+     *
+     * @since 3.21.0
+     */
+    public function set_is_analytics_enable( $value ) {
+
+        $this->set( 'wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no' );
+    }
+
+    /**
+     * Get the 'analytics-entity-uri-dimention' option.
+     *
+     * @return int
+     * @since 3.21.0
+     */
+    public function get_analytics_entity_uri_dimension() {
+        return (int) $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1 );
+    }
+
+    /**
+     * Get the 'analytics-entity-type-dimension' option.
+     *
+     * @return int
+     * @since 3.21.0
+     */
+    public function get_analytics_entity_type_dimension() {
+        return $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2 );
+    }
+
+    /**
+     * Get the URL to perform autocomplete request.
+     *
+     * @return string The URL to call to perform the autocomplete request.
+     * @since 3.15.0
+     */
+    public function get_autocomplete_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
+
+    }
+
+    /**
+     * Get the URL to perform feedback deactivation request.
+     *
+     * @return string The URL to call to perform the feedback deactivation request.
+     * @since 3.19.0
+     */
+    public function get_deactivation_feedback_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'feedbacks';
+
+    }
+
+    /**
+     * Get the base API URL.
+     *
+     * @return string The base API URL.
+     * @since 3.20.0
+     */
+    public function get_api_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE;
+    }
+
+    public function get_network_dataset_ids() {
+        return $this->get( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, array() );
+    }
+
+    public function set_network_dataset_ids( $network_dataset_ids ) {
+        $this->set( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, $network_dataset_ids );
+    }
+
+    public function get_skip_installation_notice() {
+
+        return $this->get( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, false );
+    }
+
+    public function set_skip_installation_notice( $value ) {
+
+        $this->set( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, $value );
+
+    }
 
 }

Spacing +108 added lines, -108 removed lines

@@ -12,7 +12,7 @@ 
 
 use Wordlift\Api\Default_Api_Service;
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -150,10 +150,10 @@ 
 	 */
 	protected function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		// Sync some configuration properties when key is validated.
-		add_action( 'wl_key_validation_response', array( $this, 'sync' ) );
+		add_action('wl_key_validation_response', array($this, 'sync'));
 
 	}
 
@@ -162,15 +162,15 @@ 
 	 *
 	 * @return void
 	 */
-	public function sync( $response ) {
-		if ( ! $response->is_success() ) {
+	public function sync($response) {
+		if ( ! $response->is_success()) {
 			return;
 		}
-		$data = json_decode( $response->get_body(), true );
-		if ( ! is_array( $data ) || ! array_key_exists( 'networkDatasetId', $data ) ) {
+		$data = json_decode($response->get_body(), true);
+		if ( ! is_array($data) || ! array_key_exists('networkDatasetId', $data)) {
 			return;
 		}
-		$this->set_network_dataset_ids( $data['networkDatasetId'] );
+		$this->set_network_dataset_ids($data['networkDatasetId']);
 	}
 
 	/**
@@ -191,7 +191,7 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -209,11 +209,11 @@ 
 	 * @return mixed The configuration value or the default value if not found.
 	 * @since 3.6.0
 	 */
-	private function get( $option, $key, $default = '' ) {
+	private function get($option, $key, $default = '') {
 
-		$options = get_option( $option, array() );
+		$options = get_option($option, array());
 
-		return isset( $options[ $key ] ) ? $options[ $key ] : $default;
+		return isset($options[$key]) ? $options[$key] : $default;
 	}
 
 	/**
@@ -225,12 +225,12 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	private function set( $option, $key, $value ) {
+	private function set($option, $key, $value) {
 
-		$values         = get_option( $option );
-		$values         = isset( $values ) ? $values : array();
-		$values[ $key ] = $value;
-		update_option( $option, $values );
+		$values         = get_option($option);
+		$values         = isset($values) ? $values : array();
+		$values[$key] = $value;
+		update_option($option, $values);
 
 	}
 
@@ -242,7 +242,7 @@ 
 	 */
 	public function get_entity_base_path() {
 
-		return $this->get( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity' );
+		return $this->get('wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity');
 	}
 
 	/**
@@ -252,9 +252,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	public function set_entity_base_path( $value ) {
+	public function set_entity_base_path($value) {
 
-		$this->set( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value );
+		$this->set('wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value);
 
 	}
 
@@ -266,7 +266,7 @@ 
 	 */
 	public function is_skip_wizard() {
 
-		return $this->get( 'wl_general_settings', self::SKIP_WIZARD, false );
+		return $this->get('wl_general_settings', self::SKIP_WIZARD, false);
 	}
 
 	/**
@@ -276,9 +276,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	public function set_skip_wizard( $value ) {
+	public function set_skip_wizard($value) {
 
-		$this->set( 'wl_general_settings', self::SKIP_WIZARD, true === $value );
+		$this->set('wl_general_settings', self::SKIP_WIZARD, true === $value);
 
 	}
 
@@ -290,7 +290,7 @@ 
 	 */
 	public function get_key() {
 
-		return $this->get( 'wl_general_settings', self::KEY, '' );
+		return $this->get('wl_general_settings', self::KEY, '');
 	}
 
 	/**
@@ -300,9 +300,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	public function set_key( $value ) {
+	public function set_key($value) {
 
-		$this->set( 'wl_general_settings', self::KEY, $value );
+		$this->set('wl_general_settings', self::KEY, $value);
 	}
 
 	/**
@@ -316,11 +316,11 @@ 
 	public function get_language_code() {
 
 		$language = get_locale();
-		if ( ! $language ) {
+		if ( ! $language) {
 			return 'en';
 		}
 
-		return substr( $language, 0, 2 );
+		return substr($language, 0, 2);
 	}
 
 	/**
@@ -335,9 +335,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	public function set_language_code( $value ) {
+	public function set_language_code($value) {
 
-		$this->set( 'wl_general_settings', self::LANGUAGE, $value );
+		$this->set('wl_general_settings', self::LANGUAGE, $value);
 
 	}
 
@@ -348,9 +348,9 @@ 
 	 *
 	 * @since 3.19.0
 	 */
-	public function set_diagnostic_preferences( $value ) {
+	public function set_diagnostic_preferences($value) {
 
-		$this->set( 'wl_general_settings', self::SEND_DIAGNOSTIC, $value );
+		$this->set('wl_general_settings', self::SEND_DIAGNOSTIC, $value);
 
 	}
 
@@ -361,7 +361,7 @@ 
 	 */
 	public function get_diagnostic_preferences() {
 
-		return $this->get( 'wl_general_settings', self::SEND_DIAGNOSTIC, 'no' );
+		return $this->get('wl_general_settings', self::SEND_DIAGNOSTIC, 'no');
 	}
 
 	/**
@@ -372,7 +372,7 @@ 
 	 */
 	public function get_country_code() {
 
-		return $this->get( 'wl_general_settings', self::COUNTRY_CODE, 'us' );
+		return $this->get('wl_general_settings', self::COUNTRY_CODE, 'us');
 	}
 
 	/**
@@ -382,9 +382,9 @@ 
 	 *
 	 * @since 3.18.0
 	 */
-	public function set_country_code( $value ) {
+	public function set_country_code($value) {
 
-		$this->set( 'wl_general_settings', self::COUNTRY_CODE, $value );
+		$this->set('wl_general_settings', self::COUNTRY_CODE, $value);
 
 	}
 
@@ -397,7 +397,7 @@ 
 	 * @since 3.38.6
 	 */
 	public function get_alternate_name() {
-		return $this->get( 'wl_general_settings', self::ALTERNATE_NAME );
+		return $this->get('wl_general_settings', self::ALTERNATE_NAME);
 	}
 
 	/**
@@ -407,9 +407,9 @@ 
 	 *
 	 * @since 3.38.6
 	 */
-	public function set_alternate_name( $value ) {
+	public function set_alternate_name($value) {
 
-		$this->set( 'wl_general_settings', self::ALTERNATE_NAME, wp_strip_all_tags( $value ) );
+		$this->set('wl_general_settings', self::ALTERNATE_NAME, wp_strip_all_tags($value));
 
 	}
 
@@ -424,7 +424,7 @@ 
 	 */
 	public function get_publisher_id() {
 
-		return $this->get( 'wl_general_settings', self::PUBLISHER_ID, null );
+		return $this->get('wl_general_settings', self::PUBLISHER_ID, null);
 	}
 
 	/**
@@ -434,9 +434,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	public function set_publisher_id( $value ) {
+	public function set_publisher_id($value) {
 
-		$this->set( 'wl_general_settings', self::PUBLISHER_ID, $value );
+		$this->set('wl_general_settings', self::PUBLISHER_ID, $value);
 
 	}
 
@@ -449,8 +449,8 @@ 
 	 */
 	public function get_dataset_uri() {
 
-		if ( apply_filters( 'wl_feature__enable__dataset', true ) ) {
-			return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
+		if (apply_filters('wl_feature__enable__dataset', true)) {
+			return $this->get('wl_advanced_settings', self::DATASET_URI, null);
 		} else {
 			return null;
 		}
@@ -463,9 +463,9 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	public function set_dataset_uri( $value ) {
+	public function set_dataset_uri($value) {
 
-		$this->set( 'wl_advanced_settings', self::DATASET_URI, $value );
+		$this->set('wl_advanced_settings', self::DATASET_URI, $value);
 	}
 
 	/**
@@ -476,7 +476,7 @@ 
 	 */
 	public function get_package_type() {
 
-		return $this->get( 'wl_advanced_settings', self::PACKAGE_TYPE, null );
+		return $this->get('wl_advanced_settings', self::PACKAGE_TYPE, null);
 	}
 
 	/**
@@ -486,8 +486,8 @@ 
 	 *
 	 * @since 3.20.0
 	 */
-	public function set_package_type( $value ) {
-		$this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
+	public function set_package_type($value) {
+		$this->set('wl_advanced_settings', self::PACKAGE_TYPE, $value);
 	}
 
 	/**
@@ -502,11 +502,11 @@ 
 	 * @param array $old_value The old settings.
 	 * @param array $new_value The new settings.
 	 */
-	public function update_key( $old_value, $new_value ) {
+	public function update_key($old_value, $new_value) {
 
 		// Check the old key value and the new one. We're going to ask for the dataset URI only if the key has changed.
 		// $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $new_value['key'] ) ? trim( $new_value['key'] ) : '';
+		$new_key = isset($new_value['key']) ? trim($new_value['key']) : '';
 
 		// If the key hasn't changed, don't do anything.
 		// WARN The 'update_option' hook is fired only if the new and old value are not equal.
@@ -515,14 +515,14 @@ 
 		// }
 
 		// If the key is empty, empty the dataset URI.
-		if ( '' === $new_key ) {
-			$this->set_dataset_uri( '' );
+		if ('' === $new_key) {
+			$this->set_dataset_uri('');
 		}
 
 		// make the request to the remote server.
-		$this->get_remote_dataset_uri( $new_key );
+		$this->get_remote_dataset_uri($new_key);
 
-		do_action( 'wl_key_updated' );
+		do_action('wl_key_updated');
 
 	}
 
@@ -538,15 +538,15 @@ 
 	 *
 	 * @since 3.17.0 send the site URL and get the dataset URI.
 	 */
-	public function get_remote_dataset_uri( $key ) {
+	public function get_remote_dataset_uri($key) {
 
-		$this->log->trace( 'Getting the remote dataset URI and package type...' );
+		$this->log->trace('Getting the remote dataset URI and package type...');
 
-		if ( empty( $key ) ) {
-			$this->log->warn( 'Key set to empty value.' );
+		if (empty($key)) {
+			$this->log->warn('Key set to empty value.');
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+			$this->set_dataset_uri('');
+			$this->set_package_type(null);
 
 			return;
 		}
@@ -560,15 +560,15 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+		$home_url = get_option('home');
+		$site_url = apply_filters('wl_production_site_url', untrailingslashit($home_url));
 
 		// Build the URL.
 		$url = '/accounts'
-			   . '?key=' . rawurlencode( $key )
-			   . '&url=' . rawurlencode( $site_url )
-			   . '&country=' . $this->get_country_code()
-			   . '&language=' . $this->get_language_code();
+			   . '?key='.rawurlencode($key)
+			   . '&url='.rawurlencode($site_url)
+			   . '&country='.$this->get_country_code()
+			   . '&language='.$this->get_language_code();
 
 		$api_service = Default_Api_Service::get_instance();
 		/**
@@ -578,32 +578,32 @@ 
 		$headers  = array(
 			'Authorization' => "Key $key",
 		);
-		$response = $api_service->request( 'PUT', $url, $headers )->get_response();
+		$response = $api_service->request('PUT', $url, $headers)->get_response();
 
 		// The response is an error.
-		if ( is_wp_error( $response ) ) {
-			$this->log->error( 'An error occurred setting the dataset URI: ' . $response->get_error_message() );
+		if (is_wp_error($response)) {
+			$this->log->error('An error occurred setting the dataset URI: '.$response->get_error_message());
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+			$this->set_dataset_uri('');
+			$this->set_package_type(null);
 
 			return;
 		}
 
 		// The response is not OK.
-		if ( ! is_array( $response ) || 200 !== (int) $response['response']['code'] ) {
+		if ( ! is_array($response) || 200 !== (int) $response['response']['code']) {
 			$base_url = $api_service->get_base_url();
 
-			if ( ! is_array( $response ) ) {
+			if ( ! is_array($response)) {
 				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
+				$this->log->error("Unexpected response when opening URL $base_url$url: ".var_export($response, true));
 			} else {
 				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected status code when opening URL $base_url$url: " . $response['response']['code'] . "\n" . var_export( $response, true ) );
+				$this->log->error("Unexpected status code when opening URL $base_url$url: ".$response['response']['code']."\n".var_export($response, true));
 			}
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+			$this->set_dataset_uri('');
+			$this->set_package_type(null);
 
 			return;
 		}
@@ -613,20 +613,20 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$json = json_decode( $response['body'] );
+		$json = json_decode($response['body']);
 		/**
 		 * @since 3.27.7
 		 * Remove the trailing slash returned from the new platform api.
 		 */
 		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$dataset_uri = untrailingslashit( $json->datasetURI );
+		$dataset_uri = untrailingslashit($json->datasetURI);
 		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$package_type = isset( $json->packageType ) ? $json->packageType : null;
+		$package_type = isset($json->packageType) ? $json->packageType : null;
 
-		$this->log->info( "Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]..." );
+		$this->log->info("Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]...");
 
-		$this->set_dataset_uri( $dataset_uri );
-		$this->set_package_type( $package_type );
+		$this->set_dataset_uri($dataset_uri);
+		$this->set_package_type($package_type);
 	}
 
 	/**
@@ -643,20 +643,20 @@ 
 	 * @return mixed The same value in the $value parameter
 	 * @since 3.12.0
 	 */
-	public function maybe_update_dataset_uri( $value, $old_value ) {
+	public function maybe_update_dataset_uri($value, $old_value) {
 
 		// Check the old key value and the new one. Here we're only handling the
 		// case where the key hasn't changed and the dataset URI isn't set. The
 		// other case, i.e. a new key is inserted, is handled at `update_key`.
-		$old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $value['key'] ) ? trim( $value['key'] ) : '';
+		$old_key = isset($old_value['key']) ? $old_value['key'] : '';
+		$new_key = isset($value['key']) ? trim($value['key']) : '';
 
 		$dataset_uri = $this->get_dataset_uri();
 
-		if ( ! empty( $new_key ) && $new_key === $old_key && empty( $dataset_uri ) ) {
+		if ( ! empty($new_key) && $new_key === $old_key && empty($dataset_uri)) {
 
 			// make the request to the remote server to try to get the dataset uri.
-			$this->get_remote_dataset_uri( $new_key );
+			$this->get_remote_dataset_uri($new_key);
 		}
 
 		return $value;
@@ -670,9 +670,9 @@ 
 	 * @return string The API URI.
 	 * @since 3.11.0
 	 */
-	public function get_accounts_by_key_dataset_uri( $key ) {
+	public function get_accounts_by_key_dataset_uri($key) {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/key=$key/dataset_uri";
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE."accounts/key=$key/dataset_uri";
 	}
 
 	/**
@@ -683,7 +683,7 @@ 
 	 */
 	public function get_accounts() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'accounts';
 	}
 
 	/**
@@ -694,7 +694,7 @@ 
 	 */
 	public function is_link_by_default() {
 
-		return 'yes' === $this->get( 'wl_general_settings', self::LINK_BY_DEFAULT, 'yes' );
+		return 'yes' === $this->get('wl_general_settings', self::LINK_BY_DEFAULT, 'yes');
 	}
 
 	/**
@@ -704,9 +704,9 @@ 
 	 *
 	 * @since 3.13.0
 	 */
-	public function set_link_by_default( $value ) {
+	public function set_link_by_default($value) {
 
-		$this->set( 'wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no' );
+		$this->set('wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no');
 	}
 
 	/**
@@ -716,7 +716,7 @@ 
 	 * @since 3.21.0
 	 */
 	public function is_analytics_enable() {
-		return 'yes' === $this->get( 'wl_analytics_settings', self::ANALYTICS_ENABLE, 'no' );
+		return 'yes' === $this->get('wl_analytics_settings', self::ANALYTICS_ENABLE, 'no');
 	}
 
 	/**
@@ -726,9 +726,9 @@ 
 	 *
 	 * @since 3.21.0
 	 */
-	public function set_is_analytics_enable( $value ) {
+	public function set_is_analytics_enable($value) {
 
-		$this->set( 'wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no' );
+		$this->set('wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no');
 	}
 
 	/**
@@ -738,7 +738,7 @@ 
 	 * @since 3.21.0
 	 */
 	public function get_analytics_entity_uri_dimension() {
-		return (int) $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1 );
+		return (int) $this->get('wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1);
 	}
 
 	/**
@@ -748,7 +748,7 @@ 
 	 * @since 3.21.0
 	 */
 	public function get_analytics_entity_type_dimension() {
-		return $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2 );
+		return $this->get('wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2);
 	}
 
 	/**
@@ -759,7 +759,7 @@ 
 	 */
 	public function get_autocomplete_url() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'autocomplete';
 
 	}
 
@@ -771,7 +771,7 @@ 
 	 */
 	public function get_deactivation_feedback_url() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'feedbacks';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'feedbacks';
 
 	}
 
@@ -787,21 +787,21 @@ 
 	}
 
 	public function get_network_dataset_ids() {
-		return $this->get( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, array() );
+		return $this->get('wl_advanced_settings', self::NETWORK_DATASET_IDS, array());
 	}
 
-	public function set_network_dataset_ids( $network_dataset_ids ) {
-		$this->set( 'wl_advanced_settings', self::NETWORK_DATASET_IDS, $network_dataset_ids );
+	public function set_network_dataset_ids($network_dataset_ids) {
+		$this->set('wl_advanced_settings', self::NETWORK_DATASET_IDS, $network_dataset_ids);
 	}
 
 	public function get_skip_installation_notice() {
 
-		return $this->get( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, false );
+		return $this->get('wl_general_settings', self::SKIP_INSTALLATION_NOTICE, false);
 	}
 
-	public function set_skip_installation_notice( $value ) {
+	public function set_skip_installation_notice($value) {
 
-		$this->set( 'wl_general_settings', self::SKIP_INSTALLATION_NOTICE, $value );
+		$this->set('wl_general_settings', self::SKIP_INSTALLATION_NOTICE, $value);
 
 	}
 

src/js/dist/no-editor-analysis.asset.php

Indentation +2 added lines, -2 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'react', 'react-dom', 'wp-blocks', 'wp-components', 'wp-data', 'wp-element', 'wp-hooks', 'wp-polyfill', 'wp-rich-text' ),
-	'version'      => '0ffbdec637035dcca8bbe5839f9b3cd3',
+    'dependencies' => array( 'react', 'react-dom', 'wp-blocks', 'wp-components', 'wp-data', 'wp-element', 'wp-hooks', 'wp-polyfill', 'wp-rich-text' ),
+    'version'      => '0ffbdec637035dcca8bbe5839f9b3cd3',
 );

Spacing +1 added lines, -1 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'react', 'react-dom', 'wp-blocks', 'wp-components', 'wp-data', 'wp-element', 'wp-hooks', 'wp-polyfill', 'wp-rich-text' ),
+	'dependencies' => array('react', 'react-dom', 'wp-blocks', 'wp-components', 'wp-data', 'wp-element', 'wp-hooks', 'wp-polyfill', 'wp-rich-text'),
 	'version'      => '0ffbdec637035dcca8bbe5839f9b3cd3',
 );

src/js/dist/block-editor.asset.php

Indentation +2 added lines, -2 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'react', 'wp-blocks', 'wp-components', 'wp-compose', 'wp-data', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-hooks', 'wp-i18n', 'wp-plugins', 'wp-polyfill', 'wp-rich-text' ),
-	'version'      => '9991f5bb31a907ef27b3f15491a97d8d',
+    'dependencies' => array( 'react', 'wp-blocks', 'wp-components', 'wp-compose', 'wp-data', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-hooks', 'wp-i18n', 'wp-plugins', 'wp-polyfill', 'wp-rich-text' ),
+    'version'      => '9991f5bb31a907ef27b3f15491a97d8d',
 );

Spacing +1 added lines, -1 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'react', 'wp-blocks', 'wp-components', 'wp-compose', 'wp-data', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-hooks', 'wp-i18n', 'wp-plugins', 'wp-polyfill', 'wp-rich-text' ),
+	'dependencies' => array('react', 'wp-blocks', 'wp-components', 'wp-compose', 'wp-data', 'wp-edit-post', 'wp-editor', 'wp-element', 'wp-hooks', 'wp-i18n', 'wp-plugins', 'wp-polyfill', 'wp-rich-text'),
 	'version'      => '9991f5bb31a907ef27b3f15491a97d8d',
 );

src/js/dist/edit.asset.php

Indentation +2 added lines, -2 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'react', 'react-dom', 'wp-hooks', 'wp-polyfill' ),
-	'version'      => 'e4663448def6a65455d4a6b394d6a89d',
+    'dependencies' => array( 'react', 'react-dom', 'wp-hooks', 'wp-polyfill' ),
+    'version'      => 'e4663448def6a65455d4a6b394d6a89d',
 );

Spacing +1 added lines, -1 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'react', 'react-dom', 'wp-hooks', 'wp-polyfill' ),
+	'dependencies' => array('react', 'react-dom', 'wp-hooks', 'wp-polyfill'),
 	'version'      => 'e4663448def6a65455d4a6b394d6a89d',
 );