IndexDocument::setHash() - Code Metrics - Inspection of "searchRequest() to replace searchDocuments tempora..." - nextcloud/fulltextsearch - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4541a4...2fe9dd )

by Maxence

created 2018-09-04 13:26 UTC

IndexDocument::setHash() A

↳ Parent: IndexDocument

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?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;

class IndexDocument implements \JsonSerializable {

	const NOT_ENCODED = 0;
	const ENCODED_BASE64 = 1;

	/** @var string|int */
	protected $id;

	/** @var string */
	protected $providerId;

	/** @var DocumentAccess */
	protected $access;

	/** @var Index */
	protected $index;

	/** @var int */
	protected $modifiedTime = 0;

	/** @var string */
	protected $source = '';

	/** @var array */
	protected $tags = [];

	/** @var array */
	protected $metaTags = [];

	/** @var array */
	protected $subTags = [];

	/** @var string */
	protected $title = '';

	/** @var string */
	protected $content = null;

	/** @var string */
	protected $hash = '';

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

	/** @var string */
	protected $link = '';

	/** @var array */
	protected $more = [];

	/** @var array */
	protected $excerpts = [];

	/** @var string */
	protected $score;

	/** @var array */
	protected $info = [];

	/** @var int */
	protected $contentEncoded;


	public function __construct($providerId, $id) {
		$this->providerId = $providerId;
		$this->id = $id;
	}


//	/**
//	 * @param string|integer $id
//	 *
//	 * @return $this
//	 */
//	public function setId($id) {
//		$this->id = $id;
//
//		return $this;
//	}

	/**
	 * @return string|integer
	 */
	public function getId() {
		return $this->id;
	}


//	/**
//	 * @param string $providerId
//	 *
//	 * @return $this
//	 */
//	public function setProviderId($providerId) {
//		$this->providerId = $providerId;
//
//		return $this;
//	}

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


	/**
	 * @param Index $index
	 */
	public function setIndex(Index $index) {
		$this->index = $index;
	}

	/**
	 * @return Index
	 */
	public function getIndex() {
		return $this->index;
	}


	/**
	 * @param int $modifiedTime
	 *
	 * @return $this
	 */
	public function setModifiedTime($modifiedTime) {
		$this->modifiedTime = $modifiedTime;

		return $this;
	}

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

	/**
	 * @param int $time
	 *
	 * @return bool
	 */
	public function isOlderThan($time) {
		return ($this->modifiedTime < $time);
	}


	/**
	 * @param DocumentAccess $access
	 *
	 * @return $this
	 */
	public function setAccess(DocumentAccess $access) {
		$this->access = $access;

		return $this;
	}

	/**
	 * @return DocumentAccess
	 */
	public function getAccess() {
		return $this->access;
	}


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

