insideout10 / wordlift-plugin

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

Indentation +584 added lines, -584 removed lines

@@ -16,508 +16,508 @@ 
  */
 class Wordlift_Entity_Service {
 
-	/**
-	 * The Log service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log The Log service.
-	 */
-	private $log;
-
-	/**
-	 * The UI service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_UI_Service $ui_service The UI service.
-	 */
-	private $ui_service;
-
-	/**
-	 * The {@link Wordlift_Relation_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
-	 */
-	private $relation_service;
-
-	/**
-	 * The {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * The entity post type name.
-	 *
-	 * @since 3.1.0
-	 */
-	const TYPE_NAME = 'entity';
-
-	/**
-	 * The alternative label meta key.
-	 *
-	 * @since 3.2.0
-	 */
-	const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';
-
-	/**
-	 * The alternative label input template.
-	 *
-	 * @since 3.2.0
-	 */
-	// TODO: this should be moved to a class that deals with HTML code.
-	const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
+    /**
+     * The Log service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_Log_Service $log The Log service.
+     */
+    private $log;
+
+    /**
+     * The UI service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_UI_Service $ui_service The UI service.
+     */
+    private $ui_service;
+
+    /**
+     * The {@link Wordlift_Relation_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
+     */
+    private $relation_service;
+
+    /**
+     * The {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    private $entity_uri_service;
+
+    /**
+     * The entity post type name.
+     *
+     * @since 3.1.0
+     */
+    const TYPE_NAME = 'entity';
+
+    /**
+     * The alternative label meta key.
+     *
+     * @since 3.2.0
+     */
+    const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';
+
+    /**
+     * The alternative label input template.
+     *
+     * @since 3.2.0
+     */
+    // TODO: this should be moved to a class that deals with HTML code.
+    const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
                 <label class="screen-reader-text" id="wl-alternative-label-prompt-text" for="wl-alternative-label">Enter alternative label here</label>
                 <input name="wl_alternative_label[]" size="30" value="%s" id="wl-alternative-label" type="text">
                 <button class="button wl-delete-button">%s</button>
                 </div>';
 
-	/**
-	 * A singleton instance of the Entity service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $instance A singleton instance of the Entity service.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a Wordlift_Entity_Service instance.
-	 *
-	 * @param \Wordlift_UI_Service $ui_service The UI service.
-	 * @param \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
-	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since 3.2.0
-	 *
-	 */
-	public function __construct( $ui_service, $relation_service, $entity_uri_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
-
-		$this->ui_service         = $ui_service;
-		$this->relation_service   = $relation_service;
-		$this->entity_uri_service = $entity_uri_service;
-
-		// Set the singleton instance.
-		self::$instance = $this;
-	}
-
-	/**
-	 * Get the singleton instance of the Entity service.
-	 *
-	 * @return \Wordlift_Entity_Service The singleton instance of the Entity service.
-	 * @since 3.2.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Determines whether a post is an entity or not. Entity is in this context
-	 * something which is not an article.
-	 *
-	 * @param int $post_id A post id.
-	 *
-	 * @return bool Return true if the post is an entity otherwise false.
-	 * @since 3.1.0
-	 *
-	 */
-	public function is_entity( $post_id ) {
-
-		$terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-
-		if ( is_wp_error( $terms ) ) {
-			$this->log->error( "Cannot get the terms for post $post_id: " . $terms->get_error_message() );
-
-			return false;
-		}
-
-		if ( empty( $terms ) ) {
-			return false;
-		}
-
-		/*
+    /**
+     * A singleton instance of the Entity service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_Entity_Service $instance A singleton instance of the Entity service.
+     */
+    private static $instance;
+
+    /**
+     * Create a Wordlift_Entity_Service instance.
+     *
+     * @param \Wordlift_UI_Service $ui_service The UI service.
+     * @param \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
+     * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since 3.2.0
+     *
+     */
+    public function __construct( $ui_service, $relation_service, $entity_uri_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+
+        $this->ui_service         = $ui_service;
+        $this->relation_service   = $relation_service;
+        $this->entity_uri_service = $entity_uri_service;
+
+        // Set the singleton instance.
+        self::$instance = $this;
+    }
+
+    /**
+     * Get the singleton instance of the Entity service.
+     *
+     * @return \Wordlift_Entity_Service The singleton instance of the Entity service.
+     * @since 3.2.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Determines whether a post is an entity or not. Entity is in this context
+     * something which is not an article.
+     *
+     * @param int $post_id A post id.
+     *
+     * @return bool Return true if the post is an entity otherwise false.
+     * @since 3.1.0
+     *
+     */
+    public function is_entity( $post_id ) {
+
+        $terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+
+        if ( is_wp_error( $terms ) ) {
+            $this->log->error( "Cannot get the terms for post $post_id: " . $terms->get_error_message() );
+
+            return false;
+        }
+
+        if ( empty( $terms ) ) {
+            return false;
+        }
+
+        /*
 		 * We don't consider an `article` to be an entity.
 		 *
 		 * @since 3.20.0 At least one associated mustn't be an `article`.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 */
-		foreach ( $terms as $term ) {
-			if ( 'article' !== $term->slug ) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get the proper classification scope for a given entity post
-	 *
-	 * @param integer $post_id An entity post id.
-	 *
-	 * @param string $default The default classification scope, `what` if not
-	 *                         provided.
-	 *
-	 * @return string Returns a classification scope (e.g. 'what').
-	 * @since 3.5.0
-	 *
-	 */
-	public function get_classification_scope_for( $post_id, $default = WL_WHAT_RELATION ) {
-
-		if ( false === $this->is_entity( $post_id ) ) {
-			return $default;
-		}
-
-		// Retrieve the entity type
-		$entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
-		$entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
-		// Retrieve classification boxes configuration
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
-				return $cb['id'];
-			}
-		}
-
-		return $default;
-	}
-
-	/**
-	 * Check whether a {@link WP_Post} is used.
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 *
-	 * @return bool|null Null if it's not an entity, otherwise true if it's used.
-	 */
-	public function is_used( $post_id ) {
-
-		if ( false === $this->is_entity( $post_id ) ) {
-			return null;
-		}
-		// Retrieve the post
-		$entity = get_post( $post_id );
-
-		global $wpdb;
-		// Retrieve Wordlift relation instances table name
-		$table_name = wl_core_get_relation_instances_table_name();
-
-		// Check is it's referenced / related to another post / entity
-		$stmt = $wpdb->prepare(
-			"SELECT COUNT(*) FROM $table_name WHERE  object_id = %d",
-			$entity->ID
-		);
-
-		// Perform the query
-		$relation_instances = (int) $wpdb->get_var( $stmt );
-		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
-			return true;
-		}
-
-		// Check if the entity uri is used as meta_value
-		$stmt = $wpdb->prepare(
-			"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
-			$entity->ID,
-			wl_get_entity_uri( $entity->ID )
-		);
-		// Perform the query
-		$meta_instances = (int) $wpdb->get_var( $stmt );
-
-		// If there is at least one meta that refers the current entity uri, then current entity is used
-		if ( 0 < $meta_instances ) {
-			return true;
-		}
-
-		// If we are here, it means the current entity is not used at the moment
-		return false;
-	}
-
-	/**
-	 * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
-	 *
-	 * @param string $uri The entity URI.
-	 *
-	 * @return WP_Post|null A WP_Post instance or null if not found.
-	 * @deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
-	 *
-	 * @since      3.16.3 deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
-	 * @since      3.2.0
-	 *
-	 */
-	public function get_entity_post_by_uri( $uri ) {
-
-		return $this->entity_uri_service->get_entity( $uri );
-	}
-
-	/**
-	 * Fires once a post has been saved. This function uses the $_REQUEST, therefore
-	 * we check that the post we're saving is the current post.
-	 *
-	 * @see   https://github.com/insideout10/wordlift-plugin/issues/363
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param int $post_id Post ID.
-	 * @param WP_Post $post Post object.
-	 * @param bool $update Whether this is an existing post being updated or not.
-	 */
-	public function save_post( $post_id, $post, $update ) {
-
-		// Avoid doing anything if post is autosave or a revision.
-		if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
-			return;
-		}
-
-		// We're setting the alternative label that have been provided via the UI
-		// (in fact we're using $_REQUEST), while save_post may be also called
-		// programmatically by some other function: we need to check therefore if
-		// the $post_id in the save_post call matches the post id set in the request.
-		//
-		// If this is not the current post being saved or if it's not an entity, return.
-		if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
-			return;
-		}
-
-		// Get the alt labels from the request (or empty array).
-		$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
-
-		if ( ( ! empty( $_POST['content'] ) && ! empty( $_POST['post_content'] ) ) || isset( $_REQUEST['wl_alternative_label'] ) ) {
-			// This is via classic editor, so set the alternative labels.
-			$this->set_alternative_labels( $post_id, $alt_labels );
-		}
-
-
-	}
-
-	/**
-	 * Set the alternative labels.
-	 *
-	 * @param int $post_id The post id.
-	 * @param array $alt_labels An array of labels.
-	 *
-	 * @since 3.2.0
-	 *
-	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
-
-		// Bail out if post id is not numeric. We add this check as we found a WP install that was sending a WP_Error
-		// instead of post id.
-		if ( ! is_numeric( $post_id ) ) {
-			return;
-		}
-
-		// Force $alt_labels to be an array
-		if ( ! is_array( $alt_labels ) ) {
-			$alt_labels = array( $alt_labels );
-		}
-
-		$this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
-
-		// Delete all the existing alternate labels.
-		delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
-
-		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
-			}
-		}
-
-	}
-
-	/**
-	 * Retrieve the alternate labels.
-	 *
-	 * @param int $post_id Post id.
-	 *
-	 * @return mixed An array  of alternative labels.
-	 * @since 3.2.0
-	 *
-	 */
-	public function get_alternative_labels( $post_id ) {
-
-		return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
-	}
-
-	/**
-	 * Retrieve the labels for an entity, i.e. the title + the synonyms.
-	 *
-	 * @param int $post_id The entity {@link WP_Post} id.
-	 *
-	 * @return array An array with the entity title and labels.
-	 * @since 3.12.0
-	 *
-	 */
-	public function get_labels( $post_id ) {
-
-		return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
-	}
-
-	/**
-	 * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
-	 *
-	 * @param WP_Post $post Post object.
-	 *
-	 * @since 3.2.0
-	 *
-	 */
-	public function edit_form_before_permalink( $post ) {
-
-		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
-			return;
-		}
-
-		// Print the input template.
-		$this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
-
-		// Print all the currently set alternative labels.
-		foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
-
-			echo $this->get_alternative_label_input( $alt_label );
-
-		};
-
-		// Print the button.
-		$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
-
-	}
-
-	/**
-	 * Get the URI for the entity with the specified post id.
-	 *
-	 * @param int $post_id The entity post id.
-	 *
-	 * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
-	 * @since 3.6.0
-	 *
-	 */
-	public function get_uri( $post_id ) {
-
-		$log = Wordlift_Log_Service::get_logger( get_class() );
-
-		// If a null is given, nothing to do
-		if ( is_null( $post_id ) ) {
-			return null;
-		}
-
-		$dataset_uri = wl_configuration_get_redlink_dataset_uri();
-
-		if ( empty( $dataset_uri ) ) {
-			// Continue even if the dataset uri is not properly configured. It is handled in function wl_build_entity_uri()
-			$log->debug( 'Continuing, dataset uri not configured...' );
-		}
-
-		$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
-
-		/*
+        foreach ( $terms as $term ) {
+            if ( 'article' !== $term->slug ) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Get the proper classification scope for a given entity post
+     *
+     * @param integer $post_id An entity post id.
+     *
+     * @param string $default The default classification scope, `what` if not
+     *                         provided.
+     *
+     * @return string Returns a classification scope (e.g. 'what').
+     * @since 3.5.0
+     *
+     */
+    public function get_classification_scope_for( $post_id, $default = WL_WHAT_RELATION ) {
+
+        if ( false === $this->is_entity( $post_id ) ) {
+            return $default;
+        }
+
+        // Retrieve the entity type
+        $entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
+        $entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
+        // Retrieve classification boxes configuration
+        $classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
+        foreach ( $classification_boxes as $cb ) {
+            if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
+                return $cb['id'];
+            }
+        }
+
+        return $default;
+    }
+
+    /**
+     * Check whether a {@link WP_Post} is used.
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     *
+     * @return bool|null Null if it's not an entity, otherwise true if it's used.
+     */
+    public function is_used( $post_id ) {
+
+        if ( false === $this->is_entity( $post_id ) ) {
+            return null;
+        }
+        // Retrieve the post
+        $entity = get_post( $post_id );
+
+        global $wpdb;
+        // Retrieve Wordlift relation instances table name
+        $table_name = wl_core_get_relation_instances_table_name();
+
+        // Check is it's referenced / related to another post / entity
+        $stmt = $wpdb->prepare(
+            "SELECT COUNT(*) FROM $table_name WHERE  object_id = %d",
+            $entity->ID
+        );
+
+        // Perform the query
+        $relation_instances = (int) $wpdb->get_var( $stmt );
+        // If there is at least one relation instance for the current entity, then it's used
+        if ( 0 < $relation_instances ) {
+            return true;
+        }
+
+        // Check if the entity uri is used as meta_value
+        $stmt = $wpdb->prepare(
+            "SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
+            $entity->ID,
+            wl_get_entity_uri( $entity->ID )
+        );
+        // Perform the query
+        $meta_instances = (int) $wpdb->get_var( $stmt );
+
+        // If there is at least one meta that refers the current entity uri, then current entity is used
+        if ( 0 < $meta_instances ) {
+            return true;
+        }
+
+        // If we are here, it means the current entity is not used at the moment
+        return false;
+    }
+
+    /**
+     * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
+     *
+     * @param string $uri The entity URI.
+     *
+     * @return WP_Post|null A WP_Post instance or null if not found.
+     * @deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
+     *
+     * @since      3.16.3 deprecated in favor of Wordlift_Entity_Uri_Service->get_entity( $uri );
+     * @since      3.2.0
+     *
+     */
+    public function get_entity_post_by_uri( $uri ) {
+
+        return $this->entity_uri_service->get_entity( $uri );
+    }
+
+    /**
+     * Fires once a post has been saved. This function uses the $_REQUEST, therefore
+     * we check that the post we're saving is the current post.
+     *
+     * @see   https://github.com/insideout10/wordlift-plugin/issues/363
+     *
+     * @since 3.2.0
+     *
+     * @param int $post_id Post ID.
+     * @param WP_Post $post Post object.
+     * @param bool $update Whether this is an existing post being updated or not.
+     */
+    public function save_post( $post_id, $post, $update ) {
+
+        // Avoid doing anything if post is autosave or a revision.
+        if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
+            return;
+        }
+
+        // We're setting the alternative label that have been provided via the UI
+        // (in fact we're using $_REQUEST), while save_post may be also called
+        // programmatically by some other function: we need to check therefore if
+        // the $post_id in the save_post call matches the post id set in the request.
+        //
+        // If this is not the current post being saved or if it's not an entity, return.
+        if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
+            return;
+        }
+
+        // Get the alt labels from the request (or empty array).
+        $alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
+
+        if ( ( ! empty( $_POST['content'] ) && ! empty( $_POST['post_content'] ) ) || isset( $_REQUEST['wl_alternative_label'] ) ) {
+            // This is via classic editor, so set the alternative labels.
+            $this->set_alternative_labels( $post_id, $alt_labels );
+        }
+
+
+    }
+
+    /**
+     * Set the alternative labels.
+     *
+     * @param int $post_id The post id.
+     * @param array $alt_labels An array of labels.
+     *
+     * @since 3.2.0
+     *
+     */
+    public function set_alternative_labels( $post_id, $alt_labels ) {
+
+        // Bail out if post id is not numeric. We add this check as we found a WP install that was sending a WP_Error
+        // instead of post id.
+        if ( ! is_numeric( $post_id ) ) {
+            return;
+        }
+
+        // Force $alt_labels to be an array
+        if ( ! is_array( $alt_labels ) ) {
+            $alt_labels = array( $alt_labels );
+        }
+
+        $this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
+
+        // Delete all the existing alternate labels.
+        delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+
+        // Set the alternative labels.
+        foreach ( $alt_labels as $alt_label ) {
+            if ( ! empty( $alt_label ) ) {
+                add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
+            }
+        }
+
+    }
+
+    /**
+     * Retrieve the alternate labels.
+     *
+     * @param int $post_id Post id.
+     *
+     * @return mixed An array  of alternative labels.
+     * @since 3.2.0
+     *
+     */
+    public function get_alternative_labels( $post_id ) {
+
+        return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+    }
+
+    /**
+     * Retrieve the labels for an entity, i.e. the title + the synonyms.
+     *
+     * @param int $post_id The entity {@link WP_Post} id.
+     *
+     * @return array An array with the entity title and labels.
+     * @since 3.12.0
+     *
+     */
+    public function get_labels( $post_id ) {
+
+        return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
+    }
+
+    /**
+     * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
+     *
+     * @param WP_Post $post Post object.
+     *
+     * @since 3.2.0
+     *
+     */
+    public function edit_form_before_permalink( $post ) {
+
+        // If it's not an entity, return.
+        if ( ! $this->is_entity( $post->ID ) ) {
+            return;
+        }
+
+        // Print the input template.
+        $this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+
+        // Print all the currently set alternative labels.
+        foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
+
+            echo $this->get_alternative_label_input( $alt_label );
+
+        };
+
+        // Print the button.
+        $this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+
+    }
+
+    /**
+     * Get the URI for the entity with the specified post id.
+     *
+     * @param int $post_id The entity post id.
+     *
+     * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
+     * @since 3.6.0
+     *
+     */
+    public function get_uri( $post_id ) {
+
+        $log = Wordlift_Log_Service::get_logger( get_class() );
+
+        // If a null is given, nothing to do
+        if ( is_null( $post_id ) ) {
+            return null;
+        }
+
+        $dataset_uri = wl_configuration_get_redlink_dataset_uri();
+
+        if ( empty( $dataset_uri ) ) {
+            // Continue even if the dataset uri is not properly configured. It is handled in function wl_build_entity_uri()
+            $log->debug( 'Continuing, dataset uri not configured...' );
+        }
+
+        $uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
+
+        /*
 		 * Consider the URI invalid if it doesn't start with the dataset URI.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/996
 		 */
-		if ( null === $dataset_uri || 0 !== strpos( $uri, $dataset_uri ) ) {
-			$uri = null;
-		}
-
-		// Set the URI if it isn't set yet.
-		$post_status = get_post_status( $post_id );
-		if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
-			$uri = wl_build_entity_uri( $post_id );
-			wl_set_entity_uri( $post_id, $uri );
-		}
-
-		return $uri;
-	}
-
-
-	/**
-	 * Get the alternative label input HTML code.
-	 *
-	 * @param string $value The input value.
-	 *
-	 * @return string The input HTML code.
-	 * @since 3.2.0
-	 *
-	 */
-	private function get_alternative_label_input( $value = '' ) {
-
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
-	}
-
-	/**
-	 * Get the number of entity posts published in this blog.
-	 *
-	 * @return int The number of published entity posts.
-	 * @since 3.6.0
-	 *
-	 */
-	public function count() {
-		global $wpdb;
-
-		// Try to get the count from the transient.
-		$count = get_transient( '_wl_entity_service__count' );
-		if ( false !== $count ) {
-			return $count;
-		}
-
-		// Query the count.
-		$count = $wpdb->get_var( $wpdb->prepare(
-			"SELECT COUNT( DISTINCT( tr.object_id ) )"
-			. " FROM {$wpdb->term_relationships} tr"
-			. " INNER JOIN {$wpdb->term_taxonomy} tt"
-			. "  ON tt.taxonomy = %s AND tt.term_taxonomy_id = tr.term_taxonomy_id"
-			. " INNER JOIN {$wpdb->terms} t"
-			. "  ON t.term_id = tt.term_id AND t.name != %s",
-			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-			'article'
-		) );
-
-		// Store the count in cache.
-		set_transient( '_wl_entity_service__count', $count, 900 );
-
-		return $count;
-	}
-
-	/**
-	 * Add the entity filtering criterias to the arguments for a `get_posts`
-	 * call.
-	 *
-	 * @param array $args The arguments for a `get_posts` call.
-	 *
-	 * @return array The arguments for a `get_posts` call.
-	 * @since 3.15.0
-	 *
-	 */
-	public static function add_criterias( $args ) {
-
-		// Build an optimal tax-query.
-		$tax_query = array(
-			'relation' => 'AND',
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'operator' => 'EXISTS',
-			),
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'field'    => 'slug',
-				'terms'    => 'article',
-				'operator' => 'NOT IN',
-			),
-		);
-
-		return $args + array(
-				'post_type' => Wordlift_Entity_Service::valid_entity_post_types(),
-				/*
+        if ( null === $dataset_uri || 0 !== strpos( $uri, $dataset_uri ) ) {
+            $uri = null;
+        }
+
+        // Set the URI if it isn't set yet.
+        $post_status = get_post_status( $post_id );
+        if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
+            $uri = wl_build_entity_uri( $post_id );
+            wl_set_entity_uri( $post_id, $uri );
+        }
+
+        return $uri;
+    }
+
+
+    /**
+     * Get the alternative label input HTML code.
+     *
+     * @param string $value The input value.
+     *
+     * @return string The input HTML code.
+     * @since 3.2.0
+     *
+     */
+    private function get_alternative_label_input( $value = '' ) {
+
+        return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
+    }
+
+    /**
+     * Get the number of entity posts published in this blog.
+     *
+     * @return int The number of published entity posts.
+     * @since 3.6.0
+     *
+     */
+    public function count() {
+        global $wpdb;
+
+        // Try to get the count from the transient.
+        $count = get_transient( '_wl_entity_service__count' );
+        if ( false !== $count ) {
+            return $count;
+        }
+
+        // Query the count.
+        $count = $wpdb->get_var( $wpdb->prepare(
+            "SELECT COUNT( DISTINCT( tr.object_id ) )"
+            . " FROM {$wpdb->term_relationships} tr"
+            . " INNER JOIN {$wpdb->term_taxonomy} tt"
+            . "  ON tt.taxonomy = %s AND tt.term_taxonomy_id = tr.term_taxonomy_id"
+            . " INNER JOIN {$wpdb->terms} t"
+            . "  ON t.term_id = tt.term_id AND t.name != %s",
+            Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+            'article'
+        ) );
+
+        // Store the count in cache.
+        set_transient( '_wl_entity_service__count', $count, 900 );
+
+        return $count;
+    }
+
+    /**
+     * Add the entity filtering criterias to the arguments for a `get_posts`
+     * call.
+     *
+     * @param array $args The arguments for a `get_posts` call.
+     *
+     * @return array The arguments for a `get_posts` call.
+     * @since 3.15.0
+     *
+     */
+    public static function add_criterias( $args ) {
+
+        // Build an optimal tax-query.
+        $tax_query = array(
+            'relation' => 'AND',
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'operator' => 'EXISTS',
+            ),
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'field'    => 'slug',
+                'terms'    => 'article',
+                'operator' => 'NOT IN',
+            ),
+        );
+
+        return $args + array(
+                'post_type' => Wordlift_Entity_Service::valid_entity_post_types(),
+                /*
 				 * Ensure compatibility with Polylang.
 				 *
 				 * @see https://github.com/insideout10/wordlift-plugin/issues/855.
@@ -525,102 +525,102 @@ 
 				 *
 				 * @since 3.19.5
 				 */
-				'lang'      => '',
-				'tax_query' => $tax_query,
-			);
-	}
-
-	/**
-	 * Create a new entity.
-	 *
-	 * @param string $name The entity name.
-	 * @param string $type_uri The entity's type URI.
-	 * @param null $logo The entity logo id (or NULL if none).
-	 * @param string $status The post status, by default 'publish'.
-	 *
-	 * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
-	 * @since 3.9.0
-	 *
-	 */
-	public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
-
-		// Create an entity for the publisher.
-		$post_id = @wp_insert_post( array(
-			'post_type'    => self::TYPE_NAME,
-			'post_title'   => $name,
-			'post_status'  => $status,
-			'post_content' => '',
-		) );
-
-		// Return the error if any.
-		if ( is_wp_error( $post_id ) ) {
-			return $post_id;
-		}
-
-		// Set the entity logo.
-		if ( $logo && is_numeric( $logo ) ) {
-			set_post_thumbnail( $post_id, $logo );
-		}
-
-		// Set the entity type.
-		Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
-
-		return $post_id;
-	}
-
-	/**
-	 * Get the entities related to the one with the specified id. By default only
-	 * published entities will be returned.
-	 *
-	 * @param int $id The post id.
-	 * @param string $post_status The target post status (default = publish).
-	 *
-	 * @return array An array of post ids.
-	 * @since 3.10.0
-	 *
-	 */
-	public function get_related_entities( $id, $post_status = 'publish' ) {
-
-		return $this->relation_service->get_objects( $id, 'ids', null, $post_status );
-	}
-
-	/**
-	 * Get the list of entities.
-	 *
-	 * @param array $params Custom parameters for WordPress' own {@link get_posts} function.
-	 *
-	 * @return array An array of entity posts.
-	 * @since 3.12.2
-	 *
-	 */
-	public function get( $params = array() ) {
-
-		// Set the defaults.
-		$defaults = array( 'post_type' => 'entity' );
-
-		// Merge the defaults with the provided parameters.
-		$args = wp_parse_args( $params, $defaults );
-
-		// Call the `get_posts` function.
-		return get_posts( $args );
-	}
-
-	/**
-	 * The list of post type names which can be used for entities
-	 *
-	 * Criteria is that the post type is public. The list of valid post types
-	 * can be overridden with a filter.
-	 *
-	 * @return array Array containing the names of the valid post types.
-	 * @since 3.15.0
-	 *
-	 */
-	static function valid_entity_post_types() {
-
-		// Ignore builtins in the call to avoid getting attachments.
-		$post_types = array( 'post', 'page', self::TYPE_NAME, 'product' );
-
-		return apply_filters( 'wl_valid_entity_post_types', $post_types );
-	}
+                'lang'      => '',
+                'tax_query' => $tax_query,
+            );
+    }
+
+    /**
+     * Create a new entity.
+     *
+     * @param string $name The entity name.
+     * @param string $type_uri The entity's type URI.
+     * @param null $logo The entity logo id (or NULL if none).
+     * @param string $status The post status, by default 'publish'.
+     *
+     * @return int|WP_Error The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
+     * @since 3.9.0
+     *
+     */
+    public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
+
+        // Create an entity for the publisher.
+        $post_id = @wp_insert_post( array(
+            'post_type'    => self::TYPE_NAME,
+            'post_title'   => $name,
+            'post_status'  => $status,
+            'post_content' => '',
+        ) );
+
+        // Return the error if any.
+        if ( is_wp_error( $post_id ) ) {
+            return $post_id;
+        }
+
+        // Set the entity logo.
+        if ( $logo && is_numeric( $logo ) ) {
+            set_post_thumbnail( $post_id, $logo );
+        }
+
+        // Set the entity type.
+        Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
+
+        return $post_id;
+    }
+
+    /**
+     * Get the entities related to the one with the specified id. By default only
+     * published entities will be returned.
+     *
+     * @param int $id The post id.
+     * @param string $post_status The target post status (default = publish).
+     *
+     * @return array An array of post ids.
+     * @since 3.10.0
+     *
+     */
+    public function get_related_entities( $id, $post_status = 'publish' ) {
+
+        return $this->relation_service->get_objects( $id, 'ids', null, $post_status );
+    }
+
+    /**
+     * Get the list of entities.
+     *
+     * @param array $params Custom parameters for WordPress' own {@link get_posts} function.
+     *
+     * @return array An array of entity posts.
+     * @since 3.12.2
+     *
+     */
+    public function get( $params = array() ) {
+
+        // Set the defaults.
+        $defaults = array( 'post_type' => 'entity' );
+
+        // Merge the defaults with the provided parameters.
+        $args = wp_parse_args( $params, $defaults );
+
+        // Call the `get_posts` function.
+        return get_posts( $args );
+    }
+
+    /**
+     * The list of post type names which can be used for entities
+     *
+     * Criteria is that the post type is public. The list of valid post types
+     * can be overridden with a filter.
+     *
+     * @return array Array containing the names of the valid post types.
+     * @since 3.15.0
+     *
+     */
+    static function valid_entity_post_types() {
+
+        // Ignore builtins in the call to avoid getting attachments.
+        $post_types = array( 'post', 'page', self::TYPE_NAME, 'product' );
+
+        return apply_filters( 'wl_valid_entity_post_types', $post_types );
+    }
 
 }

