insideout10 / wordlift-plugin

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

Indentation +182 added lines, -182 removed lines

@@ -16,187 +16,187 @@
  */
 class Wordlift_Attachment_Service {
 
-	/**
-	 * Create a {@link Wordlift_Attachment_Service} instance.
-	 *
-	 * @since 3.20.0
-	 */
-	protected function __construct() {
-
-	}
-
-	private static $instance = null;
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @return \Wordlift_Attachment_Service The singleton instance.
-	 * @since 3.20.0
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get an attachment ID given a URL.
-	 *
-	 * Inspired from https://wpscholar.com/blog/get-attachment-id-from-wp-image-url/
-	 *
-	 * @param string $url The attachment URL.
-	 *
-	 * @return int|false Attachment ID on success, false on failure
-	 * @since 3.10.0
-	 */
-	public function get_attachment_id( $url ) {
-
-		// Get the upload directory data, we need the base URL to check whether
-		// the URL we received is within WP.
-		$dir = wp_upload_dir();
-
-		// Get the filename, the extension is kept.
-		if ( 1 !== preg_match( "@^{$dir['baseurl']}/(.+?)(?:-\d+x\d+)?(\.\w+)$@", $url, $matches ) ) {
-			return false;
-		}
-
-		$filename = $matches[1] . $matches[2];
-
-		// The following query is CPU-intensive, we need to review it.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/689.
-		//
-		// Query for attachments with the specified filename.
-		$query = new WP_Query(
-			array(
-				'post_type'           => 'attachment',
-				'post_status'         => 'inherit',
-				'fields'              => 'ids',
-				'meta_query'          => array(
-					array(
-						'value'   => $filename,
-						'compare' => '=',
-						'key'     => '_wp_attached_file',
-					),
-				),
-				'posts_per_page'      => 1,
-				'ignore_sticky_posts' => true,
-			)
-		);
-
-		// If there are no posts, return.
-		if ( $query->have_posts() ) {
-			return $query->posts[0];
-			// foreach ( $query->posts as $attachment_id ) {
-			//
-			// Get the attachment metadata, we need the filename.
-			// $metadata          = wp_get_attachment_metadata( $attachment_id );
-			// $original_filename = basename( $metadata['file'] );
-			//
-			// Get the cropped filenames, or an empty array in case there are no files.
-			// $sizes_filenames = isset( $metadata['sizes'] ) ? wp_list_pluck( $metadata['sizes'], 'file' ) : array();
-			//
-			// If the provided filename matches the attachment filename (or one of its resized images), return the id.
-			// if ( $original_filename === $filename || in_array( $filename, $sizes_filenames ) ) {
-			// return $attachment_id;
-			// }
-			// }
-		}
-
-		// If we got here, we couldn't find any attachment.
-		return false;
-	}
-
-	/**
-	 * Get images embedded in the post content.
-	 *
-	 * @param string $content The post content.
-	 *
-	 * @return array An array of attachment ids.
-	 * @since 3.10.0
-	 */
-	public function get_image_embeds( $content ) {
-
-		// Go over all the images included in the post content, check if they are
-		// in the DB, and if so include them.
-		$images = array();
-		if ( false === preg_match_all( '#<img [^>]*src="([^\\">]*)"[^>]*>#', $content, $images ) ) {
-			return array();
-		}
-
-		// Map the image URLs to attachment ids.
-		$that = $this;
-		$ids  = array_map(
-			function ( $url ) use ( $that ) {
-				return $that->get_attachment_id( $url );
-			},
-			$images[1]
-		);
-
-		// Filter out not found ids (i.e. id is false).
-		return array_filter(
-			$ids,
-			function ( $item ) {
-				return false !== $item;
-			}
-		);
-	}
-
-	/**
-	 * Get images linked via the `gallery` shortcode.
-	 *
-	 * @param \WP_Post $post A {@link WP_Post} instance.
-	 *
-	 * @return array An array of attachment ids.
-	 * @since 3.10.0
-	 */
-	public function get_gallery( $post ) {
-
-		// @todo: the `gallery` shortcode has an `exclude` attribute which isn't
-		// checked at the moment.
-
-		// Prepare the return value.
-		$ids = array();
-
-		// As the above for images in galleries.
-		// Code inspired by http://wordpress.stackexchange.com/questions/80408/how-to-get-page-post-gallery-attachment-images-in-order-they-are-set-in-backend
-		$pattern = get_shortcode_regex();
-
-		if ( preg_match_all( '/' . $pattern . '/s', $post->post_content, $matches )
-			 && array_key_exists( 2, $matches )
-			 && in_array( 'gallery', $matches[2], true )
-		) {
-
-			$keys = array_keys( $matches[2], 'gallery', true );
-
-			foreach ( $keys as $key ) {
-				$atts = shortcode_parse_atts( $matches[3][ $key ] );
-
-				if ( is_array( $atts ) && array_key_exists( 'ids', $atts ) ) {
-					// gallery images insert explicitly by their ids.
-
-					foreach ( explode( ',', $atts['ids'] ) as $attachment_id ) {
-						// Since we do not check for actual image existence
-						// when generating the json content, check it now.
-						if ( wp_get_attachment_image_src( $attachment_id, 'full' ) ) {
-							$ids[ $attachment_id ] = true;
-						}
-					}
-				} else {
-					// gallery shortcode with no ids uses all the images
-					// attached to the post.
-					$images = get_attached_media( 'image', $post->ID );
-					foreach ( $images as $attachment ) {
-						$ids[ $attachment->ID ] = true;
-					}
-				}
-			}
-		}
-
-		return array_keys( $ids );
-	}
+    /**
+     * Create a {@link Wordlift_Attachment_Service} instance.
+     *
+     * @since 3.20.0
+     */
+    protected function __construct() {
+
+    }
+
+    private static $instance = null;
+
+    /**
+     * Get the singleton instance.
+     *
+     * @return \Wordlift_Attachment_Service The singleton instance.
+     * @since 3.20.0
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Get an attachment ID given a URL.
+     *
+     * Inspired from https://wpscholar.com/blog/get-attachment-id-from-wp-image-url/
+     *
+     * @param string $url The attachment URL.
+     *
+     * @return int|false Attachment ID on success, false on failure
+     * @since 3.10.0
+     */
+    public function get_attachment_id( $url ) {
+
+        // Get the upload directory data, we need the base URL to check whether
+        // the URL we received is within WP.
+        $dir = wp_upload_dir();
+
+        // Get the filename, the extension is kept.
+        if ( 1 !== preg_match( "@^{$dir['baseurl']}/(.+?)(?:-\d+x\d+)?(\.\w+)$@", $url, $matches ) ) {
+            return false;
+        }
+
+        $filename = $matches[1] . $matches[2];
+
+        // The following query is CPU-intensive, we need to review it.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/689.
+        //
+        // Query for attachments with the specified filename.
+        $query = new WP_Query(
+            array(
+                'post_type'           => 'attachment',
+                'post_status'         => 'inherit',
+                'fields'              => 'ids',
+                'meta_query'          => array(
+                    array(
+                        'value'   => $filename,
+                        'compare' => '=',
+                        'key'     => '_wp_attached_file',
+                    ),
+                ),
+                'posts_per_page'      => 1,
+                'ignore_sticky_posts' => true,
+            )
+        );
+
+        // If there are no posts, return.
+        if ( $query->have_posts() ) {
+            return $query->posts[0];
+            // foreach ( $query->posts as $attachment_id ) {
+            //
+            // Get the attachment metadata, we need the filename.
+            // $metadata          = wp_get_attachment_metadata( $attachment_id );
+            // $original_filename = basename( $metadata['file'] );
+            //
+            // Get the cropped filenames, or an empty array in case there are no files.
+            // $sizes_filenames = isset( $metadata['sizes'] ) ? wp_list_pluck( $metadata['sizes'], 'file' ) : array();
+            //
+            // If the provided filename matches the attachment filename (or one of its resized images), return the id.
+            // if ( $original_filename === $filename || in_array( $filename, $sizes_filenames ) ) {
+            // return $attachment_id;
+            // }
+            // }
+        }
+
+        // If we got here, we couldn't find any attachment.
+        return false;
+    }
+
+    /**
+     * Get images embedded in the post content.
+     *
+     * @param string $content The post content.
+     *
+     * @return array An array of attachment ids.
+     * @since 3.10.0
+     */
+    public function get_image_embeds( $content ) {
+
+        // Go over all the images included in the post content, check if they are
+        // in the DB, and if so include them.
+        $images = array();
+        if ( false === preg_match_all( '#<img [^>]*src="([^\\">]*)"[^>]*>#', $content, $images ) ) {
+            return array();
+        }
+
+        // Map the image URLs to attachment ids.
+        $that = $this;
+        $ids  = array_map(
+            function ( $url ) use ( $that ) {
+                return $that->get_attachment_id( $url );
+            },
+            $images[1]
+        );
+
+        // Filter out not found ids (i.e. id is false).
+        return array_filter(
+            $ids,
+            function ( $item ) {
+                return false !== $item;
+            }
+        );
+    }
+
+    /**
+     * Get images linked via the `gallery` shortcode.
+     *
+     * @param \WP_Post $post A {@link WP_Post} instance.
+     *
+     * @return array An array of attachment ids.
+     * @since 3.10.0
+     */
+    public function get_gallery( $post ) {
+
+        // @todo: the `gallery` shortcode has an `exclude` attribute which isn't
+        // checked at the moment.
+
+        // Prepare the return value.
+        $ids = array();
+
+        // As the above for images in galleries.
+        // Code inspired by http://wordpress.stackexchange.com/questions/80408/how-to-get-page-post-gallery-attachment-images-in-order-they-are-set-in-backend
+        $pattern = get_shortcode_regex();
+
+        if ( preg_match_all( '/' . $pattern . '/s', $post->post_content, $matches )
+             && array_key_exists( 2, $matches )
+             && in_array( 'gallery', $matches[2], true )
+        ) {
+
+            $keys = array_keys( $matches[2], 'gallery', true );
+
+            foreach ( $keys as $key ) {
+                $atts = shortcode_parse_atts( $matches[3][ $key ] );
+
+                if ( is_array( $atts ) && array_key_exists( 'ids', $atts ) ) {
+                    // gallery images insert explicitly by their ids.
+
+                    foreach ( explode( ',', $atts['ids'] ) as $attachment_id ) {
+                        // Since we do not check for actual image existence
+                        // when generating the json content, check it now.
+                        if ( wp_get_attachment_image_src( $attachment_id, 'full' ) ) {
+                            $ids[ $attachment_id ] = true;
+                        }
+                    }
+                } else {
+                    // gallery shortcode with no ids uses all the images
+                    // attached to the post.
+                    $images = get_attached_media( 'image', $post->ID );
+                    foreach ( $images as $attachment ) {
+                        $ids[ $attachment->ID ] = true;
+                    }
+                }
+            }
+        }
+
+        return array_keys( $ids );
+    }
 
 }

Spacing +25 added lines, -25 removed lines

@@ -35,7 +35,7 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -52,18 +52,18 @@ 
 	 * @return int|false Attachment ID on success, false on failure
 	 * @since 3.10.0
 	 */
