BaseQuery::getExcludedSubClasses() - Code Metrics - Inspection of "Initial subclass exclusion work" - Firesphere/silverstripe-solr-search - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#188)

by Simon

created 2019-12-30 23:08 UTC

BaseQuery::getExcludedSubClasses() A

↳ Parent: BaseQuery

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

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

<?php
/**
 * class BaseQuery|Firesphere\SolrSearch\Queries\BaseQuery Base of a Solr Query
 *
 * @package Firesphere\SolrSearch\Queries
 * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
 * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
 */

namespace Firesphere\SolrSearch\Queries;

use Firesphere\SolrSearch\Traits\BaseQueryTrait;
use Firesphere\SolrSearch\Traits\GetterSetterTrait;
use SilverStripe\Core\Injector\Injectable;

/**
 * Class BaseQuery is the base of every query executed.
 *
 * Build a query to execute agains Solr. Uses as simle as possible an interface.
 *
 * @package Firesphere\SolrSearch\Queries
 */
class BaseQuery
{
    use GetterSetterTrait;
    use BaseQueryTrait;
    use Injectable;
    /**
     * Pagination start
     *
     * @var int
     */
    protected $start = 0;
    /**
     * Total rows to display
     *
     * @var int
     */
    protected $rows = 10;
    /**
     * Always get the ID. If you don't, you need to implement your own solution
     *
     * @var array
     */
    protected $fields = [];
    /**
     * Sorting
     *
     * @var array
     */
    protected $sort = [];
    /**
     * Enable spellchecking?
     *
     * @var bool
     */
    protected $spellcheck = true;
    /**
     * Follow spellchecking if there are no results
     *
     * @var bool
     */
    protected $followSpellcheck = false;
    /**
     * Minimum results a facet query has to have
     *
     * @var int
     */
    protected $facetsMinCount = 0;
    /**
     * Search terms
     *
     * @var array
     */
    protected $terms = [];
    /**
     * Highlighted items
     *
     * @var array
     */
    protected $highlight = [];
    /**
     * @var array Classes to exclude through hierarchy
     */
    protected $excludedSubClasses = [];

    /**
     * Get the offset to start
     *
     * @return int
     */
    public function getStart(): int
    {
        return $this->start;
    }

    /**
     * Set the offset to start
     *
     * @param int $start
     * @return $this
     */
    public function setStart($start): self
    {
        $this->start = $start;

        return $this;
    }

    /**
     * Get the rows to return
     *
     * @return int
     */
    public function getRows(): int
    {
        return $this->rows;
    }

    /**
     * Set the rows to return
     *
     * @param int $rows
     * @return $this
     */
    public function setRows($rows): self
    {
        $this->rows = $rows;

        return $this;
    }

    /**
     * Get the fields to return
     *
     * @return array
     */
    public function getFields(): array
    {
        return $this->fields;
    }

    /**
     * Set fields to be returned
     *
     * @param array $fields
     * @return $this
     */
    public function setFields($fields): self
    {
        $this->fields = $fields;

        return $this;
    }

    /**
     * Get the sort fields
     *
     * @return array
     */
    public function getSort(): array
    {
        return $this->sort;
    }

    /**
     * Set the sort fields
     *
     * @param array $sort
     * @return $this
     */
    public function setSort($sort): self
    {
        $this->sort = $sort;

        return $this;
    }

    /**
     * Get the facet count minimum to use
     *
     * @return int
     */
    public function getFacetsMinCount(): int
    {
        return $this->facetsMinCount;
    }

    /**
     * Set the minimum count of facets to be returned
     *
     * @param mixed $facetsMinCount
     * @return $this
     */
    public function setFacetsMinCount($facetsMinCount): self
    {
        $this->facetsMinCount = $facetsMinCount;

        return $this;
    }

    /**
     * Get the search terms
     *
     * @return array
     */
    public function getTerms(): array
    {
        return $this->terms;
    }

    /**
     * Set the search tearms
     *
     * @param array $terms
     * @return $this
     */
    public function setTerms($terms): self
    {
        $this->terms = $terms;

        return $this;
    }

    /**
     * Get the filters
     *
     * @return array
     */
    public function getFilter(): array
    {
        return $this->filter;
    }

    /**
     * Set the query filters
     *
     * @param array $filter
     * @return $this
     */
    public function setFilter($filter): self
    {
        $this->filter = $filter;

        return $this;
    }

    /**
     * Get the excludes
     *
     * @return array
     */
    public function getExclude(): array
    {
        return $this->exclude;
    }

    /**
     * Set the query excludes
     *
     * @param array $exclude
     * @return $this
     */
    public function setExclude($exclude): self
    {
        $this->exclude = $exclude;

        return $this;
    }

    /**
     * Add a highlight parameter
     *
     * @param $field
     * @return $this
     */
    public function addHighlight($field): self
    {
        $this->highlight[] = $field;

        return $this;
    }

    /**
     * Get the highlight parameters
     *
     * @return array
     */
    public function getHighlight(): array
    {
        return $this->highlight;
    }