Spacing +85 added lines, -85 removed lines

@@ -97,9 +97,9 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function __construct( $ui_service, $relation_service, $entity_uri_service ) {
+	public function __construct($ui_service, $relation_service, $entity_uri_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Entity_Service');
 
 		$this->ui_service         = $ui_service;
 		$this->relation_service   = $relation_service;
@@ -130,17 +130,17 @@ 
 	 * @since 3.1.0
 	 *
 	 */
-	public function is_entity( $post_id ) {
+	public function is_entity($post_id) {
 
-		$terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+		$terms = wp_get_object_terms($post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
 
-		if ( is_wp_error( $terms ) ) {
-			$this->log->error( "Cannot get the terms for post $post_id: " . $terms->get_error_message() );
+		if (is_wp_error($terms)) {
+			$this->log->error("Cannot get the terms for post $post_id: ".$terms->get_error_message());
 
 			return false;
 		}
 
-		if ( empty( $terms ) ) {
+		if (empty($terms)) {
 			return false;
 		}
 
@@ -151,8 +151,8 @@ 
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 */
-		foreach ( $terms as $term ) {
-			if ( 'article' !== $term->slug ) {
+		foreach ($terms as $term) {
+			if ('article' !== $term->slug) {
 				return true;
 			}
 		}
@@ -172,19 +172,19 @@ 
 	 * @since 3.5.0
 	 *
 	 */
-	public function get_classification_scope_for( $post_id, $default = WL_WHAT_RELATION ) {
+	public function get_classification_scope_for($post_id, $default = WL_WHAT_RELATION) {
 
-		if ( false === $this->is_entity( $post_id ) ) {
+		if (false === $this->is_entity($post_id)) {
 			return $default;
 		}
 
 		// Retrieve the entity type
-		$entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
-		$entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
+		$entity_type_arr = Wordlift_Entity_Type_Service::get_instance()->get($post_id);
+		$entity_type     = str_replace('wl-', '', $entity_type_arr['css_class']);
 		// Retrieve classification boxes configuration
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
+		$classification_boxes = unserialize(WL_CORE_POST_CLASSIFICATION_BOXES);
+		foreach ($classification_boxes as $cb) {
+			if (in_array($entity_type, $cb['registeredTypes'])) {
 				return $cb['id'];
 			}
 		}
@@ -199,13 +199,13 @@ 
 	 *
 	 * @return bool|null Null if it's not an entity, otherwise true if it's used.
 	 */
-	public function is_used( $post_id ) {
+	public function is_used($post_id) {
 
-		if ( false === $this->is_entity( $post_id ) ) {
+		if (false === $this->is_entity($post_id)) {
 			return null;
 		}
 		// Retrieve the post
-		$entity = get_post( $post_id );
+		$entity = get_post($post_id);
 
 		global $wpdb;
 		// Retrieve Wordlift relation instances table name
@@ -218,9 +218,9 @@ 
 		);
 
 		// Perform the query
-		$relation_instances = (int) $wpdb->get_var( $stmt );
+		$relation_instances = (int) $wpdb->get_var($stmt);
 		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
+		if (0 < $relation_instances) {
 			return true;
 		}
 
@@ -228,13 +228,13 @@ 
 		$stmt = $wpdb->prepare(
 			"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
 			$entity->ID,
-			wl_get_entity_uri( $entity->ID )
+			wl_get_entity_uri($entity->ID)
 		);
 		// Perform the query
-		$meta_instances = (int) $wpdb->get_var( $stmt );
+		$meta_instances = (int) $wpdb->get_var($stmt);
 
 		// If there is at least one meta that refers the current entity uri, then current entity is used
-		if ( 0 < $meta_instances ) {
+		if (0 < $meta_instances) {
 			return true;
 		}
 
@@ -254,9 +254,9 @@ 
 	 * @since      3.2.0
 	 *
 	 */
-	public function get_entity_post_by_uri( $uri ) {
+	public function get_entity_post_by_uri($uri) {
 
-		return $this->entity_uri_service->get_entity( $uri );
+		return $this->entity_uri_service->get_entity($uri);
 	}
 
 	/**
@@ -271,10 +271,10 @@ 
 	 * @param WP_Post $post Post object.
 	 * @param bool $update Whether this is an existing post being updated or not.
 	 */
-	public function save_post( $post_id, $post, $update ) {
+	public function save_post($post_id, $post, $update) {
 
 		// Avoid doing anything if post is autosave or a revision.
-		if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
+		if (wp_is_post_autosave($post) || wp_is_post_revision($post)) {
 			return;
 		}
 
@@ -284,16 +284,16 @@ 
 		// the $post_id in the save_post call matches the post id set in the request.
 		//
 		// If this is not the current post being saved or if it's not an entity, return.
-		if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
+		if ( ! isset($_REQUEST['post_ID']) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity($post_id)) {
 			return;
 		}
 
 		// Get the alt labels from the request (or empty array).
-		$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
+		$alt_labels = isset($_REQUEST['wl_alternative_label']) ? $_REQUEST['wl_alternative_label'] : array();
 
-		if ( ( ! empty( $_POST['content'] ) && ! empty( $_POST['post_content'] ) ) || isset( $_REQUEST['wl_alternative_label'] ) ) {
+		if (( ! empty($_POST['content']) && ! empty($_POST['post_content'])) || isset($_REQUEST['wl_alternative_label'])) {
 			// This is via classic editor, so set the alternative labels.
-			$this->set_alternative_labels( $post_id, $alt_labels );
+			$this->set_alternative_labels($post_id, $alt_labels);
 		}
 
 
@@ -308,28 +308,28 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
+	public function set_alternative_labels($post_id, $alt_labels) {
 
 		// Bail out if post id is not numeric. We add this check as we found a WP install that was sending a WP_Error
 		// instead of post id.
-		if ( ! is_numeric( $post_id ) ) {
+		if ( ! is_numeric($post_id)) {
 			return;
 		}
 
 		// Force $alt_labels to be an array
-		if ( ! is_array( $alt_labels ) ) {
-			$alt_labels = array( $alt_labels );
+		if ( ! is_array($alt_labels)) {
+			$alt_labels = array($alt_labels);
 		}
 
-		$this->log->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
+		$this->log->debug("Setting alternative labels [ post id :: $post_id ][ alt labels :: ".implode(',', $alt_labels)." ]");
 
 		// Delete all the existing alternate labels.
-		delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+		delete_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY);
 
 		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
+		foreach ($alt_labels as $alt_label) {
+			if ( ! empty($alt_label)) {
+				add_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label);
 			}
 		}
 
@@ -344,9 +344,9 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function get_alternative_labels( $post_id ) {
+	public function get_alternative_labels($post_id) {
 
-		return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+		return get_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY);
 	}
 
 	/**
@@ -358,9 +358,9 @@ 
 	 * @since 3.12.0
 	 *
 	 */
-	public function get_labels( $post_id ) {
+	public function get_labels($post_id) {
 
-		return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
+		return array_merge((array) get_the_title($post_id), $this->get_alternative_labels($post_id));
 	}
 
 	/**
@@ -371,25 +371,25 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function edit_form_before_permalink( $post ) {
+	public function edit_form_before_permalink($post) {
 
 		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
+		if ( ! $this->is_entity($post->ID)) {
 			return;
 		}
 
 		// Print the input template.
-		$this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+		$this->ui_service->print_template('wl-tmpl-alternative-label-input', $this->get_alternative_label_input());
 
 		// Print all the currently set alternative labels.
-		foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
+		foreach ($this->get_alternative_labels($post->ID) as $alt_label) {
 
-			echo $this->get_alternative_label_input( $alt_label );
+			echo $this->get_alternative_label_input($alt_label);
 
 		};
 
 		// Print the button.
-		$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+		$this->ui_service->print_button('wl-add-alternative-labels-button', __('Add more titles', 'wordlift'));
 
 	}
 
@@ -402,38 +402,38 @@ 
 	 * @since 3.6.0
 	 *
 	 */
-	public function get_uri( $post_id ) {
+	public function get_uri($post_id) {
 
-		$log = Wordlift_Log_Service::get_logger( get_class() );
+		$log = Wordlift_Log_Service::get_logger(get_class());
 
 		// If a null is given, nothing to do
-		if ( is_null( $post_id ) ) {
+		if (is_null($post_id)) {
 			return null;
 		}
 
 		$dataset_uri = wl_configuration_get_redlink_dataset_uri();
 
-		if ( empty( $dataset_uri ) ) {
+		if (empty($dataset_uri)) {
 			// Continue even if the dataset uri is not properly configured. It is handled in function wl_build_entity_uri()
-			$log->debug( 'Continuing, dataset uri not configured...' );
+			$log->debug('Continuing, dataset uri not configured...');
 		}
 
-		$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, true );
+		$uri = get_post_meta($post_id, WL_ENTITY_URL_META_NAME, true);
 
 		/*
 		 * Consider the URI invalid if it doesn't start with the dataset URI.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/996
 		 */
-		if ( null === $dataset_uri || 0 !== strpos( $uri, $dataset_uri ) ) {
+		if (null === $dataset_uri || 0 !== strpos($uri, $dataset_uri)) {
 			$uri = null;
 		}
 
 		// Set the URI if it isn't set yet.
-		$post_status = get_post_status( $post_id );
-		if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
-			$uri = wl_build_entity_uri( $post_id );
-			wl_set_entity_uri( $post_id, $uri );
+		$post_status = get_post_status($post_id);
+		if (empty($uri) && 'auto-draft' !== $post_status && 'revision' !== $post_status) {
+			$uri = wl_build_entity_uri($post_id);
+			wl_set_entity_uri($post_id, $uri);
 		}
 
 		return $uri;
@@ -449,9 +449,9 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	private function get_alternative_label_input( $value = '' ) {
+	private function get_alternative_label_input($value = '') {
 
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
+		return sprintf(self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr($value), __('Delete', 'wordlift'));
 	}
 
 	/**
@@ -465,13 +465,13 @@ 
 		global $wpdb;
 
 		// Try to get the count from the transient.
-		$count = get_transient( '_wl_entity_service__count' );
-		if ( false !== $count ) {
+		$count = get_transient('_wl_entity_service__count');
+		if (false !== $count) {
 			return $count;
 		}
 
 		// Query the count.
-		$count = $wpdb->get_var( $wpdb->prepare(
+		$count = $wpdb->get_var($wpdb->prepare(
 			"SELECT COUNT( DISTINCT( tr.object_id ) )"
 			. " FROM {$wpdb->term_relationships} tr"
 			. " INNER JOIN {$wpdb->term_taxonomy} tt"
@@ -480,10 +480,10 @@ 
 			. "  ON t.term_id = tt.term_id AND t.name != %s",
 			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
 			'article'
-		) );
+		));
 
 		// Store the count in cache.
-		set_transient( '_wl_entity_service__count', $count, 900 );
+		set_transient('_wl_entity_service__count', $count, 900);
 
 		return $count;
 	}
@@ -498,7 +498,7 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	public static function add_criterias( $args ) {
+	public static function add_criterias($args) {
 
 		// Build an optimal tax-query.
 		$tax_query = array(
@@ -542,28 +542,28 @@ 
 	 * @since 3.9.0
 	 *
 	 */
-	public function create( $name, $type_uri, $logo = null, $status = 'publish' ) {
+	public function create($name, $type_uri, $logo = null, $status = 'publish') {
 
 		// Create an entity for the publisher.
-		$post_id = @wp_insert_post( array(
+		$post_id = @wp_insert_post(array(
 			'post_type'    => self::TYPE_NAME,
 			'post_title'   => $name,
 			'post_status'  => $status,
 			'post_content' => '',
-		) );
+		));
 
 		// Return the error if any.
-		if ( is_wp_error( $post_id ) ) {
+		if (is_wp_error($post_id)) {
 			return $post_id;
 		}
 
 		// Set the entity logo.
-		if ( $logo && is_numeric( $logo ) ) {
-			set_post_thumbnail( $post_id, $logo );
+		if ($logo && is_numeric($logo)) {
+			set_post_thumbnail($post_id, $logo);
 		}
 
 		// Set the entity type.
-		Wordlift_Entity_Type_Service::get_instance()->set( $post_id, $type_uri );
+		Wordlift_Entity_Type_Service::get_instance()->set($post_id, $type_uri);
 
 		return $post_id;
 	}
@@ -579,9 +579,9 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	public function get_related_entities( $id, $post_status = 'publish' ) {
+	public function get_related_entities($id, $post_status = 'publish') {
 
-		return $this->relation_service->get_objects( $id, 'ids', null, $post_status );
+		return $this->relation_service->get_objects($id, 'ids', null, $post_status);
 	}
 
 	/**
@@ -593,16 +593,16 @@ 
 	 * @since 3.12.2
 	 *
 	 */
-	public function get( $params = array() ) {
+	public function get($params = array()) {
 
 		// Set the defaults.
-		$defaults = array( 'post_type' => 'entity' );
+		$defaults = array('post_type' => 'entity');
 
 		// Merge the defaults with the provided parameters.
-		$args = wp_parse_args( $params, $defaults );
+		$args = wp_parse_args($params, $defaults);
 
 		// Call the `get_posts` function.
-		return get_posts( $args );
+		return get_posts($args);
 	}
 
 	/**
@@ -618,9 +618,9 @@ 
 	static function valid_entity_post_types() {
 
 		// Ignore builtins in the call to avoid getting attachments.
-		$post_types = array( 'post', 'page', self::TYPE_NAME, 'product' );
+		$post_types = array('post', 'page', self::TYPE_NAME, 'product');
 
-		return apply_filters( 'wl_valid_entity_post_types', $post_types );
+		return apply_filters('wl_valid_entity_post_types', $post_types);
 	}
 
 }

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

Indentation +697 added lines, -697 removed lines

@@ -13,7 +13,7 @@ 
 use Wordlift\Api\Default_Api_Service;
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -23,705 +23,705 @@ 
  */
 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';
-
-	/**
-	 * 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 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 {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var \Wordlift_Log_Service $log The {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * 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;
-
-	/**
-	 * Create a Wordlift_Configuration_Service's instance.
-	 *
-	 * @since 3.6.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @return \Wordlift_Configuration_Service
-	 * @since 3.6.0
-	 *
-	 */
-	public static function get_instance() {
-
-		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() {
-
-		return $this->get( 'wl_general_settings', self::LANGUAGE, 'en' );
-	}
-
-	/**
-	 * Set WordLift's language code, used when storing strings to the Linked Data dataset.
-	 *
-	 * @param string $value WordLift's language code.
-	 *
-	 * @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 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_features__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'] ) ? $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 );
-
-	}
-
-	/**
-	 * 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 = defined( 'WP_HOME' ) ? WP_HOME : 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();
-		$response    = $api_service->request( 'PUT', $url )->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 ( 200 !== (int) $response['response']['code'] ) {
-			$base_url = $api_service->get_base_url();
-			$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';
+
+    /**
+     * 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 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 {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var \Wordlift_Log_Service $log The {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * 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;
+
+    /**
+     * Create a Wordlift_Configuration_Service's instance.
+     *
+     * @since 3.6.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance.
+     *
+     * @return \Wordlift_Configuration_Service
+     * @since 3.6.0
+     *
+     */
+    public static function get_instance() {
+
+        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() {
+
+        return $this->get( 'wl_general_settings', self::LANGUAGE, 'en' );
+    }
+
+    /**
+     * Set WordLift's language code, used when storing strings to the Linked Data dataset.
+     *
+     * @param string $value WordLift's language code.
+     *
+     * @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 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_features__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'] ) ? $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 );
+
+    }
+
+    /**
+     * 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 = defined( 'WP_HOME' ) ? WP_HOME : 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();
+        $response    = $api_service->request( 'PUT', $url )->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 ( 200 !== (int) $response['response']['code'] ) {
+            $base_url = $api_service->get_base_url();
+            $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'] );
-		$dataset_uri  = $json->datasetURI;
-		$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
-	 *
-	 */
-	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'] ) ? $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;
-	}
+        $json         = json_decode( $response['body'] );
+        $dataset_uri  = $json->datasetURI;
+        $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
+     *
+     */
+    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'] ) ? $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;
+    }
 
 }

Spacing +87 added lines, -87 removed lines

@@ -12,7 +12,7 @@ 
 
 use Wordlift\Api\Default_Api_Service;
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -140,7 +140,7 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		self::$instance = $this;
 
@@ -170,11 +170,11 @@ 
 	 * @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;
 	}
 
 	/**
@@ -187,12 +187,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);
 
 	}
 
@@ -205,7 +205,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');
 	}
 
 	/**
@@ -216,9 +216,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);
 
 	}
 
@@ -231,7 +231,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);
 	}
 
 	/**
@@ -242,9 +242,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);
 
 	}
 
@@ -257,7 +257,7 @@ 
 	 */
 	public function get_key() {
 
-		return $this->get( 'wl_general_settings', self::KEY, '' );
+		return $this->get('wl_general_settings', self::KEY, '');
 	}
 
 	/**
@@ -268,9 +268,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);
 	}
 
 	/**
@@ -284,7 +284,7 @@ 
 	 */
 	public function get_language_code() {
 
-		return $this->get( 'wl_general_settings', self::LANGUAGE, 'en' );
+		return $this->get('wl_general_settings', self::LANGUAGE, 'en');
 	}
 
 	/**
@@ -295,9 +295,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);
 
 	}
 
@@ -309,9 +309,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);
 
 	}
 
@@ -322,7 +322,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');
 	}
 
 	/**
@@ -334,7 +334,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');
 	}
 
 	/**
@@ -345,9 +345,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);
 
 	}
 
@@ -363,7 +363,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);
 	}
 
 	/**
@@ -374,9 +374,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);
 
 	}
 
@@ -390,8 +390,8 @@ 
 	 */
 	public function get_dataset_uri() {
 
-		if ( apply_filters( 'wl_features__enable__dataset', true ) ) {
-			return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
+		if (apply_filters('wl_features__enable__dataset', true)) {
+			return $this->get('wl_advanced_settings', self::DATASET_URI, null);
 		} else {
 			return null;
 		}
@@ -405,9 +405,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);
 	}
 
 	/**
@@ -419,7 +419,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);
 	}
 
 	/**
@@ -430,9 +430,9 @@ 
 	 * @since 3.20.0
 	 *
 	 */
-	public function set_package_type( $value ) {
+	public function set_package_type($value) {
 
-		$this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
+		$this->set('wl_advanced_settings', self::PACKAGE_TYPE, $value);
 	}
 
 	/**
@@ -448,11 +448,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'] ) ? $new_value['key'] : '';
+		$new_key = isset($new_value['key']) ? $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.
@@ -461,12 +461,12 @@ 
 		//		}
 
 		// 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);
 
 	}
 
@@ -482,15 +482,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;
 		}
@@ -505,36 +505,36 @@ 
 		 * @since 3.20.0
 		 *
 		 */
-		$home_url = defined( 'WP_HOME' ) ? WP_HOME : get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+		$home_url = defined('WP_HOME') ? WP_HOME : 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();
-		$response    = $api_service->request( 'PUT', $url )->get_response();
+		$response    = $api_service->request('PUT', $url)->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 ( 200 !== (int) $response['response']['code'] ) {
+		if (200 !== (int) $response['response']['code']) {
 			$base_url = $api_service->get_base_url();
-			$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;
 		}
@@ -544,14 +544,14 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$json         = json_decode( $response['body'] );
+		$json         = json_decode($response['body']);
 		$dataset_uri  = $json->datasetURI;
-		$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);
 
 	}
 
@@ -570,20 +570,20 @@ 
 	 * @since 3.12.0
 	 *
 	 */
-	function maybe_update_dataset_uri( $value, $old_value ) {
+	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'] ) ? $value['key'] : '';
+		$old_key = isset($old_value['key']) ? $old_value['key'] : '';
+		$new_key = isset($value['key']) ? $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;
@@ -598,9 +598,9 @@ 
 	 * @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";
 	}
 
 	/**
@@ -612,7 +612,7 @@ 
 	 */
 	public function get_accounts() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'accounts';
 	}
 
 	/**
@@ -624,7 +624,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');
 	}
 
 	/**
@@ -635,9 +635,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');
 	}
 
 	/**
@@ -648,7 +648,7 @@ 
 	 *
 	 */
 	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');
 	}
 
 	/**
@@ -659,9 +659,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');
 	}
 
 	/**
@@ -672,7 +672,7 @@ 
 	 *
 	 */
 	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);
 	}
 
 	/**
@@ -683,7 +683,7 @@ 
 	 *
 	 */
 	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);
 	}
 
 	/**
@@ -695,7 +695,7 @@ 
 	 */
 	public function get_autocomplete_url() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'autocomplete';
 
 	}
 
@@ -708,7 +708,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';
 
 	}
 

src/includes/class-wordlift-linked-data-service.php

Indentation +318 added lines, -318 removed lines

@@ -18,331 +18,331 @@
  */
 class Wordlift_Linked_Data_Service {
 
-	//<editor-fold desc="## FIELDS">
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * The {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	private $entity_type_service;
-
-	/**
-	 * The {@link Wordlift_Schema_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
-	 */
-	private $schema_service;
-
-	/**
-	 * The {@link Wordlift_Sparql_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Sparql_Service $sparql_service The {@link Wordlift_Sparql_Service} instance.
-	 */
-	private $sparql_service;
-
-	/**
-	 * The {@link Wordlift_Linked_Data_Service} singleton instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Linked_Data_Service $instance The {@link Wordlift_Linked_Data_Service} singleton instance.
-	 */
-	private static $instance;
-	//</editor-fold>
-
-	/**
-	 * Create a {@link Wordlift_Linked_Data_Service} instance.
-	 *
-	 * @param \Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 * @param \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
-	 * @param \Wordlift_Sparql_Service $sparql_service The {@link Wordlift_Sparql_Service} instance.
-	 *
-	 * @since 3.15.0
-	 *
-	 */
-	public function __construct( $entity_service, $entity_type_service, $schema_service, $sparql_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Linked_Data_Service' );
-
-		$this->entity_service      = $entity_service;
-		$this->entity_type_service = $entity_type_service;
-		$this->schema_service      = $schema_service;
-		$this->sparql_service      = $sparql_service;
-
-		/*
+    //<editor-fold desc="## FIELDS">
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * The {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     */
+    private $entity_type_service;
+
+    /**
+     * The {@link Wordlift_Schema_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
+     */
+    private $schema_service;
+
+    /**
+     * The {@link Wordlift_Sparql_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Sparql_Service $sparql_service The {@link Wordlift_Sparql_Service} instance.
+     */
+    private $sparql_service;
+
+    /**
+     * The {@link Wordlift_Linked_Data_Service} singleton instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Linked_Data_Service $instance The {@link Wordlift_Linked_Data_Service} singleton instance.
+     */
+    private static $instance;
+    //</editor-fold>
+
+    /**
+     * Create a {@link Wordlift_Linked_Data_Service} instance.
+     *
+     * @param \Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     * @param \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
+     * @param \Wordlift_Sparql_Service $sparql_service The {@link Wordlift_Sparql_Service} instance.
+     *
+     * @since 3.15.0
+     *
+     */
+    public function __construct( $entity_service, $entity_type_service, $schema_service, $sparql_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Linked_Data_Service' );
+
+        $this->entity_service      = $entity_service;
+        $this->entity_type_service = $entity_type_service;
+        $this->schema_service      = $schema_service;
+        $this->sparql_service      = $sparql_service;
+
+        /*
 		 * Allow callers to call the `push` and `remove` methods using WordPress' hooks.
 		 *
 		 * @since 3.27.6
 		 */
-		add_action( 'wl_legacy_linked_data__push', array( $this, 'push' ) );
-		add_action( 'wl_legacy_linked_data__remove', array( $this, 'remove' ) );
+        add_action( 'wl_legacy_linked_data__push', array( $this, 'push' ) );
+        add_action( 'wl_legacy_linked_data__remove', array( $this, 'remove' ) );
 
-		self::$instance = $this;
+        self::$instance = $this;
 
-	}
+    }
 
-	/**
-	 * Get the singleton instance of {@link Wordlift_Linked_Data_Service}.
-	 *
-	 * @return Wordlift_Linked_Data_Service The singleton instance of <a href='psi_element://Wordlift_Linked_Data_Service'>Wordlift_Linked_Data_Service</a>.
-	 * @since 3.15.0
-	 *
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
+    /**
+     * Get the singleton instance of {@link Wordlift_Linked_Data_Service}.
+     *
+     * @return Wordlift_Linked_Data_Service The singleton instance of <a href='psi_element://Wordlift_Linked_Data_Service'>Wordlift_Linked_Data_Service</a>.
+     * @since 3.15.0
+     *
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
 
-	//<editor-fold desc="## FUNCTIONS">
-
-	/**
-	 * Push a {@link WP_Post} to the Linked Data store.
-	 *
-	 * If the {@link WP_Post} is an entity and it's not of the `Article` type,
-	 * then it is pushed to the remote Linked Data store.
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 *
-	 * @since 3.15.0
-	 *
-	 */
-	public function push( $post_id ) {
-
-		if ( null === Wordlift_Configuration_Service::get_instance()->get_dataset_uri() ) {
-			$this->log->debug( "Post $post_id won't be published because the dataset URI isn't set." );
-
-			return;
-		}
-
-		$this->log->debug( "Pushing post $post_id..." );
-
-		// @since 3.18.0 we don't check anymore if the post is an entity, i.e.
-		// we removed the following:
-		//		if ( ! $this->entity_service->is_entity( $post_id ) ) {
-		//			$this->log->debug( "Post $post_id is not an entity." );
-		//
-		//			return;
-		//		}
-
-		// Get the post and push it to the Linked Data store.
-
-		$this->log->debug( "Doing post $post_id push..." );
-
-		// Get the post.
-		$post = get_post( $post_id );
-
-		// Bail out if the post isn't found.
-		if ( null === $post ) {
-			$this->log->warn( "Post $post_id not found." );
-
-			return;
-		}
-
-		// Bail out if the post isn't published.
-		if ( 'publish' !== $post->post_status ) {
-			$this->log->info( "Post $post_id not published." );
-
-			return;
-		}
-
-		// Bail out if the URI isn't valid.
-		if ( ! $this->has_valid_uri( $post_id ) ) {
-			$this->log->warn( "Post $post_id URI invalid." );
-
-			return;
-		}
-
-		// First remove the post data.
-		$this->remove( $post_id );
-
-		// Then execute the insert query.
-		$this->insert( $post_id );
-
-		// Reindex the triple store if buffering is turned off.
-		if ( false === WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
-			wordlift_reindex_triple_store();
-		}
-
-	}
-
-	/**
-	 * Check if an entity's {@link WP_Post} has a valid URI.
-	 *
-	 * @param int $post_id The entity's {@link WP_Post}'s id.
-	 *
-	 * @return bool True if the URI is valid otherwise false.
-	 * @since 3.15.0
-	 *
-	 */
-	private function has_valid_uri( $post_id ) {
-
-		// Get the entity's URI.
-		$uri = $this->entity_service->get_uri( $post_id );
-
-		// If the URI isn't found, return false.
-		if ( null === $uri ) {
-			return false;
-		}
-
-		// If the URI ends with a trailing slash, return false.
-		if ( '/' === substr( $uri, - 1 ) ) {
-			return false;
-		}
-
-		// URI is valid.
-		return true;
-	}
-
-	/**
-	 * Remove the specified {@link WP_Post} from the Linked Data.
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 *
-	 * @since 3.18.0
-	 *
-	 */
-	public function remove( $post_id ) {
-		$delete_query = '';
-
-		// Get the delete statements.
-		$triples = $this->get_delete_triples( $post_id );
-
-		// Loop through all triples and add the statement to delete query.
-		foreach ( $triples as $item ) {
-			$delete_query .= "DELETE { $item } WHERE { $item }; \n";
-		}
-
-		$this->log->trace( "Delete Query generated [ $delete_query ]." );
-
-		$this->sparql_service->execute( $delete_query );
-	}
-
-	/**
-	 * Insert the specific {@link WP_Post} to Linked Data store.
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 *
-	 * @since 3.18.0
-	 *
-	 */
-	private function insert( $post_id ) {
-		// Get the insert statements.
-		$insert_triples = $this->get_insert_triples( $post_id );
-
-		// Convert all statements to single string.
-		$insert_query_body = implode( "\n", $insert_triples );
-
-		// Build the insert query.
-		$insert_query = "INSERT DATA { $insert_query_body };";
-
-		$this->log->trace( "Insert Query generated [ $insert_query ]." );
-
-		$this->sparql_service->execute( $insert_query );
-	}
-
-	/**
-	 * Get the delete statements.
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 *
-	 * @return array An array of delete statements.
-	 * @since 3.18.0
-	 *
-	 */
-	private function get_delete_triples( $post_id ) {
-		$delete_triples = array();
-
-		// Loop through all renditions and get the triples.
-		foreach ( $this->schema_service->get_renditions() as $rendition ) {
-			// Push the rendition delete triple to $delete_triples.
-			$delete_triples = array_merge(
-				$delete_triples,
-				(array) $rendition->get_delete_triples( $post_id )
-			);
-		}
-
-		/**
-		 * Filter: 'wl_delete_triples' - Allow third parties to hook and add additional delete triples.
-		 *
-		 * @param array $delete_triples Delete triples.
-		 * @param int $post_id The current post ID.
-		 *
-		 * @since 3.18.0
-		 *
-		 */
-		return apply_filters( 'wl_delete_triples', array_unique( $delete_triples ), $post_id );
-	}
-
-	/**
-	 * Get the SPARQL insert triples ( ?s ?p ?o ) for the specified {@link WP_Post}.
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 *
-	 * @return array An array of insert triples.
-	 * @since 3.15.0
-	 *
-	 */
-	private function get_insert_triples( $post_id ) {
-
-		// Get the entity type.
-		$type = $this->entity_type_service->get( $post_id );
-
-		// Get the `linked_data` parameter.
-		$properties = $type['linked_data'];
-
-		// Accumulate the triples.
-		$triples = array();
-
-		/** @var Wordlift_Default_Sparql_Tuple_Rendition $property A {@link Wordlift_Sparql_Tuple_Rendition} instance. */
-		foreach ( $properties as $property ) {
-			foreach ( $property->get_insert_triples( $post_id ) as $triple ) {
-				$triples[] = $triple;
-			}
-		}
-
-		$this->log->trace( count( $properties ) . ' properties and ' . count( $triples ) . " triples found for post $post_id." );
-
-		/**
-		 * Get the INSERT triples properties.
-		 *
-		 * The `wl_insert_triples` filter allows 3rd parties to extend
-		 * the list of triples for SPARQL INSERT statements.
-		 *
-		 * @param array $linked_data A {@link Wordlift_Sparql_Tuple_Rendition} instances.
-		 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-		 * @param int $post_id The {@link WP_Post}'s id.
-		 *
-		 * @since 3.18.0 The hook has been renamed from `wl_insert_tuples_properties` to `wl_insert_triples`.
-		 *
-		 * @since 3.17.0
-		 */
-		return apply_filters( 'wl_insert_triples', $triples, $this->entity_service, $post_id );
-	}
-	//</editor-fold>
+    //<editor-fold desc="## FUNCTIONS">
+
+    /**
+     * Push a {@link WP_Post} to the Linked Data store.
+     *
+     * If the {@link WP_Post} is an entity and it's not of the `Article` type,
+     * then it is pushed to the remote Linked Data store.
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     *
+     * @since 3.15.0
+     *
+     */
+    public function push( $post_id ) {
+
+        if ( null === Wordlift_Configuration_Service::get_instance()->get_dataset_uri() ) {
+            $this->log->debug( "Post $post_id won't be published because the dataset URI isn't set." );
+
+            return;
+        }
+
+        $this->log->debug( "Pushing post $post_id..." );
+
+        // @since 3.18.0 we don't check anymore if the post is an entity, i.e.
+        // we removed the following:
+        //		if ( ! $this->entity_service->is_entity( $post_id ) ) {
+        //			$this->log->debug( "Post $post_id is not an entity." );
+        //
+        //			return;
+        //		}
+
+        // Get the post and push it to the Linked Data store.
+
+        $this->log->debug( "Doing post $post_id push..." );
+
+        // Get the post.
+        $post = get_post( $post_id );
+
+        // Bail out if the post isn't found.
+        if ( null === $post ) {
+            $this->log->warn( "Post $post_id not found." );
+
+            return;
+        }
+
+        // Bail out if the post isn't published.
+        if ( 'publish' !== $post->post_status ) {
+            $this->log->info( "Post $post_id not published." );
+
+            return;
+        }
+
+        // Bail out if the URI isn't valid.
+        if ( ! $this->has_valid_uri( $post_id ) ) {
+            $this->log->warn( "Post $post_id URI invalid." );
+
+            return;
+        }
+
+        // First remove the post data.
+        $this->remove( $post_id );
+
+        // Then execute the insert query.
+        $this->insert( $post_id );
+
+        // Reindex the triple store if buffering is turned off.
+        if ( false === WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
+            wordlift_reindex_triple_store();
+        }
+
+    }
+
+    /**
+     * Check if an entity's {@link WP_Post} has a valid URI.
+     *
+     * @param int $post_id The entity's {@link WP_Post}'s id.
+     *
+     * @return bool True if the URI is valid otherwise false.
+     * @since 3.15.0
+     *
+     */
+    private function has_valid_uri( $post_id ) {
+
+        // Get the entity's URI.
+        $uri = $this->entity_service->get_uri( $post_id );
+
+        // If the URI isn't found, return false.
+        if ( null === $uri ) {
+            return false;
+        }
+
+        // If the URI ends with a trailing slash, return false.
+        if ( '/' === substr( $uri, - 1 ) ) {
+            return false;
+        }
+
+        // URI is valid.
+        return true;
+    }
+
+    /**
+     * Remove the specified {@link WP_Post} from the Linked Data.
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     *
+     * @since 3.18.0
+     *
+     */
+    public function remove( $post_id ) {
+        $delete_query = '';
+
+        // Get the delete statements.
+        $triples = $this->get_delete_triples( $post_id );
+
+        // Loop through all triples and add the statement to delete query.
+        foreach ( $triples as $item ) {
+            $delete_query .= "DELETE { $item } WHERE { $item }; \n";
+        }
+
+        $this->log->trace( "Delete Query generated [ $delete_query ]." );
+
+        $this->sparql_service->execute( $delete_query );
+    }
+
+    /**
+     * Insert the specific {@link WP_Post} to Linked Data store.
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     *
+     * @since 3.18.0
+     *
+     */
+    private function insert( $post_id ) {
+        // Get the insert statements.
+        $insert_triples = $this->get_insert_triples( $post_id );
+
+        // Convert all statements to single string.
+        $insert_query_body = implode( "\n", $insert_triples );
+
+        // Build the insert query.
+        $insert_query = "INSERT DATA { $insert_query_body };";
+
+        $this->log->trace( "Insert Query generated [ $insert_query ]." );
+
+        $this->sparql_service->execute( $insert_query );
+    }
+
+    /**
+     * Get the delete statements.
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     *
+     * @return array An array of delete statements.
+     * @since 3.18.0
+     *
+     */
+    private function get_delete_triples( $post_id ) {
+        $delete_triples = array();
+
+        // Loop through all renditions and get the triples.
+        foreach ( $this->schema_service->get_renditions() as $rendition ) {
+            // Push the rendition delete triple to $delete_triples.
+            $delete_triples = array_merge(
+                $delete_triples,
+                (array) $rendition->get_delete_triples( $post_id )
+            );
+        }
+
+        /**
+         * Filter: 'wl_delete_triples' - Allow third parties to hook and add additional delete triples.
+         *
+         * @param array $delete_triples Delete triples.
+         * @param int $post_id The current post ID.
+         *
+         * @since 3.18.0
+         *
+         */
+        return apply_filters( 'wl_delete_triples', array_unique( $delete_triples ), $post_id );
+    }
+
+    /**
+     * Get the SPARQL insert triples ( ?s ?p ?o ) for the specified {@link WP_Post}.
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     *
+     * @return array An array of insert triples.
+     * @since 3.15.0
+     *
+     */
+    private function get_insert_triples( $post_id ) {
+
+        // Get the entity type.
+        $type = $this->entity_type_service->get( $post_id );
+
+        // Get the `linked_data` parameter.
+        $properties = $type['linked_data'];
+
+        // Accumulate the triples.
+        $triples = array();
+
+        /** @var Wordlift_Default_Sparql_Tuple_Rendition $property A {@link Wordlift_Sparql_Tuple_Rendition} instance. */
+        foreach ( $properties as $property ) {
+            foreach ( $property->get_insert_triples( $post_id ) as $triple ) {
+                $triples[] = $triple;
+            }
+        }
+
+        $this->log->trace( count( $properties ) . ' properties and ' . count( $triples ) . " triples found for post $post_id." );
+
+        /**
+         * Get the INSERT triples properties.
+         *
+         * The `wl_insert_triples` filter allows 3rd parties to extend
+         * the list of triples for SPARQL INSERT statements.
+         *
+         * @param array $linked_data A {@link Wordlift_Sparql_Tuple_Rendition} instances.
+         * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+         * @param int $post_id The {@link WP_Post}'s id.
+         *
+         * @since 3.18.0 The hook has been renamed from `wl_insert_tuples_properties` to `wl_insert_triples`.
+         *
+         * @since 3.17.0
+         */
+        return apply_filters( 'wl_insert_triples', $triples, $this->entity_service, $post_id );
+    }
+    //</editor-fold>
 
 }

Spacing +43 added lines, -43 removed lines

@@ -85,9 +85,9 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	public function __construct( $entity_service, $entity_type_service, $schema_service, $sparql_service ) {
+	public function __construct($entity_service, $entity_type_service, $schema_service, $sparql_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Linked_Data_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Linked_Data_Service');
 
 		$this->entity_service      = $entity_service;
 		$this->entity_type_service = $entity_type_service;
@@ -99,8 +99,8 @@ 
 		 *
 		 * @since 3.27.6
 		 */
-		add_action( 'wl_legacy_linked_data__push', array( $this, 'push' ) );
-		add_action( 'wl_legacy_linked_data__remove', array( $this, 'remove' ) );
+		add_action('wl_legacy_linked_data__push', array($this, 'push'));
+		add_action('wl_legacy_linked_data__remove', array($this, 'remove'));
 
 		self::$instance = $this;
 
@@ -131,15 +131,15 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	public function push( $post_id ) {
+	public function push($post_id) {
 
-		if ( null === Wordlift_Configuration_Service::get_instance()->get_dataset_uri() ) {
-			$this->log->debug( "Post $post_id won't be published because the dataset URI isn't set." );
+		if (null === Wordlift_Configuration_Service::get_instance()->get_dataset_uri()) {
+			$this->log->debug("Post $post_id won't be published because the dataset URI isn't set.");
 
 			return;
 		}
 
-		$this->log->debug( "Pushing post $post_id..." );
+		$this->log->debug("Pushing post $post_id...");
 
 		// @since 3.18.0 we don't check anymore if the post is an entity, i.e.
 		// we removed the following:
@@ -151,40 +151,40 @@ 
 
 		// Get the post and push it to the Linked Data store.
 
-		$this->log->debug( "Doing post $post_id push..." );
+		$this->log->debug("Doing post $post_id push...");
 
 		// Get the post.
-		$post = get_post( $post_id );
+		$post = get_post($post_id);
 
 		// Bail out if the post isn't found.
-		if ( null === $post ) {
-			$this->log->warn( "Post $post_id not found." );
+		if (null === $post) {
+			$this->log->warn("Post $post_id not found.");
 
 			return;
 		}
 
 		// Bail out if the post isn't published.
-		if ( 'publish' !== $post->post_status ) {
-			$this->log->info( "Post $post_id not published." );
+		if ('publish' !== $post->post_status) {
+			$this->log->info("Post $post_id not published.");
 
 			return;
 		}
 
 		// Bail out if the URI isn't valid.
-		if ( ! $this->has_valid_uri( $post_id ) ) {
-			$this->log->warn( "Post $post_id URI invalid." );
+		if ( ! $this->has_valid_uri($post_id)) {
+			$this->log->warn("Post $post_id URI invalid.");
 
 			return;
 		}
 
 		// First remove the post data.
-		$this->remove( $post_id );
+		$this->remove($post_id);
 
 		// Then execute the insert query.
-		$this->insert( $post_id );
+		$this->insert($post_id);
 
 		// Reindex the triple store if buffering is turned off.
-		if ( false === WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
+		if (false === WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING) {
 			wordlift_reindex_triple_store();
 		}
 
@@ -199,18 +199,18 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	private function has_valid_uri( $post_id ) {
+	private function has_valid_uri($post_id) {
 
 		// Get the entity's URI.
-		$uri = $this->entity_service->get_uri( $post_id );
+		$uri = $this->entity_service->get_uri($post_id);
 
 		// If the URI isn't found, return false.
-		if ( null === $uri ) {
+		if (null === $uri) {
 			return false;
 		}
 
 		// If the URI ends with a trailing slash, return false.
-		if ( '/' === substr( $uri, - 1 ) ) {
+		if ('/' === substr($uri, - 1)) {
 			return false;
 		}
 
@@ -226,20 +226,20 @@ 
 	 * @since 3.18.0
 	 *
 	 */
-	public function remove( $post_id ) {
+	public function remove($post_id) {
 		$delete_query = '';
 
 		// Get the delete statements.
-		$triples = $this->get_delete_triples( $post_id );
+		$triples = $this->get_delete_triples($post_id);
 
 		// Loop through all triples and add the statement to delete query.
-		foreach ( $triples as $item ) {
+		foreach ($triples as $item) {
 			$delete_query .= "DELETE { $item } WHERE { $item }; \n";
 		}
 
-		$this->log->trace( "Delete Query generated [ $delete_query ]." );
+		$this->log->trace("Delete Query generated [ $delete_query ].");
 
-		$this->sparql_service->execute( $delete_query );
+		$this->sparql_service->execute($delete_query);
 	}
 
 	/**
@@ -250,19 +250,19 @@ 
 	 * @since 3.18.0
 	 *
 	 */
-	private function insert( $post_id ) {
+	private function insert($post_id) {
 		// Get the insert statements.
-		$insert_triples = $this->get_insert_triples( $post_id );
+		$insert_triples = $this->get_insert_triples($post_id);
 
 		// Convert all statements to single string.
-		$insert_query_body = implode( "\n", $insert_triples );
+		$insert_query_body = implode("\n", $insert_triples);
 
 		// Build the insert query.
 		$insert_query = "INSERT DATA { $insert_query_body };";
 
-		$this->log->trace( "Insert Query generated [ $insert_query ]." );
+		$this->log->trace("Insert Query generated [ $insert_query ].");
 
-		$this->sparql_service->execute( $insert_query );
+		$this->sparql_service->execute($insert_query);
 	}
 
 	/**
@@ -274,15 +274,15 @@ 
 	 * @since 3.18.0
 	 *
 	 */
-	private function get_delete_triples( $post_id ) {
+	private function get_delete_triples($post_id) {
 		$delete_triples = array();
 
 		// Loop through all renditions and get the triples.
-		foreach ( $this->schema_service->get_renditions() as $rendition ) {
+		foreach ($this->schema_service->get_renditions() as $rendition) {
 			// Push the rendition delete triple to $delete_triples.
 			$delete_triples = array_merge(
 				$delete_triples,
-				(array) $rendition->get_delete_triples( $post_id )
+				(array) $rendition->get_delete_triples($post_id)
 			);
 		}
 
@@ -295,7 +295,7 @@ 
 		 * @since 3.18.0
 		 *
 		 */
-		return apply_filters( 'wl_delete_triples', array_unique( $delete_triples ), $post_id );
+		return apply_filters('wl_delete_triples', array_unique($delete_triples), $post_id);
 	}
 
 	/**
@@ -307,10 +307,10 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	private function get_insert_triples( $post_id ) {
+	private function get_insert_triples($post_id) {
 
 		// Get the entity type.
-		$type = $this->entity_type_service->get( $post_id );
+		$type = $this->entity_type_service->get($post_id);
 
 		// Get the `linked_data` parameter.
 		$properties = $type['linked_data'];
@@ -319,13 +319,13 @@ 
 		$triples = array();
 
 		/** @var Wordlift_Default_Sparql_Tuple_Rendition $property A {@link Wordlift_Sparql_Tuple_Rendition} instance. */
-		foreach ( $properties as $property ) {
-			foreach ( $property->get_insert_triples( $post_id ) as $triple ) {
+		foreach ($properties as $property) {
+			foreach ($property->get_insert_triples($post_id) as $triple) {
 				$triples[] = $triple;
 			}
 		}
 
-		$this->log->trace( count( $properties ) . ' properties and ' . count( $triples ) . " triples found for post $post_id." );
+		$this->log->trace(count($properties).' properties and '.count($triples)." triples found for post $post_id.");
 
 		/**
 		 * Get the INSERT triples properties.
@@ -341,7 +341,7 @@ 
 		 *
 		 * @since 3.17.0
 		 */
-		return apply_filters( 'wl_insert_triples', $triples, $this->entity_service, $post_id );
+		return apply_filters('wl_insert_triples', $triples, $this->entity_service, $post_id);
 	}
 	//</editor-fold>