		return $this;
	}

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

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

		return $this;
	}


	/**
	 * @param array $tags
	 *
	 * @return $this
	 */
	public function setMetaTags($tags) {
		$this->metaTags = $tags;

		return $this;
	}

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

	/**
	 * @param $tags
	 *
	 * @return $this
	 */
	public function addMetaTag($tags) {
		$this->metaTags[] = $tags;

		return $this;
	}


	/**
	 * @param array $tags
	 *
	 * @return $this
	 */
	public function setSubTags($tags) {
		$this->subTags = $tags;

		return $this;
	}

	/**
	 * @param bool $formatted
	 *
	 * @return array
	 */
	public function getSubTags($formatted = false) {

		if ($formatted === false) {
			return $this->subTags;
		}

		$subTags = [];
		$ak = array_keys($this->subTags);
		foreach ($ak as $source) {
			$tags = $this->subTags[$source];
			foreach ($tags as $tag) {
				$subTags[] = $source . '_' . $tag;
			}
		}

		return $subTags;
	}

	/**
	 * @param string $k
	 * @param string $tag
	 *
	 * @return $this
	 */
	public function addSubTag($k, $tag) {
		$this->subTags[$k] = $tag;

		return $this;
	}


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

	/**
	 * @param string $source
	 *
	 * @return $this
	 */
	public function setSource($source) {
		$this->source = $source;

		return $this;
	}


	/**
	 * @param string $title
	 *
	 * @return $this
	 */
	public function setTitle($title) {
		$this->title = $title;

		return $this;
	}

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


	/**
	 * @param string $content
	 * @param int $encoded
	 *
	 * @return $this
	 */
	public function setContent($content, $encoded = 0) {
		$this->content = $content;
		$this->contentEncoded = $encoded;

		return $this;
	}

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

	/**
	 * @return int
	 */
	public function getContentSize() {
		return strlen($this->getContent());
	}


	/**
	 * @return $this
	 */
	public function initHash() {
		if ($this->getContent() === '' || is_null($this->getContent())) {
			return $this;
		}

		$this->hash = hash("md5", $this->getContent());

		return $this;
	}

	/**
	 * @param $hash
	 *
	 * @return $this
	 */
	public function setHash($hash) {
		$this->hash = $hash;

		return $this;
	}

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


	/**
	 * @param string $part
	 * @param string $content
	 *
	 * @return $this
	 */
	public function addPart($part, $content) {
		$this->parts[$part] = $content;

		return $this;
	}

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

		return $this;
	}

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


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


	/**
	 * @param string $link
	 *
	 * @return $this
	 */
	public function setLink($link) {
		$this->link = $link;

		return $this;
	}

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


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

		return $this;
	}

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


	/**
	 * @param array $excerpts
	 *
	 * @return $this
	 */
	public function setExcerpts($excerpts) {
		$excerpts = array_map([$this, 'cleanExcerpt'], $excerpts);

		$this->excerpts = $excerpts;

		return $this;
	}

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

	/**
	 * @param string $excerpt
	 */
	public function addExcerpt($excerpt) {
		$excerpt = $this->cleanExcerpt($excerpt);

		$this->excerpts[] = $excerpt;
	}

	/**
	 * @param $excerpt
	 *
	 * @return mixed
	 */
	public function cleanExcerpt($excerpt) {
		$excerpt = str_replace("\\n", ' ', $excerpt);
		$excerpt = str_replace("\\r", ' ', $excerpt);
		$excerpt = str_replace("\\t", ' ', $excerpt);
		$excerpt = str_replace("\n", ' ', $excerpt);
		$excerpt = str_replace("\r", ' ', $excerpt);
		$excerpt = str_replace("\t", ' ', $excerpt);

		return $excerpt;
	}

	/**
	 * @param string $score
	 *
	 * @return $this
	 */
	public function setScore($score) {
		$this->score = $score;

		return $this;
	}

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


	/**
	 * @param string $info
	 * @param mixed $value
	 *
	 * @return $this
	 */
	public function setInfo($info, $value) {
		$this->info[$info] = $value;

		return $this;
	}

	/**
	 * @param string $info
	 * @param mixed $default
	 *
	 * @return mixed
	 */
	public function getInfo($info, $default = '') {
		if (!key_exists($info, $this->info)) {
			return $default;
		}

		return $this->info[$info];
	}


	/**
	 * @return array
	 */
	public function getInfoAll() {

		$info = [];
		foreach ($this->info as $k => $v) {
			if (substr($k, 0, 1) === '_') {
				continue;
			}

			$info[$k] = $v;
		}

		return $info;
	}


	public function __destruct() {
		unset($this->id);
		unset($this->providerId);
		unset($this->access);
		unset($this->modifiedTime);
		unset($this->title);
		unset($this->content);
		unset($this->hash);
		unset($this->link);
		unset($this->source);
		unset($this->tags);
		unset($this->metaTags);
		unset($this->subTags);
		unset($this->more);
		unset($this->excerpts);
		unset($this->score);
		unset($this->info);
		unset($this->contentEncoded);
	}

	/**
	 * @return array<string,string|integer|DocumentAccess|array>

	 */
	public function jsonSerialize() {
		return [
			'id'           => $this->getId(),
			'providerId'   => $this->getProviderId(),
			'access'       => $this->getAccess(),
			'modifiedTime' => $this->getModifiedTime(),
			'title'        => $this->getTitle(),
			'link'         => $this->getLink(),
			'index'        => $this->getIndex(),
			'source'       => $this->getSource(),
			'info'         => $this->getInfoAll(),
			'hash'         => $this->getHash(),
			'contentSize'  => $this->getContentSize(),
			'tags'         => $this->getTags(),
			'metatags'     => $this->getMetaTags(),
			'subtags'      => $this->getSubTags(),
			'more'         => $this->getMore(),
			'excerpts'     => $this->getExcerpts(),
			'score'        => $this->getScore()
		];
	}

}

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		class IndexDocument implements \JsonSerializable {
30
31		const NOT_ENCODED = 0;
32		const ENCODED_BASE64 = 1;
33
34		/** @var string\|int */
35		protected $id;
36
37		/** @var string */
38		protected $providerId;
39
40		/** @var DocumentAccess */
41		protected $access;
42
43		/** @var Index */
44		protected $index;
45
46		/** @var int */
47		protected $modifiedTime = 0;
48
49		/** @var string */
50		protected $source = '';
51
52		/** @var array */
53		protected $tags = [];
54
55		/** @var array */
56		protected $metaTags = [];
57
58		/** @var array */
59		protected $subTags = [];
60
61		/** @var string */
62		protected $title = '';
63
64		/** @var string */
65		protected $content = null;
66
67		/** @var string */
68		protected $hash = '';
69
70		/** @var array */
71		protected $parts = [];
72
73		/** @var string */
74		protected $link = '';
75
76		/** @var array */
77		protected $more = [];
78
79		/** @var array */
80		protected $excerpts = [];
81
82		/** @var string */
83		protected $score;
84
85		/** @var array */
86		protected $info = [];
87
88		/** @var int */
89		protected $contentEncoded;
90
91
92		public function __construct($providerId, $id) {
93		$this->providerId = $providerId;
94		$this->id = $id;
95		}
96
97
98		// /**
99		// * @param string\|integer $id
100		// *
101		// * @return $this
102		// */
103		// public function setId($id) {
104		// $this->id = $id;
105		//
106		// return $this;
107		// }
108
109		/**
110		* @return string\|integer
111		*/
112		public function getId() {
113		return $this->id;
114		}
115
116
117		// /**
118		// * @param string $providerId
119		// *
120		// * @return $this
121		// */
122		// public function setProviderId($providerId) {
123		// $this->providerId = $providerId;
124		//
125		// return $this;
126		// }
127
128		/**
129		* @return string
130		*/
131		public function getProviderId() {
132		return $this->providerId;
133		}
134
135
136		/**
137		* @param Index $index
138		*/
139		public function setIndex(Index $index) {
140		$this->index = $index;
141		}
142
143		/**
144		* @return Index
145		*/
146		public function getIndex() {
147		return $this->index;
148		}
149
150
151		/**
152		* @param int $modifiedTime
153		*
154		* @return $this
155		*/
156		public function setModifiedTime($modifiedTime) {
157		$this->modifiedTime = $modifiedTime;
158
159		return $this;
160		}
161
162		/**
163		* @return int
164		*/
165		public function getModifiedTime() {
166		return $this->modifiedTime;
167		}
168
169		/**
170		* @param int $time
171		*
172		* @return bool
173		*/
174		public function isOlderThan($time) {
175		return ($this->modifiedTime < $time);
176		}
177
178
179		/**
180		* @param DocumentAccess $access
181		*
182		* @return $this
183		*/
184		public function setAccess(DocumentAccess $access) {
185		$this->access = $access;
186
187		return $this;
188		}
189
190		/**
191		* @return DocumentAccess
192		*/
193		public function getAccess() {
194		return $this->access;
195		}
196
197
198		/**
199		* @param array $tags
200		*
201		* @return $this
202		*/
203		public function setTags($tags) {
204		$this->tags = $tags;
205
206		return $this;
207		}
208
209		/**
210		* @return array
211		*/
212		public function getTags() {
213		return $this->tags;
214		}
215
216		/**
217		* @param $tag
218		*
219		* @return $this
220		*/
221		public function addTag($tag) {
222		$this->tags[] = $tag;
223
224		return $this;
225		}
226
227
228		/**
229		* @param array $tags
230		*
231		* @return $this
232		*/
233		public function setMetaTags($tags) {
234		$this->metaTags = $tags;
235
236		return $this;
237		}
238
239		/**
240		* @return array
241		*/
242		public function getMetaTags() {
243		return $this->metaTags;
244		}
245
246		/**
247		* @param $tags
248		*
249		* @return $this
250		*/
251		public function addMetaTag($tags) {
252		$this->metaTags[] = $tags;
253
254		return $this;
255		}
256
257
258		/**
259		* @param array $tags
260		*
261		* @return $this
262		*/
263		public function setSubTags($tags) {
264		$this->subTags = $tags;
265
266		return $this;
267		}
268
269		/**
270		* @param bool $formatted
271		*
272		* @return array
273		*/
274	View Code Duplication	public function getSubTags($formatted = false) {
		0 ignored issues – show Duplication introduced 2018-08-24 08:58 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
275		if ($formatted === false) {
276		return $this->subTags;
277		}
278
279		$subTags = [];
280		$ak = array_keys($this->subTags);
281		foreach ($ak as $source) {
282		$tags = $this->subTags[$source];
283		foreach ($tags as $tag) {
284		$subTags[] = $source . '_' . $tag;
285		}
286		}
287
288		return $subTags;
289		}
290
291		/**
292		* @param string $k
293		* @param string $tag
294		*
295		* @return $this
296		*/
297		public function addSubTag($k, $tag) {
298		$this->subTags[$k] = $tag;
299
300		return $this;
301		}
302
303
304		/**
305		* @return string
306		*/
307		public function getSource() {
308		return $this->source;
309		}
310
311		/**
312		* @param string $source
313		*
314		* @return $this
315		*/
316		public function setSource($source) {
317		$this->source = $source;
318
319		return $this;
320		}
321
322
323		/**
324		* @param string $title
325		*
326		* @return $this
327		*/
328		public function setTitle($title) {
329		$this->title = $title;
330
331		return $this;
332		}
333
334		/**
335		* @return string
336		*/
337		public function getTitle() {
338		return $this->title;
339		}
340
341
342		/**
343		* @param string $content
344		* @param int $encoded
345		*
346		* @return $this
347		*/
348		public function setContent($content, $encoded = 0) {
349		$this->content = $content;
350		$this->contentEncoded = $encoded;
351
352		return $this;
353		}
354
355		/**
356		* @return string
357		*/
358		public function getContent() {
359		return $this->content;
360		}
361
362		/**
363		* @return int
364		*/
365		public function getContentSize() {
366		return strlen($this->getContent());
367		}
368
369
370		/**
371		* @return $this
372		*/
373		public function initHash() {
374		if ($this->getContent() === '' \|\| is_null($this->getContent())) {
375		return $this;
376		}
377
378		$this->hash = hash("md5", $this->getContent());
379
380		return $this;
381		}
382
383		/**
384		* @param $hash
385		*
386		* @return $this
387		*/
388		public function setHash($hash) {
389		$this->hash = $hash;
390
391		return $this;
392		}
393
394		/**
395		* @return string
396		*/
397		public function getHash() {
398		return $this->hash;
399		}
400
401
402		/**
403		* @param string $part
404		* @param string $content
405		*
406		* @return $this
407		*/
408		public function addPart($part, $content) {
409		$this->parts[$part] = $content;
410
411		return $this;
412		}
413
414		/**
415		* @param array $parts
416		*
417		* @return $this
418		*/
419		public function setParts($parts) {
420		$this->parts = $parts;
421
422		return $this;
423		}
424
425		/**
426		* @return array
427		*/
428		public function getParts() {
429		return $this->parts;
430		}
431
432
433		/**
434		* @return int
435		*/
436		public function isContentEncoded() {
437		return $this->contentEncoded;
438		}
439
440
441		/**
442		* @param string $link
443		*
444		* @return $this
445		*/
446		public function setLink($link) {
447		$this->link = $link;
448
449		return $this;
450		}
451
452		/**
453		* @return string
454		*/
455		public function getLink() {
456		return $this->link;
457		}
458
459
460		/**
461		* @param array $more
462		*
463		* @return $this
464		*/
465		public function setMore($more) {
466		$this->more = $more;
467
468		return $this;
469		}
470
471		/**
472		* @return array
473		*/
474		public function getMore() {
475		return $this->more;
476		}
477
478
479		/**
480		* @param array $excerpts
481		*
482		* @return $this
483		*/
484		public function setExcerpts($excerpts) {
485		$excerpts = array_map([$this, 'cleanExcerpt'], $excerpts);
486
487		$this->excerpts = $excerpts;
488
489		return $this;
490		}
491
492		/**
493		* @return array
494		*/
495		public function getExcerpts() {
496		return $this->excerpts;
497		}
498
499		/**
500		* @param string $excerpt
501		*/
502		public function addExcerpt($excerpt) {
503		$excerpt = $this->cleanExcerpt($excerpt);
504
505		$this->excerpts[] = $excerpt;
506		}
507
508		/**
509		* @param $excerpt
510		*
511		* @return mixed
512		*/
513		public function cleanExcerpt($excerpt) {
514		$excerpt = str_replace("\\n", ' ', $excerpt);
515		$excerpt = str_replace("\\r", ' ', $excerpt);
516		$excerpt = str_replace("\\t", ' ', $excerpt);
517		$excerpt = str_replace("\n", ' ', $excerpt);
518		$excerpt = str_replace("\r", ' ', $excerpt);
519		$excerpt = str_replace("\t", ' ', $excerpt);
520
521		return $excerpt;
522		}
523
524		/**
525		* @param string $score
526		*
527		* @return $this
528		*/
529		public function setScore($score) {
530		$this->score = $score;
531
532		return $this;
533		}
534
535		/**
536		* @return string
537		*/
538		public function getScore() {
539		return $this->score;
540		}
541
542
543		/**
544		* @param string $info
545		* @param mixed $value
546		*
547		* @return $this
548		*/
549		public function setInfo($info, $value) {
550		$this->info[$info] = $value;
551
552		return $this;
553		}
554
555		/**
556		* @param string $info
557		* @param mixed $default
558		*
559		* @return mixed
560		*/
561		public function getInfo($info, $default = '') {
562		if (!key_exists($info, $this->info)) {
563		return $default;
564		}
565
566		return $this->info[$info];
567		}
568
569
570		/**
571		* @return array
572		*/
573		public function getInfoAll() {
574
575		$info = [];
576		foreach ($this->info as $k => $v) {
577		if (substr($k, 0, 1) === '_') {
578		continue;
579		}
580
581		$info[$k] = $v;
582		}
583
584		return $info;
585		}
586
587
588		public function __destruct() {
589		unset($this->id);
590		unset($this->providerId);
591		unset($this->access);
592		unset($this->modifiedTime);
593		unset($this->title);
594		unset($this->content);
595		unset($this->hash);
596		unset($this->link);
597		unset($this->source);
598		unset($this->tags);
599		unset($this->metaTags);
600		unset($this->subTags);
601		unset($this->more);
602		unset($this->excerpts);
603		unset($this->score);
604		unset($this->info);
605		unset($this->contentEncoded);
606		}
607
608		/**
609		* @return array<string,string\|integer\|DocumentAccess\|array>
		0 ignored issues – show Documentation introduced 2018-08-02 00:26 UTC by Report Bug Copy Issue Report Should the return type not be `array<string,string\|inte...mentAccess\|Index\|array>`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
610		*/
611		public function jsonSerialize() {
612		return [
613		'id' => $this->getId(),
614		'providerId' => $this->getProviderId(),
615		'access' => $this->getAccess(),
616		'modifiedTime' => $this->getModifiedTime(),
617		'title' => $this->getTitle(),
618		'link' => $this->getLink(),
619		'index' => $this->getIndex(),
620		'source' => $this->getSource(),
621		'info' => $this->getInfoAll(),
622		'hash' => $this->getHash(),
623		'contentSize' => $this->getContentSize(),
624		'tags' => $this->getTags(),
625		'metatags' => $this->getMetaTags(),
626		'subtags' => $this->getSubTags(),
627		'more' => $this->getMore(),
628		'excerpts' => $this->getExcerpts(),
629		'score' => $this->getScore()
630		];
631		}
632
633		}

nextcloud / fulltextsearch

Push — master ( 4541a4...2fe9dd )

IndexDocument::setHash() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like