BaseQueryTrait::addFilter() - Code Metrics - Inspection of "Initial OR facet work" - Firesphere/silverstripe-solr-search - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#216)

by Simon

created 2020-04-03 03:49 UTC

BaseQueryTrait::addFilter() A

↳ Parent: BaseQueryTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	6
ccs	3
cts	3
cp	1
crap	1
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;
    }
}


1		<?php
2		/**
3		* Trait BaseQueryTrait\|Firesphere\SolrSearch\Traits\BaseQueryTrait Trait to clean up the
4		* {@link \Firesphere\SolrSearch\Queries\BaseQuery}
5		*
6		* @package Firesphere\SolrSearch\Traits
7		* @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
8		* @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
9		*/
10
11		namespace Firesphere\SolrSearch\Traits;
12
13		use Minimalcode\Search\Criteria;
14
15		/**
16		* Trait BaseQueryTrait Extraction from the BaseQuery class to keep things readable.
17		*
18		* This trait adds the support for adding the basic field/filter/term/facet options
19		*
20		* @package Firesphere\SolrSearch\Traits
21		*/
22		trait BaseQueryTrait
23		{
24		/**
25		* @var array Terms to search
26		*/
27		protected $terms = [];
28
29		/**
30		* @var array Fields to filter
31		*/
32		protected $filter = [];
33
34		/**
35		* @var array Fields to search
36		*/
37		protected $fields = [];
38
39		/**
40		* Key => value pairs of facets to apply in AND fashion
41		* [
42		* 'FacetTitle' => [1, 2, 3],
43		* 'FacetTitle2' => [1, 2, 3]
44		* ]
45		*
46		* @var array
47		*/
48		protected $andFacetFilter = [];
49
50		/**
51		* Key => value pairs of facets to apply in OR fashion
52		* [
53		* 'FacetTitle' => [1, 2, 3],
54		* 'FacetTitle2' => [1, 2, 3]
55		* ]
56		*
57		* @var array
58		*/
59		protected $orFacetFilter = [];
60
61		/**
62		* @var array Fields to exclude
63		*/
64		protected $exclude = [];
65
66		/**
67		* @var array Sorting order
68		*/
69		protected $sort = [];
70
71		/**
72		* Each boosted query needs a separate addition!
73		* e.g. $this->addTerm('test', ['MyField', 'MyOtherField'], 3)
74		* followed by
75		* $this->addTerm('otherTest', ['Title'], 5);
76		*
77	7	* If you want a generic boost on all terms, use addTerm only once, but boost on each field
78		*
79	7	* The fields parameter is used to boost on
80	7	*
81	7	* For generic boosting, use @addBoostedField($field, $boost), this will add the boost at Index time
82	7	*
83	7	* @param string $term Term to search for
84		* @param array $fields fields to boost on
85		* @param int $boost Boost value
86	7	* @param bool\|float $fuzzy True or a value to the maximum amount of iterations
87		* @return $this
88		*/
89		public function addTerm(string $term, array $fields = [], int $boost = 0, $fuzzy = null): self
90		{
91		$this->terms[] = [
92		'text' => $term,
93		'fields' => $fields,
94		'boost' => $boost,
95		'fuzzy' => $fuzzy,
96	4	];
97
98	4	return $this;
99	4	}
100
101	4	/**
102		* Adds filters to filter on by value
103		*
104		* @param string $field Field to filter on
105		* @param string\|array\|Criteria $value Value for this field
106		* @return $this
107		*/
108		public function addFilter($field, $value): self
109		{
110	2	$field = str_replace('.', '_', $field);
111		$this->filter[$field] = $value;
112	2
113	2	return $this;
114		}
115	2
116		/**
117		* Add a field to be returned
118		*
119		* @param string $field fieldname
120		* @return $this
121		*/
122		public function addField($field): self
123		{
124		$field = str_replace('.', '_', $field);
125	4	$this->fields[] = $field;
126
127	4	return $this;
128	4	}
129
130	4	/**
131		* Exclude fields from the search action
132		*
133		* @param string $field
134		* @param string\|array\|Criteria $value
135		* @return $this
136		*/
137		public function addExclude($field, $value): self
138		{
139		$field = str_replace('.', '_', $field);
140	2	$this->exclude[$field] = $value;
141
142	2	return $this;
143		}
144	2
145		/**
146		* Add faceting fields that need to be faceted in an AND format
147		*
148		* @param string $field Field to facet
149		* @param string\|array $value Value to facet
150		* @return $this
151		*/
152		public function addFacetFilter($field, $value): self
153		{
154	1	$this->andFacetFilter[$field][] = $value;
155
156	1	return $this;
157		}
158	1
159		/**
160		* Stub for addFacetFilter to add an AND filter
161		*
162		* @param string $field
163		* @param string\|array $value
164		* @return $this
165		*/
166		public function addAndFacetFilter($field, $value): self
167		{
168		return $this->addFacetFilter($field, $value);
169		}
170
171		/**
172		* Add faceting that need to be faceted in an OR formats
173		*
174		* @param string $field Field to facet
175		* @param string\|array $value Value to facet
176		* @return $this
177		*/
178		public function addOrFacetFilter($field, $value): self
179		{
180		$this->orFacetFilter[$field][] = $value;
181
182		return $this;
183		}
184
185		/**
186		* Add a field to sort on
187		*
188		* @param string $field
189		* @param string $direction
190		* @return $this
191		*/
192		public function addSort($field, $direction): self
193		{
194		$this->sort[$field] = $direction;
195
196		return $this;
197		}
198		}
199

Firesphere / silverstripe-solr-search

Pull Request — master (#216)

BaseQueryTrait::addFilter() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like