    /**
     * Set the highlight parameters
     *
     * @param array $highlight
     * @return $this
     */
    public function setHighlight($highlight): self
    {
        $this->highlight = $highlight;

        return $this;
    }

    /**
     * Do we have spellchecking
     *
     * @return bool
     */
    public function hasSpellcheck(): bool
    {
        return $this->spellcheck;
    }

    /**
     * Set the spellchecking on this query
     *
     * @param bool $spellcheck
     * @return self
     */
    public function setSpellcheck(bool $spellcheck): self
    {
        $this->spellcheck = $spellcheck;

        return $this;
    }

    /**
     * Set if we should follow spellchecking
     *
     * @param bool $followSpellcheck
     * @return BaseQuery
     */
    public function setFollowSpellcheck(bool $followSpellcheck): BaseQuery
    {
        $this->followSpellcheck = $followSpellcheck;

        return $this;
    }

    /**
     * Should spellcheck suggestions be followed
     *
     * @return bool
     */
    public function shouldFollowSpellcheck(): bool
    {
        return $this->followSpellcheck;
    }

    /**
     * Get the facet filtering
     *
     * @return array
     */
    public function getFacetFilter(): array
    {
        return $this->facetFilter;
    }

    /**
     * Set the facet filtering
     *
     * @param array $facetFilter
     * @return BaseQuery
     */
    public function setFacetFilter(array $facetFilter): self
    {
        $this->facetFilter = $facetFilter;

        return $this;
    }

    /**
     * @return array
     */
    public function getExcludedSubClasses(): array
    {
        return $this->excludedSubClasses;
    }

    /**
     * @param array $excludedSubClasses
     * @return BaseQuery
     */
    public function setExcludedSubClasses(array $excludedSubClasses): self
    {
        $this->excludedSubClasses = $excludedSubClasses;

        return $this;
    }
}


