insideout10 / wordlift-plugin

src/modules/core/wordlift-core-post-entity-relations.php

Indentation +329 added lines, -329 removed lines

@@ -18,16 +18,16 @@ 
  */
 function wl_core_check_relation_predicate_is_supported( $predicate ) {
 
-	return in_array(
-		$predicate,
-		array(
-			WL_WHAT_RELATION,
-			WL_WHEN_RELATION,
-			WL_WHERE_RELATION,
-			WL_WHO_RELATION,
-		),
-		true
-	);
+    return in_array(
+        $predicate,
+        array(
+            WL_WHAT_RELATION,
+            WL_WHEN_RELATION,
+            WL_WHERE_RELATION,
+            WL_WHO_RELATION,
+        ),
+        true
+    );
 }
 
 /**
@@ -37,8 +37,8 @@ 
  */
 function wl_core_get_validation_rules() {
 
-	// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
-	return unserialize( WL_CORE_GET_POSTS_VALIDATION_RULES );
+    // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
+    return unserialize( WL_CORE_GET_POSTS_VALIDATION_RULES );
 }
 
 /**
@@ -48,10 +48,10 @@ 
  */
 function wl_core_get_relation_instances_table_name() {
 
-	global $wpdb;
-	$table_name = $wpdb->prefix . WL_DB_RELATION_INSTANCES_TABLE_NAME;
+    global $wpdb;
+    $table_name = $wpdb->prefix . WL_DB_RELATION_INSTANCES_TABLE_NAME;
 
-	return $table_name;
+    return $table_name;
 }
 
 /**
@@ -68,55 +68,55 @@ 
  */
 function wl_core_add_relation_instance( $subject_id, $predicate, $object_id, $subject_type = Object_Type_Enum::POST, $object_type = Object_Type_Enum::POST ) {
 
-	// Checks on subject and object
-	if ( ! is_numeric( $subject_id ) || ! is_numeric( $object_id ) ) {
-		return false;
-	}
-
-	// Checks on the given relation
-	if ( ! wl_core_check_relation_predicate_is_supported( $predicate ) ) {
-		return false;
-	}
-
-	// Ensure these are `int`s. This is especially useful to ensure that parties that hook to our actions receive
-	// the right var types.
-	$subject_id = (int) $subject_id;
-	$object_id  = (int) $object_id;
-
-	// Prepare interaction with db
-	global $wpdb;
-
-	// Checks passed. Add relation if not exists:
-	//
-	// See https://codex.wordpress.org/Class_Reference/wpdb#REPLACE_row
-	$wpdb->replace(
-		wl_core_get_relation_instances_table_name(),
-		array(
-			'subject_id'   => $subject_id,
-			'predicate'    => $predicate,
-			'object_id'    => $object_id,
-			'subject_type' => $subject_type,
-			'object_type'  => $object_type,
-		),
-		array( '%d', '%s', '%d', '%d', '%d' )
-	);
-
-	/**
-	 * Hooks: Relation Added.
-	 *
-	 * Fire a hook when a new relation between a post/entity and an entity is
-	 * added (the relation may already exists).
-	 *
-	 * @param int $subject_id The subject {@link WP_Post} id.
-	 * @param string $predicate The predicate.
-	 * @param int $object_id The object {@link WP_Post} id.
-	 *
-	 * @since 3.16.0
-	 */
-	do_action( 'wl_relation_added', $subject_id, $predicate, $object_id );
-
-	// Return record id
-	return $wpdb->insert_id;
+    // Checks on subject and object
+    if ( ! is_numeric( $subject_id ) || ! is_numeric( $object_id ) ) {
+        return false;
+    }
+
+    // Checks on the given relation
+    if ( ! wl_core_check_relation_predicate_is_supported( $predicate ) ) {
+        return false;
+    }
+
+    // Ensure these are `int`s. This is especially useful to ensure that parties that hook to our actions receive
+    // the right var types.
+    $subject_id = (int) $subject_id;
+    $object_id  = (int) $object_id;
+
+    // Prepare interaction with db
+    global $wpdb;
+
+    // Checks passed. Add relation if not exists:
+    //
+    // See https://codex.wordpress.org/Class_Reference/wpdb#REPLACE_row
+    $wpdb->replace(
+        wl_core_get_relation_instances_table_name(),
+        array(
+            'subject_id'   => $subject_id,
+            'predicate'    => $predicate,
+            'object_id'    => $object_id,
+            'subject_type' => $subject_type,
+            'object_type'  => $object_type,
+        ),
+        array( '%d', '%s', '%d', '%d', '%d' )
+    );
+
+    /**
+     * Hooks: Relation Added.
+     *
+     * Fire a hook when a new relation between a post/entity and an entity is
+     * added (the relation may already exists).
+     *
+     * @param int $subject_id The subject {@link WP_Post} id.
+     * @param string $predicate The predicate.
+     * @param int $object_id The object {@link WP_Post} id.
+     *
+     * @since 3.16.0
+     */
+    do_action( 'wl_relation_added', $subject_id, $predicate, $object_id );
+
+    // Return record id
+    return $wpdb->insert_id;
 }
 
 /**
@@ -129,41 +129,41 @@ 
  */
 function wl_core_delete_relation_instances( $subject_id ) {
 
-	// Checks on subject and object
-	if ( ! is_numeric( $subject_id ) ) {
-		return false;
-	}
-
-	// Ensure these are `int`s. This is especially useful to ensure that parties that hook to our actions receive
-	// the right var types.
-	$subject_id = (int) $subject_id;
-
-	// Prepare interaction with db
-	global $wpdb;
-
-	// wl_write_log( "Going to delete relation instances [ subject_id :: $subject_id ]");
-
-	// @see https://codex.wordpress.org/it:Riferimento_classi/wpdb#DELETE_di_righe
-	$wpdb->delete(
-		wl_core_get_relation_instances_table_name(),
-		array(
-			'subject_id' => $subject_id,
-		),
-		array( '%d' )
-	);
-
-	/**
-	 * Hooks: Relation Deleted.
-	 *
-	 * The hook is fired after the relations with this post/entity are deleted.
-	 *
-	 * @param int $subject_id The subject {@link WP_Post} id.
-	 *
-	 * @since 3.16.0
-	 */
-	do_action( 'wl_relation_deleted', $subject_id );
-
-	return true;
+    // Checks on subject and object
+    if ( ! is_numeric( $subject_id ) ) {
+        return false;
+    }
+
+    // Ensure these are `int`s. This is especially useful to ensure that parties that hook to our actions receive
+    // the right var types.
+    $subject_id = (int) $subject_id;
+
+    // Prepare interaction with db
+    global $wpdb;
+
+    // wl_write_log( "Going to delete relation instances [ subject_id :: $subject_id ]");
+
+    // @see https://codex.wordpress.org/it:Riferimento_classi/wpdb#DELETE_di_righe
+    $wpdb->delete(
+        wl_core_get_relation_instances_table_name(),
+        array(
+            'subject_id' => $subject_id,
+        ),
+        array( '%d' )
+    );
+
+    /**
+     * Hooks: Relation Deleted.
+     *
+     * The hook is fired after the relations with this post/entity are deleted.
+     *
+     * @param int $subject_id The subject {@link WP_Post} id.
+     *
+     * @since 3.16.0
+     */
+    do_action( 'wl_relation_deleted', $subject_id );
+
+    return true;
 }
 
 /**
@@ -179,18 +179,18 @@ 
  */
 function wl_core_validate_filters_for_related( $filters ) {
 
-	if ( ! is_array( $filters ) ) {
-		$filters = array();
-	}
+    if ( ! is_array( $filters ) ) {
+        $filters = array();
+    }
 
-	if ( ! isset( $filters['predicate'] ) ) {
-		$filters['predicate'] = null;
-	}
-	if ( ! isset( $filters['status'] ) ) {
-		$filters['status'] = null;
-	}
+    if ( ! isset( $filters['predicate'] ) ) {
+        $filters['predicate'] = null;
+    }
+    if ( ! isset( $filters['status'] ) ) {
+        $filters['status'] = null;
+    }
 
-	return $filters;
+    return $filters;
 }
 
 // **
@@ -237,14 +237,14 @@ 
  */
 function wl_core_get_related_entity_ids( $subject_id, $filters = array() ) {
 
-	$status    = isset( $filters['status'] ) ? $filters['status'] : null;
-	$predicate = isset( $filters['predicate'] ) ? $filters['predicate'] : null;
+    $status    = isset( $filters['status'] ) ? $filters['status'] : null;
+    $predicate = isset( $filters['predicate'] ) ? $filters['predicate'] : null;
 
-	return Wordlift_Relation_Service::get_instance()->get_objects( $subject_id, 'ids', $predicate, $status );
+    return Wordlift_Relation_Service::get_instance()->get_objects( $subject_id, 'ids', $predicate, $status );
 
-	// $filters = wl_core_validate_filters_for_related( $filters );
-	//
-	// return wl_core_inner_get_related_entities( 'post_ids', $subject_id, $filters['predicate'], $filters['status'] );
+    // $filters = wl_core_validate_filters_for_related( $filters );
+    //
+    // return wl_core_inner_get_related_entities( 'post_ids', $subject_id, $filters['predicate'], $filters['status'] );
 }
 
 /**
@@ -260,14 +260,14 @@ 
  */
 function wl_core_get_related_entities( $subject_id, $filters = array() ) {
 
-	$ids = wl_core_get_related_entity_ids( $subject_id, $filters );
+    $ids = wl_core_get_related_entity_ids( $subject_id, $filters );
 
-	return array_map(
-		function ( $item ) {
-			return get_post( $item );
-		},
-		$ids
-	);
+    return array_map(
+        function ( $item ) {
+            return get_post( $item );
+        },
+        $ids
+    );
 }
 
 //
@@ -344,16 +344,16 @@ 
  */
 function wl_core_get_related_post_ids( $object_id, $filters = array() ) {
 
-	$relation_service = Wordlift_Relation_Service::get_instance();
+    $relation_service = Wordlift_Relation_Service::get_instance();
 
-	$status    = isset( $filters['status'] ) ? $filters['status'] : null;
-	$predicate = isset( $filters['predicate'] ) ? $filters['predicate'] : null;
+    $status    = isset( $filters['status'] ) ? $filters['status'] : null;
+    $predicate = isset( $filters['predicate'] ) ? $filters['predicate'] : null;
 
-	return $relation_service->get_article_subjects( $object_id, 'ids', $predicate, $status );
-	//
-	// $filters = wl_core_validate_filters_for_related( $filters );
-	//
-	// return wl_core_inner_get_related_posts( 'post_ids', $object_id, $filters['predicate'], $filters['status'] );
+    return $relation_service->get_article_subjects( $object_id, 'ids', $predicate, $status );
+    //
+    // $filters = wl_core_validate_filters_for_related( $filters );
+    //
+    // return wl_core_inner_get_related_posts( 'post_ids', $object_id, $filters['predicate'], $filters['status'] );
 }
 
 /**
@@ -371,14 +371,14 @@ 
  */
 function wl_core_get_related_posts( $subject_id, $filters = array() ) {
 
-	$ids = wl_core_get_related_post_ids( $subject_id, $filters );
+    $ids = wl_core_get_related_post_ids( $subject_id, $filters );
 
-	return array_map(
-		function ( $item ) {
-			return get_post( $item );
-		},
-		$ids
-	);
+    return array_map(
+        function ( $item ) {
+            return get_post( $item );
+        },
+        $ids
+    );
 }
 
 // **
@@ -464,129 +464,129 @@ 
  */
 function wl_core_sql_query_builder( $args ) {
 
-	// Prepare interaction with db
-	global $wpdb;
-
-	// Retrieve Wordlift relation instances table name
-	$table_name = wl_core_get_relation_instances_table_name();
-
-	// When type is set to `post` we're looking for `post`s that are not
-	// configured as entities.
-	// When the type is set to `entity` we're looking also for `post`s that are
-	// configured as entities.
-
-	// Since we want Find only articles, based on the entity type, we need
-	// to figure out the relevant sql statements to add to the join and where
-	// parts.
-	if ( 'entity' === $args['post_type'] ) {
-		$tax_query = array(
-			'relation' => 'AND',
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'operator' => 'EXISTS',
-			),
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'field'    => 'slug',
-				'terms'    => 'article',
-				'operator' => 'NOT IN',
-			),
-		);
-	} else {
-		$tax_query = array(
-			'relation' => 'OR',
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'operator' => 'NOT EXISTS',
-			),
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'field'    => 'slug',
-				'terms'    => 'article',
-			),
-		);
-	}
-
-	// Use "p" as the table to match the initial join.
-	$tax_sql = get_tax_sql( $tax_query, 'p', 'ID' );
-
-	// Sql Action
-	$sql = 'SELECT ';
-	// Determine what has to be returned depending on 'get' argument value
-	switch ( $args['get'] ) {
-		case 'posts':
-			$sql .= 'p.*';
-			break;
-		case 'post_ids':
-			$sql .= 'p.id';
-			break;
-	}
-
-	// If we look for posts related as objects the JOIN has to be done with the object_id column and viceversa
-	$join_column = $args['as'] . '_id';
-
-	$sql .= " FROM $wpdb->posts as p JOIN $table_name as r ON p.id = r.$join_column";
-
-	// Changing left join generate by the tax query into an inner since the term relationship has to exist.
-	$sql .= str_replace( 'LEFT JOIN', 'INNER JOIN', $tax_sql['join'] );
-
-	// Sql add post type filter
-	$post_types = Wordlift_Entity_Service::valid_entity_post_types();
-	$sql       .= " AND p.post_type IN ('" . join( "', '", esc_sql( $post_types ) ) . "') AND";
-
-	// Sql add post status filter
-	if ( isset( $args['post_status'] ) && $args['post_status'] !== null ) {
-		$sql .= $wpdb->prepare( ' p.post_status = %s AND', $args['post_status'] );
-	}
-
-	// Add filtering conditions
-	// If we look for posts related as objects this means that
-	// related_to is a reference for a subject: subject_id is the filtering column
-	// If we look for posts related as subject this means that
-	// related_to is reference for an object: object_id is the filtering column
-
-	$filtering_column = ( 'object' === $args['as'] ) ? 'subject_id' : 'object_id';
-
-	if ( isset( $args['related_to'] ) ) {
-		// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-		$sql .= $wpdb->prepare( " r.$filtering_column = %d", $args['related_to'] );
-	}
-	if ( isset( $args['related_to'] ) && isset( $args['related_to__in'] ) ) {
-		$sql .= ' AND';
-	}
-	if ( isset( $args['related_to__in'] ) ) {
-		$sql .= " r.$filtering_column IN (" . implode( ',', $args['related_to__in'] ) . ')';
-		// The IDs used for filtering shouldn't be in the results.
-		$sql .= ' AND p.ID NOT IN (' . implode( ',', $args['related_to__in'] ) . ')';
-	}
-	if ( isset( $args['post__not_in'] ) ) {
-		$sql .= ' AND r.' . $args['as'] . '_id NOT IN (' . implode( ',', $args['post__not_in'] ) . ')';
-	}
-	if ( isset( $args['post__in'] ) ) {
-		$sql .= ' AND r.' . $args['as'] . '_id IN (' . implode( ',', $args['post__in'] ) . ')';
-	}
-	// Add predicate filter if required.
-	if ( isset( $args['with_predicate'] ) ) {
-		// Sql Inner Join clause.
-		$sql .= $wpdb->prepare( ' AND r.predicate = %s', $args['with_predicate'] );
-	}
-
-	// Add the taxonomy related sql.
-	$sql .= $tax_sql['where'];
-
-	// Add a group by clause to avoid duplicated rows
-	// @todo: isn't a distinct a better choice?
-	$sql .= ' GROUP BY p.id';
-
-	// @todo: how does `first` represent the limit?
-	if ( isset( $args['first'] ) && is_numeric( $args['first'] ) ) {
-		// Sql Inner Join clause.
-		$sql .= $wpdb->prepare( ' LIMIT %d', $args['first'] );
-	}
-	// Close sql statement
-	$sql .= ';';
-
-	return $sql;
+    // Prepare interaction with db
+    global $wpdb;
+
+    // Retrieve Wordlift relation instances table name
+    $table_name = wl_core_get_relation_instances_table_name();
+
+    // When type is set to `post` we're looking for `post`s that are not
+    // configured as entities.
+    // When the type is set to `entity` we're looking also for `post`s that are
+    // configured as entities.
+
+    // Since we want Find only articles, based on the entity type, we need
+    // to figure out the relevant sql statements to add to the join and where
+    // parts.
+    if ( 'entity' === $args['post_type'] ) {
+        $tax_query = array(
+            'relation' => 'AND',
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'operator' => 'EXISTS',
+            ),
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'field'    => 'slug',
+                'terms'    => 'article',
+                'operator' => 'NOT IN',
+            ),
+        );
+    } else {
+        $tax_query = array(
+            'relation' => 'OR',
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'operator' => 'NOT EXISTS',
+            ),
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'field'    => 'slug',
+                'terms'    => 'article',
+            ),
+        );
+    }
+
+    // Use "p" as the table to match the initial join.
+    $tax_sql = get_tax_sql( $tax_query, 'p', 'ID' );
+
+    // Sql Action
+    $sql = 'SELECT ';
+    // Determine what has to be returned depending on 'get' argument value
+    switch ( $args['get'] ) {
+        case 'posts':
+            $sql .= 'p.*';
+            break;
+        case 'post_ids':
+            $sql .= 'p.id';
+            break;
+    }
+
+    // If we look for posts related as objects the JOIN has to be done with the object_id column and viceversa
+    $join_column = $args['as'] . '_id';
+
+    $sql .= " FROM $wpdb->posts as p JOIN $table_name as r ON p.id = r.$join_column";
+
+    // Changing left join generate by the tax query into an inner since the term relationship has to exist.
+    $sql .= str_replace( 'LEFT JOIN', 'INNER JOIN', $tax_sql['join'] );
+
+    // Sql add post type filter
+    $post_types = Wordlift_Entity_Service::valid_entity_post_types();
+    $sql       .= " AND p.post_type IN ('" . join( "', '", esc_sql( $post_types ) ) . "') AND";
+
+    // Sql add post status filter
+    if ( isset( $args['post_status'] ) && $args['post_status'] !== null ) {
+        $sql .= $wpdb->prepare( ' p.post_status = %s AND', $args['post_status'] );
+    }
+
+    // Add filtering conditions
+    // If we look for posts related as objects this means that
+    // related_to is a reference for a subject: subject_id is the filtering column
+    // If we look for posts related as subject this means that
+    // related_to is reference for an object: object_id is the filtering column
+
+    $filtering_column = ( 'object' === $args['as'] ) ? 'subject_id' : 'object_id';
+
+    if ( isset( $args['related_to'] ) ) {
+        // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+        $sql .= $wpdb->prepare( " r.$filtering_column = %d", $args['related_to'] );
+    }
+    if ( isset( $args['related_to'] ) && isset( $args['related_to__in'] ) ) {
+        $sql .= ' AND';
+    }
+    if ( isset( $args['related_to__in'] ) ) {
+        $sql .= " r.$filtering_column IN (" . implode( ',', $args['related_to__in'] ) . ')';
+        // The IDs used for filtering shouldn't be in the results.
+        $sql .= ' AND p.ID NOT IN (' . implode( ',', $args['related_to__in'] ) . ')';
+    }
+    if ( isset( $args['post__not_in'] ) ) {
+        $sql .= ' AND r.' . $args['as'] . '_id NOT IN (' . implode( ',', $args['post__not_in'] ) . ')';
+    }
+    if ( isset( $args['post__in'] ) ) {
+        $sql .= ' AND r.' . $args['as'] . '_id IN (' . implode( ',', $args['post__in'] ) . ')';
+    }
+    // Add predicate filter if required.
+    if ( isset( $args['with_predicate'] ) ) {
+        // Sql Inner Join clause.
+        $sql .= $wpdb->prepare( ' AND r.predicate = %s', $args['with_predicate'] );
+    }
+
+    // Add the taxonomy related sql.
+    $sql .= $tax_sql['where'];
+
+    // Add a group by clause to avoid duplicated rows
+    // @todo: isn't a distinct a better choice?
+    $sql .= ' GROUP BY p.id';
+
+    // @todo: how does `first` represent the limit?
+    if ( isset( $args['first'] ) && is_numeric( $args['first'] ) ) {
+        // Sql Inner Join clause.
+        $sql .= $wpdb->prepare( ' LIMIT %d', $args['first'] );
+    }
+    // Close sql statement
+    $sql .= ';';
+
+    return $sql;
 
 }
 
