insideout10 / wordlift-plugin

src/wordlift/post-excerpt/class-post-excerpt-meta-box-adapter.php

Indentation +161 added lines, -161 removed lines

@@ -16,166 +16,166 @@
 
 final class Post_Excerpt_Meta_Box_Adapter {
 
-	/**
-	 * Key used by WordPress to add the excerpt meta box in
-	 * the $wp_meta_boxes global variable.
-	 */
-	const POST_EXCERPT_META_BOX_KEY = 'postexcerpt';
-
-	/**
-	 * Div id used for adding the additional content
-	 * to the WordPress excerpt meta box.
-	 */
-	const WORDLIFT_EXCERPT_DIV_ID = 'wl-custom-excerpt-wrapper';
-
-	/**
-	 * @var callable|null The default callback used by WordPress to
-	 * echo the post_excerpt contents, defaults to null.
-	 */
-	public $wordpress_excerpt_callback = null;
-
-	/**
-	 * Invokes the default callback inside our custom template callback
-	 *
-	 * @param $post array The post array.
-	 */
-	public function print_wordlift_custom_post_excerpt_box( $post ) {
-		call_user_func( $this->wordpress_excerpt_callback, $post );
-		// Invoke our call back to add additional html, the react script will find this id and render the component there.
-		echo "<div id='" . esc_html( self::WORDLIFT_EXCERPT_DIV_ID ) . "'></div>";
-	}
-
-	/**
-	 * Replaces the default post excerpt meta box with custom post excerpt meta box.
-	 */
-	public function replace_post_excerpt_meta_box() {
-		global $wp_meta_boxes;
-		$post_type = get_post_type();
-
-		// Bail out if feature is turned off
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__post-excerpt', true ) ) {
-			return;
-		}
-
-		/**
-		 * @since 3.27.6
-		 *
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/1188
-		 */
-		if ( ! isset( $wp_meta_boxes[ $post_type ] ) ) {
-			return;
-		}
-
-		$core_meta_boxes = $wp_meta_boxes[ $post_type ]['normal']['core'];
-
-		if ( ! isset( $core_meta_boxes[ self::POST_EXCERPT_META_BOX_KEY ] ) ) {
-			return;
-		}
-
-		$post_excerpt_meta_box = $core_meta_boxes[ self::POST_EXCERPT_META_BOX_KEY ];
-		$callback              = $post_excerpt_meta_box['callback'];
-		/**
-		 * do_meta_boxes action is called 3 times by WordPress for
-		 * different set of metaboxes, so to prevent overwriting our
-		 * callback with null, this check is necessary.
-		 */
-		if ( null !== $callback && array( $this, 'print_wordlift_custom_post_excerpt_box' ) !== $callback ) {
-			$this->wordpress_excerpt_callback = $callback;
-			$this->remove_default_post_excerpt_meta_box();
-			$this->add_custom_post_excerpt_meta_box();
-			$this->enqueue_post_excerpt_scripts();
-		}
-	}
-
-	/**
-	 * Removes the registered post excerpt metabox.
-	 */
-	private function remove_default_post_excerpt_meta_box() {
-
-		remove_meta_box( self::POST_EXCERPT_META_BOX_KEY, get_current_screen(), 'normal' );
-
-	}
-
-	/**
-	 * Deserializes the string, and rewrite the order for post excerpt.
-	 *
-	 * @param $order array
-	 *
-	 * @return array
-	 */
-	private function deserialize_and_rewrite_order( $order ) {
-		$side         = explode( ',', $order['side'] );
-		$normal       = explode( ',', $order['normal'] );
-		$advanced     = explode( ',', $order['advanced'] );
-		$remove_array = array( self::POST_EXCERPT_META_BOX_KEY );
-
-		// We first remove from the side category if it is previously present.
-		$side = array_diff( $side, $remove_array );
-		if ( count( $side ) === 0 ) {
-			// No boxes present, so add our excerpt box at o th position.
-			array_push( $side, self::POST_EXCERPT_META_BOX_KEY );
-		} else {
-			// Add custom excerpt metabox at second position
-			array_splice( $side, 1, 0, $remove_array );
-		}
-
-		// We remove postexcerpt from all other metaboxes category.
-		$normal   = array_diff( $normal, $remove_array );
-		$advanced = array_diff( $advanced, $remove_array );
-
-		return array(
-			'normal'   => $normal,
-			'side'     => $side,
-			'advanced' => $advanced,
-		);
-	}
-
-	/**
-	 * Adds the custom post excerpt metabox.
-	 */
-	private function add_custom_post_excerpt_meta_box() {
-		add_meta_box(
-			self::POST_EXCERPT_META_BOX_KEY,
-			// phpcs:ignore WordPress.WP.I18n.MissingArgDomainDefault
-			__( 'Excerpt' ),
-			array( $this, 'print_wordlift_custom_post_excerpt_box' ),
-			// Mimic the settings of the default metabox.
-			null,
-			'normal',
-			'high'
-		);
-	}
-
-	private function enqueue_post_excerpt_scripts() {
-		Scripts_Helper::enqueue_based_on_wordpress_version(
-			'wl-post-excerpt',
-			plugin_dir_url( dirname( __DIR__ ) ) . 'js/dist/post-excerpt',
-			array( 'react', 'react-dom', 'wp-polyfill' ),
-			true
-		);
-		wp_enqueue_style(
-			'wl-post-excerpt',
-			plugin_dir_url( dirname( __DIR__ ) ) . 'js/dist/post-excerpt.css',
-			array(),
-			WORDLIFT_VERSION
-		);
-		wp_localize_script(
-			'wl-post-excerpt',
-			'_wlExcerptSettings',
-			$this->get_post_excerpt_translations()
-		);
-	}
-
-	public function get_post_excerpt_translations() {
-
-		return array(
-			'orText'         => __( 'Or use WordLift suggested post excerpt:', 'wordlift' ),
-			'generatingText' => __( 'Generating excerpt...', 'wordlift' ),
-			'restUrl'        => get_rest_url( null, WL_REST_ROUTE_DEFAULT_NAMESPACE . '/post-excerpt' ),
-			'nonce'          => wp_create_nonce( 'wp_rest' ),
-			'postId'         => get_the_ID(),
-		);
-	}
+    /**
+     * Key used by WordPress to add the excerpt meta box in
+     * the $wp_meta_boxes global variable.
+     */
+    const POST_EXCERPT_META_BOX_KEY = 'postexcerpt';
+
+    /**
+     * Div id used for adding the additional content
+     * to the WordPress excerpt meta box.
+     */
+    const WORDLIFT_EXCERPT_DIV_ID = 'wl-custom-excerpt-wrapper';
+
+    /**
+     * @var callable|null The default callback used by WordPress to
+     * echo the post_excerpt contents, defaults to null.
+     */
+    public $wordpress_excerpt_callback = null;
+
+    /**
+     * Invokes the default callback inside our custom template callback
+     *
+     * @param $post array The post array.
+     */
+    public function print_wordlift_custom_post_excerpt_box( $post ) {
+        call_user_func( $this->wordpress_excerpt_callback, $post );
+        // Invoke our call back to add additional html, the react script will find this id and render the component there.
+        echo "<div id='" . esc_html( self::WORDLIFT_EXCERPT_DIV_ID ) . "'></div>";
+    }
+
+    /**
+     * Replaces the default post excerpt meta box with custom post excerpt meta box.
+     */
+    public function replace_post_excerpt_meta_box() {
+        global $wp_meta_boxes;
+        $post_type = get_post_type();
+
+        // Bail out if feature is turned off
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( ! apply_filters( 'wl_feature__enable__post-excerpt', true ) ) {
+            return;
+        }
+
+        /**
+         * @since 3.27.6
+         *
+         * @see https://github.com/insideout10/wordlift-plugin/issues/1188
+         */
+        if ( ! isset( $wp_meta_boxes[ $post_type ] ) ) {
+            return;
+        }
+
+        $core_meta_boxes = $wp_meta_boxes[ $post_type ]['normal']['core'];
+
+        if ( ! isset( $core_meta_boxes[ self::POST_EXCERPT_META_BOX_KEY ] ) ) {
+            return;
+        }
+
+        $post_excerpt_meta_box = $core_meta_boxes[ self::POST_EXCERPT_META_BOX_KEY ];
+        $callback              = $post_excerpt_meta_box['callback'];
+        /**
+         * do_meta_boxes action is called 3 times by WordPress for
+         * different set of metaboxes, so to prevent overwriting our
+         * callback with null, this check is necessary.
+         */
+        if ( null !== $callback && array( $this, 'print_wordlift_custom_post_excerpt_box' ) !== $callback ) {
+            $this->wordpress_excerpt_callback = $callback;
+            $this->remove_default_post_excerpt_meta_box();
+            $this->add_custom_post_excerpt_meta_box();
+            $this->enqueue_post_excerpt_scripts();
+        }
+    }
+
+    /**
+     * Removes the registered post excerpt metabox.
+     */
+    private function remove_default_post_excerpt_meta_box() {
+
+        remove_meta_box( self::POST_EXCERPT_META_BOX_KEY, get_current_screen(), 'normal' );
+
+    }
+
+    /**
+     * Deserializes the string, and rewrite the order for post excerpt.
+     *
+     * @param $order array
+     *
+     * @return array
+     */
+    private function deserialize_and_rewrite_order( $order ) {
+        $side         = explode( ',', $order['side'] );
+        $normal       = explode( ',', $order['normal'] );
+        $advanced     = explode( ',', $order['advanced'] );
+        $remove_array = array( self::POST_EXCERPT_META_BOX_KEY );
+
+        // We first remove from the side category if it is previously present.
+        $side = array_diff( $side, $remove_array );
+        if ( count( $side ) === 0 ) {
+            // No boxes present, so add our excerpt box at o th position.
+            array_push( $side, self::POST_EXCERPT_META_BOX_KEY );
+        } else {
+            // Add custom excerpt metabox at second position
+            array_splice( $side, 1, 0, $remove_array );
+        }
+
+        // We remove postexcerpt from all other metaboxes category.
+        $normal   = array_diff( $normal, $remove_array );
+        $advanced = array_diff( $advanced, $remove_array );
+
+        return array(
+            'normal'   => $normal,
+            'side'     => $side,
+            'advanced' => $advanced,
+        );
+    }
+
+    /**
+     * Adds the custom post excerpt metabox.
+     */
+    private function add_custom_post_excerpt_meta_box() {
+        add_meta_box(
+            self::POST_EXCERPT_META_BOX_KEY,
+            // phpcs:ignore WordPress.WP.I18n.MissingArgDomainDefault
+            __( 'Excerpt' ),
+            array( $this, 'print_wordlift_custom_post_excerpt_box' ),
+            // Mimic the settings of the default metabox.
+            null,
+            'normal',
+            'high'
+        );
+    }
+
+    private function enqueue_post_excerpt_scripts() {
+        Scripts_Helper::enqueue_based_on_wordpress_version(
+            'wl-post-excerpt',
+            plugin_dir_url( dirname( __DIR__ ) ) . 'js/dist/post-excerpt',
+            array( 'react', 'react-dom', 'wp-polyfill' ),
+            true
+        );
+        wp_enqueue_style(
+            'wl-post-excerpt',
+            plugin_dir_url( dirname( __DIR__ ) ) . 'js/dist/post-excerpt.css',
+            array(),
+            WORDLIFT_VERSION
+        );
+        wp_localize_script(
+            'wl-post-excerpt',
+            '_wlExcerptSettings',
+            $this->get_post_excerpt_translations()
+        );
+    }
+
+    public function get_post_excerpt_translations() {
+
+        return array(
+            'orText'         => __( 'Or use WordLift suggested post excerpt:', 'wordlift' ),
+            'generatingText' => __( 'Generating excerpt...', 'wordlift' ),
+            'restUrl'        => get_rest_url( null, WL_REST_ROUTE_DEFAULT_NAMESPACE . '/post-excerpt' ),
+            'nonce'          => wp_create_nonce( 'wp_rest' ),
+            'postId'         => get_the_ID(),
+        );
+    }
 
 }