1		<?php
2		/**
3		* class BaseQuery\|Firesphere\SolrSearch\Queries\BaseQuery Base of a Solr Query
4		*
5		* @package Firesphere\SolrSearch\Queries
6		* @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
7		* @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
8		*/
9
10		namespace Firesphere\SolrSearch\Queries;
11
12		use Firesphere\SolrSearch\Traits\BaseQueryTrait;
13		use Firesphere\SolrSearch\Traits\GetterSetterTrait;
14		use SilverStripe\Core\Injector\Injectable;
15
16		/**
17		* Class BaseQuery is the base of every query executed.
18		*
19		* Build a query to execute agains Solr. Uses as simle as possible an interface.
20		*
21		* @package Firesphere\SolrSearch\Queries
22		*/
23		class BaseQuery
24		{
25		use GetterSetterTrait;
26		use BaseQueryTrait;
27		use Injectable;
28		/**
29		* Pagination start
30		*
31		* @var int
32		*/
33		protected $start = 0;
34		/**
35		* Total rows to display
36		*
37		* @var int
38		*/
39		protected $rows = 10;
40		/**
41		* Always get the ID. If you don't, you need to implement your own solution
42		*
43		* @var array
44		*/
45		protected $fields = [];
46		/**
47		* Sorting
48		*
49		* @var array
50		*/
51		protected $sort = [];
52		/**
53		* Enable spellchecking?
54		*
55		* @var bool
56		*/
57		protected $spellcheck = true;
58		/**
59		* Follow spellchecking if there are no results
60		*
61		* @var bool
62		*/
63		protected $followSpellcheck = false;
64		/**
65		* Minimum results a facet query has to have
66		*
67		* @var int
68		*/
69		protected $facetsMinCount = 0;
70		/**
71		* Search terms
72		*
73		* @var array
74		*/
75		protected $terms = [];
76		/**
77		* Highlighted items
78		*
79		* @var array
80		*/
81		protected $highlight = [];
82		/**
83		* @var array Classes to exclude through hierarchy
84		*/
85		protected $excludedSubClasses = [];
86
87		/**
88	8	* Get the offset to start
89		*
90	8	* @return int
91		*/
92		public function getStart(): int
93		{
94		return $this->start;
95		}
96
97		/**
98		* Set the offset to start
99	1	*
100		* @param int $start
101	1	* @return $this
102		*/
103	1	public function setStart($start): self
104		{
105		$this->start = $start;
106
107		return $this;
108		}
109
110		/**
111	8	* Get the rows to return
112		*
113	8	* @return int
114		*/
115		public function getRows(): int
116		{
117		return $this->rows;
118		}
119
120		/**
121		* Set the rows to return
122	1	*
123		* @param int $rows
124	1	* @return $this
125		*/
126	1	public function setRows($rows): self
127		{
128		$this->rows = $rows;
129
130		return $this;
131		}
132
133		/**
134	8	* Get the fields to return
135		*
136	8	* @return array
137		*/
138		public function getFields(): array
139		{
140		return $this->fields;
141		}
142
143		/**
144		* Set fields to be returned
145	1	*
146		* @param array $fields
147	1	* @return $this
148		*/
149	1	public function setFields($fields): self
150		{
151		$this->fields = $fields;
152
153		return $this;
154		}
155
156		/**
157	1	* Get the sort fields
158		*
159	1	* @return array
160		*/
161		public function getSort(): array
162		{
163		return $this->sort;
164		}
165
166		/**
167		* Set the sort fields
168	1	*
169		* @param array $sort
170	1	* @return $this
171		*/
172	1	public function setSort($sort): self
173		{
174		$this->sort = $sort;
175
176		return $this;
177		}
178
179		/**
180	8	* Get the facet count minimum to use
181		*
182	8	* @return int
183		*/
184		public function getFacetsMinCount(): int
185		{
186		return $this->facetsMinCount;
187		}
188
189		/**
190		* Set the minimum count of facets to be returned
191	1	*
192		* @param mixed $facetsMinCount
193	1	* @return $this
194		*/
195	1	public function setFacetsMinCount($facetsMinCount): self
196		{
197		$this->facetsMinCount = $facetsMinCount;
198
199		return $this;
200		}
201
202		/**
203	8	* Get the search terms
204		*
205	8	* @return array
206		*/
207		public function getTerms(): array
208		{
209		return $this->terms;
210		}
211
212		/**
213		* Set the search tearms
214	3	*
215		* @param array $terms
216	3	* @return $this
217		*/
218	3	public function setTerms($terms): self
219		{
220		$this->terms = $terms;
221
222		return $this;
223		}
224
225		/**
226	8	* Get the filters
227		*
228	8	* @return array
229		*/
230		public function getFilter(): array
231		{
232		return $this->filter;
233		}
234
235		/**
236		* Set the query filters
237	1	*
238		* @param array $filter
239	1	* @return $this
240		*/
241	1	public function setFilter($filter): self
242		{
243		$this->filter = $filter;
244
245		return $this;
246		}
247
248		/**
249	8	* Get the excludes
250		*
251	8	* @return array
252		*/
253		public function getExclude(): array
254		{
255		return $this->exclude;
256		}
257
258		/**
259		* Set the query excludes
260	1	*
261		* @param array $exclude
262	1	* @return $this
263		*/
264	1	public function setExclude($exclude): self
265		{
266		$this->exclude = $exclude;
267
268		return $this;
269		}
270
271		/**
272		* Add a highlight parameter
273	1	*
274		* @param $field
275	1	* @return $this
276		*/
277	1	public function addHighlight($field): self
278		{
279		$this->highlight[] = $field;
280
281		return $this;
282		}
283
284		/**
285	8	* Get the highlight parameters
286		*
287	8	* @return array
288		*/
289		public function getHighlight(): array
290		{
291		return $this->highlight;
292		}
293
294		/**
295		* Set the highlight parameters
296	2	*
297		* @param array $highlight
298	2	* @return $this
299		*/
300	2	public function setHighlight($highlight): self
301		{
302		$this->highlight = $highlight;
303
304		return $this;
305		}
306
307		/**
308	7	* Do we have spellchecking
309		*
310	7	* @return bool
311		*/
312		public function hasSpellcheck(): bool
313		{
314		return $this->spellcheck;
315		}
316
317		/**
318		* Set the spellchecking on this query
319	3	*
320		* @param bool $spellcheck
321	3	* @return self
322		*/
323	3	public function setSpellcheck(bool $spellcheck): self
324		{
325		$this->spellcheck = $spellcheck;
326
327		return $this;
328		}
329
330		/**
331		* Set if we should follow spellchecking
332	2	*
333		* @param bool $followSpellcheck
334	2	* @return BaseQuery
335		*/
336	2	public function setFollowSpellcheck(bool $followSpellcheck): BaseQuery
337		{
338		$this->followSpellcheck = $followSpellcheck;
339
340		return $this;
341		}
342
343		/**
344	7	* Should spellcheck suggestions be followed
345		*
346	7	* @return bool
347		*/
348		public function shouldFollowSpellcheck(): bool
349		{
350		return $this->followSpellcheck;
351		}
352
353		/**
354	8	* Get the facet filtering
355		*
356	8	* @return array
357		*/
358		public function getFacetFilter(): array
359		{
360		return $this->facetFilter;
361		}
362
363		/**
364		* Set the facet filtering
365	1	*
366		* @param array $facetFilter
367	1	* @return BaseQuery
368		*/
369	1	public function setFacetFilter(array $facetFilter): self
370		{
371		$this->facetFilter = $facetFilter;
372
373		return $this;
374		}
375
376		/**
377		* @return array
378		*/
379		public function getExcludedSubClasses(): array
380		{
381		return $this->excludedSubClasses;
382		}
383
384		/**
385		* @param array $excludedSubClasses
386		* @return BaseQuery
387		*/
388		public function setExcludedSubClasses(array $excludedSubClasses): self
389		{
390		$this->excludedSubClasses = $excludedSubClasses;
391
392		return $this;
393		}
394		}
395

Firesphere / silverstripe-solr-search

Pull Request — master (#188)

BaseQuery::getExcludedSubClasses() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like