-	public function get_attachment_id( $url ) {
+	public function get_attachment_id($url) {
 
 		// Get the upload directory data, we need the base URL to check whether
 		// the URL we received is within WP.
 		$dir = wp_upload_dir();
 
 		// Get the filename, the extension is kept.
-		if ( 1 !== preg_match( "@^{$dir['baseurl']}/(.+?)(?:-\d+x\d+)?(\.\w+)$@", $url, $matches ) ) {
+		if (1 !== preg_match("@^{$dir['baseurl']}/(.+?)(?:-\d+x\d+)?(\.\w+)$@", $url, $matches)) {
 			return false;
 		}
 
-		$filename = $matches[1] . $matches[2];
+		$filename = $matches[1].$matches[2];
 
 		// The following query is CPU-intensive, we need to review it.
 		//
@@ -88,7 +88,7 @@ 
 		);
 
 		// If there are no posts, return.
-		if ( $query->have_posts() ) {
+		if ($query->have_posts()) {
 			return $query->posts[0];
 			// foreach ( $query->posts as $attachment_id ) {
 			//
@@ -118,20 +118,20 @@ 
 	 * @return array An array of attachment ids.
 	 * @since 3.10.0
 	 */
-	public function get_image_embeds( $content ) {
+	public function get_image_embeds($content) {
 
 		// Go over all the images included in the post content, check if they are
 		// in the DB, and if so include them.
 		$images = array();
-		if ( false === preg_match_all( '#<img [^>]*src="([^\\">]*)"[^>]*>#', $content, $images ) ) {
+		if (false === preg_match_all('#<img [^>]*src="([^\\">]*)"[^>]*>#', $content, $images)) {
 			return array();
 		}
 
 		// Map the image URLs to attachment ids.
 		$that = $this;
 		$ids  = array_map(
-			function ( $url ) use ( $that ) {
-				return $that->get_attachment_id( $url );
+			function($url) use ($that) {
+				return $that->get_attachment_id($url);
 			},
 			$images[1]
 		);
@@ -139,7 +139,7 @@ 
 		// Filter out not found ids (i.e. id is false).
 		return array_filter(
 			$ids,
-			function ( $item ) {
+			function($item) {
 				return false !== $item;
 			}
 		);
@@ -153,7 +153,7 @@ 
 	 * @return array An array of attachment ids.
 	 * @since 3.10.0
 	 */
-	public function get_gallery( $post ) {
+	public function get_gallery($post) {
 
 		// @todo: the `gallery` shortcode has an `exclude` attribute which isn't
 		// checked at the moment.
@@ -165,38 +165,38 @@ 
 		// Code inspired by http://wordpress.stackexchange.com/questions/80408/how-to-get-page-post-gallery-attachment-images-in-order-they-are-set-in-backend
 		$pattern = get_shortcode_regex();
 
-		if ( preg_match_all( '/' . $pattern . '/s', $post->post_content, $matches )
-			 && array_key_exists( 2, $matches )
-			 && in_array( 'gallery', $matches[2], true )
+		if (preg_match_all('/'.$pattern.'/s', $post->post_content, $matches)
+			 && array_key_exists(2, $matches)
+			 && in_array('gallery', $matches[2], true)
 		) {
 
-			$keys = array_keys( $matches[2], 'gallery', true );
+			$keys = array_keys($matches[2], 'gallery', true);
 
-			foreach ( $keys as $key ) {
-				$atts = shortcode_parse_atts( $matches[3][ $key ] );
+			foreach ($keys as $key) {
+				$atts = shortcode_parse_atts($matches[3][$key]);
 
-				if ( is_array( $atts ) && array_key_exists( 'ids', $atts ) ) {
+				if (is_array($atts) && array_key_exists('ids', $atts)) {
 					// gallery images insert explicitly by their ids.
 
-					foreach ( explode( ',', $atts['ids'] ) as $attachment_id ) {
+					foreach (explode(',', $atts['ids']) as $attachment_id) {
 						// Since we do not check for actual image existence
 						// when generating the json content, check it now.
-						if ( wp_get_attachment_image_src( $attachment_id, 'full' ) ) {
-							$ids[ $attachment_id ] = true;
+						if (wp_get_attachment_image_src($attachment_id, 'full')) {
+							$ids[$attachment_id] = true;
 						}
 					}
 				} else {
 					// gallery shortcode with no ids uses all the images
 					// attached to the post.
-					$images = get_attached_media( 'image', $post->ID );
-					foreach ( $images as $attachment ) {
-						$ids[ $attachment->ID ] = true;
+					$images = get_attached_media('image', $post->ID);
+					foreach ($images as $attachment) {
+						$ids[$attachment->ID] = true;
 					}
 				}
 			}
 		}
 
-		return array_keys( $ids );
+		return array_keys($ids);
 	}
 
 }

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

Indentation +264 added lines, -264 removed lines

@@ -17,274 +17,274 @@
  */
 class Wordlift_Jsonld_Service {
 
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Term_JsonLd_Adapter} instance.
-	 *
-	 * @since  3.32.0
-	 * @access private
-	 * @var Wordlift_Term_JsonLd_Adapter $entity_service A {@link Wordlift_Term_JsonLd_Adapter} instance.
-	 */
-	private $term_jsonld_adapter;
-
-	/**
-	 * A {@link Wordlift_Post_Converter} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance.
-	 */
-	private $converter;
-
-	/**
-	 * A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 */
-	private $website_converter;
-
-	/**
-	 * The singleton instance for the JSON-LD service.
-	 *
-	 * @since 3.15.1
-	 *
-	 * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a JSON-LD service.
-	 *
-	 * @param \Wordlift_Entity_Service           $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Post_Converter           $converter A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
-	 * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 * @param \Wordlift_Term_JsonLd_Adapter      $term_jsonld_adapter
-	 *
-	 * @since 3.8.0
-	 */
-	public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) {
-
-		$this->entity_service      = $entity_service;
-		$this->converter           = $converter;
-		$this->website_converter   = $website_converter;
-		$this->term_jsonld_adapter = $term_jsonld_adapter;
-		self::$instance            = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance for the JSON-LD service.
-	 *
-	 * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
-	 * @since 3.15.1
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Process calls to the AJAX 'wl_jsonld' endpoint.
-	 *
-	 * @since 3.8.0
-	 */
-	public function get() {
-		// Clear the buffer to be sure someone doesn't mess with our response.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/406.
-		// See https://codex.wordpress.org/AJAX_in_Plugins.
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Term_JsonLd_Adapter} instance.
+     *
+     * @since  3.32.0
+     * @access private
+     * @var Wordlift_Term_JsonLd_Adapter $entity_service A {@link Wordlift_Term_JsonLd_Adapter} instance.
+     */
+    private $term_jsonld_adapter;
+
+    /**
+     * A {@link Wordlift_Post_Converter} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance.
+     */
+    private $converter;
+
+    /**
+     * A {@link Wordlift_Website_Jsonld_Converter} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance.
+     */
+    private $website_converter;
+
+    /**
+     * The singleton instance for the JSON-LD service.
+     *
+     * @since 3.15.1
+     *
+     * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service.
+     */
+    private static $instance;
+
+    /**
+     * Create a JSON-LD service.
+     *
+     * @param \Wordlift_Entity_Service           $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Post_Converter           $converter A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
+     * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
+     * @param \Wordlift_Term_JsonLd_Adapter      $term_jsonld_adapter
+     *
+     * @since 3.8.0
+     */
+    public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) {
+
+        $this->entity_service      = $entity_service;
+        $this->converter           = $converter;
+        $this->website_converter   = $website_converter;
+        $this->term_jsonld_adapter = $term_jsonld_adapter;
+        self::$instance            = $this;
+
+    }
+
+    /**
+     * Get the singleton instance for the JSON-LD service.
+     *
+     * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
+     * @since 3.15.1
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Process calls to the AJAX 'wl_jsonld' endpoint.
+     *
+     * @since 3.8.0
+     */
+    public function get() {
+        // Clear the buffer to be sure someone doesn't mess with our response.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/406.
+        // See https://codex.wordpress.org/AJAX_in_Plugins.
         // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@ob_clean();
-
-		// Get the parameter from the request.
-		$is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-
-		// Send the generated JSON-LD.
-		$this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) );
-
-	}
-
-	/**
-	 * A close of WP's own `wp_send_json` function which uses `application/ld+json` as content type.
-	 *
-	 * @param mixed $response Variable (usually an array or object) to encode as JSON,
-	 *                           then print and die.
-	 *
-	 * @since 3.18.5
-	 */
-	private function send_jsonld( $response ) {
+        @ob_clean();
+
+        // Get the parameter from the request.
+        $is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+        // Send the generated JSON-LD.
+        $this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) );
+
+    }
+
+    /**
+     * A close of WP's own `wp_send_json` function which uses `application/ld+json` as content type.
+     *
+     * @param mixed $response Variable (usually an array or object) to encode as JSON,
+     *                           then print and die.
+     *
+     * @since 3.18.5
+     */
+    private function send_jsonld( $response ) {
         // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) );
-		echo wp_json_encode( $response );
-		if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
-			wp_die();
-		} else {
-			die;
-		}
-	}
-
-	/**
-	 * Get the JSON-LD.
-	 *
-	 * @param bool     $is_homepage Whether the JSON-LD for the homepage is being requested.
-	 * @param int|null $post_id The JSON-LD for the specified {@link WP_Post} id.
-	 * @param int      $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
-	 *
-	 * @return array A JSON-LD structure.
-	 * @since 3.15.1
-	 */
-	public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) {
-
-		// Tell NewRelic to ignore us, otherwise NewRelic customers might receive
-		// e-mails with a low apdex score.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/521
-		Wordlift_NewRelic_Adapter::ignore_apdex();
-
-		// Switch to Website converter if is home page.
-		if ( $is_homepage ) {
-			/**
-			 * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
-			 *
-			 * @since  3.14.0
-			 * @api    bool $display_search Whether or not to display json+ld search on the frontend.
-			 */
-			if ( apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
-				return array();
-			}
-
-			// Set a reference to the website_converter.
-			$website_converter = $this->website_converter;
-
-			// Send JSON-LD.
-			return $website_converter->create_schema();
-		}
-
-		// If no id has been provided return an empty array.
-		if ( ! isset( $post_id ) ) {
-			return array();
-		}
-
-		// An array of references which is captured when converting an URI to a
-		// json which we gather to further expand our json-ld.
-		$references       = array();
-		$references_infos = array();
-
-		// Set a reference to the entity_to_jsonld_converter to use in the closures.
-		$entity_to_jsonld_converter = $this->converter;
-
-		$jsonld = array( $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos ) );
-
-		$that                       = $this;
-		$expanded_references_jsonld = array_map(
-			function ( $item ) use ( $context, $entity_to_jsonld_converter, &$references_infos, $that ) {
-				// "2nd level properties" may not output here, e.g. a post
-				// mentioning an event, located in a place: the place is referenced
-				// via the `@id` but no other properties are loaded.
-				$ignored = array();
-				if ( $item instanceof Term_Reference ) {
+        @header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) );
+        echo wp_json_encode( $response );
+        if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
+            wp_die();
+        } else {
+            die;
+        }
+    }
+
+    /**
+     * Get the JSON-LD.
+     *
+     * @param bool     $is_homepage Whether the JSON-LD for the homepage is being requested.
+     * @param int|null $post_id The JSON-LD for the specified {@link WP_Post} id.
+     * @param int      $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
+     *
+     * @return array A JSON-LD structure.
+     * @since 3.15.1
+     */
+    public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) {
+
+        // Tell NewRelic to ignore us, otherwise NewRelic customers might receive
+        // e-mails with a low apdex score.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/521
+        Wordlift_NewRelic_Adapter::ignore_apdex();
+
+        // Switch to Website converter if is home page.
+        if ( $is_homepage ) {
+            /**
+             * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
+             *
+             * @since  3.14.0
+             * @api    bool $display_search Whether or not to display json+ld search on the frontend.
+             */
+            if ( apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
+                return array();
+            }
+
+            // Set a reference to the website_converter.
+            $website_converter = $this->website_converter;
+
+            // Send JSON-LD.
+            return $website_converter->create_schema();
+        }
+
+        // If no id has been provided return an empty array.
+        if ( ! isset( $post_id ) ) {
+            return array();
+        }
+
+        // An array of references which is captured when converting an URI to a
+        // json which we gather to further expand our json-ld.
+        $references       = array();
+        $references_infos = array();
+
+        // Set a reference to the entity_to_jsonld_converter to use in the closures.
+        $entity_to_jsonld_converter = $this->converter;
+
+        $jsonld = array( $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos ) );
+
+        $that                       = $this;
+        $expanded_references_jsonld = array_map(
+            function ( $item ) use ( $context, $entity_to_jsonld_converter, &$references_infos, $that ) {
+                // "2nd level properties" may not output here, e.g. a post
+                // mentioning an event, located in a place: the place is referenced
+                // via the `@id` but no other properties are loaded.
+                $ignored = array();
+                if ( $item instanceof Term_Reference ) {
                     // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-					  $term_jsonld = $that->term_jsonld_adapter->get( $item->get_id(), $context );
-
-					  // For term references, we publish a jsonld array on the page, use only the first item.
-					  return count( $term_jsonld ) > 0 ? $term_jsonld[0] : false;
-				} elseif ( $item instanceof Post_Reference ) {
-					$item = $item->get_id();
-				}
-
-				// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-				return $entity_to_jsonld_converter->convert( $item, $ignored, $references_infos );
-			},
-			array_unique( $references )
-		);
-
-		// Convert each URI to a JSON-LD array, while gathering referenced entities.
-		// in the references array.
-		$jsonld = array_merge(
-			$jsonld,
-			// Convert each URI in the references array to JSON-LD. We don't output
-			// entities already output above (hence the array_diff).
-			array_filter( $expanded_references_jsonld )
-		);
-
-		$required_references = array_filter(
-			$references_infos,
-			function ( $item ) use ( $references ) {
-
-				return isset( $item['reference'] ) &&
-				   // Check that the reference is required
-				   $item['reference']->get_required() &&
-				   // Check that the reference isn't being output already.
-				   ! in_array( $item['reference']->get_id(), $references, true );
-			}
-		);
-
-		$jsonld = array_merge(
-			$jsonld,
-			array_filter(
-				array_map(
-					function ( $item ) use ( $references, $entity_to_jsonld_converter ) {
-
-						if ( ! isset( $item['reference'] ) ) {
-							  return null;
-						}
-
-						$post_id = $item['reference']->get_id();
-						if ( in_array( $post_id, $references, true ) ) {
-							return null;
-						}
-
-						$references[] = $post_id;
-
-						return $entity_to_jsonld_converter->convert( $post_id, $references );
-					},
-					$required_references
-				)
-			)
-		);
-
-		/**
-		 * Filter name: wl_after_get_jsonld
-		 *
-		 * @return array
-		 * @since 3.27.2
-		 * @var $jsonld array The final jsonld before outputting to page.
-		 * @var $post_id int The post id for which the jsonld is generated.
-		 */
-		$jsonld = apply_filters( 'wl_after_get_jsonld', $jsonld, $post_id, $context );
-
-		return $jsonld;
-	}
-
-	/**
-	 * Write the JSON-LD in the head.
-	 *
-	 * This function isn't actually used, but may be used to quickly enable writing the JSON-LD synchronously to the
-	 * document head, using the `wp_head` hook.
-	 *
-	 * @since 3.18.5
-	 */
-	public function wp_head() {
-
-		// Determine whether this is the home page or whether we're displaying a single post.
-		$is_homepage = is_home() || is_front_page();
-		$post_id     = is_singular() ? get_the_ID() : null;
-
-		$jsonld = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) );
-		?>
+                        $term_jsonld = $that->term_jsonld_adapter->get( $item->get_id(), $context );
+
+                        // For term references, we publish a jsonld array on the page, use only the first item.
+                        return count( $term_jsonld ) > 0 ? $term_jsonld[0] : false;
+                } elseif ( $item instanceof Post_Reference ) {
+                    $item = $item->get_id();
+                }
+
+                // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                return $entity_to_jsonld_converter->convert( $item, $ignored, $references_infos );
+            },
+            array_unique( $references )
+        );
+
+        // Convert each URI to a JSON-LD array, while gathering referenced entities.
+        // in the references array.
+        $jsonld = array_merge(
+            $jsonld,
+            // Convert each URI in the references array to JSON-LD. We don't output
+            // entities already output above (hence the array_diff).
+            array_filter( $expanded_references_jsonld )
+        );
+
+        $required_references = array_filter(
+            $references_infos,
+            function ( $item ) use ( $references ) {
+
+                return isset( $item['reference'] ) &&
+                   // Check that the reference is required
+                   $item['reference']->get_required() &&
+                   // Check that the reference isn't being output already.
+                   ! in_array( $item['reference']->get_id(), $references, true );
+            }
+        );
+
+        $jsonld = array_merge(
+            $jsonld,
+            array_filter(
+                array_map(
+                    function ( $item ) use ( $references, $entity_to_jsonld_converter ) {
+
+                        if ( ! isset( $item['reference'] ) ) {
+                                return null;
+                        }
+
+                        $post_id = $item['reference']->get_id();
+                        if ( in_array( $post_id, $references, true ) ) {
+                            return null;
+                        }
+
+                        $references[] = $post_id;
+
+                        return $entity_to_jsonld_converter->convert( $post_id, $references );
+                    },
+                    $required_references
+                )
+            )
+        );
+
+        /**
+         * Filter name: wl_after_get_jsonld
+         *
+         * @return array
+         * @since 3.27.2
+         * @var $jsonld array The final jsonld before outputting to page.
+         * @var $post_id int The post id for which the jsonld is generated.
+         */
+        $jsonld = apply_filters( 'wl_after_get_jsonld', $jsonld, $post_id, $context );
+
+        return $jsonld;
+    }
+
+    /**
+     * Write the JSON-LD in the head.
+     *
+     * This function isn't actually used, but may be used to quickly enable writing the JSON-LD synchronously to the
+     * document head, using the `wp_head` hook.
+     *
+     * @since 3.18.5
+     */
+    public function wp_head() {
+
+        // Determine whether this is the home page or whether we're displaying a single post.
+        $is_homepage = is_home() || is_front_page();
+        $post_id     = is_singular() ? get_the_ID() : null;
+
+        $jsonld = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) );
+        ?>
 		<script type="application/ld+json"><?php echo esc_html( $jsonld ); ?></script>
 													  <?php
-	}
+    }
 
 }

Spacing +31 added lines, -31 removed lines

@@ -72,7 +72,7 @@ 
 	 *
 	 * @since 3.8.0
 	 */
-	public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) {
+	public function __construct($entity_service, $converter, $website_converter, $term_jsonld_adapter) {
 
 		$this->entity_service      = $entity_service;
 		$this->converter           = $converter;
@@ -107,11 +107,11 @@ 
 		@ob_clean();
 
 		// Get the parameter from the request.
-		$is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$is_homepage = isset($_REQUEST['homepage']); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$post_id     = isset($_REQUEST['id']) && is_numeric($_REQUEST['id']) ? intval($_REQUEST['id']) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
 		// Send the generated JSON-LD.
-		$this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) );
+		$this->send_jsonld($this->get_jsonld($is_homepage, $post_id));
 
 	}
 
@@ -123,11 +123,11 @@ 
 	 *
 	 * @since 3.18.5
 	 */
