phpcs edits

lib/adapters/class-adapter.php

@@ -118,7 +118,7 @@ abstract class Adapter {
  *
  * TODO Add param DocBloc with full set of possible array keys.
  *
- * @param array $facets_config
+ * @param array $facets_config Array configuration for facets.
  * @return void
  */
  public function set_facets_config( array $facets_config ) {
@@ -138,6 +138,7 @@ public function set_facets_config( array $facets_config ) {
 
  /**
  * Get the configured facets.
+ *
  * @return array
  */
  public function get_facet_config(): array {
@@ -196,11 +197,11 @@ public function get_facet_data( array $options = [] ): array {
 
  $options = wp_parse_args(
  $options,
- array(
+ [
  'exclude_current' => true,
  'join_existing_terms' => true,
  'join_terms_logic' => [],
- )
+ ]
  );
 
  $facet_data = [];
@@ -211,7 +212,7 @@ public function get_facet_data( array $options = [] ): array {
  continue;
  }
 
- $facet_data[ $label ]  = $this->facets[ $label ];
+ $facet_data[ $label ] = $this->facets[ $label ];
  $facet_data[ $label ]->items = [];
 
  /*
@@ -240,7 +241,7 @@ public function get_facet_data( array $options = [] ): array {
  }
 
  foreach ( $items as $item ) {
- $datum = apply_filters( 'es_extensions_facet_datum', false, $item, $this->facets );
+ $datum = apply_filters( 'elasticsearch_extensions_facet_datum', false, $item, $this->facets );
  if ( false === $datum ) {
  $query_vars = [];
  $selected = false;
@@ -353,14 +354,14 @@ public function get_facet_data( array $options = [] ): array {
  }
  }
 
- return apply_filters( 'es_extensions_facet_data', $facet_data );
+ return apply_filters( 'elasticsearch_extensions_facet_data', $facet_data );
  }
 
  /**
  * Get Facet by field
  *
  * @param string $field Facet field. See get_facet_data for acceptable values.
- * @param string $value
+ * @param string $value Value corresponding to the field.
  * @return Facet|null
  */
  public function get_facet_data_by( string $field = '', string $value = '' ) {
@@ -516,7 +517,7 @@ public function map_meta_field( string $meta_key, string $type = '' ): string {
  * @param string $field Field to map.
  * @return string The mapped field.
  */
- public function map_tax_field( string $taxonomy, string $field ): string  {
+ public function map_tax_field( string $taxonomy, string $field ): string {
  if ( 'post_tag' === $taxonomy ) {
  $field = str_replace( 'term_', 'tag_', $field );
  } elseif ( 'category' === $taxonomy ) {
@@ -529,7 +530,7 @@ public function map_tax_field( string $taxonomy, string $field ): string {
  * Pull the facets out of the ES response.
  */
  public function parse_facets() {
- $this->facets = apply_filters( 'es_extensions_parse_facets', [] );
+ $this->facets = apply_filters( 'elasticsearch_extensions_parse_facets', [] );
  if ( empty( $this->facets ) ) {
  if ( ! empty( $this->results['aggregations'] ) ) {
  foreach ( $this->results['aggregations'] as $label => $buckets ) {

lib/adapters/class-vip-enterprise-search.php

@@ -38,16 +38,16 @@ public function filter_ep_query_request_args( $request_args, $path, $index, $typ
  // Add our aggregations.
  if ( $this->get_aggregate_post_types() ) {
  $post_type_facet = new Post_Type();
- $dsl['aggs'] = array_merge( $dsl['aggs'], $post_type_facet->request() );
+ $dsl['aggs']  = array_merge( $dsl['aggs'], $post_type_facet->request() );
  }
 
  if ( $this->get_aggregate_categories() ) {
  $category_facet = new Category();
- $dsl['aggs'] = array_merge( $dsl['aggs'], $category_facet->request() );
+ $dsl['aggs']  = array_merge( $dsl['aggs'], $category_facet->request() );
  }
 
  if ( $this->get_aggregate_tags() ) {
- $tag_facet = new Tag();
+ $tag_facet  = new Tag();
  $dsl['aggs'] = array_merge( $dsl['aggs'], $tag_facet->request() );
  }
 
@@ -56,7 +56,7 @@ public function filter_ep_query_request_args( $request_args, $path, $index, $typ
  foreach ( $agg_taxonomies as $agg_taxonomy ) {
  $dsl['aggs'][ "taxonomy_{$agg_taxonomy}" ] = [
  'terms' => [
- 'size' => 1000,
+ 'size'  => 1000,
  'field' => "terms.{$agg_taxonomy}.slug",
  ],
  ];
@@ -103,7 +103,7 @@ public function set_field_map(): void {
  $this->field_map['post_title.analyzed'] = 'post_title';
  $this->field_map['post_type'] = 'post_type.raw';
  $this->field_map['post_excerpt'] = 'post_excerpt';
- $this->field_map['post_password'] = 'post_password'; // This isn't indexed on VIP;
+ $this->field_map['post_password'] = 'post_password'; // This isn't indexed on VIP.
  $this->field_map['post_name'] = 'post_name.raw';
  $this->field_map['post_modified'] = 'post_modified';
  $this->field_map['post_modified.year'] = 'modified_date_terms.year';
@@ -155,15 +155,8 @@ public function setup(): void {
  // Filter request args.
  add_filter( 'ep_query_request_args', [ $this, 'filter_ep_query_request_args' ], 10, 4 );
 
- // Set aggregations.
- add_action( 'ep_valid_response', function ( $response, $query, $query_args ) {
- if ( ! empty( $response['aggregations'] ) ) {
- $this->set_aggregations( $response['aggregations'] );
- }
- }, 10, 3 );
-
- // Set Results.
- add_action( 'ep_valid_response', [ $this, 'set_results' ], 10, 3 );
+ // Set Results and aggregations.
+ add_action( 'ep_valid_response', [ $this, 'set_results' ], 10, 1 );
 
  // Parse face data.
  add_action( 'ep_valid_response', [ $this, 'parse_facets' ], 11, 0 );
@@ -172,14 +165,17 @@ public function setup(): void {
  /**
  * Set results from last query.
  *
- * @param $response
- * @param $query
- * @param $query_args
+ * @param array $response Response from ES.
  * @return void
  */
- public function set_results( $response, $query, $query_args ) {
- // TODO ensure this is a search? Does EP restrict this to queries with post data?
- if ( apply_filters( 'es_extensions_should_set_results', true ) ) {
+ public function set_results( $response ) {
+ // Set aggregations if applicable.
+ if ( ! empty( $response['aggregations'] ) ) {
+ $this->set_aggregations( $response['aggregations'] );
+ }
+
+ // TODO ensure this is a search and this isn't too broad.
+ if ( apply_filters( 'elasticsearch_extensions_should_set_results', true ) ) {
  $this->results = $response;
  }
  }

lib/class-controller.php

@@ -80,18 +80,20 @@ public function get_facet_data(): array {
  /**
  * Get facet data by from adapter.
  *
+ * @param string $name Name of the facet.
  * @return Facet|null
  */
- public function get_facet_data_by_name( $name = '' ) {
+ public function get_facet_data_by_name( string $name = '' ) {
  return $this->adapter->get_facet_data_by( 'name', $name );
  }
 
  /**
  * Get facet data by from adapter.
  *
+ * @param string $query_var Query variable sting.
  * @return Facet|null
  */
- public function get_facet_data_by_query_var( $query_var = '' ) {
+ public function get_facet_data_by_query_var( string $query_var = '' ) {
  return $this->adapter->get_facet_data_by( 'query_var', $query_var );
  }
 
@@ -144,7 +146,7 @@ public function map_meta_field( string $meta_key, string $type = '' ): string {
  * @param string $field Field to map.
  * @return string The mapped field.
  */
- public function map_tax_field( string $taxonomy, string $field ): string  {
+ public function map_tax_field( string $taxonomy, string $field ): string {
  return $this->adapter->map_tax_field( $taxonomy, $field );
  }
 
@@ -153,6 +155,9 @@ public function map_tax_field( string $taxonomy, string $field ): string {
  * Necessary to set up faceting.
  *
  * TODO Build out the array options in the DocBloc.
+ *
+ * @param array $facets_config Config array.
+ * @return void
  */
  public function set_facets_config( $facets_config ) {
  $this->adapter->set_facets_config( $facets_config );

lib/class-dsl.php

@@ -28,7 +28,7 @@ class DSL {
  * @return array DSL fragment.
  */
  public static function all_terms( string $taxonomy, string $field, array $values ): array {
- $field = self::$controller->map_tax_field( $taxonomy, $field );
+ $field  = self::$controller->map_tax_field( $taxonomy, $field );
  $queries = [];
  foreach ( $values as $value ) {
  $queries[] = [
@@ -152,7 +152,7 @@ public static function search_query( string $s ): array {
  * @var array
  */
  $fields = apply_filters(
- 'es_extensions_searchable_fields',
+ 'elasticsearch_extensions_searchable_fields',
  [
  self::$controller->map_field( 'post_title.analyzed' ) . '^3',
  self::$controller->map_field( 'post_excerpt' ),
@@ -175,7 +175,7 @@ public static function search_query( string $s ): array {
  /**
  * Setter for the controller.
  *
- * @param Controller $controller
+ * @param Controller $controller ES Controller class.
  * @return void
  */
  public static function set_es_controller( Controller $controller ) {
@@ -192,7 +192,7 @@ public static function set_es_controller( Controller $controller ) {
  */
  public static function terms( $field, $values, $args = [] ) {
  $field = self::$controller->map_field( $field );
- $type = is_array( $values ) ? 'terms' : 'term';
+ $type  = is_array( $values ) ? 'terms' : 'term';
 
  return [
  $type => array_merge(

lib/class-facet.php

@@ -78,10 +78,10 @@ public function __construct( string $label, array $buckets ) {
  */
  protected function parse_type() {
  if ( 'taxonomy_' === substr( $this->label, 0, 9 ) ) {
- $this->type  = 'taxonomy';
- $this->subtype  = $this->query_var = substr( $this->label, 9 );
+ $this->type = 'taxonomy';
+ $this->subtype = $this->query_var = substr( $this->label, 9 ); // phpcs:ignore Squiz.PHP.DisallowMultipleAssignments.Found
  } else {
- $this->type = $this->query_var = $this->label;
+ $this->type = $this->query_var = $this->label; // phpcs:ignore Squiz.PHP.DisallowMultipleAssignments.Found
  }
  }
 
@@ -127,7 +127,7 @@ public function title(): string {
  * @param string $type Facet type.
  * @param string $subtype Facet Subtype.
  */
- $this->title = apply_filters( 'es_extensions_facet_title', '', $this->label, $this->type, $this->subtype );
+ $this->title = apply_filters( 'elasticsearch_extensions_facet_title', '', $this->label, $this->type, $this->subtype );
  if ( null === $this->title ) {
  switch ( $this->type ) {
  case 'taxonomy':
@@ -140,15 +140,15 @@ public function title(): string {
  break;
 
  case 'post_type':
- $this->title = __( 'Content Type', 'es-extensions' );
+ $this->title = __( 'Content Type', 'elasticsearch-extensions' );
  break;
 
  case 'post_date':
- $this->title = __( 'Date', 'es-extensions' );
+ $this->title = __( 'Date', 'elasticsearch-extensions' );
  break;
 
  case 'post_author':
- $this->title = __( 'Author', 'es-extensions' );
+ $this->title = __( 'Author', 'elasticsearch-extensions' );
  break;
 
  default:
@@ -176,7 +176,7 @@ public function get_label_for_bucket( array $bucket ): string {
  * @param string $type Facet type.
  * @param string $subtype Facet Subtype.
  */
- $label = apply_filters( 'es_extensions_facet_bucket_label', null, $bucket, $this->label, $this->type, $this->subtype );
+ $label = apply_filters( 'elasticsearch_extensions_facet_bucket_label', null, $bucket, $this->label, $this->type, $this->subtype );
  if ( null !== $label ) {
  return $label;
  }

lib/facets/class-post-date.php

@@ -53,10 +53,13 @@ public function filter( array $values ): array {
  foreach ( $values as $date ) {
  $gte = date( 'Y-m-d H:i:s', $date ); // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
  $lt = date( 'Y-m-d H:i:s', strtotime( date( 'Y-m-d', $date ) . ' + 1 month' ) ); // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
- $should[] = DSL::range( 'post_date', [
- 'gte' => $gte,
- 'lt' => $lt,
- ] );
+ $should[] = DSL::range(
+ 'post_date',
+ [
+ 'gte' => $gte,
+ 'lt' => $lt,
+ ]
+ );
  }
 
  return [ 'bool' => [ 'should' => $should ] ];