BaseQueryTrait::getAndFacetFields() - Code Metrics - Inspection of "Split the AND and OR. Needs clarification on which..." - Firesphere/silverstripe-solr-search - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — hans/or-we-start-or-facets ( e1f517...266943 )

by Simon

created 2020-04-02 12:09 UTC

BaseQueryTrait::getAndFacetFields() A

↳ Parent: BaseQueryTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	0
cp	0
crap	2
rs	10

<?php
/**
 * Trait BaseQueryTrait|Firesphere\SolrSearch\Traits\BaseQueryTrait Trait to clean up the
 * {@link \Firesphere\SolrSearch\Queries\BaseQuery}
 *
 * @package Firesphere\SolrSearch\Traits
 * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
 * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
 */

namespace Firesphere\SolrSearch\Traits;

use Minimalcode\Search\Criteria;

/**
 * Trait BaseQueryTrait Extraction from the BaseQuery class to keep things readable.
 *
 * This trait adds the support for adding the basic field/filter/term/facet options
 *
 * @package Firesphere\SolrSearch\Traits
 */
trait BaseQueryTrait
{
    /**
     * @var array Terms to search
     */
    protected $terms = [];

    /**
     * @var array Fields to filter
     */
    protected $filter = [];

    /**
     * @var array Fields to search
     */
    protected $fields = [];

    /**
     * Key => value pairs of facets to apply in AND fashion
     * [
     *     'FacetTitle' => [1, 2, 3],
     *     'FacetTitle2' => [1, 2, 3]
     * ]
     *
     * @var array
     */
    protected $andFacetFilter = [];

    /**
     * Key => value pairs of facets to apply in OR fashion
     * [
     *     'FacetTitle' => [1, 2, 3],
     *     'FacetTitle2' => [1, 2, 3]
     * ]
     *
     * @var array
     */
    protected $orFacetFilter = [];

    /**
     * @var array Fields to exclude
     */
    protected $exclude = [];

    /**
     * @var array Sorting order
     */
    protected $sort = [];

    /**
     * Each boosted query needs a separate addition!
     * e.g. $this->addTerm('test', ['MyField', 'MyOtherField'], 3)
     * followed by
     * $this->addTerm('otherTest', ['Title'], 5);
     *
     * If you want a generic boost on all terms, use addTerm only once, but boost on each field
     *
     * The fields parameter is used to boost on
     *
     * For generic boosting, use @addBoostedField($field, $boost), this will add the boost at Index time
     *
     * @param string $term Term to search for
     * @param array $fields fields to boost on
     * @param int $boost Boost value
     * @param bool|float $fuzzy True or a value to the maximum amount of iterations
     * @return $this
     */
    public function addTerm(string $term, array $fields = [], int $boost = 0, $fuzzy = null): self
    {
        $this->terms[] = [
            'text'   => $term,
            'fields' => $fields,
            'boost'  => $boost,
            'fuzzy'  => $fuzzy,
        ];

        return $this;
    }

    /**
     * Adds filters to filter on by value
     *
     * @param string $field Field to filter on
     * @param string|array|Criteria $value Value for this field
     * @return $this
     */
    public function addFilter($field, $value): self
    {
        $field = str_replace('.', '_', $field);
        $this->filter[$field] = $value;

        return $this;
    }

    /**
     * Add a field to be returned
     *
     * @param string $field fieldname
     * @return $this
     */
    public function addField($field): self
    {
        $field = str_replace('.', '_', $field);
        $this->fields[] = $field;

        return $this;
    }

    /**
     * Exclude fields from the search action
     *
     * @param string $field
     * @param string|array|Criteria $value
     * @return $this
     */
    public function addExclude($field, $value): self
    {
        $field = str_replace('.', '_', $field);
        $this->exclude[$field] = $value;

        return $this;
    }

    /**
     * Add faceting fields that need to be faceted in an AND format
     *
     * @param string $field Field to facet
     * @param string|array $value Value to facet
     * @return $this
     */
    public function addFacetFilter($field, $value): self
    {
        $this->andFacetFilter[$field][] = $value;

        return $this;
    }

    /**
     * Stub for addFacetFilter to add an AND filter
     *
     * @param string $field
     * @param string|array $value
     * @return $this
     */
    public function addAndFacetFilter($field, $value): self
    {
        return $this->addFacetFilter($field, $value);
    }

    /**
     * Add faceting that need to be faceted in an OR formats
     *
     * @param string $field Field to facet
     * @param string|array $value Value to facet
     * @return $this
     */
    public function addOrFacetFilter($field, $value): self
    {
        $this->orFacetFilter[$field][] = $value;

        return $this;
    }

    /**
     * Add a field to sort on
     *
     * @param string $field
     * @param string $direction
     * @return $this
     */
    public function addSort($field, $direction): self
    {
        $this->sort[$field] = $direction;

        return $this;
    }

    /**
     * Stub for transitioning from standard Facets to AND/OR differentiated facets
     *
     * @return array
     */
    public function getAndFacetFields(): array
    {
        return $this->getFacetFields();
        return $this->/** @scrutinizer ignore-call */ getFacetFields();
    }

    /**
     * Stub for transitioning from standard Facets to AND/OR differentiated facets
     *
     * @param array $facetFields
     * @return $this
     */
    public function setAndFacetFields($facetFields): self
    {
        return $this->setFacetFields($facetFields);
        return $this->/** @scrutinizer ignore-call */ setFacetFields($facetFields);
    }

    /**
     * Get the OR separated facets
     *
     * @return array
     */
    public function getOrFacetFields(): array
    {
        return $this->orFacetFields;
    }

    /**
     * Add a set of OR facets
     *
     * @param array $orFacetFields
     * @return BaseQueryTrait
     */
    public function setOrFacetFields(array $orFacetFields): self
    {
        $this->orFacetFields = $orFacetFields;


        return $this;
    }
}


Firesphere / silverstripe-solr-search

Push — hans/or-we-start-or-facets ( e1f517...266943 )

BaseQueryTrait::getAndFacetFields() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like