-	private function send_jsonld( $response ) {
+	private function send_jsonld($response) {
         // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) );
-		echo wp_json_encode( $response );
-		if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
+		@header('Content-Type: application/ld+json; charset='.get_option('blog_charset'));
+		echo wp_json_encode($response);
+		if (apply_filters('wp_doing_ajax', defined('DOING_AJAX') && DOING_AJAX)) {
 			wp_die();
 		} else {
 			die;
@@ -144,7 +144,7 @@ 
 	 * @return array A JSON-LD structure.
 	 * @since 3.15.1
 	 */
-	public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) {
+	public function get_jsonld($is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN) {
 
 		// Tell NewRelic to ignore us, otherwise NewRelic customers might receive
 		// e-mails with a low apdex score.
@@ -153,14 +153,14 @@ 
 		Wordlift_NewRelic_Adapter::ignore_apdex();
 
 		// Switch to Website converter if is home page.
-		if ( $is_homepage ) {
+		if ($is_homepage) {
 			/**
 			 * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
 			 *
 			 * @since  3.14.0
 			 * @api    bool $display_search Whether or not to display json+ld search on the frontend.
 			 */
-			if ( apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
+			if (apply_filters('wordlift_disable_website_json_ld', false)) {
 				return array();
 			}
 
@@ -172,7 +172,7 @@ 
 		}
 
 		// If no id has been provided return an empty array.
-		if ( ! isset( $post_id ) ) {
+		if ( ! isset($post_id)) {
 			return array();
 		}
 
@@ -184,29 +184,29 @@ 
 		// Set a reference to the entity_to_jsonld_converter to use in the closures.
 		$entity_to_jsonld_converter = $this->converter;
 
-		$jsonld = array( $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos ) );
+		$jsonld = array($entity_to_jsonld_converter->convert($post_id, $references, $references_infos));
 
 		$that                       = $this;
 		$expanded_references_jsonld = array_map(
-			function ( $item ) use ( $context, $entity_to_jsonld_converter, &$references_infos, $that ) {
+			function($item) use ($context, $entity_to_jsonld_converter, &$references_infos, $that) {
 				// "2nd level properties" may not output here, e.g. a post
 				// mentioning an event, located in a place: the place is referenced
 				// via the `@id` but no other properties are loaded.
 				$ignored = array();
-				if ( $item instanceof Term_Reference ) {
+				if ($item instanceof Term_Reference) {
                     // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-					  $term_jsonld = $that->term_jsonld_adapter->get( $item->get_id(), $context );
+					  $term_jsonld = $that->term_jsonld_adapter->get($item->get_id(), $context);
 
 					  // For term references, we publish a jsonld array on the page, use only the first item.
-					  return count( $term_jsonld ) > 0 ? $term_jsonld[0] : false;
-				} elseif ( $item instanceof Post_Reference ) {
+					  return count($term_jsonld) > 0 ? $term_jsonld[0] : false;
+				} elseif ($item instanceof Post_Reference) {
 					$item = $item->get_id();
 				}
 
 				// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-				return $entity_to_jsonld_converter->convert( $item, $ignored, $references_infos );
+				return $entity_to_jsonld_converter->convert($item, $ignored, $references_infos);
 			},
-			array_unique( $references )
+			array_unique($references)
 		);
 
 		// Convert each URI to a JSON-LD array, while gathering referenced entities.
@@ -215,18 +215,18 @@ 
 			$jsonld,
 			// Convert each URI in the references array to JSON-LD. We don't output
 			// entities already output above (hence the array_diff).
-			array_filter( $expanded_references_jsonld )
+			array_filter($expanded_references_jsonld)
 		);
 
 		$required_references = array_filter(
 			$references_infos,
-			function ( $item ) use ( $references ) {
+			function($item) use ($references) {
 
-				return isset( $item['reference'] ) &&
+				return isset($item['reference']) &&
 				   // Check that the reference is required
 				   $item['reference']->get_required() &&
 				   // Check that the reference isn't being output already.
-				   ! in_array( $item['reference']->get_id(), $references, true );
+				   ! in_array($item['reference']->get_id(), $references, true);
 			}
 		);
 
@@ -234,20 +234,20 @@ 
 			$jsonld,
 			array_filter(
 				array_map(
-					function ( $item ) use ( $references, $entity_to_jsonld_converter ) {
+					function($item) use ($references, $entity_to_jsonld_converter) {
 
-						if ( ! isset( $item['reference'] ) ) {
+						if ( ! isset($item['reference'])) {
 							  return null;
 						}
 
 						$post_id = $item['reference']->get_id();
-						if ( in_array( $post_id, $references, true ) ) {
+						if (in_array($post_id, $references, true)) {
 							return null;
 						}
 
 						$references[] = $post_id;
 
-						return $entity_to_jsonld_converter->convert( $post_id, $references );
+						return $entity_to_jsonld_converter->convert($post_id, $references);
 					},
 					$required_references
 				)
@@ -262,7 +262,7 @@ 
 		 * @var $jsonld array The final jsonld before outputting to page.
 		 * @var $post_id int The post id for which the jsonld is generated.
 		 */
-		$jsonld = apply_filters( 'wl_after_get_jsonld', $jsonld, $post_id, $context );
+		$jsonld = apply_filters('wl_after_get_jsonld', $jsonld, $post_id, $context);
 
 		return $jsonld;
 	}
@@ -281,9 +281,9 @@ 
 		$is_homepage = is_home() || is_front_page();
 		$post_id     = is_singular() ? get_the_ID() : null;
 
-		$jsonld = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) );
+		$jsonld = wp_json_encode($this->get_jsonld($is_homepage, $post_id, Jsonld_Context_Enum::PAGE));
 		?>
-		<script type="application/ld+json"><?php echo esc_html( $jsonld ); ?></script>
+		<script type="application/ld+json"><?php echo esc_html($jsonld); ?></script>
 													  <?php
 	}
 

src/includes/class-wordlift-abstract-post-to-jsonld-converter.php

Indentation +395 added lines, -395 removed lines

@@ -23,421 +23,421 @@
  */
 abstract class Wordlift_Abstract_Post_To_Jsonld_Converter implements Wordlift_Post_Converter {
 
-	/**
-	 * The JSON-LD context.
-	 *
-	 * @since 3.10.0
-	 */
-	const CONTEXT = 'http://schema.org';
-
-	/**
-	 * A {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access protected
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	protected $entity_type_service;
-
-	/**
-	 * A {@link Wordlift_User_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
-	 */
-	protected $user_service;
-
-	/**
-	 * A {@link Wordlift_Attachment_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 */
-	protected $attachment_service;
-
-	/**
-	 * @var Wordlift_Property_Getter
-	 */
-	private $property_getter;
-
-	/**
-	 * Wordlift_Post_To_Jsonld_Converter constructor.
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 * @param \Wordlift_User_Service        $user_service A {@link Wordlift_User_Service} instance.
-	 * @param \Wordlift_Attachment_Service  $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 * @param \Wordlift_Property_Getter     $property_getter
-	 *
-	 * @since 3.10.0
-	 */
-	public function __construct( $entity_type_service, $user_service, $attachment_service, $property_getter ) {
-		$this->entity_type_service = $entity_type_service;
-		$this->user_service        = $user_service;
-		$this->attachment_service  = $attachment_service;
-		$this->property_getter     = $property_getter;
-	}
-
-	/**
-	 * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
-	 * found while processing the post is set in the $references array.
-	 *
-	 * @param int   $post_id The post id.
-	 * @param array $references An array of entity references.
-	 * @param array $references_infos
-	 *
-	 * @return array A JSON-LD array.
-	 * @since 3.10.0
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
-
-		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
-			// Post not found.
-			return null;
-		}
-
-		// Get the post URI @id.
-		$id = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
-		if ( $id === null ) {
-			$id = 'get_uri returned null, dataset is ' . wl_configuration_get_redlink_dataset_uri();
-		}
-
-		/*
+    /**
+     * The JSON-LD context.
+     *
+     * @since 3.10.0
+     */
+    const CONTEXT = 'http://schema.org';
+
+    /**
+     * A {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since  3.10.0
+     * @access protected
+     * @var \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     */
+    protected $entity_type_service;
+
+    /**
+     * A {@link Wordlift_User_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
+     */
+    protected $user_service;
+
+    /**
+     * A {@link Wordlift_Attachment_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     */
+    protected $attachment_service;
+
+    /**
+     * @var Wordlift_Property_Getter
+     */
+    private $property_getter;
+
+    /**
+     * Wordlift_Post_To_Jsonld_Converter constructor.
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     * @param \Wordlift_User_Service        $user_service A {@link Wordlift_User_Service} instance.
+     * @param \Wordlift_Attachment_Service  $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     * @param \Wordlift_Property_Getter     $property_getter
+     *
+     * @since 3.10.0
+     */
+    public function __construct( $entity_type_service, $user_service, $attachment_service, $property_getter ) {
+        $this->entity_type_service = $entity_type_service;
+        $this->user_service        = $user_service;
+        $this->attachment_service  = $attachment_service;
+        $this->property_getter     = $property_getter;
+    }
+
+    /**
+     * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
+     * found while processing the post is set in the $references array.
+     *
+     * @param int   $post_id The post id.
+     * @param array $references An array of entity references.
+     * @param array $references_infos
+     *
+     * @return array A JSON-LD array.
+     * @since 3.10.0
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
+
+        // Get the post instance.
+        $post = get_post( $post_id );
+        if ( null === $post ) {
+            // Post not found.
+            return null;
+        }
+
+        // Get the post URI @id.
+        $id = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
+        if ( $id === null ) {
+            $id = 'get_uri returned null, dataset is ' . wl_configuration_get_redlink_dataset_uri();
+        }
+
+        /*
 		 * The `types` variable holds one or more entity types. The `type` variable isn't used anymore.
 		 *
 		 * @since 3.20.0 We support more than one entity type.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 */
-		// Get the entity @type. We consider `post` BlogPostings.
-		// $type = $this->entity_type_service->get( $post_id );
-		$types = $this->entity_type_service->get_names( $post_id );
-		$type  = self::make_one( $types );
-
-		// Prepare the response.
-		$jsonld = array(
-			'@context'    => self::CONTEXT,
-			'@id'         => $id,
-			'@type'       => $type,
-			'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ),
-		);
-
-		// Set the `mainEntityOfPage` property if the post has some contents.
-		/*
+        // Get the entity @type. We consider `post` BlogPostings.
+        // $type = $this->entity_type_service->get( $post_id );
+        $types = $this->entity_type_service->get_names( $post_id );
+        $type  = self::make_one( $types );
+
+        // Prepare the response.
+        $jsonld = array(
+            '@context'    => self::CONTEXT,
+            '@id'         => $id,
+            '@type'       => $type,
+            'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ),
+        );
+
+        // Set the `mainEntityOfPage` property if the post has some contents.
+        /*
 		 * Apply the `wl_post_content` filter, in case 3rd parties want to change the post content, e.g.
 		 * because the content is written elsewhere.
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		if ( ! empty( $post_content ) ) {
-			// We're setting the `mainEntityOfPage` to signal which one is the
-			// main entity for the specified URL. It might be however that the
-			// post/page is actually about another specific entity. How WL deals
-			// with that hasn't been defined yet (see https://github.com/insideout10/wordlift-plugin/issues/451).
-			//
-			// See http://schema.org/mainEntityOfPage
-			//
-			// No need to specify `'@type' => 'WebPage'.
-			//
-			// See https://github.com/insideout10/wordlift-plugin/issues/451.
-			$jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
-
-			/**
-			 * @see https://github.com/insideout10/wordlift-plugin/issues/1207
-			 *
-			 * @since 3.27.7
-			 */
-			if ( in_array( $type, array( 'Occupation', 'OccupationAggregationByEmployer' ), true ) ) {
-				$jsonld['mainEntityOfPage'] = array(
-					'@type'        => 'WebPage',
-					'lastReviewed' => get_post_time( 'Y-m-d\TH:i:sP', true, $post, false ),
-				);
-			}
-		};
-
-		$this->set_images( $this->attachment_service, $post, $jsonld );
-
-		// Get the entities referenced by this post and set it to the `references`
-		// array so that the caller can do further processing, such as printing out
-		// more of those references.
-		$references_without_locations = Object_Relation_Service::get_instance()
-															   ->get_references( $post_id, Object_Type_Enum::POST );
-
-		/*
+        $post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
+        if ( ! empty( $post_content ) ) {
+            // We're setting the `mainEntityOfPage` to signal which one is the
+            // main entity for the specified URL. It might be however that the
+            // post/page is actually about another specific entity. How WL deals
+            // with that hasn't been defined yet (see https://github.com/insideout10/wordlift-plugin/issues/451).
+            //
+            // See http://schema.org/mainEntityOfPage
+            //
+            // No need to specify `'@type' => 'WebPage'.
+            //
+            // See https://github.com/insideout10/wordlift-plugin/issues/451.
+            $jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
+
+            /**
+             * @see https://github.com/insideout10/wordlift-plugin/issues/1207
+             *
+             * @since 3.27.7
+             */
+            if ( in_array( $type, array( 'Occupation', 'OccupationAggregationByEmployer' ), true ) ) {
+                $jsonld['mainEntityOfPage'] = array(
+                    '@type'        => 'WebPage',
+                    'lastReviewed' => get_post_time( 'Y-m-d\TH:i:sP', true, $post, false ),
+                );
+            }
+        };
+
+        $this->set_images( $this->attachment_service, $post, $jsonld );
+
+        // Get the entities referenced by this post and set it to the `references`
+        // array so that the caller can do further processing, such as printing out
+        // more of those references.
+        $references_without_locations = Object_Relation_Service::get_instance()
+                                                                ->get_references( $post_id, Object_Type_Enum::POST );
+
+        /*
 		 * Add the locations to the references.
 		 *
 		 * @since 3.19.5
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/858.
 		 */
-		// A reference to use in closure.
-		$entity_type_service = $this->entity_type_service;
-		$locations           = array_reduce(
-			$references_without_locations,
-			function ( $carry, $reference ) use ( $entity_type_service ) {
-				/**
-				 * @var $reference Reference
-				 */
-				// @see https://schema.org/location for the schema.org types using the `location` property.
-				if ( ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Action' )
-				 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Event' )
-				 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Organization' ) ) {
-
-					return $carry;
-				}
-				$post_location_ids        = get_post_meta( $reference->get_id(), Wordlift_Schema_Service::FIELD_LOCATION );
-				$post_location_references = array_map(
-					function ( $post_id ) {
-						return new Post_Reference( $post_id );
-					},
-					$post_location_ids
-				);
-
-				return array_merge( $carry, $post_location_references );
-			},
-			array()
-		);
-
-		// Merge the references with the referenced locations if any.
-		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$references = array_merge( $references_without_locations, $locations );
-
-		return $jsonld;
-	}
-
-	/**
-	 * If the provided value starts with the schema.org context, we remove the schema.org
-	 * part since it is set with the '@context'.
-	 *
-	 * @param string $value The property value.
-	 *
-	 * @return string The property value without the context.
-	 * @since 3.10.0
-	 */
-	public function relative_to_context( $value ) {
-
-		return 0 === strpos( $value, self::CONTEXT . '/' ) ? substr( $value, strlen( self::CONTEXT ) + 1 ) : $value;
-	}
-
-	/**
-	 * Set the images, by looking for embedded images, for images loaded via the
-	 * gallery and for the featured image.
-	 *
-	 * Uses the cache service to store the results of this function for a day.
-	 *
-	 * @param $attachment_service Wordlift_Attachment_Service
-	 * @param WP_Post                                        $post The target {@link WP_Post}.
-	 * @param array                                          $jsonld The JSON-LD array.
-	 *
-	 * @since 3.10.0
-	 */
-	public static function set_images( $attachment_service, $post, &$jsonld ) {
-
-		// Prepare the attachment ids array.
-		$ids = array();
-
-		// Set the thumbnail id as first attachment id, if any.
-		$thumbnail_id = get_post_thumbnail_id( $post->ID );
-		if ( '' !== $thumbnail_id && 0 !== $thumbnail_id ) {
-			$ids[] = $thumbnail_id;
-		}
-
-		// For the time being the following is being removed since the query
-		// initiated by `get_image_embeds` is consuming lots of CPU.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/689.
-		//
-		// Get the embeds, removing existing ids.
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( apply_filters( 'wl_feature__enable__image-embeds', false ) ) {
-			$embeds = array_diff( $attachment_service->get_image_embeds( $post->post_content ), $ids );
-		} else {
-			$embeds = array();
-		}
-
-		// Get the gallery, removing existing ids.
-		$gallery = array_diff( $attachment_service->get_gallery( $post ), $ids, $embeds );
-
-		// Map the attachment ids to images' data structured for schema.org use.
-		$images_with_sizes = array_filter(
-			array_reduce(
-				array_merge( $ids, $embeds, $gallery ),
-				function ( $carry, $item ) {
-					/*
+        // A reference to use in closure.
+        $entity_type_service = $this->entity_type_service;
+        $locations           = array_reduce(
+            $references_without_locations,
+            function ( $carry, $reference ) use ( $entity_type_service ) {
+                /**
+                 * @var $reference Reference
+                 */
+                // @see https://schema.org/location for the schema.org types using the `location` property.
+                if ( ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Action' )
+                 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Event' )
+                 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Organization' ) ) {
+
+                    return $carry;
+                }
+                $post_location_ids        = get_post_meta( $reference->get_id(), Wordlift_Schema_Service::FIELD_LOCATION );
+                $post_location_references = array_map(
+                    function ( $post_id ) {
+                        return new Post_Reference( $post_id );
+                    },
+                    $post_location_ids
+                );
+
+                return array_merge( $carry, $post_location_references );
+            },
+            array()
+        );
+
+        // Merge the references with the referenced locations if any.
+        // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+        $references = array_merge( $references_without_locations, $locations );
+
+        return $jsonld;
+    }
+
+    /**
+     * If the provided value starts with the schema.org context, we remove the schema.org
+     * part since it is set with the '@context'.
+     *
+     * @param string $value The property value.
+     *
+     * @return string The property value without the context.
+     * @since 3.10.0
+     */
+    public function relative_to_context( $value ) {
+
+        return 0 === strpos( $value, self::CONTEXT . '/' ) ? substr( $value, strlen( self::CONTEXT ) + 1 ) : $value;
+    }
+
+    /**
+     * Set the images, by looking for embedded images, for images loaded via the
+     * gallery and for the featured image.
+     *
+     * Uses the cache service to store the results of this function for a day.
+     *
+     * @param $attachment_service Wordlift_Attachment_Service
+     * @param WP_Post                                        $post The target {@link WP_Post}.
+     * @param array                                          $jsonld The JSON-LD array.
+     *
+     * @since 3.10.0
+     */
+    public static function set_images( $attachment_service, $post, &$jsonld ) {
+
+        // Prepare the attachment ids array.
+        $ids = array();
+
+        // Set the thumbnail id as first attachment id, if any.
+        $thumbnail_id = get_post_thumbnail_id( $post->ID );
+        if ( '' !== $thumbnail_id && 0 !== $thumbnail_id ) {
+            $ids[] = $thumbnail_id;
+        }
+
+        // For the time being the following is being removed since the query
+        // initiated by `get_image_embeds` is consuming lots of CPU.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/689.
+        //
+        // Get the embeds, removing existing ids.
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( apply_filters( 'wl_feature__enable__image-embeds', false ) ) {
+            $embeds = array_diff( $attachment_service->get_image_embeds( $post->post_content ), $ids );
+        } else {
+            $embeds = array();
+        }
+
+        // Get the gallery, removing existing ids.
+        $gallery = array_diff( $attachment_service->get_gallery( $post ), $ids, $embeds );
+
+        // Map the attachment ids to images' data structured for schema.org use.
+        $images_with_sizes = array_filter(
+            array_reduce(
+                array_merge( $ids, $embeds, $gallery ),
+                function ( $carry, $item ) {
+                    /*
 					* @todo: we're not sure that we're getting attachment data here, we
 					* should filter `false`s.
 					*/
 
-					$sources = array_merge(
-						Wordlift_Image_Service::get_sources( $item ),
-						array( wp_get_attachment_image_src( $item, 'full' ) )
-					);
-
-					$sources_with_image = array_filter(
-						$sources,
-						function ( $source ) {
-							return ! empty( $source[0] );
-						}
-					);
-
-					// Get the attachment data.
-					// $attachment = wp_get_attachment_image_src( $item, 'full' );
-
-					// var_dump( array( "sources-$item" => Wordlift_Image_Service::get_sources( $item ) ) );
-
-					// Bail if image is not found.
-					// In some cases, you can delete the image from the database
-					// or from uploads dir, but the image id still exists as featured image
-					// or in [gallery] shortcode.
-					// if ( empty( $attachment[0] ) ) {
-					if ( empty( $sources_with_image ) ) {
-						return $carry;
-					}
-
-					// Merge the arrays.
-					return array_merge(
-						$carry,
-						$sources_with_image
-					);
-				},
-				// Initial array.
-
-				array()
-			)
-		);
-
-		// Refactor data as per schema.org specifications.
-		$images = array_map(
-			function ( $attachment ) {
-				return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
-					array(
-						'@type' => 'ImageObject',
-						'url'   => $attachment[0],
-					),
-					$attachment
-				);
-			},
-			$images_with_sizes
-		);
-
-		// Add images if present.
-		if ( 0 < count( $images ) ) {
-			$jsonld['image'] = $images;
-		}
-
-	}
-
-	/**
-	 * If the provided array of values contains only one value, then one single
-	 * value is returned, otherwise the original array is returned.
-	 *
-	 * @param array $value An array of values.
-	 *
-	 * @return mixed|array A single value or the original array.
-	 * @since 3.20.0 The function has been moved from {@link Wordlift_Entity_Post_To_Jsonld_Converter} to
-	 *  {@link Wordlift_Abstract_Post_To_Jsonld_Converter}.
-	 * @since  3.8.0
-	 * @access private
-	 */
-	protected static function make_one( $value ) {
-
-		return 1 === count( $value ) ? $value[0] : $value;
-	}
-
-	/**
-	 * Process the provided array by adding the width / height if the values
-	 * are available and are greater than 0.
-	 *
-	 * @param array $image The `ImageObject` array.
-	 * @param array $attachment The attachment array.
-	 *
-	 * @return array The enriched `ImageObject` array.
-	 * @since 3.14.0
-	 */
-	public static function set_image_size( $image, $attachment ) {
-
-		// If you specify a "width" or "height" value you should leave out
-		// 'px'. For example: "width":"4608px" should be "width":"4608".
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/451.
-		if ( isset( $attachment[1] ) && is_numeric( $attachment[1] ) && 0 < $attachment[1] ) {
-			$image['width'] = $attachment[1];
-		}
-
-		if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
-			$image['height'] = $attachment[2];
-		}
-
-		return $image;
-	}
-
-	/**
-	 * Add data to the JSON-LD using the `custom_fields` array which contains the definitions of property
-	 * for the post entity type.
-	 *
-	 * @param array   $jsonld The JSON-LD array.
-	 * @param array   $fields The entity types field array.
-	 * @param WP_Post $post The target {@link WP_Post} instance.
-	 * @param array   $references The references array.
-	 *
-	 * @since 3.20.0 This code moved from the above function `convert`, used for entity types defined in
-	 *  the {@link Wordlift_Schema_Service} class.
-	 */
-	protected function process_type_custom_fields( &$jsonld, $fields, $post, &$references, &$references_infos ) {
-
-		// Set a reference to use in closures.
-		$converter = $this;
-
-		// Try each field on the entity.
-		foreach ( $fields as $key => $value ) {
-
-			// Get the predicate.
-			$name = $this->relative_to_context( $value['predicate'] );
-
-			// Get the value, the property service will get the right extractor
-			// for that property.
-			$value = $this->property_getter->get( $post->ID, $key, Object_Type_Enum::POST );
-
-			if ( empty( $value ) ) {
-				continue;
-			}
-
-			// Map the value to the property name.
-			// If we got an array with just one value, we return that one value.
-			// If we got a Wordlift_Property_Entity_Reference we get the URL.
-			$jsonld[ $name ] = self::make_one(
-				array_map(
-					function ( $item ) use ( $converter, &$references, &$references_infos ) {
-
-						if ( $item instanceof Wordlift_Property_Entity_Reference ) {
-
-							  $url = $item->get_url();
-
-							  // The refactored converters require the entity id.
-							// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-							  $references[] = $item->get_id();
-
-							// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-							  $references_infos[] = array( 'reference' => $item );
-
-							  return array(
-								  '@id' => $url,
-							  );
-						}
-
-						return $converter->relative_to_context( $item );
-					},
-					$value
-				)
-			);
-
-		}
-
-	}
+                    $sources = array_merge(
+                        Wordlift_Image_Service::get_sources( $item ),
+                        array( wp_get_attachment_image_src( $item, 'full' ) )
+                    );
+
+                    $sources_with_image = array_filter(
+                        $sources,
+                        function ( $source ) {
+                            return ! empty( $source[0] );
+                        }
+                    );
+
+                    // Get the attachment data.
+                    // $attachment = wp_get_attachment_image_src( $item, 'full' );
+
+                    // var_dump( array( "sources-$item" => Wordlift_Image_Service::get_sources( $item ) ) );
+
+                    // Bail if image is not found.
+                    // In some cases, you can delete the image from the database
+                    // or from uploads dir, but the image id still exists as featured image
+                    // or in [gallery] shortcode.
+                    // if ( empty( $attachment[0] ) ) {
+                    if ( empty( $sources_with_image ) ) {
+                        return $carry;
+                    }
+
+                    // Merge the arrays.
+                    return array_merge(
+                        $carry,
+                        $sources_with_image
+                    );
+                },
+                // Initial array.
+
+                array()
+            )
+        );
+
+        // Refactor data as per schema.org specifications.
+        $images = array_map(
+            function ( $attachment ) {
+                return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
+                    array(
+                        '@type' => 'ImageObject',
+                        'url'   => $attachment[0],
+                    ),
+                    $attachment
+                );
+            },
+            $images_with_sizes
+        );
+
+        // Add images if present.
+        if ( 0 < count( $images ) ) {
+            $jsonld['image'] = $images;
+        }
+
+    }
+
+    /**
+     * If the provided array of values contains only one value, then one single
+     * value is returned, otherwise the original array is returned.
+     *
+     * @param array $value An array of values.
+     *
+     * @return mixed|array A single value or the original array.
+     * @since 3.20.0 The function has been moved from {@link Wordlift_Entity_Post_To_Jsonld_Converter} to
+     *  {@link Wordlift_Abstract_Post_To_Jsonld_Converter}.
+     * @since  3.8.0
+     * @access private
+     */
+    protected static function make_one( $value ) {
+
+        return 1 === count( $value ) ? $value[0] : $value;
+    }
+
+    /**
+     * Process the provided array by adding the width / height if the values
+     * are available and are greater than 0.
+     *
+     * @param array $image The `ImageObject` array.
+     * @param array $attachment The attachment array.
+     *
+     * @return array The enriched `ImageObject` array.
+     * @since 3.14.0
+     */
+    public static function set_image_size( $image, $attachment ) {
+
+        // If you specify a "width" or "height" value you should leave out
+        // 'px'. For example: "width":"4608px" should be "width":"4608".
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/451.
+        if ( isset( $attachment[1] ) && is_numeric( $attachment[1] ) && 0 < $attachment[1] ) {
+            $image['width'] = $attachment[1];
+        }
+
+        if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
+            $image['height'] = $attachment[2];
+        }
+
+        return $image;
+    }
+
+    /**
+     * Add data to the JSON-LD using the `custom_fields` array which contains the definitions of property
+     * for the post entity type.
+     *
+     * @param array   $jsonld The JSON-LD array.
+     * @param array   $fields The entity types field array.
+     * @param WP_Post $post The target {@link WP_Post} instance.
+     * @param array   $references The references array.
+     *
+     * @since 3.20.0 This code moved from the above function `convert`, used for entity types defined in
+     *  the {@link Wordlift_Schema_Service} class.
+     */
+    protected function process_type_custom_fields( &$jsonld, $fields, $post, &$references, &$references_infos ) {
+
+        // Set a reference to use in closures.
+        $converter = $this;
+
+        // Try each field on the entity.
+        foreach ( $fields as $key => $value ) {
+
+            // Get the predicate.
+            $name = $this->relative_to_context( $value['predicate'] );
+
+            // Get the value, the property service will get the right extractor
+            // for that property.
+            $value = $this->property_getter->get( $post->ID, $key, Object_Type_Enum::POST );
+
+            if ( empty( $value ) ) {
+                continue;
+            }
+
+            // Map the value to the property name.
+            // If we got an array with just one value, we return that one value.
+            // If we got a Wordlift_Property_Entity_Reference we get the URL.
+            $jsonld[ $name ] = self::make_one(
+                array_map(
+                    function ( $item ) use ( $converter, &$references, &$references_infos ) {
+
+                        if ( $item instanceof Wordlift_Property_Entity_Reference ) {
+
+                                $url = $item->get_url();
+
+                                // The refactored converters require the entity id.
+                            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                                $references[] = $item->get_id();
+
+                            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                                $references_infos[] = array( 'reference' => $item );
+
+                                return array(
+                                    '@id' => $url,
+                                );
+                        }
+
+                        return $converter->relative_to_context( $item );
+                    },
+                    $value
+                )
+            );
+
+        }
+
+    }
 
 }

