insideout10 / wordlift-plugin

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

Indentation +430 added lines, -430 removed lines

@@ -18,406 +18,406 @@ 
  */
 class Wordlift_Relation_Service {
 
-	/**
-	 * The relation table name in MySQL, set during instantiation.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var string $relation_table The relation table name.
-	 */
-	private $relation_table;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.15.3
-	 *
-	 * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private static $log;
-
-	/**
-	 * Create a {@link Wordlift_Relation_Service} instance.
-	 *
-	 * @since 3.15.0
-	 */
-	protected function __construct() {
-		global $wpdb;
-
-		self::$log = Wordlift_Log_Service::get_logger( get_class() );
-
-		// The relations table.
-		$this->relation_table = "{$wpdb->prefix}wl_relation_instances";
-
-	}
-
-	/**
-	 * The singleton instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var Wordlift_Relation_Service $instance The singleton instance.
-	 */
-	private static $instance = null;
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @return Wordlift_Relation_Service The {@link Wordlift_Relation_Service} singleton instance.
-	 * @since  3.15.0
-	 * @access public
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get the articles referencing the specified entity {@link WP_Post}.
-	 *
-	 * @param int|array     $object_id The entity {@link WP_Post}'s id.
-	 * @param string        $fields The fields to return, 'ids' to only return ids or
-	 *                                             '*' to return all fields, by default '*'.
-	 * @param null|string   $predicate The predicate (who|what|...), by default all.
-	 * @param null|string   $status The status, by default all.
-	 * @param array         $excludes An array of ids to exclude from the results.
-	 * @param null|int      $limit The maximum number of results, by default
-	 *                                         no limit.
-	 * @param null|array    $include The {@link WP_Post}s' ids to include.
-	 *
-	 * @param null | string $order_by
-	 *
-	 * @param array         $post_types
-	 *
-	 * @return array|object|null Database query results
-	 * @since 3.15.0
-	 */
-	public function get_article_subjects( $object_id, $fields = '*', $predicate = null, $status = null, $excludes = array(), $limit = null, $include = null, $order_by = null, $post_types = array(), $offset = null ) {
-		global $wpdb;
-
-		// The output fields.
-		$actual_fields = self::fields( $fields );
-
-		self::$log->trace( 'Getting article subjects for object ' . implode( ', ', (array) $object_id ) . '...' );
-
-		$objects = $this->article_id_to_entity_id( $object_id );
-
-		// If there are no related objects, return an empty array.
-		if ( empty( $objects ) ) {
-			self::$log->debug( 'No entities found for object ' . implode( ', ', (array) $object_id ) . '.' );
-
-			return array();
-		}
-
-		self::$log->debug( count( $objects ) . ' entity id(s) found for object ' . implode( ', ', (array) $object_id ) . '.' );
-
-		$sql =
-			"
+    /**
+     * The relation table name in MySQL, set during instantiation.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var string $relation_table The relation table name.
+     */
+    private $relation_table;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.15.3
+     *
+     * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private static $log;
+
+    /**
+     * Create a {@link Wordlift_Relation_Service} instance.
+     *
+     * @since 3.15.0
+     */
+    protected function __construct() {
+        global $wpdb;
+
+        self::$log = Wordlift_Log_Service::get_logger( get_class() );
+
+        // The relations table.
+        $this->relation_table = "{$wpdb->prefix}wl_relation_instances";
+
+    }
+
+    /**
+     * The singleton instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var Wordlift_Relation_Service $instance The singleton instance.
+     */
+    private static $instance = null;
+
+    /**
+     * Get the singleton instance.
+     *
+     * @return Wordlift_Relation_Service The {@link Wordlift_Relation_Service} singleton instance.
+     * @since  3.15.0
+     * @access public
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Get the articles referencing the specified entity {@link WP_Post}.
+     *
+     * @param int|array     $object_id The entity {@link WP_Post}'s id.
+     * @param string        $fields The fields to return, 'ids' to only return ids or
+     *                                             '*' to return all fields, by default '*'.
+     * @param null|string   $predicate The predicate (who|what|...), by default all.
+     * @param null|string   $status The status, by default all.
+     * @param array         $excludes An array of ids to exclude from the results.
+     * @param null|int      $limit The maximum number of results, by default
+     *                                         no limit.
+     * @param null|array    $include The {@link WP_Post}s' ids to include.
+     *
+     * @param null | string $order_by
+     *
+     * @param array         $post_types
+     *
+     * @return array|object|null Database query results
+     * @since 3.15.0
+     */
+    public function get_article_subjects( $object_id, $fields = '*', $predicate = null, $status = null, $excludes = array(), $limit = null, $include = null, $order_by = null, $post_types = array(), $offset = null ) {
+        global $wpdb;
+
+        // The output fields.
+        $actual_fields = self::fields( $fields );
+
+        self::$log->trace( 'Getting article subjects for object ' . implode( ', ', (array) $object_id ) . '...' );
+
+        $objects = $this->article_id_to_entity_id( $object_id );
+
+        // If there are no related objects, return an empty array.
+        if ( empty( $objects ) ) {
+            self::$log->debug( 'No entities found for object ' . implode( ', ', (array) $object_id ) . '.' );
+
+            return array();
+        }
+
+        self::$log->debug( count( $objects ) . ' entity id(s) found for object ' . implode( ', ', (array) $object_id ) . '.' );
+
+        $sql =
+            "
 			SELECT DISTINCT p.$actual_fields
 			FROM {$this->relation_table} r
 			INNER JOIN $wpdb->posts p
 				ON p.id = r.subject_id
 			"
-			// Add the status clause.
-			. self::and_status( $status )
-			. self::inner_join_is_article()
-			. self::where_object_id( $objects )
-			// Since `object_id` can be an article ID we need to exclude it from
-			// the results.
-			. self::and_article_not_in( array_merge( $excludes, (array) $object_id ) )
-			. self::and_article_in( $include )
-			. self::and_post_type_in( $post_types )
-			. self::and_predicate( $predicate )
-			. self::order_by( $order_by )
-			. self::limit( $limit )
-			. self::offset( $offset );
-
-		return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql );  // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-	}
-
-	/**
-	 * The `post_type IN` clause.
-	 *
-	 * @param array $post_types If the post type is not provided then the valid
-	 * entity post types are used.
-	 *
-	 * @return string The `post_type IN` clause.
-	 * @since 3.15.3
-	 */
-	private static function and_post_type_in( $post_types = array() ) {
-
-		if ( array() === $post_types ) {
-			$post_types = Wordlift_Entity_Service::valid_entity_post_types();
-		}
-
-		return " AND p.post_type IN ( '"
-			. implode(
-				"','",
-				array_map( 'esc_sql', $post_types )
-			)
-			   . "' )";
-	}
-
-	/**
-	 * Add the limit clause if specified.
-	 *
-	 * @param null|int $limit The maximum number of results.
-	 *
-	 * @return string The limit clause (empty if no limit has been specified).
-	 * @since 3.15.0
-	 */
-	private static function limit( $limit = null ) {
-
-		if ( null === $limit ) {
-			return '';
-		}
-
-		return "LIMIT $limit";
-	}
-
-	/**
-	 * Add the OFFSET clause if specified.
-	 *
-	 * @param null|int $offset The number of results to skip.
-	 *
-	 * @return string The offset clause (empty if no offset has been specified).
-	 * @since 3.35.11
-	 */
-	private static function offset( $offset = null ) {
-
-		if ( null === $offset || ! is_numeric( $offset ) ) {
-			return '';
-		}
-
-		return " OFFSET $offset";
-	}
-
-	/**
-	 * @param $order_by string | null
-	 *
-	 * @return string
-	 */
-	private static function order_by( $order_by ) {
-		if ( ! $order_by ) {
-			return '';
-		}
-		$order_by         = (string) $order_by;
-		$order_by_clauses = array( 'DESC', 'ASC' );
-
-		if ( in_array( $order_by, $order_by_clauses, true ) ) {
-			return " ORDER BY p.post_modified {$order_by} ";
-		} else {
-			return ' ORDER BY p.post_modified DESC ';
-		}
-	}
-
-	/**
-	 * Map the provided ids into entities (i.e. return the id if it's an entity
-	 * or get the entities if it's a post).
-	 *
-	 * @param int|array $object_id An array of posts/entities' ids.
-	 *
-	 * @return array An array of entities' ids.
-	 * @since 3.15.0
-	 */
-	private function article_id_to_entity_id( $object_id ) {
-
-		$entity_service = Wordlift_Entity_Service::get_instance();
-
-		$relation_service = $this;
-
-		return array_reduce(
-			(array) $object_id,
-			function ( $carry, $item ) use ( $entity_service, $relation_service ) {
-				if ( $entity_service->is_entity( $item ) ) {
-					return array_merge( $carry, (array) $item );
-				}
-
-				return array_merge( $carry, $relation_service->get_objects( $item, 'ids' ) );
-			},
-			array()
-		);
-
-	}
-
-	/**
-	 * Add the WHERE clause.
-	 *
-	 * @param int|array $object_id An array of {@link WP_Post}s' ids.
-	 *
-	 * @return string The WHERE clause.
-	 * @since 3.15.0
-	 */
-	private static function where_object_id( $object_id ) {
-
-		if ( empty( $object_id ) ) {
-			// self::$log->warn( sprintf( "%s `where_object_id` called with empty `object_id`.", var_export( debug_backtrace( false, 3 ), true ) ) );
-
-			return ' WHERE 1 = 1';
-		}
-
-		return ' WHERE r.object_id IN ( ' . implode( ',', wp_parse_id_list( (array) $object_id ) ) . ' )';
-	}
-
-	/**
-	 * Add the exclude clause.
-	 *
-	 * @param int|array $exclude An array of {@link WP_Post}s' ids to exclude.
-	 *
-	 * @return string The exclude clause.
-	 * @since 3.15.0
-	 */
-	private static function and_article_not_in( $exclude ) {
-
-		return ' AND NOT p.ID IN ( ' . implode( ',', wp_parse_id_list( (array) $exclude ) ) . ' )';
-	}
-
-	/**
-	 * Add the include clause.
-	 *
-	 * @param null|int|array $include An array of {@link WP_Post}s' ids.
-	 *
-	 * @return string An empty string if $include is null otherwise the include
-	 *                clause.
-	 * @since 3.15.0
-	 */
-	private static function and_article_in( $include = null ) {
-
-		if ( null === $include ) {
-			return '';
-		}
-
-		return ' AND p.ID IN ( ' . implode( ',', wp_parse_id_list( (array) $include ) ) . ' )';
-	}
-
-	/**
-	 * Get the entities' {@link WP_Post}s' ids referencing the specified {@link WP_Post}.
-	 *
-	 * @param int         $object_id The object {@link WP_Post}'s id.
-	 * @param string      $fields The fields to return, 'ids' to only return ids or
-	 *                                         '*' to return all fields, by default '*'.
-	 * @param null|string $status The status, by default all.
-	 *
-	 * @return array|object|null Database query results
-	 * @since 3.15.0
-	 */
-	public function get_non_article_subjects( $object_id, $fields = '*', $status = null ) {
-		global $wpdb;
-
-		// The output fields.
-		$actual_fields = self::fields( $fields );
-
-		$sql = $wpdb->prepare(
-			"SELECT p.$actual_fields FROM {$wpdb->prefix}wl_relation_instances r INNER JOIN $wpdb->posts p ON p.id = r.subject_id" // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-			// Add the status clause.
-			. self::and_status( $status ) // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-			. self::inner_join_is_not_article() // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-			. ' WHERE r.object_id = %d '
-			. self::and_post_type_in(), // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-			$object_id
-		);
-
-		return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-	}
-
-	/**
-	 * Get the entities referenced by the specified {@link WP_Post}.
-	 *
-	 * @param int         $subject_id The {@link WP_Post}'s id.
-	 * @param string      $fields The fields to return, 'ids' to only return ids or
-	 *                                          '*' to return all fields, by default '*'.
-	 * @param null|string $predicate The predicate (who|what|...), by default all.
-	 * @param null|string $status The status, by default all.
-	 *
-	 * @return array|object|null Database query results
-	 *
-	 * @deprecated since it doesn't handle the subject_type nor the object_type
-	 * @since 3.15.0
-	 */
-	public function get_objects( $subject_id, $fields = '*', $predicate = null, $status = null ) {
-		global $wpdb;
-
-		// The output fields.
-		$actual_fields = self::fields( $fields );
-
-		$sql = $wpdb->prepare(
-			"SELECT p.$actual_fields FROM {$this->relation_table} r INNER JOIN $wpdb->posts p ON p.id = r.object_id" // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-			// Add the status clause.
-			. self::and_status( $status ) // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-			. self::inner_join_is_not_article() // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-			. ' WHERE r.subject_id = %d '
-			. self::and_post_type_in() // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-			. self::and_predicate( $predicate ), // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-			$subject_id
-		);
-
-		return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-	}
-
-	/**
-	 * Add the `post_status` clause.
-	 *
-	 * @param null|string|array $status The status values.
-	 *
-	 * @return string An empty string if $status is null, otherwise the status clause.
-	 * @since 3.15.0
-	 */
-	private static function and_status( $status = null ) {
-
-		if ( null === $status ) {
-			return '';
-		}
-
-		return " AND p.post_status IN ('" . implode( "', '", array_map( 'esc_sql', (array) $status ) ) . "')";
-	}
-
-	/**
-	 * Add the `predicate` clause.
-	 *
-	 * @param null|string|array $predicate An array of predicates.
-	 *
-	 * @return string An empty string if $predicate is null otherwise the predicate
-	 *                clause.
-	 * @since 3.15.0
-	 */
-	private static function and_predicate( $predicate = null ) {
-
-		if ( null === $predicate ) {
-			return '';
-		}
-
-		return " AND r.predicate IN ('" . implode( "', '", array_map( 'esc_sql', (array) $predicate ) ) . "')";
-	}
-
-	/**
-	 * The select fields.
-	 *
-	 * @param string $fields Either 'ids' or '*', by default '*'.
-	 *
-	 * @return string The `id` field if `ids` otherwise `*`.
-	 * @since 3.15.0
-	 */
-	private static function fields( $fields = '*' ) {
-
-		// The output fields.
-		return 'ids' === $fields ? 'id' : '*';
-	}
-
-	/**
-	 * The inner join clause for articles.
-	 *
-	 * @return string The articles inner join clause.
-	 * @since 3.15.0
-	 */
-	private static function inner_join_is_article() {
-		global $wpdb;
-
-		return $wpdb->prepare(
-			"
+            // Add the status clause.
+            . self::and_status( $status )
+            . self::inner_join_is_article()
+            . self::where_object_id( $objects )
+            // Since `object_id` can be an article ID we need to exclude it from
+            // the results.
+            . self::and_article_not_in( array_merge( $excludes, (array) $object_id ) )
+            . self::and_article_in( $include )
+            . self::and_post_type_in( $post_types )
+            . self::and_predicate( $predicate )
+            . self::order_by( $order_by )
+            . self::limit( $limit )
+            . self::offset( $offset );
+
+        return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql );  // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+    }
+
+    /**
+     * The `post_type IN` clause.
+     *
+     * @param array $post_types If the post type is not provided then the valid
+     * entity post types are used.
+     *
+     * @return string The `post_type IN` clause.
+     * @since 3.15.3
+     */
+    private static function and_post_type_in( $post_types = array() ) {
+
+        if ( array() === $post_types ) {
+            $post_types = Wordlift_Entity_Service::valid_entity_post_types();
+        }
+
+        return " AND p.post_type IN ( '"
+            . implode(
+                "','",
+                array_map( 'esc_sql', $post_types )
+            )
+                . "' )";
+    }
+
+    /**
+     * Add the limit clause if specified.
+     *
+     * @param null|int $limit The maximum number of results.
+     *
+     * @return string The limit clause (empty if no limit has been specified).
+     * @since 3.15.0
+     */
+    private static function limit( $limit = null ) {
+
+        if ( null === $limit ) {
+            return '';
+        }
+
+        return "LIMIT $limit";
+    }
+
+    /**
+     * Add the OFFSET clause if specified.
+     *
+     * @param null|int $offset The number of results to skip.
+     *
+     * @return string The offset clause (empty if no offset has been specified).
+     * @since 3.35.11
+     */
+    private static function offset( $offset = null ) {
+
+        if ( null === $offset || ! is_numeric( $offset ) ) {
+            return '';
+        }
+
+        return " OFFSET $offset";
+    }
+
+    /**
+     * @param $order_by string | null
+     *
+     * @return string
+     */
+    private static function order_by( $order_by ) {
+        if ( ! $order_by ) {
+            return '';
+        }
+        $order_by         = (string) $order_by;
+        $order_by_clauses = array( 'DESC', 'ASC' );
+
+        if ( in_array( $order_by, $order_by_clauses, true ) ) {
+            return " ORDER BY p.post_modified {$order_by} ";
+        } else {
+            return ' ORDER BY p.post_modified DESC ';
+        }
+    }
+
+    /**
+     * Map the provided ids into entities (i.e. return the id if it's an entity
+     * or get the entities if it's a post).
+     *
+     * @param int|array $object_id An array of posts/entities' ids.
+     *
+     * @return array An array of entities' ids.
+     * @since 3.15.0
+     */
+    private function article_id_to_entity_id( $object_id ) {
+
+        $entity_service = Wordlift_Entity_Service::get_instance();
+
+        $relation_service = $this;
+
+        return array_reduce(
+            (array) $object_id,
+            function ( $carry, $item ) use ( $entity_service, $relation_service ) {
+                if ( $entity_service->is_entity( $item ) ) {
+                    return array_merge( $carry, (array) $item );
+                }
+
+                return array_merge( $carry, $relation_service->get_objects( $item, 'ids' ) );
+            },
+            array()
+        );
+
+    }
+
+    /**
+     * Add the WHERE clause.
+     *
+     * @param int|array $object_id An array of {@link WP_Post}s' ids.
+     *
+     * @return string The WHERE clause.
+     * @since 3.15.0
+     */
+    private static function where_object_id( $object_id ) {
+
+        if ( empty( $object_id ) ) {
+            // self::$log->warn( sprintf( "%s `where_object_id` called with empty `object_id`.", var_export( debug_backtrace( false, 3 ), true ) ) );
+
+            return ' WHERE 1 = 1';
+        }
+
+        return ' WHERE r.object_id IN ( ' . implode( ',', wp_parse_id_list( (array) $object_id ) ) . ' )';
+    }
+
+    /**
+     * Add the exclude clause.
+     *
+     * @param int|array $exclude An array of {@link WP_Post}s' ids to exclude.
+     *
+     * @return string The exclude clause.
+     * @since 3.15.0
+     */
+    private static function and_article_not_in( $exclude ) {
+
+        return ' AND NOT p.ID IN ( ' . implode( ',', wp_parse_id_list( (array) $exclude ) ) . ' )';
+    }
+
+    /**
+     * Add the include clause.
+     *
+     * @param null|int|array $include An array of {@link WP_Post}s' ids.
+     *
+     * @return string An empty string if $include is null otherwise the include
+     *                clause.
+     * @since 3.15.0
+     */
+    private static function and_article_in( $include = null ) {
+
+        if ( null === $include ) {
+            return '';
+        }
+
+        return ' AND p.ID IN ( ' . implode( ',', wp_parse_id_list( (array) $include ) ) . ' )';
+    }
+
+    /**
+     * Get the entities' {@link WP_Post}s' ids referencing the specified {@link WP_Post}.
+     *
+     * @param int         $object_id The object {@link WP_Post}'s id.
+     * @param string      $fields The fields to return, 'ids' to only return ids or
+     *                                         '*' to return all fields, by default '*'.
+     * @param null|string $status The status, by default all.
+     *
+     * @return array|object|null Database query results
+     * @since 3.15.0
+     */
+    public function get_non_article_subjects( $object_id, $fields = '*', $status = null ) {
+        global $wpdb;
+
+        // The output fields.
+        $actual_fields = self::fields( $fields );
+
+        $sql = $wpdb->prepare(
+            "SELECT p.$actual_fields FROM {$wpdb->prefix}wl_relation_instances r INNER JOIN $wpdb->posts p ON p.id = r.subject_id" // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+            // Add the status clause.
+            . self::and_status( $status ) // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+            . self::inner_join_is_not_article() // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+            . ' WHERE r.object_id = %d '
+            . self::and_post_type_in(), // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+            $object_id
+        );
+
+        return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+    }
+
+    /**
+     * Get the entities referenced by the specified {@link WP_Post}.
+     *
+     * @param int         $subject_id The {@link WP_Post}'s id.
+     * @param string      $fields The fields to return, 'ids' to only return ids or
+     *                                          '*' to return all fields, by default '*'.
+     * @param null|string $predicate The predicate (who|what|...), by default all.
+     * @param null|string $status The status, by default all.
+     *
+     * @return array|object|null Database query results
+     *
+     * @deprecated since it doesn't handle the subject_type nor the object_type
+     * @since 3.15.0
+     */
+    public function get_objects( $subject_id, $fields = '*', $predicate = null, $status = null ) {
+        global $wpdb;
+
+        // The output fields.
+        $actual_fields = self::fields( $fields );
+
+        $sql = $wpdb->prepare(
+            "SELECT p.$actual_fields FROM {$this->relation_table} r INNER JOIN $wpdb->posts p ON p.id = r.object_id" // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+            // Add the status clause.
+            . self::and_status( $status ) // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+            . self::inner_join_is_not_article() // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+            . ' WHERE r.subject_id = %d '
+            . self::and_post_type_in() // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+            . self::and_predicate( $predicate ), // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+            $subject_id
+        );
+
+        return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+    }
+
+    /**
+     * Add the `post_status` clause.
+     *
+     * @param null|string|array $status The status values.
+     *
+     * @return string An empty string if $status is null, otherwise the status clause.
+     * @since 3.15.0
+     */
+    private static function and_status( $status = null ) {
+
+        if ( null === $status ) {
+            return '';
+        }
+
+        return " AND p.post_status IN ('" . implode( "', '", array_map( 'esc_sql', (array) $status ) ) . "')";
+    }
+
+    /**
+     * Add the `predicate` clause.
+     *
+     * @param null|string|array $predicate An array of predicates.
+     *
+     * @return string An empty string if $predicate is null otherwise the predicate
+     *                clause.
+     * @since 3.15.0
+     */
+    private static function and_predicate( $predicate = null ) {
+
+        if ( null === $predicate ) {
+            return '';
+        }
+
+        return " AND r.predicate IN ('" . implode( "', '", array_map( 'esc_sql', (array) $predicate ) ) . "')";
+    }
+
+    /**
+     * The select fields.
+     *
+     * @param string $fields Either 'ids' or '*', by default '*'.
+     *
+     * @return string The `id` field if `ids` otherwise `*`.
+     * @since 3.15.0
+     */
+    private static function fields( $fields = '*' ) {
+
+        // The output fields.
+        return 'ids' === $fields ? 'id' : '*';
+    }
+
+    /**
+     * The inner join clause for articles.
+     *
+     * @return string The articles inner join clause.
+     * @since 3.15.0
+     */
+    private static function inner_join_is_article() {
+        global $wpdb;
+
+        return $wpdb->prepare(
+            "
 			INNER JOIN $wpdb->term_relationships tr
 			 ON p.id = tr.object_id
 			INNER JOIN $wpdb->term_taxonomy tt
@@ -427,22 +427,22 @@ 
 			 ON t.term_id = tt.term_id
 			  AND t.slug = %s
 			",
-			'wl_entity_type',
-			'article'
-		);
-	}
-
-	/**
-	 * The inner join clause for non-articles.
-	 *
-	 * @return string The non-articles inner join clause.
-	 * @since 3.15.0
-	 */
-	private static function inner_join_is_not_article() {
-		global $wpdb;
-
-		return $wpdb->prepare(
-			"
+            'wl_entity_type',
+            'article'
+        );
+    }
+
+    /**
+     * The inner join clause for non-articles.
+     *
+     * @return string The non-articles inner join clause.
+     * @since 3.15.0
+     */
+    private static function inner_join_is_not_article() {
+        global $wpdb;
+
+        return $wpdb->prepare(
+            "
 			INNER JOIN $wpdb->term_relationships tr
 			 ON p.id = tr.object_id
 			INNER JOIN $wpdb->term_taxonomy tt
@@ -452,29 +452,29 @@ 
 			 ON t.term_id = tt.term_id
 			  AND NOT t.slug = %s
 			",
-			'wl_entity_type',
-			'article'
-		);
-	}
-
-	/**
-	 * Find all the subject IDs and their referenced/related object IDs. The
-	 * object IDs are returned as comma separated IDs in the `object_ids` key.
-	 *
-	 * @return mixed Database query results
-	 * @since 3.18.0
-	 */
-	public function find_all_grouped_by_subject_id() {
-		global $wpdb;
-
-		return $wpdb->get_results(
-			"
+            'wl_entity_type',
+            'article'
+        );
+    }
+
+    /**
+     * Find all the subject IDs and their referenced/related object IDs. The
+     * object IDs are returned as comma separated IDs in the `object_ids` key.
+     *
+     * @return mixed Database query results
+     * @since 3.18.0
+     */
+    public function find_all_grouped_by_subject_id() {
+        global $wpdb;
+
+        return $wpdb->get_results(
+            "
 			SELECT subject_id, GROUP_CONCAT( DISTINCT object_id ORDER BY object_id SEPARATOR ',' ) AS object_ids
 			FROM {$wpdb->prefix}wl_relation_instances
 			GROUP BY subject_id
 			"
-		);
+        );
 
-	}
+    }
 
 }

