CoreQuery::isHighlight() - Code Metrics - Firesphere/silverstripe-search - Measure and Improve Code Quality continuously with Scrutinizer

CoreQuery::isHighlight() A
last analyzed 2023-11-13 23:19 UTC

↳ Parent: CoreQuery

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

namespace Firesphere\SearchBackend\Queries;

use Firesphere\SearchBackend\Interfaces\QueryInterface;

/**
 * Default querying interface,
 */
class CoreQuery implements QueryInterface
{
    /**
     * @var int Pagination start
     */
    protected $start = 0;
    /**
     * @var int Total rows to display
     */
    protected $rows = 10;
    /**
     * @var array Sorting settings
     */
    protected $sort = [];
    /**
     * @var array Filters to use/apply
     */
    protected $filters = [];

    /**
     * @var array Filters that are not exclusive
     */
    protected $orFilters = [];
    /**
     * @var array Search terms
     */
    protected $terms = [];
    /**
     * @var array
     */
    protected $boostedFields = [];
    /**
     * @var bool
     */
    protected $highlight = true;
    /**
     * @var bool Enable spellchecking?
     */
    protected $spellcheck = true;

    /**
     * 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;
    }

    /**
     * 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
     * @param string $term Term to search for
     * @param array $fields fields to boost on
     * @param int $boost Boost value
     * @param float|bool $fuzzy True or a value to the maximum amount of iterations
     * @return $this
     * For generic boosting, use @addBoostedField($field, $boost), this will add the boost at Index time
     */
    public function addTerm(string $term, array $fields = [], int $boost = 0, float|bool|null $fuzzy = false): self
    {
        $this->terms[] = [
            'text'   => $term,
            'fields' => $fields,
            'boost'  => $boost,
            'fuzzy'  => $fuzzy,
        ];

        return $this;
    }

    /**
     * @param string $key Field to apply filter on
     * @param string|array $value Value(s) to filter on
     * @return CoreQuery
     */
    public function addFilter($key, $value): CoreQuery
    {
        $this->filters[$key] = $value;

        return $this;
    }

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

    /**
     * @param array $filters
     * @return CoreQuery
     */
    public function setFilters(array $filters): CoreQuery
    {
        $this->filters = $filters;

        return $this;
    }

    /**
     * Get the OR filters for this query
     *
     * @return array
     */
    public function getOrFilters(): array
    {
        return $this->orFilters;
    }

    /**
     * Set the or filters for this query
     * @param array $filters
     * @return self
     */
    public function setOrFilters(array $filters): self
    {
        $this->orFilters = $filters;

        return $this;
    }

    /**
     * Add the or filters in a key-value pair
     * @param string $key
     * @param string $value
     * @return self
     */
    public function addOrFilter(string $key, string $value): self
    {
        $this->orFilters[$key] = $value;

        return $this;
    }

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

    /**
     * Set the offset to start
     *
     * @param int $start
     * @return self
     */
    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 self
     */
    public function setRows($rows): self
    {
        $this->rows = $rows;

        return $this;
    }

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

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

        return $this;
    }

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

        return $this;
    }

    public function getBoostedFields(): array
    {
        return $this->boostedFields;
    }

    public function setBoostedFields(array $boostedFields): void
    {
        $this->boostedFields = $boostedFields;
    }

    public function addBoostedField($key, $value): self
    {
        $this->boostedFields[$key] = $value;

        return $this;
    }

    public function isHighlight(): bool
    {
        return $this->highlight;
    }

    public function setHighlight(bool $highlight): self
    {
        $this->highlight = $highlight;

        return $this;
    }
}