Spacing +30 added lines, -30 removed lines

@@ -39,10 +39,10 @@ 
 	 *
 	 * @param $post array The post array.
 	 */
-	public function print_wordlift_custom_post_excerpt_box( $post ) {
-		call_user_func( $this->wordpress_excerpt_callback, $post );
+	public function print_wordlift_custom_post_excerpt_box($post) {
+		call_user_func($this->wordpress_excerpt_callback, $post);
 		// Invoke our call back to add additional html, the react script will find this id and render the component there.
-		echo "<div id='" . esc_html( self::WORDLIFT_EXCERPT_DIV_ID ) . "'></div>";
+		echo "<div id='".esc_html(self::WORDLIFT_EXCERPT_DIV_ID)."'></div>";
 	}
 
 	/**
@@ -54,7 +54,7 @@ 
 
 		// Bail out if feature is turned off
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__post-excerpt', true ) ) {
+		if ( ! apply_filters('wl_feature__enable__post-excerpt', true)) {
 			return;
 		}
 
@@ -63,24 +63,24 @@ 
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/1188
 		 */
-		if ( ! isset( $wp_meta_boxes[ $post_type ] ) ) {
+		if ( ! isset($wp_meta_boxes[$post_type])) {
 			return;
 		}
 
-		$core_meta_boxes = $wp_meta_boxes[ $post_type ]['normal']['core'];
+		$core_meta_boxes = $wp_meta_boxes[$post_type]['normal']['core'];
 
-		if ( ! isset( $core_meta_boxes[ self::POST_EXCERPT_META_BOX_KEY ] ) ) {
+		if ( ! isset($core_meta_boxes[self::POST_EXCERPT_META_BOX_KEY])) {
 			return;
 		}
 
-		$post_excerpt_meta_box = $core_meta_boxes[ self::POST_EXCERPT_META_BOX_KEY ];
+		$post_excerpt_meta_box = $core_meta_boxes[self::POST_EXCERPT_META_BOX_KEY];
 		$callback              = $post_excerpt_meta_box['callback'];
 		/**
 		 * do_meta_boxes action is called 3 times by WordPress for
 		 * different set of metaboxes, so to prevent overwriting our
 		 * callback with null, this check is necessary.
 		 */
-		if ( null !== $callback && array( $this, 'print_wordlift_custom_post_excerpt_box' ) !== $callback ) {
+		if (null !== $callback && array($this, 'print_wordlift_custom_post_excerpt_box') !== $callback) {
 			$this->wordpress_excerpt_callback = $callback;
 			$this->remove_default_post_excerpt_meta_box();
 			$this->add_custom_post_excerpt_meta_box();
@@ -93,7 +93,7 @@ 
 	 */
 	private function remove_default_post_excerpt_meta_box() {
 
-		remove_meta_box( self::POST_EXCERPT_META_BOX_KEY, get_current_screen(), 'normal' );
+		remove_meta_box(self::POST_EXCERPT_META_BOX_KEY, get_current_screen(), 'normal');
 
 	}
 
@@ -104,25 +104,25 @@ 
 	 *
 	 * @return array
 	 */
-	private function deserialize_and_rewrite_order( $order ) {
-		$side         = explode( ',', $order['side'] );
-		$normal       = explode( ',', $order['normal'] );
-		$advanced     = explode( ',', $order['advanced'] );
-		$remove_array = array( self::POST_EXCERPT_META_BOX_KEY );
+	private function deserialize_and_rewrite_order($order) {
+		$side         = explode(',', $order['side']);
+		$normal       = explode(',', $order['normal']);
+		$advanced     = explode(',', $order['advanced']);
+		$remove_array = array(self::POST_EXCERPT_META_BOX_KEY);
 
 		// We first remove from the side category if it is previously present.
-		$side = array_diff( $side, $remove_array );
-		if ( count( $side ) === 0 ) {
+		$side = array_diff($side, $remove_array);
+		if (count($side) === 0) {
 			// No boxes present, so add our excerpt box at o th position.
-			array_push( $side, self::POST_EXCERPT_META_BOX_KEY );
+			array_push($side, self::POST_EXCERPT_META_BOX_KEY);
 		} else {
 			// Add custom excerpt metabox at second position
-			array_splice( $side, 1, 0, $remove_array );
+			array_splice($side, 1, 0, $remove_array);
 		}
 
 		// We remove postexcerpt from all other metaboxes category.
-		$normal   = array_diff( $normal, $remove_array );
-		$advanced = array_diff( $advanced, $remove_array );
+		$normal   = array_diff($normal, $remove_array);
+		$advanced = array_diff($advanced, $remove_array);
 
 		return array(
 			'normal'   => $normal,
@@ -138,8 +138,8 @@ 
 		add_meta_box(
 			self::POST_EXCERPT_META_BOX_KEY,
 			// phpcs:ignore WordPress.WP.I18n.MissingArgDomainDefault
-			__( 'Excerpt' ),
-			array( $this, 'print_wordlift_custom_post_excerpt_box' ),
+			__('Excerpt'),
+			array($this, 'print_wordlift_custom_post_excerpt_box'),
 			// Mimic the settings of the default metabox.
 			null,
 			'normal',
@@ -150,13 +150,13 @@ 
 	private function enqueue_post_excerpt_scripts() {
 		Scripts_Helper::enqueue_based_on_wordpress_version(
 			'wl-post-excerpt',
-			plugin_dir_url( dirname( __DIR__ ) ) . 'js/dist/post-excerpt',
-			array( 'react', 'react-dom', 'wp-polyfill' ),
+			plugin_dir_url(dirname(__DIR__)).'js/dist/post-excerpt',
+			array('react', 'react-dom', 'wp-polyfill'),
 			true
 		);
 		wp_enqueue_style(
 			'wl-post-excerpt',
-			plugin_dir_url( dirname( __DIR__ ) ) . 'js/dist/post-excerpt.css',
+			plugin_dir_url(dirname(__DIR__)).'js/dist/post-excerpt.css',
 			array(),
 			WORDLIFT_VERSION
 		);
@@ -170,10 +170,10 @@ 
 	public function get_post_excerpt_translations() {
 
 		return array(
-			'orText'         => __( 'Or use WordLift suggested post excerpt:', 'wordlift' ),
-			'generatingText' => __( 'Generating excerpt...', 'wordlift' ),
-			'restUrl'        => get_rest_url( null, WL_REST_ROUTE_DEFAULT_NAMESPACE . '/post-excerpt' ),
-			'nonce'          => wp_create_nonce( 'wp_rest' ),
+			'orText'         => __('Or use WordLift suggested post excerpt:', 'wordlift'),
+			'generatingText' => __('Generating excerpt...', 'wordlift'),
+			'restUrl'        => get_rest_url(null, WL_REST_ROUTE_DEFAULT_NAMESPACE.'/post-excerpt'),
+			'nonce'          => wp_create_nonce('wp_rest'),
 			'postId'         => get_the_ID(),
 		);
 	}

src/wordlift/post-excerpt/class-post-excerpt-rest-controller.php

Indentation +207 added lines, -207 removed lines

@@ -18,212 +18,212 @@
 
 class Post_Excerpt_Rest_Controller {
 
-	const POST_EXCERPT_NAMESPACE = 'post-excerpt';
-	/**
-	 * Key for storing the meta data for the wordlift post excerpt.
-	 */
-	const POST_EXCERPT_META_KEY = '_wl_post_excerpt_meta';
-
-	/**
-	 * Url for getting the post excerpt data from wordlift api.
-	 */
-	const WORDLIFT_POST_EXCERPT_ENDPOINT = '/summarize';
-
-	/**
-	 * Wordlift returns excerpt in response using this key..
-	 */
-	const WORDLIFT_POST_EXCERPT_RESPONSE_KEY = 'summary';
-
-	public static function register_routes() {
-		add_action( 'rest_api_init', 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::register_route_callback' );
-	}
-
-	/**
-	 * Determines whether we need to get the excerpt from wordlift api,
-	 * or just use the one we already obtained by generating the hash and comparing it
-	 * with the previous one.
-	 *
-	 * @param $request WP_REST_Request $request {@link WP_REST_Request instance}.
-	 *
-	 * @return array Post excerpt data.
-	 */
-	public static function get_post_excerpt( $request ) {
-		$data      = $request->get_params();
-		$post_id   = $data['post_id'];
-		$post_body = strip_shortcodes( $data['post_body'] );
-		/**
-		 * @param $post_body string The post content sent from WordPress editor.
-		 * @param $post_id int The post id.
-		 *
-		 * @since 3.33.5
-		 * Allow post content sent to excerpt api to be filtered.
-		 */
-		$post_body       = apply_filters( 'wl_post_excerpt_post_content', $post_body, $post_id );
-		$current_hash    = md5( $post_body );
-		$server_response = self::get_post_excerpt_conditionally( $post_id, $post_body, $current_hash );
-		if ( empty( $server_response ) || ! array_key_exists( 'post_excerpt', $server_response ) ) {
-			return array(
-				'status'  => 'error',
-				'message' => __( 'Unable to contact WordLift API', 'wordlift' ),
-			);
-		} else {
-			return array(
-				'status'       => 'success',
-				'post_excerpt' => $server_response['post_excerpt'],
-				'from_cache'   => $server_response['from_cache'],
-				'message'      => __( 'Excerpt successfully generated.', 'wordlift' ),
-			);
-		}
-
-	}
-
-	/**
-	 * This function determines whether to get the excerpt from the server or from the meta cache.
-	 *
-	 * @param $post_id int The Post id.
-	 * @param $post_body string The post content
-	 * @param $current_hash string md5 hash of the current post body.
-	 *
-	 * @return array|bool|null
-	 */
-	public static function get_post_excerpt_conditionally( $post_id, $post_body, $current_hash ) {
-		$previous_data   = get_post_meta( $post_id, self::POST_EXCERPT_META_KEY, true );
-		$server_response = null;
-		if ( '' === $previous_data ) {
-			// There is no data in meta, so just fetch the data from remote server.
-			$server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
-		} else {
-			// If there is data in meta, get the previous hash and compare.
-			$previous_hash = $previous_data['post_body_hash'];
-
-			if ( $current_hash === $previous_hash ) {
-				// then return the previous value.
-				$server_response = array(
-					'post_excerpt' => $previous_data['post_excerpt'],
-					'from_cache'   => true,
-				);
-			} else {
-				// send the request to external API and then send the response.
-				$server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
-			}
-		}
-
-		return $server_response;
-	}
-
-	/**
-	 * Sends the remote request to the wordlift API and saves the response in meta for
-	 * future use.
-	 *
-	 * @param $post_id int Post id which the post excerpt belongs to
-	 * @param $post_body string Total text content of the post body.
-	 *
-	 * @return array|bool
-	 */
-	public static function get_post_excerpt_from_remote_server( $post_id, $post_body ) {
-		// The configuration is constant for now, it might be changing in future.
-		$configuration = array(
-			'ratio'      => 0.0005,
-			'min_length' => 60,
-		);
-		// Construct the url with the configuration
-		$endpoint    = add_query_arg( $configuration, self::WORDLIFT_POST_EXCERPT_ENDPOINT );
-		$api_service = Default_Api_Service::get_instance();
-		$response    = $api_service->request(
-			'POST',
-			$endpoint,
-			array( 'Content-Type' => 'text/plain' ),
-			$post_body,
-			null,
-			null,
-			array( 'data_format' => 'body' )
-		);
-
-		return self::save_response_to_meta_on_success( $post_id, $post_body, $response );
-	}
-
-	/**
-	 * Save the post excerpt to meta if the response is successful.
-	 *
-	 * @param $post_id int The post id
-	 * @param $post_body string Full text content of the post.
-	 * @param $response Response instance
-	 *
-	 * @return array|bool
-	 */
-	public static function save_response_to_meta_on_success( $post_id, $post_body, $response ) {
-		// If body exists then decode the body.
-		$body = json_decode( $response->get_body(), true );
-		if ( empty( $body ) || ! array_key_exists( self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY, $body ) ) {
-			// Bail out if we get an incorrect response
-			return false;
-		} else {
-			$post_excerpt = (string) $body[ self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY ];
-			// Save it to meta.
-			self::save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body );
-
-			return array(
-				'post_excerpt' => $post_excerpt,
-				'from_cache'   => false,
-			);
-		}
-	}
-
-	/**
-	 * Saves the excerpt in the post meta.
-	 *
-	 * @param $post_id int Post id which the post excerpt belongs to
-	 * @param $post_excerpt string Post excerpt returned by the server
-	 * @param $post_body string Total text content of the post body.
-	 *
-	 * @return void
-	 */
-	public static function save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body ) {
-		// hash the post body and save it.
-		$data = array(
-			'post_body_hash' => md5( $post_body ),
-			'post_excerpt'   => $post_excerpt,
-		);
-		update_post_meta( $post_id, self::POST_EXCERPT_META_KEY, $data );
-	}
-
-	/**
-	 * This call back is invoked by the Rest api action.
-	 */
-	public static function register_route_callback() {
-		/** @var  $post_id_validation_settings array Settings used to validate post id */
-		$post_id_validation_settings   = array(
-			'required'          => true,
-			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			'validate_callback' => function ( $param, $request, $key ) {
-				return is_numeric( $param );
-			},
-		);
-		$post_body_validation_settings = array(
-			'required'          => true,
-			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			'validate_callback' => function ( $param, $request, $key ) {
-				return is_string( $param );
-			},
-		);
-		/**
-		 * Rest route for getting the excerpt from wordlift api.
-		 */
-		register_rest_route(
-			WL_REST_ROUTE_DEFAULT_NAMESPACE,
-			'/' . self::POST_EXCERPT_NAMESPACE . '/(?P<post_id>\d+)',
-			array(
-				'methods'             => \WP_REST_Server::CREATABLE,
-				'callback'            => 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::get_post_excerpt',
-				'permission_callback' => function () {
-					return current_user_can( 'publish_posts' );
-				},
-				'args'                => array(
-					'post_id'   => $post_id_validation_settings,
-					'post_body' => $post_body_validation_settings,
-				),
-			)
-		);
-	}
+    const POST_EXCERPT_NAMESPACE = 'post-excerpt';
+    /**
+     * Key for storing the meta data for the wordlift post excerpt.
+     */
+    const POST_EXCERPT_META_KEY = '_wl_post_excerpt_meta';
+
+    /**
+     * Url for getting the post excerpt data from wordlift api.
+     */
+    const WORDLIFT_POST_EXCERPT_ENDPOINT = '/summarize';
+
+    /**
+     * Wordlift returns excerpt in response using this key..
+     */
+    const WORDLIFT_POST_EXCERPT_RESPONSE_KEY = 'summary';
+
+    public static function register_routes() {
+        add_action( 'rest_api_init', 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::register_route_callback' );
+    }
+
+    /**
+     * Determines whether we need to get the excerpt from wordlift api,
+     * or just use the one we already obtained by generating the hash and comparing it
+     * with the previous one.
+     *
+     * @param $request WP_REST_Request $request {@link WP_REST_Request instance}.
+     *
+     * @return array Post excerpt data.
+     */
+    public static function get_post_excerpt( $request ) {
+        $data      = $request->get_params();
+        $post_id   = $data['post_id'];
+        $post_body = strip_shortcodes( $data['post_body'] );
+        /**
+         * @param $post_body string The post content sent from WordPress editor.
+         * @param $post_id int The post id.
+         *
+         * @since 3.33.5
+         * Allow post content sent to excerpt api to be filtered.
+         */
+        $post_body       = apply_filters( 'wl_post_excerpt_post_content', $post_body, $post_id );
+        $current_hash    = md5( $post_body );
+        $server_response = self::get_post_excerpt_conditionally( $post_id, $post_body, $current_hash );
+        if ( empty( $server_response ) || ! array_key_exists( 'post_excerpt', $server_response ) ) {
+            return array(
+                'status'  => 'error',
+                'message' => __( 'Unable to contact WordLift API', 'wordlift' ),
+            );
+        } else {
+            return array(
+                'status'       => 'success',
+                'post_excerpt' => $server_response['post_excerpt'],
+                'from_cache'   => $server_response['from_cache'],
+                'message'      => __( 'Excerpt successfully generated.', 'wordlift' ),
+            );
+        }
+
+    }
+
+    /**
+     * This function determines whether to get the excerpt from the server or from the meta cache.
+     *
+     * @param $post_id int The Post id.
+     * @param $post_body string The post content
+     * @param $current_hash string md5 hash of the current post body.
+     *
+     * @return array|bool|null
+     */
+    public static function get_post_excerpt_conditionally( $post_id, $post_body, $current_hash ) {
+        $previous_data   = get_post_meta( $post_id, self::POST_EXCERPT_META_KEY, true );
+        $server_response = null;
+        if ( '' === $previous_data ) {
+            // There is no data in meta, so just fetch the data from remote server.
+            $server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
+        } else {
+            // If there is data in meta, get the previous hash and compare.
+            $previous_hash = $previous_data['post_body_hash'];
+
+            if ( $current_hash === $previous_hash ) {
+                // then return the previous value.
+                $server_response = array(
+                    'post_excerpt' => $previous_data['post_excerpt'],
+                    'from_cache'   => true,
+                );
+            } else {
+                // send the request to external API and then send the response.
+                $server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
+            }
+        }
+
+        return $server_response;
+    }
+
+    /**
+     * Sends the remote request to the wordlift API and saves the response in meta for
+     * future use.
+     *
+     * @param $post_id int Post id which the post excerpt belongs to
+     * @param $post_body string Total text content of the post body.
+     *
+     * @return array|bool
+     */
+    public static function get_post_excerpt_from_remote_server( $post_id, $post_body ) {
+        // The configuration is constant for now, it might be changing in future.
+        $configuration = array(
+            'ratio'      => 0.0005,
+            'min_length' => 60,
+        );
+        // Construct the url with the configuration
+        $endpoint    = add_query_arg( $configuration, self::WORDLIFT_POST_EXCERPT_ENDPOINT );
+        $api_service = Default_Api_Service::get_instance();
+        $response    = $api_service->request(
+            'POST',
+            $endpoint,
+            array( 'Content-Type' => 'text/plain' ),
+            $post_body,
+            null,
+            null,
+            array( 'data_format' => 'body' )
+        );
+
+        return self::save_response_to_meta_on_success( $post_id, $post_body, $response );
+    }
+
+    /**
+     * Save the post excerpt to meta if the response is successful.
+     *
+     * @param $post_id int The post id
+     * @param $post_body string Full text content of the post.
+     * @param $response Response instance
+     *
+     * @return array|bool
+     */
+    public static function save_response_to_meta_on_success( $post_id, $post_body, $response ) {
+        // If body exists then decode the body.
+        $body = json_decode( $response->get_body(), true );
+        if ( empty( $body ) || ! array_key_exists( self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY, $body ) ) {
+            // Bail out if we get an incorrect response
+            return false;
+        } else {
+            $post_excerpt = (string) $body[ self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY ];
+            // Save it to meta.
+            self::save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body );
+
+            return array(
+                'post_excerpt' => $post_excerpt,
+                'from_cache'   => false,
+            );
+        }
+    }
+
+    /**
+     * Saves the excerpt in the post meta.
+     *
+     * @param $post_id int Post id which the post excerpt belongs to
+     * @param $post_excerpt string Post excerpt returned by the server
+     * @param $post_body string Total text content of the post body.
+     *
+     * @return void
+     */
+    public static function save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body ) {
+        // hash the post body and save it.
+        $data = array(
+            'post_body_hash' => md5( $post_body ),
+            'post_excerpt'   => $post_excerpt,
+        );
+        update_post_meta( $post_id, self::POST_EXCERPT_META_KEY, $data );
+    }
+
+    /**
+     * This call back is invoked by the Rest api action.
+     */
+    public static function register_route_callback() {
+        /** @var  $post_id_validation_settings array Settings used to validate post id */
+        $post_id_validation_settings   = array(
+            'required'          => true,
+            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+            'validate_callback' => function ( $param, $request, $key ) {
+                return is_numeric( $param );
+            },
+        );
+        $post_body_validation_settings = array(
+            'required'          => true,
+            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+            'validate_callback' => function ( $param, $request, $key ) {
+                return is_string( $param );
+            },
+        );
+        /**
+         * Rest route for getting the excerpt from wordlift api.
+         */
+        register_rest_route(
+            WL_REST_ROUTE_DEFAULT_NAMESPACE,
+            '/' . self::POST_EXCERPT_NAMESPACE . '/(?P<post_id>\d+)',
+            array(
+                'methods'             => \WP_REST_Server::CREATABLE,
+                'callback'            => 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::get_post_excerpt',
+                'permission_callback' => function () {
+                    return current_user_can( 'publish_posts' );
+                },
+                'args'                => array(
+                    'post_id'   => $post_id_validation_settings,
+                    'post_body' => $post_body_validation_settings,
+                ),
+            )
+        );
+    }
 
 }

Spacing +36 added lines, -36 removed lines

@@ -35,7 +35,7 @@ 
 	const WORDLIFT_POST_EXCERPT_RESPONSE_KEY = 'summary';
 
 	public static function register_routes() {
-		add_action( 'rest_api_init', 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::register_route_callback' );
+		add_action('rest_api_init', 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::register_route_callback');
 	}
 
 	/**
@@ -47,10 +47,10 @@ 
 	 *
 	 * @return array Post excerpt data.
 	 */
-	public static function get_post_excerpt( $request ) {
+	public static function get_post_excerpt($request) {
 		$data      = $request->get_params();
 		$post_id   = $data['post_id'];
-		$post_body = strip_shortcodes( $data['post_body'] );
+		$post_body = strip_shortcodes($data['post_body']);
 		/**
 		 * @param $post_body string The post content sent from WordPress editor.
 		 * @param $post_id int The post id.
@@ -58,20 +58,20 @@ 
 		 * @since 3.33.5
 		 * Allow post content sent to excerpt api to be filtered.
 		 */
-		$post_body       = apply_filters( 'wl_post_excerpt_post_content', $post_body, $post_id );
-		$current_hash    = md5( $post_body );
-		$server_response = self::get_post_excerpt_conditionally( $post_id, $post_body, $current_hash );
-		if ( empty( $server_response ) || ! array_key_exists( 'post_excerpt', $server_response ) ) {
+		$post_body       = apply_filters('wl_post_excerpt_post_content', $post_body, $post_id);
+		$current_hash    = md5($post_body);
+		$server_response = self::get_post_excerpt_conditionally($post_id, $post_body, $current_hash);
+		if (empty($server_response) || ! array_key_exists('post_excerpt', $server_response)) {
 			return array(
 				'status'  => 'error',
-				'message' => __( 'Unable to contact WordLift API', 'wordlift' ),
+				'message' => __('Unable to contact WordLift API', 'wordlift'),
 			);
 		} else {
 			return array(
 				'status'       => 'success',
 				'post_excerpt' => $server_response['post_excerpt'],
 				'from_cache'   => $server_response['from_cache'],
-				'message'      => __( 'Excerpt successfully generated.', 'wordlift' ),
+				'message'      => __('Excerpt successfully generated.', 'wordlift'),
 			);
 		}
 
@@ -86,17 +86,17 @@ 
 	 *
 	 * @return array|bool|null
 	 */
-	public static function get_post_excerpt_conditionally( $post_id, $post_body, $current_hash ) {
-		$previous_data   = get_post_meta( $post_id, self::POST_EXCERPT_META_KEY, true );
+	public static function get_post_excerpt_conditionally($post_id, $post_body, $current_hash) {
+		$previous_data   = get_post_meta($post_id, self::POST_EXCERPT_META_KEY, true);
 		$server_response = null;
-		if ( '' === $previous_data ) {
+		if ('' === $previous_data) {
 			// There is no data in meta, so just fetch the data from remote server.
-			$server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
+			$server_response = self::get_post_excerpt_from_remote_server($post_id, $post_body);
 		} else {
 			// If there is data in meta, get the previous hash and compare.
 			$previous_hash = $previous_data['post_body_hash'];
 
-			if ( $current_hash === $previous_hash ) {
+			if ($current_hash === $previous_hash) {
 				// then return the previous value.
 				$server_response = array(
 					'post_excerpt' => $previous_data['post_excerpt'],
@@ -104,7 +104,7 @@ 
 				);
 			} else {
 				// send the request to external API and then send the response.
-				$server_response = self::get_post_excerpt_from_remote_server( $post_id, $post_body );
+				$server_response = self::get_post_excerpt_from_remote_server($post_id, $post_body);
 			}
 		}
 
@@ -120,26 +120,26 @@ 
 	 *
 	 * @return array|bool
 	 */
-	public static function get_post_excerpt_from_remote_server( $post_id, $post_body ) {
+	public static function get_post_excerpt_from_remote_server($post_id, $post_body) {
 		// The configuration is constant for now, it might be changing in future.
 		$configuration = array(
 			'ratio'      => 0.0005,
 			'min_length' => 60,
 		);
 		// Construct the url with the configuration
-		$endpoint    = add_query_arg( $configuration, self::WORDLIFT_POST_EXCERPT_ENDPOINT );
+		$endpoint    = add_query_arg($configuration, self::WORDLIFT_POST_EXCERPT_ENDPOINT);
 		$api_service = Default_Api_Service::get_instance();
 		$response    = $api_service->request(
 			'POST',
 			$endpoint,
-			array( 'Content-Type' => 'text/plain' ),
+			array('Content-Type' => 'text/plain'),
 			$post_body,
 			null,
 			null,
-			array( 'data_format' => 'body' )
+			array('data_format' => 'body')
 		);
 
-		return self::save_response_to_meta_on_success( $post_id, $post_body, $response );
+		return self::save_response_to_meta_on_success($post_id, $post_body, $response);
 	}
 
 	/**
@@ -151,16 +151,16 @@ 
 	 *
 	 * @return array|bool
 	 */
-	public static function save_response_to_meta_on_success( $post_id, $post_body, $response ) {
+	public static function save_response_to_meta_on_success($post_id, $post_body, $response) {
 		// If body exists then decode the body.
-		$body = json_decode( $response->get_body(), true );
-		if ( empty( $body ) || ! array_key_exists( self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY, $body ) ) {
+		$body = json_decode($response->get_body(), true);
+		if (empty($body) || ! array_key_exists(self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY, $body)) {
 			// Bail out if we get an incorrect response
 			return false;
 		} else {
-			$post_excerpt = (string) $body[ self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY ];
+			$post_excerpt = (string) $body[self::WORDLIFT_POST_EXCERPT_RESPONSE_KEY];
 			// Save it to meta.
-			self::save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body );
+			self::save_post_excerpt_in_meta($post_id, $post_excerpt, $post_body);
 
 			return array(
 				'post_excerpt' => $post_excerpt,
@@ -178,13 +178,13 @@ 
 	 *
 	 * @return void
 	 */
-	public static function save_post_excerpt_in_meta( $post_id, $post_excerpt, $post_body ) {
+	public static function save_post_excerpt_in_meta($post_id, $post_excerpt, $post_body) {
 		// hash the post body and save it.
 		$data = array(
-			'post_body_hash' => md5( $post_body ),
+			'post_body_hash' => md5($post_body),
 			'post_excerpt'   => $post_excerpt,
 		);
-		update_post_meta( $post_id, self::POST_EXCERPT_META_KEY, $data );
+		update_post_meta($post_id, self::POST_EXCERPT_META_KEY, $data);
 	}
 
 	/**
@@ -192,18 +192,18 @@ 
 	 */
 	public static function register_route_callback() {
 		/** @var  $post_id_validation_settings array Settings used to validate post id */
-		$post_id_validation_settings   = array(
+		$post_id_validation_settings = array(
 			'required'          => true,
 			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			'validate_callback' => function ( $param, $request, $key ) {
-				return is_numeric( $param );
+			'validate_callback' => function($param, $request, $key) {
+				return is_numeric($param);
 			},
 		);
 		$post_body_validation_settings = array(
 			'required'          => true,
 			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			'validate_callback' => function ( $param, $request, $key ) {
-				return is_string( $param );
+			'validate_callback' => function($param, $request, $key) {
+				return is_string($param);
 			},
 		);
 		/**
@@ -211,12 +211,12 @@ 
 		 */
 		register_rest_route(
 			WL_REST_ROUTE_DEFAULT_NAMESPACE,
-			'/' . self::POST_EXCERPT_NAMESPACE . '/(?P<post_id>\d+)',
+			'/'.self::POST_EXCERPT_NAMESPACE.'/(?P<post_id>\d+)',
 			array(
 				'methods'             => \WP_REST_Server::CREATABLE,
 				'callback'            => 'Wordlift\Post_Excerpt\Post_Excerpt_Rest_Controller::get_post_excerpt',
-				'permission_callback' => function () {
-					return current_user_can( 'publish_posts' );
+				'permission_callback' => function() {
+					return current_user_can('publish_posts');
 				},
 				'args'                => array(
 					'post_id'   => $post_id_validation_settings,

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

Indentation +163 added lines, -163 removed lines

@@ -18,168 +18,168 @@
 
 class Linked_Data_Autocomplete_Service implements Autocomplete_Service {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-	private $entity_helper;
-	private $entity_uri_service;
-	/**
-	 * @var \Wordlift_Entity_Service
-	 */
-	private $entity_service;
-
-	/**
-	 * The {@link Class_Wordlift_Autocomplete_Service} instance.
-	 *
-	 * @param Entity_Helper                $entity_helper
-	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service
-	 * @param \Wordlift_Entity_Service     $entity_service
-	 *
-	 * @since 3.15.0
-	 */
-	public function __construct( $entity_helper, $entity_uri_service, $entity_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Autocomplete_Service' );
-
-		$this->entity_helper      = $entity_helper;
-		$this->entity_uri_service = $entity_uri_service;
-		$this->entity_service     = $entity_service;
-
-	}
-
-	/**
-	 * Make request to external API and return the response.
-	 *
-	 * @param string       $query The search string.
-	 * @param string       $scope The search scope: "local" will search only in the local dataset; "cloud" will search also
-	 *                            in Wikipedia. By default is "cloud".
-	 * @param array|string $excludes The exclude parameter string.
-	 *
-	 * @return array $response The API response.
-	 * @since 3.15.0
-	 */
-	public function query( $query, $scope = 'cloud', $excludes = array() ) {
-
-		$results = $this->do_query( $query, $scope, $excludes );
-
-		$uris = array_reduce(
-			$results,
-			function ( $carry, $result ) {
-
-				$carry[] = $result['id'];
-
-				return array_merge( $carry, $result['sameAss'] );
-			},
-			array()
-		);
-
-		$mappings = $this->entity_helper->map_many_to_local( $uris );
-
-		$that           = $this;
-		$mapped_results = array_map(
-			function ( $result ) use ( $that, $mappings ) {
-
-				if ( $that->entity_uri_service->is_internal( $result['id'] ) ) {
-					  return $result;
-				}
-
-				$uris = array_merge( (array) $result['id'], $result['sameAss'] );
-
-				foreach ( $uris as $uri ) {
-					if ( isset( $mappings[ $uri ] ) ) {
-						$local_entity = $that->entity_uri_service->get_entity( $mappings[ $uri ] );
-
-						return $that->post_to_autocomplete_result( $mappings[ $uri ], $local_entity );
-					}
-				}
-
-				return $result;
-			},
-			$results
-		);
-
-		return $mapped_results;
-	}
-
-	private function do_query( $query, $scope = 'cloud', $exclude = '' ) {
-		$url = $this->build_request_url( $query, $exclude, $scope );
-
-		// Return the response.
-		$response = Default_Api_Service::get_instance()->get( $url )->get_response();
-
-		// If the response is valid, then send the suggestions.
-		if ( ! is_wp_error( $response ) && 200 === (int) $response['response']['code'] ) {
-			// Echo the response.
-			return json_decode( wp_remote_retrieve_body( $response ), true );
-		} else {
-			// Default error message.
-			$error_message = 'Something went wrong.';
-
-			// Get the real error message if there is WP_Error.
-			if ( is_wp_error( $response ) ) {
-				$error_message = $response->get_error_message();
-			}
-
-			$this->log->error( $error_message );
-
-			return array();
-		}
-	}
-
-	/**
-	 * Build the autocomplete url.
-	 *
-	 * @param string       $query The search string.
-	 * @param array|string $exclude The exclude parameter.
-	 * @param string       $scope The search scope: "local" will search only in the local dataset; "cloud" will search also
-	 *                            in Wikipedia. By default is "cloud".
-	 *
-	 * @return string Built url.
-	 * @since 3.15.0
-	 */
-	private function build_request_url( $query, $exclude, $scope ) {
-		$configuration_service = Wordlift_Configuration_Service::get_instance();
-
-		$args = array(
-			'key'      => $configuration_service->get_key(),
-			'language' => $configuration_service->get_language_code(),
-			'query'    => $query,
-			'scope'    => $scope,
-			'limit'    => 10,
-		);
-
-		// Add args to URL.
-		$request_url = add_query_arg( urlencode_deep( $args ), '/autocomplete' );
-
-		// Add the exclude parameter.
-		if ( ! empty( $exclude ) ) {
-			$request_url .= '&exclude=' . implode( '&exclude=', array_map( 'urlencode', (array) $exclude ) );
-		}
-
-		// return the built url.
-		return $request_url;
-	}
-
-	private function post_to_autocomplete_result( $uri, $post ) {
-
-		return array(
-			'id'           => $uri,
-			'label'        => array( $post->post_title ),
-			'labels'       => $this->entity_service->get_alternative_labels( $post->ID ),
-			'descriptions' => array( Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ) ),
-			'scope'        => 'local',
-			'sameAss'      => get_post_meta( $post->ID, Wordlift_Schema_Service::FIELD_SAME_AS ),
-			// The following properties are less relevant because we're linking entities that exist already in the
-			// vocabulary. That's why we don't make an effort to load the real data.
-			'types'        => array( 'http://schema.org/Thing' ),
-			'urls'         => array(),
-			'images'       => array(),
-		);
-	}
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+    private $entity_helper;
+    private $entity_uri_service;
+    /**
+     * @var \Wordlift_Entity_Service
+     */
+    private $entity_service;
+
+    /**
+     * The {@link Class_Wordlift_Autocomplete_Service} instance.
+     *
+     * @param Entity_Helper                $entity_helper
+     * @param \Wordlift_Entity_Uri_Service $entity_uri_service
+     * @param \Wordlift_Entity_Service     $entity_service
+     *
+     * @since 3.15.0
+     */
+    public function __construct( $entity_helper, $entity_uri_service, $entity_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Autocomplete_Service' );
+
+        $this->entity_helper      = $entity_helper;
+        $this->entity_uri_service = $entity_uri_service;
+        $this->entity_service     = $entity_service;
+
+    }
+
+    /**
+     * Make request to external API and return the response.
+     *
+     * @param string       $query The search string.
+     * @param string       $scope The search scope: "local" will search only in the local dataset; "cloud" will search also
+     *                            in Wikipedia. By default is "cloud".
+     * @param array|string $excludes The exclude parameter string.
+     *
+     * @return array $response The API response.
+     * @since 3.15.0
+     */
+    public function query( $query, $scope = 'cloud', $excludes = array() ) {
+
+        $results = $this->do_query( $query, $scope, $excludes );
+
+        $uris = array_reduce(
+            $results,
+            function ( $carry, $result ) {
+
+                $carry[] = $result['id'];
+
+                return array_merge( $carry, $result['sameAss'] );
+            },
+            array()
+        );
+
+        $mappings = $this->entity_helper->map_many_to_local( $uris );
+
+        $that           = $this;
+        $mapped_results = array_map(
+            function ( $result ) use ( $that, $mappings ) {
+
+                if ( $that->entity_uri_service->is_internal( $result['id'] ) ) {
+                        return $result;
+                }
+
+                $uris = array_merge( (array) $result['id'], $result['sameAss'] );
+
+                foreach ( $uris as $uri ) {
+                    if ( isset( $mappings[ $uri ] ) ) {
+                        $local_entity = $that->entity_uri_service->get_entity( $mappings[ $uri ] );
+
+                        return $that->post_to_autocomplete_result( $mappings[ $uri ], $local_entity );
+                    }
+                }
+
+                return $result;
+            },
+            $results
+        );
+
+        return $mapped_results;
+    }
+
+    private function do_query( $query, $scope = 'cloud', $exclude = '' ) {
+        $url = $this->build_request_url( $query, $exclude, $scope );
+
+        // Return the response.
+        $response = Default_Api_Service::get_instance()->get( $url )->get_response();
+
+        // If the response is valid, then send the suggestions.
+        if ( ! is_wp_error( $response ) && 200 === (int) $response['response']['code'] ) {
+            // Echo the response.
+            return json_decode( wp_remote_retrieve_body( $response ), true );
+        } else {
+            // Default error message.
+            $error_message = 'Something went wrong.';
+
+            // Get the real error message if there is WP_Error.
+            if ( is_wp_error( $response ) ) {
+                $error_message = $response->get_error_message();
+            }
+
+            $this->log->error( $error_message );
+
+            return array();
+        }
+    }
+
+    /**
+     * Build the autocomplete url.
+     *
+     * @param string       $query The search string.
+     * @param array|string $exclude The exclude parameter.
+     * @param string       $scope The search scope: "local" will search only in the local dataset; "cloud" will search also
+     *                            in Wikipedia. By default is "cloud".
+     *
+     * @return string Built url.
+     * @since 3.15.0
+     */
+    private function build_request_url( $query, $exclude, $scope ) {
+        $configuration_service = Wordlift_Configuration_Service::get_instance();
+
+        $args = array(
+            'key'      => $configuration_service->get_key(),
+            'language' => $configuration_service->get_language_code(),
+            'query'    => $query,
+            'scope'    => $scope,
+            'limit'    => 10,
+        );
+
+        // Add args to URL.
+        $request_url = add_query_arg( urlencode_deep( $args ), '/autocomplete' );
+
+        // Add the exclude parameter.
+        if ( ! empty( $exclude ) ) {
+            $request_url .= '&exclude=' . implode( '&exclude=', array_map( 'urlencode', (array) $exclude ) );
+        }
+
+        // return the built url.
+        return $request_url;
+    }
+
+    private function post_to_autocomplete_result( $uri, $post ) {
+
+        return array(
+            'id'           => $uri,
+            'label'        => array( $post->post_title ),
+            'labels'       => $this->entity_service->get_alternative_labels( $post->ID ),
+            'descriptions' => array( Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ) ),
+            'scope'        => 'local',
+            'sameAss'      => get_post_meta( $post->ID, Wordlift_Schema_Service::FIELD_SAME_AS ),
+            // The following properties are less relevant because we're linking entities that exist already in the
+            // vocabulary. That's why we don't make an effort to load the real data.
+            'types'        => array( 'http://schema.org/Thing' ),
+            'urls'         => array(),
+            'images'       => array(),
+        );
+    }
 
 }

Spacing +31 added lines, -31 removed lines

@@ -42,9 +42,9 @@ 
 	 *
 	 * @since 3.15.0
 	 */
-	public function __construct( $entity_helper, $entity_uri_service, $entity_service ) {
+	public function __construct($entity_helper, $entity_uri_service, $entity_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Autocomplete_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Autocomplete_Service');
 
 		$this->entity_helper      = $entity_helper;
 		$this->entity_uri_service = $entity_uri_service;
@@ -63,38 +63,38 @@ 
 	 * @return array $response The API response.
 	 * @since 3.15.0
 	 */
-	public function query( $query, $scope = 'cloud', $excludes = array() ) {
+	public function query($query, $scope = 'cloud', $excludes = array()) {
 
-		$results = $this->do_query( $query, $scope, $excludes );
+		$results = $this->do_query($query, $scope, $excludes);
 
 		$uris = array_reduce(
 			$results,
-			function ( $carry, $result ) {
+			function($carry, $result) {
 
 				$carry[] = $result['id'];
 
-				return array_merge( $carry, $result['sameAss'] );
+				return array_merge($carry, $result['sameAss']);
 			},
 			array()
 		);
 
-		$mappings = $this->entity_helper->map_many_to_local( $uris );
+		$mappings = $this->entity_helper->map_many_to_local($uris);
 
 		$that           = $this;
 		$mapped_results = array_map(
-			function ( $result ) use ( $that, $mappings ) {
+			function($result) use ($that, $mappings) {
 
-				if ( $that->entity_uri_service->is_internal( $result['id'] ) ) {
+				if ($that->entity_uri_service->is_internal($result['id'])) {
 					  return $result;
 				}
 
-				$uris = array_merge( (array) $result['id'], $result['sameAss'] );
+				$uris = array_merge((array) $result['id'], $result['sameAss']);
 
-				foreach ( $uris as $uri ) {
-					if ( isset( $mappings[ $uri ] ) ) {
-						$local_entity = $that->entity_uri_service->get_entity( $mappings[ $uri ] );
+				foreach ($uris as $uri) {
+					if (isset($mappings[$uri])) {
+						$local_entity = $that->entity_uri_service->get_entity($mappings[$uri]);
 
-						return $that->post_to_autocomplete_result( $mappings[ $uri ], $local_entity );
+						return $that->post_to_autocomplete_result($mappings[$uri], $local_entity);
 					}
 				}
 
@@ -106,26 +106,26 @@ 
 		return $mapped_results;
 	}
 
-	private function do_query( $query, $scope = 'cloud', $exclude = '' ) {
-		$url = $this->build_request_url( $query, $exclude, $scope );
+	private function do_query($query, $scope = 'cloud', $exclude = '') {
+		$url = $this->build_request_url($query, $exclude, $scope);
 
 		// Return the response.
-		$response = Default_Api_Service::get_instance()->get( $url )->get_response();
+		$response = Default_Api_Service::get_instance()->get($url)->get_response();
 
 		// If the response is valid, then send the suggestions.
-		if ( ! is_wp_error( $response ) && 200 === (int) $response['response']['code'] ) {
+		if ( ! is_wp_error($response) && 200 === (int) $response['response']['code']) {
 			// Echo the response.
-			return json_decode( wp_remote_retrieve_body( $response ), true );
+			return json_decode(wp_remote_retrieve_body($response), true);
 		} else {
 			// Default error message.
 			$error_message = 'Something went wrong.';
 
 			// Get the real error message if there is WP_Error.
-			if ( is_wp_error( $response ) ) {
+			if (is_wp_error($response)) {
 				$error_message = $response->get_error_message();
 			}
 
-			$this->log->error( $error_message );
+			$this->log->error($error_message);
 
 			return array();
 		}
@@ -142,7 +142,7 @@ 
 	 * @return string Built url.
 	 * @since 3.15.0
 	 */
-	private function build_request_url( $query, $exclude, $scope ) {
+	private function build_request_url($query, $exclude, $scope) {
 		$configuration_service = Wordlift_Configuration_Service::get_instance();
 
 		$args = array(
@@ -154,29 +154,29 @@ 
 		);
 
 		// Add args to URL.
-		$request_url = add_query_arg( urlencode_deep( $args ), '/autocomplete' );
+		$request_url = add_query_arg(urlencode_deep($args), '/autocomplete');
 
 		// Add the exclude parameter.
-		if ( ! empty( $exclude ) ) {
-			$request_url .= '&exclude=' . implode( '&exclude=', array_map( 'urlencode', (array) $exclude ) );
+		if ( ! empty($exclude)) {
+			$request_url .= '&exclude='.implode('&exclude=', array_map('urlencode', (array) $exclude));
 		}
 
 		// return the built url.
 		return $request_url;
 	}
 
-	private function post_to_autocomplete_result( $uri, $post ) {
+	private function post_to_autocomplete_result($uri, $post) {
 
 		return array(
 			'id'           => $uri,
-			'label'        => array( $post->post_title ),
-			'labels'       => $this->entity_service->get_alternative_labels( $post->ID ),
-			'descriptions' => array( Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ) ),
+			'label'        => array($post->post_title),
+			'labels'       => $this->entity_service->get_alternative_labels($post->ID),
+			'descriptions' => array(Wordlift_Post_Excerpt_Helper::get_text_excerpt($post)),
 			'scope'        => 'local',
-			'sameAss'      => get_post_meta( $post->ID, Wordlift_Schema_Service::FIELD_SAME_AS ),
+			'sameAss'      => get_post_meta($post->ID, Wordlift_Schema_Service::FIELD_SAME_AS),
 			// The following properties are less relevant because we're linking entities that exist already in the
 			// vocabulary. That's why we don't make an effort to load the real data.
-			'types'        => array( 'http://schema.org/Thing' ),
+			'types'        => array('http://schema.org/Thing'),
 			'urls'         => array(),
 			'images'       => array(),
 		);

src/wordlift/autocomplete/class-all-autocomplete-service.php

Indentation +47 added lines, -47 removed lines

@@ -12,62 +12,62 @@
 
 class All_Autocomplete_Service implements Autocomplete_Service {
 
-	/**
-	 * One ore more {@link Autocomplete_Service} instances.
-	 *
-	 * @var Autocomplete_Service|Autocomplete_Service[] $autocomplete_services
-	 */
-	private $autocomplete_services;
+    /**
+     * One ore more {@link Autocomplete_Service} instances.
+     *
+     * @var Autocomplete_Service|Autocomplete_Service[] $autocomplete_services
+     */
+    private $autocomplete_services;
 
-	/**
-	 * All_Autocomplete_Service constructor.
-	 *
-	 * @param Autocomplete_Service|Autocomplete_Service[] $autocomplete_services
-	 */
-	public function __construct( $autocomplete_services ) {
+    /**
+     * All_Autocomplete_Service constructor.
+     *
+     * @param Autocomplete_Service|Autocomplete_Service[] $autocomplete_services
+     */
+    public function __construct( $autocomplete_services ) {
 
-		$this->autocomplete_services = (array) $autocomplete_services;
-	}
+        $this->autocomplete_services = (array) $autocomplete_services;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function query( $query, $scope, $excludes ) {
+    /**
+     * {@inheritDoc}
+     */
+    public function query( $query, $scope, $excludes ) {
 
-		/**
-		 * Filter to show local entities on the entity autocompletion field.
-		 *
-		 * @param $state bool
-		 *
-		 * @return bool Whether to show local entities in the page or not.
-		 * @since 3.26.1
-		 */
-		$show_local_entities = apply_filters( 'wl_show_local_entities', false );
+        /**
+         * Filter to show local entities on the entity autocompletion field.
+         *
+         * @param $state bool
+         *
+         * @return bool Whether to show local entities in the page or not.
+         * @since 3.26.1
+         */
+        $show_local_entities = apply_filters( 'wl_show_local_entities', false );
 
-		$autocomplete_services = $this->autocomplete_services;
+        $autocomplete_services = $this->autocomplete_services;
 
-		// Remove the local autocomplete services.
-		if ( ! $show_local_entities ) {
-			$autocomplete_services = array_filter(
-				$autocomplete_services,
-				function ( $service ) {
-					return ! $service instanceof Local_Autocomplete_Service;
-				}
-			);
-		}
+        // Remove the local autocomplete services.
+        if ( ! $show_local_entities ) {
+            $autocomplete_services = array_filter(
+                $autocomplete_services,
+                function ( $service ) {
+                    return ! $service instanceof Local_Autocomplete_Service;
+                }
+            );
+        }
 
-		// Query each Autocomplete service and merge the results.
-		return array_reduce(
-			$autocomplete_services,
-			function ( $carry, $item ) use ( $query, $scope, $excludes ) {
+        // Query each Autocomplete service and merge the results.
+        return array_reduce(
+            $autocomplete_services,
+            function ( $carry, $item ) use ( $query, $scope, $excludes ) {
 
-				$results = $item->query( $query, $scope, $excludes );
+                $results = $item->query( $query, $scope, $excludes );
 
-				return array_merge( $carry, $results );
-			},
-			array()
-		);
+                return array_merge( $carry, $results );
+            },
+            array()
+        );
 
-	}
+    }
 
 }

Spacing +8 added lines, -8 removed lines

@@ -24,7 +24,7 @@ 
 	 *
 	 * @param Autocomplete_Service|Autocomplete_Service[] $autocomplete_services
 	 */
-	public function __construct( $autocomplete_services ) {
+	public function __construct($autocomplete_services) {
 
 		$this->autocomplete_services = (array) $autocomplete_services;
 	}
@@ -32,7 +32,7 @@ 
 	/**
 	 * {@inheritDoc}
 	 */
-	public function query( $query, $scope, $excludes ) {
+	public function query($query, $scope, $excludes) {
 
 		/**
 		 * Filter to show local entities on the entity autocompletion field.
@@ -42,15 +42,15 @@ 
 		 * @return bool Whether to show local entities in the page or not.
 		 * @since 3.26.1
 		 */
-		$show_local_entities = apply_filters( 'wl_show_local_entities', false );
+		$show_local_entities = apply_filters('wl_show_local_entities', false);
 
 		$autocomplete_services = $this->autocomplete_services;
 
 		// Remove the local autocomplete services.
-		if ( ! $show_local_entities ) {
+		if ( ! $show_local_entities) {
 			$autocomplete_services = array_filter(
 				$autocomplete_services,
-				function ( $service ) {
+				function($service) {
 					return ! $service instanceof Local_Autocomplete_Service;
 				}
 			);
@@ -59,11 +59,11 @@ 
 		// Query each Autocomplete service and merge the results.
 		return array_reduce(
 			$autocomplete_services,
-			function ( $carry, $item ) use ( $query, $scope, $excludes ) {
+			function($carry, $item) use ($query, $scope, $excludes) {
 
-				$results = $item->query( $query, $scope, $excludes );
+				$results = $item->query($query, $scope, $excludes);
 
-				return array_merge( $carry, $results );
+				return array_merge($carry, $results);
 			},
 			array()
 		);

src/wordlift/autocomplete/class-abstract-autocomplete-service.php

Indentation +27 added lines, -27 removed lines

@@ -11,35 +11,35 @@
 
 abstract class Abstract_Autocomplete_Service implements Autocomplete_Service {
 
-	/**
-	 * Filter out results that are in the excludes list.
-	 *
-	 * @param array $results {
-	 * An array of results.
-	 *
-	 * @type array The result's data.
-	 * }
-	 *
-	 * @param array $excludes An array of URLs.
-	 *
-	 * @return array The filtered array of results.
-	 */
-	protected function filter( $results, $excludes ) {
+    /**
+     * Filter out results that are in the excludes list.
+     *
+     * @param array $results {
+     * An array of results.
+     *
+     * @type array The result's data.
+     * }
+     *
+     * @param array $excludes An array of URLs.
+     *
+     * @return array The filtered array of results.
+     */
+    protected function filter( $results, $excludes ) {
 
-		$excludes_array = (array) $excludes;
+        $excludes_array = (array) $excludes;
 
-		return array_filter(
-			$results,
-			function ( $item ) use ( $excludes_array ) {
+        return array_filter(
+            $results,
+            function ( $item ) use ( $excludes_array ) {
 
-				return 0 === count(
-					array_intersect(
-						array_merge( (array) $item['id'], $item['sameAss'] ),
-						$excludes_array
-					)
-				);
-			}
-		);
-	}
+                return 0 === count(
+                    array_intersect(
+                        array_merge( (array) $item['id'], $item['sameAss'] ),
+                        $excludes_array
+                    )
+                );
+            }
+        );
+    }
 
 }

Spacing +3 added lines, -3 removed lines

@@ -24,17 +24,17 @@
 	 *
 	 * @return array The filtered array of results.
 	 */
-	protected function filter( $results, $excludes ) {
+	protected function filter($results, $excludes) {
 
 		$excludes_array = (array) $excludes;
 
 		return array_filter(
 			$results,
-			function ( $item ) use ( $excludes_array ) {
+			function($item) use ($excludes_array) {
 
 				return 0 === count(
 					array_intersect(
-						array_merge( (array) $item['id'], $item['sameAss'] ),
+						array_merge((array) $item['id'], $item['sameAss']),
 						$excludes_array
 					)
 				);

src/wordlift/autocomplete/class-local-autocomplete-service.php

Indentation +56 added lines, -56 removed lines

@@ -15,67 +15,67 @@
 
 class Local_Autocomplete_Service extends Abstract_Autocomplete_Service {
 
-	/**
-	 * @inheritDoc
-	 */
-	public function query( $query, $scope, $excludes ) {
-		global $wpdb;
+    /**
+     * @inheritDoc
+     */
+    public function query( $query, $scope, $excludes ) {
+        global $wpdb;
 
-		$posts = $wpdb->get_results(
-			$wpdb->prepare(
-				"SELECT * FROM {$wpdb->posts} p"
-				. " INNER JOIN {$wpdb->term_relationships} tr"
-				. '  ON tr.object_id = p.ID'
-				. " 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'
-				. " LEFT OUTER JOIN {$wpdb->postmeta} pm"
-				. '  ON pm.meta_key = %s AND pm.post_id = p.ID'
-				. " WHERE p.post_type IN ( '" . implode( "', '", array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() ) ) . "' )" // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.PreparedSQLPlaceholders.QuotedDynamicPlaceholderGeneration
-				. "  AND p.post_status IN ( 'publish', 'draft', 'private', 'future' ) "
-				. '  AND ( p.post_title LIKE %s OR pm.meta_value LIKE %s )'
-				. ' LIMIT %d',
-				Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'article',
-				Wordlift_Entity_Service::ALTERNATIVE_LABEL_META_KEY,
-				// `prepare` doesn't support argument number, hence we must repeat the query.
-				'%' . $wpdb->esc_like( $query ) . '%',
-				'%' . $wpdb->esc_like( $query ) . '%',
-				50
-			)
-		);
+        $posts = $wpdb->get_results(
+            $wpdb->prepare(
+                "SELECT * FROM {$wpdb->posts} p"
+                . " INNER JOIN {$wpdb->term_relationships} tr"
+                . '  ON tr.object_id = p.ID'
+                . " 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'
+                . " LEFT OUTER JOIN {$wpdb->postmeta} pm"
+                . '  ON pm.meta_key = %s AND pm.post_id = p.ID'
+                . " WHERE p.post_type IN ( '" . implode( "', '", array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() ) ) . "' )" // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.PreparedSQLPlaceholders.QuotedDynamicPlaceholderGeneration
+                . "  AND p.post_status IN ( 'publish', 'draft', 'private', 'future' ) "
+                . '  AND ( p.post_title LIKE %s OR pm.meta_value LIKE %s )'
+                . ' LIMIT %d',
+                Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'article',
+                Wordlift_Entity_Service::ALTERNATIVE_LABEL_META_KEY,
+                // `prepare` doesn't support argument number, hence we must repeat the query.
+                '%' . $wpdb->esc_like( $query ) . '%',
+                '%' . $wpdb->esc_like( $query ) . '%',
+                50
+            )
+        );
 
-		$results = array_map(
-			function ( $item ) {
+        $results = array_map(
+            function ( $item ) {
 
-				$entity_service = Wordlift_Entity_Service::get_instance();
-				$uri            = $entity_service->get_uri( $item->ID );
+                $entity_service = Wordlift_Entity_Service::get_instance();
+                $uri            = $entity_service->get_uri( $item->ID );
 
-				return array(
-					// see #1074: The value property is needed for autocomplete in category page
-					// to function correctly, if value is not provided, then the entity
-					// wont be correctly saved.
-					'value'        => $uri,
-					'id'           => $uri,
-					'label'        => array( $item->post_title ),
-					'labels'       => $entity_service->get_alternative_labels( $item->ID ),
-					'descriptions' => array( Wordlift_Post_Excerpt_Helper::get_text_excerpt( $item ) ),
-					'scope'        => 'local',
-					'sameAss'      => get_post_meta( $item->ID, \Wordlift_Schema_Service::FIELD_SAME_AS ),
-					// The following properties are less relevant because we're linking entities that exist already in the
-					// vocabulary. That's why we don't make an effort to load the real data.
-					'types'        => array( 'http://schema.org/Thing' ),
-					'urls'         => array(),
-					'images'       => array(),
-				);
-			},
-			$posts
-		);
+                return array(
+                    // see #1074: The value property is needed for autocomplete in category page
+                    // to function correctly, if value is not provided, then the entity
+                    // wont be correctly saved.
+                    'value'        => $uri,
+                    'id'           => $uri,
+                    'label'        => array( $item->post_title ),
+                    'labels'       => $entity_service->get_alternative_labels( $item->ID ),
+                    'descriptions' => array( Wordlift_Post_Excerpt_Helper::get_text_excerpt( $item ) ),
+                    'scope'        => 'local',
+                    'sameAss'      => get_post_meta( $item->ID, \Wordlift_Schema_Service::FIELD_SAME_AS ),
+                    // The following properties are less relevant because we're linking entities that exist already in the
+                    // vocabulary. That's why we don't make an effort to load the real data.
+                    'types'        => array( 'http://schema.org/Thing' ),
+                    'urls'         => array(),
+                    'images'       => array(),
+                );
+            },
+            $posts
+        );
 
-		$results = array_unique( $results, SORT_REGULAR );
+        $results = array_unique( $results, SORT_REGULAR );
 
-		return $this->filter( $results, $excludes );
-	}
+        return $this->filter( $results, $excludes );
+    }
 
 }

Spacing +13 added lines, -13 removed lines

@@ -18,7 +18,7 @@ 
 	/**
 	 * @inheritDoc
 	 */
-	public function query( $query, $scope, $excludes ) {
+	public function query($query, $scope, $excludes) {
 		global $wpdb;
 
 		$posts = $wpdb->get_results(
@@ -32,7 +32,7 @@ 
 				. '  ON t.term_id = tt.term_id AND t.name != %s'
 				. " LEFT OUTER JOIN {$wpdb->postmeta} pm"
 				. '  ON pm.meta_key = %s AND pm.post_id = p.ID'
-				. " WHERE p.post_type IN ( '" . implode( "', '", array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() ) ) . "' )" // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.PreparedSQLPlaceholders.QuotedDynamicPlaceholderGeneration
+				. " WHERE p.post_type IN ( '".implode("', '", array_map('esc_sql', Wordlift_Entity_Service::valid_entity_post_types()))."' )" // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.PreparedSQLPlaceholders.QuotedDynamicPlaceholderGeneration
 				. "  AND p.post_status IN ( 'publish', 'draft', 'private', 'future' ) "
 				. '  AND ( p.post_title LIKE %s OR pm.meta_value LIKE %s )'
 				. ' LIMIT %d',
@@ -40,17 +40,17 @@ 
 				'article',
 				Wordlift_Entity_Service::ALTERNATIVE_LABEL_META_KEY,
 				// `prepare` doesn't support argument number, hence we must repeat the query.
-				'%' . $wpdb->esc_like( $query ) . '%',
-				'%' . $wpdb->esc_like( $query ) . '%',
+				'%'.$wpdb->esc_like($query).'%',
+				'%'.$wpdb->esc_like($query).'%',
 				50
 			)
 		);
 
 		$results = array_map(
-			function ( $item ) {
+			function($item) {
 
 				$entity_service = Wordlift_Entity_Service::get_instance();
-				$uri            = $entity_service->get_uri( $item->ID );
+				$uri            = $entity_service->get_uri($item->ID);
 
 				return array(
 					// see #1074: The value property is needed for autocomplete in category page
@@ -58,14 +58,14 @@ 
 					// wont be correctly saved.
 					'value'        => $uri,
 					'id'           => $uri,
-					'label'        => array( $item->post_title ),
-					'labels'       => $entity_service->get_alternative_labels( $item->ID ),
-					'descriptions' => array( Wordlift_Post_Excerpt_Helper::get_text_excerpt( $item ) ),
+					'label'        => array($item->post_title),
+					'labels'       => $entity_service->get_alternative_labels($item->ID),
+					'descriptions' => array(Wordlift_Post_Excerpt_Helper::get_text_excerpt($item)),
 					'scope'        => 'local',
-					'sameAss'      => get_post_meta( $item->ID, \Wordlift_Schema_Service::FIELD_SAME_AS ),
+					'sameAss'      => get_post_meta($item->ID, \Wordlift_Schema_Service::FIELD_SAME_AS),
 					// The following properties are less relevant because we're linking entities that exist already in the
 					// vocabulary. That's why we don't make an effort to load the real data.
-					'types'        => array( 'http://schema.org/Thing' ),
+					'types'        => array('http://schema.org/Thing'),
 					'urls'         => array(),
 					'images'       => array(),
 				);
@@ -73,9 +73,9 @@ 
 			$posts
 		);
 
-		$results = array_unique( $results, SORT_REGULAR );
+		$results = array_unique($results, SORT_REGULAR);
 
-		return $this->filter( $results, $excludes );
+		return $this->filter($results, $excludes);
 	}
 
 }

src/wordlift/vocabulary-terms/hooks/class-term-save.php

Indentation +9 added lines, -9 removed lines

@@ -21,18 +21,18 @@
  */
 class Term_Save {
 
-	public function init() {
-		add_action( 'create_term', array( $this, 'saved_term' ) );
-		add_action( 'edited_term', array( $this, 'saved_term' ) );
-	}
+    public function init() {
+        add_action( 'create_term', array( $this, 'saved_term' ) );
+        add_action( 'edited_term', array( $this, 'saved_term' ) );
+    }
 
-	public function saved_term( $term_id ) {
+    public function saved_term( $term_id ) {
 
-		// check if entity url already exists.
+        // check if entity url already exists.
 
-		Wordpress_Term_Content_Legacy_Service::get_instance()
-									  ->get_entity_id( Wordpress_Content_Id::create_term( $term_id ) );
+        Wordpress_Term_Content_Legacy_Service::get_instance()
+                                        ->get_entity_id( Wordpress_Content_Id::create_term( $term_id ) );
 
-	}
+    }
 
 }

Spacing +4 added lines, -4 removed lines

@@ -22,16 +22,16 @@
 class Term_Save {
 
 	public function init() {
-		add_action( 'create_term', array( $this, 'saved_term' ) );
-		add_action( 'edited_term', array( $this, 'saved_term' ) );
+		add_action('create_term', array($this, 'saved_term'));
+		add_action('edited_term', array($this, 'saved_term'));
 	}
 
-	public function saved_term( $term_id ) {
+	public function saved_term($term_id) {
 
 		// check if entity url already exists.
 
 		Wordpress_Term_Content_Legacy_Service::get_instance()
-									  ->get_entity_id( Wordpress_Content_Id::create_term( $term_id ) );
+									  ->get_entity_id(Wordpress_Content_Id::create_term($term_id));
 
 	}
 

src/wordlift/vocabulary-terms/class-vocabulary-terms-loader.php

Indentation +39 added lines, -39 removed lines

@@ -12,44 +12,44 @@
 use Wordlift\Vocabulary_Terms\Jsonld\Post_Jsonld;
 
 class Vocabulary_Terms_Loader extends Default_Loader {
-	/**
-	 * @var \Wordlift_Entity_Type_Service
-	 */
-	private $entity_type_service;
-	/**
-	 * @var \Wordlift_Property_Getter
-	 */
-	private $property_getter;
-
-	/**
-	 * Vocabulary_Terms_Loader constructor.
-	 *
-	 * @param $entity_type_service \Wordlift_Entity_Type_Service
-	 * @param \Wordlift_Property_Getter                         $property_getter
-	 */
-	public function __construct( $entity_type_service, $property_getter ) {
-		parent::__construct();
-		$this->entity_type_service = $entity_type_service;
-		$this->property_getter     = $property_getter;
-	}
-
-	public function init_all_dependencies() {
-		new Entity_Type();
-		new Term_Metabox();
-		$jsonld = new Jsonld_Generator( $this->entity_type_service, $this->property_getter );
-		$jsonld->init();
-		$term_save_hook = new Term_Save();
-		$term_save_hook->init();
-		$post_jsonld = new Post_Jsonld();
-		$post_jsonld->init();
-	}
-
-	protected function get_feature_slug() {
-		return 'no-vocabulary-terms';
-	}
-
-	protected function get_feature_default_value() {
-		return false;
-	}
+    /**
+     * @var \Wordlift_Entity_Type_Service
+     */
+    private $entity_type_service;
+    /**
+     * @var \Wordlift_Property_Getter
+     */
+    private $property_getter;
+
+    /**
+     * Vocabulary_Terms_Loader constructor.
+     *
+     * @param $entity_type_service \Wordlift_Entity_Type_Service
+     * @param \Wordlift_Property_Getter                         $property_getter
+     */
+    public function __construct( $entity_type_service, $property_getter ) {
+        parent::__construct();
+        $this->entity_type_service = $entity_type_service;
+        $this->property_getter     = $property_getter;
+    }
+
+    public function init_all_dependencies() {
+        new Entity_Type();
+        new Term_Metabox();
+        $jsonld = new Jsonld_Generator( $this->entity_type_service, $this->property_getter );
+        $jsonld->init();
+        $term_save_hook = new Term_Save();
+        $term_save_hook->init();
+        $post_jsonld = new Post_Jsonld();
+        $post_jsonld->init();
+    }
+
+    protected function get_feature_slug() {
+        return 'no-vocabulary-terms';
+    }
+
+    protected function get_feature_default_value() {
+        return false;
+    }
 
 }

Spacing +2 added lines, -2 removed lines

@@ -27,7 +27,7 @@ 
 	 * @param $entity_type_service \Wordlift_Entity_Type_Service
 	 * @param \Wordlift_Property_Getter                         $property_getter
 	 */
-	public function __construct( $entity_type_service, $property_getter ) {
+	public function __construct($entity_type_service, $property_getter) {
 		parent::__construct();
 		$this->entity_type_service = $entity_type_service;
 		$this->property_getter     = $property_getter;
@@ -36,7 +36,7 @@ 
 	public function init_all_dependencies() {
 		new Entity_Type();
 		new Term_Metabox();
-		$jsonld = new Jsonld_Generator( $this->entity_type_service, $this->property_getter );
+		$jsonld = new Jsonld_Generator($this->entity_type_service, $this->property_getter);
 		$jsonld->init();
 		$term_save_hook = new Term_Save();
 		$term_save_hook->init();

src/wordlift/vocabulary-terms/jsonld/class-post-jsonld.php

Indentation +89 added lines, -89 removed lines

@@ -16,94 +16,94 @@
 
 class Post_Jsonld {
 
-	public function init() {
-		add_filter( 'wl_post_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 10, 2 );
-	}
-
-	public function wl_post_jsonld_array( $data, $post_id ) {
-
-		$term_references = $this->get_term_references( $post_id );
-
-		if ( ! $term_references ) {
-			return $data;
-		}
-
-		$references = $data['references'];
-		$jsonld     = $data['jsonld'];
-
-		$jsonld['mentions'] = $this->append_term_mentions( $jsonld, $term_references );
-
-		return array(
-			'jsonld'     => $jsonld,
-			'references' => array_merge( $references, $term_references ),
-		);
-	}
-
-	/**
-	 * @param $post_id
-	 *
-	 * @return array Returns a list of term references, Returns empty array if none found.
-	 */
-	private function get_term_references( $post_id ) {
-
-		/** @var WP_Taxonomy[] $taxonomies_for_post */
-		$taxonomies_for_post = get_object_taxonomies( get_post_type( $post_id ), 'objects' );
-
-		// now we need to collect all terms attached to this post.
-		$terms = array();
-
-		foreach ( $taxonomies_for_post as $taxonomy ) {
-			// Please note that `$taxonomy->publicly_queryable is only WP 4.7+
-			if ( 'wl_entity_type' === $taxonomy->name || ! $taxonomy->public ) {
-				continue;
-			}
-
-			$taxonomy_terms = get_the_terms( $post_id, $taxonomy->name );
-			if ( is_array( $taxonomy_terms ) ) {
-				$terms = array_merge( $terms, $taxonomy_terms );
-			}
-		}
-
-		// Convert everything to the Term Reference.
-		return array_filter(
-			array_map(
-				function ( $term ) {
-					/**
-					 * @var WP_Term $term
-					 */
-					if ( Wordpress_Term_Content_Legacy_Service::get_instance()
-													  ->get_entity_id( Wordpress_Content_Id::create_term( $term->term_id ) )
-					) {
-						  return new Term_Reference( $term->term_id );
-					}
-
-					return false;
-				},
-				$terms
-			)
-		);
-
-	}
-
-	/**
-	 * @param $jsonld array
-	 * @param $term_references array<Term_Reference>
-	 */
-	private function append_term_mentions( $jsonld, $term_references ) {
-
-		$existing_mentions = array_key_exists( 'mentions', $jsonld ) ? $jsonld['mentions'] : array();
-
-		$term_mentions = array_map(
-			function ( $term_reference ) {
-				return array(
-					'@id' => Wordpress_Term_Content_Legacy_Service::get_instance()
-															  ->get_entity_id( Wordpress_Content_Id::create_term( $term_reference->get_id() ) ),
-				);
-			},
-			$term_references
-		);
-
-		return array_merge( $existing_mentions, $term_mentions );
-	}
+    public function init() {
+        add_filter( 'wl_post_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 10, 2 );
+    }
+
+    public function wl_post_jsonld_array( $data, $post_id ) {
+
+        $term_references = $this->get_term_references( $post_id );
+
+        if ( ! $term_references ) {
+            return $data;
+        }
+
+        $references = $data['references'];
+        $jsonld     = $data['jsonld'];
+
+        $jsonld['mentions'] = $this->append_term_mentions( $jsonld, $term_references );
+
+        return array(
+            'jsonld'     => $jsonld,
+            'references' => array_merge( $references, $term_references ),
+        );
+    }
+
+    /**
+     * @param $post_id
+     *
+     * @return array Returns a list of term references, Returns empty array if none found.
+     */
+    private function get_term_references( $post_id ) {
+
+        /** @var WP_Taxonomy[] $taxonomies_for_post */
+        $taxonomies_for_post = get_object_taxonomies( get_post_type( $post_id ), 'objects' );
+
+        // now we need to collect all terms attached to this post.
+        $terms = array();
+
+        foreach ( $taxonomies_for_post as $taxonomy ) {
+            // Please note that `$taxonomy->publicly_queryable is only WP 4.7+
+            if ( 'wl_entity_type' === $taxonomy->name || ! $taxonomy->public ) {
+                continue;
+            }
+
+            $taxonomy_terms = get_the_terms( $post_id, $taxonomy->name );
+            if ( is_array( $taxonomy_terms ) ) {
+                $terms = array_merge( $terms, $taxonomy_terms );
+            }
+        }
+
+        // Convert everything to the Term Reference.
+        return array_filter(
+            array_map(
+                function ( $term ) {
+                    /**
+                     * @var WP_Term $term
+                     */
+                    if ( Wordpress_Term_Content_Legacy_Service::get_instance()
+                                                        ->get_entity_id( Wordpress_Content_Id::create_term( $term->term_id ) )
+                    ) {
+                            return new Term_Reference( $term->term_id );
+                    }
+
+                    return false;
+                },
+                $terms
+            )
+        );
+
+    }
+
+    /**
+     * @param $jsonld array
+     * @param $term_references array<Term_Reference>
+     */
+    private function append_term_mentions( $jsonld, $term_references ) {
+
+        $existing_mentions = array_key_exists( 'mentions', $jsonld ) ? $jsonld['mentions'] : array();
+
+        $term_mentions = array_map(
+            function ( $term_reference ) {
+                return array(
+                    '@id' => Wordpress_Term_Content_Legacy_Service::get_instance()
+                                                                ->get_entity_id( Wordpress_Content_Id::create_term( $term_reference->get_id() ) ),
+                );
+            },
+            $term_references
+        );
+
+        return array_merge( $existing_mentions, $term_mentions );
+    }
 
 }

Spacing +22 added lines, -22 removed lines

@@ -17,25 +17,25 @@ 
 class Post_Jsonld {
 
 	public function init() {
-		add_filter( 'wl_post_jsonld_array', array( $this, 'wl_post_jsonld_array' ), 10, 2 );
+		add_filter('wl_post_jsonld_array', array($this, 'wl_post_jsonld_array'), 10, 2);
 	}
 
-	public function wl_post_jsonld_array( $data, $post_id ) {
+	public function wl_post_jsonld_array($data, $post_id) {
 
-		$term_references = $this->get_term_references( $post_id );
+		$term_references = $this->get_term_references($post_id);
 
-		if ( ! $term_references ) {
+		if ( ! $term_references) {
 			return $data;
 		}
 
 		$references = $data['references'];
 		$jsonld     = $data['jsonld'];
 
-		$jsonld['mentions'] = $this->append_term_mentions( $jsonld, $term_references );
+		$jsonld['mentions'] = $this->append_term_mentions($jsonld, $term_references);
 
 		return array(
 			'jsonld'     => $jsonld,
-			'references' => array_merge( $references, $term_references ),
+			'references' => array_merge($references, $term_references),
 		);
 	}
 
@@ -44,37 +44,37 @@ 
 	 *
 	 * @return array Returns a list of term references, Returns empty array if none found.
 	 */
-	private function get_term_references( $post_id ) {
+	private function get_term_references($post_id) {
 
 		/** @var WP_Taxonomy[] $taxonomies_for_post */
-		$taxonomies_for_post = get_object_taxonomies( get_post_type( $post_id ), 'objects' );
+		$taxonomies_for_post = get_object_taxonomies(get_post_type($post_id), 'objects');
 
 		// now we need to collect all terms attached to this post.
 		$terms = array();
 
-		foreach ( $taxonomies_for_post as $taxonomy ) {
+		foreach ($taxonomies_for_post as $taxonomy) {
 			// Please note that `$taxonomy->publicly_queryable is only WP 4.7+
-			if ( 'wl_entity_type' === $taxonomy->name || ! $taxonomy->public ) {
+			if ('wl_entity_type' === $taxonomy->name || ! $taxonomy->public) {
 				continue;
 			}
 
-			$taxonomy_terms = get_the_terms( $post_id, $taxonomy->name );
-			if ( is_array( $taxonomy_terms ) ) {
-				$terms = array_merge( $terms, $taxonomy_terms );
+			$taxonomy_terms = get_the_terms($post_id, $taxonomy->name);
+			if (is_array($taxonomy_terms)) {
+				$terms = array_merge($terms, $taxonomy_terms);
 			}
 		}
 
 		// Convert everything to the Term Reference.
 		return array_filter(
 			array_map(
-				function ( $term ) {
+				function($term) {
 					/**
 					 * @var WP_Term $term
 					 */
-					if ( Wordpress_Term_Content_Legacy_Service::get_instance()
-													  ->get_entity_id( Wordpress_Content_Id::create_term( $term->term_id ) )
+					if (Wordpress_Term_Content_Legacy_Service::get_instance()
+													  ->get_entity_id(Wordpress_Content_Id::create_term($term->term_id))
 					) {
-						  return new Term_Reference( $term->term_id );
+						  return new Term_Reference($term->term_id);
 					}
 
 					return false;
@@ -89,21 +89,21 @@ 
 	 * @param $jsonld array
 	 * @param $term_references array<Term_Reference>
 	 */
-	private function append_term_mentions( $jsonld, $term_references ) {
+	private function append_term_mentions($jsonld, $term_references) {
 
-		$existing_mentions = array_key_exists( 'mentions', $jsonld ) ? $jsonld['mentions'] : array();
+		$existing_mentions = array_key_exists('mentions', $jsonld) ? $jsonld['mentions'] : array();
 
 		$term_mentions = array_map(
-			function ( $term_reference ) {
+			function($term_reference) {
 				return array(
 					'@id' => Wordpress_Term_Content_Legacy_Service::get_instance()
-															  ->get_entity_id( Wordpress_Content_Id::create_term( $term_reference->get_id() ) ),
+															  ->get_entity_id(Wordpress_Content_Id::create_term($term_reference->get_id())),
 				);
 			},
 			$term_references
 		);
 
-		return array_merge( $existing_mentions, $term_mentions );
+		return array_merge($existing_mentions, $term_mentions);
 	}
 
 }