src/shortcodes/class-wordlift-shortcode-rest.php

Indentation +135 added lines, -135 removed lines

@@ -10,141 +10,141 @@
  */
 abstract class Wordlift_Shortcode_REST {
 
-	/**
-	 * The cache_ttl, set by extending classes.
-	 */
-	const CACHE_TTL = 86400; // 24 hours
-
-	/**
-	 * @var $endpoint string The endpoint.
-	 */
-	private $endpoint;
-
-	/**
-	 * @var $args array The args.
-	 */
-	private $args;
-
-	public function __construct( $endpoint, $args ) {
-
-		$scope          = $this;
-		$this->endpoint = $endpoint;
-		$this->args     = $args;
-
-		// Register rest route with callback
-		add_action(
-			'rest_api_init',
-			function () use ( $scope ) {
-				register_rest_route(
-					WL_REST_ROUTE_DEFAULT_NAMESPACE,
-					$scope->endpoint,
-					array(
-						'methods'             => WP_REST_Server::READABLE,
-						'permission_callback' => '__return_true',
-						'callback'            => array( $scope, 'rest_callback' ),
-						'args'                => $scope->args,
-					)
-				);
-			}
-		);
-
-		// Optimizations: disable unneeded plugins on this specific REST call. WPSeo is slowing down the responses quite a bit.
-		add_action(
-			'plugins_loaded',
-			function () use ( $scope ) {
-
-				if ( ! defined( 'REST_REQUEST' ) || ! REST_REQUEST || ! $scope->is_endpoint() ) {
-					return;
-				}
-
-				remove_action( 'plugins_loaded', 'rocket_init' );
-				remove_action( 'plugins_loaded', 'wpseo_premium_init', 14 );
-				remove_action( 'plugins_loaded', 'wpseo_init', 14 );
-			},
-			0
-		);
-
-		add_action(
-			'init',
-			function () use ( $scope ) {
-
-				if ( ! defined( 'REST_REQUEST' ) || ! REST_REQUEST || ! $scope->is_endpoint() ) {
-					return;
-				}
-
-				remove_action( 'init', 'wp_widgets_init', 1 );
-				remove_action( 'init', 'gglcptch_init' );
-			},
-			0
-		);
-
-	}
-
-	abstract public function get_data( $request );
-
-	public function rest_callback( WP_REST_Request $request ) {
-
-		// Respond from origin if TTL is 0
-		if ( static::CACHE_TTL === 0 ) {
-
-			$data     = $this->get_data( $request );
-			$response = rest_ensure_response( $data );
-			if ( is_wp_error( $data ) ) {
-				return $response;
-			}
-			$response->header( 'Access-Control-Allow-Origin', '*' );
-			$response->header( 'X-WordLift-Cache', 'MISS' );
-
-			return $response;
-		}
-
-		// Create the cache key.
-		$cache_key_params = $request->get_params();
-		unset( $cache_key_params['uniqid'] );
-		unset( $cache_key_params['rest_route'] );
-		$cache_key = array( 'request_params' => $cache_key_params );
-
-		// Create the TTL cache and try to get the results.
-		$cache         = new Ttl_Cache( $this->endpoint, static::CACHE_TTL );
-		$cache_results = $cache->get( $cache_key );
-
-		if ( isset( $cache_results ) ) {
-
-			$response = rest_ensure_response( $cache_results );
-			$response->header( 'Access-Control-Allow-Origin', '*' );
-			$response->header( 'X-WordLift-Cache', 'HIT' );
-
-			return $response;
-		}
-
-		$data     = $this->get_data( $request );
-		$response = rest_ensure_response( $data );
-		if ( is_wp_error( $data ) ) {
-			return $response;
-		}
-		$response->header( 'Access-Control-Allow-Origin', '*' );
-		$response->header( 'X-WordLift-Cache', 'MISS' );
-
-		// Put the result before sending the json to the client, since sending the json will terminate us.
-		$cache->put( $cache_key, $data );
-
-		return $response;
-
-	}
-
-	private function is_endpoint() {
-		$compare_route = WL_REST_ROUTE_DEFAULT_NAMESPACE . $this->endpoint;
-
-		// Directly accessing $_SERVER['REQUEST_URI'] or $_GET['rest_route'] here as it's too early to use global $wp reliably
-
-		if ( isset( $_SERVER['REQUEST_URI'] ) && strpos( esc_url_raw( wp_unslash( (string) $_SERVER['REQUEST_URI'] ) ), $compare_route ) ) {
-			return true;
-		}
-		if ( ! empty( $_GET['rest_route'] ) && strpos( esc_url_raw( wp_unslash( (string) $_GET['rest_route'] ) ), $compare_route ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			return true;
-		}
+    /**
+     * The cache_ttl, set by extending classes.
+     */
+    const CACHE_TTL = 86400; // 24 hours
+
+    /**
+     * @var $endpoint string The endpoint.
+     */
+    private $endpoint;
+
+    /**
+     * @var $args array The args.
+     */
+    private $args;
+
+    public function __construct( $endpoint, $args ) {
+
+        $scope          = $this;
+        $this->endpoint = $endpoint;
+        $this->args     = $args;
+
+        // Register rest route with callback
+        add_action(
+            'rest_api_init',
+            function () use ( $scope ) {
+                register_rest_route(
+                    WL_REST_ROUTE_DEFAULT_NAMESPACE,
+                    $scope->endpoint,
+                    array(
+                        'methods'             => WP_REST_Server::READABLE,
+                        'permission_callback' => '__return_true',
+                        'callback'            => array( $scope, 'rest_callback' ),
+                        'args'                => $scope->args,
+                    )
+                );
+            }
+        );
+
+        // Optimizations: disable unneeded plugins on this specific REST call. WPSeo is slowing down the responses quite a bit.
+        add_action(
+            'plugins_loaded',
+            function () use ( $scope ) {
+
+                if ( ! defined( 'REST_REQUEST' ) || ! REST_REQUEST || ! $scope->is_endpoint() ) {
+                    return;
+                }
+
+                remove_action( 'plugins_loaded', 'rocket_init' );
+                remove_action( 'plugins_loaded', 'wpseo_premium_init', 14 );
+                remove_action( 'plugins_loaded', 'wpseo_init', 14 );
+            },
+            0
+        );
+
+        add_action(
+            'init',
+            function () use ( $scope ) {
+
+                if ( ! defined( 'REST_REQUEST' ) || ! REST_REQUEST || ! $scope->is_endpoint() ) {
+                    return;
+                }
+
+                remove_action( 'init', 'wp_widgets_init', 1 );
+                remove_action( 'init', 'gglcptch_init' );
+            },
+            0
+        );
+
+    }
+
+    abstract public function get_data( $request );
+
+    public function rest_callback( WP_REST_Request $request ) {
+
+        // Respond from origin if TTL is 0
+        if ( static::CACHE_TTL === 0 ) {
+
+            $data     = $this->get_data( $request );
+            $response = rest_ensure_response( $data );
+            if ( is_wp_error( $data ) ) {
+                return $response;
+            }
+            $response->header( 'Access-Control-Allow-Origin', '*' );
+            $response->header( 'X-WordLift-Cache', 'MISS' );
+
+            return $response;
+        }
+
+        // Create the cache key.
+        $cache_key_params = $request->get_params();
+        unset( $cache_key_params['uniqid'] );
+        unset( $cache_key_params['rest_route'] );
+        $cache_key = array( 'request_params' => $cache_key_params );
+
+        // Create the TTL cache and try to get the results.
+        $cache         = new Ttl_Cache( $this->endpoint, static::CACHE_TTL );
+        $cache_results = $cache->get( $cache_key );
+
+        if ( isset( $cache_results ) ) {
+
+            $response = rest_ensure_response( $cache_results );
+            $response->header( 'Access-Control-Allow-Origin', '*' );
+            $response->header( 'X-WordLift-Cache', 'HIT' );
+
+            return $response;
+        }
+
+        $data     = $this->get_data( $request );
+        $response = rest_ensure_response( $data );
+        if ( is_wp_error( $data ) ) {
+            return $response;
+        }
+        $response->header( 'Access-Control-Allow-Origin', '*' );
+        $response->header( 'X-WordLift-Cache', 'MISS' );
+
+        // Put the result before sending the json to the client, since sending the json will terminate us.
+        $cache->put( $cache_key, $data );
+
+        return $response;
+
+    }
+
+    private function is_endpoint() {
+        $compare_route = WL_REST_ROUTE_DEFAULT_NAMESPACE . $this->endpoint;
+
+        // Directly accessing $_SERVER['REQUEST_URI'] or $_GET['rest_route'] here as it's too early to use global $wp reliably
+
+        if ( isset( $_SERVER['REQUEST_URI'] ) && strpos( esc_url_raw( wp_unslash( (string) $_SERVER['REQUEST_URI'] ) ), $compare_route ) ) {
+            return true;
+        }
+        if ( ! empty( $_GET['rest_route'] ) && strpos( esc_url_raw( wp_unslash( (string) $_GET['rest_route'] ) ), $compare_route ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            return true;
+        }
 
-		return false;
-	}
+        return false;
+    }
 
 }

src/classes/features/class-features-registry.php

Indentation +50 added lines, -50 removed lines

@@ -4,54 +4,54 @@
 
 class Features_Registry {
 
-	/**
-	 * @var array<Feature>
-	 */
-	private $features = array();
-
-	private static $instance = null;
-
-	public static function get_instance() {
-		if ( null === self::$instance ) {
-			self::$instance = new Features_Registry();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * @param $feature Feature
-	 */
-	public function register_feature( $feature ) {
-		$this->features[] = $feature;
-	}
-
-	/**
-	 * @param $feature_slug string
-	 * @param $default_value bool
-	 * @param $callback callable
-	 */
-	public function register_feature_from_slug( $feature_slug, $default_value, $callback ) {
-		$this->features[] = new Feature(
-			$feature_slug,
-			$default_value,
-			$callback
-		);
-	}
-
-	public function initialize_all_features() {
-		foreach ( $this->features as $feature ) {
-			/**
-			 * @var $feature Feature
-			 */
-			$feature_slug = $feature->feature_slug;
-			if ( apply_filters( "wl_feature__enable__{$feature_slug}", $feature->default_value ) ) {
-				call_user_func( $feature->callback );
-			}
-		}
-	}
-
-	public function clear_all() {
-		$this->features = array();
-	}
+    /**
+     * @var array<Feature>
+     */
+    private $features = array();
+
+    private static $instance = null;
+
+    public static function get_instance() {
+        if ( null === self::$instance ) {
+            self::$instance = new Features_Registry();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * @param $feature Feature
+     */
+    public function register_feature( $feature ) {
+        $this->features[] = $feature;
+    }
+
+    /**
+     * @param $feature_slug string
+     * @param $default_value bool
+     * @param $callback callable
+     */
+    public function register_feature_from_slug( $feature_slug, $default_value, $callback ) {
+        $this->features[] = new Feature(
+            $feature_slug,
+            $default_value,
+            $callback
+        );
+    }
+
+    public function initialize_all_features() {
+        foreach ( $this->features as $feature ) {
+            /**
+             * @var $feature Feature
+             */
+            $feature_slug = $feature->feature_slug;
+            if ( apply_filters( "wl_feature__enable__{$feature_slug}", $feature->default_value ) ) {
+                call_user_func( $feature->callback );
+            }
+        }
+    }
+
+    public function clear_all() {
+        $this->features = array();
+    }
 }

src/classes/features/class-response-adapter.php

Indentation +103 added lines, -103 removed lines

@@ -3,108 +3,108 @@
 namespace Wordlift\Features;
 
 class Response_Adapter {
-	const WL_FEATURES = '_wl_features';
-	const WL_1        = 'wl1';
-
-	public function __construct() {
-
-		// Filter responses from the API calls to update the enabled features.
-		add_filter( 'wl_api_service__response', array( $this, 'response' ), 10, 1 );
-
-		// Initialize from `$_ENV`: this is currently required for Unit Tests, since `tests/bootstrap.php` loads WordLift
-		// before it can actually query the enabled features via HTTP (mock), which would prevent files from being included.
-		// $this->init_from_env();
-
-		// Register the `wl_features__enable__{feature-name}` filters.
-		$this->register_filters();
-
-		// Hook to the updates to the features setting to refresh the features' filters.
-		add_action( 'update_option_' . self::WL_FEATURES, array( $this, 'register_filters' ), 10, 0 );
-
-	}
-
-	public function response( $response ) {
-
-		$headers = wp_remote_retrieve_headers( $response );
-
-		// Bail out if the `wl1` header isn't defined.
-		if ( ! isset( $headers[ self::WL_1 ] ) ) {
-			return $response;
-		}
-		$wl1_as_base64_string = $headers[ self::WL_1 ];
-		// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
-		$wl1 = json_decode( base64_decode( $wl1_as_base64_string ), true );
-
-		$updated_features = $wl1['features'];
-
-		$existing_features = get_option( self::WL_FEATURES, array() );
-
-		// Loop through updated features.
-		foreach ( $updated_features as $feature_slug => $new_value ) {
-
-			// We cant pass false because that indicates if the feature is active or not, null is used to represent the features which are
-			// not set before.
-			$old_value = array_key_exists( $feature_slug, $existing_features ) ? $existing_features[ $feature_slug ] : null;
-
-			if ( $old_value !== $new_value ) {
-				/**
-				 * @param $feature_slug string The feature slug.
-				 * @param $old_value null | boolean Null represents the feature flag was not set before.
-				 * @param $new_value boolean True or false.
-				 *
-				 * @since 3.32.1
-				 * Hook : `wl_feature__change__{feature_slug}`
-				 * Action hook to be fired when there is a change in feature state.
-				 */
-				do_action( "wl_feature__change__$feature_slug", $new_value, $old_value, $feature_slug );
-			}
-		}
-
-		if ( isset( $updated_features ) ) {
-
-			if ( update_option( self::WL_FEATURES, (array) $updated_features, true ) ) {
-				$this->register_filters();
-			}
-		}
-
-		return $response;
-	}
-
-	/**
-	 * Registers the feature filters.
-	 */
-	public function register_filters() {
-
-		foreach ( (array) get_option( self::WL_FEATURES, array() ) as $name => $enabled ) {
-			// Remove previous filters.
-			remove_filter( "wl_feature__enable__{$name}", '__return_true' );
-			remove_filter( "wl_feature__enable__{$name}", '__return_false' );
-
-			$callback = ( $enabled ? '__return_true' : '__return_false' );
-			add_filter( "wl_feature__enable__{$name}", $callback );
-		}
-
-	}
-
-	private function init_from_env() {
-		$features = array_reduce(
-			array_filter(
-				array_keys( $_ENV ),
-				function ( $key ) {
-					return preg_match( '~^WL_FEATURES__.*~', $key );
-				}
-			),
-			function ( $features, $env ) {
-				$name              = strtolower( str_replace( '_', '-', substr( $env, strlen( 'WL_FEATURES__' ) ) ) );
-				$value             = wp_validate_boolean( getenv( $env ) );
-				$features[ $name ] = $value;
-
-				return $features;
-			},
-			array()
-		);
-
-		update_option( self::WL_FEATURES, (array) $features, true );
-	}
+    const WL_FEATURES = '_wl_features';
+    const WL_1        = 'wl1';
+
+    public function __construct() {
+
+        // Filter responses from the API calls to update the enabled features.
+        add_filter( 'wl_api_service__response', array( $this, 'response' ), 10, 1 );
+
+        // Initialize from `$_ENV`: this is currently required for Unit Tests, since `tests/bootstrap.php` loads WordLift
+        // before it can actually query the enabled features via HTTP (mock), which would prevent files from being included.
+        // $this->init_from_env();
+
+        // Register the `wl_features__enable__{feature-name}` filters.
+        $this->register_filters();
+
+        // Hook to the updates to the features setting to refresh the features' filters.
+        add_action( 'update_option_' . self::WL_FEATURES, array( $this, 'register_filters' ), 10, 0 );
+
+    }
+
+    public function response( $response ) {
+
+        $headers = wp_remote_retrieve_headers( $response );
+
+        // Bail out if the `wl1` header isn't defined.
+        if ( ! isset( $headers[ self::WL_1 ] ) ) {
+            return $response;
+        }
+        $wl1_as_base64_string = $headers[ self::WL_1 ];
+        // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
+        $wl1 = json_decode( base64_decode( $wl1_as_base64_string ), true );
+
+        $updated_features = $wl1['features'];
+
+        $existing_features = get_option( self::WL_FEATURES, array() );
+
+        // Loop through updated features.
+        foreach ( $updated_features as $feature_slug => $new_value ) {
+
+            // We cant pass false because that indicates if the feature is active or not, null is used to represent the features which are
+            // not set before.
+            $old_value = array_key_exists( $feature_slug, $existing_features ) ? $existing_features[ $feature_slug ] : null;
+
+            if ( $old_value !== $new_value ) {
+                /**
+                 * @param $feature_slug string The feature slug.
+                 * @param $old_value null | boolean Null represents the feature flag was not set before.
+                 * @param $new_value boolean True or false.
+                 *
+                 * @since 3.32.1
+                 * Hook : `wl_feature__change__{feature_slug}`
+                 * Action hook to be fired when there is a change in feature state.
+                 */
+                do_action( "wl_feature__change__$feature_slug", $new_value, $old_value, $feature_slug );
+            }
+        }
+
+        if ( isset( $updated_features ) ) {
+
+            if ( update_option( self::WL_FEATURES, (array) $updated_features, true ) ) {
+                $this->register_filters();
+            }
+        }
+
+        return $response;
+    }
+
+    /**
+     * Registers the feature filters.
+     */
+    public function register_filters() {
+
+        foreach ( (array) get_option( self::WL_FEATURES, array() ) as $name => $enabled ) {
+            // Remove previous filters.
+            remove_filter( "wl_feature__enable__{$name}", '__return_true' );
+            remove_filter( "wl_feature__enable__{$name}", '__return_false' );
+
+            $callback = ( $enabled ? '__return_true' : '__return_false' );
+            add_filter( "wl_feature__enable__{$name}", $callback );
+        }
+
+    }
+
+    private function init_from_env() {
+        $features = array_reduce(
+            array_filter(
+                array_keys( $_ENV ),
+                function ( $key ) {
+                    return preg_match( '~^WL_FEATURES__.*~', $key );
+                }
+            ),
+            function ( $features, $env ) {
+                $name              = strtolower( str_replace( '_', '-', substr( $env, strlen( 'WL_FEATURES__' ) ) ) );
+                $value             = wp_validate_boolean( getenv( $env ) );
+                $features[ $name ] = $value;
+
+                return $features;
+            },
+            array()
+        );
+
+        update_option( self::WL_FEATURES, (array) $features, true );
+    }
 
 }

src/modules/include-exclude/includes/Configuration.php

Indentation +45 added lines, -45 removed lines

@@ -4,50 +4,50 @@
 
 class Configuration {
 
-	private static $instance;
-
-	private $type;
-	private $urls;
-
-	protected function __construct() {
-		$include_exclude_data = get_option( 'wl_exclude_include_urls_settings', array() );
-		$include_exclude      = isset( $include_exclude_data['include_exclude'] ) ? $include_exclude_data['include_exclude'] : 'exclude';
-
-		$this->type = in_array(
-			$include_exclude,
-			array(
-				'include',
-				'exclude',
-			),
-			true
-		)
-			? $include_exclude : 'exclude';
-		$this->urls = isset( $include_exclude_data['urls'] ) ? $include_exclude_data['urls'] : '';
-	}
-
-	public static function get_instance() {
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	public function get_type() {
-		return $this->type;
-	}
-
-	/**
-	 * Gets the default action, which is the inverse of the configuration type.
-	 *
-	 * @return string
-	 */
-	public function get_default() {
-		return ( $this->type === 'exclude' ? 'include' : 'exclude' );
-	}
-
-	public function get_urls() {
-		return $this->urls;
-	}
+    private static $instance;
+
+    private $type;
+    private $urls;
+
+    protected function __construct() {
+        $include_exclude_data = get_option( 'wl_exclude_include_urls_settings', array() );
+        $include_exclude      = isset( $include_exclude_data['include_exclude'] ) ? $include_exclude_data['include_exclude'] : 'exclude';
+
+        $this->type = in_array(
+            $include_exclude,
+            array(
+                'include',
+                'exclude',
+            ),
+            true
+        )
+            ? $include_exclude : 'exclude';
+        $this->urls = isset( $include_exclude_data['urls'] ) ? $include_exclude_data['urls'] : '';
+    }
+
+    public static function get_instance() {
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    public function get_type() {
+        return $this->type;
+    }
+
+    /**
+     * Gets the default action, which is the inverse of the configuration type.
+     *
+     * @return string
+     */
+    public function get_default() {
+        return ( $this->type === 'exclude' ? 'include' : 'exclude' );
+    }
+
+    public function get_urls() {
+        return $this->urls;
+    }
 
 }

src/modules/include-exclude/includes/Jsonld_Interceptor.php

Indentation +30 added lines, -30 removed lines

@@ -4,44 +4,44 @@
 
 class Jsonld_Interceptor {
 
-	/** @var Plugin_Enabled $plugin_enabled */
-	private $plugin_enabled;
+    /** @var Plugin_Enabled $plugin_enabled */
+    private $plugin_enabled;
 
-	public function __construct( $plugin_enabled ) {
-		$this->plugin_enabled = $plugin_enabled;
-	}
+    public function __construct( $plugin_enabled ) {
+        $this->plugin_enabled = $plugin_enabled;
+    }
 
-	public function register_hooks() {
-		add_filter( 'wl_after_get_jsonld', array( $this, 'after_get_jsonld' ) );
-	}
+    public function register_hooks() {
+        add_filter( 'wl_after_get_jsonld', array( $this, 'after_get_jsonld' ) );
+    }
 
-	public function after_get_jsonld( $jsonld_arr ) {
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'X-Wordlift-IncludeExclude-Stage-0: Filter Called with default ' . $this->plugin_enabled->get_configuration()->get_default() );
-		if ( ! is_array( $jsonld_arr ) || empty( $jsonld_arr ) || ! isset( $jsonld_arr[0]['url'] ) || null !== filter_input( INPUT_SERVER, 'HTTP_X_WORDLIFT_BYPASS_INCLUDE_EXCLUDE' ) ) {
-			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@header( 'X-Wordlift-IncludeExclude-Stage-1: Condition Not Matched' );
+    public function after_get_jsonld( $jsonld_arr ) {
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @header( 'X-Wordlift-IncludeExclude-Stage-0: Filter Called with default ' . $this->plugin_enabled->get_configuration()->get_default() );
+        if ( ! is_array( $jsonld_arr ) || empty( $jsonld_arr ) || ! isset( $jsonld_arr[0]['url'] ) || null !== filter_input( INPUT_SERVER, 'HTTP_X_WORDLIFT_BYPASS_INCLUDE_EXCLUDE' ) ) {
+            // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+            @header( 'X-Wordlift-IncludeExclude-Stage-1: Condition Not Matched' );
 
-			return $jsonld_arr;
-		}
+            return $jsonld_arr;
+        }
 
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'X-Wordlift-IncludeExclude-Stage-1: Condition Matched for ' . $jsonld_arr[0]['url'] );
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'X-Wordlift-IncludeExclude-Note: To bypass the Include/Exclude filter add a `x-wordlift-bypass-include-exclude` HTTP request header with any value.' );
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @header( 'X-Wordlift-IncludeExclude-Stage-1: Condition Matched for ' . $jsonld_arr[0]['url'] );
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @header( 'X-Wordlift-IncludeExclude-Note: To bypass the Include/Exclude filter add a `x-wordlift-bypass-include-exclude` HTTP request header with any value.' );
 
-		// If the URLs are included then publish them.
-		if ( $this->plugin_enabled->are_urls_included( $jsonld_arr[0]['url'] ) ) {
-			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@header( 'X-Wordlift-IncludeExclude-Stage-2: URL Included' );
+        // If the URLs are included then publish them.
+        if ( $this->plugin_enabled->are_urls_included( $jsonld_arr[0]['url'] ) ) {
+            // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+            @header( 'X-Wordlift-IncludeExclude-Stage-2: URL Included' );
 
-			return $jsonld_arr;
-		}
+            return $jsonld_arr;
+        }
 
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'X-Wordlift-IncludeExclude-Stage-2: URL Excluded' );
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @header( 'X-Wordlift-IncludeExclude-Stage-2: URL Excluded' );
 
-		return array();
-	}
+        return array();
+    }
 
 }

src/modules/include-exclude/includes/Plugin_Enabled.php

Indentation +93 added lines, -93 removed lines

@@ -16,98 +16,98 @@
  */
 class Plugin_Enabled {
 
-	/**
-	 * @var Configuration $configuration
-	 */
-	private $configuration;
-
-	public function __construct( $configuration ) {
-		$this->configuration = $configuration;
-	}
-
-	/**
-	 * Register hooks.
-	 */
-	public function register_hooks() {
-		add_filter( 'wl_is_enabled', array( $this, 'wl_is_enabled' ) );
-	}
-
-	/**
-	 * Enable/Disable WordLift Plugin.
-	 *
-	 * @param $enabled
-	 *
-	 * @return bool|mixed
-	 */
-	public function wl_is_enabled( $enabled ) {
-
-		// Always enable wordlift on admin and rest api pages.
-		if ( is_admin() || $this->is_rest_request() ) {
-			return $enabled;
-		}
-
-		$path    = strtok( (string) $_SERVER['REQUEST_URI'], '?' ); // phpcs:ignore
-		$options = get_option( 'wl_exclude_include_urls_settings' );
-
-		// Bail out if URLs are not set.
-		if ( empty( $options['urls'] ) ) {
-			return $enabled;
-		}
-
-		$current_url = trailingslashit( home_url( $path ) );
-
-		return $this->are_urls_included( $current_url );
-	}
-
-	public function are_urls_included( $urls ) {
-		// Ensure we deal with an array. We `trailingslashit` all URLs to avoid issues with missing slashes.
-		$urls = array_map( 'trailingslashit', (array) $urls );
-
-		// Set a default state.
-		$include_by_default = ( $this->configuration->get_default() === 'include' );
-
-		// Get URLs into an array from settings, trim them and make absolute if needed.
-		$configured_urls = array_map(
-			function ( $url ) {
-				$url = trim( $url );
-				if ( substr( $url, 0, 4 ) !== 'http' ) {
-					return trailingslashit( home_url( $url ) );
-				}
-
-				// Add a trailing slash and return the url
-				return trailingslashit( $url );
-			},
-			explode( PHP_EOL, $this->configuration->get_urls() )
-		);
-
-		// Check if any of the provided URLs is in the configured URLs.
-		$intersection = array_intersect( $urls, $configured_urls );
-		if ( ! empty( $intersection ) ) {
-			return ! $include_by_default;
-		}
-
-		return $include_by_default;
-	}
-
-	public function get_configuration() {
-		return $this->configuration;
-	}
-
-	/**
-	 * We cant rely on WP_REST_REQUEST constant here since it is loaded after init hook
-	 *
-	 * @return bool
-	 */
-	protected function is_rest_request() {
-		if ( empty( $_SERVER['REQUEST_URI'] ) ) {
-			// Probably a CLI request.
-			return false;
-		}
-
-		$rest_prefix = trailingslashit( rest_get_url_prefix() );
-		$path        = strtok( (string) $_SERVER['REQUEST_URI'], '?' ); // phpcs:ignore
-
-		return strpos( $path, $rest_prefix ) !== false;
-	}
+    /**
+     * @var Configuration $configuration
+     */
+    private $configuration;
+
+    public function __construct( $configuration ) {
+        $this->configuration = $configuration;
+    }
+
+    /**
+     * Register hooks.
+     */
+    public function register_hooks() {
+        add_filter( 'wl_is_enabled', array( $this, 'wl_is_enabled' ) );
+    }
+
+    /**
+     * Enable/Disable WordLift Plugin.
+     *
+     * @param $enabled
+     *
+     * @return bool|mixed
+     */
+    public function wl_is_enabled( $enabled ) {
+
+        // Always enable wordlift on admin and rest api pages.
+        if ( is_admin() || $this->is_rest_request() ) {
+            return $enabled;
+        }
+
+        $path    = strtok( (string) $_SERVER['REQUEST_URI'], '?' ); // phpcs:ignore
+        $options = get_option( 'wl_exclude_include_urls_settings' );
+
+        // Bail out if URLs are not set.
+        if ( empty( $options['urls'] ) ) {
+            return $enabled;
+        }
+
+        $current_url = trailingslashit( home_url( $path ) );
+
+        return $this->are_urls_included( $current_url );
+    }
+
+    public function are_urls_included( $urls ) {
+        // Ensure we deal with an array. We `trailingslashit` all URLs to avoid issues with missing slashes.
+        $urls = array_map( 'trailingslashit', (array) $urls );
+
+        // Set a default state.
+        $include_by_default = ( $this->configuration->get_default() === 'include' );
+
+        // Get URLs into an array from settings, trim them and make absolute if needed.
+        $configured_urls = array_map(
+            function ( $url ) {
+                $url = trim( $url );
+                if ( substr( $url, 0, 4 ) !== 'http' ) {
+                    return trailingslashit( home_url( $url ) );
+                }
+
+                // Add a trailing slash and return the url
+                return trailingslashit( $url );
+            },
+            explode( PHP_EOL, $this->configuration->get_urls() )
+        );
+
+        // Check if any of the provided URLs is in the configured URLs.
+        $intersection = array_intersect( $urls, $configured_urls );
+        if ( ! empty( $intersection ) ) {
+            return ! $include_by_default;
+        }
+
+        return $include_by_default;
+    }
+
+    public function get_configuration() {
+        return $this->configuration;
+    }
+
+    /**
+     * We cant rely on WP_REST_REQUEST constant here since it is loaded after init hook
+     *
+     * @return bool
+     */
+    protected function is_rest_request() {
+        if ( empty( $_SERVER['REQUEST_URI'] ) ) {
+            // Probably a CLI request.
+            return false;
+        }
+
+        $rest_prefix = trailingslashit( rest_get_url_prefix() );
+        $path        = strtok( (string) $_SERVER['REQUEST_URI'], '?' ); // phpcs:ignore
+
+        return strpos( $path, $rest_prefix ) !== false;
+    }
 
 }