SearchRequest::getWildcardQueries() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master'" - nextcloud/fulltextsearch - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2ba6ee...8a1088 )

by Maxence

created 2018-05-30 17:10 UTC

SearchRequest::getWildcardQueries() A

↳ Parent: SearchRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * FullTextSearch - Full text search framework for Nextcloud
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Maxence Lange <[email protected]>
 * @copyright 2018
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\FullTextSearch\Model;

use OCA\FullTextSearch\Service\MiscService;

class SearchRequest implements \JsonSerializable {

	/** @var array */
	private $providers;

	/** @var string */
	private $search;

	/** @var int */
	private $page = 1;

	/** @var int */
	private $size = 10;

	/** @var string */
	private $author;

	/** @var array */
	private $tags;

	/** @var array */
	private $options;

	/** @var array */
	private $parts = [];

	/** @var array */
	private $fields = [];

	/** @var array */
	private $wildcardQueries = [];

	/** @var array */
	private $wildcardFilters = [];

	/** @var array */
	private $regexFilters = [];


	/**
	 * SearchRequest constructor.
	 */
	public function __construct() {
	}


	/**
	 * @return array
	 */
	public function getProviders() {
		return $this->providers;
	}

	/**
	 * @param string|array $providers
	 */
	public function setProviders($providers) {
		if (!is_array($providers)) {
			$providers = [$providers];
		}

		$this->providers = $providers;
	}


	/**
	 * @return string
	 */
	public function getAuthor() {
		return $this->author;
	}

	/**
	 * @param string $author
	 */
	public function setAuthor($author) {
		$this->author = $author;
	}


	/**
	 * @return string
	 */
	public function getSearch() {
		return $this->search;
	}

	/**
	 * @param string $search
	 */
	public function setSearch($search) {
		$this->search = $search;
	}


	public function cleanSearch() {
		$search = trim(str_replace('  ', ' ', $this->getSearch()));

		preg_match_all('/[^?]"(?:\\\\.|[^\\\\"])*"|\S+/', " $search ", $words);
		$searchItems = [];
		foreach ($words[0] as $word) {
			if ($this->searchQueryOptions($word)) {
				continue;
			}

			$searchItems[] = $word;
		}

		$this->setSearch(implode(" ", $searchItems));
	}


	/**
	 * @param $word
	 *
	 * @return bool
	 */
	private function searchQueryOptions($word) {
		if (($pos = strpos($word, ':')) === false) {
			return false;
		}

		list($kw, $value) = explode(':', $word, 2);
		$options = ['is', 'show'];

		if (in_array($kw, $options)) {
			$this->addOption($kw . '_' . $value, '1');

			return true;
		}

		return false;
	}


	/**
	 * @return int
	 */
	public function getPage() {
		return $this->page;
	}

	/**
	 * @param int $page
	 */
	public function setPage($page) {
		if ($page < 1) {
			$page = 1;
		}

		$this->page = $page;
	}


	/**
	 * @return int
	 */
	public function getSize() {
		return $this->size;
	}

	/**
	 * @param int $size
	 */
	public function setSize($size) {
		$this->size = $size;
	}


	/**
	 * @return array
	 */
	public function getOptions() {
		return $this->options;
	}

	/**
	 * @param array $options
	 */
	public function setOptions($options) {
		$this->options = $options;
	}

	/**
	 * @param $key
	 * @param $value
	 *
	 * @return $this
	 */
	public function addOption($key, $value) {
		$this->options[$key] = $value;

		return $this;
	}

	/**
	 * @param string $option
	 *
	 * @return mixed|string
	 */
	public function getOption($option) {
		if (array_key_exists($option, $this->options)) {
			return $this->options[$option];
		}

		return '';
	}


	/**
	 * @param array $parts
	 *
	 * @return $this
	 */
	public function setParts($parts) {
		$this->parts = $parts;

		return $this;
	}

	/**
	 * @return array
	 */
	public function getParts() {
		return $this->parts;
	}


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

	/**
	 * @param array $fields
	 *
	 * @return $this
	 */
	public function setFields($fields) {
		$this->fields = $fields;

		return $this;
	}

	/**
	 * @param $field
	 *
	 * @return $this
	 */
	public function addField($field) {
		$this->fields[] = $field;

		return $this;
	}


