insideout10 / wordlift-plugin

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

Indentation +227 added lines, -227 removed lines

@@ -18,235 +18,235 @@
  */
 class Wordlift_Publisher_Service {
 
-	protected function __construct() {
-
-	}
-
-	private static $instance = null;
-
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Counts the number of potential publishers.
-	 *
-	 * @return int The number of potential publishers.
-	 * @since 3.11.0
-	 */
-	public function count() {
-
-		// Search for entities which are either a Person
-		// or Organization.
-
-		// Get only the ids as all we need is the count.
-		$entities = get_posts(
-			array(
-				'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
-				'post_status'    => 'publish',
-				'posts_per_page' => - 1,
-				'tax_query'      => array(
-					array(
-						'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-						'field'    => 'slug',
-						'terms'    => array( 'organization', 'person' ),
-					),
-				),
-				'fields'         => 'ids',
-			)
-		);
-
-		// Finally return the count.
-		return count( $entities );
-	}
-
-	/**
-	 * Search SQL filter for matching against post title only.
-	 *
-	 * @link    http://wordpress.stackexchange.com/a/11826/1685
-	 *
-	 * @since   3.15.0
-	 *
-	 * @param string   $search The search string.
-	 * @param WP_Query $wp_query The {@link WP_Query} instance.
-	 *
-	 * @return array|string An array of results.
-	 */
-	public function limit_search_to_title( $search, $wp_query ) {
-
-		// Bail out if the search or the `search_terms` haven't been set.
-		if ( empty( $search ) || empty( $wp_query->query_vars['search_terms'] ) ) {
-			return $search;
-		}
-
-		global $wpdb;
-
-		$query_vars = $wp_query->query_vars;
-		$percent    = ! empty( $query_vars['exact'] ) ? '' : '%';
-		$search     = array();
-
-		foreach ( (array) $query_vars['search_terms'] as $term ) {
-			$search[] = $wpdb->prepare( "$wpdb->posts.post_title LIKE %s", $percent . $wpdb->esc_like( $term ) . $percent );
-		}
-
-		if ( ! is_user_logged_in() ) {
-			$search[] = "$wpdb->posts.post_password = ''";
-		}
-
-		$search = ' AND ' . implode( ' AND ', $search );
-
-		return $search;
-	}
-
-	/**
-	 * Query WP for potential publishers, i.e. {@link WP_Post}s which are associated`
-	 * with `wl_entity_type` (taxonomy) terms of `Organization` or `Person`.
-	 *
-	 * @param string $filter The title filter.
-	 *
-	 * @return array An array of results in a select2 friendly format.
-	 * @since 3.11.0
-	 */
-	public function query( $filter = '' ) {
-
-		// Search for the filter in the titles only.
-		add_filter(
-			'posts_search',
-			array(
-				$this,
-				'limit_search_to_title',
-			),
-			10,
-			2
-		);
-
-		/*
+    protected function __construct() {
+
+    }
+
+    private static $instance = null;
+
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Counts the number of potential publishers.
+     *
+     * @return int The number of potential publishers.
+     * @since 3.11.0
+     */
+    public function count() {
+
+        // Search for entities which are either a Person
+        // or Organization.
+
+        // Get only the ids as all we need is the count.
+        $entities = get_posts(
+            array(
+                'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
+                'post_status'    => 'publish',
+                'posts_per_page' => - 1,
+                'tax_query'      => array(
+                    array(
+                        'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                        'field'    => 'slug',
+                        'terms'    => array( 'organization', 'person' ),
+                    ),
+                ),
+                'fields'         => 'ids',
+            )
+        );
+
+        // Finally return the count.
+        return count( $entities );
+    }
+
+    /**
+     * Search SQL filter for matching against post title only.
+     *
+     * @link    http://wordpress.stackexchange.com/a/11826/1685
+     *
+     * @since   3.15.0
+     *
+     * @param string   $search The search string.
+     * @param WP_Query $wp_query The {@link WP_Query} instance.
+     *
+     * @return array|string An array of results.
+     */
+    public function limit_search_to_title( $search, $wp_query ) {
+
+        // Bail out if the search or the `search_terms` haven't been set.
+        if ( empty( $search ) || empty( $wp_query->query_vars['search_terms'] ) ) {
+            return $search;
+        }
+
+        global $wpdb;
+
+        $query_vars = $wp_query->query_vars;
+        $percent    = ! empty( $query_vars['exact'] ) ? '' : '%';
+        $search     = array();
+
+        foreach ( (array) $query_vars['search_terms'] as $term ) {
+            $search[] = $wpdb->prepare( "$wpdb->posts.post_title LIKE %s", $percent . $wpdb->esc_like( $term ) . $percent );
+        }
+
+        if ( ! is_user_logged_in() ) {
+            $search[] = "$wpdb->posts.post_password = ''";
+        }
+
+        $search = ' AND ' . implode( ' AND ', $search );
+
+        return $search;
+    }
+
+    /**
+     * Query WP for potential publishers, i.e. {@link WP_Post}s which are associated`
+     * with `wl_entity_type` (taxonomy) terms of `Organization` or `Person`.
+     *
+     * @param string $filter The title filter.
+     *
+     * @return array An array of results in a select2 friendly format.
+     * @since 3.11.0
+     */
+    public function query( $filter = '' ) {
+
+        // Search for the filter in the titles only.
+        add_filter(
+            'posts_search',
+            array(
+                $this,
+                'limit_search_to_title',
+            ),
+            10,
+            2
+        );
+
+        /*
 		 * Search for entities which are either a Person
 		 * or Organization. Sort the results by title in ascending order.
 		 */
-		$entities = get_posts(
-			array(
-				'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
-				'post_status'    => 'publish',
-				'posts_per_page' => - 1,
-				'tax_query'      => array(
-					array(
-						'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-						'field'    => 'slug',
-						'terms'    => array( 'organization', 'person' ),
-					),
-				),
-				's'              => $filter,
-				'orderby'        => 'title',
-				'order'          => 'ASC',
-			)
-		);
-
-		// Remove the search filter added before the query.
-		remove_filter(
-			'posts_search',
-			array(
-				$this,
-				'limit_search_to_title',
-			),
-			10,
-			2
-		);
-
-		// Set a reference to ourselves to pass to the closure.
-		$publisher_service = $this;
-
-		// Map the results in a `Select2` compatible array.
-		return array_map(
-			function ( $entity ) use ( $publisher_service ) {
-				$type     = wp_get_post_terms( $entity->ID, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-				$thumb_id = get_post_thumbnail_id( $entity->ID );
-
-				return array(
-					'id'            => $entity->ID,
-					'text'          => $entity->post_title,
-					'type'          => $type[0]->name,
-					'thumbnail_url' => $publisher_service->get_attachment_image_url( $thumb_id ),
-				);
-			},
-			$entities
-		);
-	}
-
-	/**
-	 * Get the thumbnail's URL.
-	 *
-	 * @param int    $attachment_id The attachment id.
-	 * @param string $size The attachment size (default = 'thumbnail').
-	 *
-	 * @return string|bool The image URL or false if not found.
-	 * @since 3.11.0
-	 */
-	public function get_attachment_image_url( $attachment_id, $size = 'thumbnail' ) {
-
-		$image = wp_get_attachment_image_src( $attachment_id, $size );
-
-		return isset( $image['0'] ) ? $image['0'] : false;
-	}
-
-	/**
-	 * Add additional instructions to featured image metabox
-	 * when the entity type is the publisher.
-	 *
-	 * @param string $content Current metabox content.
-	 *
-	 * @return string $content metabox content with additional instructions.
-	 * @since  3.19.0
-	 */
-	public function add_featured_image_instruction( $content ) {
-		// Get the current post ID.
-		$post_id = get_the_ID();
-
-		// Get the publisher id.
-		$publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
-
-		// Bail if for some reason the post id is not set.
-		if (
-			empty( $post_id ) ||
-			$post_id !== (int) $publisher_id
-		) {
-			return $content;
-		}
-
-		$terms = wp_get_post_terms(
-			$post_id, // The post id.
-			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, // The taxonomy slug.
-			array(
-				'fields' => 'slugs',
-				// We don't need all fields, but only slugs.
-			)
-		);
-
-		// Check that the entity type is "Organization".
-		if ( in_array( 'organization', $terms, true ) ) {
-			// Add the featured image description when the type is "Organization".
-
-			$link     = sprintf(
-				'<a target="_blank" href="%s">%s</a>',
-				esc_attr__( 'https://developers.google.com/search/docs/data-types/article#logo-guidelines', 'wordlift' ),
-				esc_html__( 'AMP logo guidelines', 'wordlift' )
-			);
-			$content .= sprintf(
-				'<p>'
-								/* translators: %s: AMP logo guidelines. */
-								 . esc_html_x( 'According to the %s, the logo should fit in a 60x600px rectangle, and either be exactly 60px high (preferred), or exactly 600px wide. For example, 450x45px would not be acceptable, even though it fits in the 600x60px rectangle. To comply with the guidelines, WordLift will automatically resize the Featured Image for structured data formats.', 'After "According to the" goes the link to the "AMP logo guidelines".', 'wordlift' )
-								 . '</p>',
-				$link
-			);
-		}
-
-		// Finally return the content.
-		return $content;
-	}
+        $entities = get_posts(
+            array(
+                'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
+                'post_status'    => 'publish',
+                'posts_per_page' => - 1,
+                'tax_query'      => array(
+                    array(
+                        'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                        'field'    => 'slug',
+                        'terms'    => array( 'organization', 'person' ),
+                    ),
+                ),
+                's'              => $filter,
+                'orderby'        => 'title',
+                'order'          => 'ASC',
+            )
+        );
+
+        // Remove the search filter added before the query.
+        remove_filter(
+            'posts_search',
+            array(
+                $this,
+                'limit_search_to_title',
+            ),
+            10,
+            2
+        );
+
+        // Set a reference to ourselves to pass to the closure.
+        $publisher_service = $this;
+
+        // Map the results in a `Select2` compatible array.
+        return array_map(
+            function ( $entity ) use ( $publisher_service ) {
+                $type     = wp_get_post_terms( $entity->ID, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+                $thumb_id = get_post_thumbnail_id( $entity->ID );
+
+                return array(
+                    'id'            => $entity->ID,
+                    'text'          => $entity->post_title,
+                    'type'          => $type[0]->name,
+                    'thumbnail_url' => $publisher_service->get_attachment_image_url( $thumb_id ),
+                );
+            },
+            $entities
+        );
+    }
+
+    /**
+     * Get the thumbnail's URL.
+     *
+     * @param int    $attachment_id The attachment id.
+     * @param string $size The attachment size (default = 'thumbnail').
+     *
+     * @return string|bool The image URL or false if not found.
+     * @since 3.11.0
+     */
+    public function get_attachment_image_url( $attachment_id, $size = 'thumbnail' ) {
+
+        $image = wp_get_attachment_image_src( $attachment_id, $size );
+
+        return isset( $image['0'] ) ? $image['0'] : false;
+    }
+
+    /**
+     * Add additional instructions to featured image metabox
+     * when the entity type is the publisher.
+     *
+     * @param string $content Current metabox content.
+     *
+     * @return string $content metabox content with additional instructions.
+     * @since  3.19.0
+     */
+    public function add_featured_image_instruction( $content ) {
+        // Get the current post ID.
+        $post_id = get_the_ID();
+
+        // Get the publisher id.
+        $publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
+
+        // Bail if for some reason the post id is not set.
+        if (
+            empty( $post_id ) ||
+            $post_id !== (int) $publisher_id
+        ) {
+            return $content;
+        }
+
+        $terms = wp_get_post_terms(
+            $post_id, // The post id.
+            Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, // The taxonomy slug.
+            array(
+                'fields' => 'slugs',
+                // We don't need all fields, but only slugs.
+            )
+        );
+
+        // Check that the entity type is "Organization".
+        if ( in_array( 'organization', $terms, true ) ) {
+            // Add the featured image description when the type is "Organization".
+
+            $link     = sprintf(
+                '<a target="_blank" href="%s">%s</a>',
+                esc_attr__( 'https://developers.google.com/search/docs/data-types/article#logo-guidelines', 'wordlift' ),
+                esc_html__( 'AMP logo guidelines', 'wordlift' )
+            );
+            $content .= sprintf(
+                '<p>'
+                                /* translators: %s: AMP logo guidelines. */
+                                    . esc_html_x( 'According to the %s, the logo should fit in a 60x600px rectangle, and either be exactly 60px high (preferred), or exactly 600px wide. For example, 450x45px would not be acceptable, even though it fits in the 600x60px rectangle. To comply with the guidelines, WordLift will automatically resize the Featured Image for structured data formats.', 'After "According to the" goes the link to the "AMP logo guidelines".', 'wordlift' )
+                                    . '</p>',
+                $link
+            );
+        }
+
+        // Finally return the content.
+        return $content;
+    }
 
 }

Spacing +28 added lines, -28 removed lines

@@ -26,7 +26,7 @@ 
 
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -49,12 +49,12 @@ 
 			array(
 				'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
 				'post_status'    => 'publish',
-				'posts_per_page' => - 1,
+				'posts_per_page' => -1,
 				'tax_query'      => array(
 					array(
 						'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
 						'field'    => 'slug',
-						'terms'    => array( 'organization', 'person' ),
+						'terms'    => array('organization', 'person'),
 					),
 				),
 				'fields'         => 'ids',
@@ -62,7 +62,7 @@ 
 		);
 
 		// Finally return the count.
-		return count( $entities );
+		return count($entities);
 	}
 
 	/**
@@ -77,28 +77,28 @@ 
 	 *
 	 * @return array|string An array of results.
 	 */
-	public function limit_search_to_title( $search, $wp_query ) {
+	public function limit_search_to_title($search, $wp_query) {
 
 		// Bail out if the search or the `search_terms` haven't been set.
-		if ( empty( $search ) || empty( $wp_query->query_vars['search_terms'] ) ) {
+		if (empty($search) || empty($wp_query->query_vars['search_terms'])) {
 			return $search;
 		}
 
 		global $wpdb;
 
 		$query_vars = $wp_query->query_vars;
-		$percent    = ! empty( $query_vars['exact'] ) ? '' : '%';
+		$percent    = ! empty($query_vars['exact']) ? '' : '%';
 		$search     = array();
 
-		foreach ( (array) $query_vars['search_terms'] as $term ) {
-			$search[] = $wpdb->prepare( "$wpdb->posts.post_title LIKE %s", $percent . $wpdb->esc_like( $term ) . $percent );
+		foreach ((array) $query_vars['search_terms'] as $term) {
+			$search[] = $wpdb->prepare("$wpdb->posts.post_title LIKE %s", $percent.$wpdb->esc_like($term).$percent);
 		}
 
-		if ( ! is_user_logged_in() ) {
+		if ( ! is_user_logged_in()) {
 			$search[] = "$wpdb->posts.post_password = ''";
 		}
 
-		$search = ' AND ' . implode( ' AND ', $search );
+		$search = ' AND '.implode(' AND ', $search);
 
 		return $search;
 	}
@@ -112,7 +112,7 @@ 
 	 * @return array An array of results in a select2 friendly format.
 	 * @since 3.11.0
 	 */
-	public function query( $filter = '' ) {
+	public function query($filter = '') {
 
 		// Search for the filter in the titles only.
 		add_filter(
@@ -133,12 +133,12 @@ 
 			array(
 				'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
 				'post_status'    => 'publish',
-				'posts_per_page' => - 1,
+				'posts_per_page' => -1,
 				'tax_query'      => array(
 					array(
 						'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
 						'field'    => 'slug',
-						'terms'    => array( 'organization', 'person' ),
+						'terms'    => array('organization', 'person'),
 					),
 				),
 				's'              => $filter,
@@ -163,15 +163,15 @@ 
 
 		// Map the results in a `Select2` compatible array.
 		return array_map(
-			function ( $entity ) use ( $publisher_service ) {
-				$type     = wp_get_post_terms( $entity->ID, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-				$thumb_id = get_post_thumbnail_id( $entity->ID );
+			function($entity) use ($publisher_service) {
+				$type     = wp_get_post_terms($entity->ID, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME);
+				$thumb_id = get_post_thumbnail_id($entity->ID);
 
 				return array(
 					'id'            => $entity->ID,
 					'text'          => $entity->post_title,
 					'type'          => $type[0]->name,
-					'thumbnail_url' => $publisher_service->get_attachment_image_url( $thumb_id ),
+					'thumbnail_url' => $publisher_service->get_attachment_image_url($thumb_id),
 				);
 			},
 			$entities
@@ -187,11 +187,11 @@ 
 	 * @return string|bool The image URL or false if not found.
 	 * @since 3.11.0
 	 */
-	public function get_attachment_image_url( $attachment_id, $size = 'thumbnail' ) {
+	public function get_attachment_image_url($attachment_id, $size = 'thumbnail') {
 
-		$image = wp_get_attachment_image_src( $attachment_id, $size );
+		$image = wp_get_attachment_image_src($attachment_id, $size);
 
-		return isset( $image['0'] ) ? $image['0'] : false;
+		return isset($image['0']) ? $image['0'] : false;
 	}
 
 	/**
@@ -203,7 +203,7 @@ 
 	 * @return string $content metabox content with additional instructions.
 	 * @since  3.19.0
 	 */
-	public function add_featured_image_instruction( $content ) {
+	public function add_featured_image_instruction($content) {
 		// Get the current post ID.
 		$post_id = get_the_ID();
 
@@ -212,7 +212,7 @@ 
 
 		// Bail if for some reason the post id is not set.
 		if (
-			empty( $post_id ) ||
+			empty($post_id) ||
 			$post_id !== (int) $publisher_id
 		) {
 			return $content;
@@ -228,18 +228,18 @@ 
 		);
 
 		// Check that the entity type is "Organization".
-		if ( in_array( 'organization', $terms, true ) ) {
+		if (in_array('organization', $terms, true)) {
 			// Add the featured image description when the type is "Organization".
 
-			$link     = sprintf(
+			$link = sprintf(
 				'<a target="_blank" href="%s">%s</a>',
-				esc_attr__( 'https://developers.google.com/search/docs/data-types/article#logo-guidelines', 'wordlift' ),
-				esc_html__( 'AMP logo guidelines', 'wordlift' )
+				esc_attr__('https://developers.google.com/search/docs/data-types/article#logo-guidelines', 'wordlift'),
+				esc_html__('AMP logo guidelines', 'wordlift')
 			);
 			$content .= sprintf(
 				'<p>'
 								/* translators: %s: AMP logo guidelines. */
-								 . esc_html_x( 'According to the %s, the logo should fit in a 60x600px rectangle, and either be exactly 60px high (preferred), or exactly 600px wide. For example, 450x45px would not be acceptable, even though it fits in the 600x60px rectangle. To comply with the guidelines, WordLift will automatically resize the Featured Image for structured data formats.', 'After "According to the" goes the link to the "AMP logo guidelines".', 'wordlift' )
+								 . esc_html_x('According to the %s, the logo should fit in a 60x600px rectangle, and either be exactly 60px high (preferred), or exactly 600px wide. For example, 450x45px would not be acceptable, even though it fits in the 600x60px rectangle. To comply with the guidelines, WordLift will automatically resize the Featured Image for structured data formats.', 'After "According to the" goes the link to the "AMP logo guidelines".', 'wordlift')
 								 . '</p>',
 				$link
 			);

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

Indentation +188 added lines, -188 removed lines

@@ -20,199 +20,199 @@
  */
 class Wordlift_Uri_Service {
 
-	/**
-	 * The title regex to sanitize titles in paths.
-	 *
-	 * According to RFC2396 (http://www.ietf.org/rfc/rfc2396.txt) these characters are reserved:
-	 * ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
-	 * "$" | ","
-	 *
-	 * We also remove the space and the UTF-8 BOM sequence.
-	 *
-	 * @since 3.7.1
-	 */
-	const INVALID_CHARACTERS = "/[ ;\\/?:@&=\\+\\\$,]|(?:\\xEF\\xBB\\xBF)/";
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The global WordPress database connection.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var \wpdb $wpdb The global WordPress database connection.
-	 */
-	private $wpdb;
-
-	/**
-	 * The {@link Wordlift_Uri_Service} singleton instance.
-	 *
-	 * @since  3.7.2
-	 * @access private
-	 * @var \Wordlift_Uri_Service The {@link Wordlift_Uri_Service} singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * Create an instance of Wordlift_Uri_Service.
-	 *
-	 * @param \wpdb $wpdb The global WordPress database connection.
-	 *
-	 * @since 3.6.0
-	 */
-	public function __construct( $wpdb ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Uri_Service' );
-
-		$this->wpdb = $wpdb;
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the {@link Wordlift_Uri_Service} singleton instance.
-	 *
-	 * @return \Wordlift_Uri_Service The {@link Wordlift_Uri_Service} singleton instance.
-	 * @since 3.7.2
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Sanitizes an URI path by replacing the not allowed characters with an underscore.
-	 *
-	 * @param string $path The path to sanitize.
-	 * @param string $char The replacement character (by default an underscore).
-	 *
-	 * @return string The sanitized path.
-	 * @since 3.7.2
-	 * @uses  sanitize_title() to manage not ASCII chars
-	 *
-	 * @see   https://codex.wordpress.org/Function_Reference/sanitize_title
-	 */
-	public function sanitize_path( $path, $char = '_' ) {
-
-		// Ensure the path is ASCII.
-		// see https://github.com/insideout10/wordlift-plugin/issues/386
-		// $path_ascii = mb_convert_encoding( $path, 'ASCII' );
-
-		return sanitize_title( preg_replace( self::INVALID_CHARACTERS, $char, stripslashes( $path ) ) );
-	}
-
-	/**
-	 * Build an entity uri for a given title. The uri is composed using a given
-	 * post_type and a title. If already exists an entity e2 with a given uri a
-	 * numeric suffix is added. If a schema type is given entities with same label
-	 * and same type are overridden.
-	 *
-	 * @param string  $title A post title.
-	 * @param string  $post_type A post type. Default value is 'entity'
-	 * @param string  $schema_type A schema org type.
-	 * @param integer $increment_digit A digit used to call recursively the same function.
-	 *
-	 * @return string Returns an uri.
-	 * @deprecated don't use anywhere else, since we're refactoring the way URIs are built in the global function wl_build_entity_uri.
-	 * @since 3.5.0
-	 */
-	public function build_uri( $title, $post_type, $schema_type = null, $increment_digit = 0 ) {
-
-		// Get the entity slug suffix digit
-		$suffix_digit = $increment_digit + 1;
-
-		// Get a sanitized uri for a given title.
-		/*
+    /**
+     * The title regex to sanitize titles in paths.
+     *
+     * According to RFC2396 (http://www.ietf.org/rfc/rfc2396.txt) these characters are reserved:
+     * ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
+     * "$" | ","
+     *
+     * We also remove the space and the UTF-8 BOM sequence.
+     *
+     * @since 3.7.1
+     */
+    const INVALID_CHARACTERS = "/[ ;\\/?:@&=\\+\\\$,]|(?:\\xEF\\xBB\\xBF)/";
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The global WordPress database connection.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var \wpdb $wpdb The global WordPress database connection.
+     */
+    private $wpdb;
+
+    /**
+     * The {@link Wordlift_Uri_Service} singleton instance.
+     *
+     * @since  3.7.2
+     * @access private
+     * @var \Wordlift_Uri_Service The {@link Wordlift_Uri_Service} singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * Create an instance of Wordlift_Uri_Service.
+     *
+     * @param \wpdb $wpdb The global WordPress database connection.
+     *
+     * @since 3.6.0
+     */
+    public function __construct( $wpdb ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Uri_Service' );
+
+        $this->wpdb = $wpdb;
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the {@link Wordlift_Uri_Service} singleton instance.
+     *
+     * @return \Wordlift_Uri_Service The {@link Wordlift_Uri_Service} singleton instance.
+     * @since 3.7.2
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Sanitizes an URI path by replacing the not allowed characters with an underscore.
+     *
+     * @param string $path The path to sanitize.
+     * @param string $char The replacement character (by default an underscore).
+     *
+     * @return string The sanitized path.
+     * @since 3.7.2
+     * @uses  sanitize_title() to manage not ASCII chars
+     *
+     * @see   https://codex.wordpress.org/Function_Reference/sanitize_title
+     */
+    public function sanitize_path( $path, $char = '_' ) {
+
+        // Ensure the path is ASCII.
+        // see https://github.com/insideout10/wordlift-plugin/issues/386
+        // $path_ascii = mb_convert_encoding( $path, 'ASCII' );
+
+        return sanitize_title( preg_replace( self::INVALID_CHARACTERS, $char, stripslashes( $path ) ) );
+    }
+
+    /**
+     * Build an entity uri for a given title. The uri is composed using a given
+     * post_type and a title. If already exists an entity e2 with a given uri a
+     * numeric suffix is added. If a schema type is given entities with same label
+     * and same type are overridden.
+     *
+     * @param string  $title A post title.
+     * @param string  $post_type A post type. Default value is 'entity'
+     * @param string  $schema_type A schema org type.
+     * @param integer $increment_digit A digit used to call recursively the same function.
+     *
+     * @return string Returns an uri.
+     * @deprecated don't use anywhere else, since we're refactoring the way URIs are built in the global function wl_build_entity_uri.
+     * @since 3.5.0
+     */
+    public function build_uri( $title, $post_type, $schema_type = null, $increment_digit = 0 ) {
+
+        // Get the entity slug suffix digit
+        $suffix_digit = $increment_digit + 1;
+
+        // Get a sanitized uri for a given title.
+        /*
 		 * The call takes into consideration URL encoding.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/885
 		 *
 		 * @since 3.20.0
 		 */
-		$entity_slug = urldecode( wl_sanitize_uri_path( $title ) )
-					   . ( 0 === $increment_digit ? '' : '_' . $suffix_digit );
-
-		// Compose a candidate uri.
-		$new_entity_uri = sprintf(
-			'%s/%s/%s',
-			untrailingslashit( wl_configuration_get_redlink_dataset_uri() ),
-			$post_type,
-			$entity_slug
-		);
-
-		$this->log->trace( "Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]" );
-
-		$content = Wordpress_Content_Service::get_instance()->get_by_entity_id( $new_entity_uri );
-		$post_id = $content && is_a( $content->get_bag(), '\WP_Post' ) ? $content->get_bag()->ID : null;
-
-		// If the post does not exist, then the new uri is returned
-		if ( ! is_numeric( $post_id ) ) {
-			$this->log->trace( "Going to return uri [ new_entity_uri :: $new_entity_uri ]" );
-
-			return $new_entity_uri;
-		}
-
-		// If schema_type is equal to schema org type of post x, then the new uri is returned
-		$schema_post_type = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
-
-		// @todo: we shouldn't rely on css classes to take such decisions.
-		if ( $schema_type === $schema_post_type['css_class'] ) {
-			$this->log->trace( "An entity with the same title and type already exists! Return uri [ new_entity_uri :: $new_entity_uri ]" );
-
-			return $new_entity_uri;
-		}
-
-		// Otherwise the same function is called recursively
-		return $this->build_uri( $title, $post_type, $schema_type, ++ $increment_digit );
-	}
-
-	/**
-	 *
-	 * @param string  $title A post title.
-	 * @param string  $taxonomy A post type. Default value is 'entity'
-	 * @param integer $increment_digit A digit used to call recursively the same function.
-	 *
-	 * @return string Returns an uri.
-	 * @since 3.32.0
-	 */
-	public function build_term_uri( $title, $taxonomy, $increment_digit = 0 ) {
-
-		// Get the entity slug suffix digit
-		$suffix_digit = $increment_digit + 1;
-
-		$entity_slug = urldecode( $title )
-					   . ( 0 === $increment_digit ? '' : '_' . $suffix_digit );
-
-		// Compose a candidate uri.
-		$new_entity_uri = sprintf(
-			'%s/term/%s/%s',
-			Wordlift_Configuration_Service::get_instance()->get_dataset_uri(),
-			$taxonomy,
-			$entity_slug
-		);
-
-		$this->log->trace( "Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]" );
-
-		$content = Wordpress_Term_Content_Service::get_instance()->get_by_entity_id( $new_entity_uri );
-		$term_id = $content ? $content->get_bag()->term_id : null;
-
-		// If the post does not exist, then the new uri is returned
-		if ( ! is_numeric( $term_id ) ) {
-			$this->log->trace( "Going to return uri [ new_term_entity_uri :: $new_entity_uri ]" );
-
-			return $new_entity_uri;
-		}
-
-		// Otherwise the same function is called recursively
-		return $this->build_term_uri( $title, $taxonomy, ++ $increment_digit );
-	}
+        $entity_slug = urldecode( wl_sanitize_uri_path( $title ) )
+                        . ( 0 === $increment_digit ? '' : '_' . $suffix_digit );
+
+        // Compose a candidate uri.
+        $new_entity_uri = sprintf(
+            '%s/%s/%s',
+            untrailingslashit( wl_configuration_get_redlink_dataset_uri() ),
+            $post_type,
+            $entity_slug
+        );
+
+        $this->log->trace( "Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]" );
+
+        $content = Wordpress_Content_Service::get_instance()->get_by_entity_id( $new_entity_uri );
+        $post_id = $content && is_a( $content->get_bag(), '\WP_Post' ) ? $content->get_bag()->ID : null;
+
+        // If the post does not exist, then the new uri is returned
+        if ( ! is_numeric( $post_id ) ) {
+            $this->log->trace( "Going to return uri [ new_entity_uri :: $new_entity_uri ]" );
+
+            return $new_entity_uri;
+        }
+
+        // If schema_type is equal to schema org type of post x, then the new uri is returned
+        $schema_post_type = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
+
+        // @todo: we shouldn't rely on css classes to take such decisions.
+        if ( $schema_type === $schema_post_type['css_class'] ) {
+            $this->log->trace( "An entity with the same title and type already exists! Return uri [ new_entity_uri :: $new_entity_uri ]" );
+
+            return $new_entity_uri;
+        }
+
+        // Otherwise the same function is called recursively
+        return $this->build_uri( $title, $post_type, $schema_type, ++ $increment_digit );
+    }
+
+    /**
+     *
+     * @param string  $title A post title.
+     * @param string  $taxonomy A post type. Default value is 'entity'
+     * @param integer $increment_digit A digit used to call recursively the same function.
+     *
+     * @return string Returns an uri.
+     * @since 3.32.0
+     */
+    public function build_term_uri( $title, $taxonomy, $increment_digit = 0 ) {
+
+        // Get the entity slug suffix digit
+        $suffix_digit = $increment_digit + 1;
+
+        $entity_slug = urldecode( $title )
+                        . ( 0 === $increment_digit ? '' : '_' . $suffix_digit );
+
+        // Compose a candidate uri.
+        $new_entity_uri = sprintf(
+            '%s/term/%s/%s',
+            Wordlift_Configuration_Service::get_instance()->get_dataset_uri(),
+            $taxonomy,
+            $entity_slug
+        );
+
+        $this->log->trace( "Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]" );
+
+        $content = Wordpress_Term_Content_Service::get_instance()->get_by_entity_id( $new_entity_uri );
+        $term_id = $content ? $content->get_bag()->term_id : null;
+
+        // If the post does not exist, then the new uri is returned
+        if ( ! is_numeric( $term_id ) ) {
+            $this->log->trace( "Going to return uri [ new_term_entity_uri :: $new_entity_uri ]" );
+
+            return $new_entity_uri;
+        }
+
+        // Otherwise the same function is called recursively
+        return $this->build_term_uri( $title, $taxonomy, ++ $increment_digit );
+    }
 
 }

Spacing +25 added lines, -25 removed lines

@@ -67,9 +67,9 @@ 
 	 *
 	 * @since 3.6.0
 	 */
-	public function __construct( $wpdb ) {
+	public function __construct($wpdb) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Uri_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Uri_Service');
 
 		$this->wpdb = $wpdb;
 
@@ -100,13 +100,13 @@ 
 	 *
 	 * @see   https://codex.wordpress.org/Function_Reference/sanitize_title
 	 */
-	public function sanitize_path( $path, $char = '_' ) {
+	public function sanitize_path($path, $char = '_') {
 
 		// Ensure the path is ASCII.
 		// see https://github.com/insideout10/wordlift-plugin/issues/386
 		// $path_ascii = mb_convert_encoding( $path, 'ASCII' );
 
-		return sanitize_title( preg_replace( self::INVALID_CHARACTERS, $char, stripslashes( $path ) ) );
+		return sanitize_title(preg_replace(self::INVALID_CHARACTERS, $char, stripslashes($path)));
 	}
 
 	/**
@@ -124,7 +124,7 @@ 
 	 * @deprecated don't use anywhere else, since we're refactoring the way URIs are built in the global function wl_build_entity_uri.
 	 * @since 3.5.0
 	 */
-	public function build_uri( $title, $post_type, $schema_type = null, $increment_digit = 0 ) {
+	public function build_uri($title, $post_type, $schema_type = null, $increment_digit = 0) {
 
 		// Get the entity slug suffix digit
 		$suffix_digit = $increment_digit + 1;
@@ -137,41 +137,41 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$entity_slug = urldecode( wl_sanitize_uri_path( $title ) )
-					   . ( 0 === $increment_digit ? '' : '_' . $suffix_digit );
+		$entity_slug = urldecode(wl_sanitize_uri_path($title))
+					   . (0 === $increment_digit ? '' : '_'.$suffix_digit);
 
 		// Compose a candidate uri.
 		$new_entity_uri = sprintf(
 			'%s/%s/%s',
-			untrailingslashit( wl_configuration_get_redlink_dataset_uri() ),
+			untrailingslashit(wl_configuration_get_redlink_dataset_uri()),
 			$post_type,
 			$entity_slug
 		);
 
-		$this->log->trace( "Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]" );
+		$this->log->trace("Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]");
 
-		$content = Wordpress_Content_Service::get_instance()->get_by_entity_id( $new_entity_uri );
-		$post_id = $content && is_a( $content->get_bag(), '\WP_Post' ) ? $content->get_bag()->ID : null;
+		$content = Wordpress_Content_Service::get_instance()->get_by_entity_id($new_entity_uri);
+		$post_id = $content && is_a($content->get_bag(), '\WP_Post') ? $content->get_bag()->ID : null;
 
 		// If the post does not exist, then the new uri is returned
-		if ( ! is_numeric( $post_id ) ) {
-			$this->log->trace( "Going to return uri [ new_entity_uri :: $new_entity_uri ]" );
+		if ( ! is_numeric($post_id)) {
+			$this->log->trace("Going to return uri [ new_entity_uri :: $new_entity_uri ]");
 
 			return $new_entity_uri;
 		}
 
 		// If schema_type is equal to schema org type of post x, then the new uri is returned
-		$schema_post_type = Wordlift_Entity_Type_Service::get_instance()->get( $post_id );
+		$schema_post_type = Wordlift_Entity_Type_Service::get_instance()->get($post_id);
 
 		// @todo: we shouldn't rely on css classes to take such decisions.
-		if ( $schema_type === $schema_post_type['css_class'] ) {
-			$this->log->trace( "An entity with the same title and type already exists! Return uri [ new_entity_uri :: $new_entity_uri ]" );
+		if ($schema_type === $schema_post_type['css_class']) {
+			$this->log->trace("An entity with the same title and type already exists! Return uri [ new_entity_uri :: $new_entity_uri ]");
 
 			return $new_entity_uri;
 		}
 
 		// Otherwise the same function is called recursively
-		return $this->build_uri( $title, $post_type, $schema_type, ++ $increment_digit );
+		return $this->build_uri($title, $post_type, $schema_type, ++ $increment_digit);
 	}
 
 	/**
@@ -183,13 +183,13 @@ 
 	 * @return string Returns an uri.
 	 * @since 3.32.0
 	 */
-	public function build_term_uri( $title, $taxonomy, $increment_digit = 0 ) {
+	public function build_term_uri($title, $taxonomy, $increment_digit = 0) {
 
 		// Get the entity slug suffix digit
 		$suffix_digit = $increment_digit + 1;
 
-		$entity_slug = urldecode( $title )
-					   . ( 0 === $increment_digit ? '' : '_' . $suffix_digit );
+		$entity_slug = urldecode($title)
+					   . (0 === $increment_digit ? '' : '_'.$suffix_digit);
 
 		// Compose a candidate uri.
 		$new_entity_uri = sprintf(
@@ -199,20 +199,20 @@ 
 			$entity_slug
 		);
 
-		$this->log->trace( "Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]" );
+		$this->log->trace("Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]");
 
-		$content = Wordpress_Term_Content_Service::get_instance()->get_by_entity_id( $new_entity_uri );
+		$content = Wordpress_Term_Content_Service::get_instance()->get_by_entity_id($new_entity_uri);
 		$term_id = $content ? $content->get_bag()->term_id : null;
 
 		// If the post does not exist, then the new uri is returned
-		if ( ! is_numeric( $term_id ) ) {
-			$this->log->trace( "Going to return uri [ new_term_entity_uri :: $new_entity_uri ]" );
+		if ( ! is_numeric($term_id)) {
+			$this->log->trace("Going to return uri [ new_term_entity_uri :: $new_entity_uri ]");
 
 			return $new_entity_uri;
 		}
 
 		// Otherwise the same function is called recursively
-		return $this->build_term_uri( $title, $taxonomy, ++ $increment_digit );
+		return $this->build_term_uri($title, $taxonomy, ++ $increment_digit);
 	}
 
 }

src/includes/class-wordlift-batch-action.php

Indentation +47 added lines, -47 removed lines

@@ -8,61 +8,61 @@
 
 class Wordlift_Batch_Action {
 
-	public static function process( $post_type, $offset, $query, $callback ) {
+    public static function process( $post_type, $offset, $query, $callback ) {
 
-		$posts_per_page = 10;
+        $posts_per_page = 10;
 
-		$args = array_merge(
-			self::get_args( $post_type, $query ),
-			array(
-				'offset'         => $offset,
-				'posts_per_page' => $posts_per_page,
-			)
-		);
+        $args = array_merge(
+            self::get_args( $post_type, $query ),
+            array(
+                'offset'         => $offset,
+                'posts_per_page' => $posts_per_page,
+            )
+        );
 
-		$post_ids = get_posts( $args );
+        $post_ids = get_posts( $args );
 
-		foreach ( $post_ids as $post_id ) {
-			call_user_func( $callback, $post_id );
-		}
+        foreach ( $post_ids as $post_id ) {
+            call_user_func( $callback, $post_id );
+        }
 
-		return array(
-			'current' => $offset,
-			'next'    => $offset + $posts_per_page,
-			'count'   => self::count( $post_type, $query ),
-		);
-	}
+        return array(
+            'current' => $offset,
+            'next'    => $offset + $posts_per_page,
+            'count'   => self::count( $post_type, $query ),
+        );
+    }
 
-	public static function count( $post_type, $query ) {
-		$args = array_merge(
-			self::get_args( $post_type, $query ),
-			array(
-				'posts_per_page' => - 1,
-			)
-		);
+    public static function count( $post_type, $query ) {
+        $args = array_merge(
+            self::get_args( $post_type, $query ),
+            array(
+                'posts_per_page' => - 1,
+            )
+        );
 
-		return count( get_posts( $args ) );
-	}
+        return count( get_posts( $args ) );
+    }
 
-	private static function get_args( $post_type, $query ) {
+    private static function get_args( $post_type, $query ) {
 
-		return array_merge(
-			array(
-				'fields'        => 'ids',
-				'post_type'     => $post_type,
-				'post_status'   => array(
-					'publish',
-					'future',
-					'draft',
-					'pending',
-					'private',
-					'auto-draft',
-					'inherit',
-				),
-				'cache_results' => false,
-			),
-			$query
-		);
-	}
+        return array_merge(
+            array(
+                'fields'        => 'ids',
+                'post_type'     => $post_type,
+                'post_status'   => array(
+                    'publish',
+                    'future',
+                    'draft',
+                    'pending',
+                    'private',
+                    'auto-draft',
+                    'inherit',
+                ),
+                'cache_results' => false,
+            ),
+            $query
+        );
+    }
 
 }

Spacing +11 added lines, -11 removed lines

@@ -8,43 +8,43 @@
 
 class Wordlift_Batch_Action {
 
-	public static function process( $post_type, $offset, $query, $callback ) {
+	public static function process($post_type, $offset, $query, $callback) {
 
 		$posts_per_page = 10;
 
 		$args = array_merge(
-			self::get_args( $post_type, $query ),
+			self::get_args($post_type, $query),
 			array(
 				'offset'         => $offset,
 				'posts_per_page' => $posts_per_page,
 			)
 		);
 
-		$post_ids = get_posts( $args );
+		$post_ids = get_posts($args);
 
-		foreach ( $post_ids as $post_id ) {
-			call_user_func( $callback, $post_id );
+		foreach ($post_ids as $post_id) {
+			call_user_func($callback, $post_id);
 		}
 
 		return array(
 			'current' => $offset,
 			'next'    => $offset + $posts_per_page,
-			'count'   => self::count( $post_type, $query ),
+			'count'   => self::count($post_type, $query),
 		);
 	}
 
-	public static function count( $post_type, $query ) {
+	public static function count($post_type, $query) {
 		$args = array_merge(
-			self::get_args( $post_type, $query ),
+			self::get_args($post_type, $query),
 			array(
-				'posts_per_page' => - 1,
+				'posts_per_page' => -1,
 			)
 		);
 
-		return count( get_posts( $args ) );
+		return count(get_posts($args));
 	}
 
-	private static function get_args( $post_type, $query ) {
+	private static function get_args($post_type, $query) {
 
 		return array_merge(
 			array(

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

Indentation +184 added lines, -184 removed lines

@@ -25,194 +25,194 @@
  */
 class Wordlift_Entity_Link_Service {
 
-	/**
-	 * The entity type service.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var Wordlift_Entity_Post_Type_Service $entity_type_service The entity type service.
-	 */
-	private $entity_type_service;
-
-	/**
-	 * The entity post type slug.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var string $slug The entity post type slug.
-	 */
-	private $slug;
-
-	/**
-	 * A logger instance.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var Wordlift_Log_Service
-	 */
-	private $log;
-
-	/**
-	 * Wordlift_Entity_Link_Service constructor.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param Wordlift_Entity_Post_Type_Service $entity_type_service
-	 * @param string                            $slug The entity post type slug.
-	 */
-	public function __construct( $entity_type_service, $slug ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Link_Service' );
-
-		$this->entity_type_service = $entity_type_service;
-		$this->slug                = $slug;
-
-	}
-
-	/**
-	 * Intercept link generation to posts in order to customize links to entities.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param string  $post_link The post's permalink.
-	 * @param WP_Post $post      The post in question.
-	 *
-	 * @return string The link to the post.
-	 */
-	public function post_type_link( $post_link, $post ) {
-
-		// Return the post link if this is not our post type.
-		if ( ! empty( $this->slug ) || $this->entity_type_service->get_post_type() !== get_post_type( $post ) ) {
-			return $post_link;
-		}
-
-		// Replace /slug/post_name/ with /post_name/
-		// The slug comes from the Entity Type Service since that service is responsible for registering the default
-		// slug.
-		return str_replace( "/{$this->entity_type_service->get_slug()}/$post->post_name/", "/$post->post_name/", $post_link );
-	}
-
-	/**
-	 * Alter the query to look for our own custom type.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param WP_Query $query
-	 */
-	public function pre_get_posts( $query ) {
-
-		// If a slug has been set, we don't need to alter the query.
-		if ( ! empty( $this->slug ) ) {
-			return;
-		}
-
-		// Check if it's a query we should extend with our own custom post type.
-		//
-		// The `$query->query` count could be > 2 if the preview parameter is passed too.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/439
-		if ( ! $query->is_main_query() || 2 > count( $query->query ) || ! isset( $query->query['page'] ) || empty( $query->query['name'] ) ) {
-			return;
-		}
-
-		// Add our own post type to the query.
-		$post_types = '' === $query->get( 'post_type' )
-			? Wordlift_Entity_Service::valid_entity_post_types()
-			: array_merge( (array) $query->get( 'post_type' ), (array) $this->entity_type_service->get_post_type() );
-		$query->set( 'post_type', $post_types );
-
-	}
-
-	/**
-	 * Hook to WordPress' wp_unique_post_slug_is_bad_flat_slug filter. This is called when a page is saved.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param bool   $bad_slug  Whether the post slug would be bad as a flat slug.
-	 * @param string $slug      The post slug.
-	 * @param string $post_type Post type.
-	 *
-	 * @return bool Whether the slug is bad.
-	 */
-	public function wp_unique_post_slug_is_bad_flat_slug( $bad_slug, $slug, $post_type ) {
-
-		// The list of post types that might have conflicting slugs.
-		$post_types = Wordlift_Entity_Service::valid_entity_post_types();
-
-		// Ignore post types different from the ones we need to check.
-		if ( ! in_array( $post_type, $post_types, true ) ) {
-			return $bad_slug;
-		}
-
-		// We remove the request post type since WordPress is already checking that the slug doesn't conflict.
-		$exists = $this->slug_exists( $slug, array_diff( $post_types, array( $post_type ) ) );
-
-		$this->log->debug( "Checking if a slug exists [ post type :: $post_type ][ slug :: $slug ][ exists :: " . ( $exists ? 'yes' : 'no' ) . ' ]' );
-
-		return apply_filters( 'wl_unique_post_slug_is_bad_flat_slug', $exists, $bad_slug, $slug, $post_type );
-	}
-
-	/**
-	 * Check whether a slug exists already for the specified post types.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param string $slug       The slug.
-	 * @param array  $post_types An array of post types.
-	 *
-	 * @return bool True if the slug exists, otherwise false.
-	 */
-	private function slug_exists( $slug, $post_types ) {
-		global $wpdb;
-
-		// Loop through all post types and check
-		// whether they have archive pages and if
-		// the archive slug matches the post slug.
-		//
-		// Note that the condition below checks only post types used by WordLift.
-		// We don't check other post types for archive pages,
-		// because this is a job of WordPress.
-		//
-		// There is a open ticket that should solve this, when it's merged:
-		// https://core.trac.wordpress.org/ticket/13459
-		$all_post_types = Wordlift_Entity_Service::valid_entity_post_types();
-		foreach ( $all_post_types as $post_type ) {
-
-			// Get the post type object for current post type.
-			$post_type_object = get_post_type_object( $post_type );
-
-			if (
-				// Check whether the post type object is not empty.
-				! empty( $post_type_object ) &&
-				// And the post type has archive page.
-				$post_type_object->has_archive &&
-				// And `rewrite` options exists..
-				! empty( $post_type_object->rewrite ) &&
-				// And the `rewrite` slug property is not empty.
-				! empty( $post_type_object->rewrite['slug'] ) &&
-				// And if the rewrite slug equals to the slug.
-				$post_type_object->rewrite['slug'] === $slug
-			) {
-				// Return true which means that the slug is already in use.
-				return true;
-			}
-		}
-
-		return null !== $wpdb->get_var(
-			$wpdb->prepare(
-				sprintf(
-					"SELECT post_name
+    /**
+     * The entity type service.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var Wordlift_Entity_Post_Type_Service $entity_type_service The entity type service.
+     */
+    private $entity_type_service;
+
+    /**
+     * The entity post type slug.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var string $slug The entity post type slug.
+     */
+    private $slug;
+
+    /**
+     * A logger instance.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var Wordlift_Log_Service
+     */
+    private $log;
+
+    /**
+     * Wordlift_Entity_Link_Service constructor.
+     *
+     * @since 3.6.0
+     *
+     * @param Wordlift_Entity_Post_Type_Service $entity_type_service
+     * @param string                            $slug The entity post type slug.
+     */
+    public function __construct( $entity_type_service, $slug ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Link_Service' );
+
+        $this->entity_type_service = $entity_type_service;
+        $this->slug                = $slug;
+
+    }
+
+    /**
+     * Intercept link generation to posts in order to customize links to entities.
+     *
+     * @since 3.6.0
+     *
+     * @param string  $post_link The post's permalink.
+     * @param WP_Post $post      The post in question.
+     *
+     * @return string The link to the post.
+     */
+    public function post_type_link( $post_link, $post ) {
+
+        // Return the post link if this is not our post type.
+        if ( ! empty( $this->slug ) || $this->entity_type_service->get_post_type() !== get_post_type( $post ) ) {
+            return $post_link;
+        }
+
+        // Replace /slug/post_name/ with /post_name/
+        // The slug comes from the Entity Type Service since that service is responsible for registering the default
+        // slug.
+        return str_replace( "/{$this->entity_type_service->get_slug()}/$post->post_name/", "/$post->post_name/", $post_link );
+    }
+
+    /**
+     * Alter the query to look for our own custom type.
+     *
+     * @since 3.6.0
+     *
+     * @param WP_Query $query
+     */
+    public function pre_get_posts( $query ) {
+
+        // If a slug has been set, we don't need to alter the query.
+        if ( ! empty( $this->slug ) ) {
+            return;
+        }
+
+        // Check if it's a query we should extend with our own custom post type.
+        //
+        // The `$query->query` count could be > 2 if the preview parameter is passed too.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/439
+        if ( ! $query->is_main_query() || 2 > count( $query->query ) || ! isset( $query->query['page'] ) || empty( $query->query['name'] ) ) {
+            return;
+        }
+
+        // Add our own post type to the query.
+        $post_types = '' === $query->get( 'post_type' )
+            ? Wordlift_Entity_Service::valid_entity_post_types()
+            : array_merge( (array) $query->get( 'post_type' ), (array) $this->entity_type_service->get_post_type() );
+        $query->set( 'post_type', $post_types );
+
+    }
+
+    /**
+     * Hook to WordPress' wp_unique_post_slug_is_bad_flat_slug filter. This is called when a page is saved.
+     *
+     * @since 3.6.0
+     *
+     * @param bool   $bad_slug  Whether the post slug would be bad as a flat slug.
+     * @param string $slug      The post slug.
+     * @param string $post_type Post type.
+     *
+     * @return bool Whether the slug is bad.
+     */
+    public function wp_unique_post_slug_is_bad_flat_slug( $bad_slug, $slug, $post_type ) {
+
+        // The list of post types that might have conflicting slugs.
+        $post_types = Wordlift_Entity_Service::valid_entity_post_types();
+
+        // Ignore post types different from the ones we need to check.
+        if ( ! in_array( $post_type, $post_types, true ) ) {
+            return $bad_slug;
+        }
+
+        // We remove the request post type since WordPress is already checking that the slug doesn't conflict.
+        $exists = $this->slug_exists( $slug, array_diff( $post_types, array( $post_type ) ) );
+
+        $this->log->debug( "Checking if a slug exists [ post type :: $post_type ][ slug :: $slug ][ exists :: " . ( $exists ? 'yes' : 'no' ) . ' ]' );
+
+        return apply_filters( 'wl_unique_post_slug_is_bad_flat_slug', $exists, $bad_slug, $slug, $post_type );
+    }
+
+    /**
+     * Check whether a slug exists already for the specified post types.
+     *
+     * @since 3.6.0
+     *
+     * @param string $slug       The slug.
+     * @param array  $post_types An array of post types.
+     *
+     * @return bool True if the slug exists, otherwise false.
+     */
+    private function slug_exists( $slug, $post_types ) {
+        global $wpdb;
+
+        // Loop through all post types and check
+        // whether they have archive pages and if
+        // the archive slug matches the post slug.
+        //
+        // Note that the condition below checks only post types used by WordLift.
+        // We don't check other post types for archive pages,
+        // because this is a job of WordPress.
+        //
+        // There is a open ticket that should solve this, when it's merged:
+        // https://core.trac.wordpress.org/ticket/13459
+        $all_post_types = Wordlift_Entity_Service::valid_entity_post_types();
+        foreach ( $all_post_types as $post_type ) {
+
+            // Get the post type object for current post type.
+            $post_type_object = get_post_type_object( $post_type );
+
+            if (
+                // Check whether the post type object is not empty.
+                ! empty( $post_type_object ) &&
+                // And the post type has archive page.
+                $post_type_object->has_archive &&
+                // And `rewrite` options exists..
+                ! empty( $post_type_object->rewrite ) &&
+                // And the `rewrite` slug property is not empty.
+                ! empty( $post_type_object->rewrite['slug'] ) &&
+                // And if the rewrite slug equals to the slug.
+                $post_type_object->rewrite['slug'] === $slug
+            ) {
+                // Return true which means that the slug is already in use.
+                return true;
+            }
+        }
+
+        return null !== $wpdb->get_var(
+            $wpdb->prepare(
+                sprintf(
+                    "SELECT post_name
 			FROM $wpdb->posts
 			WHERE post_name = %s
 			AND post_type IN (%s)
 			LIMIT 1
 			",
-					'%s',
-					implode( ',', array_fill( 0, count( $post_types ), '%s' ) )
-				),
-				array_merge( array( $slug ), $post_types )
-			)
-		);
-	}
+                    '%s',
+                    implode( ',', array_fill( 0, count( $post_types ), '%s' ) )
+                ),
+                array_merge( array( $slug ), $post_types )
+            )
+        );
+    }
 
 }

Spacing +24 added lines, -24 removed lines

@@ -60,9 +60,9 @@ 
 	 * @param Wordlift_Entity_Post_Type_Service $entity_type_service
 	 * @param string                            $slug The entity post type slug.
 	 */
-	public function __construct( $entity_type_service, $slug ) {
+	public function __construct($entity_type_service, $slug) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Link_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Entity_Link_Service');
 
 		$this->entity_type_service = $entity_type_service;
 		$this->slug                = $slug;
@@ -79,17 +79,17 @@ 
 	 *
 	 * @return string The link to the post.
 	 */
-	public function post_type_link( $post_link, $post ) {
+	public function post_type_link($post_link, $post) {
 
 		// Return the post link if this is not our post type.
-		if ( ! empty( $this->slug ) || $this->entity_type_service->get_post_type() !== get_post_type( $post ) ) {
+		if ( ! empty($this->slug) || $this->entity_type_service->get_post_type() !== get_post_type($post)) {
 			return $post_link;
 		}
 
 		// Replace /slug/post_name/ with /post_name/
 		// The slug comes from the Entity Type Service since that service is responsible for registering the default
 		// slug.
-		return str_replace( "/{$this->entity_type_service->get_slug()}/$post->post_name/", "/$post->post_name/", $post_link );
+		return str_replace("/{$this->entity_type_service->get_slug()}/$post->post_name/", "/$post->post_name/", $post_link);
 	}
 
 	/**
@@ -99,10 +99,10 @@ 
 	 *
 	 * @param WP_Query $query
 	 */
-	public function pre_get_posts( $query ) {
+	public function pre_get_posts($query) {
 
 		// If a slug has been set, we don't need to alter the query.
-		if ( ! empty( $this->slug ) ) {
+		if ( ! empty($this->slug)) {
 			return;
 		}
 
@@ -111,15 +111,15 @@ 
 		// The `$query->query` count could be > 2 if the preview parameter is passed too.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/439
-		if ( ! $query->is_main_query() || 2 > count( $query->query ) || ! isset( $query->query['page'] ) || empty( $query->query['name'] ) ) {
+		if ( ! $query->is_main_query() || 2 > count($query->query) || ! isset($query->query['page']) || empty($query->query['name'])) {
 			return;
 		}
 
 		// Add our own post type to the query.
-		$post_types = '' === $query->get( 'post_type' )
+		$post_types = '' === $query->get('post_type')
 			? Wordlift_Entity_Service::valid_entity_post_types()
-			: array_merge( (array) $query->get( 'post_type' ), (array) $this->entity_type_service->get_post_type() );
-		$query->set( 'post_type', $post_types );
+			: array_merge((array) $query->get('post_type'), (array) $this->entity_type_service->get_post_type());
+		$query->set('post_type', $post_types);
 
 	}
 
@@ -134,22 +134,22 @@ 
 	 *
 	 * @return bool Whether the slug is bad.
 	 */
-	public function wp_unique_post_slug_is_bad_flat_slug( $bad_slug, $slug, $post_type ) {
+	public function wp_unique_post_slug_is_bad_flat_slug($bad_slug, $slug, $post_type) {
 
 		// The list of post types that might have conflicting slugs.
 		$post_types = Wordlift_Entity_Service::valid_entity_post_types();
 
 		// Ignore post types different from the ones we need to check.
-		if ( ! in_array( $post_type, $post_types, true ) ) {
+		if ( ! in_array($post_type, $post_types, true)) {
 			return $bad_slug;
 		}
 
 		// We remove the request post type since WordPress is already checking that the slug doesn't conflict.
-		$exists = $this->slug_exists( $slug, array_diff( $post_types, array( $post_type ) ) );
+		$exists = $this->slug_exists($slug, array_diff($post_types, array($post_type)));
 
-		$this->log->debug( "Checking if a slug exists [ post type :: $post_type ][ slug :: $slug ][ exists :: " . ( $exists ? 'yes' : 'no' ) . ' ]' );
+		$this->log->debug("Checking if a slug exists [ post type :: $post_type ][ slug :: $slug ][ exists :: ".($exists ? 'yes' : 'no').' ]');
 
-		return apply_filters( 'wl_unique_post_slug_is_bad_flat_slug', $exists, $bad_slug, $slug, $post_type );
+		return apply_filters('wl_unique_post_slug_is_bad_flat_slug', $exists, $bad_slug, $slug, $post_type);
 	}
 
 	/**
@@ -162,7 +162,7 @@ 
 	 *
 	 * @return bool True if the slug exists, otherwise false.
 	 */
-	private function slug_exists( $slug, $post_types ) {
+	private function slug_exists($slug, $post_types) {
 		global $wpdb;
 
 		// Loop through all post types and check
@@ -176,20 +176,20 @@ 
 		// There is a open ticket that should solve this, when it's merged:
 		// https://core.trac.wordpress.org/ticket/13459
 		$all_post_types = Wordlift_Entity_Service::valid_entity_post_types();
-		foreach ( $all_post_types as $post_type ) {
+		foreach ($all_post_types as $post_type) {
 
 			// Get the post type object for current post type.
-			$post_type_object = get_post_type_object( $post_type );
+			$post_type_object = get_post_type_object($post_type);
 
 			if (
 				// Check whether the post type object is not empty.
-				! empty( $post_type_object ) &&
+				! empty($post_type_object) &&
 				// And the post type has archive page.
 				$post_type_object->has_archive &&
 				// And `rewrite` options exists..
-				! empty( $post_type_object->rewrite ) &&
+				! empty($post_type_object->rewrite) &&
 				// And the `rewrite` slug property is not empty.
-				! empty( $post_type_object->rewrite['slug'] ) &&
+				! empty($post_type_object->rewrite['slug']) &&
 				// And if the rewrite slug equals to the slug.
 				$post_type_object->rewrite['slug'] === $slug
 			) {
@@ -208,9 +208,9 @@ 
 			LIMIT 1
 			",
 					'%s',
-					implode( ',', array_fill( 0, count( $post_types ), '%s' ) )
+					implode(',', array_fill(0, count($post_types), '%s'))
 				),
-				array_merge( array( $slug ), $post_types )
+				array_merge(array($slug), $post_types)
 			)
 		);
 	}

src/includes/batch/class-wordlift-batch-operation-ajax-adapter.php

Indentation +138 added lines, -138 removed lines

@@ -14,143 +14,143 @@
  */
 class Wordlift_Batch_Operation_Ajax_Adapter {
 
-	/**
-	 * The access levels.
-	 *
-	 * @since 3.20.0
-	 */
-	const ACCESS_ANONYMOUS = 1;
-	const ACCESS_ADMIN     = 2;
-	const ACCESS_ALL       = 3;
-
-	/**
-	 * A {@link Wordlift_Batch_Operation_Interface} instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Batch_Operation_Interface $operation A {@link Wordlift_Batch_Operation_Interface} instance.
-	 */
-	private $operation;
-
-	/**
-	 * The ajax action name.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var string $action The ajax action name.
-	 */
-	private $action;
-
-	/**
-	 * Wordlift_Batch_Operation_Ajax_Adapter constructor.
-	 *
-	 * @param \Wordlift_Batch_Operation_Interface $operation The batch operation.
-	 * @param string                              $action The action name.
-	 * @param int                                 $access The access level.
-	 */
-	public function __construct( $operation, $action, $access = self::ACCESS_ADMIN ) {
-
-		$this->operation = $operation;
-
-		if ( $access & self::ACCESS_ADMIN ) {
-			add_action( "wp_ajax_$action", array( $this, 'process' ) );
-			add_action( "wp_ajax_{$action}_count", array( $this, 'count' ) );
-
-			// Add the nonce for the `schemaorg_sync` action.
-			add_filter( 'wl_admin_settings', array( $this, 'add_nonce' ) );
-		}
-
-		if ( $access & self::ACCESS_ANONYMOUS ) {
-			add_action( "wp_ajax_nopriv_$action", array( $this, 'process' ) );
-			add_action( "wp_ajax_nopriv_{$action}_count", array( $this, 'count' ) );
-		}
-
-		$this->action = $action;
-	}
-
-	/**
-	 * Hook to `wl_admin_settings`, adds the nonce.
-	 *
-	 * @param array $params An array of settings.
-	 *
-	 * @return array The updated array of settings.
-	 * @since 3.20.0
-	 */
-	public function add_nonce( $params ) {
-
-		return array_merge(
-			$params,
-			array(
-				"{$this->action}_nonce" => $this->create_nonce(),
-			)
-		);
-	}
-
-	/**
-	 * Process the requested operation.
-	 *
-	 * @since 3.20.0
-	 */
-	public function process() {
-		$nonce = isset( $_POST['_nonce'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['_nonce'] ) ) : '';
-		// Validate the nonce.
-		if ( ! wp_verify_nonce( $nonce, $this->action ) ) {
-			wp_send_json_error( 'Invalid nonce.' );
-		}
-
-		$offset = isset( $_POST['offset'] ) ? (int) $_POST['offset'] : 0;
-		$limit  = isset( $_POST['limit'] ) ? (int) $_POST['limit'] : 10;
-
-		// Run the batch operation.
-		$result = $this->operation->process( $offset, $limit );
-
-		// Send the results along with a potentially updated nonce.
-		wp_send_json_success(
-			array_merge(
-				$result,
-				array(
-					'_nonce' => $this->create_nonce(),
-				)
-			)
-		);
-
-	}
-
-	/**
-	 * Count the number of elements that would be affected by the operation.
-	 *
-	 * @since 3.20.0
-	 */
-	public function count() {
-
-		// Validate the nonce.
-		$nonce = isset( $_POST['_nonce'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['_nonce'] ) ) : '';
-		if ( ! wp_verify_nonce( $nonce, $this->action ) ) {
-			wp_send_json_error( 'Invalid nonce.' );
-		}
-
-		// Run the batch operation.
-		$result = $this->operation->count();
-
-		// Send the results along with a potentially updated nonce.
-		wp_send_json_success(
-			array(
-				'count'  => $result,
-				'_nonce' => $this->create_nonce(),
-			)
-		);
-
-	}
-
-	/**
-	 * Create a nonce for the ajax operation.
-	 *
-	 * @return string The nonce.
-	 * @since 3.20.0
-	 */
-	public function create_nonce() {
-
-		return wp_create_nonce( $this->action );
-	}
+    /**
+     * The access levels.
+     *
+     * @since 3.20.0
+     */
+    const ACCESS_ANONYMOUS = 1;
+    const ACCESS_ADMIN     = 2;
+    const ACCESS_ALL       = 3;
+
+    /**
+     * A {@link Wordlift_Batch_Operation_Interface} instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Batch_Operation_Interface $operation A {@link Wordlift_Batch_Operation_Interface} instance.
+     */
+    private $operation;
+
+    /**
+     * The ajax action name.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var string $action The ajax action name.
+     */
+    private $action;
+
+    /**
+     * Wordlift_Batch_Operation_Ajax_Adapter constructor.
+     *
+     * @param \Wordlift_Batch_Operation_Interface $operation The batch operation.
+     * @param string                              $action The action name.
+     * @param int                                 $access The access level.
+     */
+    public function __construct( $operation, $action, $access = self::ACCESS_ADMIN ) {
+
+        $this->operation = $operation;
+
+        if ( $access & self::ACCESS_ADMIN ) {
+            add_action( "wp_ajax_$action", array( $this, 'process' ) );
+            add_action( "wp_ajax_{$action}_count", array( $this, 'count' ) );
+
+            // Add the nonce for the `schemaorg_sync` action.
+            add_filter( 'wl_admin_settings', array( $this, 'add_nonce' ) );
+        }
+
+        if ( $access & self::ACCESS_ANONYMOUS ) {
+            add_action( "wp_ajax_nopriv_$action", array( $this, 'process' ) );
+            add_action( "wp_ajax_nopriv_{$action}_count", array( $this, 'count' ) );
+        }
+
+        $this->action = $action;
+    }
+
+    /**
+     * Hook to `wl_admin_settings`, adds the nonce.
+     *
+     * @param array $params An array of settings.
+     *
+     * @return array The updated array of settings.
+     * @since 3.20.0
+     */
+    public function add_nonce( $params ) {
+
+        return array_merge(
+            $params,
+            array(
+                "{$this->action}_nonce" => $this->create_nonce(),
+            )
+        );
+    }
+
+    /**
+     * Process the requested operation.
+     *
+     * @since 3.20.0
+     */
+    public function process() {
+        $nonce = isset( $_POST['_nonce'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['_nonce'] ) ) : '';
+        // Validate the nonce.
+        if ( ! wp_verify_nonce( $nonce, $this->action ) ) {
+            wp_send_json_error( 'Invalid nonce.' );
+        }
+
+        $offset = isset( $_POST['offset'] ) ? (int) $_POST['offset'] : 0;
+        $limit  = isset( $_POST['limit'] ) ? (int) $_POST['limit'] : 10;
+
+        // Run the batch operation.
+        $result = $this->operation->process( $offset, $limit );
+
+        // Send the results along with a potentially updated nonce.
+        wp_send_json_success(
+            array_merge(
+                $result,
+                array(
+                    '_nonce' => $this->create_nonce(),
+                )
+            )
+        );
+
+    }
+
+    /**
+     * Count the number of elements that would be affected by the operation.
+     *
+     * @since 3.20.0
+     */
+    public function count() {
+
+        // Validate the nonce.
+        $nonce = isset( $_POST['_nonce'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['_nonce'] ) ) : '';
+        if ( ! wp_verify_nonce( $nonce, $this->action ) ) {
+            wp_send_json_error( 'Invalid nonce.' );
+        }
+
+        // Run the batch operation.
+        $result = $this->operation->count();
+
+        // Send the results along with a potentially updated nonce.
+        wp_send_json_success(
+            array(
+                'count'  => $result,
+                '_nonce' => $this->create_nonce(),
+            )
+        );
+
+    }
+
+    /**
+     * Create a nonce for the ajax operation.
+     *
+     * @return string The nonce.
+     * @since 3.20.0
+     */
+    public function create_nonce() {
+
+        return wp_create_nonce( $this->action );
+    }
 
 }

Spacing +19 added lines, -19 removed lines

@@ -48,21 +48,21 @@ 
 	 * @param string                              $action The action name.
 	 * @param int                                 $access The access level.
 	 */
-	public function __construct( $operation, $action, $access = self::ACCESS_ADMIN ) {
+	public function __construct($operation, $action, $access = self::ACCESS_ADMIN) {
 
 		$this->operation = $operation;
 
-		if ( $access & self::ACCESS_ADMIN ) {
-			add_action( "wp_ajax_$action", array( $this, 'process' ) );
-			add_action( "wp_ajax_{$action}_count", array( $this, 'count' ) );
+		if ($access & self::ACCESS_ADMIN) {
+			add_action("wp_ajax_$action", array($this, 'process'));
+			add_action("wp_ajax_{$action}_count", array($this, 'count'));
 
 			// Add the nonce for the `schemaorg_sync` action.
-			add_filter( 'wl_admin_settings', array( $this, 'add_nonce' ) );
+			add_filter('wl_admin_settings', array($this, 'add_nonce'));
 		}
 
-		if ( $access & self::ACCESS_ANONYMOUS ) {
-			add_action( "wp_ajax_nopriv_$action", array( $this, 'process' ) );
-			add_action( "wp_ajax_nopriv_{$action}_count", array( $this, 'count' ) );
+		if ($access & self::ACCESS_ANONYMOUS) {
+			add_action("wp_ajax_nopriv_$action", array($this, 'process'));
+			add_action("wp_ajax_nopriv_{$action}_count", array($this, 'count'));
 		}
 
 		$this->action = $action;
@@ -76,7 +76,7 @@ 
 	 * @return array The updated array of settings.
 	 * @since 3.20.0
 	 */
-	public function add_nonce( $params ) {
+	public function add_nonce($params) {
 
 		return array_merge(
 			$params,
@@ -92,17 +92,17 @@ 
 	 * @since 3.20.0
 	 */
 	public function process() {
-		$nonce = isset( $_POST['_nonce'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['_nonce'] ) ) : '';
+		$nonce = isset($_POST['_nonce']) ? sanitize_text_field(wp_unslash((string) $_POST['_nonce'])) : '';
 		// Validate the nonce.
-		if ( ! wp_verify_nonce( $nonce, $this->action ) ) {
-			wp_send_json_error( 'Invalid nonce.' );
+		if ( ! wp_verify_nonce($nonce, $this->action)) {
+			wp_send_json_error('Invalid nonce.');
 		}
 
-		$offset = isset( $_POST['offset'] ) ? (int) $_POST['offset'] : 0;
-		$limit  = isset( $_POST['limit'] ) ? (int) $_POST['limit'] : 10;
+		$offset = isset($_POST['offset']) ? (int) $_POST['offset'] : 0;
+		$limit  = isset($_POST['limit']) ? (int) $_POST['limit'] : 10;
 
 		// Run the batch operation.
-		$result = $this->operation->process( $offset, $limit );
+		$result = $this->operation->process($offset, $limit);
 
 		// Send the results along with a potentially updated nonce.
 		wp_send_json_success(
@@ -124,9 +124,9 @@ 
 	public function count() {
 
 		// Validate the nonce.
-		$nonce = isset( $_POST['_nonce'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['_nonce'] ) ) : '';
-		if ( ! wp_verify_nonce( $nonce, $this->action ) ) {
-			wp_send_json_error( 'Invalid nonce.' );
+		$nonce = isset($_POST['_nonce']) ? sanitize_text_field(wp_unslash((string) $_POST['_nonce'])) : '';
+		if ( ! wp_verify_nonce($nonce, $this->action)) {
+			wp_send_json_error('Invalid nonce.');
 		}
 
 		// Run the batch operation.
@@ -150,7 +150,7 @@ 
 	 */
 	public function create_nonce() {
 
-		return wp_create_nonce( $this->action );
+		return wp_create_nonce($this->action);
 	}
 
 }

src/includes/class-wordlift-remote-image-service.php

Indentation +144 added lines, -144 removed lines

@@ -8,149 +8,149 @@
  */
 class Wordlift_Remote_Image_Service {
 
-	/**
-	 * Save the image with the specified URL locally.
-	 *
-	 * @param string $url The image remote URL.
-	 *
-	 * @return array|false|WP_Error An array with information about the saved image (*path*: the local path to the image, *url*: the local
-	 * url, *content_type*: the image content type) or false on error.
-	 * @since 3.18.0
-	 * @since 3.23.4 the function may return a WP_Error.
-	 */
-	public static function save_from_url( $url ) {
-
-		// Required for REST API calls
-		if ( ! function_exists( 'WP_Filesystem' ) ) {
-			require_once ABSPATH . 'wp-admin/includes/file.php';
-		}
-
-		// Load `WP_Filesystem`.
-		add_filter( 'filesystem_method', 'Wordlift_Remote_Image_Service::_return_direct' );
-		WP_Filesystem();
-		global $wp_filesystem;
-
-		// Parse the url.
-		$parts = wp_parse_url( $url );
-
-		// Get the bare filename (filename w/o the extension).
-		$basename = str_replace(
-			DIRECTORY_SEPARATOR,
-			'_',
-			rawurldecode(
-				pathinfo( $parts['path'], PATHINFO_FILENAME )
-			)
-		);
-
-		// Get the base dir.
-		$wp_upload_dir = wp_upload_dir();
-
-		// Set the upload directory and URL.
-		$upload_dir = $wp_upload_dir['basedir'] . '/wl' . $wp_upload_dir['subdir'];
-		$upload_url = $wp_upload_dir['baseurl'] . '/wl' . $wp_upload_dir['subdir'];
-
-		// Get the full path to the local filename.
-		$image_full_path = $upload_dir . '/' . $basename;
-		$image_full_url  = $upload_url . '/' . $basename;
-
-		// Create custom directory and bail on failure.
-		if ( ! wp_mkdir_p( $upload_dir ) ) {
-			Wordlift_Log_Service::get_logger( 'Wordlift_Remote_Image_Service' )
-								->warn( "save_image_from_url : failed creating upload dir $upload_dir \n" );
-
-			return new WP_Error( 'image_error', "save_image_from_url : failed creating upload dir $upload_dir \n" );
-		};
-
-		$response = wp_remote_get(
-			$url,
-			array(
-				'user-agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.135 Safari/537.36',
-			)
-		);
-
-		// Bail if the response is not set.
-		if ( self::is_response_error( $response ) ) {
-			Wordlift_Log_Service::get_logger( 'Wordlift_Remote_Image_Service' )
-								// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-								->warn( "save_image_from_url : failed to fetch the response from: $url\nThe response was:\n" . var_export( $response, true ) );
-
-			// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-			return new WP_Error( 'image_error', "save_image_from_url : failed to fetch the response from: $url\nThe response was:\n" . var_export( $response, true ) );
-		}
-
-		// Get the content type of response.
-		$content_type = wp_remote_retrieve_header( $response, 'content-type' );
-
-		// Get the file extension.
-		$extension = self::get_extension_from_content_type( $content_type );
-
-		// Bail if the content type is not supported.
-		if ( empty( $extension ) ) {
-			// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-			return new WP_Error( 'image_error', "Unsupported content type [ $content_type ]:\n" . var_export( $response, true ) );
-		}
-
-		// Complete the local filename.
-		$image_full_path .= $extension;
-		$image_full_url  .= $extension;
-
-		// Store the data locally.
-		$wp_filesystem->put_contents( $image_full_path, wp_remote_retrieve_body( $response ) );
-		remove_filter( 'filesystem_method', 'Wordlift_Remote_Image_Service::_return_direct' );
-
-		// Return the path.
-		return array(
-			'path'         => $image_full_path,
-			'url'          => $image_full_url,
-			'content_type' => $content_type,
-		);
-	}
-
-	// phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
-	public static function _return_direct() {
-		return 'direct';
-	}
-
-	/**
-	 * Returns the file extension using the content type.
-	 *
-	 * @param string $content_type File content type.
-	 *
-	 * @return string|bool The file extension on success and
-	 * false on fail or if the content type is not supported.
-	 * @since 3.18.0
-	 */
-	private static function get_extension_from_content_type( $content_type ) {
-
-		// Return the extension if match.
-		switch ( $content_type ) {
-			case 'image/jpeg':
-			case 'image/jpg':
-				return '.jpg';
-			case 'image/gif':
-				return '.gif';
-			case 'image/png':
-				return '.png';
-		}
-
-		// Otherwise return false.
-		return false;
-	}
-
-	/**
-	 * Checks whether a response is an error.
-	 *
-	 * @param array|WP_Error $response The response.
-	 *
-	 * @return bool True if the response is an error, otherwise false.
-	 * @since 3.23.4
-	 */
-	private static function is_response_error( $response ) {
-
-		return ( is_wp_error( $response )
-				 || 200 !== (int) $response['response']['code']
-				 || ! isset( $response['body'] )
-		);
-	}
+    /**
+     * Save the image with the specified URL locally.
+     *
+     * @param string $url The image remote URL.
+     *
+     * @return array|false|WP_Error An array with information about the saved image (*path*: the local path to the image, *url*: the local
+     * url, *content_type*: the image content type) or false on error.
+     * @since 3.18.0
+     * @since 3.23.4 the function may return a WP_Error.
+     */
+    public static function save_from_url( $url ) {
+
+        // Required for REST API calls
+        if ( ! function_exists( 'WP_Filesystem' ) ) {
+            require_once ABSPATH . 'wp-admin/includes/file.php';
+        }
+
+        // Load `WP_Filesystem`.
+        add_filter( 'filesystem_method', 'Wordlift_Remote_Image_Service::_return_direct' );
+        WP_Filesystem();
+        global $wp_filesystem;
+
+        // Parse the url.
+        $parts = wp_parse_url( $url );
+
+        // Get the bare filename (filename w/o the extension).
+        $basename = str_replace(
+            DIRECTORY_SEPARATOR,
+            '_',
+            rawurldecode(
+                pathinfo( $parts['path'], PATHINFO_FILENAME )
+            )
+        );
+
+        // Get the base dir.
+        $wp_upload_dir = wp_upload_dir();
+
+        // Set the upload directory and URL.
+        $upload_dir = $wp_upload_dir['basedir'] . '/wl' . $wp_upload_dir['subdir'];
+        $upload_url = $wp_upload_dir['baseurl'] . '/wl' . $wp_upload_dir['subdir'];
+
+        // Get the full path to the local filename.
+        $image_full_path = $upload_dir . '/' . $basename;
+        $image_full_url  = $upload_url . '/' . $basename;
+
+        // Create custom directory and bail on failure.
+        if ( ! wp_mkdir_p( $upload_dir ) ) {
+            Wordlift_Log_Service::get_logger( 'Wordlift_Remote_Image_Service' )
+                                ->warn( "save_image_from_url : failed creating upload dir $upload_dir \n" );
+
+            return new WP_Error( 'image_error', "save_image_from_url : failed creating upload dir $upload_dir \n" );
+        };
+
+        $response = wp_remote_get(
+            $url,
+            array(
+                'user-agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.135 Safari/537.36',
+            )
+        );
+
+        // Bail if the response is not set.
+        if ( self::is_response_error( $response ) ) {
+            Wordlift_Log_Service::get_logger( 'Wordlift_Remote_Image_Service' )
+                                // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
+                                ->warn( "save_image_from_url : failed to fetch the response from: $url\nThe response was:\n" . var_export( $response, true ) );
+
+            // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
+            return new WP_Error( 'image_error', "save_image_from_url : failed to fetch the response from: $url\nThe response was:\n" . var_export( $response, true ) );
+        }
+
+        // Get the content type of response.
+        $content_type = wp_remote_retrieve_header( $response, 'content-type' );
+
+        // Get the file extension.
+        $extension = self::get_extension_from_content_type( $content_type );
+
+        // Bail if the content type is not supported.
+        if ( empty( $extension ) ) {
+            // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
+            return new WP_Error( 'image_error', "Unsupported content type [ $content_type ]:\n" . var_export( $response, true ) );
+        }
+
+        // Complete the local filename.
+        $image_full_path .= $extension;
+        $image_full_url  .= $extension;
+
+        // Store the data locally.
+        $wp_filesystem->put_contents( $image_full_path, wp_remote_retrieve_body( $response ) );
+        remove_filter( 'filesystem_method', 'Wordlift_Remote_Image_Service::_return_direct' );
+
+        // Return the path.
+        return array(
+            'path'         => $image_full_path,
+            'url'          => $image_full_url,
+            'content_type' => $content_type,
+        );
+    }
+
+    // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
+    public static function _return_direct() {
+        return 'direct';
+    }
+
+    /**
+     * Returns the file extension using the content type.
+     *
+     * @param string $content_type File content type.
+     *
+     * @return string|bool The file extension on success and
+     * false on fail or if the content type is not supported.
+     * @since 3.18.0
+     */
+    private static function get_extension_from_content_type( $content_type ) {
+
+        // Return the extension if match.
+        switch ( $content_type ) {
+            case 'image/jpeg':
+            case 'image/jpg':
+                return '.jpg';
+            case 'image/gif':
+                return '.gif';
+            case 'image/png':
+                return '.png';
+        }
+
+        // Otherwise return false.
+        return false;
+    }
+
+    /**
+     * Checks whether a response is an error.
+     *
+     * @param array|WP_Error $response The response.
+     *
+     * @return bool True if the response is an error, otherwise false.
+     * @since 3.23.4
+     */
+    private static function is_response_error( $response ) {
+
+        return ( is_wp_error( $response )
+                 || 200 !== (int) $response['response']['code']
+                 || ! isset( $response['body'] )
+        );
+    }
 
 }

Spacing +29 added lines, -29 removed lines

@@ -18,27 +18,27 @@ 
 	 * @since 3.18.0
 	 * @since 3.23.4 the function may return a WP_Error.
 	 */
-	public static function save_from_url( $url ) {
+	public static function save_from_url($url) {
 
 		// Required for REST API calls
-		if ( ! function_exists( 'WP_Filesystem' ) ) {
-			require_once ABSPATH . 'wp-admin/includes/file.php';
+		if ( ! function_exists('WP_Filesystem')) {
+			require_once ABSPATH.'wp-admin/includes/file.php';
 		}
 
 		// Load `WP_Filesystem`.
-		add_filter( 'filesystem_method', 'Wordlift_Remote_Image_Service::_return_direct' );
+		add_filter('filesystem_method', 'Wordlift_Remote_Image_Service::_return_direct');
 		WP_Filesystem();
 		global $wp_filesystem;
 
 		// Parse the url.
-		$parts = wp_parse_url( $url );
+		$parts = wp_parse_url($url);
 
 		// Get the bare filename (filename w/o the extension).
 		$basename = str_replace(
 			DIRECTORY_SEPARATOR,
 			'_',
 			rawurldecode(
-				pathinfo( $parts['path'], PATHINFO_FILENAME )
+				pathinfo($parts['path'], PATHINFO_FILENAME)
 			)
 		);
 
@@ -46,19 +46,19 @@ 
 		$wp_upload_dir = wp_upload_dir();
 
 		// Set the upload directory and URL.
-		$upload_dir = $wp_upload_dir['basedir'] . '/wl' . $wp_upload_dir['subdir'];
-		$upload_url = $wp_upload_dir['baseurl'] . '/wl' . $wp_upload_dir['subdir'];
+		$upload_dir = $wp_upload_dir['basedir'].'/wl'.$wp_upload_dir['subdir'];
+		$upload_url = $wp_upload_dir['baseurl'].'/wl'.$wp_upload_dir['subdir'];
 
 		// Get the full path to the local filename.
-		$image_full_path = $upload_dir . '/' . $basename;
-		$image_full_url  = $upload_url . '/' . $basename;
+		$image_full_path = $upload_dir.'/'.$basename;
+		$image_full_url  = $upload_url.'/'.$basename;
 
 		// Create custom directory and bail on failure.
-		if ( ! wp_mkdir_p( $upload_dir ) ) {
-			Wordlift_Log_Service::get_logger( 'Wordlift_Remote_Image_Service' )
-								->warn( "save_image_from_url : failed creating upload dir $upload_dir \n" );
+		if ( ! wp_mkdir_p($upload_dir)) {
+			Wordlift_Log_Service::get_logger('Wordlift_Remote_Image_Service')
+								->warn("save_image_from_url : failed creating upload dir $upload_dir \n");
 
-			return new WP_Error( 'image_error', "save_image_from_url : failed creating upload dir $upload_dir \n" );
+			return new WP_Error('image_error', "save_image_from_url : failed creating upload dir $upload_dir \n");
 		};
 
 		$response = wp_remote_get(
@@ -69,25 +69,25 @@ 
 		);
 
 		// Bail if the response is not set.
-		if ( self::is_response_error( $response ) ) {
-			Wordlift_Log_Service::get_logger( 'Wordlift_Remote_Image_Service' )
+		if (self::is_response_error($response)) {
+			Wordlift_Log_Service::get_logger('Wordlift_Remote_Image_Service')
 								// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-								->warn( "save_image_from_url : failed to fetch the response from: $url\nThe response was:\n" . var_export( $response, true ) );
+								->warn("save_image_from_url : failed to fetch the response from: $url\nThe response was:\n".var_export($response, true));
 
 			// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-			return new WP_Error( 'image_error', "save_image_from_url : failed to fetch the response from: $url\nThe response was:\n" . var_export( $response, true ) );
+			return new WP_Error('image_error', "save_image_from_url : failed to fetch the response from: $url\nThe response was:\n".var_export($response, true));
 		}
 
 		// Get the content type of response.
-		$content_type = wp_remote_retrieve_header( $response, 'content-type' );
+		$content_type = wp_remote_retrieve_header($response, 'content-type');
 
 		// Get the file extension.
-		$extension = self::get_extension_from_content_type( $content_type );
+		$extension = self::get_extension_from_content_type($content_type);
 
 		// Bail if the content type is not supported.
-		if ( empty( $extension ) ) {
+		if (empty($extension)) {
 			// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-			return new WP_Error( 'image_error', "Unsupported content type [ $content_type ]:\n" . var_export( $response, true ) );
+			return new WP_Error('image_error', "Unsupported content type [ $content_type ]:\n".var_export($response, true));
 		}
 
 		// Complete the local filename.
@@ -95,8 +95,8 @@ 
 		$image_full_url  .= $extension;
 
 		// Store the data locally.
-		$wp_filesystem->put_contents( $image_full_path, wp_remote_retrieve_body( $response ) );
-		remove_filter( 'filesystem_method', 'Wordlift_Remote_Image_Service::_return_direct' );
+		$wp_filesystem->put_contents($image_full_path, wp_remote_retrieve_body($response));
+		remove_filter('filesystem_method', 'Wordlift_Remote_Image_Service::_return_direct');
 
 		// Return the path.
 		return array(
@@ -120,10 +120,10 @@ 
 	 * false on fail or if the content type is not supported.
 	 * @since 3.18.0
 	 */
-	private static function get_extension_from_content_type( $content_type ) {
+	private static function get_extension_from_content_type($content_type) {
 
 		// Return the extension if match.
-		switch ( $content_type ) {
+		switch ($content_type) {
 			case 'image/jpeg':
 			case 'image/jpg':
 				return '.jpg';
@@ -145,11 +145,11 @@ 
 	 * @return bool True if the response is an error, otherwise false.
 	 * @since 3.23.4
 	 */
-	private static function is_response_error( $response ) {
+	private static function is_response_error($response) {
 
-		return ( is_wp_error( $response )
+		return (is_wp_error($response)
 				 || 200 !== (int) $response['response']['code']
-				 || ! isset( $response['body'] )
+				 || ! isset($response['body'])
 		);
 	}
 

src/includes/class-wordlift-autocomplete-adapter.php

Indentation +76 added lines, -76 removed lines

@@ -13,7 +13,7 @@ 
 use Wordlift\Autocomplete\Autocomplete_Service;
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -23,79 +23,79 @@ 
  */
 class Wordlift_Autocomplete_Adapter {
 
-	/**
-	 * The {@link Autocomplete_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var Autocomplete_Service $configuration_service The {@link Autocomplete_Service} instance.
-	 */
-	private $autocomplete_service;
-
-	/**
-	 * Wordlift_Autocomplete_Adapter constructor.
-	 *
-	 * @param Autocomplete_Service $autocomplete_service The {@link Autocomplete_Service} instance.
-	 *
-	 * @since 3.14.2
-	 */
-	public function __construct( $autocomplete_service ) {
-		$this->autocomplete_service = $autocomplete_service;
-	}
-
-	/**
-	 * Handle the autocomplete ajax request.
-	 *
-	 * @since 3.15.0
-	 */
-	public function wl_autocomplete() {
-
-		check_ajax_referer( 'wl_autocomplete' );
-
-		// Return error if the query param is empty.
-		if ( ! empty( $_REQUEST['query'] ) ) { // Input var okay.
-			$query = sanitize_text_field( wp_unslash( $_REQUEST['query'] ) ); // Input var okay.
-		} else {
-			wp_send_json_error(
-				array(
-					'message' => __( 'The query param is empty.', 'wordlift' ),
-				)
-			);
-		}
-
-		// Get the exclude parameter.
-		$exclude = ! empty( $_REQUEST['exclude'] )
-			? sanitize_text_field( wp_unslash( $_REQUEST['exclude'] ) ) : '';
-
-		$scope = ! empty( $_REQUEST['scope'] )
-			? sanitize_text_field( wp_unslash( $_REQUEST['scope'] ) ) : WL_AUTOCOMPLETE_SCOPE;
-
-		/**
-		 * @since 3.26.1
-		 * Providing a way for term pages to show and save local entities.
-		 */
-		$show_local_entities = false;
-
-		if ( isset( $_REQUEST['show_local_entities'] )
-			 && ! empty( $_REQUEST['show_local_entities'] ) ) { // Make request.
-			$show_local_entities = filter_var( wp_unslash( $_REQUEST['show_local_entities'] ), FILTER_VALIDATE_BOOLEAN );
-		}
-
-		// Add the filter to check if we need to show local entities or not.
-		add_filter(
-			'wl_show_local_entities',
-			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			function ( $state ) use ( $show_local_entities ) {
-				return $show_local_entities;
-			}
-		);
-
-		$results = $this->autocomplete_service->query( $query, $scope, $exclude );
-
-		// Clear any buffer.
-		ob_clean();
-
-		wp_send_json_success( $results );
-
-	}
+    /**
+     * The {@link Autocomplete_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var Autocomplete_Service $configuration_service The {@link Autocomplete_Service} instance.
+     */
+    private $autocomplete_service;
+
+    /**
+     * Wordlift_Autocomplete_Adapter constructor.
+     *
+     * @param Autocomplete_Service $autocomplete_service The {@link Autocomplete_Service} instance.
+     *
+     * @since 3.14.2
+     */
+    public function __construct( $autocomplete_service ) {
+        $this->autocomplete_service = $autocomplete_service;
+    }
+
+    /**
+     * Handle the autocomplete ajax request.
+     *
+     * @since 3.15.0
+     */
+    public function wl_autocomplete() {
+
+        check_ajax_referer( 'wl_autocomplete' );
+
+        // Return error if the query param is empty.
+        if ( ! empty( $_REQUEST['query'] ) ) { // Input var okay.
+            $query = sanitize_text_field( wp_unslash( $_REQUEST['query'] ) ); // Input var okay.
+        } else {
+            wp_send_json_error(
+                array(
+                    'message' => __( 'The query param is empty.', 'wordlift' ),
+                )
+            );
+        }
+
+        // Get the exclude parameter.
+        $exclude = ! empty( $_REQUEST['exclude'] )
+            ? sanitize_text_field( wp_unslash( $_REQUEST['exclude'] ) ) : '';
+
+        $scope = ! empty( $_REQUEST['scope'] )
+            ? sanitize_text_field( wp_unslash( $_REQUEST['scope'] ) ) : WL_AUTOCOMPLETE_SCOPE;
+
+        /**
+         * @since 3.26.1
+         * Providing a way for term pages to show and save local entities.
+         */
+        $show_local_entities = false;
+
+        if ( isset( $_REQUEST['show_local_entities'] )
+             && ! empty( $_REQUEST['show_local_entities'] ) ) { // Make request.
+            $show_local_entities = filter_var( wp_unslash( $_REQUEST['show_local_entities'] ), FILTER_VALIDATE_BOOLEAN );
+        }
+
+        // Add the filter to check if we need to show local entities or not.
+        add_filter(
+            'wl_show_local_entities',
+            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+            function ( $state ) use ( $show_local_entities ) {
+                return $show_local_entities;
+            }
+        );
+
+        $results = $this->autocomplete_service->query( $query, $scope, $exclude );
+
+        // Clear any buffer.
+        ob_clean();
+
+        wp_send_json_success( $results );
+
+    }
 }

Spacing +16 added lines, -16 removed lines

@@ -12,7 +12,7 @@ 
 
 use Wordlift\Autocomplete\Autocomplete_Service;
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -39,7 +39,7 @@ 
 	 *
 	 * @since 3.14.2
 	 */
-	public function __construct( $autocomplete_service ) {
+	public function __construct($autocomplete_service) {
 		$this->autocomplete_service = $autocomplete_service;
 	}
 
@@ -50,25 +50,25 @@ 
 	 */
 	public function wl_autocomplete() {
 
-		check_ajax_referer( 'wl_autocomplete' );
+		check_ajax_referer('wl_autocomplete');
 
 		// Return error if the query param is empty.
-		if ( ! empty( $_REQUEST['query'] ) ) { // Input var okay.
-			$query = sanitize_text_field( wp_unslash( $_REQUEST['query'] ) ); // Input var okay.
+		if ( ! empty($_REQUEST['query'])) { // Input var okay.
+			$query = sanitize_text_field(wp_unslash($_REQUEST['query'])); // Input var okay.
 		} else {
 			wp_send_json_error(
 				array(
-					'message' => __( 'The query param is empty.', 'wordlift' ),
+					'message' => __('The query param is empty.', 'wordlift'),
 				)
 			);
 		}
 
 		// Get the exclude parameter.
-		$exclude = ! empty( $_REQUEST['exclude'] )
-			? sanitize_text_field( wp_unslash( $_REQUEST['exclude'] ) ) : '';
+		$exclude = ! empty($_REQUEST['exclude'])
+			? sanitize_text_field(wp_unslash($_REQUEST['exclude'])) : '';
 
-		$scope = ! empty( $_REQUEST['scope'] )
-			? sanitize_text_field( wp_unslash( $_REQUEST['scope'] ) ) : WL_AUTOCOMPLETE_SCOPE;
+		$scope = ! empty($_REQUEST['scope'])
+			? sanitize_text_field(wp_unslash($_REQUEST['scope'])) : WL_AUTOCOMPLETE_SCOPE;
 
 		/**
 		 * @since 3.26.1
@@ -76,26 +76,26 @@ 
 		 */
 		$show_local_entities = false;
 
-		if ( isset( $_REQUEST['show_local_entities'] )
-			 && ! empty( $_REQUEST['show_local_entities'] ) ) { // Make request.
-			$show_local_entities = filter_var( wp_unslash( $_REQUEST['show_local_entities'] ), FILTER_VALIDATE_BOOLEAN );
+		if (isset($_REQUEST['show_local_entities'])
+			 && ! empty($_REQUEST['show_local_entities'])) { // Make request.
+			$show_local_entities = filter_var(wp_unslash($_REQUEST['show_local_entities']), FILTER_VALIDATE_BOOLEAN);
 		}
 
 		// Add the filter to check if we need to show local entities or not.
 		add_filter(
 			'wl_show_local_entities',
 			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			function ( $state ) use ( $show_local_entities ) {
+			function($state) use ($show_local_entities) {
 				return $show_local_entities;
 			}
 		);
 
-		$results = $this->autocomplete_service->query( $query, $scope, $exclude );
+		$results = $this->autocomplete_service->query($query, $scope, $exclude);
 
 		// Clear any buffer.
 		ob_clean();
 
-		wp_send_json_success( $results );
+		wp_send_json_success($results);
 
 	}
 }

src/includes/class-wordlift-schema-location-property-service.php

Indentation +82 added lines, -82 removed lines

@@ -13,87 +13,87 @@
  */
 class Wordlift_Schema_Location_Property_Service extends Wordlift_Property_Service {
 
-	/**
-	 * The meta key used to store data for this property. We don't use wl_url to
-	 * avoid potential confusion about other URLs.
-	 *
-	 * @since 3.7.0
-	 */
-	const META_KEY = 'wl_location';
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_rdf_predicate() {
-
-		return 'http://schema.org/location';
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_rdf_data_type() {
-
-		return 'xsd:anyURI';
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_data_type() {
-
-		return Wordlift_Schema_Service::DATA_TYPE_URI;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_cardinality() {
-
-		return INF;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_metabox_class() {
-
-		return 'Wl_Metabox_Field';
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get_metabox_label() {
-
-		return 'Location(s)';
-	}
-
-	/**
-	 * Get the schema:url value for the specified post/entity.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|NULL The schema:url value or NULL if not set.
-	 * @since 3.7.0
-	 */
-	public function get( $post_id ) {
-
-		// Get the schema:url values set in WP.
-		$values = get_post_meta( $post_id, self::META_KEY, false );
-
-		// Finally return whatever values the editor set.
-		return $values;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function sanitize( $value ) {
-
-		// TODO: check that it's an URL or that is <permalink>
-
-		return $value;
-	}
+    /**
+     * The meta key used to store data for this property. We don't use wl_url to
+     * avoid potential confusion about other URLs.
+     *
+     * @since 3.7.0
+     */
+    const META_KEY = 'wl_location';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_rdf_predicate() {
+
+        return 'http://schema.org/location';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_rdf_data_type() {
+
+        return 'xsd:anyURI';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_data_type() {
+
+        return Wordlift_Schema_Service::DATA_TYPE_URI;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_cardinality() {
+
+        return INF;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_metabox_class() {
+
+        return 'Wl_Metabox_Field';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get_metabox_label() {
+
+        return 'Location(s)';
+    }
+
+    /**
+     * Get the schema:url value for the specified post/entity.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|NULL The schema:url value or NULL if not set.
+     * @since 3.7.0
+     */
+    public function get( $post_id ) {
+
+        // Get the schema:url values set in WP.
+        $values = get_post_meta( $post_id, self::META_KEY, false );
+
+        // Finally return whatever values the editor set.
+        return $values;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function sanitize( $value ) {
+
+        // TODO: check that it's an URL or that is <permalink>
+
+        return $value;
+    }
 
 }

Spacing +3 added lines, -3 removed lines

@@ -77,10 +77,10 @@ 
 	 * @return array|NULL The schema:url value or NULL if not set.
 	 * @since 3.7.0
 	 */
-	public function get( $post_id ) {
+	public function get($post_id) {
 
 		// Get the schema:url values set in WP.
-		$values = get_post_meta( $post_id, self::META_KEY, false );
+		$values = get_post_meta($post_id, self::META_KEY, false);
 
 		// Finally return whatever values the editor set.
 		return $values;
@@ -89,7 +89,7 @@ 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function sanitize( $value ) {
+	public function sanitize($value) {
 
 		// TODO: check that it's an URL or that is <permalink>
 

src/includes/cache/intf-wordlift-cache-service.php

Indentation +43 added lines, -43 removed lines

@@ -17,52 +17,52 @@
  */
 interface Wordlift_Cache_Service {
 
-	/**
-	 * Get the cached response for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param string $id The cache `id`.
-	 *
-	 * @return mixed|false The cached contents or false if the cache isn't found.
-	 */
-	public function get_cache( $id );
+    /**
+     * Get the cached response for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param string $id The cache `id`.
+     *
+     * @return mixed|false The cached contents or false if the cache isn't found.
+     */
+    public function get_cache( $id );
 
-	/**
-	 * Check whether we have cached results for the provided id.
-	 *
-	 * @since 3.16.3
-	 *
-	 * @param string $id The cache `id`.
-	 *
-	 * @return bool True if we have cached results otherwise false.
-	 */
-	public function has_cache( $id );
+    /**
+     * Check whether we have cached results for the provided id.
+     *
+     * @since 3.16.3
+     *
+     * @param string $id The cache `id`.
+     *
+     * @return bool True if we have cached results otherwise false.
+     */
+    public function has_cache( $id );
 
-	/**
-	 * Set the cache contents for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param string $id       The cache id.
-	 * @param mixed  $contents The cache contents.
-	 */
-	public function set_cache( $id, $contents );
+    /**
+     * Set the cache contents for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param string $id       The cache id.
+     * @param mixed  $contents The cache contents.
+     */
+    public function set_cache( $id, $contents );
 
-	/**
-	 * Delete the cache for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param string $id The cache `id`.
-	 */
-	public function delete_cache( $id );
+    /**
+     * Delete the cache for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param string $id The cache `id`.
+     */
+    public function delete_cache( $id );
 
-	/**
-	 * Flush the whole cache.
-	 *
-	 * @since 3.16.0
-	 */
-	public function flush();
+    /**
+     * Flush the whole cache.
+     *
+     * @since 3.16.0
+     */
+    public function flush();
 
 }

Spacing +4 added lines, -4 removed lines

@@ -26,7 +26,7 @@ 
 	 *
 	 * @return mixed|false The cached contents or false if the cache isn't found.
 	 */
-	public function get_cache( $id );
+	public function get_cache($id);
 
 	/**
 	 * Check whether we have cached results for the provided id.
@@ -37,7 +37,7 @@ 
 	 *
 	 * @return bool True if we have cached results otherwise false.
 	 */
-	public function has_cache( $id );
+	public function has_cache($id);
 
 	/**
 	 * Set the cache contents for the specified `id`.
@@ -47,7 +47,7 @@ 
 	 * @param string $id       The cache id.
 	 * @param mixed  $contents The cache contents.
 	 */
-	public function set_cache( $id, $contents );
+	public function set_cache($id, $contents);
 
 	/**
 	 * Delete the cache for the specified `id`.
@@ -56,7 +56,7 @@ 
 	 *
 	 * @param string $id The cache `id`.
 	 */
-	public function delete_cache( $id );
+	public function delete_cache($id);
 
 	/**
 	 * Flush the whole cache.