1			<?php
2
3			namespace Firesphere\SearchBackend\Queries;
4
5			use Firesphere\SearchBackend\Interfaces\QueryInterface;
6
7			/**
8			* Default querying interface,
9			*/
10			class CoreQuery implements QueryInterface
11			{
12			/**
13			* @var int Pagination start
14			*/
15			protected $start = 0;
16			/**
17			* @var int Total rows to display
18			*/
19			protected $rows = 10;
20			/**
21			* @var array Sorting settings
22			*/
23			protected $sort = [];
24			/**
25			* @var array Filters to use/apply
26			*/
27			protected $filters = [];
28
29			/**
30			* @var array Filters that are not exclusive
31			*/
32			protected $orFilters = [];
33			/**
34			* @var array Search terms
35			*/
36			protected $terms = [];
37			/**
38			* @var array
39			*/
40			protected $boostedFields = [];
41			/**
42			* @var bool
43			*/
44			protected $highlight = true;
45			/**
46			* @var bool Enable spellchecking?
47			*/
48			protected $spellcheck = true;
49
50			/**
51			* Get the search terms
52			*
53			* @return array
54			*/
55			public function getTerms(): array
56			{
57			return $this->terms;
58			}
59
60			/**
61			* Set the search tearms
62			*
63			* @param array $terms
64			* @return $this
65			*/
66			public function setTerms($terms): self
67			{
68			$this->terms = $terms;
69
70			return $this;
71			}
72
73			/**
74			* Each boosted query needs a separate addition!
75			* e.g. $this->addTerm('test', ['MyField', 'MyOtherField'], 3)
76			* followed by
77			* $this->addTerm('otherTest', ['Title'], 5);
78			*
79			* If you want a generic boost on all terms, use addTerm only once, but boost on each field
80			*
81			* The fields parameter is used to boost on
82			* @param string $term Term to search for
83			* @param array $fields fields to boost on
84			* @param int $boost Boost value
85			* @param float\|bool $fuzzy True or a value to the maximum amount of iterations
86			* @return $this
87			* For generic boosting, use @addBoostedField($field, $boost), this will add the boost at Index time
88			*/
89			public function addTerm(string $term, array $fields = [], int $boost = 0, float\|bool\|null $fuzzy = false): self
90			{
91			$this->terms[] = [
92			'text' => $term,
93			'fields' => $fields,
94			'boost' => $boost,
95			'fuzzy' => $fuzzy,
96			];
97
98			return $this;
99			}
100
101			/**
102			* @param string $key Field to apply filter on
103			* @param string\|array $value Value(s) to filter on
104			* @return CoreQuery
105			*/
106			public function addFilter($key, $value): CoreQuery
107			{
108			$this->filters[$key] = $value;
109
110			return $this;
111			}
112
113			/**
114			* @return array
115			*/
116			public function getFilters(): array
117			{
118			return $this->filters;
119			}
120
121			/**
122			* @param array $filters
123			* @return CoreQuery
124			*/
125			public function setFilters(array $filters): CoreQuery
126			{
127			$this->filters = $filters;
128
129			return $this;
130			}
131
132			/**
133			* Get the OR filters for this query
134			*
135			* @return array
136			*/
137			public function getOrFilters(): array
138			{
139			return $this->orFilters;
140			}
141
142			/**
143			* Set the or filters for this query
144			* @param array $filters
145			* @return self
146			*/
147			public function setOrFilters(array $filters): self
148			{
149			$this->orFilters = $filters;
150
151			return $this;
152			}
153
154			/**
155			* Add the or filters in a key-value pair
156			* @param string $key
157			* @param string $value
158			* @return self
159			*/
160			public function addOrFilter(string $key, string $value): self
161			{
162			$this->orFilters[$key] = $value;
163
164			return $this;
165			}
166
167			/**
168			* Get the offset to start
169			*
170			* @return int
171			*/
172			public function getStart(): int
173			{
174			return $this->start;
175			}
176
177			/**
178			* Set the offset to start
179			*
180			* @param int $start
181			* @return self
182			*/
183			public function setStart($start): self
184			{
185			$this->start = $start;
186
187			return $this;
188			}
189
190			/**
191			* Get the rows to return
192			*
193			* @return int
194			*/
195			public function getRows(): int
196			{
197			return $this->rows;
198			}
199
200			/**
201			* Set the rows to return
202			*
203			* @param int $rows
204			* @return self
205			*/
206			public function setRows($rows): self
207			{
208			$this->rows = $rows;
209
210			return $this;
211			}
212
213			/**
214			* Get the sort fields
215			*
216			* @return array
217			*/
218			public function getSort(): array
219			{
220			return $this->sort;
221			}
222
223			/**
224			* Set the sort fields
225			*
226			* @param array $sort
227			* @return self
228			*/
229			public function setSort($sort): self
230			{
231			$this->sort = $sort;
232
233			return $this;
234			}
235
236			/**
237			* Add a sort field and direction
238			*
239			* @param string $field
240			* @param string $direction
241			* @return self
242			*/
243			public function addSort($field, $direction): self
244			{
245			$this->sort[$field] = $direction;
246
247			return $this;
248			}
249
250			public function getBoostedFields(): array
251			{
252			return $this->boostedFields;
253			}
254
255			public function setBoostedFields(array $boostedFields): void
256			{
257			$this->boostedFields = $boostedFields;
258			}
259
260			public function addBoostedField($key, $value): self
261			{
262			$this->boostedFields[$key] = $value;
263
264			return $this;
265			}
266
267			public function isHighlight(): bool
268			{
269			return $this->highlight;
270			}
271
272			public function setHighlight(bool $highlight): self
273			{
274			$this->highlight = $highlight;
275
276			return $this;
277			}
278			}
279

Firesphere / silverstripe-search

CoreQuery::isHighlight() A last analyzed 2023-11-13 23:19 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CoreQuery::isHighlight() A
last analyzed 2023-11-13 23:19 UTC