	/**
	 * @param string $tag
	 */
	public function addTag($tag) {
		$this->tags[] = $tag;
	}

	/**
	 * @return array
	 */
	public function getTags() {
		return $this->tags;
	}

	/**
	 * @param array $tags
	 */
	public function setTags($tags) {
		$this->tags = $tags;
	}


	/**
	 * @param array $query
	 *
	 * @return $this
	 */
	public function addWildcardQuery($query) {
		$this->addWildcardQueries([$query]);

		return $this;
	}

	/**
	 * @param array $query
	 *
	 * @return $this
	 */
	public function addWildcardQueries($query) {
		array_push($this->wildcardQueries, $query);

		return $this;
	}

	/**
	 * @return array
	 */
	public function getWildcardQueries() {
		return $this->wildcardQueries;
	}


	/**
	 * @param array $filter
	 *
	 * @return $this
	 */
	public function addWildcardFilter($filter) {
		$this->addWildcardFilters([$filter]);

		return $this;
	}

	/**
	 * @param array $filters
	 *
	 * @return $this
	 */
	public function addWildcardFilters($filters) {
		array_push($this->wildcardFilters, $filters);

		return $this;
	}

	/**
	 * @return array
	 */
	public function getWildcardFilters() {
		return $this->wildcardFilters;
	}


	/**
	 * @param array $filter
	 *
	 * @return $this
	 */
	public function addRegexFilter($filter) {
		$this->addRegexFilters([$filter]);

		return $this;
	}

	/**
	 * @param array $filters
	 *
	 * @return $this
	 */
	public function addRegexFilters($filters) {
		array_push($this->regexFilters, $filters);

		return $this;
	}

	/**
	 * @return array
	 */
	public function getRegexFilters() {
		return $this->regexFilters;
	}


	/**
	 * @return array

	 */
	public function jsonSerialize() {
		return [
			'providers' => $this->getProviders(),
			'author'    => $this->getAuthor(),
			'search'    => $this->getSearch(),
			'page'      => $this->getPage(),
			'size'      => $this->getSize(),
			'parts'     => $this->getParts(),
			'options'   => $this->getOptions(),
			'tags'      => $this->getTags()
		];
	}


	/**
	 * @param string $json
	 *
	 * @return SearchRequest
	 */
	public static function fromJSON($json) {
		return self::fromArray(json_decode($json, true));
	}

	/**
	 * @param array $arr
	 *
	 * @return SearchRequest
	 */
	public static function fromArray($arr) {
		$request = new SearchRequest();
		$request->setProviders($arr['providers']);
		$request->setAuthor(MiscService::get($arr, 'author', ''));
		$request->setSearch(MiscService::get($arr, 'search', ''));
		$request->setPage(MiscService::get($arr, 'page', 0));
		$request->setParts(MiscService::get($arr, 'parts', []));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$request->setSize(MiscService::get($arr, 'size', 10));
		$request->setOptions(MiscService::get($arr, 'options', []));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$request->setTags(MiscService::get($arr, 'tags', []));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		return $request;
	}


}

