insideout10 / wordlift-plugin

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

Doc Comments +4 added lines, -1 removed lines

@@ -441,6 +441,9 @@ 
 		return $uri;
 	}
 
+	/**
+	 * @param integer $type
+	 */
 	public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {
 
 		if ( Object_Type_Enum::POST === $type ) {
@@ -566,7 +569,7 @@ 
 	 * @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.
+	 * @return integer The entity post id or a {@link WP_Error} in case the `wp_insert_post` call fails.
 	 * @since 3.9.0
 	 *
 	 */

Indentation +610 added lines, -610 removed lines

@@ -18,534 +18,534 @@ 
  */
 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 ( 1 !== preg_match( '~(^|-)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
-	 *
-	 */
-	private function get_uri_for_post( $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 ( 1 !== preg_match( '~(^|-)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
+     *
+     */
+    private function get_uri_for_post( $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;
-	}
-
-	public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {
-
-		if ( Object_Type_Enum::POST === $type ) {
-			return $this->get_uri_for_post( $object_id );
-		}
-
-		if ( Object_Type_Enum::USER === $type ) {
-			$uri = get_user_meta( $object_id, 'entity_url', true );
-			if ( ! empty( $uri ) ) {
-				return $uri;
-			}
-
-			$dataset_uri = wl_configuration_get_redlink_dataset_uri();
-			if ( empty( $dataset_uri ) ) {
-				return get_author_posts_url( $object_id ) . '#author';
-			} else {
-				$user = get_userdata( $object_id );
-				if ( empty( $user->user_nicename ) ) {
-					return null;
-				}
-
-				return sprintf( '%s/author/%s', $dataset_uri, $user->user_nicename );
-			}
-		}
-
-	}
-
-	/**
-	 * 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;
+    }
+
+    public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {
+
+        if ( Object_Type_Enum::POST === $type ) {
+            return $this->get_uri_for_post( $object_id );
+        }
+
+        if ( Object_Type_Enum::USER === $type ) {
+            $uri = get_user_meta( $object_id, 'entity_url', true );
+            if ( ! empty( $uri ) ) {
+                return $uri;
+            }
+
+            $dataset_uri = wl_configuration_get_redlink_dataset_uri();
+            if ( empty( $dataset_uri ) ) {
+                return get_author_posts_url( $object_id ) . '#author';
+            } else {
+                $user = get_userdata( $object_id );
+                if ( empty( $user->user_nicename ) ) {
+                    return null;
+                }
+
+                return sprintf( '%s/author/%s', $dataset_uri, $user->user_nicename );
+            }
+        }
+
+    }
+
+    /**
+     * 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.
@@ -553,102 +553,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 +96 added lines, -96 removed lines

@@ -99,9 +99,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;
@@ -132,17 +132,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;
 		}
 
@@ -153,8 +153,8 @@ 
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 */
-		foreach ( $terms as $term ) {
-			if ( 1 !== preg_match( '~(^|-)article$~', $term->slug ) ) {
+		foreach ($terms as $term) {
+			if (1 !== preg_match('~(^|-)article$~', $term->slug)) {
 				return true;
 			}
 		}
@@ -174,19 +174,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'];
 			}
 		}
@@ -201,13 +201,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
@@ -220,9 +220,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;
 		}
 
@@ -230,13 +230,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;
 		}
 
@@ -256,9 +256,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);
 	}
 
 	/**
@@ -273,10 +273,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;
 		}
 
@@ -286,16 +286,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);
 		}
 
 
@@ -310,28 +310,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);
 			}
 		}
 
@@ -346,9 +346,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);
 	}
 
 	/**
@@ -360,9 +360,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));
 	}
 
 	/**
@@ -373,25 +373,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'));
 
 	}
 
@@ -404,65 +404,65 @@ 
 	 * @since 3.6.0
 	 *
 	 */
-	private function get_uri_for_post( $post_id ) {
+	private function get_uri_for_post($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;
 	}
 
-	public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {
+	public function get_uri($object_id, $type = Object_Type_Enum::POST) {
 
-		if ( Object_Type_Enum::POST === $type ) {
-			return $this->get_uri_for_post( $object_id );
+		if (Object_Type_Enum::POST === $type) {
+			return $this->get_uri_for_post($object_id);
 		}
 
-		if ( Object_Type_Enum::USER === $type ) {
-			$uri = get_user_meta( $object_id, 'entity_url', true );
-			if ( ! empty( $uri ) ) {
+		if (Object_Type_Enum::USER === $type) {
+			$uri = get_user_meta($object_id, 'entity_url', true);
+			if ( ! empty($uri)) {
 				return $uri;
 			}
 
 			$dataset_uri = wl_configuration_get_redlink_dataset_uri();
-			if ( empty( $dataset_uri ) ) {
-				return get_author_posts_url( $object_id ) . '#author';
+			if (empty($dataset_uri)) {
+				return get_author_posts_url($object_id).'#author';
 			} else {
-				$user = get_userdata( $object_id );
-				if ( empty( $user->user_nicename ) ) {
+				$user = get_userdata($object_id);
+				if (empty($user->user_nicename)) {
 					return null;
 				}
 
-				return sprintf( '%s/author/%s', $dataset_uri, $user->user_nicename );
+				return sprintf('%s/author/%s', $dataset_uri, $user->user_nicename);
 			}
 		}
 
@@ -477,9 +477,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'));
 	}
 
 	/**
@@ -493,13 +493,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"
@@ -508,10 +508,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;
 	}
@@ -526,7 +526,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(
@@ -570,28 +570,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;
 	}
@@ -607,9 +607,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);
 	}
 
 	/**
@@ -621,16 +621,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);
 	}
 
 	/**
@@ -646,9 +646,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/wordlift/dataset/class-abstract-sync-object-adapter.php

Doc Comments +7 added lines

@@ -47,11 +47,18 @@
 
 	}
 
+	/**
+	 * @param string $meta_key
+	 * @param boolean $single
+	 */
 	function get_meta( $meta_key, $single ) {
 
 		return call_user_func( $this->get_meta, $this->object_id, $meta_key, $single );
 	}
 
+	/**
+	 * @param string $meta_key
+	 */
 	function update_meta( $meta_key, $meta_value ) {
 
 		call_user_func( $this->update_meta, $this->object_id, $meta_key, $meta_value );

Indentation +36 added lines, -36 removed lines

@@ -7,55 +7,55 @@
 
 abstract class Abstract_Sync_Object_Adapter implements Sync_Object_Adapter {
 
-	private $object_id;
+    private $object_id;
 
-	private $type;
+    private $type;
 
-	private $get_meta;
+    private $get_meta;
 
-	private $update_meta;
+    private $update_meta;
 
-	private static $meta_name = array(
-		Object_Type_Enum::POST => 'post',
-		Object_Type_Enum::TERM => 'term',
-		Object_Type_Enum::USER => 'user',
-	);
+    private static $meta_name = array(
+        Object_Type_Enum::POST => 'post',
+        Object_Type_Enum::TERM => 'term',
+        Object_Type_Enum::USER => 'user',
+    );
 
-	/**
-	 * Sync_Object_Adapter constructor.
-	 *
-	 * @param int $type One of Object_Type_Enum.
-	 * @param int $object_id A post or term id.
-	 * @param Jsonld_Service
-	 *
-	 * @throws \Exception
-	 */
-	function __construct( $type, $object_id ) {
+    /**
+     * Sync_Object_Adapter constructor.
+     *
+     * @param int $type One of Object_Type_Enum.
+     * @param int $object_id A post or term id.
+     * @param Jsonld_Service
+     *
+     * @throws \Exception
+     */
+    function __construct( $type, $object_id ) {
 
-		$this->type      = filter_var( $type, FILTER_VALIDATE_INT );
-		$this->object_id = filter_var( $object_id, FILTER_VALIDATE_INT );
+        $this->type      = filter_var( $type, FILTER_VALIDATE_INT );
+        $this->object_id = filter_var( $object_id, FILTER_VALIDATE_INT );
 
-		if ( null === $this->type || ! isset( self::$meta_name[ $this->type ] ) ) {
-			throw new \Exception( 'Invalid $type.' );
-		}
-		if ( null === $this->object_id ) {
-			throw new \Exception( 'Invalid $object.' );
-		}
+        if ( null === $this->type || ! isset( self::$meta_name[ $this->type ] ) ) {
+            throw new \Exception( 'Invalid $type.' );
+        }
+        if ( null === $this->object_id ) {
+            throw new \Exception( 'Invalid $object.' );
+        }
 
-		$this->get_meta    = sprintf( 'get_%s_meta', self::$meta_name[ $this->type ] );
-		$this->update_meta = sprintf( 'update_%s_meta', self::$meta_name[ $this->type ] );
+        $this->get_meta    = sprintf( 'get_%s_meta', self::$meta_name[ $this->type ] );
+        $this->update_meta = sprintf( 'update_%s_meta', self::$meta_name[ $this->type ] );
 
-	}
+    }
 
-	function get_meta( $meta_key, $single ) {
+    function get_meta( $meta_key, $single ) {
 
-		return call_user_func( $this->get_meta, $this->object_id, $meta_key, $single );
-	}
+        return call_user_func( $this->get_meta, $this->object_id, $meta_key, $single );
+    }
 
-	function update_meta( $meta_key, $meta_value ) {
+    function update_meta( $meta_key, $meta_value ) {
 
-		call_user_func( $this->update_meta, $this->object_id, $meta_key, $meta_value );
+        call_user_func( $this->update_meta, $this->object_id, $meta_key, $meta_value );
 
-	}
+    }
 
 }

Spacing +13 added lines, -13 removed lines

@@ -30,31 +30,31 @@
 	 *
 	 * @throws \Exception
 	 */
-	function __construct( $type, $object_id ) {
+	function __construct($type, $object_id) {
 
-		$this->type      = filter_var( $type, FILTER_VALIDATE_INT );
-		$this->object_id = filter_var( $object_id, FILTER_VALIDATE_INT );
+		$this->type      = filter_var($type, FILTER_VALIDATE_INT);
+		$this->object_id = filter_var($object_id, FILTER_VALIDATE_INT);
 
-		if ( null === $this->type || ! isset( self::$meta_name[ $this->type ] ) ) {
-			throw new \Exception( 'Invalid $type.' );
+		if (null === $this->type || ! isset(self::$meta_name[$this->type])) {
+			throw new \Exception('Invalid $type.');
 		}
-		if ( null === $this->object_id ) {
-			throw new \Exception( 'Invalid $object.' );
+		if (null === $this->object_id) {
+			throw new \Exception('Invalid $object.');
 		}
 
-		$this->get_meta    = sprintf( 'get_%s_meta', self::$meta_name[ $this->type ] );
-		$this->update_meta = sprintf( 'update_%s_meta', self::$meta_name[ $this->type ] );
+		$this->get_meta    = sprintf('get_%s_meta', self::$meta_name[$this->type]);
+		$this->update_meta = sprintf('update_%s_meta', self::$meta_name[$this->type]);
 
 	}
 
-	function get_meta( $meta_key, $single ) {
+	function get_meta($meta_key, $single) {
 
-		return call_user_func( $this->get_meta, $this->object_id, $meta_key, $single );
+		return call_user_func($this->get_meta, $this->object_id, $meta_key, $single);
 	}
 
-	function update_meta( $meta_key, $meta_value ) {
+	function update_meta($meta_key, $meta_value) {
 
-		call_user_func( $this->update_meta, $this->object_id, $meta_key, $meta_value );
+		call_user_func($this->update_meta, $this->object_id, $meta_key, $meta_value);
 
 	}
 

src/wordlift/dataset/class-sync-service.php

Doc Comments +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
 	 * @param int $type
 	 * @param int $object_id
 	 *
-	 * @return array|false
+	 * @return boolean
 	 * @throws \Exception
 	 */
 	public function sync_one( $type, $object_id ) {

Indentation +287 added lines, -287 removed lines

@@ -7,187 +7,187 @@ 
 use Wordlift\Object_Type_Enum;
 
 class Sync_Service {
-	const JSONLD_HASH = '_wl_jsonld_hash';
-	const SYNCED_GMT = '_wl_synced_gmt';
-
-	/**
-	 * @var \Wordlift_Log_Service
-	 */
-	private $log;
-
-	/**
-	 * @var Api_Service
-	 */
-	private $api_service;
-
-	/**
-	 * @var Jsonld_Service
-	 */
-	private $jsonld_service;
-
-	/**
-	 * @var Sync_Background_Process
-	 */
-	private $sync_background_process;
-
-	/**
-	 * The number of posts processed in one call.
-	 *
-	 * @var int The batch size.
-	 */
-	private $batch_size;
-
-	/**
-	 * @var Sync_Object_Adapter_Factory
-	 */
-	private $sync_object_adapter_factory;
-
-	/**
-	 * @var Sync_Service
-	 */
-	private static $instance;
-	private $entity_service;
-
-	/**
-	 * Constructor.
-	 *
-	 * @param Api_Service $api_service The {@link Api_Service} used to communicate with the remote APIs.
-	 * @param Sync_Object_Adapter_Factory $sync_object_adapter_factory
-	 * @param Jsonld_Service $jsonld_service
-	 * @param \Wordlift_Entity_Service $entity_service
-	 */
-	public function __construct( $api_service, $sync_object_adapter_factory, $jsonld_service, $entity_service ) {
-
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->api_service                 = $api_service;
-		$this->sync_object_adapter_factory = $sync_object_adapter_factory;
-		$this->jsonld_service              = $jsonld_service;
-		$this->entity_service              = $entity_service;
-		$this->batch_size                  = 10;
-
-		// You need to initialize this early, otherwise the Background Process isn't registered in AJAX calls.
-		$this->sync_background_process = new Sync_Background_Process( $this );;
-
-		// Exclude the JSONLD_HASH meta key from those that require a resync.
-		add_filter( 'wl_dataset__sync_hooks__ignored_meta_keys', function ( $args ) {
-			$args[] = Sync_Service::JSONLD_HASH;
-			$args[] = Sync_Service::SYNCED_GMT;
-
-			return $args;
-		} );
-
-		self::$instance = $this;
-	}
-
-	public static function get_instance() {
-		return self::$instance;
-	}
-
-	/**
-	 * @param int $type
-	 * @param int $object_id
-	 *
-	 * @return array|false
-	 * @throws \Exception
-	 */
-	public function sync_one( $type, $object_id ) {
-
-		$jsonld_as_string = wp_json_encode( apply_filters( 'wl_dataset__sync_service__sync_item__jsonld',
-			$this->jsonld_service->get( $type, $object_id ), $type, $object_id ) );
-		$new_hash         = sha1( $jsonld_as_string );
-
-		$object   = $this->sync_object_adapter_factory->create( $type, $object_id );
-		$old_hash = $object->get_meta( self::JSONLD_HASH, true );
-
-		// JSON-LD hasn't changed, bail out.
-		if ( $new_hash === $old_hash ) {
-			return false;
-		}
-
-		$uri = $this->entity_service->get_uri( $object_id, $type );
-
-		// Entity URL isn't set, bail out.
-		if ( empty( $uri ) ) {
-			return false;
-		}
-
-		$response = $this->api_service->request(
-			'POST', '/middleware/dataset/batch',
-			array( 'Content-Type' => 'application/json', ),
-			wp_json_encode( array(
-				array(
-					'uri'     => $uri,
-					'model'   => $jsonld_as_string,
-					'private' => ! $object->is_public(),
-				)
-			) ) );
-
-		// Update the sync date in case of success, otherwise log an error.
-		if ( ! $response->is_success() ) {
-			return false;
-		}
-
-		$object->update_meta( self::JSONLD_HASH, $new_hash );
-		$object->update_meta( self::SYNCED_GMT, current_time( 'mysql', true ) );
-
-		return true;
-	}
-
-	public function delete_one( $type, $object_id ) {
-		$object = $this->sync_object_adapter_factory->create( $type, $object_id );
-		$uri    = $object->get_meta( 'entity_url', true );
-
-		// Entity URL isn't set, bail out.
-		if ( empty( $uri ) ) {
-			return false;
-		}
-
-		$response = $this->api_service->request(
-			'DELETE', sprintf( '/middleware/dataset?uri=%s', rawurlencode( $uri ) ) );
-
-		// Update the sync date in case of success, otherwise log an error.
-		if ( ! $response->is_success() ) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Starts a new synchronization.
-	 */
-	public function start() {
-
-		// Create the Sync_Background_Process.
-		$this->sync_background_process->start();
-
-	}
-
-	/**
-	 * Request to cancel a background process.
-	 */
-	public function request_cancel() {
-
-		$this->sync_background_process->request_cancel();
-
-	}
-
-	/**
-	 * Get the next post IDs to synchronize.
-	 *
-	 * @return array An array of post IDs.
-	 */
-	public function next() {
-		global $wpdb;
-
-		$state = $this->info();
-
-		// Limit the query to the allowed post types.
-		$post_type_in = implode( "','", array_map( 'esc_sql', \Wordlift_Entity_Service::valid_entity_post_types() ) );
-
-		// Get the next post ID.
-		return $wpdb->get_col( "
+    const JSONLD_HASH = '_wl_jsonld_hash';
+    const SYNCED_GMT = '_wl_synced_gmt';
+
+    /**
+     * @var \Wordlift_Log_Service
+     */
+    private $log;
+
+    /**
+     * @var Api_Service
+     */
+    private $api_service;
+
+    /**
+     * @var Jsonld_Service
+     */
+    private $jsonld_service;
+
+    /**
+     * @var Sync_Background_Process
+     */
+    private $sync_background_process;
+
+    /**
+     * The number of posts processed in one call.
+     *
+     * @var int The batch size.
+     */
+    private $batch_size;
+
+    /**
+     * @var Sync_Object_Adapter_Factory
+     */
+    private $sync_object_adapter_factory;
+
+    /**
+     * @var Sync_Service
+     */
+    private static $instance;
+    private $entity_service;
+
+    /**
+     * Constructor.
+     *
+     * @param Api_Service $api_service The {@link Api_Service} used to communicate with the remote APIs.
+     * @param Sync_Object_Adapter_Factory $sync_object_adapter_factory
+     * @param Jsonld_Service $jsonld_service
+     * @param \Wordlift_Entity_Service $entity_service
+     */
+    public function __construct( $api_service, $sync_object_adapter_factory, $jsonld_service, $entity_service ) {
+
+        $this->log = \Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->api_service                 = $api_service;
+        $this->sync_object_adapter_factory = $sync_object_adapter_factory;
+        $this->jsonld_service              = $jsonld_service;
+        $this->entity_service              = $entity_service;
+        $this->batch_size                  = 10;
+
+        // You need to initialize this early, otherwise the Background Process isn't registered in AJAX calls.
+        $this->sync_background_process = new Sync_Background_Process( $this );;
+
+        // Exclude the JSONLD_HASH meta key from those that require a resync.
+        add_filter( 'wl_dataset__sync_hooks__ignored_meta_keys', function ( $args ) {
+            $args[] = Sync_Service::JSONLD_HASH;
+            $args[] = Sync_Service::SYNCED_GMT;
+
+            return $args;
+        } );
+
+        self::$instance = $this;
+    }
+
+    public static function get_instance() {
+        return self::$instance;
+    }
+
+    /**
+     * @param int $type
+     * @param int $object_id
+     *
+     * @return array|false
+     * @throws \Exception
+     */
+    public function sync_one( $type, $object_id ) {
+
+        $jsonld_as_string = wp_json_encode( apply_filters( 'wl_dataset__sync_service__sync_item__jsonld',
+            $this->jsonld_service->get( $type, $object_id ), $type, $object_id ) );
+        $new_hash         = sha1( $jsonld_as_string );
+
+        $object   = $this->sync_object_adapter_factory->create( $type, $object_id );
+        $old_hash = $object->get_meta( self::JSONLD_HASH, true );
+
+        // JSON-LD hasn't changed, bail out.
+        if ( $new_hash === $old_hash ) {
+            return false;
+        }
+
+        $uri = $this->entity_service->get_uri( $object_id, $type );
+
+        // Entity URL isn't set, bail out.
+        if ( empty( $uri ) ) {
+            return false;
+        }
+
+        $response = $this->api_service->request(
+            'POST', '/middleware/dataset/batch',
+            array( 'Content-Type' => 'application/json', ),
+            wp_json_encode( array(
+                array(
+                    'uri'     => $uri,
+                    'model'   => $jsonld_as_string,
+                    'private' => ! $object->is_public(),
+                )
+            ) ) );
+
+        // Update the sync date in case of success, otherwise log an error.
+        if ( ! $response->is_success() ) {
+            return false;
+        }
+
+        $object->update_meta( self::JSONLD_HASH, $new_hash );
+        $object->update_meta( self::SYNCED_GMT, current_time( 'mysql', true ) );
+
+        return true;
+    }
+
+    public function delete_one( $type, $object_id ) {
+        $object = $this->sync_object_adapter_factory->create( $type, $object_id );
+        $uri    = $object->get_meta( 'entity_url', true );
+
+        // Entity URL isn't set, bail out.
+        if ( empty( $uri ) ) {
+            return false;
+        }
+
+        $response = $this->api_service->request(
+            'DELETE', sprintf( '/middleware/dataset?uri=%s', rawurlencode( $uri ) ) );
+
+        // Update the sync date in case of success, otherwise log an error.
+        if ( ! $response->is_success() ) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Starts a new synchronization.
+     */
+    public function start() {
+
+        // Create the Sync_Background_Process.
+        $this->sync_background_process->start();
+
+    }
+
+    /**
+     * Request to cancel a background process.
+     */
+    public function request_cancel() {
+
+        $this->sync_background_process->request_cancel();
+
+    }
+
+    /**
+     * Get the next post IDs to synchronize.
+     *
+     * @return array An array of post IDs.
+     */
+    public function next() {
+        global $wpdb;
+
+        $state = $this->info();
+
+        // Limit the query to the allowed post types.
+        $post_type_in = implode( "','", array_map( 'esc_sql', \Wordlift_Entity_Service::valid_entity_post_types() ) );
+
+        // Get the next post ID.
+        return $wpdb->get_col( "
 			SELECT p.ID
 			FROM $wpdb->posts p
 			WHERE p.post_status = 'publish'
@@ -195,118 +195,118 @@ 
 			ORDER BY p.ID
 			LIMIT {$state->index},{$this->batch_size}
 			" );
-	}
+    }
 
-	public function count() {
-		global $wpdb;
-		$post_type_in = implode( "','", array_map( 'esc_sql', \Wordlift_Entity_Service::valid_entity_post_types() ) );
+    public function count() {
+        global $wpdb;
+        $post_type_in = implode( "','", array_map( 'esc_sql', \Wordlift_Entity_Service::valid_entity_post_types() ) );
 
-		return $wpdb->get_var( "
+        return $wpdb->get_var( "
 			SELECT COUNT(1)
 			FROM $wpdb->posts p
 			WHERE p.post_status = 'publish'
 			  AND p.post_type IN ('$post_type_in')
 			" );
-	}
-
-	public function info() {
-		return Sync_Background_Process::get_state();
-	}
-
-	public function sync_items(
-		$post_ids, $clear = true
-	) {
-
-		$this->log->debug( sprintf( 'Synchronizing post(s) %s...', implode( ', ', $post_ids ) ) );
-
-		// If we're starting the sync, try to clear the dataset.
-		if ( $clear && 0 === $this->info()->index ) {
-			$this->api_service->request( 'DELETE', '/middleware/dataset/delete' );
-		}
-
-		$that         = $this;
-		$request_body = array_filter( array_map( function ( $post_id ) use ( $that ) {
-			// Check if the post type is public.
-			$post_type     = get_post_type( $post_id );
-			$post_type_obj = get_post_type_object( $post_type );
-			if ( ! $post_type_obj->public ) {
-				return false;
-			}
-
-			$is_private       = ( 'publish' !== get_post_status( $post_id ) );
-			$uri              = get_post_meta( $post_id, 'entity_url', true );
-			$object_adapter   = $that->sync_object_adapter_factory->create( Object_Type_Enum::POST, $post_id );
-			$jsonld           = $object_adapter->get_jsonld_and_update_hash();
-			$jsonld_as_string = wp_json_encode( $jsonld );
-
-			$that->log->trace( "Posting JSON-LD:\n$jsonld_as_string" );
-
-			return array(
-				'uri'     => $uri,
-				'model'   => $jsonld_as_string,
-				'private' => $is_private
-			);
-		}, $post_ids ) );
-
-		// There's no point in making a request if the request is empty.
-		if ( empty( $request_body ) ) {
-			return true;
-		}
-
-		// Make a request to the remote endpoint.
-		$state              = $this->info();
-		$state_header_value = str_replace( "\n", '', wp_json_encode( $state ) );
-		$response           = $this->api_service->request(
-			'POST', '/middleware/dataset/batch',
-			array(
-				'Content-Type'                     => 'application/json',
-				'X-Wordlift-Dataset-Sync-State-V1' => $state_header_value
-			),
-			wp_json_encode( $request_body ) );
-
-		$this->log->debug( "Response received: " . ( $response->is_success() ? 'yes' : 'no' ) );
-
-		// Update the sync date in case of success, otherwise log an error.
-		if ( $response->is_success() ) {
-
-			foreach ( $post_ids as $post_id ) {
-				update_post_meta( $post_id, '_wl_synced_gmt', current_time( 'mysql', true ) );
-			}
-
-			$this->log->debug( sprintf( 'Posts %s synchronized.', implode( ', ', $post_ids ) ) );
-
-			return true;
-		} else {
-			// @@todo: should we put a limit retry here?
-			$response_dump = var_export( $response, true );
-			$this->log->error(
-				sprintf( 'An error occurred while synchronizing the data for post IDs %s: %s', implode( ', ', $post_ids ), $response_dump ) );
-
-			return false;
-		}
-
-	}
-
-	/**
-	 * @param $post_id
-	 *
-	 * @todo Complete the delete item.
-	 */
-	public function delete_item( $post_id ) {
-		$uri = get_post_meta( $post_id, 'entity_url', true );
-		// Make a request to the remote endpoint.
-		$state_header_value = str_replace( wp_json_encode( $this->info() ), "\n", '' );
-		$response           = $this->api_service->request(
-			'DELETE', '/middleware/dataset?uri=' . rawurlencode( $uri ),
-			array(
-				'Content-Type'                     => 'application/ld+json',
-				'X-Wordlift-Dataset-Sync-State-V1' => $state_header_value
-			) );
-	}
-
-	public function get_batch_size() {
-
-		return $this->batch_size;
-	}
+    }
+
+    public function info() {
+        return Sync_Background_Process::get_state();
+    }
+
+    public function sync_items(
+        $post_ids, $clear = true
+    ) {
+
+        $this->log->debug( sprintf( 'Synchronizing post(s) %s...', implode( ', ', $post_ids ) ) );
+
+        // If we're starting the sync, try to clear the dataset.
+        if ( $clear && 0 === $this->info()->index ) {
+            $this->api_service->request( 'DELETE', '/middleware/dataset/delete' );
+        }
+
+        $that         = $this;
+        $request_body = array_filter( array_map( function ( $post_id ) use ( $that ) {
+            // Check if the post type is public.
+            $post_type     = get_post_type( $post_id );
+            $post_type_obj = get_post_type_object( $post_type );
+            if ( ! $post_type_obj->public ) {
+                return false;
+            }
+
+            $is_private       = ( 'publish' !== get_post_status( $post_id ) );
+            $uri              = get_post_meta( $post_id, 'entity_url', true );
+            $object_adapter   = $that->sync_object_adapter_factory->create( Object_Type_Enum::POST, $post_id );
+            $jsonld           = $object_adapter->get_jsonld_and_update_hash();
+            $jsonld_as_string = wp_json_encode( $jsonld );
+
+            $that->log->trace( "Posting JSON-LD:\n$jsonld_as_string" );
+
+            return array(
+                'uri'     => $uri,
+                'model'   => $jsonld_as_string,
+                'private' => $is_private
+            );
+        }, $post_ids ) );
+
+        // There's no point in making a request if the request is empty.
+        if ( empty( $request_body ) ) {
+            return true;
+        }
+
+        // Make a request to the remote endpoint.
+        $state              = $this->info();
+        $state_header_value = str_replace( "\n", '', wp_json_encode( $state ) );
+        $response           = $this->api_service->request(
+            'POST', '/middleware/dataset/batch',
+            array(
+                'Content-Type'                     => 'application/json',
+                'X-Wordlift-Dataset-Sync-State-V1' => $state_header_value
+            ),
+            wp_json_encode( $request_body ) );
+
+        $this->log->debug( "Response received: " . ( $response->is_success() ? 'yes' : 'no' ) );
+
+        // Update the sync date in case of success, otherwise log an error.
+        if ( $response->is_success() ) {
+
+            foreach ( $post_ids as $post_id ) {
+                update_post_meta( $post_id, '_wl_synced_gmt', current_time( 'mysql', true ) );
+            }
+
+            $this->log->debug( sprintf( 'Posts %s synchronized.', implode( ', ', $post_ids ) ) );
+
+            return true;
+        } else {
+            // @@todo: should we put a limit retry here?
+            $response_dump = var_export( $response, true );
+            $this->log->error(
+                sprintf( 'An error occurred while synchronizing the data for post IDs %s: %s', implode( ', ', $post_ids ), $response_dump ) );
+
+            return false;
+        }
+
+    }
+
+    /**
+     * @param $post_id
+     *
+     * @todo Complete the delete item.
+     */
+    public function delete_item( $post_id ) {
+        $uri = get_post_meta( $post_id, 'entity_url', true );
+        // Make a request to the remote endpoint.
+        $state_header_value = str_replace( wp_json_encode( $this->info() ), "\n", '' );
+        $response           = $this->api_service->request(
+            'DELETE', '/middleware/dataset?uri=' . rawurlencode( $uri ),
+            array(
+                'Content-Type'                     => 'application/ld+json',
+                'X-Wordlift-Dataset-Sync-State-V1' => $state_header_value
+            ) );
+    }
+
+    public function get_batch_size() {
+
+        return $this->batch_size;
+    }
 
 }

Spacing +58 added lines, -58 removed lines

@@ -56,9 +56,9 @@ 
 	 * @param Jsonld_Service $jsonld_service
 	 * @param \Wordlift_Entity_Service $entity_service
 	 */
-	public function __construct( $api_service, $sync_object_adapter_factory, $jsonld_service, $entity_service ) {
+	public function __construct($api_service, $sync_object_adapter_factory, $jsonld_service, $entity_service) {
 
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = \Wordlift_Log_Service::get_logger(get_class());
 
 		$this->api_service                 = $api_service;
 		$this->sync_object_adapter_factory = $sync_object_adapter_factory;
@@ -67,10 +67,10 @@ 
 		$this->batch_size                  = 10;
 
 		// You need to initialize this early, otherwise the Background Process isn't registered in AJAX calls.
-		$this->sync_background_process = new Sync_Background_Process( $this );;
+		$this->sync_background_process = new Sync_Background_Process($this); ;
 
 		// Exclude the JSONLD_HASH meta key from those that require a resync.
-		add_filter( 'wl_dataset__sync_hooks__ignored_meta_keys', function ( $args ) {
+		add_filter('wl_dataset__sync_hooks__ignored_meta_keys', function($args) {
 			$args[] = Sync_Service::JSONLD_HASH;
 			$args[] = Sync_Service::SYNCED_GMT;
 
@@ -91,63 +91,63 @@ 
 	 * @return array|false
 	 * @throws \Exception
 	 */
-	public function sync_one( $type, $object_id ) {
+	public function sync_one($type, $object_id) {
 
-		$jsonld_as_string = wp_json_encode( apply_filters( 'wl_dataset__sync_service__sync_item__jsonld',
-			$this->jsonld_service->get( $type, $object_id ), $type, $object_id ) );
-		$new_hash         = sha1( $jsonld_as_string );
+		$jsonld_as_string = wp_json_encode(apply_filters('wl_dataset__sync_service__sync_item__jsonld',
+			$this->jsonld_service->get($type, $object_id), $type, $object_id));
+		$new_hash         = sha1($jsonld_as_string);
 
-		$object   = $this->sync_object_adapter_factory->create( $type, $object_id );
-		$old_hash = $object->get_meta( self::JSONLD_HASH, true );
+		$object   = $this->sync_object_adapter_factory->create($type, $object_id);
+		$old_hash = $object->get_meta(self::JSONLD_HASH, true);
 
 		// JSON-LD hasn't changed, bail out.
-		if ( $new_hash === $old_hash ) {
+		if ($new_hash === $old_hash) {
 			return false;
 		}
 
-		$uri = $this->entity_service->get_uri( $object_id, $type );
+		$uri = $this->entity_service->get_uri($object_id, $type);
 
 		// Entity URL isn't set, bail out.
-		if ( empty( $uri ) ) {
+		if (empty($uri)) {
 			return false;
 		}
 
 		$response = $this->api_service->request(
 			'POST', '/middleware/dataset/batch',
-			array( 'Content-Type' => 'application/json', ),
-			wp_json_encode( array(
+			array('Content-Type' => 'application/json',),
+			wp_json_encode(array(
 				array(
 					'uri'     => $uri,
 					'model'   => $jsonld_as_string,
 					'private' => ! $object->is_public(),
 				)
-			) ) );
+			)) );
 
 		// Update the sync date in case of success, otherwise log an error.
-		if ( ! $response->is_success() ) {
+		if ( ! $response->is_success()) {
 			return false;
 		}
 
-		$object->update_meta( self::JSONLD_HASH, $new_hash );
-		$object->update_meta( self::SYNCED_GMT, current_time( 'mysql', true ) );
+		$object->update_meta(self::JSONLD_HASH, $new_hash);
+		$object->update_meta(self::SYNCED_GMT, current_time('mysql', true));
 
 		return true;
 	}
 
-	public function delete_one( $type, $object_id ) {
-		$object = $this->sync_object_adapter_factory->create( $type, $object_id );
-		$uri    = $object->get_meta( 'entity_url', true );
+	public function delete_one($type, $object_id) {
+		$object = $this->sync_object_adapter_factory->create($type, $object_id);
+		$uri    = $object->get_meta('entity_url', true);
 
 		// Entity URL isn't set, bail out.
-		if ( empty( $uri ) ) {
+		if (empty($uri)) {
 			return false;
 		}
 
 		$response = $this->api_service->request(
-			'DELETE', sprintf( '/middleware/dataset?uri=%s', rawurlencode( $uri ) ) );
+			'DELETE', sprintf('/middleware/dataset?uri=%s', rawurlencode($uri)) );
 
 		// Update the sync date in case of success, otherwise log an error.
-		if ( ! $response->is_success() ) {
+		if ( ! $response->is_success()) {
 			return false;
 		}
 
@@ -184,29 +184,29 @@ 
 		$state = $this->info();
 
 		// Limit the query to the allowed post types.
-		$post_type_in = implode( "','", array_map( 'esc_sql', \Wordlift_Entity_Service::valid_entity_post_types() ) );
+		$post_type_in = implode("','", array_map('esc_sql', \Wordlift_Entity_Service::valid_entity_post_types()));
 
 		// Get the next post ID.
-		return $wpdb->get_col( "
+		return $wpdb->get_col("
 			SELECT p.ID
 			FROM $wpdb->posts p
 			WHERE p.post_status = 'publish'
 			  AND p.post_type IN ('$post_type_in')
 			ORDER BY p.ID
 			LIMIT {$state->index},{$this->batch_size}
-			" );
+			");
 	}
 
 	public function count() {
 		global $wpdb;
-		$post_type_in = implode( "','", array_map( 'esc_sql', \Wordlift_Entity_Service::valid_entity_post_types() ) );
+		$post_type_in = implode("','", array_map('esc_sql', \Wordlift_Entity_Service::valid_entity_post_types()));
 
-		return $wpdb->get_var( "
+		return $wpdb->get_var("
 			SELECT COUNT(1)
 			FROM $wpdb->posts p
 			WHERE p.post_status = 'publish'
 			  AND p.post_type IN ('$post_type_in')
-			" );
+			");
 	}
 
 	public function info() {
@@ -217,70 +217,70 @@ 
 		$post_ids, $clear = true
 	) {
 
-		$this->log->debug( sprintf( 'Synchronizing post(s) %s...', implode( ', ', $post_ids ) ) );
+		$this->log->debug(sprintf('Synchronizing post(s) %s...', implode(', ', $post_ids)));
 
 		// If we're starting the sync, try to clear the dataset.
-		if ( $clear && 0 === $this->info()->index ) {
-			$this->api_service->request( 'DELETE', '/middleware/dataset/delete' );
+		if ($clear && 0 === $this->info()->index) {
+			$this->api_service->request('DELETE', '/middleware/dataset/delete');
 		}
 
 		$that         = $this;
-		$request_body = array_filter( array_map( function ( $post_id ) use ( $that ) {
+		$request_body = array_filter(array_map(function($post_id) use ($that) {
 			// Check if the post type is public.
-			$post_type     = get_post_type( $post_id );
-			$post_type_obj = get_post_type_object( $post_type );
-			if ( ! $post_type_obj->public ) {
+			$post_type     = get_post_type($post_id);
+			$post_type_obj = get_post_type_object($post_type);
+			if ( ! $post_type_obj->public) {
 				return false;
 			}
 
-			$is_private       = ( 'publish' !== get_post_status( $post_id ) );
-			$uri              = get_post_meta( $post_id, 'entity_url', true );
-			$object_adapter   = $that->sync_object_adapter_factory->create( Object_Type_Enum::POST, $post_id );
+			$is_private       = ('publish' !== get_post_status($post_id));
+			$uri              = get_post_meta($post_id, 'entity_url', true);
+			$object_adapter   = $that->sync_object_adapter_factory->create(Object_Type_Enum::POST, $post_id);
 			$jsonld           = $object_adapter->get_jsonld_and_update_hash();
-			$jsonld_as_string = wp_json_encode( $jsonld );
+			$jsonld_as_string = wp_json_encode($jsonld);
 
-			$that->log->trace( "Posting JSON-LD:\n$jsonld_as_string" );
+			$that->log->trace("Posting JSON-LD:\n$jsonld_as_string");
 
 			return array(
 				'uri'     => $uri,
 				'model'   => $jsonld_as_string,
 				'private' => $is_private
 			);
-		}, $post_ids ) );
+		}, $post_ids));
 
 		// There's no point in making a request if the request is empty.
-		if ( empty( $request_body ) ) {
+		if (empty($request_body)) {
 			return true;
 		}
 
 		// Make a request to the remote endpoint.
 		$state              = $this->info();
-		$state_header_value = str_replace( "\n", '', wp_json_encode( $state ) );
+		$state_header_value = str_replace("\n", '', wp_json_encode($state));
 		$response           = $this->api_service->request(
 			'POST', '/middleware/dataset/batch',
 			array(
 				'Content-Type'                     => 'application/json',
 				'X-Wordlift-Dataset-Sync-State-V1' => $state_header_value
 			),
-			wp_json_encode( $request_body ) );
+			wp_json_encode($request_body) );
 
-		$this->log->debug( "Response received: " . ( $response->is_success() ? 'yes' : 'no' ) );
+		$this->log->debug("Response received: ".($response->is_success() ? 'yes' : 'no'));
 
 		// Update the sync date in case of success, otherwise log an error.
-		if ( $response->is_success() ) {
+		if ($response->is_success()) {
 
-			foreach ( $post_ids as $post_id ) {
-				update_post_meta( $post_id, '_wl_synced_gmt', current_time( 'mysql', true ) );
+			foreach ($post_ids as $post_id) {
+				update_post_meta($post_id, '_wl_synced_gmt', current_time('mysql', true));
 			}
 
-			$this->log->debug( sprintf( 'Posts %s synchronized.', implode( ', ', $post_ids ) ) );
+			$this->log->debug(sprintf('Posts %s synchronized.', implode(', ', $post_ids)));
 
 			return true;
 		} else {
 			// @@todo: should we put a limit retry here?
-			$response_dump = var_export( $response, true );
+			$response_dump = var_export($response, true);
 			$this->log->error(
-				sprintf( 'An error occurred while synchronizing the data for post IDs %s: %s', implode( ', ', $post_ids ), $response_dump ) );
+				sprintf('An error occurred while synchronizing the data for post IDs %s: %s', implode(', ', $post_ids), $response_dump) );
 
 			return false;
 		}
@@ -292,12 +292,12 @@ 
 	 *
 	 * @todo Complete the delete item.
 	 */
-	public function delete_item( $post_id ) {
-		$uri = get_post_meta( $post_id, 'entity_url', true );
+	public function delete_item($post_id) {
+		$uri = get_post_meta($post_id, 'entity_url', true);
 		// Make a request to the remote endpoint.
-		$state_header_value = str_replace( wp_json_encode( $this->info() ), "\n", '' );
+		$state_header_value = str_replace(wp_json_encode($this->info()), "\n", '');
 		$response           = $this->api_service->request(
-			'DELETE', '/middleware/dataset?uri=' . rawurlencode( $uri ),
+			'DELETE', '/middleware/dataset?uri='.rawurlencode($uri),
 			array(
 				'Content-Type'                     => 'application/ld+json',
 				'X-Wordlift-Dataset-Sync-State-V1' => $state_header_value

src/wordlift/dataset/class-sync-object-adapter-factory.php

Indentation +17 added lines, -17 removed lines

@@ -6,24 +6,24 @@
 
 class Sync_Object_Adapter_Factory {
 
-	/**
-	 * @param $type
-	 * @param $object_id
-	 *
-	 * @return Abstract_Sync_Object_Adapter
-	 * @throws \Exception
-	 */
-	function create( $type, $object_id ) {
+    /**
+     * @param $type
+     * @param $object_id
+     *
+     * @return Abstract_Sync_Object_Adapter
+     * @throws \Exception
+     */
+    function create( $type, $object_id ) {
 
-		switch ( $type ) {
-			case Object_Type_Enum::POST:
-				return new Sync_Post_Adapter( $object_id );
-			case Object_Type_Enum::USER:
-				return new Sync_User_Adapter( $object_id );
-			default:
-				throw new \Exception( "Unsupported type $type." );
-		}
+        switch ( $type ) {
+            case Object_Type_Enum::POST:
+                return new Sync_Post_Adapter( $object_id );
+            case Object_Type_Enum::USER:
+                return new Sync_User_Adapter( $object_id );
+            default:
+                throw new \Exception( "Unsupported type $type." );
+        }
 
-	}
+    }
 
 }

Spacing +5 added lines, -5 removed lines

@@ -13,15 +13,15 @@
 	 * @return Abstract_Sync_Object_Adapter
 	 * @throws \Exception
 	 */
-	function create( $type, $object_id ) {
+	function create($type, $object_id) {
 
-		switch ( $type ) {
+		switch ($type) {
 			case Object_Type_Enum::POST:
-				return new Sync_Post_Adapter( $object_id );
+				return new Sync_Post_Adapter($object_id);
 			case Object_Type_Enum::USER:
-				return new Sync_User_Adapter( $object_id );
+				return new Sync_User_Adapter($object_id);
 			default:
-				throw new \Exception( "Unsupported type $type." );
+				throw new \Exception("Unsupported type $type.");
 		}
 
 	}

src/wordlift/dataset/class-sync-user-adapter.php

Indentation +16 added lines, -16 removed lines

@@ -6,23 +6,23 @@
 
 class Sync_User_Adapter extends Abstract_Sync_Object_Adapter {
 
-	/**
-	 * Sync_User_Adapter constructor.
-	 *
-	 * @param int $user_id
-	 *
-	 * @throws \Exception
-	 */
-	function __construct( $user_id ) {
-		parent::__construct( Object_Type_Enum::USER, $user_id );
-	}
+    /**
+     * Sync_User_Adapter constructor.
+     *
+     * @param int $user_id
+     *
+     * @throws \Exception
+     */
+    function __construct( $user_id ) {
+        parent::__construct( Object_Type_Enum::USER, $user_id );
+    }
 
-	function is_published() {
-		return true;
-	}
+    function is_published() {
+        return true;
+    }
 
-	function is_public() {
-		return true;
-	}
+    function is_public() {
+        return true;
+    }
 
 }

Spacing +2 added lines, -2 removed lines

@@ -13,8 +13,8 @@
 	 *
 	 * @throws \Exception
 	 */
-	function __construct( $user_id ) {
-		parent::__construct( Object_Type_Enum::USER, $user_id );
+	function __construct($user_id) {
+		parent::__construct(Object_Type_Enum::USER, $user_id);
 	}
 
 	function is_published() {

src/wordlift/dataset/index.php

Indentation +11 added lines, -11 removed lines

@@ -10,28 +10,28 @@
 use Wordlift\Jsonld\Jsonld_Service;
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 // Register the Dataset JSON Endpoint. The `$api_service` variable must be defined in the calling file (wordlift.php).
 if ( apply_filters( 'wl_feature__enable__dataset-ng', false ) ) {
-	/*
+    /*
 	 * Add Composer Autoload with Mozart support.
 	 *
 	 * @since 3.27.6
 	 */
 //	require dirname( dirname( dirname( __FILE__ ) ) ) . '/vendor/autoload.php';
 
-	$sync_object_adapter_factory = new Sync_Object_Adapter_Factory();
-	$sync_service                = new Sync_Service( $api_service, $sync_object_adapter_factory, Jsonld_Service::get_instance(), Wordlift_Entity_Service::get_instance() );
-	new Sync_Post_Hooks( $sync_service );
-	new Sync_User_Hooks( $sync_service );
+    $sync_object_adapter_factory = new Sync_Object_Adapter_Factory();
+    $sync_service                = new Sync_Service( $api_service, $sync_object_adapter_factory, Jsonld_Service::get_instance(), Wordlift_Entity_Service::get_instance() );
+    new Sync_Post_Hooks( $sync_service );
+    new Sync_User_Hooks( $sync_service );
 //	new Sync_Wpjson_Endpoint( $sync_service );
 //	new Sync_Page();
 
-	/**
-	 * @since 3.28.0
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/1186
-	 */
-	new Sync_Hooks_Entity_Relation( Wordlift_Entity_Service::get_instance() );
+    /**
+     * @since 3.28.0
+     * @see https://github.com/insideout10/wordlift-plugin/issues/1186
+     */
+    new Sync_Hooks_Entity_Relation( Wordlift_Entity_Service::get_instance() );
 
 }

Spacing +6 added lines, -6 removed lines

@@ -9,11 +9,11 @@ 
 use Wordlift\Dataset\Sync_Wpjson_Endpoint;
 use Wordlift\Jsonld\Jsonld_Service;
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 // Register the Dataset JSON Endpoint. The `$api_service` variable must be defined in the calling file (wordlift.php).
-if ( apply_filters( 'wl_feature__enable__dataset-ng', false ) ) {
+if (apply_filters('wl_feature__enable__dataset-ng', false)) {
 	/*
 	 * Add Composer Autoload with Mozart support.
 	 *
@@ -22,9 +22,9 @@ 
 //	require dirname( dirname( dirname( __FILE__ ) ) ) . '/vendor/autoload.php';
 
 	$sync_object_adapter_factory = new Sync_Object_Adapter_Factory();
-	$sync_service                = new Sync_Service( $api_service, $sync_object_adapter_factory, Jsonld_Service::get_instance(), Wordlift_Entity_Service::get_instance() );
-	new Sync_Post_Hooks( $sync_service );
-	new Sync_User_Hooks( $sync_service );
+	$sync_service                = new Sync_Service($api_service, $sync_object_adapter_factory, Jsonld_Service::get_instance(), Wordlift_Entity_Service::get_instance());
+	new Sync_Post_Hooks($sync_service);
+	new Sync_User_Hooks($sync_service);
 //	new Sync_Wpjson_Endpoint( $sync_service );
 //	new Sync_Page();
 
@@ -32,6 +32,6 @@ 
 	 * @since 3.28.0
 	 * @see https://github.com/insideout10/wordlift-plugin/issues/1186
 	 */
-	new Sync_Hooks_Entity_Relation( Wordlift_Entity_Service::get_instance() );
+	new Sync_Hooks_Entity_Relation(Wordlift_Entity_Service::get_instance());
 
 }

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

Indentation +29 added lines, -29 removed lines

@@ -5,34 +5,34 @@
 use Wordlift\Object_Type_Enum;
 
 class Sync_Post_Adapter extends Abstract_Sync_Object_Adapter {
-	/**
-	 * @var int
-	 */
-	private $post_id;
-
-	/**
-	 * Sync_User_Adapter constructor.
-	 *
-	 * @param int $post_id
-	 *
-	 * @throws \Exception
-	 */
-	function __construct( $post_id ) {
-		parent::__construct( Object_Type_Enum::POST, $post_id );
-
-		$this->post_id = $post_id;
-	}
-
-	function is_published() {
-		return ( 'publish' === get_post_status( $this->post_id ) );
-	}
-
-	function is_public() {
-		// Check if the post type is public.
-		$post_type     = get_post_type( $this->post_id );
-		$post_type_obj = get_post_type_object( $post_type );
-
-		return $post_type_obj->public;
-	}
+    /**
+     * @var int
+     */
+    private $post_id;
+
+    /**
+     * Sync_User_Adapter constructor.
+     *
+     * @param int $post_id
+     *
+     * @throws \Exception
+     */
+    function __construct( $post_id ) {
+        parent::__construct( Object_Type_Enum::POST, $post_id );
+
+        $this->post_id = $post_id;
+    }
+
+    function is_published() {
+        return ( 'publish' === get_post_status( $this->post_id ) );
+    }
+
+    function is_public() {
+        // Check if the post type is public.
+        $post_type     = get_post_type( $this->post_id );
+        $post_type_obj = get_post_type_object( $post_type );
+
+        return $post_type_obj->public;
+    }
 
 }

Spacing +5 added lines, -5 removed lines

@@ -17,20 +17,20 @@
 	 *
 	 * @throws \Exception
 	 */
-	function __construct( $post_id ) {
-		parent::__construct( Object_Type_Enum::POST, $post_id );
+	function __construct($post_id) {
+		parent::__construct(Object_Type_Enum::POST, $post_id);
 
 		$this->post_id = $post_id;
 	}
 
 	function is_published() {
-		return ( 'publish' === get_post_status( $this->post_id ) );
+		return ('publish' === get_post_status($this->post_id));
 	}
 
 	function is_public() {
 		// Check if the post type is public.
-		$post_type     = get_post_type( $this->post_id );
-		$post_type_obj = get_post_type_object( $post_type );
+		$post_type     = get_post_type($this->post_id);
+		$post_type_obj = get_post_type_object($post_type);
 
 		return $post_type_obj->public;
 	}

src/wordlift/dataset/class-sync-user-hooks.php

Indentation +65 added lines, -65 removed lines

@@ -5,91 +5,91 @@
 use Wordlift\Object_Type_Enum;
 
 class Sync_User_Hooks {
-	/**
-	 * @var \Wordlift_Log_Service
-	 */
-	private $log;
+    /**
+     * @var \Wordlift_Log_Service
+     */
+    private $log;
 
-	/**
-	 * @var Sync_Service
-	 */
-	private $sync_service;
+    /**
+     * @var Sync_Service
+     */
+    private $sync_service;
 
-	/**
-	 * Sync_User_Hooks constructor.
-	 *
-	 * @param Sync_Service $sync_service
-	 */
-	function __construct( Sync_Service $sync_service ) {
+    /**
+     * Sync_User_Hooks constructor.
+     *
+     * @param Sync_Service $sync_service
+     */
+    function __construct( Sync_Service $sync_service ) {
 
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
+        $this->log = \Wordlift_Log_Service::get_logger( get_class() );
 
-		$this->sync_service = $sync_service;
+        $this->sync_service = $sync_service;
 
-		$this->register_hooks();
+        $this->register_hooks();
 
-	}
+    }
 
-	private function register_hooks() {
-		/**
-		 * Register hooks for user and meta.
-		 */
-		add_action( 'user_register', array( $this, 'changed_user' ) );
-		add_action( 'profile_update', array( $this, 'changed_user' ) );
-		add_action( 'added_user_meta', array( $this, 'changed_user_meta' ), 10, 3 );
-		add_action( 'updated_user_meta', array( $this, 'changed_user_meta' ), 10, 3 );
-		add_action( 'deleted_user_meta', array( $this, 'changed_user_meta' ), 10, 3 );
-		add_action( 'delete_user', array( $this, 'delete_user' ) );
+    private function register_hooks() {
+        /**
+         * Register hooks for user and meta.
+         */
+        add_action( 'user_register', array( $this, 'changed_user' ) );
+        add_action( 'profile_update', array( $this, 'changed_user' ) );
+        add_action( 'added_user_meta', array( $this, 'changed_user_meta' ), 10, 3 );
+        add_action( 'updated_user_meta', array( $this, 'changed_user_meta' ), 10, 3 );
+        add_action( 'deleted_user_meta', array( $this, 'changed_user_meta' ), 10, 3 );
+        add_action( 'delete_user', array( $this, 'delete_user' ) );
 
-	}
+    }
 
-	public function changed_user( $user_id ) {
+    public function changed_user( $user_id ) {
 
-		$this->sync( $user_id );
+        $this->sync( $user_id );
 
-	}
+    }
 
-	public function changed_user_meta( $meta_id, $user_id, $meta_key ) {
+    public function changed_user_meta( $meta_id, $user_id, $meta_key ) {
 
-		if ( in_array( $meta_key,
-			apply_filters( 'wl_dataset__sync_user_hooks__ignored_meta_keys',
-				apply_filters( 'wl_dataset__sync_hooks__ignored_meta_keys',
-					array(
-						'rich_editing',
-						'comment_shortcuts',
-						'admin_color',
-						'use_ssl',
-						'show_admin_bar_front',
-						'wptests_capabilities',
-						'wptests_user_level',
-						'dismissed_wp_pointers',
-						'entity_url',
-					) ) ) ) ) {
-			return;
-		}
+        if ( in_array( $meta_key,
+            apply_filters( 'wl_dataset__sync_user_hooks__ignored_meta_keys',
+                apply_filters( 'wl_dataset__sync_hooks__ignored_meta_keys',
+                    array(
+                        'rich_editing',
+                        'comment_shortcuts',
+                        'admin_color',
+                        'use_ssl',
+                        'show_admin_bar_front',
+                        'wptests_capabilities',
+                        'wptests_user_level',
+                        'dismissed_wp_pointers',
+                        'entity_url',
+                    ) ) ) ) ) {
+            return;
+        }
 
-		$this->sync( $user_id );
+        $this->sync( $user_id );
 
-	}
+    }
 
-	private function sync( $user_id ) {
+    private function sync( $user_id ) {
 
-		try {
-			$this->sync_service->sync_one( Object_Type_Enum::USER, (int) $user_id );
-		} catch ( \Exception $e ) {
-			$this->log->error( "An error occurred while trying to sync user $user_id: " . $e->getMessage(), $e );
-		}
+        try {
+            $this->sync_service->sync_one( Object_Type_Enum::USER, (int) $user_id );
+        } catch ( \Exception $e ) {
+            $this->log->error( "An error occurred while trying to sync user $user_id: " . $e->getMessage(), $e );
+        }
 
-	}
+    }
 
-	public function delete_user( $user_id ) {
+    public function delete_user( $user_id ) {
 
-		try {
-			$this->sync_service->delete_one( Object_Type_Enum::USER, $user_id );
-		} catch ( \Exception $e ) {
-			$this->log->error( "An error occurred while trying to delete user $user_id: " . $e->getMessage(), $e );
-		}
+        try {
+            $this->sync_service->delete_one( Object_Type_Enum::USER, $user_id );
+        } catch ( \Exception $e ) {
+            $this->log->error( "An error occurred while trying to delete user $user_id: " . $e->getMessage(), $e );
+        }
 
-	}
+    }
 
 }
\ No newline at end of file

Spacing +24 added lines, -24 removed lines

@@ -20,9 +20,9 @@ 
 	 *
 	 * @param Sync_Service $sync_service
 	 */
-	function __construct( Sync_Service $sync_service ) {
+	function __construct(Sync_Service $sync_service) {
 
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = \Wordlift_Log_Service::get_logger(get_class());
 
 		$this->sync_service = $sync_service;
 
@@ -34,26 +34,26 @@ 
 		/**
 		 * Register hooks for user and meta.
 		 */
-		add_action( 'user_register', array( $this, 'changed_user' ) );
-		add_action( 'profile_update', array( $this, 'changed_user' ) );
-		add_action( 'added_user_meta', array( $this, 'changed_user_meta' ), 10, 3 );
-		add_action( 'updated_user_meta', array( $this, 'changed_user_meta' ), 10, 3 );
-		add_action( 'deleted_user_meta', array( $this, 'changed_user_meta' ), 10, 3 );
-		add_action( 'delete_user', array( $this, 'delete_user' ) );
+		add_action('user_register', array($this, 'changed_user'));
+		add_action('profile_update', array($this, 'changed_user'));
+		add_action('added_user_meta', array($this, 'changed_user_meta'), 10, 3);
+		add_action('updated_user_meta', array($this, 'changed_user_meta'), 10, 3);
+		add_action('deleted_user_meta', array($this, 'changed_user_meta'), 10, 3);
+		add_action('delete_user', array($this, 'delete_user'));
 
 	}
 
-	public function changed_user( $user_id ) {
+	public function changed_user($user_id) {
 
-		$this->sync( $user_id );
+		$this->sync($user_id);
 
 	}
 
-	public function changed_user_meta( $meta_id, $user_id, $meta_key ) {
+	public function changed_user_meta($meta_id, $user_id, $meta_key) {
 
-		if ( in_array( $meta_key,
-			apply_filters( 'wl_dataset__sync_user_hooks__ignored_meta_keys',
-				apply_filters( 'wl_dataset__sync_hooks__ignored_meta_keys',
+		if (in_array($meta_key,
+			apply_filters('wl_dataset__sync_user_hooks__ignored_meta_keys',
+				apply_filters('wl_dataset__sync_hooks__ignored_meta_keys',
 					array(
 						'rich_editing',
 						'comment_shortcuts',
@@ -64,30 +64,30 @@ 
 						'wptests_user_level',
 						'dismissed_wp_pointers',
 						'entity_url',
-					) ) ) ) ) {
+					))))) {
 			return;
 		}
 
-		$this->sync( $user_id );
+		$this->sync($user_id);
 
 	}
 
-	private function sync( $user_id ) {
+	private function sync($user_id) {
 
 		try {
-			$this->sync_service->sync_one( Object_Type_Enum::USER, (int) $user_id );
-		} catch ( \Exception $e ) {
-			$this->log->error( "An error occurred while trying to sync user $user_id: " . $e->getMessage(), $e );
+			$this->sync_service->sync_one(Object_Type_Enum::USER, (int) $user_id);
+		} catch (\Exception $e) {
+			$this->log->error("An error occurred while trying to sync user $user_id: ".$e->getMessage(), $e);
 		}
 
 	}
 
-	public function delete_user( $user_id ) {
+	public function delete_user($user_id) {
 
 		try {
-			$this->sync_service->delete_one( Object_Type_Enum::USER, $user_id );
-		} catch ( \Exception $e ) {
-			$this->log->error( "An error occurred while trying to delete user $user_id: " . $e->getMessage(), $e );
+			$this->sync_service->delete_one(Object_Type_Enum::USER, $user_id);
+		} catch (\Exception $e) {
+			$this->log->error("An error occurred while trying to delete user $user_id: ".$e->getMessage(), $e);
 		}
 
 	}

src/wordlift/dataset/class-sync-post-hooks.php

Indentation +58 added lines, -58 removed lines

@@ -5,84 +5,84 @@
 use Wordlift\Object_Type_Enum;
 
 class Sync_Post_Hooks {
-	/**
-	 * @var \Wordlift_Log_Service
-	 */
-	private $log;
+    /**
+     * @var \Wordlift_Log_Service
+     */
+    private $log;
 
-	/**
-	 * @var Sync_Service
-	 */
-	private $sync_service;
+    /**
+     * @var Sync_Service
+     */
+    private $sync_service;
 
-	/**
-	 * Sync_Post_Hooks constructor.
-	 *
-	 * @param Sync_Service $sync_service
-	 */
-	function __construct( $sync_service ) {
+    /**
+     * Sync_Post_Hooks constructor.
+     *
+     * @param Sync_Service $sync_service
+     */
+    function __construct( $sync_service ) {
 
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
+        $this->log = \Wordlift_Log_Service::get_logger( get_class() );
 
-		$this->sync_service = $sync_service;
+        $this->sync_service = $sync_service;
 
-		$this->register_hooks();
+        $this->register_hooks();
 
-	}
+    }
 
-	private function register_hooks() {
-		/**
-		 * Register hooks for post and meta.
-		 */
-		add_action( 'save_post', array( $this, 'save_post' ) );
-		add_action( 'added_post_meta', array( $this, 'changed_post_meta' ), 10, 4 );
-		add_action( 'updated_post_meta', array( $this, 'changed_post_meta' ), 10, 4 );
-		add_action( 'deleted_post_meta', array( $this, 'changed_post_meta' ), 10, 4 );
-		add_action( 'delete_post', array( $this, 'delete_post' ) );
+    private function register_hooks() {
+        /**
+         * Register hooks for post and meta.
+         */
+        add_action( 'save_post', array( $this, 'save_post' ) );
+        add_action( 'added_post_meta', array( $this, 'changed_post_meta' ), 10, 4 );
+        add_action( 'updated_post_meta', array( $this, 'changed_post_meta' ), 10, 4 );
+        add_action( 'deleted_post_meta', array( $this, 'changed_post_meta' ), 10, 4 );
+        add_action( 'delete_post', array( $this, 'delete_post' ) );
 
-	}
+    }
 
-	public function save_post( $post_id ) {
+    public function save_post( $post_id ) {
 
-		$this->sync( $post_id );
+        $this->sync( $post_id );
 
-	}
+    }
 
-	public function changed_post_meta( $meta_id, $post_id, $meta_key, $_meta_value ) {
+    public function changed_post_meta( $meta_id, $post_id, $meta_key, $_meta_value ) {
 
-		if ( in_array( $meta_key,
-			apply_filters( 'wl_dataset__sync_post_hooks__ignored_meta_keys',
-				apply_filters( 'wl_dataset__sync_hooks__ignored_meta_keys',
-					array(
-						'_pingme',
-						'_encloseme',
-						'entity_url',
-					) ) ) ) ) {
-			return;
-		}
+        if ( in_array( $meta_key,
+            apply_filters( 'wl_dataset__sync_post_hooks__ignored_meta_keys',
+                apply_filters( 'wl_dataset__sync_hooks__ignored_meta_keys',
+                    array(
+                        '_pingme',
+                        '_encloseme',
+                        'entity_url',
+                    ) ) ) ) ) {
+            return;
+        }
 
-		$this->sync( $post_id );
+        $this->sync( $post_id );
 
-	}
+    }
 
-	private function sync( $post_id ) {
+    private function sync( $post_id ) {
 
-		try {
-			$this->sync_service->sync_one( Object_Type_Enum::POST, $post_id );
-		} catch ( \Exception $e ) {
-			$this->log->error( "An error occurred while trying to sync post $post_id: " . $e->getMessage(), $e );
-		}
+        try {
+            $this->sync_service->sync_one( Object_Type_Enum::POST, $post_id );
+        } catch ( \Exception $e ) {
+            $this->log->error( "An error occurred while trying to sync post $post_id: " . $e->getMessage(), $e );
+        }
 
-	}
+    }
 
-	public function delete_post( $post_id ) {
+    public function delete_post( $post_id ) {
 
-		try {
-			$this->sync_service->delete_one( Object_Type_Enum::POST, $post_id );
-		} catch ( \Exception $e ) {
-			$this->log->error( "An error occurred while trying to delete post $post_id: " . $e->getMessage(), $e );
-		}
+        try {
+            $this->sync_service->delete_one( Object_Type_Enum::POST, $post_id );
+        } catch ( \Exception $e ) {
+            $this->log->error( "An error occurred while trying to delete post $post_id: " . $e->getMessage(), $e );
+        }
 
-	}
+    }
 
 }
\ No newline at end of file

Spacing +23 added lines, -23 removed lines

@@ -20,9 +20,9 @@ 
 	 *
 	 * @param Sync_Service $sync_service
 	 */
-	function __construct( $sync_service ) {
+	function __construct($sync_service) {
 
-		$this->log = \Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = \Wordlift_Log_Service::get_logger(get_class());
 
 		$this->sync_service = $sync_service;
 
@@ -34,53 +34,53 @@ 
 		/**
 		 * Register hooks for post and meta.
 		 */
-		add_action( 'save_post', array( $this, 'save_post' ) );
-		add_action( 'added_post_meta', array( $this, 'changed_post_meta' ), 10, 4 );
-		add_action( 'updated_post_meta', array( $this, 'changed_post_meta' ), 10, 4 );
-		add_action( 'deleted_post_meta', array( $this, 'changed_post_meta' ), 10, 4 );
-		add_action( 'delete_post', array( $this, 'delete_post' ) );
+		add_action('save_post', array($this, 'save_post'));
+		add_action('added_post_meta', array($this, 'changed_post_meta'), 10, 4);
+		add_action('updated_post_meta', array($this, 'changed_post_meta'), 10, 4);
+		add_action('deleted_post_meta', array($this, 'changed_post_meta'), 10, 4);
+		add_action('delete_post', array($this, 'delete_post'));
 
 	}
 
-	public function save_post( $post_id ) {
+	public function save_post($post_id) {
 
-		$this->sync( $post_id );
+		$this->sync($post_id);
 
 	}
 
-	public function changed_post_meta( $meta_id, $post_id, $meta_key, $_meta_value ) {
+	public function changed_post_meta($meta_id, $post_id, $meta_key, $_meta_value) {
 
-		if ( in_array( $meta_key,
-			apply_filters( 'wl_dataset__sync_post_hooks__ignored_meta_keys',
-				apply_filters( 'wl_dataset__sync_hooks__ignored_meta_keys',
+		if (in_array($meta_key,
+			apply_filters('wl_dataset__sync_post_hooks__ignored_meta_keys',
+				apply_filters('wl_dataset__sync_hooks__ignored_meta_keys',
 					array(
 						'_pingme',
 						'_encloseme',
 						'entity_url',
-					) ) ) ) ) {
+					))))) {
 			return;
 		}
 
-		$this->sync( $post_id );
+		$this->sync($post_id);
 
 	}
 
-	private function sync( $post_id ) {
+	private function sync($post_id) {
 
 		try {
-			$this->sync_service->sync_one( Object_Type_Enum::POST, $post_id );
-		} catch ( \Exception $e ) {
-			$this->log->error( "An error occurred while trying to sync post $post_id: " . $e->getMessage(), $e );
+			$this->sync_service->sync_one(Object_Type_Enum::POST, $post_id);
+		} catch (\Exception $e) {
+			$this->log->error("An error occurred while trying to sync post $post_id: ".$e->getMessage(), $e);
 		}
 
 	}
 
-	public function delete_post( $post_id ) {
+	public function delete_post($post_id) {
 
 		try {
-			$this->sync_service->delete_one( Object_Type_Enum::POST, $post_id );
-		} catch ( \Exception $e ) {
-			$this->log->error( "An error occurred while trying to delete post $post_id: " . $e->getMessage(), $e );
+			$this->sync_service->delete_one(Object_Type_Enum::POST, $post_id);
+		} catch (\Exception $e) {
+			$this->log->error("An error occurred while trying to delete post $post_id: ".$e->getMessage(), $e);
 		}
 
 	}