SearchResult::getPlatform() - Code Metrics - Inspection of "display version in searchresult" - nextcloud/fulltextsearch - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 17927a...312875 )

by Maxence

created 2018-01-19 23:23 UTC

SearchResult::getPlatform() A

↳ Parent: SearchResult

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
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\IFullTextSearchPlatform;
use OCA\FullTextSearch\IFullTextSearchProvider;

class SearchResult implements \JsonSerializable {

	/** @var IndexDocument[] */
	private $documents = [];

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

	/** @var IFullTextSearchProvider */
	private $provider;

	/** @var IFullTextSearchPlatform */
	private $platform;

	/** @var int */
	private $total;

	/** @var int */
	private $maxScore;

	/** @var int */
	private $time;

	/** @var boolean */
	private $timedOut;

	/** @var SearchRequest */
	private $request;


	public function __construct() {
	}


	/**
	 * @param IndexDocument[] $documents
	 *
	 * @return $this
	 */
	public function setDocuments($documents) {
		$this->documents = $documents;

		return $this;
	}

	/**
	 * @return IndexDocument[]
	 */
	public function getDocuments() {
		return $this->documents;
	}

	/**
	 * @param IndexDocument $document
	 *
	 * @return $this
	 */
	public function addDocument(IndexDocument $document) {
		$this->documents[] = $document;

		return $this;
	}

	/**
	 * @return int
	 */
	public function getCount() {
		return count($this->documents);
	}


	/**
	 * @param string $result
	 */
	public function setRawResult($result) {
		$this->rawResult = $result;
	}

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


	/**
	 * @param IFullTextSearchProvider $provider
	 */
	public function setProvider(IFullTextSearchProvider $provider) {
		$this->provider = $provider;
	}

	/**
	 * @return IFullTextSearchProvider
	 */
	public function getProvider() {
		return $this->provider;
	}


	/**
	 * @return IFullTextSearchPlatform
	 */
	public function getPlatform() {
		return $this->platform;
	}

	/**
	 * @param IFullTextSearchPlatform $platform
	 */
	public function setPlatform($platform) {
		$this->platform = $platform;
	}


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

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


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

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


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

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


	/**
	 * @return bool
	 */
	public function isTimedOut() {
		return $this->timedOut;
	}

	/**
	 * @param bool $timedOut
	 */
	public function setTimedOut($timedOut) {
		$this->timedOut = $timedOut;
	}


	/**
	 * @return SearchRequest
	 */
	public function getRequest() {
		return $this->request;
	}

	/**
	 * @param SearchRequest $request
	 */
	public function setRequest($request) {
		$this->request = $request;
	}


