insideout10 / wordlift-plugin

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

Indentation +577 added lines, -577 removed lines

@@ -21,498 +21,498 @@ 
  */
 class Wordlift_Entity_Service {
 
-	/**
-	 * The Log service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log The Log service.
-	 */
-	private $log;
-
-	/**
-	 * 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 {@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>';
 
-	/**
-	 * Create a Wordlift_Entity_Service instance.
-	 *
-	 * @throws Exception if the `$content_service` is not of the `Content_Service` type.
-	 * @since 3.2.0
-	 */
-	protected function __construct() {
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
-
-		$this->entity_uri_service = Wordlift_Entity_Uri_Service::get_instance();
-		$this->relation_service   = Wordlift_Relation_Service::get_instance();
-
-	}
-
-	/**
-	 * 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 = null;
-
-	/**
-	 * 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() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		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 ) {
-
-		// Improve performance by giving for granted that a product is an entity.
-		if ( 'product' === get_post_type( $post_id ) ) {
-			return true;
-		}
-
-		$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;
-		}
-
-		/*
+    /**
+     * Create a Wordlift_Entity_Service instance.
+     *
+     * @throws Exception if the `$content_service` is not of the `Content_Service` type.
+     * @since 3.2.0
+     */
+    protected function __construct() {
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+
+        $this->entity_uri_service = Wordlift_Entity_Uri_Service::get_instance();
+        $this->relation_service   = Wordlift_Relation_Service::get_instance();
+
+    }
+
+    /**
+     * 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 = null;
+
+    /**
+     * 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() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        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 ) {
+
+        // Improve performance by giving for granted that a product is an entity.
+        if ( 'product' === get_post_type( $post_id ) ) {
+            return true;
+        }
+
+        $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
-		// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'], true ) ) {
-				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;
-
-		// Perform the query
-		$relation_instances = (int) $wpdb->get_var(
-			$wpdb->prepare(
-				"SELECT COUNT(*) FROM {$wpdb->prefix}wl_relation_instances WHERE  object_id = %d",
-				$entity->ID
-			)
-		);
-		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
-			return true;
-		}
-
-		// Perform the query
-		$meta_instances = (int) $wpdb->get_var(
-			$wpdb->prepare(
-				"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
-				$entity->ID,
-				wl_get_entity_uri( $entity->ID )
-			)
-		);
-
-		// 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.
-	 *
-	 * This function is called by a hook, so we're not the ones that need to check the `nonce`.
-	 *
-	 * @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.
-	 */
-	public function save_post( $post_id, $post ) {
-		// Avoid doing anything if post is autosave or a revision.
-		if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
-			return;
-		}
-
-		// We expect a numeric value here.
-		if ( ! isset( $_REQUEST['post_ID'] ) || ! is_numeric( $_REQUEST['post_ID'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			return;
-		}
-
-		// Get the numeric post ID from the request.
-		$request_post_id = intval( $_REQUEST['post_ID'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-
-		// 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 ( $request_post_id !== $post_id || ! $this->is_entity( $post_id ) ) {
-			return;
-		}
-
-		if ( isset( $_REQUEST['wl_alternative_label'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			$data = filter_var_array( $_REQUEST, array( 'wl_alternative_label' => array( 'flags' => FILTER_REQUIRE_ARRAY ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			// Get the alt labels from the request (or empty array).
-			$alt_labels = isset( $data['wl_alternative_label'] ) ? $data['wl_alternative_label'] : array();
-			// 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 );
-
-		// Save only unique synonymns.
-		$alt_labels = array_unique( $alt_labels );
-
-		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-
-			// Strip html code from synonym.
-			$alt_label = wp_strip_all_tags( $alt_label );
-
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, (string) $alt_label );
-			}
-		}
-
-	}
-
-	public function append_alternative_labels( $post_id, $labels_to_append ) {
-
-		$merged_labels = $this->get_alternative_labels( $post_id );
-
-		// Append new synonyms to the end.
-		$merged_labels = array_merge( $merged_labels, $labels_to_append );
-
-		$this->set_alternative_labels( $post_id, $merged_labels );
-
-	}
-
-	/**
-	 * 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.
-	 * @param int $object_type The object type {@link Object_Type_Enum}
-	 *
-	 * @return array An array with the entity title and labels.
-	 * @since 3.12.0
-	 */
-	public function get_labels( $post_id, $object_type = Object_Type_Enum::POST ) {
-		if ( Object_Type_Enum::POST === $object_type ) {
-			return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
-		}
-
-		// Term Reference dont have synonyms yet.
-		return array();
-	}
-
-	/**
-	 * 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;
-		}
-
-		// If disabled by filter, return.
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__add-synonyms', true ) ) {
-			return;
-		}
-
-		// Print the input template.
-		Wordlift_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 wp_kses( $this->get_alternative_label_input( $alt_label ), Wordlift_UI_Service::get_template_allowed_html() );
-
-		};
-
-		// Print the button.
-		Wordlift_UI_Service::print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
-
-	}
-
-	public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {
-		$content_service = Wordpress_Content_Service::get_instance();
-		$entity_id       = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
-		$dataset_uri     = Wordlift_Configuration_Service::get_instance()->get_dataset_uri();
-
-		if ( ! isset( $entity_id ) ||
-			 ( ! empty( $dataset_uri ) && 0 !== strpos( $entity_id, $dataset_uri ) ) ) {
-			$rel_uri = Entity_Uri_Generator::create_uri( $type, $object_id );
-			try {
-				$content_service->set_entity_id( new Wordpress_Content_Id( $object_id, $type ), $rel_uri );
-				$entity_id = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
-			} catch ( Exception $e ) {
-				return null;
-			}
-		}
-
-		return $entity_id;
-	}
-
-	/**
-	 * 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 ), esc_html__( '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' => self::valid_entity_post_types(),
-			/*
+        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
+        // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
+        $classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
+        foreach ( $classification_boxes as $cb ) {
+            if ( in_array( $entity_type, $cb['registeredTypes'], true ) ) {
+                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;
+
+        // Perform the query
+        $relation_instances = (int) $wpdb->get_var(
+            $wpdb->prepare(
+                "SELECT COUNT(*) FROM {$wpdb->prefix}wl_relation_instances WHERE  object_id = %d",
+                $entity->ID
+            )
+        );
+        // If there is at least one relation instance for the current entity, then it's used
+        if ( 0 < $relation_instances ) {
+            return true;
+        }
+
+        // Perform the query
+        $meta_instances = (int) $wpdb->get_var(
+            $wpdb->prepare(
+                "SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
+                $entity->ID,
+                wl_get_entity_uri( $entity->ID )
+            )
+        );
+
+        // 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.
+     *
+     * This function is called by a hook, so we're not the ones that need to check the `nonce`.
+     *
+     * @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.
+     */
+    public function save_post( $post_id, $post ) {
+        // Avoid doing anything if post is autosave or a revision.
+        if ( wp_is_post_autosave( $post ) || wp_is_post_revision( $post ) ) {
+            return;
+        }
+
+        // We expect a numeric value here.
+        if ( ! isset( $_REQUEST['post_ID'] ) || ! is_numeric( $_REQUEST['post_ID'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            return;
+        }
+
+        // Get the numeric post ID from the request.
+        $request_post_id = intval( $_REQUEST['post_ID'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+        // 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 ( $request_post_id !== $post_id || ! $this->is_entity( $post_id ) ) {
+            return;
+        }
+
+        if ( isset( $_REQUEST['wl_alternative_label'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            $data = filter_var_array( $_REQUEST, array( 'wl_alternative_label' => array( 'flags' => FILTER_REQUIRE_ARRAY ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            // Get the alt labels from the request (or empty array).
+            $alt_labels = isset( $data['wl_alternative_label'] ) ? $data['wl_alternative_label'] : array();
+            // 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 );
+
+        // Save only unique synonymns.
+        $alt_labels = array_unique( $alt_labels );
+
+        // Set the alternative labels.
+        foreach ( $alt_labels as $alt_label ) {
+
+            // Strip html code from synonym.
+            $alt_label = wp_strip_all_tags( $alt_label );
+
+            if ( ! empty( $alt_label ) ) {
+                add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, (string) $alt_label );
+            }
+        }
+
+    }
+
+    public function append_alternative_labels( $post_id, $labels_to_append ) {
+
+        $merged_labels = $this->get_alternative_labels( $post_id );
+
+        // Append new synonyms to the end.
+        $merged_labels = array_merge( $merged_labels, $labels_to_append );
+
+        $this->set_alternative_labels( $post_id, $merged_labels );
+
+    }
+
+    /**
+     * 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.
+     * @param int $object_type The object type {@link Object_Type_Enum}
+     *
+     * @return array An array with the entity title and labels.
+     * @since 3.12.0
+     */
+    public function get_labels( $post_id, $object_type = Object_Type_Enum::POST ) {
+        if ( Object_Type_Enum::POST === $object_type ) {
+            return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
+        }
+
+        // Term Reference dont have synonyms yet.
+        return array();
+    }
+
+    /**
+     * 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;
+        }
+
+        // If disabled by filter, return.
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( ! apply_filters( 'wl_feature__enable__add-synonyms', true ) ) {
+            return;
+        }
+
+        // Print the input template.
+        Wordlift_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 wp_kses( $this->get_alternative_label_input( $alt_label ), Wordlift_UI_Service::get_template_allowed_html() );
+
+        };
+
+        // Print the button.
+        Wordlift_UI_Service::print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+
+    }
+
+    public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {
+        $content_service = Wordpress_Content_Service::get_instance();
+        $entity_id       = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
+        $dataset_uri     = Wordlift_Configuration_Service::get_instance()->get_dataset_uri();
+
+        if ( ! isset( $entity_id ) ||
+             ( ! empty( $dataset_uri ) && 0 !== strpos( $entity_id, $dataset_uri ) ) ) {
+            $rel_uri = Entity_Uri_Generator::create_uri( $type, $object_id );
+            try {
+                $content_service->set_entity_id( new Wordpress_Content_Id( $object_id, $type ), $rel_uri );
+                $entity_id = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
+            } catch ( Exception $e ) {
+                return null;
+            }
+        }
+
+        return $entity_id;
+    }
+
+    /**
+     * 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 ), esc_html__( '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' => self::valid_entity_post_types(),
+            /*
 			 * Ensure compatibility with Polylang.
 			 *
 			 * @see https://github.com/insideout10/wordlift-plugin/issues/855.
@@ -520,101 +520,101 @@ 
 			 *
 			 * @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.
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		$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
-	 */
-	public 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.
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        $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
+     */
+    public 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 +88 added lines, -88 removed lines

@@ -81,7 +81,7 @@ 
 	 * @since 3.2.0
 	 */
 	protected function __construct() {
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Entity_Service');
 
 		$this->entity_uri_service = Wordlift_Entity_Uri_Service::get_instance();
 		$this->relation_service   = Wordlift_Relation_Service::get_instance();
@@ -105,7 +105,7 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -121,22 +121,22 @@ 
 	 * @return bool Return true if the post is an entity otherwise false.
 	 * @since 3.1.0
 	 */
-	public function is_entity( $post_id ) {
+	public function is_entity($post_id) {
 
 		// Improve performance by giving for granted that a product is an entity.
-		if ( 'product' === get_post_type( $post_id ) ) {
+		if ('product' === get_post_type($post_id)) {
 			return true;
 		}
 
-		$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;
 		}
 
@@ -147,8 +147,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;
 			}
 		}
@@ -167,20 +167,20 @@ 
 	 * @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 ) {
+	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
 		// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'], true ) ) {
+		$classification_boxes = unserialize(WL_CORE_POST_CLASSIFICATION_BOXES);
+		foreach ($classification_boxes as $cb) {
+			if (in_array($entity_type, $cb['registeredTypes'], true)) {
 				return $cb['id'];
 			}
 		}
@@ -195,13 +195,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;
 
@@ -213,7 +213,7 @@ 
 			)
 		);
 		// 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;
 		}
 
@@ -222,12 +222,12 @@ 
 			$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)
 			)
 		);
 
 		// 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;
 		}
 
@@ -246,9 +246,9 @@ 
 	 * @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 ) {
+	public function get_entity_post_by_uri($uri) {
 
-		return $this->entity_uri_service->get_entity( $uri );
+		return $this->entity_uri_service->get_entity($uri);
 	}
 
 	/**
@@ -264,19 +264,19 @@ 
 	 * @param int     $post_id Post ID.
 	 * @param WP_Post $post Post object.
 	 */
-	public function save_post( $post_id, $post ) {
+	public function save_post($post_id, $post) {
 		// 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;
 		}
 
 		// We expect a numeric value here.
-		if ( ! isset( $_REQUEST['post_ID'] ) || ! is_numeric( $_REQUEST['post_ID'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( ! isset($_REQUEST['post_ID']) || ! is_numeric($_REQUEST['post_ID'])) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 			return;
 		}
 
 		// Get the numeric post ID from the request.
-		$request_post_id = intval( $_REQUEST['post_ID'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$request_post_id = intval($_REQUEST['post_ID']); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
 		// 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
@@ -284,16 +284,16 @@ 
 		// the $post_id in the save_post call matches the post id set in the request.
 		//
 		// If this is not the current post being saved or if it's not an entity, return.
-		if ( $request_post_id !== $post_id || ! $this->is_entity( $post_id ) ) {
+		if ($request_post_id !== $post_id || ! $this->is_entity($post_id)) {
 			return;
 		}
 
-		if ( isset( $_REQUEST['wl_alternative_label'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			$data = filter_var_array( $_REQUEST, array( 'wl_alternative_label' => array( 'flags' => FILTER_REQUIRE_ARRAY ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if (isset($_REQUEST['wl_alternative_label'])) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			$data = filter_var_array($_REQUEST, array('wl_alternative_label' => array('flags' => FILTER_REQUIRE_ARRAY))); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 			// Get the alt labels from the request (or empty array).
-			$alt_labels = isset( $data['wl_alternative_label'] ) ? $data['wl_alternative_label'] : array();
+			$alt_labels = isset($data['wl_alternative_label']) ? $data['wl_alternative_label'] : array();
 			// 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);
 		}
 
 	}
@@ -306,48 +306,48 @@ 
 	 *
 	 * @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);
 
 		// Save only unique synonymns.
-		$alt_labels = array_unique( $alt_labels );
+		$alt_labels = array_unique($alt_labels);
 
 		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
+		foreach ($alt_labels as $alt_label) {
 
 			// Strip html code from synonym.
-			$alt_label = wp_strip_all_tags( $alt_label );
+			$alt_label = wp_strip_all_tags($alt_label);
 
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, (string) $alt_label );
+			if ( ! empty($alt_label)) {
+				add_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY, (string) $alt_label);
 			}
 		}
 
 	}
 
-	public function append_alternative_labels( $post_id, $labels_to_append ) {
+	public function append_alternative_labels($post_id, $labels_to_append) {
 
-		$merged_labels = $this->get_alternative_labels( $post_id );
+		$merged_labels = $this->get_alternative_labels($post_id);
 
 		// Append new synonyms to the end.
-		$merged_labels = array_merge( $merged_labels, $labels_to_append );
+		$merged_labels = array_merge($merged_labels, $labels_to_append);
 
-		$this->set_alternative_labels( $post_id, $merged_labels );
+		$this->set_alternative_labels($post_id, $merged_labels);
 
 	}
 
@@ -359,9 +359,9 @@ 
 	 * @return mixed An array  of alternative labels.
 	 * @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);
 	}
 
 	/**
@@ -373,9 +373,9 @@ 
 	 * @return array An array with the entity title and labels.
 	 * @since 3.12.0
 	 */
-	public function get_labels( $post_id, $object_type = Object_Type_Enum::POST ) {
-		if ( Object_Type_Enum::POST === $object_type ) {
-			return array_merge( (array) get_the_title( $post_id ), $this->get_alternative_labels( $post_id ) );
+	public function get_labels($post_id, $object_type = Object_Type_Enum::POST) {
+		if (Object_Type_Enum::POST === $object_type) {
+			return array_merge((array) get_the_title($post_id), $this->get_alternative_labels($post_id));
 		}
 
 		// Term Reference dont have synonyms yet.
@@ -389,46 +389,46 @@ 
 	 *
 	 * @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;
 		}
 
 		// If disabled by filter, return.
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__add-synonyms', true ) ) {
+		if ( ! apply_filters('wl_feature__enable__add-synonyms', true)) {
 			return;
 		}
 
 		// Print the input template.
-		Wordlift_UI_Service::print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+		Wordlift_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 wp_kses( $this->get_alternative_label_input( $alt_label ), Wordlift_UI_Service::get_template_allowed_html() );
+			echo wp_kses($this->get_alternative_label_input($alt_label), Wordlift_UI_Service::get_template_allowed_html());
 
 		};
 
 		// Print the button.
-		Wordlift_UI_Service::print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+		Wordlift_UI_Service::print_button('wl-add-alternative-labels-button', __('Add more titles', 'wordlift'));
 
 	}
 
-	public function get_uri( $object_id, $type = Object_Type_Enum::POST ) {
+	public function get_uri($object_id, $type = Object_Type_Enum::POST) {
 		$content_service = Wordpress_Content_Service::get_instance();
-		$entity_id       = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
+		$entity_id       = $content_service->get_entity_id(new Wordpress_Content_Id($object_id, $type));
 		$dataset_uri     = Wordlift_Configuration_Service::get_instance()->get_dataset_uri();
 
-		if ( ! isset( $entity_id ) ||
-			 ( ! empty( $dataset_uri ) && 0 !== strpos( $entity_id, $dataset_uri ) ) ) {
-			$rel_uri = Entity_Uri_Generator::create_uri( $type, $object_id );
+		if ( ! isset($entity_id) ||
+			 ( ! empty($dataset_uri) && 0 !== strpos($entity_id, $dataset_uri))) {
+			$rel_uri = Entity_Uri_Generator::create_uri($type, $object_id);
 			try {
-				$content_service->set_entity_id( new Wordpress_Content_Id( $object_id, $type ), $rel_uri );
-				$entity_id = $content_service->get_entity_id( new Wordpress_Content_Id( $object_id, $type ) );
-			} catch ( Exception $e ) {
+				$content_service->set_entity_id(new Wordpress_Content_Id($object_id, $type), $rel_uri);
+				$entity_id = $content_service->get_entity_id(new Wordpress_Content_Id($object_id, $type));
+			} catch (Exception $e) {
 				return null;
 			}
 		}
@@ -444,9 +444,9 @@ 
 	 * @return string The input HTML code.
 	 * @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 ), esc_html__( 'Delete', 'wordlift' ) );
+		return sprintf(self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr($value), esc_html__('Delete', 'wordlift'));
 	}
 
 	/**
@@ -459,8 +459,8 @@ 
 		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;
 		}
 
@@ -479,7 +479,7 @@ 
 		);
 
 		// Store the count in cache.
-		set_transient( '_wl_entity_service__count', $count, 900 );
+		set_transient('_wl_entity_service__count', $count, 900);
 
 		return $count;
 	}
@@ -493,7 +493,7 @@ 
 	 * @return array The arguments for a `get_posts` call.
 	 * @since 3.15.0
 	 */
-	public static function add_criterias( $args ) {
+	public static function add_criterias($args) {
 
 		// Build an optimal tax-query.
 		$tax_query = array(
@@ -536,7 +536,7 @@ 
 	 * @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' ) {
+	public function create($name, $type_uri, $logo = null, $status = 'publish') {
 
 		// Create an entity for the publisher.
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
@@ -550,17 +550,17 @@ 
 		);
 
 		// 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;
 	}
@@ -575,9 +575,9 @@ 
 	 * @return array An array of post ids.
 	 * @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);
 	}
 
 	/**
@@ -588,16 +588,16 @@ 
 	 * @return array An array of entity posts.
 	 * @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);
 	}
 
 	/**
@@ -612,9 +612,9 @@ 
 	public static function valid_entity_post_types() {
 
 		// Ignore builtins in the call to avoid getting attachments.
-		$post_types = array( 'post', 'page', self::TYPE_NAME, 'product' );
+		$post_types = array('post', 'page', self::TYPE_NAME, 'product');
 
-		return apply_filters( 'wl_valid_entity_post_types', $post_types );
+		return apply_filters('wl_valid_entity_post_types', $post_types);
 	}
 
 }

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

Indentation +94 added lines, -94 removed lines

@@ -7,110 +7,110 @@
  */
 class Wordlift_UI_Service {
 
-	/**
-	 * The button element HTML code.
-	 *
-	 * @since 3.2.0
-	 */
-	const BUTTON_HTML = '<a id="%s" class="button wl-button">%s</a>';
+    /**
+     * The button element HTML code.
+     *
+     * @since 3.2.0
+     */
+    const BUTTON_HTML = '<a id="%s" class="button wl-button">%s</a>';
 
-	/**
-	 * The template HTML code.
-	 *
-	 * @since 3.2.0
-	 */
-	const TEMPLATE_HTML = '<script id="%s" type="text/template">%s</script>';
+    /**
+     * The template HTML code.
+     *
+     * @since 3.2.0
+     */
+    const TEMPLATE_HTML = '<script id="%s" type="text/template">%s</script>';
 
-	/**
-	 * Get the button HTML.
-	 *
-	 * @param string $element_id The button element id.
-	 * @param string $label The button (translated) label.
-	 *
-	 * @return string The button HTML code.
-	 * @since 3.2.0
-	 */
-	public static function get_button_html( $element_id, $label ) {
+    /**
+     * Get the button HTML.
+     *
+     * @param string $element_id The button element id.
+     * @param string $label The button (translated) label.
+     *
+     * @return string The button HTML code.
+     * @since 3.2.0
+     */
+    public static function get_button_html( $element_id, $label ) {
 
-		return sprintf( self::BUTTON_HTML, $element_id, esc_html( $label ) );
-	}
+        return sprintf( self::BUTTON_HTML, $element_id, esc_html( $label ) );
+    }
 
-	/**
-	 * Echo the button HTML.
-	 *
-	 * @param string $element_id The button element id.
-	 * @param string $label The button (translated) label.
-	 *
-	 * @since 3.2.0
-	 */
-	public static function print_button( $element_id, $label ) {
+    /**
+     * Echo the button HTML.
+     *
+     * @param string $element_id The button element id.
+     * @param string $label The button (translated) label.
+     *
+     * @since 3.2.0
+     */
+    public static function print_button( $element_id, $label ) {
 
-		echo wp_kses(
-			self::get_button_html( $element_id, $label ),
-			array(
-				'a' => array(
-					'id'    => array(),
-					'class' => array(),
-				),
-			)
-		);
+        echo wp_kses(
+            self::get_button_html( $element_id, $label ),
+            array(
+                'a' => array(
+                    'id'    => array(),
+                    'class' => array(),
+                ),
+            )
+        );
 
-	}
+    }
 
-	/**
-	 * Get the HTML code for a template tag.
-	 *
-	 * @param string $element_id The element id.
-	 * @param string $body The element content.
-	 *
-	 * @return string The HTML code.
-	 * @since 3.2.0
-	 */
-	public static function get_template_html( $element_id, $body ) {
+    /**
+     * Get the HTML code for a template tag.
+     *
+     * @param string $element_id The element id.
+     * @param string $body The element content.
+     *
+     * @return string The HTML code.
+     * @since 3.2.0
+     */
+    public static function get_template_html( $element_id, $body ) {
 
-		return sprintf( self::TEMPLATE_HTML, $element_id, $body );
-	}
+        return sprintf( self::TEMPLATE_HTML, $element_id, $body );
+    }
 
-	/**
-	 * Echo the HTML code for a template tag.
-	 *
-	 * @param string $element_id The element id.
-	 * @param string $body The element content.
-	 *
-	 * @since 3.2.0
-	 */
-	public static function print_template( $element_id, $body ) {
+    /**
+     * Echo the HTML code for a template tag.
+     *
+     * @param string $element_id The element id.
+     * @param string $body The element content.
+     *
+     * @since 3.2.0
+     */
+    public static function print_template( $element_id, $body ) {
 
-		echo wp_kses(
-			self::get_template_html( $element_id, $body ),
-			self::get_template_allowed_html()
-		);
-	}
+        echo wp_kses(
+            self::get_template_html( $element_id, $body ),
+            self::get_template_allowed_html()
+        );
+    }
 
-	/**
-	 * @return array[]
-	 */
-	public static function get_template_allowed_html() {
-		return array(
-			'div'    => array( 'class' => array() ),
-			'label'  => array(
-				'class' => array(),
-				'id'    => array(),
-				'for'   => array(),
-			),
-			'input'  => array(
-				'name'  => array(),
-				'size'  => array(),
-				'value' => array(),
-				'id'    => array(),
-				'type'  => array(),
-			),
-			'button' => array( 'class' => array() ),
-			'script' => array(
-				'id'   => array(),
-				'type' => array(),
-			),
-		);
-	}
+    /**
+     * @return array[]
+     */
+    public static function get_template_allowed_html() {
+        return array(
+            'div'    => array( 'class' => array() ),
+            'label'  => array(
+                'class' => array(),
+                'id'    => array(),
+                'for'   => array(),
+            ),
+            'input'  => array(
+                'name'  => array(),
+                'size'  => array(),
+                'value' => array(),
+                'id'    => array(),
+                'type'  => array(),
+            ),
+            'button' => array( 'class' => array() ),
+            'script' => array(
+                'id'   => array(),
+                'type' => array(),
+            ),
+        );
+    }
 
 }

Spacing +10 added lines, -10 removed lines

@@ -30,9 +30,9 @@ 
 	 * @return string The button HTML code.
 	 * @since 3.2.0
 	 */
-	public static function get_button_html( $element_id, $label ) {
+	public static function get_button_html($element_id, $label) {
 
-		return sprintf( self::BUTTON_HTML, $element_id, esc_html( $label ) );
+		return sprintf(self::BUTTON_HTML, $element_id, esc_html($label));
 	}
 
 	/**
@@ -43,10 +43,10 @@ 
 	 *
 	 * @since 3.2.0
 	 */
-	public static function print_button( $element_id, $label ) {
+	public static function print_button($element_id, $label) {
 
 		echo wp_kses(
-			self::get_button_html( $element_id, $label ),
+			self::get_button_html($element_id, $label),
 			array(
 				'a' => array(
 					'id'    => array(),
@@ -66,9 +66,9 @@ 
 	 * @return string The HTML code.
 	 * @since 3.2.0
 	 */
-	public static function get_template_html( $element_id, $body ) {
+	public static function get_template_html($element_id, $body) {
 
-		return sprintf( self::TEMPLATE_HTML, $element_id, $body );
+		return sprintf(self::TEMPLATE_HTML, $element_id, $body);
 	}
 
 	/**
@@ -79,10 +79,10 @@ 
 	 *
 	 * @since 3.2.0
 	 */
-	public static function print_template( $element_id, $body ) {
+	public static function print_template($element_id, $body) {
 
 		echo wp_kses(
-			self::get_template_html( $element_id, $body ),
+			self::get_template_html($element_id, $body),
 			self::get_template_allowed_html()
 		);
 	}
@@ -92,7 +92,7 @@ 
 	 */
 	public static function get_template_allowed_html() {
 		return array(
-			'div'    => array( 'class' => array() ),
+			'div'    => array('class' => array()),
 			'label'  => array(
 				'class' => array(),
 				'id'    => array(),
@@ -105,7 +105,7 @@ 
 				'id'    => array(),
 				'type'  => array(),
 			),
-			'button' => array( 'class' => array() ),
+			'button' => array('class' => array()),
 			'script' => array(
 				'id'   => array(),
 				'type' => array(),

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

Indentation +213 added lines, -213 removed lines

@@ -14,223 +14,223 @@
  */
 class Wordlift_Entity_Type_Taxonomy_Service {
 
-	/**
-	 * The WordPress taxonomy name.
-	 *
-	 * @since 1.0.0
-	 */
-	const TAXONOMY_NAME = 'wl_entity_type';
-
-	/**
-	 * Register the taxonomies.
-	 *
-	 * @since 3.23.6 we hook to `wp_get_object_terms` to ensure that a term is returned when a post is queries for the
-	 *               `wl_entity_type` taxonomy.
-	 * @since 3.18.0
-	 */
-	public function init() {
-
-		$labels = array(
-			'name'              => _x( 'Entity Types', 'taxonomy general name', 'wordlift' ),
-			'singular_name'     => _x( 'Entity Type', 'taxonomy singular name', 'wordlift' ),
-			'search_items'      => __( 'Search Entity Types', 'wordlift' ),
-			'all_items'         => __( 'All Entity Types', 'wordlift' ),
-			'parent_item'       => __( 'Parent Entity Type', 'wordlift' ),
-			'parent_item_colon' => __( 'Parent Entity Type:', 'wordlift' ),
-			'edit_item'         => __( 'Edit Entity Type', 'wordlift' ),
-			'update_item'       => __( 'Update Entity Type', 'wordlift' ),
-			'add_new_item'      => __( 'Add New Entity Type', 'wordlift' ),
-			'new_item_name'     => __( 'New Entity Type', 'wordlift' ),
-			'menu_name'         => __( 'Entity Types', 'wordlift' ),
-		);
-
-		// Take away GUI for taxonomy editing.
-		// TODO: read capabilities when editing of the WL <-> schema.org mapping is possible.
-		$capabilities = array(
-			// We enable editors to change the title/description of terms:
-			//
-			// @see https://github.com/insideout10/wordlift-plugin/issues/398.
-			'manage_terms' => 'manage_options',
-			'edit_terms'   => 'wl_entity_type_edit_term',
-			'delete_terms' => 'wl_entity_type_delete_term',
-			'assign_terms' => 'edit_posts',
-		);
-
-		$args = array(
-			'labels'             => $labels,
-			'capabilities'       => $capabilities,
-			'hierarchical'       => true,
-			// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-			'show_admin_column'  => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ),
-			// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-			'show_in_rest'       => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ),
-			'show_in_quick_edit' => false,
-			'publicly_queryable' => false,
-		);
-
-		/*
+    /**
+     * The WordPress taxonomy name.
+     *
+     * @since 1.0.0
+     */
+    const TAXONOMY_NAME = 'wl_entity_type';
+
+    /**
+     * Register the taxonomies.
+     *
+     * @since 3.23.6 we hook to `wp_get_object_terms` to ensure that a term is returned when a post is queries for the
+     *               `wl_entity_type` taxonomy.
+     * @since 3.18.0
+     */
+    public function init() {
+
+        $labels = array(
+            'name'              => _x( 'Entity Types', 'taxonomy general name', 'wordlift' ),
+            'singular_name'     => _x( 'Entity Type', 'taxonomy singular name', 'wordlift' ),
+            'search_items'      => __( 'Search Entity Types', 'wordlift' ),
+            'all_items'         => __( 'All Entity Types', 'wordlift' ),
+            'parent_item'       => __( 'Parent Entity Type', 'wordlift' ),
+            'parent_item_colon' => __( 'Parent Entity Type:', 'wordlift' ),
+            'edit_item'         => __( 'Edit Entity Type', 'wordlift' ),
+            'update_item'       => __( 'Update Entity Type', 'wordlift' ),
+            'add_new_item'      => __( 'Add New Entity Type', 'wordlift' ),
+            'new_item_name'     => __( 'New Entity Type', 'wordlift' ),
+            'menu_name'         => __( 'Entity Types', 'wordlift' ),
+        );
+
+        // Take away GUI for taxonomy editing.
+        // TODO: read capabilities when editing of the WL <-> schema.org mapping is possible.
+        $capabilities = array(
+            // We enable editors to change the title/description of terms:
+            //
+            // @see https://github.com/insideout10/wordlift-plugin/issues/398.
+            'manage_terms' => 'manage_options',
+            'edit_terms'   => 'wl_entity_type_edit_term',
+            'delete_terms' => 'wl_entity_type_delete_term',
+            'assign_terms' => 'edit_posts',
+        );
+
+        $args = array(
+            'labels'             => $labels,
+            'capabilities'       => $capabilities,
+            'hierarchical'       => true,
+            // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+            'show_admin_column'  => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ),
+            // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+            'show_in_rest'       => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ),
+            'show_in_quick_edit' => false,
+            'publicly_queryable' => false,
+        );
+
+        /*
 		 * If `All Entity Types` is enabled, use the new metabox.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 * @since 3.20.0
 		 */
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( apply_filters( 'wl_feature__enable__all-entity-types', WL_ALL_ENTITY_TYPES ) ) {
-			// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-			$args['meta_box_cb'] = apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ) ? array(
-				'Wordlift_Admin_Schemaorg_Taxonomy_Metabox',
-				'render',
-			) : false;
-		}
-
-		register_taxonomy(
-			self::TAXONOMY_NAME, // Taxonomy name.
-			Wordlift_Entity_Service::valid_entity_post_types(), // Taxonomy post types.
-			$args // Taxonomy args.
-		);
-
-		/**
-		 * Register meta wl_entities_gutenberg for use in Gutenberg
-		 */
-		register_meta(
-			'post',
-			'wl_entities_gutenberg',
-			array(
-				'show_in_rest' => true,
-				'single'       => true,
-				'type'         => 'string',
-			)
-		);
-
-		/**
-		 * Register meta _wl_alt_label for use in Gutenberg
-		 */
-		// register_meta( 'post', Wordlift_Entity_Service::ALTERNATIVE_LABEL_META_KEY, array(
-		// 'object_subtype' => '',
-		// 'show_in_rest'   => true,
-		// 'single'         => false,
-		// 'type'           => 'string',
-		// 'auth_callback'  => function () {
-		// return current_user_can( 'edit_posts' );
-		// }
-		// ) );
-
-		// see #1364: add custom fields support for CPTs that are valid entity post types in order to be able to
-		// query for synonyms in Block Editor.
-		add_filter(
-			'register_post_type_args',
-			function ( $args, $post_type ) {
-				if ( in_array( $post_type, Wordlift_Entity_Service::valid_entity_post_types(), true ) ) {
-					if ( ! isset( $args['supports'] ) ) {
-						$args['supports'] = array();
-					}
-					$args['supports'][] = 'custom-fields';
-				}
-
-				return $args;
-			},
-			10,
-			2
-		);
-
-		// Add filter to change the metabox CSS class.
-		add_filter( 'postbox_classes_entity_wl_entity_typediv', 'wl_admin_metaboxes_add_css_class' );
-
-		// Add a filter to preset the object term if none is set.
-		//
-		// DO NOT hook to `wp_get_object_terms`, because `wp_get_object_terms` returns imploded values for SQL queries.
-		//
-		// @see https://github.com/insideout10/wordlift-plugin/issues/995
-		// @since 3.23.6
-		add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 );
-
-		/**
-		 * Exclude sitemap creation for wl_entity_type taxonomy in Yoast
-		 *
-		 * @since 3.30.1
-		 */
-		add_filter( 'wpseo_sitemap_exclude_taxonomy', array( $this, 'wpseo_sitemap_exclude_taxonomy' ), 10, 2 );
-
-		$this->hide_posts_count();
-	}
-
-	private function hide_posts_count() {
-		$name = self::TAXONOMY_NAME;
-		add_filter(
-			"manage_edit-{$name}_columns",
-			function ( $columns ) {
-				unset( $columns['posts'] );
-				return $columns;
-			}
-		);
-	}
-
-	/**
-	 * Hook to the `get_object_terms` filter.
-	 *
-	 * We check if our taxonomy is requested and whether a term has been returned. If no term has been returned we
-	 * preset `Article` for posts/pages and 'Thing' for everything else and we query the terms again.
-	 *
-	 * @param array    $terms Array of terms for the given object or objects.
-	 * @param int[]    $object_ids Array of object IDs for which terms were retrieved.
-	 * @param string[] $taxonomies Array of taxonomy names from which terms were retrieved.
-	 * @param array    $args Array of arguments for retrieving terms for the given
-	 *                                object(s). See get_object_terms() for details.
-	 *
-	 * @return array|WP_Error
-	 * @since 3.23.6
-	 */
-	public function get_object_terms( $terms, $object_ids, $taxonomies, $args ) {
-		// Get our entity type.
-		$entity_type = self::TAXONOMY_NAME;
-
-		// Check if this is a query for our entity type, that no terms have been found and that we have an article
-		// term to preset in case.
-		if ( ! taxonomy_exists( $entity_type )
-			 || array( $entity_type ) !== (array) $taxonomies
-			 || ! empty( $terms )
-			 || ! term_exists( 'article', $entity_type )
-			 || ! term_exists( 'thing', $entity_type ) ) {
-
-			// Return the input value.
-			return $terms;
-		}
-
-		// Avoid nested calls in case of issues.
-		remove_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10 );
-
-		// Set the default term for all the queried object.
-		foreach ( (array) $object_ids as $object_id ) {
-			$post_type = get_post_type( $object_id );
-			if ( Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post_type ) ) {
-				// Set the term to article for posts and pages, or to thing for everything else.
-				$uris = Wordlift_Entity_Type_Adapter::get_entity_types( $post_type );
-				foreach ( $uris as $uri ) {
-					// set the uri based on post type.
-					if ( 'http://schema.org/Article' === $uri || 'http://schema.org/Thing' === $uri ) {
-						$uri = Wordlift_Entity_Service::TYPE_NAME === $post_type ?
-							'http://schema.org/Thing' : 'http://schema.org/Article';
-					}
-					Wordlift_Entity_Type_Service::get_instance()->set( $object_id, $uri );
-				}
-			}
-		}
-
-		// Finally return the object terms.
-		$terms = wp_get_object_terms( $object_ids, $taxonomies, $args );
-
-		// Re-enable nested calls in case of issues.
-		add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 );
-
-		return $terms;
-	}
-
-	public function wpseo_sitemap_exclude_taxonomy( $exclude, $tax ) {
-		if ( self::TAXONOMY_NAME === $tax ) {
-			return true;
-		}
-
-		return $exclude;
-	}
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( apply_filters( 'wl_feature__enable__all-entity-types', WL_ALL_ENTITY_TYPES ) ) {
+            // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+            $args['meta_box_cb'] = apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ) ? array(
+                'Wordlift_Admin_Schemaorg_Taxonomy_Metabox',
+                'render',
+            ) : false;
+        }
+
+        register_taxonomy(
+            self::TAXONOMY_NAME, // Taxonomy name.
+            Wordlift_Entity_Service::valid_entity_post_types(), // Taxonomy post types.
+            $args // Taxonomy args.
+        );
+
+        /**
+         * Register meta wl_entities_gutenberg for use in Gutenberg
+         */
+        register_meta(
+            'post',
+            'wl_entities_gutenberg',
+            array(
+                'show_in_rest' => true,
+                'single'       => true,
+                'type'         => 'string',
+            )
+        );
+
+        /**
+         * Register meta _wl_alt_label for use in Gutenberg
+         */
+        // register_meta( 'post', Wordlift_Entity_Service::ALTERNATIVE_LABEL_META_KEY, array(
+        // 'object_subtype' => '',
+        // 'show_in_rest'   => true,
+        // 'single'         => false,
+        // 'type'           => 'string',
+        // 'auth_callback'  => function () {
+        // return current_user_can( 'edit_posts' );
+        // }
+        // ) );
+
+        // see #1364: add custom fields support for CPTs that are valid entity post types in order to be able to
+        // query for synonyms in Block Editor.
+        add_filter(
+            'register_post_type_args',
+            function ( $args, $post_type ) {
+                if ( in_array( $post_type, Wordlift_Entity_Service::valid_entity_post_types(), true ) ) {
+                    if ( ! isset( $args['supports'] ) ) {
+                        $args['supports'] = array();
+                    }
+                    $args['supports'][] = 'custom-fields';
+                }
+
+                return $args;
+            },
+            10,
+            2
+        );
+
+        // Add filter to change the metabox CSS class.
+        add_filter( 'postbox_classes_entity_wl_entity_typediv', 'wl_admin_metaboxes_add_css_class' );
+
+        // Add a filter to preset the object term if none is set.
+        //
+        // DO NOT hook to `wp_get_object_terms`, because `wp_get_object_terms` returns imploded values for SQL queries.
+        //
+        // @see https://github.com/insideout10/wordlift-plugin/issues/995
+        // @since 3.23.6
+        add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 );
+
+        /**
+         * Exclude sitemap creation for wl_entity_type taxonomy in Yoast
+         *
+         * @since 3.30.1
+         */
+        add_filter( 'wpseo_sitemap_exclude_taxonomy', array( $this, 'wpseo_sitemap_exclude_taxonomy' ), 10, 2 );
+
+        $this->hide_posts_count();
+    }
+
+    private function hide_posts_count() {
+        $name = self::TAXONOMY_NAME;
+        add_filter(
+            "manage_edit-{$name}_columns",
+            function ( $columns ) {
+                unset( $columns['posts'] );
+                return $columns;
+            }
+        );
+    }
+
+    /**
+     * Hook to the `get_object_terms` filter.
+     *
+     * We check if our taxonomy is requested and whether a term has been returned. If no term has been returned we
+     * preset `Article` for posts/pages and 'Thing' for everything else and we query the terms again.
+     *
+     * @param array    $terms Array of terms for the given object or objects.
+     * @param int[]    $object_ids Array of object IDs for which terms were retrieved.
+     * @param string[] $taxonomies Array of taxonomy names from which terms were retrieved.
+     * @param array    $args Array of arguments for retrieving terms for the given
+     *                                object(s). See get_object_terms() for details.
+     *
+     * @return array|WP_Error
+     * @since 3.23.6
+     */
+    public function get_object_terms( $terms, $object_ids, $taxonomies, $args ) {
+        // Get our entity type.
+        $entity_type = self::TAXONOMY_NAME;
+
+        // Check if this is a query for our entity type, that no terms have been found and that we have an article
+        // term to preset in case.
+        if ( ! taxonomy_exists( $entity_type )
+             || array( $entity_type ) !== (array) $taxonomies
+             || ! empty( $terms )
+             || ! term_exists( 'article', $entity_type )
+             || ! term_exists( 'thing', $entity_type ) ) {
+
+            // Return the input value.
+            return $terms;
+        }
+
+        // Avoid nested calls in case of issues.
+        remove_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10 );
+
+        // Set the default term for all the queried object.
+        foreach ( (array) $object_ids as $object_id ) {
+            $post_type = get_post_type( $object_id );
+            if ( Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post_type ) ) {
+                // Set the term to article for posts and pages, or to thing for everything else.
+                $uris = Wordlift_Entity_Type_Adapter::get_entity_types( $post_type );
+                foreach ( $uris as $uri ) {
+                    // set the uri based on post type.
+                    if ( 'http://schema.org/Article' === $uri || 'http://schema.org/Thing' === $uri ) {
+                        $uri = Wordlift_Entity_Service::TYPE_NAME === $post_type ?
+                            'http://schema.org/Thing' : 'http://schema.org/Article';
+                    }
+                    Wordlift_Entity_Type_Service::get_instance()->set( $object_id, $uri );
+                }
+            }
+        }
+
+        // Finally return the object terms.
+        $terms = wp_get_object_terms( $object_ids, $taxonomies, $args );
+
+        // Re-enable nested calls in case of issues.
+        add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 );
+
+        return $terms;
+    }
+
+    public function wpseo_sitemap_exclude_taxonomy( $exclude, $tax ) {
+        if ( self::TAXONOMY_NAME === $tax ) {
+            return true;
+        }
+
+        return $exclude;
+    }
 
 }

Spacing +41 added lines, -41 removed lines

@@ -31,17 +31,17 @@ 
 	public function init() {
 
 		$labels = array(
-			'name'              => _x( 'Entity Types', 'taxonomy general name', 'wordlift' ),
-			'singular_name'     => _x( 'Entity Type', 'taxonomy singular name', 'wordlift' ),
-			'search_items'      => __( 'Search Entity Types', 'wordlift' ),
-			'all_items'         => __( 'All Entity Types', 'wordlift' ),
-			'parent_item'       => __( 'Parent Entity Type', 'wordlift' ),
-			'parent_item_colon' => __( 'Parent Entity Type:', 'wordlift' ),
-			'edit_item'         => __( 'Edit Entity Type', 'wordlift' ),
-			'update_item'       => __( 'Update Entity Type', 'wordlift' ),
-			'add_new_item'      => __( 'Add New Entity Type', 'wordlift' ),
-			'new_item_name'     => __( 'New Entity Type', 'wordlift' ),
-			'menu_name'         => __( 'Entity Types', 'wordlift' ),
+			'name'              => _x('Entity Types', 'taxonomy general name', 'wordlift'),
+			'singular_name'     => _x('Entity Type', 'taxonomy singular name', 'wordlift'),
+			'search_items'      => __('Search Entity Types', 'wordlift'),
+			'all_items'         => __('All Entity Types', 'wordlift'),
+			'parent_item'       => __('Parent Entity Type', 'wordlift'),
+			'parent_item_colon' => __('Parent Entity Type:', 'wordlift'),
+			'edit_item'         => __('Edit Entity Type', 'wordlift'),
+			'update_item'       => __('Update Entity Type', 'wordlift'),
+			'add_new_item'      => __('Add New Entity Type', 'wordlift'),
+			'new_item_name'     => __('New Entity Type', 'wordlift'),
+			'menu_name'         => __('Entity Types', 'wordlift'),
 		);
 
 		// Take away GUI for taxonomy editing.
@@ -61,9 +61,9 @@ 
 			'capabilities'       => $capabilities,
 			'hierarchical'       => true,
 			// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-			'show_admin_column'  => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ),
+			'show_admin_column'  => apply_filters('wl_feature__enable__entity-types-taxonomy', true),
 			// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-			'show_in_rest'       => apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ),
+			'show_in_rest'       => apply_filters('wl_feature__enable__entity-types-taxonomy', true),
 			'show_in_quick_edit' => false,
 			'publicly_queryable' => false,
 		);
@@ -75,9 +75,9 @@ 
 		 * @since 3.20.0
 		 */
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( apply_filters( 'wl_feature__enable__all-entity-types', WL_ALL_ENTITY_TYPES ) ) {
+		if (apply_filters('wl_feature__enable__all-entity-types', WL_ALL_ENTITY_TYPES)) {
 			// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-			$args['meta_box_cb'] = apply_filters( 'wl_feature__enable__entity-types-taxonomy', true ) ? array(
+			$args['meta_box_cb'] = apply_filters('wl_feature__enable__entity-types-taxonomy', true) ? array(
 				'Wordlift_Admin_Schemaorg_Taxonomy_Metabox',
 				'render',
 			) : false;
@@ -119,9 +119,9 @@ 
 		// query for synonyms in Block Editor.
 		add_filter(
 			'register_post_type_args',
-			function ( $args, $post_type ) {
-				if ( in_array( $post_type, Wordlift_Entity_Service::valid_entity_post_types(), true ) ) {
-					if ( ! isset( $args['supports'] ) ) {
+			function($args, $post_type) {
+				if (in_array($post_type, Wordlift_Entity_Service::valid_entity_post_types(), true)) {
+					if ( ! isset($args['supports'])) {
 						$args['supports'] = array();
 					}
 					$args['supports'][] = 'custom-fields';
@@ -134,7 +134,7 @@ 
 		);
 
 		// Add filter to change the metabox CSS class.
-		add_filter( 'postbox_classes_entity_wl_entity_typediv', 'wl_admin_metaboxes_add_css_class' );
+		add_filter('postbox_classes_entity_wl_entity_typediv', 'wl_admin_metaboxes_add_css_class');
 
 		// Add a filter to preset the object term if none is set.
 		//
@@ -142,14 +142,14 @@ 
 		//
 		// @see https://github.com/insideout10/wordlift-plugin/issues/995
 		// @since 3.23.6
-		add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 );
+		add_filter('get_object_terms', array($this, 'get_object_terms'), 10, 4);
 
 		/**
 		 * Exclude sitemap creation for wl_entity_type taxonomy in Yoast
 		 *
 		 * @since 3.30.1
 		 */
-		add_filter( 'wpseo_sitemap_exclude_taxonomy', array( $this, 'wpseo_sitemap_exclude_taxonomy' ), 10, 2 );
+		add_filter('wpseo_sitemap_exclude_taxonomy', array($this, 'wpseo_sitemap_exclude_taxonomy'), 10, 2);
 
 		$this->hide_posts_count();
 	}
@@ -158,8 +158,8 @@ 
 		$name = self::TAXONOMY_NAME;
 		add_filter(
 			"manage_edit-{$name}_columns",
-			function ( $columns ) {
-				unset( $columns['posts'] );
+			function($columns) {
+				unset($columns['posts']);
 				return $columns;
 			}
 		);
@@ -180,53 +180,53 @@ 
 	 * @return array|WP_Error
 	 * @since 3.23.6
 	 */
-	public function get_object_terms( $terms, $object_ids, $taxonomies, $args ) {
+	public function get_object_terms($terms, $object_ids, $taxonomies, $args) {
 		// Get our entity type.
 		$entity_type = self::TAXONOMY_NAME;
 
 		// Check if this is a query for our entity type, that no terms have been found and that we have an article
 		// term to preset in case.
-		if ( ! taxonomy_exists( $entity_type )
-			 || array( $entity_type ) !== (array) $taxonomies
-			 || ! empty( $terms )
-			 || ! term_exists( 'article', $entity_type )
-			 || ! term_exists( 'thing', $entity_type ) ) {
+		if ( ! taxonomy_exists($entity_type)
+			 || array($entity_type) !== (array) $taxonomies
+			 || ! empty($terms)
+			 || ! term_exists('article', $entity_type)
+			 || ! term_exists('thing', $entity_type)) {
 
 			// Return the input value.
 			return $terms;
 		}
 
 		// Avoid nested calls in case of issues.
-		remove_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10 );
+		remove_filter('get_object_terms', array($this, 'get_object_terms'), 10);
 
 		// Set the default term for all the queried object.
-		foreach ( (array) $object_ids as $object_id ) {
-			$post_type = get_post_type( $object_id );
-			if ( Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post_type ) ) {
+		foreach ((array) $object_ids as $object_id) {
+			$post_type = get_post_type($object_id);
+			if (Wordlift_Entity_Type_Service::is_valid_entity_post_type($post_type)) {
 				// Set the term to article for posts and pages, or to thing for everything else.
-				$uris = Wordlift_Entity_Type_Adapter::get_entity_types( $post_type );
-				foreach ( $uris as $uri ) {
+				$uris = Wordlift_Entity_Type_Adapter::get_entity_types($post_type);
+				foreach ($uris as $uri) {
 					// set the uri based on post type.
-					if ( 'http://schema.org/Article' === $uri || 'http://schema.org/Thing' === $uri ) {
+					if ('http://schema.org/Article' === $uri || 'http://schema.org/Thing' === $uri) {
 						$uri = Wordlift_Entity_Service::TYPE_NAME === $post_type ?
 							'http://schema.org/Thing' : 'http://schema.org/Article';
 					}
-					Wordlift_Entity_Type_Service::get_instance()->set( $object_id, $uri );
+					Wordlift_Entity_Type_Service::get_instance()->set($object_id, $uri);
 				}
 			}
 		}
 
 		// Finally return the object terms.
-		$terms = wp_get_object_terms( $object_ids, $taxonomies, $args );
+		$terms = wp_get_object_terms($object_ids, $taxonomies, $args);
 
 		// Re-enable nested calls in case of issues.
-		add_filter( 'get_object_terms', array( $this, 'get_object_terms' ), 10, 4 );
+		add_filter('get_object_terms', array($this, 'get_object_terms'), 10, 4);
 
 		return $terms;
 	}
 
-	public function wpseo_sitemap_exclude_taxonomy( $exclude, $tax ) {
-		if ( self::TAXONOMY_NAME === $tax ) {
+	public function wpseo_sitemap_exclude_taxonomy($exclude, $tax) {
+		if (self::TAXONOMY_NAME === $tax) {
 			return true;
 		}
 

src/wordlift/vocabulary/cache/class-options-cache.php

Indentation +22 added lines, -22 removed lines

@@ -4,35 +4,35 @@
 
 class Options_Cache implements Cache {
 
-	private $namespace;
+    private $namespace;
 
-	/**
-	 * Options_Cache constructor.
-	 *
-	 * @param $namespace
-	 */
-	public function __construct( $namespace ) {
-		$this->namespace = $namespace;
-	}
+    /**
+     * Options_Cache constructor.
+     *
+     * @param $namespace
+     */
+    public function __construct( $namespace ) {
+        $this->namespace = $namespace;
+    }
 
-	public function get( $cache_key ) {
+    public function get( $cache_key ) {
 
-		return get_option( $this->namespace . '__' . $cache_key, false );
+        return get_option( $this->namespace . '__' . $cache_key, false );
 
-	}
+    }
 
-	public function put( $cache_key, $value ) {
+    public function put( $cache_key, $value ) {
 
-		return update_option( $this->namespace . '__' . $cache_key, $value, false );
+        return update_option( $this->namespace . '__' . $cache_key, $value, false );
 
-	}
+    }
 
-	public function flush_all() {
-		if ( '' !== $this->namespace ) {
-			global $wpdb;
-			$namespace_esc = $wpdb->esc_like( $this->namespace ) . '__%';
-			$wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->options WHERE option_name LIKE %s", $namespace_esc ) );
-		}
-	}
+    public function flush_all() {
+        if ( '' !== $this->namespace ) {
+            global $wpdb;
+            $namespace_esc = $wpdb->esc_like( $this->namespace ) . '__%';
+            $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->options WHERE option_name LIKE %s", $namespace_esc ) );
+        }
+    }
 
 }

Spacing +8 added lines, -8 removed lines

@@ -11,27 +11,27 @@
 	 *
 	 * @param $namespace
 	 */
-	public function __construct( $namespace ) {
+	public function __construct($namespace) {
 		$this->namespace = $namespace;
 	}
 
-	public function get( $cache_key ) {
+	public function get($cache_key) {
 
-		return get_option( $this->namespace . '__' . $cache_key, false );
+		return get_option($this->namespace.'__'.$cache_key, false);
 
 	}
 
-	public function put( $cache_key, $value ) {
+	public function put($cache_key, $value) {
 
-		return update_option( $this->namespace . '__' . $cache_key, $value, false );
+		return update_option($this->namespace.'__'.$cache_key, $value, false);
 
 	}
 
 	public function flush_all() {
-		if ( '' !== $this->namespace ) {
+		if ('' !== $this->namespace) {
 			global $wpdb;
-			$namespace_esc = $wpdb->esc_like( $this->namespace ) . '__%';
-			$wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->options WHERE option_name LIKE %s", $namespace_esc ) );
+			$namespace_esc = $wpdb->esc_like($this->namespace).'__%';
+			$wpdb->query($wpdb->prepare("DELETE FROM $wpdb->options WHERE option_name LIKE %s", $namespace_esc));
 		}
 	}
 

src/wordlift/task/action-scheduler/class-background-task.php

Indentation +97 added lines, -97 removed lines

@@ -8,101 +8,101 @@
 use Wordlift\Task\Task;
 
 class Background_Task extends Action_Scheduler_Background_Process implements Background_Route_Task {
-	/**
-	 * The option prefix to store state.
-	 *
-	 * @var string $option_prefix
-	 */
-	private $option_prefix;
-	/**
-	 * @var Task
-	 */
-	private $task;
-
-	const STATE_STARTED = 'started';
-	const STATE_STOPPED = 'stopped';
-	/**
-	 * @var int
-	 */
-	private $batch_size;
-
-	public function __construct( $hook, $group, $task, $option_prefix, $batch_size = 5 ) {
-		parent::__construct( $hook, $group );
-		$this->task          = $task;
-		$this->option_prefix = $option_prefix;
-		$this->batch_size    = $batch_size;
-	}
-
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function do_task( $args ) {
-		if ( self::STATE_STOPPED === $this->get_process_state() ) {
-			return State::complete();
-		}
-		$context = $this->get_context();
-		$this->task->tick( null, $context->get_data() + array( 'batch_size' => $this->batch_size ) );
-
-		if ( ( $context->get_count() - $context->get_offset() ) >= 0 ) {
-			$context->set_offset( $context->get_offset() + $this->batch_size )->set_updated( time() );
-			$this->set_info( $context );
-			return State::items_in_queue();
-		} else {
-			$this->set_process_state( self::STATE_STOPPED );
-			return State::complete();
-		}
-
-	}
-
-	public function start() {
-		$this->delete_info();
-		$this->set_process_state( self::STATE_STARTED );
-		$this->schedule();
-	}
-
-	public function stop() {
-		$this->set_process_state( self::STATE_STOPPED );
-		$this->unschedule();
-	}
-
-	public function resume() {
-		$this->set_process_state( self::STATE_STARTED );
-		$this->schedule();
-	}
-
-	public function get_info() {
-		return $this->get_context()->get_data() + array( 'state' => $this->get_process_state() );
-	}
-
-	public function get_context() {
-		$data = get_option(
-			"{$this->option_prefix}_state",
-			null
-		);
-
-		if ( null === $data ) {
-			return Context::from( (int) $this->task->starting() );
-		}
-
-		return Context::from_data( $data );
-	}
-
-	/**
-	 * @param $context Context
-	 *
-	 * @return void
-	 */
-	public function set_info( $context ) {
-		update_option( "{$this->option_prefix}_state", $context->get_data(), false );
-	}
-
-	private function delete_info() {
-		delete_option( "{$this->option_prefix}_state" );
-	}
-
-	private function get_process_state() {
-		return get_option( "{$this->option_prefix}_action_scheduler_state", self::STATE_STOPPED );
-	}
-
-	private function set_process_state( $state ) {
-		update_option( "{$this->option_prefix}_action_scheduler_state", $state );
-	}
+    /**
+     * The option prefix to store state.
+     *
+     * @var string $option_prefix
+     */
+    private $option_prefix;
+    /**
+     * @var Task
+     */
+    private $task;
+
+    const STATE_STARTED = 'started';
+    const STATE_STOPPED = 'stopped';
+    /**
+     * @var int
+     */
+    private $batch_size;
+
+    public function __construct( $hook, $group, $task, $option_prefix, $batch_size = 5 ) {
+        parent::__construct( $hook, $group );
+        $this->task          = $task;
+        $this->option_prefix = $option_prefix;
+        $this->batch_size    = $batch_size;
+    }
+
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function do_task( $args ) {
+        if ( self::STATE_STOPPED === $this->get_process_state() ) {
+            return State::complete();
+        }
+        $context = $this->get_context();
+        $this->task->tick( null, $context->get_data() + array( 'batch_size' => $this->batch_size ) );
+
+        if ( ( $context->get_count() - $context->get_offset() ) >= 0 ) {
+            $context->set_offset( $context->get_offset() + $this->batch_size )->set_updated( time() );
+            $this->set_info( $context );
+            return State::items_in_queue();
+        } else {
+            $this->set_process_state( self::STATE_STOPPED );
+            return State::complete();
+        }
+
+    }
+
+    public function start() {
+        $this->delete_info();
+        $this->set_process_state( self::STATE_STARTED );
+        $this->schedule();
+    }
+
+    public function stop() {
+        $this->set_process_state( self::STATE_STOPPED );
+        $this->unschedule();
+    }
+
+    public function resume() {
+        $this->set_process_state( self::STATE_STARTED );
+        $this->schedule();
+    }
+
+    public function get_info() {
+        return $this->get_context()->get_data() + array( 'state' => $this->get_process_state() );
+    }
+
+    public function get_context() {
+        $data = get_option(
+            "{$this->option_prefix}_state",
+            null
+        );
+
+        if ( null === $data ) {
+            return Context::from( (int) $this->task->starting() );
+        }
+
+        return Context::from_data( $data );
+    }
+
+    /**
+     * @param $context Context
+     *
+     * @return void
+     */
+    public function set_info( $context ) {
+        update_option( "{$this->option_prefix}_state", $context->get_data(), false );
+    }
+
+    private function delete_info() {
+        delete_option( "{$this->option_prefix}_state" );
+    }
+
+    private function get_process_state() {
+        return get_option( "{$this->option_prefix}_action_scheduler_state", self::STATE_STOPPED );
+    }
+
+    private function set_process_state( $state ) {
+        update_option( "{$this->option_prefix}_action_scheduler_state", $state );
+    }
 }

Spacing +22 added lines, -22 removed lines

@@ -26,27 +26,27 @@ 
 	 */
 	private $batch_size;
 
-	public function __construct( $hook, $group, $task, $option_prefix, $batch_size = 5 ) {
-		parent::__construct( $hook, $group );
+	public function __construct($hook, $group, $task, $option_prefix, $batch_size = 5) {
+		parent::__construct($hook, $group);
 		$this->task          = $task;
 		$this->option_prefix = $option_prefix;
 		$this->batch_size    = $batch_size;
 	}
 
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function do_task( $args ) {
-		if ( self::STATE_STOPPED === $this->get_process_state() ) {
+	public function do_task($args) {
+		if (self::STATE_STOPPED === $this->get_process_state()) {
 			return State::complete();
 		}
 		$context = $this->get_context();
-		$this->task->tick( null, $context->get_data() + array( 'batch_size' => $this->batch_size ) );
+		$this->task->tick(null, $context->get_data() + array('batch_size' => $this->batch_size));
 
-		if ( ( $context->get_count() - $context->get_offset() ) >= 0 ) {
-			$context->set_offset( $context->get_offset() + $this->batch_size )->set_updated( time() );
-			$this->set_info( $context );
+		if (($context->get_count() - $context->get_offset()) >= 0) {
+			$context->set_offset($context->get_offset() + $this->batch_size)->set_updated(time());
+			$this->set_info($context);
 			return State::items_in_queue();
 		} else {
-			$this->set_process_state( self::STATE_STOPPED );
+			$this->set_process_state(self::STATE_STOPPED);
 			return State::complete();
 		}
 
@@ -54,22 +54,22 @@ 
 
 	public function start() {
 		$this->delete_info();
-		$this->set_process_state( self::STATE_STARTED );
+		$this->set_process_state(self::STATE_STARTED);
 		$this->schedule();
 	}
 
 	public function stop() {
-		$this->set_process_state( self::STATE_STOPPED );
+		$this->set_process_state(self::STATE_STOPPED);
 		$this->unschedule();
 	}
 
 	public function resume() {
-		$this->set_process_state( self::STATE_STARTED );
+		$this->set_process_state(self::STATE_STARTED);
 		$this->schedule();
 	}
 
 	public function get_info() {
-		return $this->get_context()->get_data() + array( 'state' => $this->get_process_state() );
+		return $this->get_context()->get_data() + array('state' => $this->get_process_state());
 	}
 
 	public function get_context() {
@@ -78,11 +78,11 @@ 
 			null
 		);
 
-		if ( null === $data ) {
-			return Context::from( (int) $this->task->starting() );
+		if (null === $data) {
+			return Context::from((int) $this->task->starting());
 		}
 
-		return Context::from_data( $data );
+		return Context::from_data($data);
 	}
 
 	/**
@@ -90,19 +90,19 @@ 
 	 *
 	 * @return void
 	 */
-	public function set_info( $context ) {
-		update_option( "{$this->option_prefix}_state", $context->get_data(), false );
+	public function set_info($context) {
+		update_option("{$this->option_prefix}_state", $context->get_data(), false);
 	}
 
 	private function delete_info() {
-		delete_option( "{$this->option_prefix}_state" );
+		delete_option("{$this->option_prefix}_state");
 	}
 
 	private function get_process_state() {
-		return get_option( "{$this->option_prefix}_action_scheduler_state", self::STATE_STOPPED );
+		return get_option("{$this->option_prefix}_action_scheduler_state", self::STATE_STOPPED);
 	}
 
-	private function set_process_state( $state ) {
-		update_option( "{$this->option_prefix}_action_scheduler_state", $state );
+	private function set_process_state($state) {
+		update_option("{$this->option_prefix}_action_scheduler_state", $state);
 	}
 }

src/includes/class-wordlift-key-validation-service.php

Indentation +178 added lines, -178 removed lines

@@ -21,186 +21,186 @@
  */
 class Wordlift_Key_Validation_Service {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * @var Ttl_Cache
-	 */
-	private $ttl_cache_service;
-
-	/**
-	 * Create a {@link Wordlift_Key_Validation_Service} instance.
-	 *
-	 * @since 3.14.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
-
-		add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
-		/**
-		 * Filter: wl_feature__enable__notices.
-		 *
-		 * @param bool whether notices need to be enabled or not.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
-		}
-
-		$this->ttl_cache_service = new Ttl_Cache( 'key-validation-notification' );
-
-	}
-
-	/**
-	 * Validate the provided key.
-	 *
-	 * @param string $key WordLift's key to validate.
-	 *
-	 * @return WP_Error|array The response or WP_Error on failure.
-	 * @since 3.9.0
-	 */
-	public function get_account_info( $key ) {
-
-		$this->log->debug( 'Validating key...' );
-
-		$response = Default_Api_Service::get_instance()->get(
-			'/accounts/info',
-			array(
-				'Authorization' => "Key $key",
-			)
-		);
-
-		/**
-		 * @since 3.38.5
-		 * This action is fired when the key is validated.
-		 * @param $response \Wordlift\Api\Response
-		 */
-		do_action( 'wl_key_validation_response', $response );
-
-		return $response->get_response();
-	}
-
-	private function key_validation_request( $key ) {
-		$response = $this->get_account_info( $key );
-
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			throw new \Exception( __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ) );
-		}
-
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
-
-		$url = $res_body['url'];
-
-		$enabled_features = array_keys( array_filter( $res_body['features'] ) );
-		$plugin_features  = array( Entity_Type_Setter::STARTER_PLAN, Entity_Type_Setter::PROFESSIONAL_PLAN, Entity_Type_Setter::BUSINESS_PLAN );
-
-		if ( count( array_intersect( $enabled_features, $plugin_features ) ) === 0 ) {
-			throw new \Exception( __( 'This key is not valid. Start building your Knowledge Graph by purchasing a WordLift subscription <a href=\'https://wordlift.io/pricing/\'>here</a>.', 'wordlift' ) );
-		}
-
-		// Considering that production URL may be filtered.
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
-
-		if ( $url !== $site_url ) {
-			throw new \Exception( __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if key is valid
-	 *
-	 * @param $key string
-	 *
-	 * @return bool
-	 */
-	public function is_key_valid( $key ) {
-		try {
-			$this->key_validation_request( $key );
-			return true;
-		} catch ( \Exception $e ) {
-			return false;
-		}
-	}
-
-	/**
-	 * This function is hooked to the `wl_validate_key` AJAX call.
-	 *
-	 * @since 3.9.0
-	 */
-	public function validate_key() {
-
-		// Ensure we don't have garbage before us.
-		ob_clean();
-
-		// Check if we have a key.
-		if ( ! isset( $_POST['key'] ) ) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			wp_send_json_error( 'The key parameter is required.' );
-		}
-
-		$this->ttl_cache_service->delete( 'is_key_valid' );
-
-		try {
-			$this->key_validation_request( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			wp_send_json_success(
-				array(
-					'valid'   => true,
-					'message' => '',
-				)
-			);
-
-		} catch ( \Exception $e ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			wp_send_json_success(
-				array(
-					'valid'   => false,
-					'message' => $e->getMessage(),
-					'api_url' => Default_Api_Service::get_instance()->get_base_url(),
-				)
-			);
-		}
-	}
-
-	/**
-	 * This function is hooked `admin_init` to check _wl_blog_url.
-	 */
-	public function wl_load_plugin() {
-
-		$wl_blog_url = get_option( '_wl_blog_url' );
-		$home_url    = get_option( 'home' );
-
-		if ( ! $wl_blog_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-		} elseif ( $wl_blog_url !== $home_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			set_transient( 'wl-key-error-msg', __( "Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift' ), 10 );
-		}
-
-	}
-
-	/**
-	 * This function is hooked to the `admin_notices` to show admin notification.
-	 */
-	public function wl_key_update_notice() {
-		if ( get_transient( 'wl-key-error-msg' ) ) {
-			?>
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * @var Ttl_Cache
+     */
+    private $ttl_cache_service;
+
+    /**
+     * Create a {@link Wordlift_Key_Validation_Service} instance.
+     *
+     * @since 3.14.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+
+        add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
+        /**
+         * Filter: wl_feature__enable__notices.
+         *
+         * @param bool whether notices need to be enabled or not.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+            add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
+        }
+
+        $this->ttl_cache_service = new Ttl_Cache( 'key-validation-notification' );
+
+    }
+
+    /**
+     * Validate the provided key.
+     *
+     * @param string $key WordLift's key to validate.
+     *
+     * @return WP_Error|array The response or WP_Error on failure.
+     * @since 3.9.0
+     */
+    public function get_account_info( $key ) {
+
+        $this->log->debug( 'Validating key...' );
+
+        $response = Default_Api_Service::get_instance()->get(
+            '/accounts/info',
+            array(
+                'Authorization' => "Key $key",
+            )
+        );
+
+        /**
+         * @since 3.38.5
+         * This action is fired when the key is validated.
+         * @param $response \Wordlift\Api\Response
+         */
+        do_action( 'wl_key_validation_response', $response );
+
+        return $response->get_response();
+    }
+
+    private function key_validation_request( $key ) {
+        $response = $this->get_account_info( $key );
+
+        if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+            throw new \Exception( __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ) );
+        }
+
+        $res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+        $url = $res_body['url'];
+
+        $enabled_features = array_keys( array_filter( $res_body['features'] ) );
+        $plugin_features  = array( Entity_Type_Setter::STARTER_PLAN, Entity_Type_Setter::PROFESSIONAL_PLAN, Entity_Type_Setter::BUSINESS_PLAN );
+
+        if ( count( array_intersect( $enabled_features, $plugin_features ) ) === 0 ) {
+            throw new \Exception( __( 'This key is not valid. Start building your Knowledge Graph by purchasing a WordLift subscription <a href=\'https://wordlift.io/pricing/\'>here</a>.', 'wordlift' ) );
+        }
+
+        // Considering that production URL may be filtered.
+        $home_url = get_option( 'home' );
+        $site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+
+        if ( $url !== $site_url ) {
+            throw new \Exception( __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if key is valid
+     *
+     * @param $key string
+     *
+     * @return bool
+     */
+    public function is_key_valid( $key ) {
+        try {
+            $this->key_validation_request( $key );
+            return true;
+        } catch ( \Exception $e ) {
+            return false;
+        }
+    }
+
+    /**
+     * This function is hooked to the `wl_validate_key` AJAX call.
+     *
+     * @since 3.9.0
+     */
+    public function validate_key() {
+
+        // Ensure we don't have garbage before us.
+        ob_clean();
+
+        // Check if we have a key.
+        if ( ! isset( $_POST['key'] ) ) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
+            wp_send_json_error( 'The key parameter is required.' );
+        }
+
+        $this->ttl_cache_service->delete( 'is_key_valid' );
+
+        try {
+            $this->key_validation_request( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Missing
+            wp_send_json_success(
+                array(
+                    'valid'   => true,
+                    'message' => '',
+                )
+            );
+
+        } catch ( \Exception $e ) {
+            Wordlift_Configuration_Service::get_instance()->set_key( '' );
+            wp_send_json_success(
+                array(
+                    'valid'   => false,
+                    'message' => $e->getMessage(),
+                    'api_url' => Default_Api_Service::get_instance()->get_base_url(),
+                )
+            );
+        }
+    }
+
+    /**
+     * This function is hooked `admin_init` to check _wl_blog_url.
+     */
+    public function wl_load_plugin() {
+
+        $wl_blog_url = get_option( '_wl_blog_url' );
+        $home_url    = get_option( 'home' );
+
+        if ( ! $wl_blog_url ) {
+            update_option( '_wl_blog_url', $home_url, true );
+        } elseif ( $wl_blog_url !== $home_url ) {
+            update_option( '_wl_blog_url', $home_url, true );
+            Wordlift_Configuration_Service::get_instance()->set_key( '' );
+            set_transient( 'wl-key-error-msg', __( "Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift' ), 10 );
+        }
+
+    }
+
+    /**
+     * This function is hooked to the `admin_notices` to show admin notification.
+     */
+    public function wl_key_update_notice() {
+        if ( get_transient( 'wl-key-error-msg' ) ) {
+            ?>
 			<div class="updated notice is-dismissible error">
 				<p><?php esc_html( get_transient( 'wl-key-error-msg' ) ); ?></p>
 			</div>
 			<?php
-		}
-	}
+        }
+    }
 }

Spacing +40 added lines, -40 removed lines

@@ -42,9 +42,9 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Key_Validation_Service');
 
-		add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
+		add_action('admin_init', array($this, 'wl_load_plugin'));
 		/**
 		 * Filter: wl_feature__enable__notices.
 		 *
@@ -53,11 +53,11 @@ 
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
+		if (apply_filters('wl_feature__enable__notices', true)) {
+			add_action('admin_notices', array($this, 'wl_key_update_notice'));
 		}
 
-		$this->ttl_cache_service = new Ttl_Cache( 'key-validation-notification' );
+		$this->ttl_cache_service = new Ttl_Cache('key-validation-notification');
 
 	}
 
@@ -69,9 +69,9 @@ 
 	 * @return WP_Error|array The response or WP_Error on failure.
 	 * @since 3.9.0
 	 */
-	public function get_account_info( $key ) {
+	public function get_account_info($key) {
 
-		$this->log->debug( 'Validating key...' );
+		$this->log->debug('Validating key...');
 
 		$response = Default_Api_Service::get_instance()->get(
 			'/accounts/info',
@@ -85,35 +85,35 @@ 
 		 * This action is fired when the key is validated.
 		 * @param $response \Wordlift\Api\Response
 		 */
-		do_action( 'wl_key_validation_response', $response );
+		do_action('wl_key_validation_response', $response);
 
 		return $response->get_response();
 	}
 
-	private function key_validation_request( $key ) {
-		$response = $this->get_account_info( $key );
+	private function key_validation_request($key) {
+		$response = $this->get_account_info($key);
 
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			throw new \Exception( __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ) );
+		if (is_wp_error($response) || 2 !== (int) $response['response']['code'] / 100) {
+			throw new \Exception(__('An error occurred, please contact us at hello@wordlift.io', 'wordlift'));
 		}
 
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+		$res_body = json_decode(wp_remote_retrieve_body($response), true);
 
 		$url = $res_body['url'];
 
-		$enabled_features = array_keys( array_filter( $res_body['features'] ) );
-		$plugin_features  = array( Entity_Type_Setter::STARTER_PLAN, Entity_Type_Setter::PROFESSIONAL_PLAN, Entity_Type_Setter::BUSINESS_PLAN );
+		$enabled_features = array_keys(array_filter($res_body['features']));
+		$plugin_features  = array(Entity_Type_Setter::STARTER_PLAN, Entity_Type_Setter::PROFESSIONAL_PLAN, Entity_Type_Setter::BUSINESS_PLAN);
 
-		if ( count( array_intersect( $enabled_features, $plugin_features ) ) === 0 ) {
-			throw new \Exception( __( 'This key is not valid. Start building your Knowledge Graph by purchasing a WordLift subscription <a href=\'https://wordlift.io/pricing/\'>here</a>.', 'wordlift' ) );
+		if (count(array_intersect($enabled_features, $plugin_features)) === 0) {
+			throw new \Exception(__('This key is not valid. Start building your Knowledge Graph by purchasing a WordLift subscription <a href=\'https://wordlift.io/pricing/\'>here</a>.', 'wordlift'));
 		}
 
 		// Considering that production URL may be filtered.
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+		$home_url = get_option('home');
+		$site_url = apply_filters('wl_production_site_url', untrailingslashit($home_url));
 
-		if ( $url !== $site_url ) {
-			throw new \Exception( __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ) );
+		if ($url !== $site_url) {
+			throw new \Exception(__('The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift'));
 		}
 
 		return true;
@@ -126,11 +126,11 @@ 
 	 *
 	 * @return bool
 	 */
-	public function is_key_valid( $key ) {
+	public function is_key_valid($key) {
 		try {
-			$this->key_validation_request( $key );
+			$this->key_validation_request($key);
 			return true;
-		} catch ( \Exception $e ) {
+		} catch (\Exception $e) {
 			return false;
 		}
 	}
@@ -146,14 +146,14 @@ 
 		ob_clean();
 
 		// Check if we have a key.
-		if ( ! isset( $_POST['key'] ) ) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			wp_send_json_error( 'The key parameter is required.' );
+		if ( ! isset($_POST['key'])) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
+			wp_send_json_error('The key parameter is required.');
 		}
 
-		$this->ttl_cache_service->delete( 'is_key_valid' );
+		$this->ttl_cache_service->delete('is_key_valid');
 
 		try {
-			$this->key_validation_request( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Missing
+			$this->key_validation_request(sanitize_text_field(wp_unslash((string) $_POST['key']))); //phpcs:ignore WordPress.Security.NonceVerification.Missing
 			wp_send_json_success(
 				array(
 					'valid'   => true,
@@ -161,8 +161,8 @@ 
 				)
 			);
 
-		} catch ( \Exception $e ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
+		} catch (\Exception $e) {
+			Wordlift_Configuration_Service::get_instance()->set_key('');
 			wp_send_json_success(
 				array(
 					'valid'   => false,
@@ -178,15 +178,15 @@ 
 	 */
 	public function wl_load_plugin() {
 
-		$wl_blog_url = get_option( '_wl_blog_url' );
-		$home_url    = get_option( 'home' );
+		$wl_blog_url = get_option('_wl_blog_url');
+		$home_url    = get_option('home');
 
-		if ( ! $wl_blog_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-		} elseif ( $wl_blog_url !== $home_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			set_transient( 'wl-key-error-msg', __( "Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift' ), 10 );
+		if ( ! $wl_blog_url) {
+			update_option('_wl_blog_url', $home_url, true);
+		} elseif ($wl_blog_url !== $home_url) {
+			update_option('_wl_blog_url', $home_url, true);
+			Wordlift_Configuration_Service::get_instance()->set_key('');
+			set_transient('wl-key-error-msg', __("Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift'), 10);
 		}
 
 	}
@@ -195,10 +195,10 @@ 
 	 * This function is hooked to the `admin_notices` to show admin notification.
 	 */
 	public function wl_key_update_notice() {
-		if ( get_transient( 'wl-key-error-msg' ) ) {
+		if (get_transient('wl-key-error-msg')) {
 			?>
 			<div class="updated notice is-dismissible error">
-				<p><?php esc_html( get_transient( 'wl-key-error-msg' ) ); ?></p>
+				<p><?php esc_html(get_transient('wl-key-error-msg')); ?></p>
 			</div>
 			<?php
 		}

src/wordlift/api/class-api-headers-service.php

Indentation +34 added lines, -34 removed lines

@@ -4,39 +4,39 @@
 
 class Api_Headers_Service {
 
-	private static $instance = null;
-
-	protected function __construct() {
-
-	}
-
-	/**
-	 * This function is used to append WordPress endpoint data to every request made.
-	 *
-	 * @return array
-	 */
-	public function get_wp_headers() {
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		$is_plugin_subscription = apply_filters( 'wl_feature__enable__entity-types-professional', false ) ||
-		                          // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-										   apply_filters( 'wl_feature__enable__entity-types-business', false ) ||
-		                          // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-										   apply_filters( 'wl_feature__enable__entity-types-starter', false );
-		return $is_plugin_subscription ? array(
-			'X-Wordlift-Plugin-Wp-Admin' => untrailingslashit( get_admin_url() ),
-			'X-Wordlift-Plugin-Wp-Json'  => untrailingslashit( get_rest_url() ),
-		) : array();
-	}
-
-	/**
-	 * @return Api_Headers_Service
-	 */
-	public static function get_instance() {
-		if ( null === self::$instance ) {
-			self::$instance = new Api_Headers_Service();
-		}
-
-		return self::$instance;
-	}
+    private static $instance = null;
+
+    protected function __construct() {
+
+    }
+
+    /**
+     * This function is used to append WordPress endpoint data to every request made.
+     *
+     * @return array
+     */
+    public function get_wp_headers() {
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        $is_plugin_subscription = apply_filters( 'wl_feature__enable__entity-types-professional', false ) ||
+                                  // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+                                           apply_filters( 'wl_feature__enable__entity-types-business', false ) ||
+                                  // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+                                           apply_filters( 'wl_feature__enable__entity-types-starter', false );
+        return $is_plugin_subscription ? array(
+            'X-Wordlift-Plugin-Wp-Admin' => untrailingslashit( get_admin_url() ),
+            'X-Wordlift-Plugin-Wp-Json'  => untrailingslashit( get_rest_url() ),
+        ) : array();
+    }
+
+    /**
+     * @return Api_Headers_Service
+     */
+    public static function get_instance() {
+        if ( null === self::$instance ) {
+            self::$instance = new Api_Headers_Service();
+        }
+
+        return self::$instance;
+    }
 
 }

Spacing +6 added lines, -6 removed lines

@@ -17,14 +17,14 @@ 
 	 */
 	public function get_wp_headers() {
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		$is_plugin_subscription = apply_filters( 'wl_feature__enable__entity-types-professional', false ) ||
+		$is_plugin_subscription = apply_filters('wl_feature__enable__entity-types-professional', false) ||
 		                          // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-										   apply_filters( 'wl_feature__enable__entity-types-business', false ) ||
+										   apply_filters('wl_feature__enable__entity-types-business', false) ||
 		                          // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-										   apply_filters( 'wl_feature__enable__entity-types-starter', false );
+										   apply_filters('wl_feature__enable__entity-types-starter', false);
 		return $is_plugin_subscription ? array(
-			'X-Wordlift-Plugin-Wp-Admin' => untrailingslashit( get_admin_url() ),
-			'X-Wordlift-Plugin-Wp-Json'  => untrailingslashit( get_rest_url() ),
+			'X-Wordlift-Plugin-Wp-Admin' => untrailingslashit(get_admin_url()),
+			'X-Wordlift-Plugin-Wp-Json'  => untrailingslashit(get_rest_url()),
 		) : array();
 	}
 
@@ -32,7 +32,7 @@ 
 	 * @return Api_Headers_Service
 	 */
 	public static function get_instance() {
-		if ( null === self::$instance ) {
+		if (null === self::$instance) {
 			self::$instance = new Api_Headers_Service();
 		}
 

src/wordlift/external-plugin-hooks/recipe-maker/class-recipe-maker-warning.php

Indentation +90 added lines, -90 removed lines

@@ -11,105 +11,105 @@
  */
 class Recipe_Maker_Warning {
 
-	/**
-	 * @var Recipe_Maker_Validation_Service
-	 */
-	private $recipe_maker_validation_service;
-
-	public function __construct( $recipe_maker_validation_service ) {
-		$this->recipe_maker_validation_service = $recipe_maker_validation_service;
-		add_action(
-			'load-post.php',
-			function () {
-				add_action( 'wordlift_admin_notices', array( $this, 'display_image_size_warning' ) );
-			}
-		);
-
-	}
-
-	/**
-	 * Show the warning after applying the conditions.
-	 */
-	public function display_image_size_warning() {
-
-		// Check if we are on the post.
-		if ( ! get_post() instanceof \WP_Post ) {
-			return false;
-		}
-		if ( ! $this->recipe_maker_validation_service->is_wp_recipe_maker_available() ) {
-			return false;
-		}
-		$post_id = get_the_ID();
-
-		// Dont show notification if there is no recipes referred by the post.
-		if ( ! $this->recipe_maker_validation_service->is_atleast_once_recipe_present_in_the_post( $post_id ) ) {
-			return false;
-		}
-
-		$warnings = $this->get_warnings( $post_id );
-
-		if ( count( $warnings ) > 0 ) {
-			// Show notification.
-			?>
+    /**
+     * @var Recipe_Maker_Validation_Service
+     */
+    private $recipe_maker_validation_service;
+
+    public function __construct( $recipe_maker_validation_service ) {
+        $this->recipe_maker_validation_service = $recipe_maker_validation_service;
+        add_action(
+            'load-post.php',
+            function () {
+                add_action( 'wordlift_admin_notices', array( $this, 'display_image_size_warning' ) );
+            }
+        );
+
+    }
+
+    /**
+     * Show the warning after applying the conditions.
+     */
+    public function display_image_size_warning() {
+
+        // Check if we are on the post.
+        if ( ! get_post() instanceof \WP_Post ) {
+            return false;
+        }
+        if ( ! $this->recipe_maker_validation_service->is_wp_recipe_maker_available() ) {
+            return false;
+        }
+        $post_id = get_the_ID();
+
+        // Dont show notification if there is no recipes referred by the post.
+        if ( ! $this->recipe_maker_validation_service->is_atleast_once_recipe_present_in_the_post( $post_id ) ) {
+            return false;
+        }
+
+        $warnings = $this->get_warnings( $post_id );
+
+        if ( count( $warnings ) > 0 ) {
+            // Show notification.
+            ?>
 			<div class="notice notice-warning is-dismissible">
 				<h3><?php esc_html_e( 'WordLift', 'wordlift' ); ?></h3>
 				<p><?php esc_html_e( 'The following recipes don\'t have minimum image size of 1200 x 1200 px. This size is required for channels like Google Discover', 'wordlift' ); ?></p>
 				<ol>
 					<?php
-					foreach ( $warnings as $warning ) {
-						$image_link = get_edit_post_link( $warning['image_id'] );
-						?>
+                    foreach ( $warnings as $warning ) {
+                        $image_link = get_edit_post_link( $warning['image_id'] );
+                        ?>
 						<li><?php echo esc_html( get_the_title( $warning['recipe_id'] ) ); ?> <a href="<?php echo esc_attr( $image_link ); ?>"><?php esc_html_e( '[edit image]', 'wordlift' ); ?></a></li>
 						<?php
-					}
-					?>
+                    }
+                    ?>
 				</ol>
 			</div>
 			<?php
-		}
-
-	}
-
-	/**
-	 * @param $post_id
-	 *
-	 * @return array
-	 */
-	private function get_warnings( $post_id ) {
-
-		$recipe_ids = \WPRM_Recipe_Manager::get_recipe_ids_from_post( $post_id );
-
-		// Dont show duplicate warnings.
-		$recipe_ids = array_unique( $recipe_ids );
-
-		$recipe_with_image_warnings = array();
-
-		foreach ( $recipe_ids as $recipe_id ) {
-			$recipe = \WPRM_Recipe_Manager::get_recipe( $recipe_id );
-			if ( ! $recipe ) {
-				continue;
-			}
-			$image_id   = $recipe->image_id();
-			$image_data = wp_get_attachment_image_src( $image_id, array( 1200, 1200 ) );
-			if ( ! is_array( $image_data ) ) {
-				continue;
-			}
-			$image_width  = array_key_exists( 1, $image_data ) ? $image_data [1] : false;
-			$image_height = array_key_exists( 2, $image_data ) ? $image_data [2] : false;
-			if ( ! ( $image_height && $image_width ) ) {
-				continue;
-			}
-
-			if ( $image_height < 1200 || $image_width < 1200 ) {
-				// Image size not present in 1200 * 1200, show a warning.
-				$recipe_with_image_warnings[] = array(
-					'recipe_id' => $recipe_id,
-					'image_id'  => $image_id,
-				);
-			}
-		}
-
-		return $recipe_with_image_warnings;
-	}
+        }
+
+    }
+
+    /**
+     * @param $post_id
+     *
+     * @return array
+     */
+    private function get_warnings( $post_id ) {
+
+        $recipe_ids = \WPRM_Recipe_Manager::get_recipe_ids_from_post( $post_id );
+
+        // Dont show duplicate warnings.
+        $recipe_ids = array_unique( $recipe_ids );
+
+        $recipe_with_image_warnings = array();
+
+        foreach ( $recipe_ids as $recipe_id ) {
+            $recipe = \WPRM_Recipe_Manager::get_recipe( $recipe_id );
+            if ( ! $recipe ) {
+                continue;
+            }
+            $image_id   = $recipe->image_id();
+            $image_data = wp_get_attachment_image_src( $image_id, array( 1200, 1200 ) );
+            if ( ! is_array( $image_data ) ) {
+                continue;
+            }
+            $image_width  = array_key_exists( 1, $image_data ) ? $image_data [1] : false;
+            $image_height = array_key_exists( 2, $image_data ) ? $image_data [2] : false;
+            if ( ! ( $image_height && $image_width ) ) {
+                continue;
+            }
+
+            if ( $image_height < 1200 || $image_width < 1200 ) {
+                // Image size not present in 1200 * 1200, show a warning.
+                $recipe_with_image_warnings[] = array(
+                    'recipe_id' => $recipe_id,
+                    'image_id'  => $image_id,
+                );
+            }
+        }
+
+        return $recipe_with_image_warnings;
+    }
 
 }

Spacing +25 added lines, -25 removed lines

@@ -16,12 +16,12 @@ 
 	 */
 	private $recipe_maker_validation_service;
 
-	public function __construct( $recipe_maker_validation_service ) {
+	public function __construct($recipe_maker_validation_service) {
 		$this->recipe_maker_validation_service = $recipe_maker_validation_service;
 		add_action(
 			'load-post.php',
-			function () {
-				add_action( 'wordlift_admin_notices', array( $this, 'display_image_size_warning' ) );
+			function() {
+				add_action('wordlift_admin_notices', array($this, 'display_image_size_warning'));
 			}
 		);
 
@@ -33,33 +33,33 @@ 
 	public function display_image_size_warning() {
 
 		// Check if we are on the post.
-		if ( ! get_post() instanceof \WP_Post ) {
+		if ( ! get_post() instanceof \WP_Post) {
 			return false;
 		}
-		if ( ! $this->recipe_maker_validation_service->is_wp_recipe_maker_available() ) {
+		if ( ! $this->recipe_maker_validation_service->is_wp_recipe_maker_available()) {
 			return false;
 		}
 		$post_id = get_the_ID();
 
 		// Dont show notification if there is no recipes referred by the post.
-		if ( ! $this->recipe_maker_validation_service->is_atleast_once_recipe_present_in_the_post( $post_id ) ) {
+		if ( ! $this->recipe_maker_validation_service->is_atleast_once_recipe_present_in_the_post($post_id)) {
 			return false;
 		}
 
-		$warnings = $this->get_warnings( $post_id );
+		$warnings = $this->get_warnings($post_id);
 
-		if ( count( $warnings ) > 0 ) {
+		if (count($warnings) > 0) {
 			// Show notification.
 			?>
 			<div class="notice notice-warning is-dismissible">
-				<h3><?php esc_html_e( 'WordLift', 'wordlift' ); ?></h3>
-				<p><?php esc_html_e( 'The following recipes don\'t have minimum image size of 1200 x 1200 px. This size is required for channels like Google Discover', 'wordlift' ); ?></p>
+				<h3><?php esc_html_e('WordLift', 'wordlift'); ?></h3>
+				<p><?php esc_html_e('The following recipes don\'t have minimum image size of 1200 x 1200 px. This size is required for channels like Google Discover', 'wordlift'); ?></p>
 				<ol>
 					<?php
-					foreach ( $warnings as $warning ) {
-						$image_link = get_edit_post_link( $warning['image_id'] );
+					foreach ($warnings as $warning) {
+						$image_link = get_edit_post_link($warning['image_id']);
 						?>
-						<li><?php echo esc_html( get_the_title( $warning['recipe_id'] ) ); ?> <a href="<?php echo esc_attr( $image_link ); ?>"><?php esc_html_e( '[edit image]', 'wordlift' ); ?></a></li>
+						<li><?php echo esc_html(get_the_title($warning['recipe_id'])); ?> <a href="<?php echo esc_attr($image_link); ?>"><?php esc_html_e('[edit image]', 'wordlift'); ?></a></li>
 						<?php
 					}
 					?>
@@ -75,32 +75,32 @@ 
 	 *
 	 * @return array
 	 */
-	private function get_warnings( $post_id ) {
+	private function get_warnings($post_id) {
 
-		$recipe_ids = \WPRM_Recipe_Manager::get_recipe_ids_from_post( $post_id );
+		$recipe_ids = \WPRM_Recipe_Manager::get_recipe_ids_from_post($post_id);
 
 		// Dont show duplicate warnings.
-		$recipe_ids = array_unique( $recipe_ids );
+		$recipe_ids = array_unique($recipe_ids);
 
 		$recipe_with_image_warnings = array();
 
-		foreach ( $recipe_ids as $recipe_id ) {
-			$recipe = \WPRM_Recipe_Manager::get_recipe( $recipe_id );
-			if ( ! $recipe ) {
+		foreach ($recipe_ids as $recipe_id) {
+			$recipe = \WPRM_Recipe_Manager::get_recipe($recipe_id);
+			if ( ! $recipe) {
 				continue;
 			}
 			$image_id   = $recipe->image_id();
-			$image_data = wp_get_attachment_image_src( $image_id, array( 1200, 1200 ) );
-			if ( ! is_array( $image_data ) ) {
+			$image_data = wp_get_attachment_image_src($image_id, array(1200, 1200));
+			if ( ! is_array($image_data)) {
 				continue;
 			}
-			$image_width  = array_key_exists( 1, $image_data ) ? $image_data [1] : false;
-			$image_height = array_key_exists( 2, $image_data ) ? $image_data [2] : false;
-			if ( ! ( $image_height && $image_width ) ) {
+			$image_width  = array_key_exists(1, $image_data) ? $image_data [1] : false;
+			$image_height = array_key_exists(2, $image_data) ? $image_data [2] : false;
+			if ( ! ($image_height && $image_width)) {
 				continue;
 			}
 
-			if ( $image_height < 1200 || $image_width < 1200 ) {
+			if ($image_height < 1200 || $image_width < 1200) {
 				// Image size not present in 1200 * 1200, show a warning.
 				$recipe_with_image_warnings[] = array(
 					'recipe_id' => $recipe_id,

src/wordlift/task/background/class-background-task-factory.php

Indentation +53 added lines, -53 removed lines

@@ -14,60 +14,60 @@
  */
 class Background_Task_Factory {
 
-	/**
-	 * Create a {@link Background_Task} given the provided task and route.
-	 *
-	 * @param Task   $task The target task.
-	 * @param string $route The route name.
-	 * @param string $page_id The page id.
-	 * @param string $page_title The page title.
-	 *
-	 * @return Background_Task
-	 * @throws Exception in case of invalid arguments.
-	 */
-	public static function create( $task, $route, $page_id, $page_title ) {
-		self::assertions( $task, $route );
-		$background_task       = Background_Task::create( $task );
-		$background_task_route = Background_Task_Route::create( $background_task, $route );
-		Background_Task_Page::create( $page_title, $page_id, $background_task_route );
-		return $background_task;
-	}
+    /**
+     * Create a {@link Background_Task} given the provided task and route.
+     *
+     * @param Task   $task The target task.
+     * @param string $route The route name.
+     * @param string $page_id The page id.
+     * @param string $page_title The page title.
+     *
+     * @return Background_Task
+     * @throws Exception in case of invalid arguments.
+     */
+    public static function create( $task, $route, $page_id, $page_title ) {
+        self::assertions( $task, $route );
+        $background_task       = Background_Task::create( $task );
+        $background_task_route = Background_Task_Route::create( $background_task, $route );
+        Background_Task_Page::create( $page_title, $page_id, $background_task_route );
+        return $background_task;
+    }
 
-	/**
-	 * Create a {@link Background_Task} given the provided task and route.
-	 *
-	 * @param Task   $task The target task.
-	 * @param string $route The route name.
-	 * @param string $page_id The page id.
-	 * @param string $page_title The page title.
-	 *
-	 * @return \Wordlift\Task\Action_Scheduler\Background_Task
-	 * @throws Exception in case of invalid arguments.
-	 */
-	public static function create_action_scheduler_task( $hook, $group, $task, $route, $page_id, $page_title, $batch_size = 5 ) {
-		self::assertions( $task, $route );
-		$background_task       = new \Wordlift\Task\Action_Scheduler\Background_Task(
-			$hook,
-			$group,
-			$task,
-			"_{$hook}_",
-			$batch_size
-		);
-		$background_task_route = Background_Task_Route::create( $background_task, $route );
-		Background_Task_Page::create( $page_title, $page_id, $background_task_route );
-		return $background_task;
-	}
+    /**
+     * Create a {@link Background_Task} given the provided task and route.
+     *
+     * @param Task   $task The target task.
+     * @param string $route The route name.
+     * @param string $page_id The page id.
+     * @param string $page_title The page title.
+     *
+     * @return \Wordlift\Task\Action_Scheduler\Background_Task
+     * @throws Exception in case of invalid arguments.
+     */
+    public static function create_action_scheduler_task( $hook, $group, $task, $route, $page_id, $page_title, $batch_size = 5 ) {
+        self::assertions( $task, $route );
+        $background_task       = new \Wordlift\Task\Action_Scheduler\Background_Task(
+            $hook,
+            $group,
+            $task,
+            "_{$hook}_",
+            $batch_size
+        );
+        $background_task_route = Background_Task_Route::create( $background_task, $route );
+        Background_Task_Page::create( $page_title, $page_id, $background_task_route );
+        return $background_task;
+    }
 
-	/**
-	 * @param Task  $task
-	 * @param $route
-	 *
-	 * @return void
-	 * @throws Exception in case of invalid arguments.
-	 */
-	private static function assertions( Task $task, $route ) {
-		Assertions::is_a( $task, 'Wordlift\Task\Task' );
-		Assertions::starts_with( $route, '/', __( 'The route must start with a slash.', 'wordlift' ) );
-	}
+    /**
+     * @param Task  $task
+     * @param $route
+     *
+     * @return void
+     * @throws Exception in case of invalid arguments.
+     */
+    private static function assertions( Task $task, $route ) {
+        Assertions::is_a( $task, 'Wordlift\Task\Task' );
+        Assertions::starts_with( $route, '/', __( 'The route must start with a slash.', 'wordlift' ) );
+    }
 
 }

Spacing +13 added lines, -13 removed lines

@@ -25,11 +25,11 @@ 
 	 * @return Background_Task
 	 * @throws Exception in case of invalid arguments.
 	 */
-	public static function create( $task, $route, $page_id, $page_title ) {
-		self::assertions( $task, $route );
-		$background_task       = Background_Task::create( $task );
-		$background_task_route = Background_Task_Route::create( $background_task, $route );
-		Background_Task_Page::create( $page_title, $page_id, $background_task_route );
+	public static function create($task, $route, $page_id, $page_title) {
+		self::assertions($task, $route);
+		$background_task       = Background_Task::create($task);
+		$background_task_route = Background_Task_Route::create($background_task, $route);
+		Background_Task_Page::create($page_title, $page_id, $background_task_route);
 		return $background_task;
 	}
 
@@ -44,17 +44,17 @@ 
 	 * @return \Wordlift\Task\Action_Scheduler\Background_Task
 	 * @throws Exception in case of invalid arguments.
 	 */
-	public static function create_action_scheduler_task( $hook, $group, $task, $route, $page_id, $page_title, $batch_size = 5 ) {
-		self::assertions( $task, $route );
-		$background_task       = new \Wordlift\Task\Action_Scheduler\Background_Task(
+	public static function create_action_scheduler_task($hook, $group, $task, $route, $page_id, $page_title, $batch_size = 5) {
+		self::assertions($task, $route);
+		$background_task = new \Wordlift\Task\Action_Scheduler\Background_Task(
 			$hook,
 			$group,
 			$task,
 			"_{$hook}_",
 			$batch_size
 		);
-		$background_task_route = Background_Task_Route::create( $background_task, $route );
-		Background_Task_Page::create( $page_title, $page_id, $background_task_route );
+		$background_task_route = Background_Task_Route::create($background_task, $route);
+		Background_Task_Page::create($page_title, $page_id, $background_task_route);
 		return $background_task;
 	}
 
@@ -65,9 +65,9 @@ 
 	 * @return void
 	 * @throws Exception in case of invalid arguments.
 	 */
-	private static function assertions( Task $task, $route ) {
-		Assertions::is_a( $task, 'Wordlift\Task\Task' );
-		Assertions::starts_with( $route, '/', __( 'The route must start with a slash.', 'wordlift' ) );
+	private static function assertions(Task $task, $route) {
+		Assertions::is_a($task, 'Wordlift\Task\Task');
+		Assertions::starts_with($route, '/', __('The route must start with a slash.', 'wordlift'));
 	}
 
 }