@@ -605,73 +605,73 @@ 
  */
 function wl_core_get_posts( $args, $returned_type = OBJECT ) {
 
-	// Merge given args with defaults args value
-	$args = array_merge(
-		array(
-			'with_predicate' => null,
-			'as'             => 'subject',
-			'post_type'      => 'post',
-			'get'            => 'posts',
-			'post_status'    => null,
-		),
-		$args
-	);
-
-	// Arguments validation rules
-	// At least one between related_to and related_to__in has to be set
-	if ( ! isset( $args['related_to'] ) && ! isset( $args['related_to__in'] ) ) {
-		return false;
-	}
-	if ( isset( $args['related_to'] ) && ! is_numeric( $args['related_to'] ) ) {
-		return false;
-	}
-
-	// The same check is applied to post_in, post__not_in and related_to__in options
-	// Only arrays with at least one numeric value are considerad valid
-	// The argument value is further sanitized in order to clean up not numeric values
-	foreach (
-		array(
-			'post__in',
-			'post__not_in',
-			'related_to__in',
-		) as $option_name
-	) {
-		if ( isset( $args[ $option_name ] ) ) {
-			if ( ! is_array( $args[ $option_name ] ) || 0 === count( array_filter( $args[ $option_name ], 'is_numeric' ) ) ) {
-				return false;
-			}
-			// Sanitize value removing non numeric values from the array
-			$args[ $option_name ] = array_filter( $args[ $option_name ], 'is_numeric' );
-		}
-	}
-	// Performing validation rules
-	foreach ( wl_core_get_validation_rules() as $option_name => $accepted_values ) {
-		if ( isset( $args[ $option_name ] ) && ( $args[ $option_name ] ) !== null ) {
-			if ( ! in_array( $args[ $option_name ], $accepted_values, true ) ) {
-				return false;
-			}
-		}
-	}
-
-	// Prepare interaction with db
-	global $wpdb;
-
-	// Build sql statement with given arguments
-	$sql_statement = wl_core_sql_query_builder( $args );
-
-	// If ids are required, returns a one-dimensional array containing ids.
-	// Otherwise an array of associative arrays representing the post | relation object
-	if ( 'post_ids' === $args['get'] ) {
-		// See https://codex.wordpress.org/Class_Reference/wpdb#SELECT_a_Column
-		$results = $wpdb->get_col( $sql_statement ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-	} else {
-		$results = $wpdb->get_results( $sql_statement, $returned_type ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-	}
-	// If there were an error performing the query then false is returned
-	if ( ! empty( $wpdb->last_error ) ) {
-		return false;
-	}
-
-	// Finally
-	return $results;
+    // Merge given args with defaults args value
+    $args = array_merge(
+        array(
+            'with_predicate' => null,
+            'as'             => 'subject',
+            'post_type'      => 'post',
+            'get'            => 'posts',
+            'post_status'    => null,
+        ),
+        $args
+    );
+
+    // Arguments validation rules
+    // At least one between related_to and related_to__in has to be set
+    if ( ! isset( $args['related_to'] ) && ! isset( $args['related_to__in'] ) ) {
+        return false;
+    }
+    if ( isset( $args['related_to'] ) && ! is_numeric( $args['related_to'] ) ) {
+        return false;
+    }
+
+    // The same check is applied to post_in, post__not_in and related_to__in options
+    // Only arrays with at least one numeric value are considerad valid
+    // The argument value is further sanitized in order to clean up not numeric values
+    foreach (
+        array(
+            'post__in',
+            'post__not_in',
+            'related_to__in',
+        ) as $option_name
+    ) {
+        if ( isset( $args[ $option_name ] ) ) {
+            if ( ! is_array( $args[ $option_name ] ) || 0 === count( array_filter( $args[ $option_name ], 'is_numeric' ) ) ) {
+                return false;
+            }
+            // Sanitize value removing non numeric values from the array
+            $args[ $option_name ] = array_filter( $args[ $option_name ], 'is_numeric' );
+        }
+    }
+    // Performing validation rules
+    foreach ( wl_core_get_validation_rules() as $option_name => $accepted_values ) {
+        if ( isset( $args[ $option_name ] ) && ( $args[ $option_name ] ) !== null ) {
+            if ( ! in_array( $args[ $option_name ], $accepted_values, true ) ) {
+                return false;
+            }
+        }
+    }
+
+    // Prepare interaction with db
+    global $wpdb;
+
+    // Build sql statement with given arguments
+    $sql_statement = wl_core_sql_query_builder( $args );
+
+    // If ids are required, returns a one-dimensional array containing ids.
+    // Otherwise an array of associative arrays representing the post | relation object
+    if ( 'post_ids' === $args['get'] ) {
+        // See https://codex.wordpress.org/Class_Reference/wpdb#SELECT_a_Column
+        $results = $wpdb->get_col( $sql_statement ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+    } else {
+        $results = $wpdb->get_results( $sql_statement, $returned_type ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+    }
+    // If there were an error performing the query then false is returned
+    if ( ! empty( $wpdb->last_error ) ) {
+        return false;
+    }
+
+    // Finally
+    return $results;
 }

Spacing +70 added lines, -70 removed lines

@@ -16,7 +16,7 @@ 
  *
  * @return bool Return true if supported, false otherwise
  */
-function wl_core_check_relation_predicate_is_supported( $predicate ) {
+function wl_core_check_relation_predicate_is_supported($predicate) {
 
 	return in_array(
 		$predicate,
@@ -38,7 +38,7 @@ 
 function wl_core_get_validation_rules() {
 
 	// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
-	return unserialize( WL_CORE_GET_POSTS_VALIDATION_RULES );
+	return unserialize(WL_CORE_GET_POSTS_VALIDATION_RULES);
 }
 
 /**
@@ -49,7 +49,7 @@ 
 function wl_core_get_relation_instances_table_name() {
 
 	global $wpdb;
-	$table_name = $wpdb->prefix . WL_DB_RELATION_INSTANCES_TABLE_NAME;
+	$table_name = $wpdb->prefix.WL_DB_RELATION_INSTANCES_TABLE_NAME;
 
 	return $table_name;
 }
@@ -66,15 +66,15 @@ 
  * @return integer|boolean Return then relation instance ID or false.
  * @uses   $wpdb->replace() to perform the query
  */
-function wl_core_add_relation_instance( $subject_id, $predicate, $object_id, $subject_type = Object_Type_Enum::POST, $object_type = Object_Type_Enum::POST ) {
+function wl_core_add_relation_instance($subject_id, $predicate, $object_id, $subject_type = Object_Type_Enum::POST, $object_type = Object_Type_Enum::POST) {
 
 	// Checks on subject and object
-	if ( ! is_numeric( $subject_id ) || ! is_numeric( $object_id ) ) {
+	if ( ! is_numeric($subject_id) || ! is_numeric($object_id)) {
 		return false;
 	}
 
 	// Checks on the given relation
-	if ( ! wl_core_check_relation_predicate_is_supported( $predicate ) ) {
+	if ( ! wl_core_check_relation_predicate_is_supported($predicate)) {
 		return false;
 	}
 
@@ -98,7 +98,7 @@ 
 			'subject_type' => $subject_type,
 			'object_type'  => $object_type,
 		),
-		array( '%d', '%s', '%d', '%d', '%d' )
+		array('%d', '%s', '%d', '%d', '%d')
 	);
 
 	/**
@@ -113,7 +113,7 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	do_action( 'wl_relation_added', $subject_id, $predicate, $object_id );
+	do_action('wl_relation_added', $subject_id, $predicate, $object_id);
 
 	// Return record id
 	return $wpdb->insert_id;
@@ -127,10 +127,10 @@ 
  *
  * @return bool False for failure. True for success.
  */
-function wl_core_delete_relation_instances( $subject_id ) {
+function wl_core_delete_relation_instances($subject_id) {
 
 	// Checks on subject and object
-	if ( ! is_numeric( $subject_id ) ) {
+	if ( ! is_numeric($subject_id)) {
 		return false;
 	}
 
@@ -149,7 +149,7 @@ 
 		array(
 			'subject_id' => $subject_id,
 		),
-		array( '%d' )
+		array('%d')
 	);
 
 	/**
@@ -161,7 +161,7 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	do_action( 'wl_relation_deleted', $subject_id );
+	do_action('wl_relation_deleted', $subject_id);
 
 	return true;
 }
@@ -177,16 +177,16 @@ 
  *      'status'    => null
  *  );
  */
-function wl_core_validate_filters_for_related( $filters ) {
+function wl_core_validate_filters_for_related($filters) {
 
-	if ( ! is_array( $filters ) ) {
+	if ( ! is_array($filters)) {
 		$filters = array();
 	}
 
-	if ( ! isset( $filters['predicate'] ) ) {
+	if ( ! isset($filters['predicate'])) {
 		$filters['predicate'] = null;
 	}
-	if ( ! isset( $filters['status'] ) ) {
+	if ( ! isset($filters['status'])) {
 		$filters['status'] = null;
 	}
 
@@ -235,12 +235,12 @@ 
  *
  * @deprecated use Wordlift_Relation_Service::get_instance()->get_objects( $subject_id, 'ids', $predicate, $status );
  */
-function wl_core_get_related_entity_ids( $subject_id, $filters = array() ) {
+function wl_core_get_related_entity_ids($subject_id, $filters = array()) {
 
-	$status    = isset( $filters['status'] ) ? $filters['status'] : null;
-	$predicate = isset( $filters['predicate'] ) ? $filters['predicate'] : null;
+	$status    = isset($filters['status']) ? $filters['status'] : null;
+	$predicate = isset($filters['predicate']) ? $filters['predicate'] : null;
 
-	return Wordlift_Relation_Service::get_instance()->get_objects( $subject_id, 'ids', $predicate, $status );
+	return Wordlift_Relation_Service::get_instance()->get_objects($subject_id, 'ids', $predicate, $status);
 
 	// $filters = wl_core_validate_filters_for_related( $filters );
 	//
@@ -258,13 +258,13 @@ 
  * @return array An array of {@link WP_Post}s.
  * @deprecated use Wordlift_Relation_Service::get_instance()->get_objects()
  */
-function wl_core_get_related_entities( $subject_id, $filters = array() ) {
+function wl_core_get_related_entities($subject_id, $filters = array()) {
 
-	$ids = wl_core_get_related_entity_ids( $subject_id, $filters );
+	$ids = wl_core_get_related_entity_ids($subject_id, $filters);
 
 	return array_map(
-		function ( $item ) {
-			return get_post( $item );
+		function($item) {
+			return get_post($item);
 		},
 		$ids
 	);
@@ -342,14 +342,14 @@ 
  *
  * @deprecated use Wordlift_Relation_Service::get_instance()->get_article_subjects( $object_id, 'ids', $status );
  */
-function wl_core_get_related_post_ids( $object_id, $filters = array() ) {
+function wl_core_get_related_post_ids($object_id, $filters = array()) {
 
 	$relation_service = Wordlift_Relation_Service::get_instance();
 
-	$status    = isset( $filters['status'] ) ? $filters['status'] : null;
-	$predicate = isset( $filters['predicate'] ) ? $filters['predicate'] : null;
+	$status    = isset($filters['status']) ? $filters['status'] : null;
+	$predicate = isset($filters['predicate']) ? $filters['predicate'] : null;
 
-	return $relation_service->get_article_subjects( $object_id, 'ids', $predicate, $status );
+	return $relation_service->get_article_subjects($object_id, 'ids', $predicate, $status);
 	//
 	// $filters = wl_core_validate_filters_for_related( $filters );
 	//
@@ -369,13 +369,13 @@ 
  * @return array An array of {@link WP_Post}s.
  * @deprecated use Wordlift_Relation_Service::get_instance()->get_article_subjects()
  */
-function wl_core_get_related_posts( $subject_id, $filters = array() ) {
+function wl_core_get_related_posts($subject_id, $filters = array()) {
 
-	$ids = wl_core_get_related_post_ids( $subject_id, $filters );
+	$ids = wl_core_get_related_post_ids($subject_id, $filters);
 
 	return array_map(
-		function ( $item ) {
-			return get_post( $item );
+		function($item) {
+			return get_post($item);
 		},
 		$ids
 	);
@@ -462,7 +462,7 @@ 
  *
  * @return string|false String representing a sql statement, or false in case of error
  */
-function wl_core_sql_query_builder( $args ) {
+function wl_core_sql_query_builder($args) {
 
 	// Prepare interaction with db
 	global $wpdb;
@@ -478,7 +478,7 @@ 
 	// Since we want Find only articles, based on the entity type, we need
 	// to figure out the relevant sql statements to add to the join and where
 	// parts.
-	if ( 'entity' === $args['post_type'] ) {
+	if ('entity' === $args['post_type']) {
 		$tax_query = array(
 			'relation' => 'AND',
 			array(
@@ -508,12 +508,12 @@ 
 	}
 
 	// Use "p" as the table to match the initial join.
-	$tax_sql = get_tax_sql( $tax_query, 'p', 'ID' );
+	$tax_sql = get_tax_sql($tax_query, 'p', 'ID');
 
 	// Sql Action
 	$sql = 'SELECT ';
 	// Determine what has to be returned depending on 'get' argument value
-	switch ( $args['get'] ) {
+	switch ($args['get']) {
 		case 'posts':
 			$sql .= 'p.*';
 			break;
@@ -523,20 +523,20 @@ 
 	}
 
 	// If we look for posts related as objects the JOIN has to be done with the object_id column and viceversa
-	$join_column = $args['as'] . '_id';
+	$join_column = $args['as'].'_id';
 
 	$sql .= " FROM $wpdb->posts as p JOIN $table_name as r ON p.id = r.$join_column";
 
 	// Changing left join generate by the tax query into an inner since the term relationship has to exist.
-	$sql .= str_replace( 'LEFT JOIN', 'INNER JOIN', $tax_sql['join'] );
+	$sql .= str_replace('LEFT JOIN', 'INNER JOIN', $tax_sql['join']);
 
 	// Sql add post type filter
 	$post_types = Wordlift_Entity_Service::valid_entity_post_types();
-	$sql       .= " AND p.post_type IN ('" . join( "', '", esc_sql( $post_types ) ) . "') AND";
+	$sql       .= " AND p.post_type IN ('".join("', '", esc_sql($post_types))."') AND";
 
 	// Sql add post status filter
-	if ( isset( $args['post_status'] ) && $args['post_status'] !== null ) {
-		$sql .= $wpdb->prepare( ' p.post_status = %s AND', $args['post_status'] );
+	if (isset($args['post_status']) && $args['post_status'] !== null) {
+		$sql .= $wpdb->prepare(' p.post_status = %s AND', $args['post_status']);
 	}
 
 	// Add filtering conditions
@@ -545,30 +545,30 @@ 
 	// If we look for posts related as subject this means that
 	// related_to is reference for an object: object_id is the filtering column
 
-	$filtering_column = ( 'object' === $args['as'] ) ? 'subject_id' : 'object_id';
+	$filtering_column = ('object' === $args['as']) ? 'subject_id' : 'object_id';
 
-	if ( isset( $args['related_to'] ) ) {
+	if (isset($args['related_to'])) {
 		// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-		$sql .= $wpdb->prepare( " r.$filtering_column = %d", $args['related_to'] );
+		$sql .= $wpdb->prepare(" r.$filtering_column = %d", $args['related_to']);
 	}
-	if ( isset( $args['related_to'] ) && isset( $args['related_to__in'] ) ) {
+	if (isset($args['related_to']) && isset($args['related_to__in'])) {
 		$sql .= ' AND';
 	}
-	if ( isset( $args['related_to__in'] ) ) {
-		$sql .= " r.$filtering_column IN (" . implode( ',', $args['related_to__in'] ) . ')';
+	if (isset($args['related_to__in'])) {
+		$sql .= " r.$filtering_column IN (".implode(',', $args['related_to__in']).')';
 		// The IDs used for filtering shouldn't be in the results.
-		$sql .= ' AND p.ID NOT IN (' . implode( ',', $args['related_to__in'] ) . ')';
+		$sql .= ' AND p.ID NOT IN ('.implode(',', $args['related_to__in']).')';
 	}
-	if ( isset( $args['post__not_in'] ) ) {
-		$sql .= ' AND r.' . $args['as'] . '_id NOT IN (' . implode( ',', $args['post__not_in'] ) . ')';
+	if (isset($args['post__not_in'])) {
+		$sql .= ' AND r.'.$args['as'].'_id NOT IN ('.implode(',', $args['post__not_in']).')';
 	}
-	if ( isset( $args['post__in'] ) ) {
-		$sql .= ' AND r.' . $args['as'] . '_id IN (' . implode( ',', $args['post__in'] ) . ')';
+	if (isset($args['post__in'])) {
+		$sql .= ' AND r.'.$args['as'].'_id IN ('.implode(',', $args['post__in']).')';
 	}
 	// Add predicate filter if required.
-	if ( isset( $args['with_predicate'] ) ) {
+	if (isset($args['with_predicate'])) {
 		// Sql Inner Join clause.
-		$sql .= $wpdb->prepare( ' AND r.predicate = %s', $args['with_predicate'] );
+		$sql .= $wpdb->prepare(' AND r.predicate = %s', $args['with_predicate']);
 	}
 
 	// Add the taxonomy related sql.
@@ -579,9 +579,9 @@ 
 	$sql .= ' GROUP BY p.id';
 
 	// @todo: how does `first` represent the limit?
-	if ( isset( $args['first'] ) && is_numeric( $args['first'] ) ) {
+	if (isset($args['first']) && is_numeric($args['first'])) {
 		// Sql Inner Join clause.
-		$sql .= $wpdb->prepare( ' LIMIT %d', $args['first'] );
+		$sql .= $wpdb->prepare(' LIMIT %d', $args['first']);
 	}
 	// Close sql statement
 	$sql .= ';';
@@ -603,7 +603,7 @@ 
  *
  * @uses   wl_core_sql_query_builder() to compose the sql statement
  */
-function wl_core_get_posts( $args, $returned_type = OBJECT ) {
+function wl_core_get_posts($args, $returned_type = OBJECT) {
 
 	// Merge given args with defaults args value
 	$args = array_merge(
@@ -619,10 +619,10 @@ 
 
 	// Arguments validation rules
 	// At least one between related_to and related_to__in has to be set
-	if ( ! isset( $args['related_to'] ) && ! isset( $args['related_to__in'] ) ) {
+	if ( ! isset($args['related_to']) && ! isset($args['related_to__in'])) {
 		return false;
 	}
-	if ( isset( $args['related_to'] ) && ! is_numeric( $args['related_to'] ) ) {
+	if (isset($args['related_to']) && ! is_numeric($args['related_to'])) {
 		return false;
 	}
 
@@ -636,18 +636,18 @@ 
 			'related_to__in',
 		) as $option_name
 	) {
-		if ( isset( $args[ $option_name ] ) ) {
-			if ( ! is_array( $args[ $option_name ] ) || 0 === count( array_filter( $args[ $option_name ], 'is_numeric' ) ) ) {
+		if (isset($args[$option_name])) {
+			if ( ! is_array($args[$option_name]) || 0 === count(array_filter($args[$option_name], 'is_numeric'))) {
 				return false;
 			}
 			// Sanitize value removing non numeric values from the array
-			$args[ $option_name ] = array_filter( $args[ $option_name ], 'is_numeric' );
+			$args[$option_name] = array_filter($args[$option_name], 'is_numeric');
 		}
 	}
 	// Performing validation rules
-	foreach ( wl_core_get_validation_rules() as $option_name => $accepted_values ) {
-		if ( isset( $args[ $option_name ] ) && ( $args[ $option_name ] ) !== null ) {
-			if ( ! in_array( $args[ $option_name ], $accepted_values, true ) ) {
+	foreach (wl_core_get_validation_rules() as $option_name => $accepted_values) {
+		if (isset($args[$option_name]) && ($args[$option_name]) !== null) {
+			if ( ! in_array($args[$option_name], $accepted_values, true)) {
 				return false;
 			}
 		}
@@ -657,18 +657,18 @@ 
 	global $wpdb;
 
 	// Build sql statement with given arguments
-	$sql_statement = wl_core_sql_query_builder( $args );
+	$sql_statement = wl_core_sql_query_builder($args);
 
 	// If ids are required, returns a one-dimensional array containing ids.
 	// Otherwise an array of associative arrays representing the post | relation object
-	if ( 'post_ids' === $args['get'] ) {
+	if ('post_ids' === $args['get']) {
 		// See https://codex.wordpress.org/Class_Reference/wpdb#SELECT_a_Column
-		$results = $wpdb->get_col( $sql_statement ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+		$results = $wpdb->get_col($sql_statement); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 	} else {
-		$results = $wpdb->get_results( $sql_statement, $returned_type ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+		$results = $wpdb->get_results($sql_statement, $returned_type); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 	}
 	// If there were an error performing the query then false is returned
-	if ( ! empty( $wpdb->last_error ) ) {
+	if ( ! empty($wpdb->last_error)) {
 		return false;
 	}
 

src/modules/acf4so/vendor/composer/ClassLoader.php

Indentation +370 added lines, -370 removed lines

@@ -42,375 +42,375 @@ 
  */
 class ClassLoader {
 
-	// PSR-4
-	private $prefixLengthsPsr4 = array();
-	private $prefixDirsPsr4    = array();
-	private $fallbackDirsPsr4  = array();
-
-	// PSR-0
-	private $prefixesPsr0     = array();
-	private $fallbackDirsPsr0 = array();
-
-	private $useIncludePath        = false;
-	private $classMap              = array();
-	private $classMapAuthoritative = false;
-	private $missingClasses        = array();
-	private $apcuPrefix;
-
-	public function getPrefixes() {
-		if ( ! empty( $this->prefixesPsr0 ) ) {
-			return call_user_func_array( 'array_merge', array_values( $this->prefixesPsr0 ) );
-		}
-
-		return array();
-	}
-
-	public function getPrefixesPsr4() {
-		return $this->prefixDirsPsr4;
-	}
-
-	public function getFallbackDirs() {
-		return $this->fallbackDirsPsr0;
-	}
-
-	public function getFallbackDirsPsr4() {
-		return $this->fallbackDirsPsr4;
-	}
-
-	public function getClassMap() {
-		return $this->classMap;
-	}
-
-	/**
-	 * @param array $classMap Class to filename map
-	 */
-	public function addClassMap( array $classMap ) {
-		if ( $this->classMap ) {
-			$this->classMap = array_merge( $this->classMap, $classMap );
-		} else {
-			$this->classMap = $classMap;
-		}
-	}
-
-	/**
-	 * Registers a set of PSR-0 directories for a given prefix, either
-	 * appending or prepending to the ones previously set for this prefix.
-	 *
-	 * @param string       $prefix  The prefix
-	 * @param array|string $paths   The PSR-0 root directories
-	 * @param bool         $prepend Whether to prepend the directories
-	 */
-	public function add( $prefix, $paths, $prepend = false ) {
-		if ( ! $prefix ) {
-			if ( $prepend ) {
-				$this->fallbackDirsPsr0 = array_merge(
-					(array) $paths,
-					$this->fallbackDirsPsr0
-				);
-			} else {
-				$this->fallbackDirsPsr0 = array_merge(
-					$this->fallbackDirsPsr0,
-					(array) $paths
-				);
-			}
-
-			return;
-		}
-
-		$first = $prefix[0];
-		if ( ! isset( $this->prefixesPsr0[ $first ][ $prefix ] ) ) {
-			$this->prefixesPsr0[ $first ][ $prefix ] = (array) $paths;
-
-			return;
-		}
-		if ( $prepend ) {
-			$this->prefixesPsr0[ $first ][ $prefix ] = array_merge(
-				(array) $paths,
-				$this->prefixesPsr0[ $first ][ $prefix ]
-			);
-		} else {
-			$this->prefixesPsr0[ $first ][ $prefix ] = array_merge(
-				$this->prefixesPsr0[ $first ][ $prefix ],
-				(array) $paths
-			);
-		}
-	}
-
-	/**
-	 * Registers a set of PSR-4 directories for a given namespace, either
-	 * appending or prepending to the ones previously set for this namespace.
-	 *
-	 * @param string       $prefix  The prefix/namespace, with trailing '\\'
-	 * @param array|string $paths   The PSR-4 base directories
-	 * @param bool         $prepend Whether to prepend the directories
-	 *
-	 * @throws \InvalidArgumentException
-	 */
-	public function addPsr4( $prefix, $paths, $prepend = false ) {
-		if ( ! $prefix ) {
-			// Register directories for the root namespace.
-			if ( $prepend ) {
-				$this->fallbackDirsPsr4 = array_merge(
-					(array) $paths,
-					$this->fallbackDirsPsr4
-				);
-			} else {
-				$this->fallbackDirsPsr4 = array_merge(
-					$this->fallbackDirsPsr4,
-					(array) $paths
-				);
-			}
-		} elseif ( ! isset( $this->prefixDirsPsr4[ $prefix ] ) ) {
-			// Register directories for a new namespace.
-			$length = strlen( $prefix );
-			if ( '\\' !== $prefix[ $length - 1 ] ) {
-				throw new \InvalidArgumentException( 'A non-empty PSR-4 prefix must end with a namespace separator.' );
-			}
-			$this->prefixLengthsPsr4[ $prefix[0] ][ $prefix ] = $length;
-			$this->prefixDirsPsr4[ $prefix ]                  = (array) $paths;
-		} elseif ( $prepend ) {
-			// Prepend directories for an already registered namespace.
-			$this->prefixDirsPsr4[ $prefix ] = array_merge(
-				(array) $paths,
-				$this->prefixDirsPsr4[ $prefix ]
-			);
-		} else {
-			// Append directories for an already registered namespace.
-			$this->prefixDirsPsr4[ $prefix ] = array_merge(
-				$this->prefixDirsPsr4[ $prefix ],
-				(array) $paths
-			);
-		}
-	}
-
-	/**
-	 * Registers a set of PSR-0 directories for a given prefix,
-	 * replacing any others previously set for this prefix.
-	 *
-	 * @param string       $prefix The prefix
-	 * @param array|string $paths  The PSR-0 base directories
-	 */
-	public function set( $prefix, $paths ) {
-		if ( ! $prefix ) {
-			$this->fallbackDirsPsr0 = (array) $paths;
-		} else {
-			$this->prefixesPsr0[ $prefix[0] ][ $prefix ] = (array) $paths;
-		}
-	}
-
-	/**
-	 * Registers a set of PSR-4 directories for a given namespace,
-	 * replacing any others previously set for this namespace.
-	 *
-	 * @param string       $prefix The prefix/namespace, with trailing '\\'
-	 * @param array|string $paths  The PSR-4 base directories
-	 *
-	 * @throws \InvalidArgumentException
-	 */
-	public function setPsr4( $prefix, $paths ) {
-		if ( ! $prefix ) {
-			$this->fallbackDirsPsr4 = (array) $paths;
-		} else {
-			$length = strlen( $prefix );
-			if ( '\\' !== $prefix[ $length - 1 ] ) {
-				throw new \InvalidArgumentException( 'A non-empty PSR-4 prefix must end with a namespace separator.' );
-			}
-			$this->prefixLengthsPsr4[ $prefix[0] ][ $prefix ] = $length;
-			$this->prefixDirsPsr4[ $prefix ]                  = (array) $paths;
-		}
-	}
-
-	/**
-	 * Turns on searching the include path for class files.
-	 *
-	 * @param bool $useIncludePath
-	 */
-	public function setUseIncludePath( $useIncludePath ) {
-		$this->useIncludePath = $useIncludePath;
-	}
-
-	/**
-	 * Can be used to check if the autoloader uses the include path to check
-	 * for classes.
-	 *
-	 * @return bool
-	 */
-	public function getUseIncludePath() {
-		return $this->useIncludePath;
-	}
-
-	/**
-	 * Turns off searching the prefix and fallback directories for classes
-	 * that have not been registered with the class map.
-	 *
-	 * @param bool $classMapAuthoritative
-	 */
-	public function setClassMapAuthoritative( $classMapAuthoritative ) {
-		$this->classMapAuthoritative = $classMapAuthoritative;
-	}
-
-	/**
-	 * Should class lookup fail if not found in the current class map?
-	 *
-	 * @return bool
-	 */
-	public function isClassMapAuthoritative() {
-		return $this->classMapAuthoritative;
-	}
-
-	/**
-	 * APCu prefix to use to cache found/not-found classes, if the extension is enabled.
-	 *
-	 * @param string|null $apcuPrefix
-	 */
-	public function setApcuPrefix( $apcuPrefix ) {
-		$this->apcuPrefix = function_exists( 'apcu_fetch' ) && filter_var( ini_get( 'apc.enabled' ), FILTER_VALIDATE_BOOLEAN ) ? $apcuPrefix : null;
-	}
-
-	/**
-	 * The APCu prefix in use, or null if APCu caching is not enabled.
-	 *
-	 * @return string|null
-	 */
-	public function getApcuPrefix() {
-		return $this->apcuPrefix;
-	}
-
-	/**
-	 * Registers this instance as an autoloader.
-	 *
-	 * @param bool $prepend Whether to prepend the autoloader or not
-	 */
-	public function register( $prepend = false ) {
-		spl_autoload_register( array( $this, 'loadClass' ), true, $prepend );
-	}
-
-	/**
-	 * Unregisters this instance as an autoloader.
-	 */
-	public function unregister() {
-		spl_autoload_unregister( array( $this, 'loadClass' ) );
-	}
-
-	/**
-	 * Loads the given class or interface.
-	 *
-	 * @param  string $class The name of the class
-	 * @return bool|null True if loaded, null otherwise
-	 */
-	public function loadClass( $class ) {
-		if ( $file = $this->findFile( $class ) ) {
-			includeFile( $file );
-
-			return true;
-		}
-	}
-
-	/**
-	 * Finds the path to the file where the class is defined.
-	 *
-	 * @param string $class The name of the class
-	 *
-	 * @return string|false The path if found, false otherwise
-	 */
-	public function findFile( $class ) {
-		// class map lookup
-		if ( isset( $this->classMap[ $class ] ) ) {
-			return $this->classMap[ $class ];
-		}
-		if ( $this->classMapAuthoritative || isset( $this->missingClasses[ $class ] ) ) {
-			return false;
-		}
-		if ( null !== $this->apcuPrefix ) {
-			$file = apcu_fetch( $this->apcuPrefix . $class, $hit );
-			if ( $hit ) {
-				return $file;
-			}
-		}
-
-		$file = $this->findFileWithExtension( $class, '.php' );
-
-		// Search for Hack files if we are running on HHVM
-		if ( false === $file && defined( 'HHVM_VERSION' ) ) {
-			$file = $this->findFileWithExtension( $class, '.hh' );
-		}
-
-		if ( null !== $this->apcuPrefix ) {
-			apcu_add( $this->apcuPrefix . $class, $file );
-		}
-
-		if ( false === $file ) {
-			// Remember that this class does not exist.
-			$this->missingClasses[ $class ] = true;
-		}
-
-		return $file;
-	}
-
-	private function findFileWithExtension( $class, $ext ) {
-		// PSR-4 lookup
-		$logicalPathPsr4 = strtr( $class, '\\', DIRECTORY_SEPARATOR ) . $ext;
-
-		$first = $class[0];
-		if ( isset( $this->prefixLengthsPsr4[ $first ] ) ) {
-			$subPath = $class;
-			while ( false !== $lastPos = strrpos( $subPath, '\\' ) ) {
-				$subPath = substr( $subPath, 0, $lastPos );
-				$search  = $subPath . '\\';
-				if ( isset( $this->prefixDirsPsr4[ $search ] ) ) {
-					$pathEnd = DIRECTORY_SEPARATOR . substr( $logicalPathPsr4, $lastPos + 1 );
-					foreach ( $this->prefixDirsPsr4[ $search ] as $dir ) {
-						if ( file_exists( $file = $dir . $pathEnd ) ) {
-							return $file;
-						}
-					}
-				}
-			}
-		}
-
-		// PSR-4 fallback dirs
-		foreach ( $this->fallbackDirsPsr4 as $dir ) {
-			if ( file_exists( $file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4 ) ) {
-				return $file;
-			}
-		}
-
-		// PSR-0 lookup
-		if ( false !== $pos = strrpos( $class, '\\' ) ) {
-			// namespaced class name
-			$logicalPathPsr0 = substr( $logicalPathPsr4, 0, $pos + 1 )
-				. strtr( substr( $logicalPathPsr4, $pos + 1 ), '_', DIRECTORY_SEPARATOR );
-		} else {
-			// PEAR-like class name
-			$logicalPathPsr0 = strtr( $class, '_', DIRECTORY_SEPARATOR ) . $ext;
-		}
-
-		if ( isset( $this->prefixesPsr0[ $first ] ) ) {
-			foreach ( $this->prefixesPsr0[ $first ] as $prefix => $dirs ) {
-				if ( 0 === strpos( $class, $prefix ) ) {
-					foreach ( $dirs as $dir ) {
-						if ( file_exists( $file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0 ) ) {
-							return $file;
-						}
-					}
-				}
-			}
-		}
-
-		// PSR-0 fallback dirs
-		foreach ( $this->fallbackDirsPsr0 as $dir ) {
-			if ( file_exists( $file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0 ) ) {
-				return $file;
-			}
-		}
-
-		// PSR-0 include paths.
-		if ( $this->useIncludePath && $file = stream_resolve_include_path( $logicalPathPsr0 ) ) {
-			return $file;
-		}
-
-		return false;
-	}
+    // PSR-4
+    private $prefixLengthsPsr4 = array();
+    private $prefixDirsPsr4    = array();
+    private $fallbackDirsPsr4  = array();
+
+    // PSR-0
+    private $prefixesPsr0     = array();
+    private $fallbackDirsPsr0 = array();
+
+    private $useIncludePath        = false;
+    private $classMap              = array();
+    private $classMapAuthoritative = false;
+    private $missingClasses        = array();
+    private $apcuPrefix;
+
+    public function getPrefixes() {
+        if ( ! empty( $this->prefixesPsr0 ) ) {
+            return call_user_func_array( 'array_merge', array_values( $this->prefixesPsr0 ) );
+        }
+
+        return array();
+    }
+
+    public function getPrefixesPsr4() {
+        return $this->prefixDirsPsr4;
+    }
+
+    public function getFallbackDirs() {
+        return $this->fallbackDirsPsr0;
+    }
+
+    public function getFallbackDirsPsr4() {
+        return $this->fallbackDirsPsr4;
+    }
+
+    public function getClassMap() {
+        return $this->classMap;
+    }
+
+    /**
+     * @param array $classMap Class to filename map
+     */
+    public function addClassMap( array $classMap ) {
+        if ( $this->classMap ) {
+            $this->classMap = array_merge( $this->classMap, $classMap );
+        } else {
+            $this->classMap = $classMap;
+        }
+    }
+
+    /**
+     * Registers a set of PSR-0 directories for a given prefix, either
+     * appending or prepending to the ones previously set for this prefix.
+     *
+     * @param string       $prefix  The prefix
+     * @param array|string $paths   The PSR-0 root directories
+     * @param bool         $prepend Whether to prepend the directories
+     */
+    public function add( $prefix, $paths, $prepend = false ) {
+        if ( ! $prefix ) {
+            if ( $prepend ) {
+                $this->fallbackDirsPsr0 = array_merge(
+                    (array) $paths,
+                    $this->fallbackDirsPsr0
+                );
+            } else {
+                $this->fallbackDirsPsr0 = array_merge(
+                    $this->fallbackDirsPsr0,
+                    (array) $paths
+                );
+            }
+
+            return;
+        }
+
+        $first = $prefix[0];
+        if ( ! isset( $this->prefixesPsr0[ $first ][ $prefix ] ) ) {
+            $this->prefixesPsr0[ $first ][ $prefix ] = (array) $paths;
+
+            return;
+        }
+        if ( $prepend ) {
+            $this->prefixesPsr0[ $first ][ $prefix ] = array_merge(
+                (array) $paths,
+                $this->prefixesPsr0[ $first ][ $prefix ]
+            );
+        } else {
+            $this->prefixesPsr0[ $first ][ $prefix ] = array_merge(
+                $this->prefixesPsr0[ $first ][ $prefix ],
+                (array) $paths
+            );
+        }
+    }
+
+    /**
+     * Registers a set of PSR-4 directories for a given namespace, either
+     * appending or prepending to the ones previously set for this namespace.
+     *
+     * @param string       $prefix  The prefix/namespace, with trailing '\\'
+     * @param array|string $paths   The PSR-4 base directories
+     * @param bool         $prepend Whether to prepend the directories
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function addPsr4( $prefix, $paths, $prepend = false ) {
+        if ( ! $prefix ) {
+            // Register directories for the root namespace.
+            if ( $prepend ) {
+                $this->fallbackDirsPsr4 = array_merge(
+                    (array) $paths,
+                    $this->fallbackDirsPsr4
+                );
+            } else {
+                $this->fallbackDirsPsr4 = array_merge(
+                    $this->fallbackDirsPsr4,
+                    (array) $paths
+                );
+            }
+        } elseif ( ! isset( $this->prefixDirsPsr4[ $prefix ] ) ) {
+            // Register directories for a new namespace.
+            $length = strlen( $prefix );
+            if ( '\\' !== $prefix[ $length - 1 ] ) {
+                throw new \InvalidArgumentException( 'A non-empty PSR-4 prefix must end with a namespace separator.' );
+            }
+            $this->prefixLengthsPsr4[ $prefix[0] ][ $prefix ] = $length;
+            $this->prefixDirsPsr4[ $prefix ]                  = (array) $paths;
+        } elseif ( $prepend ) {
+            // Prepend directories for an already registered namespace.
+            $this->prefixDirsPsr4[ $prefix ] = array_merge(
+                (array) $paths,
+                $this->prefixDirsPsr4[ $prefix ]
+            );
+        } else {
+            // Append directories for an already registered namespace.
+            $this->prefixDirsPsr4[ $prefix ] = array_merge(
+                $this->prefixDirsPsr4[ $prefix ],
+                (array) $paths
+            );
+        }
+    }
+
+    /**
+     * Registers a set of PSR-0 directories for a given prefix,
+     * replacing any others previously set for this prefix.
+     *
+     * @param string       $prefix The prefix
+     * @param array|string $paths  The PSR-0 base directories
+     */
+    public function set( $prefix, $paths ) {
+        if ( ! $prefix ) {
+            $this->fallbackDirsPsr0 = (array) $paths;
+        } else {
+            $this->prefixesPsr0[ $prefix[0] ][ $prefix ] = (array) $paths;
+        }
+    }
+
+    /**
+     * Registers a set of PSR-4 directories for a given namespace,
+     * replacing any others previously set for this namespace.
+     *
+     * @param string       $prefix The prefix/namespace, with trailing '\\'
+     * @param array|string $paths  The PSR-4 base directories
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function setPsr4( $prefix, $paths ) {
+        if ( ! $prefix ) {
+            $this->fallbackDirsPsr4 = (array) $paths;
+        } else {
+            $length = strlen( $prefix );
+            if ( '\\' !== $prefix[ $length - 1 ] ) {
+                throw new \InvalidArgumentException( 'A non-empty PSR-4 prefix must end with a namespace separator.' );
+            }
+            $this->prefixLengthsPsr4[ $prefix[0] ][ $prefix ] = $length;
+            $this->prefixDirsPsr4[ $prefix ]                  = (array) $paths;
+        }
+    }
+
+    /**
+     * Turns on searching the include path for class files.
+     *
+     * @param bool $useIncludePath
+     */
+    public function setUseIncludePath( $useIncludePath ) {
+        $this->useIncludePath = $useIncludePath;
+    }
+
+    /**
+     * Can be used to check if the autoloader uses the include path to check
+     * for classes.
+     *
+     * @return bool
+     */
+    public function getUseIncludePath() {
+        return $this->useIncludePath;
+    }
+
+    /**
+     * Turns off searching the prefix and fallback directories for classes
+     * that have not been registered with the class map.
+     *
+     * @param bool $classMapAuthoritative
+     */
+    public function setClassMapAuthoritative( $classMapAuthoritative ) {
+        $this->classMapAuthoritative = $classMapAuthoritative;
+    }
+
+    /**
+     * Should class lookup fail if not found in the current class map?
+     *
+     * @return bool
+     */
+    public function isClassMapAuthoritative() {
+        return $this->classMapAuthoritative;
+    }
+
+    /**
+     * APCu prefix to use to cache found/not-found classes, if the extension is enabled.
+     *
+     * @param string|null $apcuPrefix
+     */
+    public function setApcuPrefix( $apcuPrefix ) {
+        $this->apcuPrefix = function_exists( 'apcu_fetch' ) && filter_var( ini_get( 'apc.enabled' ), FILTER_VALIDATE_BOOLEAN ) ? $apcuPrefix : null;
+    }
+
+    /**
+     * The APCu prefix in use, or null if APCu caching is not enabled.
+     *
+     * @return string|null
+     */
+    public function getApcuPrefix() {
+        return $this->apcuPrefix;
+    }
+
+    /**
+     * Registers this instance as an autoloader.
+     *
+     * @param bool $prepend Whether to prepend the autoloader or not
+     */
+    public function register( $prepend = false ) {
+        spl_autoload_register( array( $this, 'loadClass' ), true, $prepend );
+    }
+
+    /**
+     * Unregisters this instance as an autoloader.
+     */
+    public function unregister() {
+        spl_autoload_unregister( array( $this, 'loadClass' ) );
+    }
+
+    /**
+     * Loads the given class or interface.
+     *
+     * @param  string $class The name of the class
+     * @return bool|null True if loaded, null otherwise
+     */
+    public function loadClass( $class ) {
+        if ( $file = $this->findFile( $class ) ) {
+            includeFile( $file );
+
+            return true;
+        }
+    }
+
+    /**
+     * Finds the path to the file where the class is defined.
+     *
+     * @param string $class The name of the class
+     *
+     * @return string|false The path if found, false otherwise
+     */
+    public function findFile( $class ) {
+        // class map lookup
+        if ( isset( $this->classMap[ $class ] ) ) {
+            return $this->classMap[ $class ];
+        }
+        if ( $this->classMapAuthoritative || isset( $this->missingClasses[ $class ] ) ) {
+            return false;
+        }
+        if ( null !== $this->apcuPrefix ) {
+            $file = apcu_fetch( $this->apcuPrefix . $class, $hit );
+            if ( $hit ) {
+                return $file;
+            }
+        }
+
+        $file = $this->findFileWithExtension( $class, '.php' );
+
+        // Search for Hack files if we are running on HHVM
+        if ( false === $file && defined( 'HHVM_VERSION' ) ) {
+            $file = $this->findFileWithExtension( $class, '.hh' );
+        }
+
+        if ( null !== $this->apcuPrefix ) {
+            apcu_add( $this->apcuPrefix . $class, $file );
+        }
+
+        if ( false === $file ) {
+            // Remember that this class does not exist.
+            $this->missingClasses[ $class ] = true;
+        }
+
+        return $file;
+    }
+
+    private function findFileWithExtension( $class, $ext ) {
+        // PSR-4 lookup
+        $logicalPathPsr4 = strtr( $class, '\\', DIRECTORY_SEPARATOR ) . $ext;
+
+        $first = $class[0];
+        if ( isset( $this->prefixLengthsPsr4[ $first ] ) ) {
+            $subPath = $class;
+            while ( false !== $lastPos = strrpos( $subPath, '\\' ) ) {
+                $subPath = substr( $subPath, 0, $lastPos );
+                $search  = $subPath . '\\';
+                if ( isset( $this->prefixDirsPsr4[ $search ] ) ) {
+                    $pathEnd = DIRECTORY_SEPARATOR . substr( $logicalPathPsr4, $lastPos + 1 );
+                    foreach ( $this->prefixDirsPsr4[ $search ] as $dir ) {
+                        if ( file_exists( $file = $dir . $pathEnd ) ) {
+                            return $file;
+                        }
+                    }
+                }
+            }
+        }
+
+        // PSR-4 fallback dirs
+        foreach ( $this->fallbackDirsPsr4 as $dir ) {
+            if ( file_exists( $file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4 ) ) {
+                return $file;
+            }
+        }
+
+        // PSR-0 lookup
+        if ( false !== $pos = strrpos( $class, '\\' ) ) {
+            // namespaced class name
+            $logicalPathPsr0 = substr( $logicalPathPsr4, 0, $pos + 1 )
+                . strtr( substr( $logicalPathPsr4, $pos + 1 ), '_', DIRECTORY_SEPARATOR );
+        } else {
+            // PEAR-like class name
+            $logicalPathPsr0 = strtr( $class, '_', DIRECTORY_SEPARATOR ) . $ext;
+        }
+
+        if ( isset( $this->prefixesPsr0[ $first ] ) ) {
+            foreach ( $this->prefixesPsr0[ $first ] as $prefix => $dirs ) {
+                if ( 0 === strpos( $class, $prefix ) ) {
+                    foreach ( $dirs as $dir ) {
+                        if ( file_exists( $file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0 ) ) {
+                            return $file;
+                        }
+                    }
+                }
+            }
+        }
+
+        // PSR-0 fallback dirs
+        foreach ( $this->fallbackDirsPsr0 as $dir ) {
+            if ( file_exists( $file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0 ) ) {
+                return $file;
+            }
+        }
+
+        // PSR-0 include paths.
+        if ( $this->useIncludePath && $file = stream_resolve_include_path( $logicalPathPsr0 ) ) {
+            return $file;
+        }
+
+        return false;
+    }
 }
 
 /**
@@ -419,5 +419,5 @@ 
  * Prevents access to $this/self from included files.
  */
 function includeFile( $file ) {
-	include $file;
+    include $file;
 }

Spacing +88 added lines, -88 removed lines

@@ -58,8 +58,8 @@ 
 	private $apcuPrefix;
 
 	public function getPrefixes() {
-		if ( ! empty( $this->prefixesPsr0 ) ) {
-			return call_user_func_array( 'array_merge', array_values( $this->prefixesPsr0 ) );
+		if ( ! empty($this->prefixesPsr0)) {
+			return call_user_func_array('array_merge', array_values($this->prefixesPsr0));
 		}
 
 		return array();
@@ -84,9 +84,9 @@ 
 	/**
 	 * @param array $classMap Class to filename map
 	 */
-	public function addClassMap( array $classMap ) {
-		if ( $this->classMap ) {
-			$this->classMap = array_merge( $this->classMap, $classMap );
+	public function addClassMap(array $classMap) {
+		if ($this->classMap) {
+			$this->classMap = array_merge($this->classMap, $classMap);
 		} else {
 			$this->classMap = $classMap;
 		}
@@ -100,9 +100,9 @@ 
 	 * @param array|string $paths   The PSR-0 root directories
 	 * @param bool         $prepend Whether to prepend the directories
 	 */
-	public function add( $prefix, $paths, $prepend = false ) {
-		if ( ! $prefix ) {
-			if ( $prepend ) {
+	public function add($prefix, $paths, $prepend = false) {
+		if ( ! $prefix) {
+			if ($prepend) {
 				$this->fallbackDirsPsr0 = array_merge(
 					(array) $paths,
 					$this->fallbackDirsPsr0
@@ -118,19 +118,19 @@ 
 		}
 
 		$first = $prefix[0];
-		if ( ! isset( $this->prefixesPsr0[ $first ][ $prefix ] ) ) {
-			$this->prefixesPsr0[ $first ][ $prefix ] = (array) $paths;
+		if ( ! isset($this->prefixesPsr0[$first][$prefix])) {
+			$this->prefixesPsr0[$first][$prefix] = (array) $paths;
 
 			return;
 		}
-		if ( $prepend ) {
-			$this->prefixesPsr0[ $first ][ $prefix ] = array_merge(
+		if ($prepend) {
+			$this->prefixesPsr0[$first][$prefix] = array_merge(
 				(array) $paths,
-				$this->prefixesPsr0[ $first ][ $prefix ]
+				$this->prefixesPsr0[$first][$prefix]
 			);
 		} else {
-			$this->prefixesPsr0[ $first ][ $prefix ] = array_merge(
-				$this->prefixesPsr0[ $first ][ $prefix ],
+			$this->prefixesPsr0[$first][$prefix] = array_merge(
+				$this->prefixesPsr0[$first][$prefix],
 				(array) $paths
 			);
 		}
@@ -146,10 +146,10 @@ 
 	 *
 	 * @throws \InvalidArgumentException
 	 */
-	public function addPsr4( $prefix, $paths, $prepend = false ) {
-		if ( ! $prefix ) {
+	public function addPsr4($prefix, $paths, $prepend = false) {
+		if ( ! $prefix) {
 			// Register directories for the root namespace.
-			if ( $prepend ) {
+			if ($prepend) {
 				$this->fallbackDirsPsr4 = array_merge(
 					(array) $paths,
 					$this->fallbackDirsPsr4
@@ -160,24 +160,24 @@ 
 					(array) $paths
 				);
 			}
-		} elseif ( ! isset( $this->prefixDirsPsr4[ $prefix ] ) ) {
+		} elseif ( ! isset($this->prefixDirsPsr4[$prefix])) {
 			// Register directories for a new namespace.
-			$length = strlen( $prefix );
-			if ( '\\' !== $prefix[ $length - 1 ] ) {
-				throw new \InvalidArgumentException( 'A non-empty PSR-4 prefix must end with a namespace separator.' );
+			$length = strlen($prefix);
+			if ('\\' !== $prefix[$length - 1]) {
+				throw new \InvalidArgumentException('A non-empty PSR-4 prefix must end with a namespace separator.');
 			}
-			$this->prefixLengthsPsr4[ $prefix[0] ][ $prefix ] = $length;
-			$this->prefixDirsPsr4[ $prefix ]                  = (array) $paths;
-		} elseif ( $prepend ) {
+			$this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
+			$this->prefixDirsPsr4[$prefix]                  = (array) $paths;
+		} elseif ($prepend) {
 			// Prepend directories for an already registered namespace.
-			$this->prefixDirsPsr4[ $prefix ] = array_merge(
+			$this->prefixDirsPsr4[$prefix] = array_merge(
 				(array) $paths,
-				$this->prefixDirsPsr4[ $prefix ]
+				$this->prefixDirsPsr4[$prefix]
 			);
 		} else {
 			// Append directories for an already registered namespace.
-			$this->prefixDirsPsr4[ $prefix ] = array_merge(
-				$this->prefixDirsPsr4[ $prefix ],
+			$this->prefixDirsPsr4[$prefix] = array_merge(
+				$this->prefixDirsPsr4[$prefix],
 				(array) $paths
 			);
 		}
@@ -190,11 +190,11 @@ 
 	 * @param string       $prefix The prefix
 	 * @param array|string $paths  The PSR-0 base directories
 	 */
-	public function set( $prefix, $paths ) {
-		if ( ! $prefix ) {
+	public function set($prefix, $paths) {
+		if ( ! $prefix) {
 			$this->fallbackDirsPsr0 = (array) $paths;
 		} else {
-			$this->prefixesPsr0[ $prefix[0] ][ $prefix ] = (array) $paths;
+			$this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths;
 		}
 	}
 
@@ -207,16 +207,16 @@ 
 	 *
 	 * @throws \InvalidArgumentException
 	 */
-	public function setPsr4( $prefix, $paths ) {
-		if ( ! $prefix ) {
+	public function setPsr4($prefix, $paths) {
+		if ( ! $prefix) {
 			$this->fallbackDirsPsr4 = (array) $paths;
 		} else {
-			$length = strlen( $prefix );
-			if ( '\\' !== $prefix[ $length - 1 ] ) {
-				throw new \InvalidArgumentException( 'A non-empty PSR-4 prefix must end with a namespace separator.' );
+			$length = strlen($prefix);
+			if ('\\' !== $prefix[$length - 1]) {
+				throw new \InvalidArgumentException('A non-empty PSR-4 prefix must end with a namespace separator.');
 			}
-			$this->prefixLengthsPsr4[ $prefix[0] ][ $prefix ] = $length;
-			$this->prefixDirsPsr4[ $prefix ]                  = (array) $paths;
+			$this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
+			$this->prefixDirsPsr4[$prefix]                  = (array) $paths;
 		}
 	}
 
@@ -225,7 +225,7 @@ 
 	 *
 	 * @param bool $useIncludePath
 	 */
-	public function setUseIncludePath( $useIncludePath ) {
+	public function setUseIncludePath($useIncludePath) {
 		$this->useIncludePath = $useIncludePath;
 	}
 
@@ -245,7 +245,7 @@ 
 	 *
 	 * @param bool $classMapAuthoritative
 	 */
-	public function setClassMapAuthoritative( $classMapAuthoritative ) {
+	public function setClassMapAuthoritative($classMapAuthoritative) {
 		$this->classMapAuthoritative = $classMapAuthoritative;
 	}
 
@@ -263,8 +263,8 @@ 
 	 *
 	 * @param string|null $apcuPrefix
 	 */
-	public function setApcuPrefix( $apcuPrefix ) {
-		$this->apcuPrefix = function_exists( 'apcu_fetch' ) && filter_var( ini_get( 'apc.enabled' ), FILTER_VALIDATE_BOOLEAN ) ? $apcuPrefix : null;
+	public function setApcuPrefix($apcuPrefix) {
+		$this->apcuPrefix = function_exists('apcu_fetch') && filter_var(ini_get('apc.enabled'), FILTER_VALIDATE_BOOLEAN) ? $apcuPrefix : null;
 	}
 
 	/**
@@ -281,15 +281,15 @@ 
 	 *
 	 * @param bool $prepend Whether to prepend the autoloader or not
 	 */
-	public function register( $prepend = false ) {
-		spl_autoload_register( array( $this, 'loadClass' ), true, $prepend );
+	public function register($prepend = false) {
+		spl_autoload_register(array($this, 'loadClass'), true, $prepend);
 	}
 
 	/**
 	 * Unregisters this instance as an autoloader.
 	 */
 	public function unregister() {
-		spl_autoload_unregister( array( $this, 'loadClass' ) );
+		spl_autoload_unregister(array($this, 'loadClass'));
 	}
 
 	/**
@@ -298,9 +298,9 @@ 
 	 * @param  string $class The name of the class
 	 * @return bool|null True if loaded, null otherwise
 	 */
-	public function loadClass( $class ) {
-		if ( $file = $this->findFile( $class ) ) {
-			includeFile( $file );
+	public function loadClass($class) {
+		if ($file = $this->findFile($class)) {
+			includeFile($file);
 
 			return true;
 		}
@@ -313,54 +313,54 @@ 
 	 *
 	 * @return string|false The path if found, false otherwise
 	 */
-	public function findFile( $class ) {
+	public function findFile($class) {
 		// class map lookup
-		if ( isset( $this->classMap[ $class ] ) ) {
-			return $this->classMap[ $class ];
+		if (isset($this->classMap[$class])) {
+			return $this->classMap[$class];
 		}
-		if ( $this->classMapAuthoritative || isset( $this->missingClasses[ $class ] ) ) {
+		if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) {
 			return false;
 		}
-		if ( null !== $this->apcuPrefix ) {
-			$file = apcu_fetch( $this->apcuPrefix . $class, $hit );
-			if ( $hit ) {
+		if (null !== $this->apcuPrefix) {
+			$file = apcu_fetch($this->apcuPrefix.$class, $hit);
+			if ($hit) {
 				return $file;
 			}
 		}
 
-		$file = $this->findFileWithExtension( $class, '.php' );
+		$file = $this->findFileWithExtension($class, '.php');
 
 		// Search for Hack files if we are running on HHVM
-		if ( false === $file && defined( 'HHVM_VERSION' ) ) {
-			$file = $this->findFileWithExtension( $class, '.hh' );
+		if (false === $file && defined('HHVM_VERSION')) {
+			$file = $this->findFileWithExtension($class, '.hh');
 		}
 
-		if ( null !== $this->apcuPrefix ) {
-			apcu_add( $this->apcuPrefix . $class, $file );
+		if (null !== $this->apcuPrefix) {
+			apcu_add($this->apcuPrefix.$class, $file);
 		}
 
-		if ( false === $file ) {
+		if (false === $file) {
 			// Remember that this class does not exist.
-			$this->missingClasses[ $class ] = true;
+			$this->missingClasses[$class] = true;
 		}
 
 		return $file;
 	}
 
-	private function findFileWithExtension( $class, $ext ) {
+	private function findFileWithExtension($class, $ext) {
 		// PSR-4 lookup
-		$logicalPathPsr4 = strtr( $class, '\\', DIRECTORY_SEPARATOR ) . $ext;
+		$logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR).$ext;
 
 		$first = $class[0];
-		if ( isset( $this->prefixLengthsPsr4[ $first ] ) ) {
+		if (isset($this->prefixLengthsPsr4[$first])) {
 			$subPath = $class;
-			while ( false !== $lastPos = strrpos( $subPath, '\\' ) ) {
-				$subPath = substr( $subPath, 0, $lastPos );
-				$search  = $subPath . '\\';
-				if ( isset( $this->prefixDirsPsr4[ $search ] ) ) {
-					$pathEnd = DIRECTORY_SEPARATOR . substr( $logicalPathPsr4, $lastPos + 1 );
-					foreach ( $this->prefixDirsPsr4[ $search ] as $dir ) {
-						if ( file_exists( $file = $dir . $pathEnd ) ) {
+			while (false !== $lastPos = strrpos($subPath, '\\')) {
+				$subPath = substr($subPath, 0, $lastPos);
+				$search  = $subPath.'\\';
+				if (isset($this->prefixDirsPsr4[$search])) {
+					$pathEnd = DIRECTORY_SEPARATOR.substr($logicalPathPsr4, $lastPos + 1);
+					foreach ($this->prefixDirsPsr4[$search] as $dir) {
+						if (file_exists($file = $dir.$pathEnd)) {
 							return $file;
 						}
 					}
@@ -369,27 +369,27 @@ 
 		}
 
 		// PSR-4 fallback dirs
-		foreach ( $this->fallbackDirsPsr4 as $dir ) {
-			if ( file_exists( $file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4 ) ) {
+		foreach ($this->fallbackDirsPsr4 as $dir) {
+			if (file_exists($file = $dir.DIRECTORY_SEPARATOR.$logicalPathPsr4)) {
 				return $file;
 			}
 		}
 
 		// PSR-0 lookup
-		if ( false !== $pos = strrpos( $class, '\\' ) ) {
+		if (false !== $pos = strrpos($class, '\\')) {
 			// namespaced class name
-			$logicalPathPsr0 = substr( $logicalPathPsr4, 0, $pos + 1 )
-				. strtr( substr( $logicalPathPsr4, $pos + 1 ), '_', DIRECTORY_SEPARATOR );
+			$logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1)
+				. strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR);
 		} else {
 			// PEAR-like class name
-			$logicalPathPsr0 = strtr( $class, '_', DIRECTORY_SEPARATOR ) . $ext;
+			$logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR).$ext;
 		}
 
-		if ( isset( $this->prefixesPsr0[ $first ] ) ) {
-			foreach ( $this->prefixesPsr0[ $first ] as $prefix => $dirs ) {
-				if ( 0 === strpos( $class, $prefix ) ) {
-					foreach ( $dirs as $dir ) {
-						if ( file_exists( $file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0 ) ) {
+		if (isset($this->prefixesPsr0[$first])) {
+			foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) {
+				if (0 === strpos($class, $prefix)) {
+					foreach ($dirs as $dir) {
+						if (file_exists($file = $dir.DIRECTORY_SEPARATOR.$logicalPathPsr0)) {
 							return $file;
 						}
 					}
@@ -398,14 +398,14 @@ 
 		}
 
 		// PSR-0 fallback dirs
-		foreach ( $this->fallbackDirsPsr0 as $dir ) {
-			if ( file_exists( $file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0 ) ) {
+		foreach ($this->fallbackDirsPsr0 as $dir) {
+			if (file_exists($file = $dir.DIRECTORY_SEPARATOR.$logicalPathPsr0)) {
 				return $file;
 			}
 		}
 
 		// PSR-0 include paths.
-		if ( $this->useIncludePath && $file = stream_resolve_include_path( $logicalPathPsr0 ) ) {
+		if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) {
 			return $file;
 		}
 
@@ -418,6 +418,6 @@ 
  *
  * Prevents access to $this/self from included files.
  */
-function includeFile( $file ) {
+function includeFile($file) {
 	include $file;
 }

src/modules/acf4so/vendor/composer/autoload_namespaces.php

Spacing +2 added lines, -2 removed lines

@@ -2,7 +2,7 @@
 
 // autoload_namespaces.php @generated by Composer
 
-$vendorDir = dirname( ( __DIR__ ) );
-$baseDir   = dirname( $vendorDir );
+$vendorDir = dirname((__DIR__));
+$baseDir   = dirname($vendorDir);
 
 return array();

src/modules/analyzer/wordlift-analyzer.php

Indentation +79 added lines, -79 removed lines

@@ -11,17 +11,17 @@ 
  * @since 3.27.6
  */
 function wl_ajax_analyze_disabled_action() {
-	// adding the below header for debugging purpose.
-	if ( ! headers_sent() ) {
-		header( 'X-WordLift-Analysis: OFF' );
-	}
-	wp_send_json_success(
-		array(
-			'entities'    => array(),
-			'annotations' => array(),
-			'topics'      => array(),
-		)
-	);
+    // adding the below header for debugging purpose.
+    if ( ! headers_sent() ) {
+        header( 'X-WordLift-Analysis: OFF' );
+    }
+    wp_send_json_success(
+        array(
+            'entities'    => array(),
+            'annotations' => array(),
+            'topics'      => array(),
+        )
+    );
 }
 
 /**
@@ -35,16 +35,16 @@ 
  */
 function wl_ajax_analyze_action() {
 
-	check_admin_referer( 'wl_analyze' );
-	$data = '';
+    check_admin_referer( 'wl_analyze' );
+    $data = '';
 
-	if ( isset( $_POST['data'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
-		// We need to send the data from editor without sanitizing to analysis service.
-		$filtered_data = filter_var_array( $_POST, array( 'data' => array( 'flags' => FILTER_UNSAFE_RAW ) ) );
-		$data          = $filtered_data['data'];
-	}
+    if ( isset( $_POST['data'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
+        // We need to send the data from editor without sanitizing to analysis service.
+        $filtered_data = filter_var_array( $_POST, array( 'data' => array( 'flags' => FILTER_UNSAFE_RAW ) ) );
+        $data          = $filtered_data['data'];
+    }
 
-	wp_send_json_success( wl_analyze_content( $data, 'application/json; charset=' . strtolower( get_bloginfo( 'charset' ) ) ) );
+    wp_send_json_success( wl_analyze_content( $data, 'application/json; charset=' . strtolower( get_bloginfo( 'charset' ) ) ) );
 
 }
 
@@ -66,75 +66,75 @@ 
  */
 function wl_analyze_content( $data, $content_type ) {
 
-	$default_response = json_decode( '{ "entities": {}, "annotations": {}, "topics": {} }' );
-	$request_body     = json_decode( $data, true );
-
-	$post_id = isset( $_REQUEST['postId'] ) ? intval( $_REQUEST['postId'] ) : 0; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-
-	if ( null === $request_body ) {
-		/**
-		 * @since 3.27.7
-		 *
-		 * Conditionally try using stripslashes as $_POST['data'] could be escaped
-		 */
-		$request_body = json_decode( stripslashes( $data ), true );
-	}
-	$request_body['contentLanguage'] = Wordlift_Configuration_Service::get_instance()->get_language_code();
-	$excluded_uris                   = array_key_exists( 'exclude', $request_body ) ? (array) $request_body['exclude'] : array();
-	$data                            = wp_json_encode( $request_body );
-
-	// If dataset is not enabled, return a locally prepared response without analysis API.
-	if ( ! apply_filters( 'wl_feature__enable__dataset', true ) ) {
-
-		return Analysis_Response_Ops_Factory::get_instance()
-											->create( $default_response, $post_id )
-											->make_entities_local()
-											->add_occurrences( $request_body['content'] )
-											->add_local_entities()
-											->get_json();
-	}
-
-	add_filter( 'wl_api_service_api_url_path', 'wl_use_analysis_on_api_wordlift_io' );
-
-	$json = Analysis_Service_Factory::get_instance( $post_id )
-									->get_analysis_response( $data, $content_type, $post_id );
-
-	remove_filter( 'wl_api_service_api_url_path', 'wl_use_analysis_on_api_wordlift_io' );
-
-	// If it's an error log it.
-	if ( is_wp_error( $json ) ) {
-		return Analysis_Response_Ops_Factory::get_instance()
-											->create( $default_response, $post_id )
-											->make_entities_local()
-											->add_occurrences( $request_body['content'] )
-											->get_json();
-	}
-
-	/*
+    $default_response = json_decode( '{ "entities": {}, "annotations": {}, "topics": {} }' );
+    $request_body     = json_decode( $data, true );
+
+    $post_id = isset( $_REQUEST['postId'] ) ? intval( $_REQUEST['postId'] ) : 0; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+    if ( null === $request_body ) {
+        /**
+         * @since 3.27.7
+         *
+         * Conditionally try using stripslashes as $_POST['data'] could be escaped
+         */
+        $request_body = json_decode( stripslashes( $data ), true );
+    }
+    $request_body['contentLanguage'] = Wordlift_Configuration_Service::get_instance()->get_language_code();
+    $excluded_uris                   = array_key_exists( 'exclude', $request_body ) ? (array) $request_body['exclude'] : array();
+    $data                            = wp_json_encode( $request_body );
+
+    // If dataset is not enabled, return a locally prepared response without analysis API.
+    if ( ! apply_filters( 'wl_feature__enable__dataset', true ) ) {
+
+        return Analysis_Response_Ops_Factory::get_instance()
+                                            ->create( $default_response, $post_id )
+                                            ->make_entities_local()
+                                            ->add_occurrences( $request_body['content'] )
+                                            ->add_local_entities()
+                                            ->get_json();
+    }
+
+    add_filter( 'wl_api_service_api_url_path', 'wl_use_analysis_on_api_wordlift_io' );
+
+    $json = Analysis_Service_Factory::get_instance( $post_id )
+                                    ->get_analysis_response( $data, $content_type, $post_id );
+
+    remove_filter( 'wl_api_service_api_url_path', 'wl_use_analysis_on_api_wordlift_io' );
+
+    // If it's an error log it.
+    if ( is_wp_error( $json ) ) {
+        return Analysis_Response_Ops_Factory::get_instance()
+                                            ->create( $default_response, $post_id )
+                                            ->make_entities_local()
+                                            ->add_occurrences( $request_body['content'] )
+                                            ->get_json();
+    }
+
+    /*
 	 * We pass the response to the Analysis_Response_Ops to ensure that we make remote entities local.
 	 *
 	 * @see https://github.com/insideout10/wordlift-plugin/issues/944
 	 * @since 3.21.5
 	 */
 
-	// Get the actual content sent to the analysis, so that we can pass it to the Analysis_Response_Ops to populate
-	// the occurrences for the local entities.
-	if ( 0 === strpos( $content_type, 'application/json' ) ) {
-		$request_content = $request_body['content'];
-	} else {
-		$request_content = $data;
-	}
-
-	return Analysis_Response_Ops_Factory::get_instance()
-										->create( $json, $post_id )
-										->make_entities_local()
-										->remove_excluded_entities( $excluded_uris )
-										->add_occurrences( $request_content )
-										->get_json();
+    // Get the actual content sent to the analysis, so that we can pass it to the Analysis_Response_Ops to populate
+    // the occurrences for the local entities.
+    if ( 0 === strpos( $content_type, 'application/json' ) ) {
+        $request_content = $request_body['content'];
+    } else {
+        $request_content = $data;
+    }
+
+    return Analysis_Response_Ops_Factory::get_instance()
+                                        ->create( $json, $post_id )
+                                        ->make_entities_local()
+                                        ->remove_excluded_entities( $excluded_uris )
+                                        ->add_occurrences( $request_content )
+                                        ->get_json();
 
 }
 
 function wl_use_analysis_on_api_wordlift_io( $value ) {
 
-	return preg_replace( '|https://api\.wordlift\.it/|', apply_filters( 'wl_api_base_url', 'https://api.wordlift.io' ) . '/', $value );
+    return preg_replace( '|https://api\.wordlift\.it/|', apply_filters( 'wl_api_base_url', 'https://api.wordlift.io' ) . '/', $value );
 }

Spacing +30 added lines, -30 removed lines

@@ -12,8 +12,8 @@ 
  */
 function wl_ajax_analyze_disabled_action() {
 	// adding the below header for debugging purpose.
-	if ( ! headers_sent() ) {
-		header( 'X-WordLift-Analysis: OFF' );
+	if ( ! headers_sent()) {
+		header('X-WordLift-Analysis: OFF');
 	}
 	wp_send_json_success(
 		array(
@@ -35,16 +35,16 @@ 
  */
 function wl_ajax_analyze_action() {
 
-	check_admin_referer( 'wl_analyze' );
+	check_admin_referer('wl_analyze');
 	$data = '';
 
-	if ( isset( $_POST['data'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
+	if (isset($_POST['data'])) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
 		// We need to send the data from editor without sanitizing to analysis service.
-		$filtered_data = filter_var_array( $_POST, array( 'data' => array( 'flags' => FILTER_UNSAFE_RAW ) ) );
+		$filtered_data = filter_var_array($_POST, array('data' => array('flags' => FILTER_UNSAFE_RAW)));
 		$data          = $filtered_data['data'];
 	}
 
-	wp_send_json_success( wl_analyze_content( $data, 'application/json; charset=' . strtolower( get_bloginfo( 'charset' ) ) ) );
+	wp_send_json_success(wl_analyze_content($data, 'application/json; charset='.strtolower(get_bloginfo('charset'))));
 
 }
 
@@ -64,49 +64,49 @@ 
  * @since 3.24.2 We don't return an error anymore, but an empty analysis response. This is required to allow the editor
  *   to manage entities or to manually add them even when analysis isn't available.
  */
-function wl_analyze_content( $data, $content_type ) {
+function wl_analyze_content($data, $content_type) {
 
-	$default_response = json_decode( '{ "entities": {}, "annotations": {}, "topics": {} }' );
-	$request_body     = json_decode( $data, true );
+	$default_response = json_decode('{ "entities": {}, "annotations": {}, "topics": {} }');
+	$request_body     = json_decode($data, true);
 
-	$post_id = isset( $_REQUEST['postId'] ) ? intval( $_REQUEST['postId'] ) : 0; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+	$post_id = isset($_REQUEST['postId']) ? intval($_REQUEST['postId']) : 0; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
-	if ( null === $request_body ) {
+	if (null === $request_body) {
 		/**
 		 * @since 3.27.7
 		 *
 		 * Conditionally try using stripslashes as $_POST['data'] could be escaped
 		 */
-		$request_body = json_decode( stripslashes( $data ), true );
+		$request_body = json_decode(stripslashes($data), true);
 	}
 	$request_body['contentLanguage'] = Wordlift_Configuration_Service::get_instance()->get_language_code();
-	$excluded_uris                   = array_key_exists( 'exclude', $request_body ) ? (array) $request_body['exclude'] : array();
-	$data                            = wp_json_encode( $request_body );
+	$excluded_uris                   = array_key_exists('exclude', $request_body) ? (array) $request_body['exclude'] : array();
+	$data                            = wp_json_encode($request_body);
 
 	// If dataset is not enabled, return a locally prepared response without analysis API.
-	if ( ! apply_filters( 'wl_feature__enable__dataset', true ) ) {
+	if ( ! apply_filters('wl_feature__enable__dataset', true)) {
 
 		return Analysis_Response_Ops_Factory::get_instance()
-											->create( $default_response, $post_id )
+											->create($default_response, $post_id)
 											->make_entities_local()
-											->add_occurrences( $request_body['content'] )
+											->add_occurrences($request_body['content'])
 											->add_local_entities()
 											->get_json();
 	}
 
-	add_filter( 'wl_api_service_api_url_path', 'wl_use_analysis_on_api_wordlift_io' );
+	add_filter('wl_api_service_api_url_path', 'wl_use_analysis_on_api_wordlift_io');
 
-	$json = Analysis_Service_Factory::get_instance( $post_id )
-									->get_analysis_response( $data, $content_type, $post_id );
+	$json = Analysis_Service_Factory::get_instance($post_id)
+									->get_analysis_response($data, $content_type, $post_id);
 
-	remove_filter( 'wl_api_service_api_url_path', 'wl_use_analysis_on_api_wordlift_io' );
+	remove_filter('wl_api_service_api_url_path', 'wl_use_analysis_on_api_wordlift_io');
 
 	// If it's an error log it.
-	if ( is_wp_error( $json ) ) {
+	if (is_wp_error($json)) {
 		return Analysis_Response_Ops_Factory::get_instance()
-											->create( $default_response, $post_id )
+											->create($default_response, $post_id)
 											->make_entities_local()
-											->add_occurrences( $request_body['content'] )
+											->add_occurrences($request_body['content'])
 											->get_json();
 	}
 
@@ -119,22 +119,22 @@ 
 
 	// Get the actual content sent to the analysis, so that we can pass it to the Analysis_Response_Ops to populate
 	// the occurrences for the local entities.
-	if ( 0 === strpos( $content_type, 'application/json' ) ) {
+	if (0 === strpos($content_type, 'application/json')) {
 		$request_content = $request_body['content'];
 	} else {
 		$request_content = $data;
 	}
 
 	return Analysis_Response_Ops_Factory::get_instance()
-										->create( $json, $post_id )
+										->create($json, $post_id)
 										->make_entities_local()
-										->remove_excluded_entities( $excluded_uris )
-										->add_occurrences( $request_content )
+										->remove_excluded_entities($excluded_uris)
+										->add_occurrences($request_content)
 										->get_json();
 
 }
 
-function wl_use_analysis_on_api_wordlift_io( $value ) {
+function wl_use_analysis_on_api_wordlift_io($value) {
 
-	return preg_replace( '|https://api\.wordlift\.it/|', apply_filters( 'wl_api_base_url', 'https://api.wordlift.io' ) . '/', $value );
+	return preg_replace('|https://api\.wordlift\.it/|', apply_filters('wl_api_base_url', 'https://api.wordlift.io').'/', $value);
 }

src/public/class-wordlift-shortcode.php

Indentation +50 added lines, -50 removed lines

@@ -8,55 +8,55 @@
  */
 abstract class Wordlift_Shortcode {
 
-	/**
-	 * The shortcode, set by extending classes.
-	 */
-	const SHORTCODE = null;
-
-	/**
-	 * Create a shortcode instance by registering the shortcode with the render
-	 * function.
-	 *
-	 * @since 3.5.4
-	 */
-	public function __construct() {
-
-		add_shortcode( static::SHORTCODE, array( $this, 'render' ) );
-
-	}
-
-	/**
-	 * Render the shortcode.
-	 *
-	 * @param array $atts An array of shortcode attributes as set by the editor.
-	 *
-	 * @return string The output html code.
-	 * @since 3.5.4
-	 */
-	abstract public function render( $atts );
-
-	/**
-	 * Enqueue scripts. Called by the shortcode implementations in their render
-	 * method.
-	 *
-	 * @since 3.5.4
-	 */
-	protected function enqueue_scripts() {
-
-		wp_enqueue_script( 'angularjs', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular.min.js', array(), '1.3.11', false );
-		wp_enqueue_script( 'angularjs-touch', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular-touch.min.js', array( 'angularjs' ), '1.3.11', false );
-		wp_enqueue_script(
-			'wordlift-ui',
-			dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-ui' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js',
-			array(
-				'jquery',
-				'angularjs',
-				'angularjs-touch',
-			),
-			WORDLIFT_VERSION,
-			false
-		);
-
-	}
+    /**
+     * The shortcode, set by extending classes.
+     */
+    const SHORTCODE = null;
+
+    /**
+     * Create a shortcode instance by registering the shortcode with the render
+     * function.
+     *
+     * @since 3.5.4
+     */
+    public function __construct() {
+
+        add_shortcode( static::SHORTCODE, array( $this, 'render' ) );
+
+    }
+
+    /**
+     * Render the shortcode.
+     *
+     * @param array $atts An array of shortcode attributes as set by the editor.
+     *
+     * @return string The output html code.
+     * @since 3.5.4
+     */
+    abstract public function render( $atts );
+
+    /**
+     * Enqueue scripts. Called by the shortcode implementations in their render
+     * method.
+     *
+     * @since 3.5.4
+     */
+    protected function enqueue_scripts() {
+
+        wp_enqueue_script( 'angularjs', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular.min.js', array(), '1.3.11', false );
+        wp_enqueue_script( 'angularjs-touch', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular-touch.min.js', array( 'angularjs' ), '1.3.11', false );
+        wp_enqueue_script(
+            'wordlift-ui',
+            dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-ui' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js',
+            array(
+                'jquery',
+                'angularjs',
+                'angularjs-touch',
+            ),
+            WORDLIFT_VERSION,
+            false
+        );
+
+    }
 
 }

Spacing +5 added lines, -5 removed lines

@@ -21,7 +21,7 @@ 
 	 */
 	public function __construct() {
 
-		add_shortcode( static::SHORTCODE, array( $this, 'render' ) );
+		add_shortcode(static::SHORTCODE, array($this, 'render'));
 
 	}
 
@@ -33,7 +33,7 @@ 
 	 * @return string The output html code.
 	 * @since 3.5.4
 	 */
-	abstract public function render( $atts );
+	abstract public function render($atts);
 
 	/**
 	 * Enqueue scripts. Called by the shortcode implementations in their render
@@ -43,11 +43,11 @@ 
 	 */
 	protected function enqueue_scripts() {
 
-		wp_enqueue_script( 'angularjs', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular.min.js', array(), '1.3.11', false );
-		wp_enqueue_script( 'angularjs-touch', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular-touch.min.js', array( 'angularjs' ), '1.3.11', false );
+		wp_enqueue_script('angularjs', plugin_dir_url(__DIR__).'/js/3rdparty/angular.min.js', array(), '1.3.11', false);
+		wp_enqueue_script('angularjs-touch', plugin_dir_url(__DIR__).'/js/3rdparty/angular-touch.min.js', array('angularjs'), '1.3.11', false);
 		wp_enqueue_script(
 			'wordlift-ui',
-			dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-ui' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js',
+			dirname(plugin_dir_url(__FILE__)).'/js/wordlift-ui'.( ! defined('SCRIPT_DEBUG') || ! SCRIPT_DEBUG ? '.min' : '').'.js',
 			array(
 				'jquery',
 				'angularjs',

src/shortcodes/wordlift-shortcode-faceted-search.php

Indentation +219 added lines, -219 removed lines

@@ -20,45 +20,45 @@ 
  */
 function wl_shortcode_faceted_search( $request ) {
 
-	// Filter the allowed parameters for caching.
-	$cache_params = array_intersect_key(
-		$_GET, // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		array(
-			'post_id'    => 1,
-			'post_types' => 1,
-			'limit'      => 1,
-			'amp'        => 1,
-			'sort'       => 1,
-		)
-	);
+    // Filter the allowed parameters for caching.
+    $cache_params = array_intersect_key(
+        $_GET, // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        array(
+            'post_id'    => 1,
+            'post_types' => 1,
+            'limit'      => 1,
+            'amp'        => 1,
+            'sort'       => 1,
+        )
+    );
 
-	// Create the cache key.
-	$cache_key = array(
-		'request_params' => $cache_params,
-	);
+    // Create the cache key.
+    $cache_key = array(
+        'request_params' => $cache_params,
+    );
 
-	// Create the TTL cache and try to get the results.
-	$cache         = new Ttl_Cache( 'faceted-search', 8 * 60 * 60 ); // 8 hours.
-	$cache_results = $cache->get( $cache_key );
+    // Create the TTL cache and try to get the results.
+    $cache         = new Ttl_Cache( 'faceted-search', 8 * 60 * 60 ); // 8 hours.
+    $cache_results = $cache->get( $cache_key );
 
-	// So that the endpoint can be used remotely
-	header( 'Access-Control-Allow-Origin: *' );
+    // So that the endpoint can be used remotely
+    header( 'Access-Control-Allow-Origin: *' );
 
-	if ( isset( $cache_results ) ) {
-		header( 'X-WordLift-Cache: HIT' );
-		wl_core_send_json( $cache_results );
+    if ( isset( $cache_results ) ) {
+        header( 'X-WordLift-Cache: HIT' );
+        wl_core_send_json( $cache_results );
 
-		return;
-	}
+        return;
+    }
 
-	header( 'X-WordLift-Cache: MISS' );
+    header( 'X-WordLift-Cache: MISS' );
 
-	$results = wl_shortcode_faceted_search_origin( $request->get_query_params() );
+    $results = wl_shortcode_faceted_search_origin( $request->get_query_params() );
 
-	// Put the result before sending the json to the client, since sending the json will terminate us.
-	$cache->put( $cache_key, $results );
+    // Put the result before sending the json to the client, since sending the json will terminate us.
+    $cache->put( $cache_key, $results );
 
-	wl_core_send_json( $results );
+    wl_core_send_json( $results );
 
 }
 
@@ -70,141 +70,141 @@ 
  */
 // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 function wl_shortcode_faceted_search_origin( $request ) {
-	// Post ID must be defined.
-	if ( ! isset( $request['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
-		wp_die( 'No post_id given' );
-
-		return;
-	}
-
-	$current_post_id = (int) $request['post_id']; // WPCS: input var ok; CSRF ok.
-	$current_post    = get_post( $current_post_id );
-	$faceted_id      = isset( $request['uniqid'] ) ? sanitize_text_field( wp_unslash( (string) $request['uniqid'] ) ) : '';
-
-	$post_types          = isset( $request['post_types'] ) ? sanitize_text_field( wp_unslash( (string) $request['post_types'] ) ) : '';
-	$post_types          = explode( ',', $post_types );
-	$existing_post_types = get_post_types();
-	$post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
-
-	// Post ID has to match an existing item.
-	if ( null === $current_post ) {
-		wp_die( 'No valid post_id given' );
-
-		return;
-	}
-
-	// If the current post is an entity,
-	// the current post is used as main entity.
-	// Otherwise, current post related entities are used.
-	$entity_service = Wordlift_Entity_Service::get_instance();
-
-	$entity_ids = $entity_service->is_entity( $current_post->ID ) ?
-		array( $current_post->ID ) :
-		$entity_service->get_related_entities( $current_post->ID );
-
-	// If there are no entities we cannot render the widget.
-	if ( 0 === count( $entity_ids ) ) {
-		/**
-		 * If this function is not called from ajax
-		 * then this should not throw an error.
-		 * Note: Used in scripbox longtail project on json endpoint.
-		 */
-		if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
-			wp_die( 'No entities available' );
-		}
-	}
-
-	// phpcs:ignore Standard.Category.SniffName.ErrorCode
-	$limit = ( isset( $request['limit'] ) ) ? (int) $request['limit'] : 4;
-	$amp   = isset( $request['amp'] );
-
-	/**
-	 * see https://github.com/insideout10/wordlift-plugin/issues/1181
-	 * The ordering should be descending by date on default.
-	 */
-	$order_by = 'DESC';
-	if ( isset( $request['sort'] ) && is_string( $request['sort'] ) ) {
-		$order_by = sanitize_sql_orderby( wp_unslash( (string) $request['sort'] ) );
-	}
-
-	$referencing_posts = Wordlift_Relation_Service::get_instance()->get_article_subjects(
-		$entity_ids,
-		'*',
-		null,
-		'publish',
-		array( $current_post_id ),
-		$limit,
-		null,
-		$order_by,
-		$post_types
-	);
-
-	$referencing_post_ids = array_map(
-		function ( $p ) {
-			return $p->ID;
-		},
-		$referencing_posts
-	);
-
-	$post_results   = array();
-	$entity_results = array();
-
-	// Populate $post_results
-
-	if ( $referencing_posts ) {
-		foreach ( $referencing_posts as $post_obj ) {
-
-			/**
-			 * Use the thumbnail.
-			 *
-			 * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
-			 * @see https://github.com/insideout10/wordlift-plugin/issues/837
-			 *
-			 * @since 3.19.3 We're using the medium size image.
-			 */
-			$thumbnail            = get_the_post_thumbnail_url( $post_obj, 'medium' );
-			$post_obj->thumbnail  = ( $thumbnail ) ?
-				$thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-			$post_obj->permalink  = get_permalink( $post_obj->ID );
-			$post_obj->srcset     = Srcset_Util::get_srcset( $post_obj->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
-			$post_obj->post_title = wp_strip_all_tags( html_entity_decode( $post_obj->post_title, ENT_QUOTES, 'UTF-8' ) );
-			$result               = $post_obj;
-			$post_results[]       = $result;
-		}
-	}
-
-	// Add filler posts if needed
-
-	$filler_count = $limit - count( $post_results );
-	if ( 0 < apply_filters( 'wl_faceted_search__filler_count', $filler_count, $current_post_id, $referencing_post_ids ) ) {
-		$filler_posts_util       = new Filler_Posts_Util( $current_post_id );
-		$post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
-		$filler_posts            = $filler_posts_util->get_filler_posts( $filler_count, $post_ids_to_be_excluded );
-
-		$post_results = array_merge( $post_results, $filler_posts );
-	}
-	$referencing_post_ids = array_map(
-		function ( $post ) {
-			return $post->ID;
-		},
-		$post_results
-	);
-
-	// Populate $entity_results
-
-	global $wpdb;
-
-	// Retrieve Wordlift relation instances table name.
-	$table_name = wl_core_get_relation_instances_table_name();
-
-	/*
+    // Post ID must be defined.
+    if ( ! isset( $request['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
+        wp_die( 'No post_id given' );
+
+        return;
+    }
+
+    $current_post_id = (int) $request['post_id']; // WPCS: input var ok; CSRF ok.
+    $current_post    = get_post( $current_post_id );
+    $faceted_id      = isset( $request['uniqid'] ) ? sanitize_text_field( wp_unslash( (string) $request['uniqid'] ) ) : '';
+
+    $post_types          = isset( $request['post_types'] ) ? sanitize_text_field( wp_unslash( (string) $request['post_types'] ) ) : '';
+    $post_types          = explode( ',', $post_types );
+    $existing_post_types = get_post_types();
+    $post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
+
+    // Post ID has to match an existing item.
+    if ( null === $current_post ) {
+        wp_die( 'No valid post_id given' );
+
+        return;
+    }
+
+    // If the current post is an entity,
+    // the current post is used as main entity.
+    // Otherwise, current post related entities are used.
+    $entity_service = Wordlift_Entity_Service::get_instance();
+
+    $entity_ids = $entity_service->is_entity( $current_post->ID ) ?
+        array( $current_post->ID ) :
+        $entity_service->get_related_entities( $current_post->ID );
+
+    // If there are no entities we cannot render the widget.
+    if ( 0 === count( $entity_ids ) ) {
+        /**
+         * If this function is not called from ajax
+         * then this should not throw an error.
+         * Note: Used in scripbox longtail project on json endpoint.
+         */
+        if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
+            wp_die( 'No entities available' );
+        }
+    }
+
+    // phpcs:ignore Standard.Category.SniffName.ErrorCode
+    $limit = ( isset( $request['limit'] ) ) ? (int) $request['limit'] : 4;
+    $amp   = isset( $request['amp'] );
+
+    /**
+     * see https://github.com/insideout10/wordlift-plugin/issues/1181
+     * The ordering should be descending by date on default.
+     */
+    $order_by = 'DESC';
+    if ( isset( $request['sort'] ) && is_string( $request['sort'] ) ) {
+        $order_by = sanitize_sql_orderby( wp_unslash( (string) $request['sort'] ) );
+    }
+
+    $referencing_posts = Wordlift_Relation_Service::get_instance()->get_article_subjects(
+        $entity_ids,
+        '*',
+        null,
+        'publish',
+        array( $current_post_id ),
+        $limit,
+        null,
+        $order_by,
+        $post_types
+    );
+
+    $referencing_post_ids = array_map(
+        function ( $p ) {
+            return $p->ID;
+        },
+        $referencing_posts
+    );
+
+    $post_results   = array();
+    $entity_results = array();
+
+    // Populate $post_results
+
+    if ( $referencing_posts ) {
+        foreach ( $referencing_posts as $post_obj ) {
+
+            /**
+             * Use the thumbnail.
+             *
+             * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
+             * @see https://github.com/insideout10/wordlift-plugin/issues/837
+             *
+             * @since 3.19.3 We're using the medium size image.
+             */
+            $thumbnail            = get_the_post_thumbnail_url( $post_obj, 'medium' );
+            $post_obj->thumbnail  = ( $thumbnail ) ?
+                $thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
+            $post_obj->permalink  = get_permalink( $post_obj->ID );
+            $post_obj->srcset     = Srcset_Util::get_srcset( $post_obj->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
+            $post_obj->post_title = wp_strip_all_tags( html_entity_decode( $post_obj->post_title, ENT_QUOTES, 'UTF-8' ) );
+            $result               = $post_obj;
+            $post_results[]       = $result;
+        }
+    }
+
+    // Add filler posts if needed
+
+    $filler_count = $limit - count( $post_results );
+    if ( 0 < apply_filters( 'wl_faceted_search__filler_count', $filler_count, $current_post_id, $referencing_post_ids ) ) {
+        $filler_posts_util       = new Filler_Posts_Util( $current_post_id );
+        $post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
+        $filler_posts            = $filler_posts_util->get_filler_posts( $filler_count, $post_ids_to_be_excluded );
+
+        $post_results = array_merge( $post_results, $filler_posts );
+    }
+    $referencing_post_ids = array_map(
+        function ( $post ) {
+            return $post->ID;
+        },
+        $post_results
+    );
+
+    // Populate $entity_results
+
+    global $wpdb;
+
+    // Retrieve Wordlift relation instances table name.
+    $table_name = wl_core_get_relation_instances_table_name();
+
+    /*
 	 * Make sure we have some referenced post, otherwise the IN parts of
 	 * the SQL will produce an SQL error.
 	 */
-	if ( ! empty( $referencing_post_ids ) ) {
-		$subject_ids = implode( ',', $referencing_post_ids );
+    if ( ! empty( $referencing_post_ids ) ) {
+        $subject_ids = implode( ',', $referencing_post_ids );
 
-		$query = "
+        $query = "
 				SELECT
 					object_id AS ID,
 					count( object_id ) AS counter
@@ -216,71 +216,71 @@ 
 				LIMIT $limit;
 			";
 
-		wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
+        wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
 
-		$entities = $wpdb->get_results( $query, OBJECT ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+        $entities = $wpdb->get_results( $query, OBJECT ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 
-		wl_write_log( 'Entities found ' . count( $entities ) );
+        wl_write_log( 'Entities found ' . count( $entities ) );
 
-		foreach ( $entities as $obj ) {
+        foreach ( $entities as $obj ) {
 
-			$entity = get_post( $obj->ID );
+            $entity = get_post( $obj->ID );
 
-			// Ensure only valid and published entities are returned.
-			if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
+            // Ensure only valid and published entities are returned.
+            if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
 
-				$serialized_entity                    = wl_serialize_entity( $entity );
-				$serialized_entity['label']           = html_entity_decode( wl_shortcode_faceted_search_get_the_title( $obj->ID ), ENT_QUOTES, 'UTF-8' );
-				$serialized_entity['counter']         = $obj->counter;
-				$serialized_entity['createdAt']       = $entity->post_date;
-				$serialized_entity['referencedPosts'] = Wordlift_Relation_Service::get_instance()->get_article_subjects(
-					$obj->ID,
-					'ids',
-					null,
-					null,
-					array(),
-					null,
-					$referencing_post_ids
-				);
-				$entity_results[]                     = $serialized_entity;
-			}
-		}
-	}
+                $serialized_entity                    = wl_serialize_entity( $entity );
+                $serialized_entity['label']           = html_entity_decode( wl_shortcode_faceted_search_get_the_title( $obj->ID ), ENT_QUOTES, 'UTF-8' );
+                $serialized_entity['counter']         = $obj->counter;
+                $serialized_entity['createdAt']       = $entity->post_date;
+                $serialized_entity['referencedPosts'] = Wordlift_Relation_Service::get_instance()->get_article_subjects(
+                    $obj->ID,
+                    'ids',
+                    null,
+                    null,
+                    array(),
+                    null,
+                    $referencing_post_ids
+                );
+                $entity_results[]                     = $serialized_entity;
+            }
+        }
+    }
 
-	$post_results = apply_filters( 'wl_faceted_data_posts', $post_results, $faceted_id );
+    $post_results = apply_filters( 'wl_faceted_data_posts', $post_results, $faceted_id );
 
-	// Add srcset attribute.
-	$post_results = array_map(
-		function ( $post ) {
-			$post->srcset = Srcset_Util::get_srcset( $post->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
+    // Add srcset attribute.
+    $post_results = array_map(
+        function ( $post ) {
+            $post->srcset = Srcset_Util::get_srcset( $post->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
 
-			return $post;
-		},
-		$post_results
-	);
+            return $post;
+        },
+        $post_results
+    );
 
-	$entity_results = apply_filters( 'wl_faceted_data_entities', $entity_results, $faceted_id );
+    $entity_results = apply_filters( 'wl_faceted_data_entities', $entity_results, $faceted_id );
 
-	return array(
-		'posts'    => $amp ? array( array( 'values' => $post_results ) ) : $post_results,
-		'entities' => $entity_results,
-	);
+    return array(
+        'posts'    => $amp ? array( array( 'values' => $post_results ) ) : $post_results,
+        'entities' => $entity_results,
+    );
 
 }
 
 function wl_shortcode_faceted_search_get_the_title( $post_id ) {
 
-	$title = wp_strip_all_tags( get_the_title( $post_id ) );
+    $title = wp_strip_all_tags( get_the_title( $post_id ) );
 
-	if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
-		$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
+    if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
+        $alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
 
-		if ( count( $alternative_labels ) > 0 ) {
-			$title = $alternative_labels[0];
-		}
-	}
+        if ( count( $alternative_labels ) > 0 ) {
+            $title = $alternative_labels[0];
+        }
+    }
 
-	return remove_accents( $title );
+    return remove_accents( $title );
 
 }
 
@@ -288,16 +288,16 @@ 
  * Adding `rest_api_init` action for network faceted-search
  */
 add_action(
-	'rest_api_init',
-	function () {
-		register_rest_route(
-			WL_REST_ROUTE_DEFAULT_NAMESPACE,
-			'/faceted-search',
-			array(
-				'methods'             => 'GET',
-				'callback'            => 'wl_shortcode_faceted_search',
-				'permission_callback' => '__return_true',
-			)
-		);
-	}
+    'rest_api_init',
+    function () {
+        register_rest_route(
+            WL_REST_ROUTE_DEFAULT_NAMESPACE,
+            '/faceted-search',
+            array(
+                'methods'             => 'GET',
+                'callback'            => 'wl_shortcode_faceted_search',
+                'permission_callback' => '__return_true',
+            )
+        );
+    }
 );

Spacing +69 added lines, -70 removed lines

@@ -18,7 +18,7 @@ 
  * @since 3.21.4 fix the cache key by also using the request body.
  * @since 3.21.2 add a caching layer.
  */
-function wl_shortcode_faceted_search( $request ) {
+function wl_shortcode_faceted_search($request) {
 
 	// Filter the allowed parameters for caching.
 	$cache_params = array_intersect_key(
@@ -38,27 +38,27 @@ 
 	);
 
 	// Create the TTL cache and try to get the results.
-	$cache         = new Ttl_Cache( 'faceted-search', 8 * 60 * 60 ); // 8 hours.
-	$cache_results = $cache->get( $cache_key );
+	$cache         = new Ttl_Cache('faceted-search', 8 * 60 * 60); // 8 hours.
+	$cache_results = $cache->get($cache_key);
 
 	// So that the endpoint can be used remotely
-	header( 'Access-Control-Allow-Origin: *' );
+	header('Access-Control-Allow-Origin: *');
 
-	if ( isset( $cache_results ) ) {
-		header( 'X-WordLift-Cache: HIT' );
-		wl_core_send_json( $cache_results );
+	if (isset($cache_results)) {
+		header('X-WordLift-Cache: HIT');
+		wl_core_send_json($cache_results);
 
 		return;
 	}
 
-	header( 'X-WordLift-Cache: MISS' );
+	header('X-WordLift-Cache: MISS');
 
-	$results = wl_shortcode_faceted_search_origin( $request->get_query_params() );
+	$results = wl_shortcode_faceted_search_origin($request->get_query_params());
 
 	// Put the result before sending the json to the client, since sending the json will terminate us.
-	$cache->put( $cache_key, $results );
+	$cache->put($cache_key, $results);
 
-	wl_core_send_json( $results );
+	wl_core_send_json($results);
 
 }
 
@@ -69,26 +69,26 @@ 
  * @since        3.26.0
  */
 // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-function wl_shortcode_faceted_search_origin( $request ) {
+function wl_shortcode_faceted_search_origin($request) {
 	// Post ID must be defined.
-	if ( ! isset( $request['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
-		wp_die( 'No post_id given' );
+	if ( ! isset($request['post_id'])) { // WPCS: input var ok; CSRF ok.
+		wp_die('No post_id given');
 
 		return;
 	}
 
 	$current_post_id = (int) $request['post_id']; // WPCS: input var ok; CSRF ok.
-	$current_post    = get_post( $current_post_id );
-	$faceted_id      = isset( $request['uniqid'] ) ? sanitize_text_field( wp_unslash( (string) $request['uniqid'] ) ) : '';
+	$current_post    = get_post($current_post_id);
+	$faceted_id      = isset($request['uniqid']) ? sanitize_text_field(wp_unslash((string) $request['uniqid'])) : '';
 
-	$post_types          = isset( $request['post_types'] ) ? sanitize_text_field( wp_unslash( (string) $request['post_types'] ) ) : '';
-	$post_types          = explode( ',', $post_types );
+	$post_types          = isset($request['post_types']) ? sanitize_text_field(wp_unslash((string) $request['post_types'])) : '';
+	$post_types          = explode(',', $post_types);
 	$existing_post_types = get_post_types();
-	$post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
+	$post_types          = array_values(array_intersect($existing_post_types, $post_types));
 
 	// Post ID has to match an existing item.
-	if ( null === $current_post ) {
-		wp_die( 'No valid post_id given' );
+	if (null === $current_post) {
+		wp_die('No valid post_id given');
 
 		return;
 	}
@@ -98,33 +98,32 @@ 
 	// Otherwise, current post related entities are used.
 	$entity_service = Wordlift_Entity_Service::get_instance();
 
-	$entity_ids = $entity_service->is_entity( $current_post->ID ) ?
-		array( $current_post->ID ) :
-		$entity_service->get_related_entities( $current_post->ID );
+	$entity_ids = $entity_service->is_entity($current_post->ID) ?
+		array($current_post->ID) : $entity_service->get_related_entities($current_post->ID);
 
 	// If there are no entities we cannot render the widget.
-	if ( 0 === count( $entity_ids ) ) {
+	if (0 === count($entity_ids)) {
 		/**
 		 * If this function is not called from ajax
 		 * then this should not throw an error.
 		 * Note: Used in scripbox longtail project on json endpoint.
 		 */
-		if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
-			wp_die( 'No entities available' );
+		if (apply_filters('wp_doing_ajax', defined('DOING_AJAX') && DOING_AJAX)) {
+			wp_die('No entities available');
 		}
 	}
 
 	// phpcs:ignore Standard.Category.SniffName.ErrorCode
-	$limit = ( isset( $request['limit'] ) ) ? (int) $request['limit'] : 4;
-	$amp   = isset( $request['amp'] );
+	$limit = (isset($request['limit'])) ? (int) $request['limit'] : 4;
+	$amp   = isset($request['amp']);
 
 	/**
 	 * see https://github.com/insideout10/wordlift-plugin/issues/1181
 	 * The ordering should be descending by date on default.
 	 */
 	$order_by = 'DESC';
-	if ( isset( $request['sort'] ) && is_string( $request['sort'] ) ) {
-		$order_by = sanitize_sql_orderby( wp_unslash( (string) $request['sort'] ) );
+	if (isset($request['sort']) && is_string($request['sort'])) {
+		$order_by = sanitize_sql_orderby(wp_unslash((string) $request['sort']));
 	}
 
 	$referencing_posts = Wordlift_Relation_Service::get_instance()->get_article_subjects(
@@ -132,7 +131,7 @@ 
 		'*',
 		null,
 		'publish',
-		array( $current_post_id ),
+		array($current_post_id),
 		$limit,
 		null,
 		$order_by,
@@ -140,7 +139,7 @@ 
 	);
 
 	$referencing_post_ids = array_map(
-		function ( $p ) {
+		function($p) {
 			return $p->ID;
 		},
 		$referencing_posts
@@ -151,8 +150,8 @@ 
 
 	// Populate $post_results
 
-	if ( $referencing_posts ) {
-		foreach ( $referencing_posts as $post_obj ) {
+	if ($referencing_posts) {
+		foreach ($referencing_posts as $post_obj) {
 
 			/**
 			 * Use the thumbnail.
@@ -162,12 +161,12 @@ 
 			 *
 			 * @since 3.19.3 We're using the medium size image.
 			 */
-			$thumbnail            = get_the_post_thumbnail_url( $post_obj, 'medium' );
-			$post_obj->thumbnail  = ( $thumbnail ) ?
+			$thumbnail            = get_the_post_thumbnail_url($post_obj, 'medium');
+			$post_obj->thumbnail  = ($thumbnail) ?
 				$thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-			$post_obj->permalink  = get_permalink( $post_obj->ID );
-			$post_obj->srcset     = Srcset_Util::get_srcset( $post_obj->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
-			$post_obj->post_title = wp_strip_all_tags( html_entity_decode( $post_obj->post_title, ENT_QUOTES, 'UTF-8' ) );
+			$post_obj->permalink  = get_permalink($post_obj->ID);
+			$post_obj->srcset     = Srcset_Util::get_srcset($post_obj->ID, Srcset_Util::FACETED_SEARCH_WIDGET);
+			$post_obj->post_title = wp_strip_all_tags(html_entity_decode($post_obj->post_title, ENT_QUOTES, 'UTF-8'));
 			$result               = $post_obj;
 			$post_results[]       = $result;
 		}
@@ -175,16 +174,16 @@ 
 
 	// Add filler posts if needed
 
-	$filler_count = $limit - count( $post_results );
-	if ( 0 < apply_filters( 'wl_faceted_search__filler_count', $filler_count, $current_post_id, $referencing_post_ids ) ) {
-		$filler_posts_util       = new Filler_Posts_Util( $current_post_id );
-		$post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
-		$filler_posts            = $filler_posts_util->get_filler_posts( $filler_count, $post_ids_to_be_excluded );
+	$filler_count = $limit - count($post_results);
+	if (0 < apply_filters('wl_faceted_search__filler_count', $filler_count, $current_post_id, $referencing_post_ids)) {
+		$filler_posts_util       = new Filler_Posts_Util($current_post_id);
+		$post_ids_to_be_excluded = array_merge(array($current_post_id), $referencing_post_ids);
+		$filler_posts            = $filler_posts_util->get_filler_posts($filler_count, $post_ids_to_be_excluded);
 
-		$post_results = array_merge( $post_results, $filler_posts );
+		$post_results = array_merge($post_results, $filler_posts);
 	}
 	$referencing_post_ids = array_map(
-		function ( $post ) {
+		function($post) {
 			return $post->ID;
 		},
 		$post_results
@@ -201,8 +200,8 @@ 
 	 * Make sure we have some referenced post, otherwise the IN parts of
 	 * the SQL will produce an SQL error.
 	 */
-	if ( ! empty( $referencing_post_ids ) ) {
-		$subject_ids = implode( ',', $referencing_post_ids );
+	if ( ! empty($referencing_post_ids)) {
+		$subject_ids = implode(',', $referencing_post_ids);
 
 		$query = "
 				SELECT
@@ -216,21 +215,21 @@ 
 				LIMIT $limit;
 			";
 
-		wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
+		wl_write_log("Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]");
 
-		$entities = $wpdb->get_results( $query, OBJECT ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+		$entities = $wpdb->get_results($query, OBJECT); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 
-		wl_write_log( 'Entities found ' . count( $entities ) );
+		wl_write_log('Entities found '.count($entities));
 
-		foreach ( $entities as $obj ) {
+		foreach ($entities as $obj) {
 
-			$entity = get_post( $obj->ID );
+			$entity = get_post($obj->ID);
 
 			// Ensure only valid and published entities are returned.
-			if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
+			if ((null !== $entity) && ('publish' === $entity->post_status)) {
 
-				$serialized_entity                    = wl_serialize_entity( $entity );
-				$serialized_entity['label']           = html_entity_decode( wl_shortcode_faceted_search_get_the_title( $obj->ID ), ENT_QUOTES, 'UTF-8' );
+				$serialized_entity                    = wl_serialize_entity($entity);
+				$serialized_entity['label']           = html_entity_decode(wl_shortcode_faceted_search_get_the_title($obj->ID), ENT_QUOTES, 'UTF-8');
 				$serialized_entity['counter']         = $obj->counter;
 				$serialized_entity['createdAt']       = $entity->post_date;
 				$serialized_entity['referencedPosts'] = Wordlift_Relation_Service::get_instance()->get_article_subjects(
@@ -242,45 +241,45 @@ 
 					null,
 					$referencing_post_ids
 				);
-				$entity_results[]                     = $serialized_entity;
+				$entity_results[] = $serialized_entity;
 			}
 		}
 	}
 
-	$post_results = apply_filters( 'wl_faceted_data_posts', $post_results, $faceted_id );
+	$post_results = apply_filters('wl_faceted_data_posts', $post_results, $faceted_id);
 
 	// Add srcset attribute.
 	$post_results = array_map(
-		function ( $post ) {
-			$post->srcset = Srcset_Util::get_srcset( $post->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
+		function($post) {
+			$post->srcset = Srcset_Util::get_srcset($post->ID, Srcset_Util::FACETED_SEARCH_WIDGET);
 
 			return $post;
 		},
 		$post_results
 	);
 
-	$entity_results = apply_filters( 'wl_faceted_data_entities', $entity_results, $faceted_id );
+	$entity_results = apply_filters('wl_faceted_data_entities', $entity_results, $faceted_id);
 
 	return array(
-		'posts'    => $amp ? array( array( 'values' => $post_results ) ) : $post_results,
+		'posts'    => $amp ? array(array('values' => $post_results)) : $post_results,
 		'entities' => $entity_results,
 	);
 
 }
 
-function wl_shortcode_faceted_search_get_the_title( $post_id ) {
+function wl_shortcode_faceted_search_get_the_title($post_id) {
 
-	$title = wp_strip_all_tags( get_the_title( $post_id ) );
+	$title = wp_strip_all_tags(get_the_title($post_id));
 
-	if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
-		$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
+	if (get_post_type($post_id) !== Wordlift_Entity_Service::TYPE_NAME) {
+		$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels($post_id);
 
-		if ( count( $alternative_labels ) > 0 ) {
+		if (count($alternative_labels) > 0) {
 			$title = $alternative_labels[0];
 		}
 	}
 
-	return remove_accents( $title );
+	return remove_accents($title);
 
 }
 
@@ -289,7 +288,7 @@ 
  */
 add_action(
 	'rest_api_init',
-	function () {
+	function() {
 		register_rest_route(
 			WL_REST_ROUTE_DEFAULT_NAMESPACE,
 			'/faceted-search',

src/shortcodes/wordlift-shortcode-navigator.php

Indentation +204 added lines, -204 removed lines

@@ -19,176 +19,176 @@ 
  */
 function wl_shortcode_navigator_data() {
 
-	// Create the cache key.
-	$cache_params = array_intersect_key(
-		$_REQUEST, // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		array(
-			'limit'      => 1,
-			'offset'     => 1,
-			'sort'       => 1,
-			'post_types' => 1,
-			'post_id'    => 1,
-		)
-	);
+    // Create the cache key.
+    $cache_params = array_intersect_key(
+        $_REQUEST, // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        array(
+            'limit'      => 1,
+            'offset'     => 1,
+            'sort'       => 1,
+            'post_types' => 1,
+            'post_id'    => 1,
+        )
+    );
 
-	$cache_key = array( 'request_params' => $cache_params );
+    $cache_key = array( 'request_params' => $cache_params );
 
-	// Create the TTL cache and try to get the results.
-	$cache         = new Ttl_Cache( 'navigator', 8 * 60 * 60 ); // 8 hours.
-	$cache_results = $cache->get( $cache_key );
+    // Create the TTL cache and try to get the results.
+    $cache         = new Ttl_Cache( 'navigator', 8 * 60 * 60 ); // 8 hours.
+    $cache_results = $cache->get( $cache_key );
 
-	// So that the endpoint can be used remotely
-	header( 'Access-Control-Allow-Origin: *' );
+    // So that the endpoint can be used remotely
+    header( 'Access-Control-Allow-Origin: *' );
 
-	if ( isset( $cache_results ) ) {
-		header( 'X-WordLift-Cache: HIT' );
+    if ( isset( $cache_results ) ) {
+        header( 'X-WordLift-Cache: HIT' );
 
-		return $cache_results;
-	}
+        return $cache_results;
+    }
 
-	header( 'X-WordLift-Cache: MISS' );
+    header( 'X-WordLift-Cache: MISS' );
 
-	$results = _wl_navigator_get_data();
+    $results = _wl_navigator_get_data();
 
-	// Put the result before sending the json to the client, since sending the json will terminate us.
-	$cache->put( $cache_key, $results );
+    // Put the result before sending the json to the client, since sending the json will terminate us.
+    $cache->put( $cache_key, $results );
 
-	return $results;
+    return $results;
 }
 
 function _wl_navigator_get_data() {
 
-	check_ajax_referer( 'wl_navigator' );
-
-	// Post ID must be defined
-	if ( ! isset( $_GET['post_id'] ) ) {
-		wp_send_json_error( 'No post_id given' );
-
-		return array();
-	}
-
-	// Post ID must be defined
-	if ( ! isset( $_GET['uniqid'] ) ) {
-		wp_send_json_error( 'No uniqid given' );
-
-		return array();
-	}
-
-	// Limit the results (defaults to 4)
-	$navigator_length    = isset( $_GET['limit'] ) ? intval( $_GET['limit'] ) : 4;
-	$navigator_offset    = isset( $_GET['offset'] ) ? intval( $_GET['offset'] ) : 0;
-	$order_by            = isset( $_GET['sort'] ) ? sanitize_sql_orderby( wp_unslash( $_GET['sort'] ) ) : 'ID DESC';
-	$post_types          = isset( $_GET['post_types'] ) ? sanitize_text_field( wp_unslash( $_GET['post_types'] ) ) : '';
-	$post_types          = explode( ',', $post_types );
-	$existing_post_types = get_post_types();
-	$post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
-	$current_post_id     = (int) $_GET['post_id'];
-	$current_post        = get_post( $current_post_id );
-
-	$navigator_id = sanitize_text_field( wp_unslash( $_GET['uniqid'] ) );
-
-	// Post ID has to match an existing item
-	if ( null === $current_post ) {
-		wp_send_json_error( 'No valid post_id given' );
-
-		return array();
-	}
-
-	// Determine navigator type and call respective _get_results
-	if ( get_post_type( $current_post_id ) === Wordlift_Entity_Service::TYPE_NAME ) {
-
-		$referencing_posts = Navigator_Data::entity_navigator_get_results(
-			$current_post_id,
-			array(
-				'ID',
-				'post_title',
-			),
-			$order_by,
-			$navigator_length,
-			$navigator_offset,
-			$post_types
-		);
-	} else {
-		$referencing_posts = Navigator_Data::post_navigator_get_results(
-			$current_post_id,
-			array(
-				'ID',
-				'post_title',
-			),
-			$order_by,
-			$navigator_length,
-			$navigator_offset,
-			$post_types
-		);
-
-	}
-
-	// loop over them and take the first one which is not already in the $related_posts
-	$results = array();
-	foreach ( $referencing_posts as $referencing_post ) {
-		$serialized_entity = wl_serialize_entity( $referencing_post->entity_id );
-
-		/**
-		 * Use the thumbnail.
-		 *
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/837
-		 *
-		 * @since 3.19.3 We're using the medium size image.
-		 */
-		$thumbnail = get_the_post_thumbnail_url( $referencing_post, 'medium' );
-
-		$result = array(
-			'post'   => array(
-				'id'        => $referencing_post->ID,
-				'permalink' => get_permalink( $referencing_post->ID ),
-				'title'     => html_entity_decode( $referencing_post->post_title, ENT_QUOTES, 'UTF-8' ),
-				'thumbnail' => $thumbnail,
-				'srcset'    => Srcset_Util::get_srcset( $referencing_post->ID, Srcset_Util::NAVIGATOR_WIDGET ),
-			),
-			'entity' => array(
-				'id'        => $referencing_post->entity_id,
-				'label'     => $serialized_entity['label'],
-				'mainType'  => $serialized_entity['mainType'],
-				'permalink' => get_permalink( $referencing_post->entity_id ),
-			),
-		);
-
-		$results[] = $result;
-	}
-
-	if ( count( $results ) < $navigator_length ) {
-		$results = apply_filters( 'wl_navigator_data_placeholder', $results, $navigator_id, $navigator_offset, $navigator_length );
-	}
-
-	// Add filler posts if needed
-	$filler_count = $navigator_length - count( $results );
-	if ( $filler_count > 0 ) {
-		$referencing_post_ids = array_map(
-			function ( $p ) {
-				return $p->ID;
-			},
-			$referencing_posts
-		);
-		/**
-		 * @since 3.27.8
-		 * Filler posts are fetched using this util.
-		 */
-		$filler_posts_util       = new Filler_Posts_Util( $current_post_id, $post_types );
-		$post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
-		$filler_posts            = $filler_posts_util->get_filler_response( $filler_count, $post_ids_to_be_excluded );
-		$results                 = array_merge( $results, $filler_posts );
-	}
-
-	// Apply filters after fillers are added
-	foreach ( $results as $result_index => $result ) {
-		$results[ $result_index ]['post']   = apply_filters( 'wl_navigator_data_post', $result['post'], intval( $result['post']['id'] ), $navigator_id );
-		$results[ $result_index ]['entity'] = apply_filters( 'wl_navigator_data_entity', $result['entity'], intval( $result['entity']['id'] ), $navigator_id );
-	}
-
-	$results = apply_filters( 'wl_navigator_results', $results, $navigator_id, $current_post_id );
-
-	return $results;
+    check_ajax_referer( 'wl_navigator' );
+
+    // Post ID must be defined
+    if ( ! isset( $_GET['post_id'] ) ) {
+        wp_send_json_error( 'No post_id given' );
+
+        return array();
+    }
+
+    // Post ID must be defined
+    if ( ! isset( $_GET['uniqid'] ) ) {
+        wp_send_json_error( 'No uniqid given' );
+
+        return array();
+    }
+
+    // Limit the results (defaults to 4)
+    $navigator_length    = isset( $_GET['limit'] ) ? intval( $_GET['limit'] ) : 4;
+    $navigator_offset    = isset( $_GET['offset'] ) ? intval( $_GET['offset'] ) : 0;
+    $order_by            = isset( $_GET['sort'] ) ? sanitize_sql_orderby( wp_unslash( $_GET['sort'] ) ) : 'ID DESC';
+    $post_types          = isset( $_GET['post_types'] ) ? sanitize_text_field( wp_unslash( $_GET['post_types'] ) ) : '';
+    $post_types          = explode( ',', $post_types );
+    $existing_post_types = get_post_types();
+    $post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
+    $current_post_id     = (int) $_GET['post_id'];
+    $current_post        = get_post( $current_post_id );
+
+    $navigator_id = sanitize_text_field( wp_unslash( $_GET['uniqid'] ) );
+
+    // Post ID has to match an existing item
+    if ( null === $current_post ) {
+        wp_send_json_error( 'No valid post_id given' );
+
+        return array();
+    }
+
+    // Determine navigator type and call respective _get_results
+    if ( get_post_type( $current_post_id ) === Wordlift_Entity_Service::TYPE_NAME ) {
+
+        $referencing_posts = Navigator_Data::entity_navigator_get_results(
+            $current_post_id,
+            array(
+                'ID',
+                'post_title',
+            ),
+            $order_by,
+            $navigator_length,
+            $navigator_offset,
+            $post_types
+        );
+    } else {
+        $referencing_posts = Navigator_Data::post_navigator_get_results(
+            $current_post_id,
+            array(
+                'ID',
+                'post_title',
+            ),
+            $order_by,
+            $navigator_length,
+            $navigator_offset,
+            $post_types
+        );
+
+    }
+
+    // loop over them and take the first one which is not already in the $related_posts
+    $results = array();
+    foreach ( $referencing_posts as $referencing_post ) {
+        $serialized_entity = wl_serialize_entity( $referencing_post->entity_id );
+
+        /**
+         * Use the thumbnail.
+         *
+         * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
+         * @see https://github.com/insideout10/wordlift-plugin/issues/837
+         *
+         * @since 3.19.3 We're using the medium size image.
+         */
+        $thumbnail = get_the_post_thumbnail_url( $referencing_post, 'medium' );
+
+        $result = array(
+            'post'   => array(
+                'id'        => $referencing_post->ID,
+                'permalink' => get_permalink( $referencing_post->ID ),
+                'title'     => html_entity_decode( $referencing_post->post_title, ENT_QUOTES, 'UTF-8' ),
+                'thumbnail' => $thumbnail,
+                'srcset'    => Srcset_Util::get_srcset( $referencing_post->ID, Srcset_Util::NAVIGATOR_WIDGET ),
+            ),
+            'entity' => array(
+                'id'        => $referencing_post->entity_id,
+                'label'     => $serialized_entity['label'],
+                'mainType'  => $serialized_entity['mainType'],
+                'permalink' => get_permalink( $referencing_post->entity_id ),
+            ),
+        );
+
+        $results[] = $result;
+    }
+
+    if ( count( $results ) < $navigator_length ) {
+        $results = apply_filters( 'wl_navigator_data_placeholder', $results, $navigator_id, $navigator_offset, $navigator_length );
+    }
+
+    // Add filler posts if needed
+    $filler_count = $navigator_length - count( $results );
+    if ( $filler_count > 0 ) {
+        $referencing_post_ids = array_map(
+            function ( $p ) {
+                return $p->ID;
+            },
+            $referencing_posts
+        );
+        /**
+         * @since 3.27.8
+         * Filler posts are fetched using this util.
+         */
+        $filler_posts_util       = new Filler_Posts_Util( $current_post_id, $post_types );
+        $post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
+        $filler_posts            = $filler_posts_util->get_filler_response( $filler_count, $post_ids_to_be_excluded );
+        $results                 = array_merge( $results, $filler_posts );
+    }
+
+    // Apply filters after fillers are added
+    foreach ( $results as $result_index => $result ) {
+        $results[ $result_index ]['post']   = apply_filters( 'wl_navigator_data_post', $result['post'], intval( $result['post']['id'] ), $navigator_id );
+        $results[ $result_index ]['entity'] = apply_filters( 'wl_navigator_data_entity', $result['entity'], intval( $result['entity']['id'] ), $navigator_id );
+    }
+
+    $results = apply_filters( 'wl_navigator_results', $results, $navigator_id, $current_post_id );
+
+    return $results;
 }
 
 /**
@@ -198,9 +198,9 @@ 
  */
 function wl_shortcode_navigator_ajax() {
 
-	// Temporary blocking the Navigator.
-	$results = wl_shortcode_navigator_data();
-	wl_core_send_json( $results );
+    // Temporary blocking the Navigator.
+    $results = wl_shortcode_navigator_data();
+    wl_core_send_json( $results );
 
 }
 
@@ -212,16 +212,16 @@ 
  */
 function wl_shortcode_navigator_wp_json() {
 
-	$results = wl_shortcode_navigator_data();
-	if ( ob_get_contents() ) {
-		ob_clean();
-	}
+    $results = wl_shortcode_navigator_data();
+    if ( ob_get_contents() ) {
+        ob_clean();
+    }
 
-	return array(
-		'items' => array(
-			array( 'values' => $results ),
-		),
-	);
+    return array(
+        'items' => array(
+            array( 'values' => $results ),
+        ),
+    );
 
 }
 
@@ -229,18 +229,18 @@ 
  * Adding `rest_api_init` action for amp backend of navigator
  */
 add_action(
-	'rest_api_init',
-	function () {
-		register_rest_route(
-			WL_REST_ROUTE_DEFAULT_NAMESPACE,
-			'/navigator',
-			array(
-				'methods'             => 'GET',
-				'permission_callback' => '__return_true',
-				'callback'            => 'wl_shortcode_navigator_wp_json',
-			)
-		);
-	}
+    'rest_api_init',
+    function () {
+        register_rest_route(
+            WL_REST_ROUTE_DEFAULT_NAMESPACE,
+            '/navigator',
+            array(
+                'methods'             => 'GET',
+                'permission_callback' => '__return_true',
+                'callback'            => 'wl_shortcode_navigator_wp_json',
+            )
+        );
+    }
 );
 
 /**
@@ -249,31 +249,31 @@ 
  * @since 2.2.0
  */
 add_action(
-	'plugins_loaded',
-	function () {
-		$action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
-			return;
-		}
-
-		remove_action( 'plugins_loaded', 'rocket_init' );
-		remove_action( 'plugins_loaded', 'wpseo_premium_init', 14 );
-		remove_action( 'plugins_loaded', 'wpseo_init', 14 );
-	},
-	0
+    'plugins_loaded',
+    function () {
+        $action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
+            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 () {
-		$action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
-			return;
-		}
-
-		remove_action( 'init', 'wp_widgets_init', 1 );
-		remove_action( 'init', 'gglcptch_init' );
-	},
-	0
+    'init',
+    function () {
+        $action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
+            return;
+        }
+
+        remove_action( 'init', 'wp_widgets_init', 1 );
+        remove_action( 'init', 'gglcptch_init' );
+    },
+    0
 );
 

Spacing +61 added lines, -61 removed lines

@@ -31,71 +31,71 @@ 
 		)
 	);
 
-	$cache_key = array( 'request_params' => $cache_params );
+	$cache_key = array('request_params' => $cache_params);
 
 	// Create the TTL cache and try to get the results.
-	$cache         = new Ttl_Cache( 'navigator', 8 * 60 * 60 ); // 8 hours.
-	$cache_results = $cache->get( $cache_key );
+	$cache         = new Ttl_Cache('navigator', 8 * 60 * 60); // 8 hours.
+	$cache_results = $cache->get($cache_key);
 
 	// So that the endpoint can be used remotely
-	header( 'Access-Control-Allow-Origin: *' );
+	header('Access-Control-Allow-Origin: *');
 
-	if ( isset( $cache_results ) ) {
-		header( 'X-WordLift-Cache: HIT' );
+	if (isset($cache_results)) {
+		header('X-WordLift-Cache: HIT');
 
 		return $cache_results;
 	}
 
-	header( 'X-WordLift-Cache: MISS' );
+	header('X-WordLift-Cache: MISS');
 
 	$results = _wl_navigator_get_data();
 
 	// Put the result before sending the json to the client, since sending the json will terminate us.
-	$cache->put( $cache_key, $results );
+	$cache->put($cache_key, $results);
 
 	return $results;
 }
 
 function _wl_navigator_get_data() {
 
-	check_ajax_referer( 'wl_navigator' );
+	check_ajax_referer('wl_navigator');
 
 	// Post ID must be defined
-	if ( ! isset( $_GET['post_id'] ) ) {
-		wp_send_json_error( 'No post_id given' );
+	if ( ! isset($_GET['post_id'])) {
+		wp_send_json_error('No post_id given');
 
 		return array();
 	}
 
 	// Post ID must be defined
-	if ( ! isset( $_GET['uniqid'] ) ) {
-		wp_send_json_error( 'No uniqid given' );
+	if ( ! isset($_GET['uniqid'])) {
+		wp_send_json_error('No uniqid given');
 
 		return array();
 	}
 
 	// Limit the results (defaults to 4)
-	$navigator_length    = isset( $_GET['limit'] ) ? intval( $_GET['limit'] ) : 4;
-	$navigator_offset    = isset( $_GET['offset'] ) ? intval( $_GET['offset'] ) : 0;
-	$order_by            = isset( $_GET['sort'] ) ? sanitize_sql_orderby( wp_unslash( $_GET['sort'] ) ) : 'ID DESC';
-	$post_types          = isset( $_GET['post_types'] ) ? sanitize_text_field( wp_unslash( $_GET['post_types'] ) ) : '';
-	$post_types          = explode( ',', $post_types );
+	$navigator_length    = isset($_GET['limit']) ? intval($_GET['limit']) : 4;
+	$navigator_offset    = isset($_GET['offset']) ? intval($_GET['offset']) : 0;
+	$order_by            = isset($_GET['sort']) ? sanitize_sql_orderby(wp_unslash($_GET['sort'])) : 'ID DESC';
+	$post_types          = isset($_GET['post_types']) ? sanitize_text_field(wp_unslash($_GET['post_types'])) : '';
+	$post_types          = explode(',', $post_types);
 	$existing_post_types = get_post_types();
-	$post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
+	$post_types          = array_values(array_intersect($existing_post_types, $post_types));
 	$current_post_id     = (int) $_GET['post_id'];
-	$current_post        = get_post( $current_post_id );
+	$current_post        = get_post($current_post_id);
 
-	$navigator_id = sanitize_text_field( wp_unslash( $_GET['uniqid'] ) );
+	$navigator_id = sanitize_text_field(wp_unslash($_GET['uniqid']));
 
 	// Post ID has to match an existing item
-	if ( null === $current_post ) {
-		wp_send_json_error( 'No valid post_id given' );
+	if (null === $current_post) {
+		wp_send_json_error('No valid post_id given');
 
 		return array();
 	}
 
 	// Determine navigator type and call respective _get_results
-	if ( get_post_type( $current_post_id ) === Wordlift_Entity_Service::TYPE_NAME ) {
+	if (get_post_type($current_post_id) === Wordlift_Entity_Service::TYPE_NAME) {
 
 		$referencing_posts = Navigator_Data::entity_navigator_get_results(
 			$current_post_id,
@@ -125,8 +125,8 @@ 
 
 	// loop over them and take the first one which is not already in the $related_posts
 	$results = array();
-	foreach ( $referencing_posts as $referencing_post ) {
-		$serialized_entity = wl_serialize_entity( $referencing_post->entity_id );
+	foreach ($referencing_posts as $referencing_post) {
+		$serialized_entity = wl_serialize_entity($referencing_post->entity_id);
 
 		/**
 		 * Use the thumbnail.
@@ -136,36 +136,36 @@ 
 		 *
 		 * @since 3.19.3 We're using the medium size image.
 		 */
-		$thumbnail = get_the_post_thumbnail_url( $referencing_post, 'medium' );
+		$thumbnail = get_the_post_thumbnail_url($referencing_post, 'medium');
 
 		$result = array(
 			'post'   => array(
 				'id'        => $referencing_post->ID,
-				'permalink' => get_permalink( $referencing_post->ID ),
-				'title'     => html_entity_decode( $referencing_post->post_title, ENT_QUOTES, 'UTF-8' ),
+				'permalink' => get_permalink($referencing_post->ID),
+				'title'     => html_entity_decode($referencing_post->post_title, ENT_QUOTES, 'UTF-8'),
 				'thumbnail' => $thumbnail,
-				'srcset'    => Srcset_Util::get_srcset( $referencing_post->ID, Srcset_Util::NAVIGATOR_WIDGET ),
+				'srcset'    => Srcset_Util::get_srcset($referencing_post->ID, Srcset_Util::NAVIGATOR_WIDGET),
 			),
 			'entity' => array(
 				'id'        => $referencing_post->entity_id,
 				'label'     => $serialized_entity['label'],
 				'mainType'  => $serialized_entity['mainType'],
-				'permalink' => get_permalink( $referencing_post->entity_id ),
+				'permalink' => get_permalink($referencing_post->entity_id),
 			),
 		);
 
 		$results[] = $result;
 	}
 
-	if ( count( $results ) < $navigator_length ) {
-		$results = apply_filters( 'wl_navigator_data_placeholder', $results, $navigator_id, $navigator_offset, $navigator_length );
+	if (count($results) < $navigator_length) {
+		$results = apply_filters('wl_navigator_data_placeholder', $results, $navigator_id, $navigator_offset, $navigator_length);
 	}
 
 	// Add filler posts if needed
-	$filler_count = $navigator_length - count( $results );
-	if ( $filler_count > 0 ) {
+	$filler_count = $navigator_length - count($results);
+	if ($filler_count > 0) {
 		$referencing_post_ids = array_map(
-			function ( $p ) {
+			function($p) {
 				return $p->ID;
 			},
 			$referencing_posts
@@ -174,19 +174,19 @@ 
 		 * @since 3.27.8
 		 * Filler posts are fetched using this util.
 		 */
-		$filler_posts_util       = new Filler_Posts_Util( $current_post_id, $post_types );
-		$post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
-		$filler_posts            = $filler_posts_util->get_filler_response( $filler_count, $post_ids_to_be_excluded );
-		$results                 = array_merge( $results, $filler_posts );
+		$filler_posts_util       = new Filler_Posts_Util($current_post_id, $post_types);
+		$post_ids_to_be_excluded = array_merge(array($current_post_id), $referencing_post_ids);
+		$filler_posts            = $filler_posts_util->get_filler_response($filler_count, $post_ids_to_be_excluded);
+		$results                 = array_merge($results, $filler_posts);
 	}
 
 	// Apply filters after fillers are added
-	foreach ( $results as $result_index => $result ) {
-		$results[ $result_index ]['post']   = apply_filters( 'wl_navigator_data_post', $result['post'], intval( $result['post']['id'] ), $navigator_id );
-		$results[ $result_index ]['entity'] = apply_filters( 'wl_navigator_data_entity', $result['entity'], intval( $result['entity']['id'] ), $navigator_id );
+	foreach ($results as $result_index => $result) {
+		$results[$result_index]['post']   = apply_filters('wl_navigator_data_post', $result['post'], intval($result['post']['id']), $navigator_id);
+		$results[$result_index]['entity'] = apply_filters('wl_navigator_data_entity', $result['entity'], intval($result['entity']['id']), $navigator_id);
 	}
 
-	$results = apply_filters( 'wl_navigator_results', $results, $navigator_id, $current_post_id );
+	$results = apply_filters('wl_navigator_results', $results, $navigator_id, $current_post_id);
 
 	return $results;
 }
@@ -200,12 +200,12 @@ 
 
 	// Temporary blocking the Navigator.
 	$results = wl_shortcode_navigator_data();
-	wl_core_send_json( $results );
+	wl_core_send_json($results);
 
 }
 
-add_action( 'wp_ajax_wl_navigator', 'wl_shortcode_navigator_ajax' );
-add_action( 'wp_ajax_nopriv_wl_navigator', 'wl_shortcode_navigator_ajax' );
+add_action('wp_ajax_wl_navigator', 'wl_shortcode_navigator_ajax');
+add_action('wp_ajax_nopriv_wl_navigator', 'wl_shortcode_navigator_ajax');
 
 /**
  * wp-json call for the navigator widget
@@ -213,13 +213,13 @@ 
 function wl_shortcode_navigator_wp_json() {
 
 	$results = wl_shortcode_navigator_data();
-	if ( ob_get_contents() ) {
+	if (ob_get_contents()) {
 		ob_clean();
 	}
 
 	return array(
 		'items' => array(
-			array( 'values' => $results ),
+			array('values' => $results),
 		),
 	);
 
@@ -230,7 +230,7 @@ 
  */
 add_action(
 	'rest_api_init',
-	function () {
+	function() {
 		register_rest_route(
 			WL_REST_ROUTE_DEFAULT_NAMESPACE,
 			'/navigator',
@@ -250,29 +250,29 @@ 
  */
 add_action(
 	'plugins_loaded',
-	function () {
-		$action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
+	function() {
+		$action = array_key_exists('action', $_REQUEST) ? sanitize_text_field(wp_unslash((string) $_REQUEST['action'])) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( ! defined('DOING_AJAX') || ! DOING_AJAX || 'wl_navigator' !== $action) {
 			return;
 		}
 
-		remove_action( 'plugins_loaded', 'rocket_init' );
-		remove_action( 'plugins_loaded', 'wpseo_premium_init', 14 );
-		remove_action( 'plugins_loaded', 'wpseo_init', 14 );
+		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 () {
-		$action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
+	function() {
+		$action = array_key_exists('action', $_REQUEST) ? sanitize_text_field(wp_unslash((string) $_REQUEST['action'])) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( ! defined('DOING_AJAX') || ! DOING_AJAX || 'wl_navigator' !== $action) {
 			return;
 		}
 
-		remove_action( 'init', 'wp_widgets_init', 1 );
-		remove_action( 'init', 'gglcptch_init' );
+		remove_action('init', 'wp_widgets_init', 1);
+		remove_action('init', 'gglcptch_init');
 	},
 	0
 );

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

Indentation +63 added lines, -63 removed lines

@@ -20,80 +20,80 @@
  */
 class Wordlift_WpRocket_Adapter {
 
-	/**
-	 * Create a {@link Wordlift_WpRocket_Adapter} instance.
-	 *
-	 * @since 3.19.4
-	 */
-	public function __construct() {
+    /**
+     * Create a {@link Wordlift_WpRocket_Adapter} instance.
+     *
+     * @since 3.19.4
+     */
+    public function __construct() {
 
-		add_filter( 'rocket_exclude_js', array( $this, 'exclude_js' ) );
-		add_filter( 'rocket_excluded_inline_js_content', array( $this, 'excluded_inline_js_content' ) );
+        add_filter( 'rocket_exclude_js', array( $this, 'exclude_js' ) );
+        add_filter( 'rocket_excluded_inline_js_content', array( $this, 'excluded_inline_js_content' ) );
 
-	}
+    }
 
-	/**
-	 * Get the absolute path for the specified URL.
-	 *
-	 * @param string $url The full URL.
-	 *
-	 * @return string The absolute path.
-	 */
-	private function get_absolute_path( $url ) {
+    /**
+     * Get the absolute path for the specified URL.
+     *
+     * @param string $url The full URL.
+     *
+     * @return string The absolute path.
+     */
+    private function get_absolute_path( $url ) {
 
-		if ( 1 !== preg_match( '|https?://[^/]+(/.*)$|', $url, $matches ) ) {
-			return $url;
-		}
+        if ( 1 !== preg_match( '|https?://[^/]+(/.*)$|', $url, $matches ) ) {
+            return $url;
+        }
 
-		return $matches[1];
-	}
+        return $matches[1];
+    }
 
-	/**
-	 * Hook to `rocket_exclude_defer_js` filter.
-	 *
-	 * @param array $excluded_js The preset excluded files.
-	 *
-	 * @return array The updated excluded files array.
-	 *
-	 * @since 3.25.0 We realized that WP Rocket has an issue with these path: while it seems to expect a path relative
-	 *               to home_url, it is actually looking for a path relative to the root. We leave both exclusions so
-	 *               that we'll be compatible in case WP Rocket fixes its implementation.
-	 * @since 3.23.0 add the Cloud js.
-	 * @since 3.20.0 hook to `rocket_exclude_js`.
-	 * @since 3.19.4
-	 */
-	public function exclude_js( $excluded_js = array() ) {
+    /**
+     * Hook to `rocket_exclude_defer_js` filter.
+     *
+     * @param array $excluded_js The preset excluded files.
+     *
+     * @return array The updated excluded files array.
+     *
+     * @since 3.25.0 We realized that WP Rocket has an issue with these path: while it seems to expect a path relative
+     *               to home_url, it is actually looking for a path relative to the root. We leave both exclusions so
+     *               that we'll be compatible in case WP Rocket fixes its implementation.
+     * @since 3.23.0 add the Cloud js.
+     * @since 3.20.0 hook to `rocket_exclude_js`.
+     * @since 3.19.4
+     */
+    public function exclude_js( $excluded_js = array() ) {
 
-		// Exclude our own public JS.
-		$excluded_js[] = $this->get_absolute_path( Wordlift_Public::get_public_js_url() );
-		$excluded_js[] = $this->get_absolute_path( Wordlift_Public::get_cloud_js_url() );
+        // Exclude our own public JS.
+        $excluded_js[] = $this->get_absolute_path( Wordlift_Public::get_public_js_url() );
+        $excluded_js[] = $this->get_absolute_path( Wordlift_Public::get_cloud_js_url() );
 
-		$excluded_js[] = str_replace( home_url(), '', plugin_dir_url( __DIR__ ) . '/js/dist/bundle.js' );
-		$excluded_js[] = str_replace( home_url(), '', plugin_dir_url( __DIR__ ) . '/js/dist/wordlift-cloud.js' );
+        $excluded_js[] = str_replace( home_url(), '', plugin_dir_url( __DIR__ ) . '/js/dist/bundle.js' );
+        $excluded_js[] = str_replace( home_url(), '', plugin_dir_url( __DIR__ ) . '/js/dist/wordlift-cloud.js' );
 
-		return $excluded_js;
-	}
+        return $excluded_js;
+    }
 
-	/**
-	 * Filters inline JS excluded from being combined
-	 *
-	 * @link https://github.com/insideout10/wordlift-plugin/issues/868
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param array $pattern Patterns to match.
-	 *
-	 * @return array Patterns to match.
-	 */
-	public function excluded_inline_js_content( $pattern = array() ) {
+    /**
+     * Filters inline JS excluded from being combined
+     *
+     * @link https://github.com/insideout10/wordlift-plugin/issues/868
+     *
+     * @since 3.20.0
+     *
+     * @param array $pattern Patterns to match.
+     *
+     * @return array Patterns to match.
+     */
+    public function excluded_inline_js_content( $pattern = array() ) {
 
-		$pattern[] = 'wlSettings';
-		$pattern[] = 'wlNavigators';
-		$pattern[] = '_wlCloudSettings';
-		$pattern[] = 'wlProductsNavigators';
-		$pattern[] = 'wlFaceteds';
+        $pattern[] = 'wlSettings';
+        $pattern[] = 'wlNavigators';
+        $pattern[] = '_wlCloudSettings';
+        $pattern[] = 'wlProductsNavigators';
+        $pattern[] = 'wlFaceteds';
 
-		return $pattern;
-	}
+        return $pattern;
+    }
 
 }

Spacing +10 added lines, -10 removed lines

@@ -27,8 +27,8 @@ 
 	 */
 	public function __construct() {
 
-		add_filter( 'rocket_exclude_js', array( $this, 'exclude_js' ) );
-		add_filter( 'rocket_excluded_inline_js_content', array( $this, 'excluded_inline_js_content' ) );
+		add_filter('rocket_exclude_js', array($this, 'exclude_js'));
+		add_filter('rocket_excluded_inline_js_content', array($this, 'excluded_inline_js_content'));
 
 	}
 
@@ -39,9 +39,9 @@ 
 	 *
 	 * @return string The absolute path.
 	 */
-	private function get_absolute_path( $url ) {
+	private function get_absolute_path($url) {
 
-		if ( 1 !== preg_match( '|https?://[^/]+(/.*)$|', $url, $matches ) ) {
+		if (1 !== preg_match('|https?://[^/]+(/.*)$|', $url, $matches)) {
 			return $url;
 		}
 
@@ -62,14 +62,14 @@ 
 	 * @since 3.20.0 hook to `rocket_exclude_js`.
 	 * @since 3.19.4
 	 */
-	public function exclude_js( $excluded_js = array() ) {
+	public function exclude_js($excluded_js = array()) {
 
 		// Exclude our own public JS.
-		$excluded_js[] = $this->get_absolute_path( Wordlift_Public::get_public_js_url() );
-		$excluded_js[] = $this->get_absolute_path( Wordlift_Public::get_cloud_js_url() );
+		$excluded_js[] = $this->get_absolute_path(Wordlift_Public::get_public_js_url());
+		$excluded_js[] = $this->get_absolute_path(Wordlift_Public::get_cloud_js_url());
 
-		$excluded_js[] = str_replace( home_url(), '', plugin_dir_url( __DIR__ ) . '/js/dist/bundle.js' );
-		$excluded_js[] = str_replace( home_url(), '', plugin_dir_url( __DIR__ ) . '/js/dist/wordlift-cloud.js' );
+		$excluded_js[] = str_replace(home_url(), '', plugin_dir_url(__DIR__).'/js/dist/bundle.js');
+		$excluded_js[] = str_replace(home_url(), '', plugin_dir_url(__DIR__).'/js/dist/wordlift-cloud.js');
 
 		return $excluded_js;
 	}
@@ -85,7 +85,7 @@ 
 	 *
 	 * @return array Patterns to match.
 	 */
-	public function excluded_inline_js_content( $pattern = array() ) {
+	public function excluded_inline_js_content($pattern = array()) {
 
 		$pattern[] = 'wlSettings';
 		$pattern[] = 'wlNavigators';

src/public/class-wordlift-vocabulary-shortcode.php

Indentation +404 added lines, -404 removed lines

@@ -18,267 +18,267 @@ 
  */
 class Wordlift_Vocabulary_Shortcode extends Wordlift_Shortcode {
 
-	/**
-	 * The shortcode.
-	 *
-	 * @since  3.17.0
-	 */
-	const SHORTCODE = 'wl_vocabulary';
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.17.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The vocabulary id
-	 *
-	 * @since  3.18.3
-	 * @access private
-	 * @var int $vocabulary_id The vocabulary unique id.
-	 */
-	private static $vocabulary_id = 0;
-
-	/**
-	 * Create a {@link Wordlift_Glossary_Shortcode} instance.
-	 *
-	 * @since 3.16.0
-	 */
-	public function __construct() {
-		parent::__construct();
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->register_block_type();
-
-	}
-
-	/**
-	 * Check whether the requirements for this shortcode to work are available.
-	 *
-	 * @return bool True if the requirements are satisfied otherwise false.
-	 * @since 3.17.0
-	 */
-	private static function are_requirements_satisfied() {
-
-		return function_exists( 'mb_strlen' ) &&
-			   function_exists( 'mb_substr' ) &&
-			   function_exists( 'mb_strtolower' ) &&
-			   function_exists( 'mb_strtoupper' ) &&
-			   function_exists( 'mb_convert_case' );
-	}
-
-	/**
-	 * Render the shortcode.
-	 *
-	 * @param array $atts An array of shortcode attributes as set by the editor.
-	 *
-	 * @return string The output html code.
-	 * @since 3.16.0
-	 */
-	public function render( $atts ) {
-
-		// Bail out if the requirements aren't satisfied: we need mbstring for
-		// the vocabulary widget to work.
-		if ( ! self::are_requirements_satisfied() ) {
-			$this->log->warn( "The vocabulary widget cannot be displayed because this WordPress installation doesn't satisfy its requirements." );
-
-			return '';
-		}
-
-		wp_enqueue_style( 'wl-vocabulary-shortcode', dirname( plugin_dir_url( __FILE__ ) ) . '/public/css/wordlift-vocabulary-shortcode.css', array(), WORDLIFT_VERSION );
-
-		// Extract attributes and set default values.
-		$atts = shortcode_atts(
-			array(
-				// The entity type, such as `person`, `organization`, ...
-				'type'    => 'all',
-				// Limit the number of posts to 100 by default. Use -1 to remove the limit.
-				'limit'   => 100,
-				// Sort by title.
-				'orderby' => 'post_date',
-				// Sort DESC.
-				'order'   => 'DESC',
-				// Allow to specify the category ID.
-				'cat'     => '',
-			),
-			$atts
-		);
-
-		// Get the posts. Note that if a `type` is specified before, then the
-		// `tax_query` from the `add_criterias` call isn't added.
-		$posts = $this->get_posts( $atts );
-
-		// Get the alphabet.
-		$language_code = Wordlift_Configuration_Service::get_instance()->get_language_code();
-		$alphabet      = Wordlift_Alphabet_Service::get( $language_code );
-
-		// Add posts to the alphabet.
-		foreach ( $posts as $post ) {
-			$this->add_to_alphabet( $alphabet, $post->ID );
-		}
-
-		$header   = '';
-		$sections = '';
-
-		// Get unique id for each vocabulary shortcode.
-		$vocabulary_id = self::get_and_increment_vocabulary_id();
-
-		// Generate the header.
-		foreach ( $alphabet as $item => $translations ) {
-			$template = ( empty( $translations )
-				? '<span class="wl-vocabulary-widget-disabled">%s</span>'
-				: '<a href="#wl-vocabulary-%3$d-%2$s">%1$s</a>' );
-
-			$header .= sprintf( $template, esc_html( $item ), esc_attr( $item ), $vocabulary_id );
-		}
-
-		// Generate the sections.
-		foreach ( $alphabet as $item => $translations ) {
-			// @since 3.19.3 we use `mb_strtolower` and `mb_strtoupper` with a custom function to handle sorting,
-			// since we had `AB` being placed before `Aa` with `asort`.
-			//
-			// Order the translations alphabetically.
-			// asort( $translations );
-			uasort(
-				$translations,
-				function ( $a, $b ) {
-					if ( mb_strtolower( $a ) === mb_strtolower( $b )
-						 || mb_strtoupper( $a ) === mb_strtoupper( $b ) ) {
-						return 0;
-					}
-
-					return ( mb_strtolower( $a ) < mb_strtolower( $b ) ) ? - 1 : 1;
-				}
-			);
-			$sections .= $this->get_section( $item, $translations, $vocabulary_id );
-		}
-
-		// Return HTML template.
-		ob_start();
-		?>
+    /**
+     * The shortcode.
+     *
+     * @since  3.17.0
+     */
+    const SHORTCODE = 'wl_vocabulary';
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.17.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The vocabulary id
+     *
+     * @since  3.18.3
+     * @access private
+     * @var int $vocabulary_id The vocabulary unique id.
+     */
+    private static $vocabulary_id = 0;
+
+    /**
+     * Create a {@link Wordlift_Glossary_Shortcode} instance.
+     *
+     * @since 3.16.0
+     */
+    public function __construct() {
+        parent::__construct();
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->register_block_type();
+
+    }
+
+    /**
+     * Check whether the requirements for this shortcode to work are available.
+     *
+     * @return bool True if the requirements are satisfied otherwise false.
+     * @since 3.17.0
+     */
+    private static function are_requirements_satisfied() {
+
+        return function_exists( 'mb_strlen' ) &&
+               function_exists( 'mb_substr' ) &&
+               function_exists( 'mb_strtolower' ) &&
+               function_exists( 'mb_strtoupper' ) &&
+               function_exists( 'mb_convert_case' );
+    }
+
+    /**
+     * Render the shortcode.
+     *
+     * @param array $atts An array of shortcode attributes as set by the editor.
+     *
+     * @return string The output html code.
+     * @since 3.16.0
+     */
+    public function render( $atts ) {
+
+        // Bail out if the requirements aren't satisfied: we need mbstring for
+        // the vocabulary widget to work.
+        if ( ! self::are_requirements_satisfied() ) {
+            $this->log->warn( "The vocabulary widget cannot be displayed because this WordPress installation doesn't satisfy its requirements." );
+
+            return '';
+        }
+
+        wp_enqueue_style( 'wl-vocabulary-shortcode', dirname( plugin_dir_url( __FILE__ ) ) . '/public/css/wordlift-vocabulary-shortcode.css', array(), WORDLIFT_VERSION );
+
+        // Extract attributes and set default values.
+        $atts = shortcode_atts(
+            array(
+                // The entity type, such as `person`, `organization`, ...
+                'type'    => 'all',
+                // Limit the number of posts to 100 by default. Use -1 to remove the limit.
+                'limit'   => 100,
+                // Sort by title.
+                'orderby' => 'post_date',
+                // Sort DESC.
+                'order'   => 'DESC',
+                // Allow to specify the category ID.
+                'cat'     => '',
+            ),
+            $atts
+        );
+
+        // Get the posts. Note that if a `type` is specified before, then the
+        // `tax_query` from the `add_criterias` call isn't added.
+        $posts = $this->get_posts( $atts );
+
+        // Get the alphabet.
+        $language_code = Wordlift_Configuration_Service::get_instance()->get_language_code();
+        $alphabet      = Wordlift_Alphabet_Service::get( $language_code );
+
+        // Add posts to the alphabet.
+        foreach ( $posts as $post ) {
+            $this->add_to_alphabet( $alphabet, $post->ID );
+        }
+
+        $header   = '';
+        $sections = '';
+
+        // Get unique id for each vocabulary shortcode.
+        $vocabulary_id = self::get_and_increment_vocabulary_id();
+
+        // Generate the header.
+        foreach ( $alphabet as $item => $translations ) {
+            $template = ( empty( $translations )
+                ? '<span class="wl-vocabulary-widget-disabled">%s</span>'
+                : '<a href="#wl-vocabulary-%3$d-%2$s">%1$s</a>' );
+
+            $header .= sprintf( $template, esc_html( $item ), esc_attr( $item ), $vocabulary_id );
+        }
+
+        // Generate the sections.
+        foreach ( $alphabet as $item => $translations ) {
+            // @since 3.19.3 we use `mb_strtolower` and `mb_strtoupper` with a custom function to handle sorting,
+            // since we had `AB` being placed before `Aa` with `asort`.
+            //
+            // Order the translations alphabetically.
+            // asort( $translations );
+            uasort(
+                $translations,
+                function ( $a, $b ) {
+                    if ( mb_strtolower( $a ) === mb_strtolower( $b )
+                         || mb_strtoupper( $a ) === mb_strtoupper( $b ) ) {
+                        return 0;
+                    }
+
+                    return ( mb_strtolower( $a ) < mb_strtolower( $b ) ) ? - 1 : 1;
+                }
+            );
+            $sections .= $this->get_section( $item, $translations, $vocabulary_id );
+        }
+
+        // Return HTML template.
+        ob_start();
+        ?>
 		<div class='wl-vocabulary'>
 			<nav class='wl-vocabulary-alphabet-nav'>
 				<?php
-				echo wp_kses(
-					$header,
-					array(
-						'span' => array( 'class' => array() ),
-						'a'    => array( 'href' => array() ),
-					)
-				);
-				?>
+                echo wp_kses(
+                    $header,
+                    array(
+                        'span' => array( 'class' => array() ),
+                        'a'    => array( 'href' => array() ),
+                    )
+                );
+                ?>
 			</nav>
 			<div class='wl-vocabulary-grid'>
 				<?php
-				echo wp_kses(
-					$sections,
-					array(
-						'div'   => array(
-							'class' => array(),
-							'id'    => array(),
-						),
-						'aside' => array( 'class' => array() ),
-						'ul'    => array( 'class' => array() ),
-						'li'    => array(),
-						'a'     => array( 'href' => array() ),
-					)
-				);
-				?>
+                echo wp_kses(
+                    $sections,
+                    array(
+                        'div'   => array(
+                            'class' => array(),
+                            'id'    => array(),
+                        ),
+                        'aside' => array( 'class' => array() ),
+                        'ul'    => array( 'class' => array() ),
+                        'li'    => array(),
+                        'a'     => array( 'href' => array() ),
+                    )
+                );
+                ?>
 			</div>
 		</div>
 		<?php
-		$html = ob_get_clean();
-
-		return $html;
-
-	}
-
-	private function register_block_type() {
-
-		$scope = $this;
-
-		add_action(
-			'init',
-			function () use ( $scope ) {
-				if ( ! function_exists( 'register_block_type' ) ) {
-					// Gutenberg is not active.
-					return;
-				}
-
-				register_block_type(
-					'wordlift/vocabulary',
-					array(
-						'editor_script'   => 'wl-block-editor',
-						'render_callback' => function ( $attributes ) use ( $scope ) {
-							$attr_code = '';
-							foreach ( $attributes as $key => $value ) {
-								$attr_code .= $key . '="' . htmlentities( $value ) . '" ';
-							}
-
-							return '[' . $scope::SHORTCODE . ' ' . $attr_code . ']';
-						},
-						'attributes'      => array(
-							'type'        => array(
-								'type'    => 'string',
-								'default' => 'all',
-							),
-							'limit'       => array(
-								'type'    => 'number',
-								'default' => 100,
-							),
-							'orderby'     => array(
-								'type'    => 'string',
-								'default' => 'post_date',
-							),
-							'order'       => array(
-								'type'    => 'string',
-								'default' => 'DESC',
-							),
-							'cat'         => array(
-								'type'    => 'string',
-								'default' => '',
-							),
-							'preview'     => array(
-								'type'    => 'boolean',
-								'default' => false,
-							),
-							'preview_src' => array(
-								'type'    => 'string',
-								'default' => WP_CONTENT_URL . '/plugins/wordlift/images/block-previews/vocabulary.png',
-							),
-						),
-					)
-				);
-			}
-		);
-	}
-
-	/**
-	 * Generate the html code for the section.
-	 *
-	 * @param string $letter The section's letter.
-	 * @param array  $posts An array of `$post_id => $post_title` associated with
-	 *                                the section.
-	 * @param int    $vocabulary_id Unique vocabulary id.
-	 *
-	 * @return string The section html code (or an empty string if the section has
-	 *                no posts).
-	 * @since 3.17.0
-	 */
-	private function get_section( $letter, $posts, $vocabulary_id ) {
-
-		// Return an empty string if there are no posts.
-		if ( 0 === count( $posts ) ) {
-			return '';
-		}
-
-		return sprintf(
-			'
+        $html = ob_get_clean();
+
+        return $html;
+
+    }
+
+    private function register_block_type() {
+
+        $scope = $this;
+
+        add_action(
+            'init',
+            function () use ( $scope ) {
+                if ( ! function_exists( 'register_block_type' ) ) {
+                    // Gutenberg is not active.
+                    return;
+                }
+
+                register_block_type(
+                    'wordlift/vocabulary',
+                    array(
+                        'editor_script'   => 'wl-block-editor',
+                        'render_callback' => function ( $attributes ) use ( $scope ) {
+                            $attr_code = '';
+                            foreach ( $attributes as $key => $value ) {
+                                $attr_code .= $key . '="' . htmlentities( $value ) . '" ';
+                            }
+
+                            return '[' . $scope::SHORTCODE . ' ' . $attr_code . ']';
+                        },
+                        'attributes'      => array(
+                            'type'        => array(
+                                'type'    => 'string',
+                                'default' => 'all',
+                            ),
+                            'limit'       => array(
+                                'type'    => 'number',
+                                'default' => 100,
+                            ),
+                            'orderby'     => array(
+                                'type'    => 'string',
+                                'default' => 'post_date',
+                            ),
+                            'order'       => array(
+                                'type'    => 'string',
+                                'default' => 'DESC',
+                            ),
+                            'cat'         => array(
+                                'type'    => 'string',
+                                'default' => '',
+                            ),
+                            'preview'     => array(
+                                'type'    => 'boolean',
+                                'default' => false,
+                            ),
+                            'preview_src' => array(
+                                'type'    => 'string',
+                                'default' => WP_CONTENT_URL . '/plugins/wordlift/images/block-previews/vocabulary.png',
+                            ),
+                        ),
+                    )
+                );
+            }
+        );
+    }
+
+    /**
+     * Generate the html code for the section.
+     *
+     * @param string $letter The section's letter.
+     * @param array  $posts An array of `$post_id => $post_title` associated with
+     *                                the section.
+     * @param int    $vocabulary_id Unique vocabulary id.
+     *
+     * @return string The section html code (or an empty string if the section has
+     *                no posts).
+     * @since 3.17.0
+     */
+    private function get_section( $letter, $posts, $vocabulary_id ) {
+
+        // Return an empty string if there are no posts.
+        if ( 0 === count( $posts ) ) {
+            return '';
+        }
+
+        return sprintf(
+            '
 			<div class="wl-vocabulary-letter-block" id="wl-vocabulary-%d-%s">
 				<aside class="wl-vocabulary-left-column">%s</aside>
 				<div class="wl-vocabulary-right-column">
@@ -288,157 +288,157 @@ 
 				</div>
 			</div>
 		',
-			$vocabulary_id,
-			esc_attr( $letter ),
-			esc_html( $letter ),
-			$this->format_posts_as_list( $posts )
-		);
-	}
-
-	/**
-	 * Format an array post `$post_id => $post_title` as a list.
-	 *
-	 * @param array $posts An array of `$post_id => $post_title` key, value pairs.
-	 *
-	 * @return string A list.
-	 * @since 3.17.0
-	 */
-	private function format_posts_as_list( $posts ) {
-
-		return array_reduce(
-			array_keys( $posts ),
-			function ( $carry, $item ) use ( $posts ) {
-				return $carry . sprintf( '<li><a href="%s">%s</a></li>', esc_attr( get_permalink( $item ) ), esc_html( $posts[ $item ] ) );
-			},
-			''
-		);
-	}
-
-	/**
-	 * Get the posts from WordPress using the provided attributes.
-	 *
-	 * @param array $atts The shortcode attributes.
-	 *
-	 * @return array An array of {@link WP_Post}s.
-	 * @since 3.17.0
-	 */
-	private function get_posts( $atts ) {
-		// The default arguments for the query.
-		$args = array(
-			// phpcs:ignore WordPress.WP.PostsPerPage.posts_per_page_posts_per_page
-			'posts_per_page'         => intval( $atts['limit'] ),
-			'update_post_meta_cache' => false,
-			'update_post_term_cache' => false,
-			'orderby'                => $atts['orderby'],
-			'order'                  => $atts['order'],
-			// Exclude the publisher.
-			'post__not_in'           => array( Wordlift_Configuration_Service::get_instance()->get_publisher_id() ),
-		);
-
-		// Limit the based entity type if needed.
-		if ( 'all' !== $atts['type'] ) {
-			$args['tax_query'] = array(
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'field'    => 'slug',
-					'terms'    => $atts['type'],
-				),
-			);
-		}
-
-		if ( ! empty( $atts['cat'] ) ) {
-			$args['cat'] = $atts['cat'];
-		}
-
-		// Get the posts. Note that if a `type` is specified before, then the
-		// `tax_query` from the `add_criterias` call isn't added.
-		return get_posts( Wordlift_Entity_Service::add_criterias( $args ) );
-
-	}
-
-	/**
-	 * Populate the alphabet with posts.
-	 *
-	 * @param array $alphabet An array of letters.
-	 * @param int   $post_id The {@link WP_Post} id.
-	 *
-	 * @since 3.17.0
-	 */
-	private function add_to_alphabet( &$alphabet, $post_id ) {
-
-		// Get the title without accents.
-		$title = $this->get_the_title( $post_id );
-
-		// Get the initial letter.
-		$letter = $this->get_first_letter_in_alphabet_or_hash( $alphabet, $title );
-
-		// Add the post.
-		$alphabet[ $letter ][ $post_id ] = $title;
-
-	}
-
-	/**
-	 * Get the title without accents.
-	 * If the post is not of type `entity`, use first synonym if synonyms exists.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/1096
-	 *
-	 * @since 3.27.0
-	 *
-	 * @param int $post_id The {@link WP_Post} id.
-	 *
-	 * @return string
-	 */
-	private function get_the_title( $post_id ) {
-
-		$title = get_the_title( $post_id );
-
-		if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
-			$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
-
-			if ( count( $alternative_labels ) > 0 ) {
-				$title = $alternative_labels[0];
-			}
-		}
-
-		return remove_accents( $title );
-
-	}
-
-	/**
-	 * Find the first letter in the alphabet.
-	 *
-	 * In some alphabets a letter is a compound of letters, therefore this function
-	 * will look for groups of 2 or 3 letters in the alphabet before looking for a
-	 * single letter. In case the letter is not found a # (hash) key is returned.
-	 *
-	 * @param array  $alphabet An array of alphabet letters.
-	 * @param string $title The title to match.
-	 *
-	 * @return string The initial letter or a `#` key.
-	 * @since 3.17.0
-	 */
-	private function get_first_letter_in_alphabet_or_hash( $alphabet, $title ) {
-
-		// Need to handle letters which consist of 3 and 2 characters.
-		for ( $i = 3; $i > 0; $i -- ) {
-			$letter = mb_convert_case( mb_substr( $title, 0, $i ), MB_CASE_UPPER );
-			if ( isset( $alphabet[ $letter ] ) ) {
-				return $letter;
-			}
-		}
-
-		return '#';
-	}
-
-	/**
-	 * Get and increment the `$vocabulary_id`.
-	 *
-	 * @return int The incremented vocabulary id.
-	 * @since  3.18.3
-	 */
-	private static function get_and_increment_vocabulary_id() {
-		return self::$vocabulary_id ++;
-	}
+            $vocabulary_id,
+            esc_attr( $letter ),
+            esc_html( $letter ),
+            $this->format_posts_as_list( $posts )
+        );
+    }
+
+    /**
+     * Format an array post `$post_id => $post_title` as a list.
+     *
+     * @param array $posts An array of `$post_id => $post_title` key, value pairs.
+     *
+     * @return string A list.
+     * @since 3.17.0
+     */
+    private function format_posts_as_list( $posts ) {
+
+        return array_reduce(
+            array_keys( $posts ),
+            function ( $carry, $item ) use ( $posts ) {
+                return $carry . sprintf( '<li><a href="%s">%s</a></li>', esc_attr( get_permalink( $item ) ), esc_html( $posts[ $item ] ) );
+            },
+            ''
+        );
+    }
+
+    /**
+     * Get the posts from WordPress using the provided attributes.
+     *
+     * @param array $atts The shortcode attributes.
+     *
+     * @return array An array of {@link WP_Post}s.
+     * @since 3.17.0
+     */
+    private function get_posts( $atts ) {
+        // The default arguments for the query.
+        $args = array(
+            // phpcs:ignore WordPress.WP.PostsPerPage.posts_per_page_posts_per_page
+            'posts_per_page'         => intval( $atts['limit'] ),
+            'update_post_meta_cache' => false,
+            'update_post_term_cache' => false,
+            'orderby'                => $atts['orderby'],
+            'order'                  => $atts['order'],
+            // Exclude the publisher.
+            'post__not_in'           => array( Wordlift_Configuration_Service::get_instance()->get_publisher_id() ),
+        );
+
+        // Limit the based entity type if needed.
+        if ( 'all' !== $atts['type'] ) {
+            $args['tax_query'] = array(
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'field'    => 'slug',
+                    'terms'    => $atts['type'],
+                ),
+            );
+        }
+
+        if ( ! empty( $atts['cat'] ) ) {
+            $args['cat'] = $atts['cat'];
+        }
+
+        // Get the posts. Note that if a `type` is specified before, then the
+        // `tax_query` from the `add_criterias` call isn't added.
+        return get_posts( Wordlift_Entity_Service::add_criterias( $args ) );
+
+    }
+
+    /**
+     * Populate the alphabet with posts.
+     *
+     * @param array $alphabet An array of letters.
+     * @param int   $post_id The {@link WP_Post} id.
+     *
+     * @since 3.17.0
+     */
+    private function add_to_alphabet( &$alphabet, $post_id ) {
+
+        // Get the title without accents.
+        $title = $this->get_the_title( $post_id );
+
+        // Get the initial letter.
+        $letter = $this->get_first_letter_in_alphabet_or_hash( $alphabet, $title );
+
+        // Add the post.
+        $alphabet[ $letter ][ $post_id ] = $title;
+
+    }
+
+    /**
+     * Get the title without accents.
+     * If the post is not of type `entity`, use first synonym if synonyms exists.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/1096
+     *
+     * @since 3.27.0
+     *
+     * @param int $post_id The {@link WP_Post} id.
+     *
+     * @return string
+     */
+    private function get_the_title( $post_id ) {
+
+        $title = get_the_title( $post_id );
+
+        if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
+            $alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
+
+            if ( count( $alternative_labels ) > 0 ) {
+                $title = $alternative_labels[0];
+            }
+        }
+
+        return remove_accents( $title );
+
+    }
+
+    /**
+     * Find the first letter in the alphabet.
+     *
+     * In some alphabets a letter is a compound of letters, therefore this function
+     * will look for groups of 2 or 3 letters in the alphabet before looking for a
+     * single letter. In case the letter is not found a # (hash) key is returned.
+     *
+     * @param array  $alphabet An array of alphabet letters.
+     * @param string $title The title to match.
+     *
+     * @return string The initial letter or a `#` key.
+     * @since 3.17.0
+     */
+    private function get_first_letter_in_alphabet_or_hash( $alphabet, $title ) {
+
+        // Need to handle letters which consist of 3 and 2 characters.
+        for ( $i = 3; $i > 0; $i -- ) {
+            $letter = mb_convert_case( mb_substr( $title, 0, $i ), MB_CASE_UPPER );
+            if ( isset( $alphabet[ $letter ] ) ) {
+                return $letter;
+            }
+        }
+
+        return '#';
+    }
+
+    /**
+     * Get and increment the `$vocabulary_id`.
+     *
+     * @return int The incremented vocabulary id.
+     * @since  3.18.3
+     */
+    private static function get_and_increment_vocabulary_id() {
+        return self::$vocabulary_id ++;
+    }
 
 }

Spacing +66 added lines, -66 removed lines

@@ -51,7 +51,7 @@ 
 	public function __construct() {
 		parent::__construct();
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->register_block_type();
 
@@ -65,11 +65,11 @@ 
 	 */
 	private static function are_requirements_satisfied() {
 
-		return function_exists( 'mb_strlen' ) &&
-			   function_exists( 'mb_substr' ) &&
-			   function_exists( 'mb_strtolower' ) &&
-			   function_exists( 'mb_strtoupper' ) &&
-			   function_exists( 'mb_convert_case' );
+		return function_exists('mb_strlen') &&
+			   function_exists('mb_substr') &&
+			   function_exists('mb_strtolower') &&
+			   function_exists('mb_strtoupper') &&
+			   function_exists('mb_convert_case');
 	}
 
 	/**
@@ -80,17 +80,17 @@ 
 	 * @return string The output html code.
 	 * @since 3.16.0
 	 */
-	public function render( $atts ) {
+	public function render($atts) {
 
 		// Bail out if the requirements aren't satisfied: we need mbstring for
 		// the vocabulary widget to work.
-		if ( ! self::are_requirements_satisfied() ) {
-			$this->log->warn( "The vocabulary widget cannot be displayed because this WordPress installation doesn't satisfy its requirements." );
+		if ( ! self::are_requirements_satisfied()) {
+			$this->log->warn("The vocabulary widget cannot be displayed because this WordPress installation doesn't satisfy its requirements.");
 
 			return '';
 		}
 
-		wp_enqueue_style( 'wl-vocabulary-shortcode', dirname( plugin_dir_url( __FILE__ ) ) . '/public/css/wordlift-vocabulary-shortcode.css', array(), WORDLIFT_VERSION );
+		wp_enqueue_style('wl-vocabulary-shortcode', dirname(plugin_dir_url(__FILE__)).'/public/css/wordlift-vocabulary-shortcode.css', array(), WORDLIFT_VERSION);
 
 		// Extract attributes and set default values.
 		$atts = shortcode_atts(
@@ -111,15 +111,15 @@ 
 
 		// Get the posts. Note that if a `type` is specified before, then the
 		// `tax_query` from the `add_criterias` call isn't added.
-		$posts = $this->get_posts( $atts );
+		$posts = $this->get_posts($atts);
 
 		// Get the alphabet.
 		$language_code = Wordlift_Configuration_Service::get_instance()->get_language_code();
-		$alphabet      = Wordlift_Alphabet_Service::get( $language_code );
+		$alphabet      = Wordlift_Alphabet_Service::get($language_code);
 
 		// Add posts to the alphabet.
-		foreach ( $posts as $post ) {
-			$this->add_to_alphabet( $alphabet, $post->ID );
+		foreach ($posts as $post) {
+			$this->add_to_alphabet($alphabet, $post->ID);
 		}
 
 		$header   = '';
@@ -129,16 +129,16 @@ 
 		$vocabulary_id = self::get_and_increment_vocabulary_id();
 
 		// Generate the header.
-		foreach ( $alphabet as $item => $translations ) {
-			$template = ( empty( $translations )
+		foreach ($alphabet as $item => $translations) {
+			$template = (empty($translations)
 				? '<span class="wl-vocabulary-widget-disabled">%s</span>'
-				: '<a href="#wl-vocabulary-%3$d-%2$s">%1$s</a>' );
+				: '<a href="#wl-vocabulary-%3$d-%2$s">%1$s</a>');
 
-			$header .= sprintf( $template, esc_html( $item ), esc_attr( $item ), $vocabulary_id );
+			$header .= sprintf($template, esc_html($item), esc_attr($item), $vocabulary_id);
 		}
 
 		// Generate the sections.
-		foreach ( $alphabet as $item => $translations ) {
+		foreach ($alphabet as $item => $translations) {
 			// @since 3.19.3 we use `mb_strtolower` and `mb_strtoupper` with a custom function to handle sorting,
 			// since we had `AB` being placed before `Aa` with `asort`.
 			//
@@ -146,16 +146,16 @@ 
 			// asort( $translations );
 			uasort(
 				$translations,
-				function ( $a, $b ) {
-					if ( mb_strtolower( $a ) === mb_strtolower( $b )
-						 || mb_strtoupper( $a ) === mb_strtoupper( $b ) ) {
+				function($a, $b) {
+					if (mb_strtolower($a) === mb_strtolower($b)
+						 || mb_strtoupper($a) === mb_strtoupper($b)) {
 						return 0;
 					}
 
-					return ( mb_strtolower( $a ) < mb_strtolower( $b ) ) ? - 1 : 1;
+					return (mb_strtolower($a) < mb_strtolower($b)) ? -1 : 1;
 				}
 			);
-			$sections .= $this->get_section( $item, $translations, $vocabulary_id );
+			$sections .= $this->get_section($item, $translations, $vocabulary_id);
 		}
 
 		// Return HTML template.
@@ -167,8 +167,8 @@ 
 				echo wp_kses(
 					$header,
 					array(
-						'span' => array( 'class' => array() ),
-						'a'    => array( 'href' => array() ),
+						'span' => array('class' => array()),
+						'a'    => array('href' => array()),
 					)
 				);
 				?>
@@ -182,10 +182,10 @@ 
 							'class' => array(),
 							'id'    => array(),
 						),
-						'aside' => array( 'class' => array() ),
-						'ul'    => array( 'class' => array() ),
+						'aside' => array('class' => array()),
+						'ul'    => array('class' => array()),
 						'li'    => array(),
-						'a'     => array( 'href' => array() ),
+						'a'     => array('href' => array()),
 					)
 				);
 				?>
@@ -204,8 +204,8 @@ 
 
 		add_action(
 			'init',
-			function () use ( $scope ) {
-				if ( ! function_exists( 'register_block_type' ) ) {
+			function() use ($scope) {
+				if ( ! function_exists('register_block_type')) {
 					// Gutenberg is not active.
 					return;
 				}
@@ -214,13 +214,13 @@ 
 					'wordlift/vocabulary',
 					array(
 						'editor_script'   => 'wl-block-editor',
-						'render_callback' => function ( $attributes ) use ( $scope ) {
+						'render_callback' => function($attributes) use ($scope) {
 							$attr_code = '';
-							foreach ( $attributes as $key => $value ) {
-								$attr_code .= $key . '="' . htmlentities( $value ) . '" ';
+							foreach ($attributes as $key => $value) {
+								$attr_code .= $key.'="'.htmlentities($value).'" ';
 							}
 
-							return '[' . $scope::SHORTCODE . ' ' . $attr_code . ']';
+							return '['.$scope::SHORTCODE.' '.$attr_code.']';
 						},
 						'attributes'      => array(
 							'type'        => array(
@@ -249,7 +249,7 @@ 
 							),
 							'preview_src' => array(
 								'type'    => 'string',
-								'default' => WP_CONTENT_URL . '/plugins/wordlift/images/block-previews/vocabulary.png',
+								'default' => WP_CONTENT_URL.'/plugins/wordlift/images/block-previews/vocabulary.png',
 							),
 						),
 					)
@@ -270,10 +270,10 @@ 
 	 *                no posts).
 	 * @since 3.17.0
 	 */
-	private function get_section( $letter, $posts, $vocabulary_id ) {
+	private function get_section($letter, $posts, $vocabulary_id) {
 
 		// Return an empty string if there are no posts.
-		if ( 0 === count( $posts ) ) {
+		if (0 === count($posts)) {
 			return '';
 		}
 
@@ -289,9 +289,9 @@ 
 			</div>
 		',
 			$vocabulary_id,
-			esc_attr( $letter ),
-			esc_html( $letter ),
-			$this->format_posts_as_list( $posts )
+			esc_attr($letter),
+			esc_html($letter),
+			$this->format_posts_as_list($posts)
 		);
 	}
 
@@ -303,12 +303,12 @@ 
 	 * @return string A list.
 	 * @since 3.17.0
 	 */
-	private function format_posts_as_list( $posts ) {
+	private function format_posts_as_list($posts) {
 
 		return array_reduce(
-			array_keys( $posts ),
-			function ( $carry, $item ) use ( $posts ) {
-				return $carry . sprintf( '<li><a href="%s">%s</a></li>', esc_attr( get_permalink( $item ) ), esc_html( $posts[ $item ] ) );
+			array_keys($posts),
+			function($carry, $item) use ($posts) {
+				return $carry.sprintf('<li><a href="%s">%s</a></li>', esc_attr(get_permalink($item)), esc_html($posts[$item]));
 			},
 			''
 		);
@@ -322,21 +322,21 @@ 
 	 * @return array An array of {@link WP_Post}s.
 	 * @since 3.17.0
 	 */
-	private function get_posts( $atts ) {
+	private function get_posts($atts) {
 		// The default arguments for the query.
 		$args = array(
 			// phpcs:ignore WordPress.WP.PostsPerPage.posts_per_page_posts_per_page
-			'posts_per_page'         => intval( $atts['limit'] ),
+			'posts_per_page'         => intval($atts['limit']),
 			'update_post_meta_cache' => false,
 			'update_post_term_cache' => false,
 			'orderby'                => $atts['orderby'],
 			'order'                  => $atts['order'],
 			// Exclude the publisher.
-			'post__not_in'           => array( Wordlift_Configuration_Service::get_instance()->get_publisher_id() ),
+			'post__not_in'           => array(Wordlift_Configuration_Service::get_instance()->get_publisher_id()),
 		);
 
 		// Limit the based entity type if needed.
-		if ( 'all' !== $atts['type'] ) {
+		if ('all' !== $atts['type']) {
 			$args['tax_query'] = array(
 				array(
 					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
@@ -346,13 +346,13 @@ 
 			);
 		}
 
-		if ( ! empty( $atts['cat'] ) ) {
+		if ( ! empty($atts['cat'])) {
 			$args['cat'] = $atts['cat'];
 		}
 
 		// Get the posts. Note that if a `type` is specified before, then the
 		// `tax_query` from the `add_criterias` call isn't added.
-		return get_posts( Wordlift_Entity_Service::add_criterias( $args ) );
+		return get_posts(Wordlift_Entity_Service::add_criterias($args));
 
 	}
 
@@ -364,16 +364,16 @@ 
 	 *
 	 * @since 3.17.0
 	 */
-	private function add_to_alphabet( &$alphabet, $post_id ) {
+	private function add_to_alphabet(&$alphabet, $post_id) {
 
 		// Get the title without accents.
-		$title = $this->get_the_title( $post_id );
+		$title = $this->get_the_title($post_id);
 
 		// Get the initial letter.
-		$letter = $this->get_first_letter_in_alphabet_or_hash( $alphabet, $title );
+		$letter = $this->get_first_letter_in_alphabet_or_hash($alphabet, $title);
 
 		// Add the post.
-		$alphabet[ $letter ][ $post_id ] = $title;
+		$alphabet[$letter][$post_id] = $title;
 
 	}
 
@@ -389,19 +389,19 @@ 
 	 *
 	 * @return string
 	 */
-	private function get_the_title( $post_id ) {
+	private function get_the_title($post_id) {
 
-		$title = get_the_title( $post_id );
+		$title = get_the_title($post_id);
 
-		if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
-			$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
+		if (get_post_type($post_id) !== Wordlift_Entity_Service::TYPE_NAME) {
+			$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels($post_id);
 
-			if ( count( $alternative_labels ) > 0 ) {
+			if (count($alternative_labels) > 0) {
 				$title = $alternative_labels[0];
 			}
 		}
 
-		return remove_accents( $title );
+		return remove_accents($title);
 
 	}
 
@@ -418,12 +418,12 @@ 
 	 * @return string The initial letter or a `#` key.
 	 * @since 3.17.0
 	 */
-	private function get_first_letter_in_alphabet_or_hash( $alphabet, $title ) {
+	private function get_first_letter_in_alphabet_or_hash($alphabet, $title) {
 
 		// Need to handle letters which consist of 3 and 2 characters.
-		for ( $i = 3; $i > 0; $i -- ) {
-			$letter = mb_convert_case( mb_substr( $title, 0, $i ), MB_CASE_UPPER );
-			if ( isset( $alphabet[ $letter ] ) ) {
+		for ($i = 3; $i > 0; $i--) {
+			$letter = mb_convert_case(mb_substr($title, 0, $i), MB_CASE_UPPER);
+			if (isset($alphabet[$letter])) {
 				return $letter;
 			}
 		}
@@ -438,7 +438,7 @@ 
 	 * @since  3.18.3
 	 */
 	private static function get_and_increment_vocabulary_id() {
-		return self::$vocabulary_id ++;
+		return self::$vocabulary_id++;
 	}
 
 }