1			<?php
2			/**
3			* FullTextSearch - Full text search framework for Nextcloud
4			*
5			* This file is licensed under the Affero General Public License version 3 or
6			* later. See the COPYING file.
7			*
8			* @author Maxence Lange <[email protected]>
9			* @copyright 2018
10			* @license GNU AGPL version 3 or any later version
11			*
12			* This program is free software: you can redistribute it and/or modify
13			* it under the terms of the GNU Affero General Public License as
14			* published by the Free Software Foundation, either version 3 of the
15			* License, or (at your option) any later version.
16			*
17			* This program is distributed in the hope that it will be useful,
18			* but WITHOUT ANY WARRANTY; without even the implied warranty of
19			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20			* GNU Affero General Public License for more details.
21			*
22			* You should have received a copy of the GNU Affero General Public License
23			* along with this program. If not, see <http://www.gnu.org/licenses/>.
24			*
25			*/
26
27			namespace OCA\FullTextSearch\Model;
28
29			use OCA\FullTextSearch\Service\MiscService;
30
31			class SearchRequest implements \JsonSerializable {
32
33			/** @var array */
34			private $providers;
35
36			/** @var string */
37			private $search;
38
39			/** @var int */
40			private $page = 1;
41
42			/** @var int */
43			private $size = 10;
44
45			/** @var string */
46			private $author;
47
48			/** @var array */
49			private $tags;
50
51			/** @var array */
52			private $options;
53
54			/** @var array */
55			private $parts = [];
56
57			/** @var array */
58			private $fields = [];
59
60			/** @var array */
61			private $wildcardQueries = [];
62
63			/** @var array */
64			private $wildcardFilters = [];
65
66			/** @var array */
67			private $regexFilters = [];
68
69
70			/**
71			* SearchRequest constructor.
72			*/
73			public function __construct() {
74			}
75
76
77			/**
78			* @return array
79			*/
80			public function getProviders() {
81			return $this->providers;
82			}
83
84			/**
85			* @param string\|array $providers
86			*/
87			public function setProviders($providers) {
88			if (!is_array($providers)) {
89			$providers = [$providers];
90			}
91
92			$this->providers = $providers;
93			}
94
95
96			/**
97			* @return string
98			*/
99			public function getAuthor() {
100			return $this->author;
101			}
102
103			/**
104			* @param string $author
105			*/
106			public function setAuthor($author) {
107			$this->author = $author;
108			}
109
110
111			/**
112			* @return string
113			*/
114			public function getSearch() {
115			return $this->search;
116			}
117
118			/**
119			* @param string $search
120			*/
121			public function setSearch($search) {
122			$this->search = $search;
123			}
124
125
126			public function cleanSearch() {
127			$search = trim(str_replace(' ', ' ', $this->getSearch()));
128
129			preg_match_all('/[^?]"(?:\\\\.\|[^\\\\"])*"\|\S+/', " $search ", $words);
130			$searchItems = [];
131			foreach ($words[0] as $word) {
132			if ($this->searchQueryOptions($word)) {
133			continue;
134			}
135
136			$searchItems[] = $word;
137			}
138
139			$this->setSearch(implode(" ", $searchItems));
140			}
141
142
143			/**
144			* @param $word
145			*
146			* @return bool
147			*/
148			private function searchQueryOptions($word) {
149			if (($pos = strpos($word, ':')) === false) {
150			return false;
151			}
152
153			list($kw, $value) = explode(':', $word, 2);
154			$options = ['is', 'show'];
155
156			if (in_array($kw, $options)) {
157			$this->addOption($kw . '_' . $value, '1');
158
159			return true;
160			}
161
162			return false;
163			}
164
165
166			/**
167			* @return int
168			*/
169			public function getPage() {
170			return $this->page;
171			}
172
173			/**
174			* @param int $page
175			*/
176			public function setPage($page) {
177			if ($page < 1) {
178			$page = 1;
179			}
180
181			$this->page = $page;
182			}
183
184
185			/**
186			* @return int
187			*/
188			public function getSize() {
189			return $this->size;
190			}
191
192			/**
193			* @param int $size
194			*/
195			public function setSize($size) {
196			$this->size = $size;
197			}
198
199
200			/**
201			* @return array
202			*/
203			public function getOptions() {
204			return $this->options;
205			}
206
207			/**
208			* @param array $options
209			*/
210			public function setOptions($options) {
211			$this->options = $options;
212			}
213
214			/**
215			* @param $key
216			* @param $value
217			*
218			* @return $this
219			*/
220			public function addOption($key, $value) {
221			$this->options[$key] = $value;
222
223			return $this;
224			}
225
226			/**
227			* @param string $option
228			*
229			* @return mixed\|string
230			*/
231			public function getOption($option) {
232			if (array_key_exists($option, $this->options)) {
233			return $this->options[$option];
234			}
235
236			return '';
237			}
238
239
240			/**
241			* @param array $parts
242			*
243			* @return $this
244			*/
245			public function setParts($parts) {
246			$this->parts = $parts;
247
248			return $this;
249			}
250
251			/**
252			* @return array
253			*/
254			public function getParts() {
255			return $this->parts;
256			}
257
258
259			/**
260			* @return array
261			*/
262			public function getFields() {
263			return $this->fields;
264			}
265
266			/**
267			* @param array $fields
268			*
269			* @return $this
270			*/
271			public function setFields($fields) {
272			$this->fields = $fields;
273
274			return $this;
275			}
276
277			/**
278			* @param $field
279			*
280			* @return $this
281			*/
282			public function addField($field) {
283			$this->fields[] = $field;
284
285			return $this;
286			}
287
288
289			/**
290			* @param string $tag
291			*/
292			public function addTag($tag) {
293			$this->tags[] = $tag;
294			}
295
296			/**
297			* @return array
298			*/
299			public function getTags() {
300			return $this->tags;
301			}
302
303			/**
304			* @param array $tags
305			*/
306			public function setTags($tags) {
307			$this->tags = $tags;
308			}
309
310
311			/**
312			* @param array $query
313			*
314			* @return $this
315			*/
316			public function addWildcardQuery($query) {
317			$this->addWildcardQueries([$query]);
318
319			return $this;
320			}
321
322			/**
323			* @param array $query
324			*
325			* @return $this
326			*/
327			public function addWildcardQueries($query) {
328			array_push($this->wildcardQueries, $query);
329
330			return $this;
331			}
332
333			/**
334			* @return array
335			*/
336			public function getWildcardQueries() {
337			return $this->wildcardQueries;
338			}
339
340
341			/**
342			* @param array $filter
343			*
344			* @return $this
345			*/
346			public function addWildcardFilter($filter) {
347			$this->addWildcardFilters([$filter]);
348
349			return $this;
350			}
351
352			/**
353			* @param array $filters
354			*
355			* @return $this
356			*/
357			public function addWildcardFilters($filters) {
358			array_push($this->wildcardFilters, $filters);
359
360			return $this;
361			}
362
363			/**
364			* @return array
365			*/
366			public function getWildcardFilters() {
367			return $this->wildcardFilters;
368			}
369
370
371			/**
372			* @param array $filter
373			*
374			* @return $this
375			*/
376			public function addRegexFilter($filter) {
377			$this->addRegexFilters([$filter]);
378
379			return $this;
380			}
381
382			/**
383			* @param array $filters
384			*
385			* @return $this
386			*/
387			public function addRegexFilters($filters) {
388			array_push($this->regexFilters, $filters);
389
390			return $this;
391			}
392
393			/**
394			* @return array
395			*/
396			public function getRegexFilters() {
397			return $this->regexFilters;
398			}
399
400
401			/**
402			* @return array
			0 ignored issues – show Documentation introduced 2018-01-10 22:09 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,array\|string\|integer>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
403			*/
404			public function jsonSerialize() {
405			return [
406			'providers' => $this->getProviders(),
407			'author' => $this->getAuthor(),
408			'search' => $this->getSearch(),
409			'page' => $this->getPage(),
410			'size' => $this->getSize(),
411			'parts' => $this->getParts(),
412			'options' => $this->getOptions(),
413			'tags' => $this->getTags()
414			];
415			}
416
417
418			/**
419			* @param string $json
420			*
421			* @return SearchRequest
422			*/
423			public static function fromJSON($json) {
424			return self::fromArray(json_decode($json, true));
425			}
426
427			/**
428			* @param array $arr
429			*
430			* @return SearchRequest
431			*/
432			public static function fromArray($arr) {
433			$request = new SearchRequest();
434			$request->setProviders($arr['providers']);
435			$request->setAuthor(MiscService::get($arr, 'author', ''));
436			$request->setSearch(MiscService::get($arr, 'search', ''));
437			$request->setPage(MiscService::get($arr, 'page', 0));
438			$request->setParts(MiscService::get($arr, 'parts', []));
			0 ignored issues – show Documentation introduced 2018-01-10 22:09 UTC by Report Bug Copy Issue Report `array()` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
439			$request->setSize(MiscService::get($arr, 'size', 10));
440			$request->setOptions(MiscService::get($arr, 'options', []));
			0 ignored issues – show Documentation introduced 2018-01-10 22:09 UTC by Report Bug Copy Issue Report `array()` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
441			$request->setTags(MiscService::get($arr, 'tags', []));
			0 ignored issues – show Documentation introduced 2018-05-07 17:25 UTC by Report Bug Copy Issue Report `array()` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
442
443			return $request;
444			}
445
446
447			}

nextcloud / fulltextsearch

Push — master ( 2ba6ee...8a1088 )

SearchRequest::getWildcardQueries() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like