Spacing +58 added lines, -58 removed lines

@@ -72,7 +72,7 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	public function __construct( $entity_type_service, $user_service, $attachment_service, $property_getter ) {
+	public function __construct($entity_type_service, $user_service, $attachment_service, $property_getter) {
 		$this->entity_type_service = $entity_type_service;
 		$this->user_service        = $user_service;
 		$this->attachment_service  = $attachment_service;
@@ -91,19 +91,19 @@ 
 	 * @since 3.10.0
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function convert( $post_id, &$references = array(), &$references_infos = array() ) {
+	public function convert($post_id, &$references = array(), &$references_infos = array()) {
 
 		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
+		$post = get_post($post_id);
+		if (null === $post) {
 			// Post not found.
 			return null;
 		}
 
 		// Get the post URI @id.
-		$id = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
-		if ( $id === null ) {
-			$id = 'get_uri returned null, dataset is ' . wl_configuration_get_redlink_dataset_uri();
+		$id = Wordlift_Entity_Service::get_instance()->get_uri($post->ID);
+		if ($id === null) {
+			$id = 'get_uri returned null, dataset is '.wl_configuration_get_redlink_dataset_uri();
 		}
 
 		/*
@@ -115,15 +115,15 @@ 
 		 */
 		// Get the entity @type. We consider `post` BlogPostings.
 		// $type = $this->entity_type_service->get( $post_id );
-		$types = $this->entity_type_service->get_names( $post_id );
-		$type  = self::make_one( $types );
+		$types = $this->entity_type_service->get_names($post_id);
+		$type  = self::make_one($types);
 
 		// Prepare the response.
 		$jsonld = array(
 			'@context'    => self::CONTEXT,
 			'@id'         => $id,
 			'@type'       => $type,
-			'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ),
+			'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt($post),
 		);
 
 		// Set the `mainEntityOfPage` property if the post has some contents.
@@ -133,8 +133,8 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		if ( ! empty( $post_content ) ) {
+		$post_content = apply_filters('wl_post_content', $post->post_content, $post);
+		if ( ! empty($post_content)) {
 			// We're setting the `mainEntityOfPage` to signal which one is the
 			// main entity for the specified URL. It might be however that the
 			// post/page is actually about another specific entity. How WL deals
@@ -145,28 +145,28 @@ 
 			// No need to specify `'@type' => 'WebPage'.
 			//
 			// See https://github.com/insideout10/wordlift-plugin/issues/451.
-			$jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
+			$jsonld['mainEntityOfPage'] = get_the_permalink($post->ID);
 
 			/**
 			 * @see https://github.com/insideout10/wordlift-plugin/issues/1207
 			 *
 			 * @since 3.27.7
 			 */
-			if ( in_array( $type, array( 'Occupation', 'OccupationAggregationByEmployer' ), true ) ) {
+			if (in_array($type, array('Occupation', 'OccupationAggregationByEmployer'), true)) {
 				$jsonld['mainEntityOfPage'] = array(
 					'@type'        => 'WebPage',
-					'lastReviewed' => get_post_time( 'Y-m-d\TH:i:sP', true, $post, false ),
+					'lastReviewed' => get_post_time('Y-m-d\TH:i:sP', true, $post, false),
 				);
 			}
 		};
 
-		$this->set_images( $this->attachment_service, $post, $jsonld );
+		$this->set_images($this->attachment_service, $post, $jsonld);
 
 		// Get the entities referenced by this post and set it to the `references`
 		// array so that the caller can do further processing, such as printing out
 		// more of those references.
 		$references_without_locations = Object_Relation_Service::get_instance()
-															   ->get_references( $post_id, Object_Type_Enum::POST );
+															   ->get_references($post_id, Object_Type_Enum::POST);
 
 		/*
 		 * Add the locations to the references.
@@ -179,33 +179,33 @@ 
 		$entity_type_service = $this->entity_type_service;
 		$locations           = array_reduce(
 			$references_without_locations,
-			function ( $carry, $reference ) use ( $entity_type_service ) {
+			function($carry, $reference) use ($entity_type_service) {
 				/**
 				 * @var $reference Reference
 				 */
 				// @see https://schema.org/location for the schema.org types using the `location` property.
-				if ( ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Action' )
-				 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Event' )
-				 && ! $entity_type_service->has_entity_type( $reference->get_id(), 'http://schema.org/Organization' ) ) {
+				if ( ! $entity_type_service->has_entity_type($reference->get_id(), 'http://schema.org/Action')
+				 && ! $entity_type_service->has_entity_type($reference->get_id(), 'http://schema.org/Event')
+				 && ! $entity_type_service->has_entity_type($reference->get_id(), 'http://schema.org/Organization')) {
 
 					return $carry;
 				}
-				$post_location_ids        = get_post_meta( $reference->get_id(), Wordlift_Schema_Service::FIELD_LOCATION );
+				$post_location_ids        = get_post_meta($reference->get_id(), Wordlift_Schema_Service::FIELD_LOCATION);
 				$post_location_references = array_map(
-					function ( $post_id ) {
-						return new Post_Reference( $post_id );
+					function($post_id) {
+						return new Post_Reference($post_id);
 					},
 					$post_location_ids
 				);
 
-				return array_merge( $carry, $post_location_references );
+				return array_merge($carry, $post_location_references);
 			},
 			array()
 		);
 
 		// Merge the references with the referenced locations if any.
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$references = array_merge( $references_without_locations, $locations );
+		$references = array_merge($references_without_locations, $locations);
 
 		return $jsonld;
 	}
@@ -219,9 +219,9 @@ 
 	 * @return string The property value without the context.
 	 * @since 3.10.0
 	 */
-	public function relative_to_context( $value ) {
+	public function relative_to_context($value) {
 
-		return 0 === strpos( $value, self::CONTEXT . '/' ) ? substr( $value, strlen( self::CONTEXT ) + 1 ) : $value;
+		return 0 === strpos($value, self::CONTEXT.'/') ? substr($value, strlen(self::CONTEXT) + 1) : $value;
 	}
 
 	/**
@@ -236,14 +236,14 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	public static function set_images( $attachment_service, $post, &$jsonld ) {
+	public static function set_images($attachment_service, $post, &$jsonld) {
 
 		// Prepare the attachment ids array.
 		$ids = array();
 
 		// Set the thumbnail id as first attachment id, if any.
-		$thumbnail_id = get_post_thumbnail_id( $post->ID );
-		if ( '' !== $thumbnail_id && 0 !== $thumbnail_id ) {
+		$thumbnail_id = get_post_thumbnail_id($post->ID);
+		if ('' !== $thumbnail_id && 0 !== $thumbnail_id) {
 			$ids[] = $thumbnail_id;
 		}
 
@@ -254,34 +254,34 @@ 
 		//
 		// Get the embeds, removing existing ids.
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( apply_filters( 'wl_feature__enable__image-embeds', false ) ) {
-			$embeds = array_diff( $attachment_service->get_image_embeds( $post->post_content ), $ids );
+		if (apply_filters('wl_feature__enable__image-embeds', false)) {
+			$embeds = array_diff($attachment_service->get_image_embeds($post->post_content), $ids);
 		} else {
 			$embeds = array();
 		}
 
 		// Get the gallery, removing existing ids.
-		$gallery = array_diff( $attachment_service->get_gallery( $post ), $ids, $embeds );
+		$gallery = array_diff($attachment_service->get_gallery($post), $ids, $embeds);
 
 		// Map the attachment ids to images' data structured for schema.org use.
 		$images_with_sizes = array_filter(
 			array_reduce(
-				array_merge( $ids, $embeds, $gallery ),
-				function ( $carry, $item ) {
+				array_merge($ids, $embeds, $gallery),
+				function($carry, $item) {
 					/*
 					* @todo: we're not sure that we're getting attachment data here, we
 					* should filter `false`s.
 					*/
 
 					$sources = array_merge(
-						Wordlift_Image_Service::get_sources( $item ),
-						array( wp_get_attachment_image_src( $item, 'full' ) )
+						Wordlift_Image_Service::get_sources($item),
+						array(wp_get_attachment_image_src($item, 'full'))
 					);
 
 					$sources_with_image = array_filter(
 						$sources,
-						function ( $source ) {
-							return ! empty( $source[0] );
+						function($source) {
+							return ! empty($source[0]);
 						}
 					);
 
@@ -295,7 +295,7 @@ 
 					// or from uploads dir, but the image id still exists as featured image
 					// or in [gallery] shortcode.
 					// if ( empty( $attachment[0] ) ) {
-					if ( empty( $sources_with_image ) ) {
+					if (empty($sources_with_image)) {
 						return $carry;
 					}
 
@@ -313,7 +313,7 @@ 
 
 		// Refactor data as per schema.org specifications.
 		$images = array_map(
-			function ( $attachment ) {
+			function($attachment) {
 				return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
 					array(
 						'@type' => 'ImageObject',
@@ -326,7 +326,7 @@ 
 		);
 
 		// Add images if present.
-		if ( 0 < count( $images ) ) {
+		if (0 < count($images)) {
 			$jsonld['image'] = $images;
 		}
 
@@ -344,9 +344,9 @@ 
 	 * @since  3.8.0
 	 * @access private
 	 */
-	protected static function make_one( $value ) {
+	protected static function make_one($value) {
 
-		return 1 === count( $value ) ? $value[0] : $value;
+		return 1 === count($value) ? $value[0] : $value;
 	}
 
 	/**
@@ -359,17 +359,17 @@ 
 	 * @return array The enriched `ImageObject` array.
 	 * @since 3.14.0
 	 */
-	public static function set_image_size( $image, $attachment ) {
+	public static function set_image_size($image, $attachment) {
 
 		// If you specify a "width" or "height" value you should leave out
 		// 'px'. For example: "width":"4608px" should be "width":"4608".
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/451.
-		if ( isset( $attachment[1] ) && is_numeric( $attachment[1] ) && 0 < $attachment[1] ) {
+		if (isset($attachment[1]) && is_numeric($attachment[1]) && 0 < $attachment[1]) {
 			$image['width'] = $attachment[1];
 		}
 
-		if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
+		if (isset($attachment[2]) && is_numeric($attachment[2]) && 0 < $attachment[2]) {
 			$image['height'] = $attachment[2];
 		}
 
@@ -388,33 +388,33 @@ 
 	 * @since 3.20.0 This code moved from the above function `convert`, used for entity types defined in
 	 *  the {@link Wordlift_Schema_Service} class.
 	 */
-	protected function process_type_custom_fields( &$jsonld, $fields, $post, &$references, &$references_infos ) {
+	protected function process_type_custom_fields(&$jsonld, $fields, $post, &$references, &$references_infos) {
 
 		// Set a reference to use in closures.
 		$converter = $this;
 
 		// Try each field on the entity.
-		foreach ( $fields as $key => $value ) {
+		foreach ($fields as $key => $value) {
 
 			// Get the predicate.
-			$name = $this->relative_to_context( $value['predicate'] );
+			$name = $this->relative_to_context($value['predicate']);
 
 			// Get the value, the property service will get the right extractor
 			// for that property.
-			$value = $this->property_getter->get( $post->ID, $key, Object_Type_Enum::POST );
+			$value = $this->property_getter->get($post->ID, $key, Object_Type_Enum::POST);
 
-			if ( empty( $value ) ) {
+			if (empty($value)) {
 				continue;
 			}
 
 			// Map the value to the property name.
 			// If we got an array with just one value, we return that one value.
 			// If we got a Wordlift_Property_Entity_Reference we get the URL.
-			$jsonld[ $name ] = self::make_one(
+			$jsonld[$name] = self::make_one(
 				array_map(
-					function ( $item ) use ( $converter, &$references, &$references_infos ) {
+					function($item) use ($converter, &$references, &$references_infos) {
 
-						if ( $item instanceof Wordlift_Property_Entity_Reference ) {
+						if ($item instanceof Wordlift_Property_Entity_Reference) {
 
 							  $url = $item->get_url();
 
@@ -423,14 +423,14 @@ 
 							  $references[] = $item->get_id();
 
 							// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-							  $references_infos[] = array( 'reference' => $item );
+							  $references_infos[] = array('reference' => $item);
 
 							  return array(
 								  '@id' => $url,
 							  );
 						}
 
-						return $converter->relative_to_context( $item );
+						return $converter->relative_to_context($item);
 					},
 					$value
 				)

src/includes/class-wordlift-category-taxonomy-service.php

Indentation +60 added lines, -60 removed lines

@@ -18,75 +18,75 @@
  */
 class Wordlift_Category_Taxonomy_Service {
 
-	/**
-	 * The {@link Wordlift_Entity_Post_Type_Service} instance.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
-	 */
-	private $entity_post_type_service;
+    /**
+     * The {@link Wordlift_Entity_Post_Type_Service} instance.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
+     */
+    private $entity_post_type_service;
 
-	/**
-	 * Create a {@link Wordlift_Category_Taxonomy_Service} instance.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
-	 */
-	public function __construct( $entity_post_type_service ) {
+    /**
+     * Create a {@link Wordlift_Category_Taxonomy_Service} instance.
+     *
+     * @since 3.11.0
+     *
+     * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
+     */
+    public function __construct( $entity_post_type_service ) {
 
-		$this->entity_post_type_service = $entity_post_type_service;
+        $this->entity_post_type_service = $entity_post_type_service;
 
-	}
+    }
 
-	/**
-	 * Set the entity post types as one to be included in archive pages.
-	 *
-	 * In order to have entities show up in standard WP categories (Posts categories)
-	 * we configure the `entity` post type, but we also need to alter the main
-	 * WP query (which by default queries posts only) to include the `entities`.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param WP_Query $query WP's {@link WP_Query} instance.
-	 */
-	public function pre_get_posts( $query ) {
+    /**
+     * Set the entity post types as one to be included in archive pages.
+     *
+     * In order to have entities show up in standard WP categories (Posts categories)
+     * we configure the `entity` post type, but we also need to alter the main
+     * WP query (which by default queries posts only) to include the `entities`.
+     *
+     * @since 3.11.0
+     *
+     * @param WP_Query $query WP's {@link WP_Query} instance.
+     */
+    public function pre_get_posts( $query ) {
 
-		// Only for the main query, avoid problems with widgets and what not.
-		if ( ! $query->is_main_query() ) {
-			return;
-		}
+        // Only for the main query, avoid problems with widgets and what not.
+        if ( ! $query->is_main_query() ) {
+            return;
+        }
 
-		// We don't want to alter the query if we're in the admin UI, if this is
-		// not a category query, or if the `suppress_filters` is set.
-		//
-		// Note that it is unlikely for `suppress_filter` to be set on the front
-		// end, but let's be safe if it is set the calling code assumes no
-		// modifications of queries.
-		//
-		// is_admin is needed, otherwise category based post filters will show
-		// both types and at the current release (4.7) it causes PHP errors.
-		if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) {
-			return;
-		}
+        // We don't want to alter the query if we're in the admin UI, if this is
+        // not a category query, or if the `suppress_filters` is set.
+        //
+        // Note that it is unlikely for `suppress_filter` to be set on the front
+        // end, but let's be safe if it is set the calling code assumes no
+        // modifications of queries.
+        //
+        // is_admin is needed, otherwise category based post filters will show
+        // both types and at the current release (4.7) it causes PHP errors.
+        if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) {
+            return;
+        }
 
-		// Check the current post types, maybe the category archive pages
-		// are already associated with other post types.
-		//
-		// If `post_type` isn't set, WP assumes `post` by default.
-		$post_types = $query->get( 'post_type' );
-		$post_types = (array) ( $post_types ? $post_types : 'post' );
+        // Check the current post types, maybe the category archive pages
+        // are already associated with other post types.
+        //
+        // If `post_type` isn't set, WP assumes `post` by default.
+        $post_types = $query->get( 'post_type' );
+        $post_types = (array) ( $post_types ? $post_types : 'post' );
 
-		// Add the entities post type only if the post post type is used in the query
-		// since we only want `entities` to appear alongside posts.
-		if ( in_array( 'post', $post_types, true ) ) {
-			$post_types[] = $this->entity_post_type_service->get_post_type();
-		}
+        // Add the entities post type only if the post post type is used in the query
+        // since we only want `entities` to appear alongside posts.
+        if ( in_array( 'post', $post_types, true ) ) {
+            $post_types[] = $this->entity_post_type_service->get_post_type();
+        }
 
-		// Update the query post types.
-		$query->set( 'post_type', $post_types );
+        // Update the query post types.
+        $query->set( 'post_type', $post_types );
 
-	}
+    }
 
 }

Spacing +8 added lines, -8 removed lines

@@ -34,7 +34,7 @@ 
 	 *
 	 * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
 	 */
-	public function __construct( $entity_post_type_service ) {
+	public function __construct($entity_post_type_service) {
 
 		$this->entity_post_type_service = $entity_post_type_service;
 
@@ -51,10 +51,10 @@ 
 	 *
 	 * @param WP_Query $query WP's {@link WP_Query} instance.
 	 */
-	public function pre_get_posts( $query ) {
+	public function pre_get_posts($query) {
 
 		// Only for the main query, avoid problems with widgets and what not.
-		if ( ! $query->is_main_query() ) {
+		if ( ! $query->is_main_query()) {
 			return;
 		}
 
@@ -67,7 +67,7 @@ 
 		//
 		// is_admin is needed, otherwise category based post filters will show
 		// both types and at the current release (4.7) it causes PHP errors.
-		if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) {
+		if (is_admin() || ! is_category() || ! empty($query->query_vars['suppress_filters'])) {
 			return;
 		}
 
@@ -75,17 +75,17 @@ 
 		// are already associated with other post types.
 		//
 		// If `post_type` isn't set, WP assumes `post` by default.
-		$post_types = $query->get( 'post_type' );
-		$post_types = (array) ( $post_types ? $post_types : 'post' );
+		$post_types = $query->get('post_type');
+		$post_types = (array) ($post_types ? $post_types : 'post');
 
 		// Add the entities post type only if the post post type is used in the query
 		// since we only want `entities` to appear alongside posts.
-		if ( in_array( 'post', $post_types, true ) ) {
+		if (in_array('post', $post_types, true)) {
 			$post_types[] = $this->entity_post_type_service->get_post_type();
 		}
 
 		// Update the query post types.
-		$query->set( 'post_type', $post_types );
+		$query->set('post_type', $post_types);
 
 	}
 

src/includes/class-wordlift-entity-type-adapter.php

Indentation +141 added lines, -141 removed lines

@@ -20,146 +20,146 @@
  */
 class Wordlift_Entity_Type_Adapter {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	private $entity_type_service;
-
-	/**
-	 * Create a {@link Wordlift_Entity_Type_Adapter} instance.
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since 3.15.0
-	 */
-	public function __construct( $entity_type_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Adapter' );
-
-		$this->entity_type_service = $entity_type_service;
-
-		add_filter(
-			'wl_default_entity_type_for_post_type',
-			array(
-				$this,
-				'default_entity_type_callback',
-			),
-			10,
-			2
-		);
-
-	}
-
-	/**
-	 * @param $entity_type string Entity type
-	 * @param $post_type string The post type
-	 *
-	 * @return string The default entity type depending on the post type.
-	 */
-	public function default_entity_type_callback( $entity_type, $post_type ) {
-		if ( 'product' === $post_type ) {
-			return 'http://schema.org/Product';
-		}
-
-		return $entity_type;
-	}
-
-	/**
-	 * Hook to `save_post`.
-	 *
-	 * This function is called when the `save_post` action is run. The
-	 * function checks whether an Entity Type term (from the Entity Types
-	 * taxonomy) is already assigned and, if not, it calls {@link Wordlift_Entity_Type_Service}
-	 * to set the default taxonomy term.
-	 *
-	 * @param int     $post_id The {@link WP_Post}'s id.
-	 * @param WP_Post $post The {@link WP_Post} instance.
-	 *
-	 * @since 3.15.0
-	 */
-	public function save_post( $post_id, $post ) {
-
-		if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post->post_type ) ) {
-			$this->log->debug( "Ignoring `{$post->post_type}` post type." );
-
-			// Bail out if the post can not be an entity.
-			return;
-		}
-
-		// Bail out if the post already has an entity type.
-		if ( apply_filters( 'wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type( $post_id ) ) ) {
-			$this->log->debug( "Post $post_id has already an entity type." );
-
-			return;
-		}
-
-		$this->log->debug( "Setting `Article` entity type for post $post_id." );
-
-		// Finally set the default entity type.
-
-		// For entities use a Thing
-		if ( 'entity' === $post->post_type ) {
-			$this->entity_type_service->set( $post_id, 'http://schema.org/Thing' );
-		} else {
-			// Get the entity types.
-			$entity_types = self::get_entity_types( $post->post_type );
-
-			// Set the entity type.
-			foreach ( $entity_types as $entity_type ) {
-				$this->entity_type_service->set( $post_id, $entity_type, false );
-			}
-		}
-
-	}
-
-	/**
-	 * Get the entity types for a post type.
-	 *
-	 * @param string $post_type The post type.
-	 *
-	 * @return array An array of entity types.
-	 * @since 3.20.0
-	 */
-	public static function get_entity_types( $post_type ) {
-
-		/**
-		 * Get the default entity type.
-		 *
-		 * @param string $entity_type The preset entity type.
-		 * @param string $post_type The post type.
-		 *
-		 * @since 3.20.0
-		 */
-		$default_entity_type = apply_filters( 'wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type );
-
-		/**
-		 * Get the default entity types.
-		 *
-		 * Adding support to assign more than one entity type.
-		 *
-		 * @param array $entity_types The default entity types.
-		 * @param string $post_type The post type.
-		 *
-		 * @since 3.20.0
-		 *
-		 * @see Wordlift_Mapping_Service
-		 */
-		$entity_types = apply_filters( 'wl_default_entity_types_for_post_type', array( $default_entity_type ), $post_type );
-
-		return $entity_types;
-	}
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     */
+    private $entity_type_service;
+
+    /**
+     * Create a {@link Wordlift_Entity_Type_Adapter} instance.
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since 3.15.0
+     */
+    public function __construct( $entity_type_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Adapter' );
+
+        $this->entity_type_service = $entity_type_service;
+
+        add_filter(
+            'wl_default_entity_type_for_post_type',
+            array(
+                $this,
+                'default_entity_type_callback',
+            ),
+            10,
+            2
+        );
+
+    }
+
+    /**
+     * @param $entity_type string Entity type
+     * @param $post_type string The post type
+     *
+     * @return string The default entity type depending on the post type.
+     */
+    public function default_entity_type_callback( $entity_type, $post_type ) {
+        if ( 'product' === $post_type ) {
+            return 'http://schema.org/Product';
+        }
+
+        return $entity_type;
+    }
+
+    /**
+     * Hook to `save_post`.
+     *
+     * This function is called when the `save_post` action is run. The
+     * function checks whether an Entity Type term (from the Entity Types
+     * taxonomy) is already assigned and, if not, it calls {@link Wordlift_Entity_Type_Service}
+     * to set the default taxonomy term.
+     *
+     * @param int     $post_id The {@link WP_Post}'s id.
+     * @param WP_Post $post The {@link WP_Post} instance.
+     *
+     * @since 3.15.0
+     */
+    public function save_post( $post_id, $post ) {
+
+        if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post->post_type ) ) {
+            $this->log->debug( "Ignoring `{$post->post_type}` post type." );
+
+            // Bail out if the post can not be an entity.
+            return;
+        }
+
+        // Bail out if the post already has an entity type.
+        if ( apply_filters( 'wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type( $post_id ) ) ) {
+            $this->log->debug( "Post $post_id has already an entity type." );
+
+            return;
+        }
+
+        $this->log->debug( "Setting `Article` entity type for post $post_id." );
+
+        // Finally set the default entity type.
+
+        // For entities use a Thing
+        if ( 'entity' === $post->post_type ) {
+            $this->entity_type_service->set( $post_id, 'http://schema.org/Thing' );
+        } else {
+            // Get the entity types.
+            $entity_types = self::get_entity_types( $post->post_type );
+
+            // Set the entity type.
+            foreach ( $entity_types as $entity_type ) {
+                $this->entity_type_service->set( $post_id, $entity_type, false );
+            }
+        }
+
+    }
+
+    /**
+     * Get the entity types for a post type.
+     *
+     * @param string $post_type The post type.
+     *
+     * @return array An array of entity types.
+     * @since 3.20.0
+     */
+    public static function get_entity_types( $post_type ) {
+
+        /**
+         * Get the default entity type.
+         *
+         * @param string $entity_type The preset entity type.
+         * @param string $post_type The post type.
+         *
+         * @since 3.20.0
+         */
+        $default_entity_type = apply_filters( 'wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type );
+
+        /**
+         * Get the default entity types.
+         *
+         * Adding support to assign more than one entity type.
+         *
+         * @param array $entity_types The default entity types.
+         * @param string $post_type The post type.
+         *
+         * @since 3.20.0
+         *
+         * @see Wordlift_Mapping_Service
+         */
+        $entity_types = apply_filters( 'wl_default_entity_types_for_post_type', array( $default_entity_type ), $post_type );
+
+        return $entity_types;
+    }
 
 }

Spacing +18 added lines, -18 removed lines

@@ -45,9 +45,9 @@ 
 	 *
 	 * @since 3.15.0
 	 */
-	public function __construct( $entity_type_service ) {
+	public function __construct($entity_type_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Adapter' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Entity_Type_Adapter');
 
 		$this->entity_type_service = $entity_type_service;
 
@@ -69,8 +69,8 @@ 
 	 *
 	 * @return string The default entity type depending on the post type.
 	 */
-	public function default_entity_type_callback( $entity_type, $post_type ) {
-		if ( 'product' === $post_type ) {
+	public function default_entity_type_callback($entity_type, $post_type) {
+		if ('product' === $post_type) {
 			return 'http://schema.org/Product';
 		}
 
@@ -90,36 +90,36 @@ 
 	 *
 	 * @since 3.15.0
 	 */
-	public function save_post( $post_id, $post ) {
+	public function save_post($post_id, $post) {
 
-		if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post->post_type ) ) {
-			$this->log->debug( "Ignoring `{$post->post_type}` post type." );
+		if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type($post->post_type)) {
+			$this->log->debug("Ignoring `{$post->post_type}` post type.");
 
 			// Bail out if the post can not be an entity.
 			return;
 		}
 
 		// Bail out if the post already has an entity type.
-		if ( apply_filters( 'wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type( $post_id ) ) ) {
-			$this->log->debug( "Post $post_id has already an entity type." );
+		if (apply_filters('wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type($post_id))) {
+			$this->log->debug("Post $post_id has already an entity type.");
 
 			return;
 		}
 
-		$this->log->debug( "Setting `Article` entity type for post $post_id." );
+		$this->log->debug("Setting `Article` entity type for post $post_id.");
 
 		// Finally set the default entity type.
 
 		// For entities use a Thing
-		if ( 'entity' === $post->post_type ) {
-			$this->entity_type_service->set( $post_id, 'http://schema.org/Thing' );
+		if ('entity' === $post->post_type) {
+			$this->entity_type_service->set($post_id, 'http://schema.org/Thing');
 		} else {
 			// Get the entity types.
-			$entity_types = self::get_entity_types( $post->post_type );
+			$entity_types = self::get_entity_types($post->post_type);
 
 			// Set the entity type.
-			foreach ( $entity_types as $entity_type ) {
-				$this->entity_type_service->set( $post_id, $entity_type, false );
+			foreach ($entity_types as $entity_type) {
+				$this->entity_type_service->set($post_id, $entity_type, false);
 			}
 		}
 
@@ -133,7 +133,7 @@ 
 	 * @return array An array of entity types.
 	 * @since 3.20.0
 	 */
-	public static function get_entity_types( $post_type ) {
+	public static function get_entity_types($post_type) {
 
 		/**
 		 * Get the default entity type.
@@ -143,7 +143,7 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$default_entity_type = apply_filters( 'wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type );
+		$default_entity_type = apply_filters('wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type);
 
 		/**
 		 * Get the default entity types.
@@ -157,7 +157,7 @@ 
 		 *
 		 * @see Wordlift_Mapping_Service
 		 */
-		$entity_types = apply_filters( 'wl_default_entity_types_for_post_type', array( $default_entity_type ), $post_type );
+		$entity_types = apply_filters('wl_default_entity_types_for_post_type', array($default_entity_type), $post_type);
 
 		return $entity_types;
 	}

src/includes/class-wordlift-deactivator-feedback.php

Indentation +141 added lines, -141 removed lines

@@ -21,145 +21,145 @@
  */
 class Wordlift_Deactivator_Feedback {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.19.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Wordlift_Deactivator_Feedback constructor.
-	 *
-	 * @since 3.19.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Deactivator_Feedback' );
-
-	}
-
-	/**
-	 * Checks whether we have permissions to show the popup.
-	 *
-	 * @return  bool `true` if we have permissions, false otherwise.
-	 * @version 3.19.0
-	 */
-	private function has_permission_to_show_popup() {
-		// Get the current page.
-		global $pagenow;
-
-		// Bail if the user doesn't have permissions
-		// or if it's not the plugins page.
-		if ( 'plugins.php' !== $pagenow ) {
-			return false;
-		}
-
-		// Get the user preferences. We shouldn't show the feedback popup
-		// if we don't have permissions for that.
-		$user_preferences = Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences();
-
-		// Bail. We don't have preferences to show the popup.
-		if ( 'yes' !== $user_preferences ) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Render the feedback popup in the footer.
-	 *
-	 * @return  void
-	 * @version 3.19.0
-	 */
-	public function render_feedback_popup() {
-		// Bail if we don't have permissions to show the popup.
-		if ( ! $this->has_permission_to_show_popup() ) {
-			return;
-		}
-		// Include the partial.
-		include plugin_dir_path( __FILE__ ) . '../admin/partials/wordlift-admin-deactivation-feedback-popup.php';
-	}
-
-	/**
-	 * Enqueue required popup scripts and styles.
-	 *
-	 * @return  void
-	 * @version 3.19.0
-	 */
-	public function enqueue_popup_scripts() {
-		// Bail if we don't have permissions to show the popup.
-		if ( ! $this->has_permission_to_show_popup() ) {
-			return;
-		}
-
-		wp_enqueue_style( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION );
-		wp_enqueue_script( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/js/wordlift-admin-feedback-popup.js', array( 'jquery' ), WORDLIFT_VERSION, false );
-	}
-
-	/**
-	 * Handle the deactivation ajax call
-	 * and perform a request to external server.
-	 *
-	 * @return  void
-	 * @version 3.19.0
-	 */
-	public function wl_deactivation_feedback() {
-		// Bail if the nonce is not valid.
-		if (
-			empty( $_POST['wl_deactivation_feedback_nonce'] ) || // The nonce doens't exists.
-			! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['wl_deactivation_feedback_nonce'] ) ), 'wl_deactivation_feedback_nonce' ) // The nonce is invalid.
-		) {
-			wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
-		}
-
-		// We allow user to deactivate without providing a reason
-		// so bail and send success response.
-		if ( empty( $_POST['code'] ) ) {
-			wp_send_json_success();
-		}
-
-		$plugin_data = get_plugin_data( plugin_dir_path( __DIR__ ) . 'wordlift.php', false, false );
-
-		// Prepare the options.
-		$options = array(
-			// The deactivation reason.
-			'code'             => sanitize_text_field( wp_unslash( (string) $_POST['code'] ) ),
-			// Additional information if provided.
-			'details'          => ( ! empty( $_POST['details'] ) ) ? sanitize_text_field( wp_unslash( (string) $_POST['details'] ) ) : '',
-			// The website url.
-			'url'              => get_bloginfo( 'url' ),
-			// WP version.
-			'wordpressVersion' => get_bloginfo( 'version' ),
-			// WL version.
-			'wordliftVersion'  => $plugin_data['Version'],
-			// The admin email.
-			'email'            => get_bloginfo( 'admin_email' ),
-		);
-
-		$response = wp_remote_post(
-			Wordlift_Configuration_Service::get_instance()->get_deactivation_feedback_url(),
-			array(
-				'method'  => 'POST',
-				'body'    => wp_json_encode( $options ),
-				'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ),
-			)
-		);
-
-		$code    = wp_remote_retrieve_response_code( $response );
-		$message = wp_remote_retrieve_response_message( $response );
-
-		// Add message to the error log if the response code is not 200.
-		if ( 201 !== $code ) {
-			// Write the error in the logs.
-			$this->log->error( 'An error occurred while requesting a feedback endpoint error_code: ' . $code . ' message: ' . $message );
-		}
-
-		// We should send success message even when the feedback is not
-		// send, because otherwise the plugin cannot be deactivated.
-		wp_send_json_success();
-	}
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.19.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Wordlift_Deactivator_Feedback constructor.
+     *
+     * @since 3.19.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Deactivator_Feedback' );
+
+    }
+
+    /**
+     * Checks whether we have permissions to show the popup.
+     *
+     * @return  bool `true` if we have permissions, false otherwise.
+     * @version 3.19.0
+     */
+    private function has_permission_to_show_popup() {
+        // Get the current page.
+        global $pagenow;
+
+        // Bail if the user doesn't have permissions
+        // or if it's not the plugins page.
+        if ( 'plugins.php' !== $pagenow ) {
+            return false;
+        }
+
+        // Get the user preferences. We shouldn't show the feedback popup
+        // if we don't have permissions for that.
+        $user_preferences = Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences();
+
+        // Bail. We don't have preferences to show the popup.
+        if ( 'yes' !== $user_preferences ) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Render the feedback popup in the footer.
+     *
+     * @return  void
+     * @version 3.19.0
+     */
+    public function render_feedback_popup() {
+        // Bail if we don't have permissions to show the popup.
+        if ( ! $this->has_permission_to_show_popup() ) {
+            return;
+        }
+        // Include the partial.
+        include plugin_dir_path( __FILE__ ) . '../admin/partials/wordlift-admin-deactivation-feedback-popup.php';
+    }
+
+    /**
+     * Enqueue required popup scripts and styles.
+     *
+     * @return  void
+     * @version 3.19.0
+     */
+    public function enqueue_popup_scripts() {
+        // Bail if we don't have permissions to show the popup.
+        if ( ! $this->has_permission_to_show_popup() ) {
+            return;
+        }
+
+        wp_enqueue_style( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION );
+        wp_enqueue_script( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/js/wordlift-admin-feedback-popup.js', array( 'jquery' ), WORDLIFT_VERSION, false );
+    }
+
+    /**
+     * Handle the deactivation ajax call
+     * and perform a request to external server.
+     *
+     * @return  void
+     * @version 3.19.0
+     */
+    public function wl_deactivation_feedback() {
+        // Bail if the nonce is not valid.
+        if (
+            empty( $_POST['wl_deactivation_feedback_nonce'] ) || // The nonce doens't exists.
+            ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['wl_deactivation_feedback_nonce'] ) ), 'wl_deactivation_feedback_nonce' ) // The nonce is invalid.
+        ) {
+            wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
+        }
+
+        // We allow user to deactivate without providing a reason
+        // so bail and send success response.
+        if ( empty( $_POST['code'] ) ) {
+            wp_send_json_success();
+        }
+
+        $plugin_data = get_plugin_data( plugin_dir_path( __DIR__ ) . 'wordlift.php', false, false );
+
+        // Prepare the options.
+        $options = array(
+            // The deactivation reason.
+            'code'             => sanitize_text_field( wp_unslash( (string) $_POST['code'] ) ),
+            // Additional information if provided.
+            'details'          => ( ! empty( $_POST['details'] ) ) ? sanitize_text_field( wp_unslash( (string) $_POST['details'] ) ) : '',
+            // The website url.
+            'url'              => get_bloginfo( 'url' ),
+            // WP version.
+            'wordpressVersion' => get_bloginfo( 'version' ),
+            // WL version.
+            'wordliftVersion'  => $plugin_data['Version'],
+            // The admin email.
+            'email'            => get_bloginfo( 'admin_email' ),
+        );
+
+        $response = wp_remote_post(
+            Wordlift_Configuration_Service::get_instance()->get_deactivation_feedback_url(),
+            array(
+                'method'  => 'POST',
+                'body'    => wp_json_encode( $options ),
+                'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ),
+            )
+        );
+
+        $code    = wp_remote_retrieve_response_code( $response );
+        $message = wp_remote_retrieve_response_message( $response );
+
+        // Add message to the error log if the response code is not 200.
+        if ( 201 !== $code ) {
+            // Write the error in the logs.
+            $this->log->error( 'An error occurred while requesting a feedback endpoint error_code: ' . $code . ' message: ' . $message );
+        }
+
+        // We should send success message even when the feedback is not
+        // send, because otherwise the plugin cannot be deactivated.
+        wp_send_json_success();
+    }
 }

Spacing +24 added lines, -24 removed lines

@@ -37,7 +37,7 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Deactivator_Feedback' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Deactivator_Feedback');
 
 	}
 
@@ -53,7 +53,7 @@ 
 
 		// Bail if the user doesn't have permissions
 		// or if it's not the plugins page.
-		if ( 'plugins.php' !== $pagenow ) {
+		if ('plugins.php' !== $pagenow) {
 			return false;
 		}
 
@@ -62,7 +62,7 @@ 
 		$user_preferences = Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences();
 
 		// Bail. We don't have preferences to show the popup.
-		if ( 'yes' !== $user_preferences ) {
+		if ('yes' !== $user_preferences) {
 			return false;
 		}
 
@@ -77,11 +77,11 @@ 
 	 */
 	public function render_feedback_popup() {
 		// Bail if we don't have permissions to show the popup.
-		if ( ! $this->has_permission_to_show_popup() ) {
+		if ( ! $this->has_permission_to_show_popup()) {
 			return;
 		}
 		// Include the partial.
-		include plugin_dir_path( __FILE__ ) . '../admin/partials/wordlift-admin-deactivation-feedback-popup.php';
+		include plugin_dir_path(__FILE__).'../admin/partials/wordlift-admin-deactivation-feedback-popup.php';
 	}
 
 	/**
@@ -92,12 +92,12 @@ 
 	 */
 	public function enqueue_popup_scripts() {
 		// Bail if we don't have permissions to show the popup.
-		if ( ! $this->has_permission_to_show_popup() ) {
+		if ( ! $this->has_permission_to_show_popup()) {
 			return;
 		}
 
-		wp_enqueue_style( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION );
-		wp_enqueue_script( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/js/wordlift-admin-feedback-popup.js', array( 'jquery' ), WORDLIFT_VERSION, false );
+		wp_enqueue_style('wordlift-admin-feedback-popup', plugin_dir_url(__DIR__).'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION);
+		wp_enqueue_script('wordlift-admin-feedback-popup', plugin_dir_url(__DIR__).'admin/js/wordlift-admin-feedback-popup.js', array('jquery'), WORDLIFT_VERSION, false);
 	}
 
 	/**
@@ -110,52 +110,52 @@ 
 	public function wl_deactivation_feedback() {
 		// Bail if the nonce is not valid.
 		if (
-			empty( $_POST['wl_deactivation_feedback_nonce'] ) || // The nonce doens't exists.
-			! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['wl_deactivation_feedback_nonce'] ) ), 'wl_deactivation_feedback_nonce' ) // The nonce is invalid.
+			empty($_POST['wl_deactivation_feedback_nonce']) || // The nonce doens't exists.
+			! wp_verify_nonce(sanitize_text_field(wp_unslash($_POST['wl_deactivation_feedback_nonce'])), 'wl_deactivation_feedback_nonce') // The nonce is invalid.
 		) {
-			wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
+			wp_send_json_error(__('Nonce Security Check Failed!', 'wordlift'));
 		}
 
 		// We allow user to deactivate without providing a reason
 		// so bail and send success response.
-		if ( empty( $_POST['code'] ) ) {
+		if (empty($_POST['code'])) {
 			wp_send_json_success();
 		}
 
-		$plugin_data = get_plugin_data( plugin_dir_path( __DIR__ ) . 'wordlift.php', false, false );
+		$plugin_data = get_plugin_data(plugin_dir_path(__DIR__).'wordlift.php', false, false);
 
 		// Prepare the options.
 		$options = array(
 			// The deactivation reason.
-			'code'             => sanitize_text_field( wp_unslash( (string) $_POST['code'] ) ),
+			'code'             => sanitize_text_field(wp_unslash((string) $_POST['code'])),
 			// Additional information if provided.
-			'details'          => ( ! empty( $_POST['details'] ) ) ? sanitize_text_field( wp_unslash( (string) $_POST['details'] ) ) : '',
+			'details'          => ( ! empty($_POST['details'])) ? sanitize_text_field(wp_unslash((string) $_POST['details'])) : '',
 			// The website url.
-			'url'              => get_bloginfo( 'url' ),
+			'url'              => get_bloginfo('url'),
 			// WP version.
-			'wordpressVersion' => get_bloginfo( 'version' ),
+			'wordpressVersion' => get_bloginfo('version'),
 			// WL version.
 			'wordliftVersion'  => $plugin_data['Version'],
 			// The admin email.
-			'email'            => get_bloginfo( 'admin_email' ),
+			'email'            => get_bloginfo('admin_email'),
 		);
 
 		$response = wp_remote_post(
 			Wordlift_Configuration_Service::get_instance()->get_deactivation_feedback_url(),
 			array(
 				'method'  => 'POST',
-				'body'    => wp_json_encode( $options ),
-				'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ),
+				'body'    => wp_json_encode($options),
+				'headers' => array('Content-Type' => 'application/json; charset=utf-8'),
 			)
 		);
 
-		$code    = wp_remote_retrieve_response_code( $response );
-		$message = wp_remote_retrieve_response_message( $response );
+		$code    = wp_remote_retrieve_response_code($response);
+		$message = wp_remote_retrieve_response_message($response);
 
 		// Add message to the error log if the response code is not 200.
-		if ( 201 !== $code ) {
+		if (201 !== $code) {
 			// Write the error in the logs.
-			$this->log->error( 'An error occurred while requesting a feedback endpoint error_code: ' . $code . ' message: ' . $message );
+			$this->log->error('An error occurred while requesting a feedback endpoint error_code: '.$code.' message: '.$message);
 		}
 
 		// We should send success message even when the feedback is not

src/includes/class-wordlift-loader.php

Indentation +102 added lines, -102 removed lines

@@ -23,107 +23,107 @@
  */
 class Wordlift_Loader {
 
-	/**
-	 * The array of actions registered with WordPress.
-	 *
-	 * @since    1.0.0
-	 * @access   protected
-	 * @var      array    $actions    The actions registered with WordPress to fire when the plugin loads.
-	 */
-	protected $actions;
-
-	/**
-	 * The array of filters registered with WordPress.
-	 *
-	 * @since    1.0.0
-	 * @access   protected
-	 * @var      array    $filters    The filters registered with WordPress to fire when the plugin loads.
-	 */
-	protected $filters;
-
-	/**
-	 * Initialize the collections used to maintain the actions and filters.
-	 *
-	 * @since    1.0.0
-	 */
-	public function __construct() {
-
-		$this->actions = array();
-		$this->filters = array();
-
-	}
-
-	/**
-	 * Add a new action to the collection to be registered with WordPress.
-	 *
-	 * @since    1.0.0
-	 * @param    string $hook             The name of the WordPress action that is being registered.
-	 * @param    object $component        A reference to the instance of the object on which the action is defined.
-	 * @param    string $callback         The name of the function definition on the $component.
-	 * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
-	 * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1.
-	 */
-	public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
-		add_action( $hook, array( $component, $callback ), $priority, $accepted_args );
-	}
-
-	/**
-	 * Add a new filter to the collection to be registered with WordPress.
-	 *
-	 * @since    1.0.0
-	 * @param    string $hook             The name of the WordPress filter that is being registered.
-	 * @param    object $component        A reference to the instance of the object on which the filter is defined.
-	 * @param    string $callback         The name of the function definition on the $component.
-	 * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
-	 * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1
-	 */
-	public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
-		add_filter( $hook, array( $component, $callback ), $priority, $accepted_args );
-	}
-
-	/**
-	 * A utility function that is used to register the actions and hooks into a single
-	 * collection.
-	 *
-	 * @since    1.0.0
-	 * @access   private
-	 * @param    array  $hooks            The collection of hooks that is being registered (that is, actions or filters).
-	 * @param    string $hook             The name of the WordPress filter that is being registered.
-	 * @param    object $component        A reference to the instance of the object on which the filter is defined.
-	 * @param    string $callback         The name of the function definition on the $component.
-	 * @param    int    $priority         The priority at which the function should be fired.
-	 * @param    int    $accepted_args    The number of arguments that should be passed to the $callback.
-	 * @return   array                                  The collection of actions and filters registered with WordPress.
-	 */
-	private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {
-
-		$hooks[] = array(
-			'hook'          => $hook,
-			'component'     => $component,
-			'callback'      => $callback,
-			'priority'      => $priority,
-			'accepted_args' => $accepted_args,
-		);
-
-		return $hooks;
-
-	}
-
-	/**
-	 * Register the filters and actions with WordPress.
-	 *
-	 * @since    1.0.0
-	 */
-	public function run() {
-
-		foreach ( $this->filters as $hook ) {
-			add_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
-		}
-
-		foreach ( $this->actions as $hook ) {
-			add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
-		}
-
-	}
+    /**
+     * The array of actions registered with WordPress.
+     *
+     * @since    1.0.0
+     * @access   protected
+     * @var      array    $actions    The actions registered with WordPress to fire when the plugin loads.
+     */
+    protected $actions;
+
+    /**
+     * The array of filters registered with WordPress.
+     *
+     * @since    1.0.0
+     * @access   protected
+     * @var      array    $filters    The filters registered with WordPress to fire when the plugin loads.
+     */
+    protected $filters;
+
+    /**
+     * Initialize the collections used to maintain the actions and filters.
+     *
+     * @since    1.0.0
+     */
+    public function __construct() {
+
+        $this->actions = array();
+        $this->filters = array();
+
+    }
+
+    /**
+     * Add a new action to the collection to be registered with WordPress.
+     *
+     * @since    1.0.0
+     * @param    string $hook             The name of the WordPress action that is being registered.
+     * @param    object $component        A reference to the instance of the object on which the action is defined.
+     * @param    string $callback         The name of the function definition on the $component.
+     * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
+     * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1.
+     */
+    public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
+        add_action( $hook, array( $component, $callback ), $priority, $accepted_args );
+    }
+
+    /**
+     * Add a new filter to the collection to be registered with WordPress.
+     *
+     * @since    1.0.0
+     * @param    string $hook             The name of the WordPress filter that is being registered.
+     * @param    object $component        A reference to the instance of the object on which the filter is defined.
+     * @param    string $callback         The name of the function definition on the $component.
+     * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
+     * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1
+     */
+    public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
+        add_filter( $hook, array( $component, $callback ), $priority, $accepted_args );
+    }
+
+    /**
+     * A utility function that is used to register the actions and hooks into a single
+     * collection.
+     *
+     * @since    1.0.0
+     * @access   private
+     * @param    array  $hooks            The collection of hooks that is being registered (that is, actions or filters).
+     * @param    string $hook             The name of the WordPress filter that is being registered.
+     * @param    object $component        A reference to the instance of the object on which the filter is defined.
+     * @param    string $callback         The name of the function definition on the $component.
+     * @param    int    $priority         The priority at which the function should be fired.
+     * @param    int    $accepted_args    The number of arguments that should be passed to the $callback.
+     * @return   array                                  The collection of actions and filters registered with WordPress.
+     */
+    private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {
+
+        $hooks[] = array(
+            'hook'          => $hook,
+            'component'     => $component,
+            'callback'      => $callback,
+            'priority'      => $priority,
+            'accepted_args' => $accepted_args,
+        );
+
+        return $hooks;
+
+    }
+
+    /**
+     * Register the filters and actions with WordPress.
+     *
+     * @since    1.0.0
+     */
+    public function run() {
+
+        foreach ( $this->filters as $hook ) {
+            add_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
+        }
+
+        foreach ( $this->actions as $hook ) {
+            add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
+        }
+
+    }
 
 }

Spacing +9 added lines, -9 removed lines

@@ -63,8 +63,8 @@ 
 	 * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
 	 * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1.
 	 */
-	public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
-		add_action( $hook, array( $component, $callback ), $priority, $accepted_args );
+	public function add_action($hook, $component, $callback, $priority = 10, $accepted_args = 1) {
+		add_action($hook, array($component, $callback), $priority, $accepted_args);
 	}
 
 	/**
@@ -77,8 +77,8 @@ 
 	 * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
 	 * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1
 	 */
-	public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
-		add_filter( $hook, array( $component, $callback ), $priority, $accepted_args );
+	public function add_filter($hook, $component, $callback, $priority = 10, $accepted_args = 1) {
+		add_filter($hook, array($component, $callback), $priority, $accepted_args);
 	}
 
 	/**
@@ -95,7 +95,7 @@ 
 	 * @param    int    $accepted_args    The number of arguments that should be passed to the $callback.
 	 * @return   array                                  The collection of actions and filters registered with WordPress.
 	 */
-	private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {
+	private function add($hooks, $hook, $component, $callback, $priority, $accepted_args) {
 
 		$hooks[] = array(
 			'hook'          => $hook,
@@ -116,12 +116,12 @@ 
 	 */
 	public function run() {
 
-		foreach ( $this->filters as $hook ) {
-			add_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
+		foreach ($this->filters as $hook) {
+			add_filter($hook['hook'], array($hook['component'], $hook['callback']), $hook['priority'], $hook['accepted_args']);
 		}
 
-		foreach ( $this->actions as $hook ) {
-			add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
+		foreach ($this->actions as $hook) {
+			add_action($hook['hook'], array($hook['component'], $hook['callback']), $hook['priority'], $hook['accepted_args']);
 		}
 
 	}

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

Indentation +187 added lines, -187 removed lines

@@ -17,202 +17,202 @@
  */
 class Wordlift_Api_Service {
 
-	/**
-	 * The {@link Wordlift_Api_Service} singleton instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Api_Service $instance The singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * @var Api_Headers_Service|null
-	 */
-	private $headers_service;
-
-	/**
-	 * Create a {@link Wordlift_Api_Service} instance.
-	 *
-	 * @since 3.20.0
-	 */
-	public function __construct() {
-		self::$instance        = $this;
-		$this->headers_service = Api_Headers_Service::get_instance();
-	}
-
-	/**
-	 * Get the {@link Wordlift_Api_Service} singleton instance.
-	 *
-	 * @return \Wordlift_Api_Service The {@link Wordlift_Api_Service} singleton instance.
-	 * @since 3.20.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Perform a `GET` request towards the requested path.
-	 *
-	 * @param string $path The relative path.
-	 *
-	 * @return array|WP_Error
-	 * @since 3.20.0
-	 */
-	public function get( $path ) {
-
-		// Prepare the target URL.
-		$url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
-
-		// Get the response value.
-		$response = wp_remote_get(
-			$url,
-			array(
-				'user-agent' => User_Agent::get_user_agent(),
-				'headers'    => array(
-					'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(),
-				) + $this->headers_service->get_wp_headers(),
-				/*
+    /**
+     * The {@link Wordlift_Api_Service} singleton instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Api_Service $instance The singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * @var Api_Headers_Service|null
+     */
+    private $headers_service;
+
+    /**
+     * Create a {@link Wordlift_Api_Service} instance.
+     *
+     * @since 3.20.0
+     */
+    public function __construct() {
+        self::$instance        = $this;
+        $this->headers_service = Api_Headers_Service::get_instance();
+    }
+
+    /**
+     * Get the {@link Wordlift_Api_Service} singleton instance.
+     *
+     * @return \Wordlift_Api_Service The {@link Wordlift_Api_Service} singleton instance.
+     * @since 3.20.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Perform a `GET` request towards the requested path.
+     *
+     * @param string $path The relative path.
+     *
+     * @return array|WP_Error
+     * @since 3.20.0
+     */
+    public function get( $path ) {
+
+        // Prepare the target URL.
+        $url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
+
+        // Get the response value.
+        $response = wp_remote_get(
+            $url,
+            array(
+                'user-agent' => User_Agent::get_user_agent(),
+                'headers'    => array(
+                    'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(),
+                ) + $this->headers_service->get_wp_headers(),
+                /*
 				* Increase the timeout from the default of 5 to 30 secs.
 				*
 				* @see https://github.com/insideout10/wordlift-plugin/issues/906
 				*
 				* @since 3.20.1
 				*/
-				'timeout'    => 30,
-			)
-		);
-
-		return self::get_message_or_error( $response );
-	}
-
-	/**
-	 * Perform a `POST` request towards the requested path.
-	 *
-	 * @param string       $path The relative path.
-	 * @param array|object $body The request body (will be serialized to JSON).
-	 *
-	 * @return array|WP_Error
-	 * @since 3.20.0
-	 */
-	public function post( $path, $body ) {
-
-		return $this->post_custom_content_type(
-			$path,
-			wp_json_encode( $body ),
-			'application/json; ' . get_bloginfo( 'charset' )
-		);
-	}
-
-	public function post_custom_content_type( $path, $body, $content_type ) {
-
-		// Prepare the target URL.
-		$url = apply_filters( 'wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url() . $path );
-
-		// Give some time for the operation to complete, more than the time we give to the HTTP operation to complete.
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@set_time_limit( 90 );
-
-		// Get the response value.
-		$key      = Wordlift_Configuration_Service::get_instance()->get_key();
-		$response = wp_remote_post(
-			$url,
-			array(
-				'timeout'    => 60,
-				'user-agent' => User_Agent::get_user_agent(),
-				'headers'    => array(
-					'Content-Type'    => $content_type,
-					'X-Authorization' => $key,
-					'Authorization'   => "Key $key",
-					/*
+                'timeout'    => 30,
+            )
+        );
+
+        return self::get_message_or_error( $response );
+    }
+
+    /**
+     * Perform a `POST` request towards the requested path.
+     *
+     * @param string       $path The relative path.
+     * @param array|object $body The request body (will be serialized to JSON).
+     *
+     * @return array|WP_Error
+     * @since 3.20.0
+     */
+    public function post( $path, $body ) {
+
+        return $this->post_custom_content_type(
+            $path,
+            wp_json_encode( $body ),
+            'application/json; ' . get_bloginfo( 'charset' )
+        );
+    }
+
+    public function post_custom_content_type( $path, $body, $content_type ) {
+
+        // Prepare the target URL.
+        $url = apply_filters( 'wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url() . $path );
+
+        // Give some time for the operation to complete, more than the time we give to the HTTP operation to complete.
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @set_time_limit( 90 );
+
+        // Get the response value.
+        $key      = Wordlift_Configuration_Service::get_instance()->get_key();
+        $response = wp_remote_post(
+            $url,
+            array(
+                'timeout'    => 60,
+                'user-agent' => User_Agent::get_user_agent(),
+                'headers'    => array(
+                    'Content-Type'    => $content_type,
+                    'X-Authorization' => $key,
+                    'Authorization'   => "Key $key",
+                    /*
 					 * This is required to avoid CURL receiving 502 Bad Gateway errors.
 					 *
 					 * @see https://stackoverflow.com/questions/30601075/curl-to-google-compute-load-balancer-gets-error-502
 					 */
-					'Expect'          => '',
-				) + $this->headers_service->get_wp_headers(),
-				'body'       => $body,
-			)
-		);
-
-		return self::get_message_or_error( $response );
-	}
-
-	public function delete( $path ) {
-
-		// Prepare the target URL.
-		$url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
-
-		// Get the response value.
-		$response = wp_remote_request(
-			$url,
-			array(
-				'method'     => 'DELETE',
-				'user-agent' => User_Agent::get_user_agent(),
-				'headers'    => array(
-					'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(),
-				) + $this->headers_service->get_wp_headers(),
-			)
-		);
-
-		return self::get_message_or_error( $response );
-	}
-
-	/**
-	 * Return the {@link WP_Error} in case of error or the actual reply if successful.
-	 *
-	 * @param array|WP_Error $response The response of an http call.
-	 *
-	 * @return string|object|WP_Error A {@link WP_Error} instance or the actual response content.
-	 * @since 3.20.0
-	 */
-	private static function get_message_or_error( $response ) {
-
-		// Result is WP_Error.
-		if ( is_wp_error( $response ) ) {
-			return $response;
-		}
-
-		// `code` not set or not numeric.
-		$code = wp_remote_retrieve_response_code( $response );
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		$message = @wp_remote_retrieve_response_message( $response );
-
-		if ( empty( $code ) || ! is_numeric( $code ) ) {
-			return new WP_Error( 0, $message );
-		}
-
-		// Code not 2xx.
-		if ( 2 !== intval( $code / 100 ) ) {
-			return new WP_Error( $code, $message );
-		}
-
-		// Everything's fine, return the message.
-		return self::try_json_decode( $response );
-	}
-
-	/**
-	 * Try to decode the json response
-	 *
-	 * @param array $response The response array.
-	 *
-	 * @return array|mixed|object The decoded response or the original response body.
-	 * @since 3.20.0
-	 */
-	private static function try_json_decode( $response ) {
-
-		// Get the headers.
-		$content_type = wp_remote_retrieve_header( $response, 'content-type' );
-		$body         = wp_remote_retrieve_body( $response );
-
-		// If it's not an `application/json` return the plain response body.
-		if ( 0 !== strpos( strtolower( $content_type ), 'application/json' ) ) {
-			return $body;
-		}
-
-		// Decode and return the structured result.
-		return json_decode( $body );
-	}
+                    'Expect'          => '',
+                ) + $this->headers_service->get_wp_headers(),
+                'body'       => $body,
+            )
+        );
+
+        return self::get_message_or_error( $response );
+    }
+
+    public function delete( $path ) {
+
+        // Prepare the target URL.
+        $url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
+
+        // Get the response value.
+        $response = wp_remote_request(
+            $url,
+            array(
+                'method'     => 'DELETE',
+                'user-agent' => User_Agent::get_user_agent(),
+                'headers'    => array(
+                    'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(),
+                ) + $this->headers_service->get_wp_headers(),
+            )
+        );
+
+        return self::get_message_or_error( $response );
+    }
+
+    /**
+     * Return the {@link WP_Error} in case of error or the actual reply if successful.
+     *
+     * @param array|WP_Error $response The response of an http call.
+     *
+     * @return string|object|WP_Error A {@link WP_Error} instance or the actual response content.
+     * @since 3.20.0
+     */
+    private static function get_message_or_error( $response ) {
+
+        // Result is WP_Error.
+        if ( is_wp_error( $response ) ) {
+            return $response;
+        }
+
+        // `code` not set or not numeric.
+        $code = wp_remote_retrieve_response_code( $response );
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        $message = @wp_remote_retrieve_response_message( $response );
+
+        if ( empty( $code ) || ! is_numeric( $code ) ) {
+            return new WP_Error( 0, $message );
+        }
+
+        // Code not 2xx.
+        if ( 2 !== intval( $code / 100 ) ) {
+            return new WP_Error( $code, $message );
+        }
+
+        // Everything's fine, return the message.
+        return self::try_json_decode( $response );
+    }
+
+    /**
+     * Try to decode the json response
+     *
+     * @param array $response The response array.
+     *
+     * @return array|mixed|object The decoded response or the original response body.
+     * @since 3.20.0
+     */
+    private static function try_json_decode( $response ) {
+
+        // Get the headers.
+        $content_type = wp_remote_retrieve_header( $response, 'content-type' );
+        $body         = wp_remote_retrieve_body( $response );
+
+        // If it's not an `application/json` return the plain response body.
+        if ( 0 !== strpos( strtolower( $content_type ), 'application/json' ) ) {
+            return $body;
+        }
+
+        // Decode and return the structured result.
+        return json_decode( $body );
+    }
 
 }

Spacing +27 added lines, -27 removed lines

@@ -60,10 +60,10 @@ 
 	 * @return array|WP_Error
 	 * @since 3.20.0
 	 */
-	public function get( $path ) {
+	public function get($path) {
 
 		// Prepare the target URL.
-		$url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
+		$url = Wordlift_Configuration_Service::get_instance()->get_api_url().$path;
 
 		// Get the response value.
 		$response = wp_remote_get(
@@ -84,7 +84,7 @@ 
 			)
 		);
 
-		return self::get_message_or_error( $response );
+		return self::get_message_or_error($response);
 	}
 
 	/**
@@ -96,23 +96,23 @@ 
 	 * @return array|WP_Error
 	 * @since 3.20.0
 	 */
-	public function post( $path, $body ) {
+	public function post($path, $body) {
 
 		return $this->post_custom_content_type(
 			$path,
-			wp_json_encode( $body ),
-			'application/json; ' . get_bloginfo( 'charset' )
+			wp_json_encode($body),
+			'application/json; '.get_bloginfo('charset')
 		);
 	}
 
-	public function post_custom_content_type( $path, $body, $content_type ) {
+	public function post_custom_content_type($path, $body, $content_type) {
 
 		// Prepare the target URL.
-		$url = apply_filters( 'wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url() . $path );
+		$url = apply_filters('wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url().$path);
 
 		// Give some time for the operation to complete, more than the time we give to the HTTP operation to complete.
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@set_time_limit( 90 );
+		@set_time_limit(90);
 
 		// Get the response value.
 		$key      = Wordlift_Configuration_Service::get_instance()->get_key();
@@ -136,13 +136,13 @@ 
 			)
 		);
 
-		return self::get_message_or_error( $response );
+		return self::get_message_or_error($response);
 	}
 
-	public function delete( $path ) {
+	public function delete($path) {
 
 		// Prepare the target URL.
-		$url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
+		$url = Wordlift_Configuration_Service::get_instance()->get_api_url().$path;
 
 		// Get the response value.
 		$response = wp_remote_request(
@@ -156,7 +156,7 @@ 
 			)
 		);
 
-		return self::get_message_or_error( $response );
+		return self::get_message_or_error($response);
 	}
 
 	/**
@@ -167,29 +167,29 @@ 
 	 * @return string|object|WP_Error A {@link WP_Error} instance or the actual response content.
 	 * @since 3.20.0
 	 */
-	private static function get_message_or_error( $response ) {
+	private static function get_message_or_error($response) {
 
 		// Result is WP_Error.
-		if ( is_wp_error( $response ) ) {
+		if (is_wp_error($response)) {
 			return $response;
 		}
 
 		// `code` not set or not numeric.
-		$code = wp_remote_retrieve_response_code( $response );
+		$code = wp_remote_retrieve_response_code($response);
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		$message = @wp_remote_retrieve_response_message( $response );
+		$message = @wp_remote_retrieve_response_message($response);
 
-		if ( empty( $code ) || ! is_numeric( $code ) ) {
-			return new WP_Error( 0, $message );
+		if (empty($code) || ! is_numeric($code)) {
+			return new WP_Error(0, $message);
 		}
 
 		// Code not 2xx.
-		if ( 2 !== intval( $code / 100 ) ) {
-			return new WP_Error( $code, $message );
+		if (2 !== intval($code / 100)) {
+			return new WP_Error($code, $message);
 		}
 
 		// Everything's fine, return the message.
-		return self::try_json_decode( $response );
+		return self::try_json_decode($response);
 	}
 
 	/**
@@ -200,19 +200,19 @@ 
 	 * @return array|mixed|object The decoded response or the original response body.
 	 * @since 3.20.0
 	 */
-	private static function try_json_decode( $response ) {
+	private static function try_json_decode($response) {
 
 		// Get the headers.
-		$content_type = wp_remote_retrieve_header( $response, 'content-type' );
-		$body         = wp_remote_retrieve_body( $response );
+		$content_type = wp_remote_retrieve_header($response, 'content-type');
+		$body         = wp_remote_retrieve_body($response);
 
 		// If it's not an `application/json` return the plain response body.
-		if ( 0 !== strpos( strtolower( $content_type ), 'application/json' ) ) {
+		if (0 !== strpos(strtolower($content_type), 'application/json')) {
 			return $body;
 		}
 
 		// Decode and return the structured result.
-		return json_decode( $body );
+		return json_decode($body);
 	}
 
 }

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

Indentation +184 added lines, -184 removed lines

@@ -20,192 +20,192 @@
  */
 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...' );
-
-		return Default_Api_Service::get_instance()->get(
-			'/accounts/info',
-			array(
-				'Authorization' => "Key $key",
-			)
-		)->get_response();
-	}
-
-	/**
-	 * Check if key is valid
-	 *
-	 * @param $key string
-	 *
-	 * @return bool
-	 */
-	public function is_key_valid( $key ) {
-
-		$response = $this->get_account_info( $key );
-
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			return false;
-		}
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
-
-		$url = $res_body['url'];
-
-		// 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 === null || $url === $site_url ) {
-			return true;
-		}
-
-		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.' );
-		}
-
-		$response = $this->get_account_info( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) );  //phpcs:ignore WordPress.Security.NonceVerification.Missing
-
-		// If we got an error, return invalid.
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			wp_send_json_success(
-				array(
-					'valid'    => false,
-					'message'  => '',
-					'response' => $response,
-					'api_url'  => Default_Api_Service::get_instance()->get_base_url(),
-				)
-			);
-		}
-
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
-
-		// The URL stored in WLS. If this is the initial install the URL may be null.
-		$url = $res_body['url'];
-
-		// Considering that production URL may be filtered.
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
-
-		// If the URL isn't set or matches, then it's valid.
-		if ( $url === null || $url === $site_url ) {
-			// Invalidate the cache key
-			$this->ttl_cache_service->delete( 'is_key_valid' );
-			wp_send_json_success(
-				array(
-					'valid'   => true,
-					'message' => '',
-				)
-			);
-		}
-
-		// If the URL doesn't match it means that this key has been configured elsewhere already.
-		if ( $url !== $site_url ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			wp_send_json_success(
-				array(
-					'valid'   => false,
-					'message' => __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ),
-				)
-			);
-		}
-
-		// Set a response with valid set to true or false according to the key validity with message.
-		wp_send_json_success(
-			array(
-				'valid'   => false,
-				'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
-			)
-		);
-	}
-
-	/**
-	 * 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...' );
+
+        return Default_Api_Service::get_instance()->get(
+            '/accounts/info',
+            array(
+                'Authorization' => "Key $key",
+            )
+        )->get_response();
+    }
+
+    /**
+     * Check if key is valid
+     *
+     * @param $key string
+     *
+     * @return bool
+     */
+    public function is_key_valid( $key ) {
+
+        $response = $this->get_account_info( $key );
+
+        if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+            return false;
+        }
+        $res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+        $url = $res_body['url'];
+
+        // 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 === null || $url === $site_url ) {
+            return true;
+        }
+
+        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.' );
+        }
+
+        $response = $this->get_account_info( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) );  //phpcs:ignore WordPress.Security.NonceVerification.Missing
+
+        // If we got an error, return invalid.
+        if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+            wp_send_json_success(
+                array(
+                    'valid'    => false,
+                    'message'  => '',
+                    'response' => $response,
+                    'api_url'  => Default_Api_Service::get_instance()->get_base_url(),
+                )
+            );
+        }
+
+        $res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+        // The URL stored in WLS. If this is the initial install the URL may be null.
+        $url = $res_body['url'];
+
+        // Considering that production URL may be filtered.
+        $home_url = get_option( 'home' );
+        $site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+
+        // If the URL isn't set or matches, then it's valid.
+        if ( $url === null || $url === $site_url ) {
+            // Invalidate the cache key
+            $this->ttl_cache_service->delete( 'is_key_valid' );
+            wp_send_json_success(
+                array(
+                    'valid'   => true,
+                    'message' => '',
+                )
+            );
+        }
+
+        // If the URL doesn't match it means that this key has been configured elsewhere already.
+        if ( $url !== $site_url ) {
+            Wordlift_Configuration_Service::get_instance()->set_key( '' );
+            wp_send_json_success(
+                array(
+                    'valid'   => false,
+                    'message' => __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ),
+                )
+            );
+        }
+
+        // Set a response with valid set to true or false according to the key validity with message.
+        wp_send_json_success(
+            array(
+                'valid'   => false,
+                'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
+            )
+        );
+    }
+
+    /**
+     * 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 +37 added lines, -37 removed lines

@@ -41,9 +41,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.
 		 *
@@ -52,11 +52,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');
 
 	}
 
@@ -68,9 +68,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...');
 
 		return Default_Api_Service::get_instance()->get(
 			'/accounts/info',
@@ -87,21 +87,21 @@ 
 	 *
 	 * @return bool
 	 */
-	public function is_key_valid( $key ) {
+	public function is_key_valid($key) {
 
-		$response = $this->get_account_info( $key );
+		$response = $this->get_account_info($key);
 
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+		if (is_wp_error($response) || 2 !== (int) $response['response']['code'] / 100) {
 			return false;
 		}
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+		$res_body = json_decode(wp_remote_retrieve_body($response), true);
 
 		$url = $res_body['url'];
 
 		// 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 === null || $url === $site_url ) {
+		$home_url = get_option('home');
+		$site_url = apply_filters('wl_production_site_url', untrailingslashit($home_url));
+		if ($url === null || $url === $site_url) {
 			return true;
 		}
 
@@ -119,14 +119,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.');
 		}
 
-		$response = $this->get_account_info( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) );  //phpcs:ignore WordPress.Security.NonceVerification.Missing
+		$response = $this->get_account_info(sanitize_text_field(wp_unslash((string) $_POST['key']))); //phpcs:ignore WordPress.Security.NonceVerification.Missing
 
 		// If we got an error, return invalid.
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+		if (is_wp_error($response) || 2 !== (int) $response['response']['code'] / 100) {
 			wp_send_json_success(
 				array(
 					'valid'    => false,
@@ -137,19 +137,19 @@ 
 			);
 		}
 
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+		$res_body = json_decode(wp_remote_retrieve_body($response), true);
 
 		// The URL stored in WLS. If this is the initial install the URL may be null.
 		$url = $res_body['url'];
 
 		// 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 the URL isn't set or matches, then it's valid.
-		if ( $url === null || $url === $site_url ) {
+		if ($url === null || $url === $site_url) {
 			// Invalidate the cache key
-			$this->ttl_cache_service->delete( 'is_key_valid' );
+			$this->ttl_cache_service->delete('is_key_valid');
 			wp_send_json_success(
 				array(
 					'valid'   => true,
@@ -159,12 +159,12 @@ 
 		}
 
 		// If the URL doesn't match it means that this key has been configured elsewhere already.
-		if ( $url !== $site_url ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
+		if ($url !== $site_url) {
+			Wordlift_Configuration_Service::get_instance()->set_key('');
 			wp_send_json_success(
 				array(
 					'valid'   => false,
-					'message' => __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ),
+					'message' => __('The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift'),
 				)
 			);
 		}
@@ -173,7 +173,7 @@ 
 		wp_send_json_success(
 			array(
 				'valid'   => false,
-				'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
+				'message' => __('An error occurred, please contact us at hello@wordlift.io', 'wordlift'),
 			)
 		);
 	}
@@ -183,15 +183,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);
 		}
 
 	}
@@ -200,10 +200,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
 		}