	/**
	 * @return array<string,array<string,string>|IndexDocument[]|integer>

	 */
	public function jsonSerialize() {

		$provider = $this->getProvider();
		$platform = $this->getPlatform();

		return [
			'provider'  => [
				'id'      => $provider->getId(),
				'name'    => $provider->getName(),
				'version' => $provider->getVersion()
			],
			'platform'  => [
				'id'      => $platform->getId(),
				'name'    => $platform->getName(),
				'version' => $platform->getVersion()
			],
			'documents' => $this->getDocuments(),
			'meta'      =>
				[
					'timedOut' => $this->isTimedOut(),
					'time'     => $this->getTime(),
					'count'    => $this->getCount(),
					'total'    => $this->getTotal(),
					'maxScore' => $this->getMaxScore()
				]
		];
	}
}

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\IFullTextSearchPlatform;
30			use OCA\FullTextSearch\IFullTextSearchProvider;
31
32			class SearchResult implements \JsonSerializable {
33
34			/** @var IndexDocument[] */
35			private $documents = [];
36
37			/** @var string */
38			private $rawResult;
39
40			/** @var IFullTextSearchProvider */
41			private $provider;
42
43			/** @var IFullTextSearchPlatform */
44			private $platform;
45
46			/** @var int */
47			private $total;
48
49			/** @var int */
50			private $maxScore;
51
52			/** @var int */
53			private $time;
54
55			/** @var boolean */
56			private $timedOut;
57
58			/** @var SearchRequest */
59			private $request;
60
61
62			public function __construct() {
63			}
64
65
66			/**
67			* @param IndexDocument[] $documents
68			*
69			* @return $this
70			*/
71			public function setDocuments($documents) {
72			$this->documents = $documents;
73
74			return $this;
75			}
76
77			/**
78			* @return IndexDocument[]
79			*/
80			public function getDocuments() {
81			return $this->documents;
82			}
83
84			/**
85			* @param IndexDocument $document
86			*
87			* @return $this
88			*/
89			public function addDocument(IndexDocument $document) {
90			$this->documents[] = $document;
91
92			return $this;
93			}
94
95			/**
96			* @return int
97			*/
98			public function getCount() {
99			return count($this->documents);
100			}
101
102
103			/**
104			* @param string $result
105			*/
106			public function setRawResult($result) {
107			$this->rawResult = $result;
108			}
109
110			/**
111			* @return string
112			*/
113			public function getRawResult() {
114			return $this->rawResult;
115			}
116
117
118			/**
119			* @param IFullTextSearchProvider $provider
120			*/
121			public function setProvider(IFullTextSearchProvider $provider) {
122			$this->provider = $provider;
123			}
124
125			/**
126			* @return IFullTextSearchProvider
127			*/
128			public function getProvider() {
129			return $this->provider;
130			}
131
132
133			/**
134			* @return IFullTextSearchPlatform
135			*/
136			public function getPlatform() {
137			return $this->platform;
138			}
139
140			/**
141			* @param IFullTextSearchPlatform $platform
142			*/
143			public function setPlatform($platform) {
144			$this->platform = $platform;
145			}
146
147
148			/**
149			* @return int
150			*/
151			public function getTotal() {
152			return $this->total;
153			}
154
155			/**
156			* @param int $total
157			*/
158			public function setTotal($total) {
159			$this->total = $total;
160			}
161
162
163			/**
164			* @return int
165			*/
166			public function getMaxScore() {
167			return $this->maxScore;
168			}
169
170			/**
171			* @param int $maxScore
172			*/
173			public function setMaxScore($maxScore) {
174			$this->maxScore = $maxScore;
175			}
176
177
178			/**
179			* @return int
180			*/
181			public function getTime() {
182			return $this->time;
183			}
184
185			/**
186			* @param int $time
187			*/
188			public function setTime($time) {
189			$this->time = $time;
190			}
191
192
193			/**
194			* @return bool
195			*/
196			public function isTimedOut() {
197			return $this->timedOut;
198			}
199
200			/**
201			* @param bool $timedOut
202			*/
203			public function setTimedOut($timedOut) {
204			$this->timedOut = $timedOut;
205			}
206
207
208			/**
209			* @return SearchRequest
210			*/
211			public function getRequest() {
212			return $this->request;
213			}
214
215			/**
216			* @param SearchRequest $request
217			*/
218			public function setRequest($request) {
219			$this->request = $request;
220			}
221
222
223			/**
224			* @return array<string,array<string,string>\|IndexDocument[]\|integer>
			0 ignored issues – show Documentation introduced 2018-01-10 22:09 UTC by Report Bug Copy Issue Report Should the return type not be `array<string,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...
225			*/
226			public function jsonSerialize() {
227
228			$provider = $this->getProvider();
229			$platform = $this->getPlatform();
230
231			return [
232			'provider' => [
233			'id' => $provider->getId(),
234			'name' => $provider->getName(),
235			'version' => $provider->getVersion()
236			],
237			'platform' => [
238			'id' => $platform->getId(),
239			'name' => $platform->getName(),
240			'version' => $platform->getVersion()
241			],
242			'documents' => $this->getDocuments(),
243			'meta' =>
244			[
245			'timedOut' => $this->isTimedOut(),
246			'time' => $this->getTime(),
247			'count' => $this->getCount(),
248			'total' => $this->getTotal(),
249			'maxScore' => $this->getMaxScore()
250			]
251			];
252			}
253			}

nextcloud / fulltextsearch

Push — master ( 17927a...312875 )

SearchResult::getPlatform() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like