Results::getResultsMetadata() - Code Metrics - Inspection of "create results metadata model, add to results mode..." - groupby/api-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — SR-1041 ( c8cc1c...ff7836 )

unknown

created 2017-08-28 18:57 UTC

Results::getResultsMetadata() A

↳ Parent: Results

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace GroupByInc\API\Model;

use JMS\Serializer\Annotation as JMS;

class Results
{
  /**
   * @var string
   * @JMS\Type("string")
   */
  public $id;
  /**
   * @var int
   * @JMS\Type("integer")
   */
  public $totalRecordCount;
  /**
   * @var string
   * @JMS\Type("string")
   */
  public $area;
  /**
   * @var string
   * @JMS\Type("string")
   */
  public $biasingProfile;
  /**
   * @var string
   * @JMS\Type("string")
   */
  public $redirect;
  /**
   * @var string
   * @JMS\Type("string")
   */
  public $errors;
  /**
   * @var string
   * @JMS\Type("string")
   */
  public $query;
  /**
   * @var string
   * @JMS\Type("string")
   */
  public $originalQuery;
  /**
   * @var string
   * @JMS\Type("string")
   */
  public $correctedQuery;

  /**
   * @var Template
   * @JMS\Type("GroupByInc\API\Model\Template")
   */
  public $template;
  /**
   * @var PageInfo
   * @JMS\Type("GroupByInc\API\Model\PageInfo")
   */
  public $pageInfo;
  /**
   * @var Navigation[]
   * @JMS\Type("array<GroupByInc\API\Model\Navigation>")
   */
  public $availableNavigation = array();
  /**
   * @var Navigation[]
   * @JMS\Type("array<GroupByInc\API\Model\Navigation>")
   */
  public $selectedNavigation = array();

  /**
   * @var Record[]
   * @JMS\Type("array<GroupByInc\API\Model\Record>")
   */
  public $records = array();
  /**
   * @var string[]
   * @JMS\Type("array<string>")
   */
  public $didYouMean = array();
  /**
   * @var string[]
   * @JMS\Type("array<string>")
   */
  public $relatedQueries = array();
  /**
   * @var string[]
   * @JMS\Type("array<string>")
   */
  public $rewrites = array();
  /**
   * @var Metadata[]
   * @JMS\Type("array<GroupByInc\API\Model\Metadata>")
   */
  public $siteParams = array();

  /**
   * @var string[]
   * @JMS\Type("array<string>")
   */
  public $warnings = array();

  /**
   * @var ResultsMetadata
   * @JMS\Type("GroupByInc\API\Model\ResultsMetadata")
   */
  public $resultsMetadata;

  /**
   * @return string The ID of the response.
   */
  public function getId()
  {
    return $this->id;
  }

  /**
   * @param string $id Set the response ID.
   */
  public function setId($id)
  {
    $this->id = $id;
  }

  /**
   * @return string[] A list of spell corrections based on the search term.
   */
  public function getDidYouMean()
  {
    return $this->didYouMean;
  }

  /**
   * @param string[] $didYouMean Set the list.
   */
  public function setDidYouMean($didYouMean)
  {
    $this->didYouMean = $didYouMean;
  }

  /**
   * @return string[] A list of related queries for a given search term.
   */
  public function getRelatedQueries()
  {
    return $this->relatedQueries;
  }

  /**
   * @param string[] $relatedQueries Set the related queries for a search term.
   */
  public function setRelatedQueries($relatedQueries)
  {
    $this->relatedQueries = $relatedQueries;
  }

  /**
   * @return Record[] A list of the records for this search and navigation state.
   */
  public function getRecords()
  {
    return $this->records;
  }

  /**
   * @param Record[] $records Set the records.
   */
  public function setRecords($records)
  {
    $this->records = $records;
  }

  /**
   * @return Template If a rule has fired, the associated template will be returned.
   */
  public function getTemplate()
  {
    return $this->template;
  }

  /**
   * @param Template $template Set the template.
   */
  public function setTemplate($template)
  {
    $this->template = $template;
  }

  /**
   * @return PageInfo Information about the results page.
   */
  public function getPageInfo()
  {
    return $this->pageInfo;
  }

  /**
   * @param PageInfo $pageInfo Set the page info.
   */
  public function setPageInfo($pageInfo)
  {
    $this->pageInfo = $pageInfo;
  }

  /**
   * @return Navigation[] A list of all the ways in which you can filter the current result set.
   */
  public function getAvailableNavigation()
  {
    return $this->availableNavigation;
  }

  /**
   * @param Navigation[] $availableNavigation Set the available navigation.
   */
  public function setAvailableNavigation($availableNavigation)
  {
    $this->availableNavigation = $availableNavigation;
  }

  /**
   * @return Navigation[] A list of the currently selected navigations. Also known as breadcrumbs.
   */
  public function getSelectedNavigation()
  {
    return $this->selectedNavigation;
  }

  /**
   * @param Navigation[] $selectedNavigation Set the selected navigations.
   */
  public function setSelectedNavigation($selectedNavigation)
  {
    $this->selectedNavigation = $selectedNavigation;
  }

  /**
   * @return string A URL to redirect to based on this search term.
   */
  public function getRedirect()
  {
    return $this->redirect;
  }

  /**
   * @param string $redirect Set the redirect.
   */
  public function setRedirect($redirect)
  {
    $this->redirect = $redirect;
  }

  /**
   * @return string representation of any errors encountered.
   */
  public function getErrors()
  {
    return $this->errors;
  }

  /**
   * @param string $errors Set errors.
   */
  public function setErrors($errors)
  {
    $this->errors = $errors;
  }

  /**
   * @return int A count of the total number of records in this search and navigation state.
   */
  public function getTotalRecordCount()
  {
    return $this->totalRecordCount;
  }

  /**
   * @param int $totalRecordCount Set the total record count.
   */
  public function setTotalRecordCount($totalRecordCount)
  {
    $this->totalRecordCount = $totalRecordCount;
  }

  /**
   * @return Metadata[] A list of metadata as set in the area management section of the command center.
   */
  public function getSiteParams()
  {
    return $this->siteParams;
  }

  /**
   * @param Metadata[] $siteParams Set the site metadata.
   */
  public function setSiteParams($siteParams)
  {
    $this->siteParams = $siteParams;
  }

  /**
   * @return string The query sent to the bridge.
   */
  public function getQuery()
  {
    return $this->query;
  }

  /**
   * @param string $query Sets the query to the bridge.
   */
  public function setQuery($query)
  {
    $this->query = $query;
  }

  /**
   * @return string The original query sent to the search service.
   */
  public function getOriginalQuery()
  {
    return $this->originalQuery;
  }

  /**
   * @param string $originalQuery Sets the original query sent to the search service.
   */
  public function setOriginalQuery($originalQuery)
  {
    $this->originalQuery = $originalQuery;
  }

  /**
   * @return string The corrected query sent to the engine, if auto-correction is enabled.
   */
  public function getCorrectedQuery()
  {
    return $this->correctedQuery;
  }

  /**
   * @param string $correctedQuery Sets the corrected query sent to the engine, if auto-correction is enabled.
   */
  public function setCorrectedQuery($correctedQuery)
  {
    $this->correctedQuery = $correctedQuery;
  }

  /**
   * @return string[] A list of rewrites (spellings, synonyms, etc...) that occurred.
   */
  public function getRewrites()
  {
    return $this->rewrites;
  }

  /**
   * @param string[] $rewrites Sets the rewrites that occurred.
   */
  public function setRewrites($rewrites)
  {
    $this->rewrites = $rewrites;
  }

  /**
   * @return string The area that the search fired against.
   */
  public function getArea()
  {
    return $this->area;
  }

  /**
   * @param string $area Sets the area.
   */
  public function setArea($area)
  {
    $this->area = $area;
  }

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

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

  /**
   * @return string[]
   */
  public function getWarnings()
  {
    return $this->warnings;
  }

  /**
   * @param string[] $warnings
   */
  public function setWarnings($warnings)
  {
    $this->warnings = $warnings;
  }

  /**
   * @return ResultsMetadata
   */
  public function getResultsMetadata()
  {
    return $this->resultsMetadata;
  }

  /**
   * @param ResultsMetadata $resultsMetadata
   */
  public function setResultsMetadata($resultsMetadata)
  {
    $this->resultsMetadata = $resultsMetadata;
  }
}


1			<?php
2
3			namespace GroupByInc\API\Model;
4
5			use JMS\Serializer\Annotation as JMS;
6
7			class Results
8			{
9			/**
10			* @var string
11			* @JMS\Type("string")
12			*/
13			public $id;
14			/**
15			* @var int
16			* @JMS\Type("integer")
17			*/
18			public $totalRecordCount;
19			/**
20			* @var string
21			* @JMS\Type("string")
22			*/
23			public $area;
24			/**
25			* @var string
26			* @JMS\Type("string")
27			*/
28			public $biasingProfile;
29			/**
30			* @var string
31			* @JMS\Type("string")
32			*/
33			public $redirect;
34			/**
35			* @var string
36			* @JMS\Type("string")
37			*/
38			public $errors;
39			/**
40			* @var string
41			* @JMS\Type("string")
42			*/
43			public $query;
44			/**
45			* @var string
46			* @JMS\Type("string")
47			*/
48			public $originalQuery;
49			/**
50			* @var string
51			* @JMS\Type("string")
52			*/
53			public $correctedQuery;
54
55			/**
56			* @var Template
57			* @JMS\Type("GroupByInc\API\Model\Template")
58			*/
59			public $template;
60			/**
61			* @var PageInfo
62			* @JMS\Type("GroupByInc\API\Model\PageInfo")
63			*/
64			public $pageInfo;
65			/**
66			* @var Navigation[]
67			* @JMS\Type("array<GroupByInc\API\Model\Navigation>")
68			*/
69			public $availableNavigation = array();
70			/**
71			* @var Navigation[]
72			* @JMS\Type("array<GroupByInc\API\Model\Navigation>")
73			*/
74			public $selectedNavigation = array();
75
76			/**
77			* @var Record[]
78			* @JMS\Type("array<GroupByInc\API\Model\Record>")
79			*/
80			public $records = array();
81			/**
82			* @var string[]
83			* @JMS\Type("array<string>")
84			*/
85			public $didYouMean = array();
86			/**
87			* @var string[]
88			* @JMS\Type("array<string>")
89			*/
90			public $relatedQueries = array();
91			/**
92			* @var string[]
93			* @JMS\Type("array<string>")
94			*/
95			public $rewrites = array();
96			/**
97			* @var Metadata[]
98			* @JMS\Type("array<GroupByInc\API\Model\Metadata>")
99			*/
100			public $siteParams = array();
101
102			/**
103			* @var string[]
104			* @JMS\Type("array<string>")
105			*/
106			public $warnings = array();
107
108			/**
109			* @var ResultsMetadata
110			* @JMS\Type("GroupByInc\API\Model\ResultsMetadata")
111			*/
112			public $resultsMetadata;
113
114			/**
115			* @return string The ID of the response.
116			*/
117			public function getId()
118			{
119			return $this->id;
120			}
121
122			/**
123			* @param string $id Set the response ID.
124			*/
125			public function setId($id)
126			{
127			$this->id = $id;
128			}
129
130			/**
131			* @return string[] A list of spell corrections based on the search term.
132			*/
133			public function getDidYouMean()
134			{
135			return $this->didYouMean;
136			}
137
138			/**
139			* @param string[] $didYouMean Set the list.
140			*/
141			public function setDidYouMean($didYouMean)
142			{
143			$this->didYouMean = $didYouMean;
144			}
145
146			/**
147			* @return string[] A list of related queries for a given search term.
148			*/
149			public function getRelatedQueries()
150			{
151			return $this->relatedQueries;
152			}
153
154			/**
155			* @param string[] $relatedQueries Set the related queries for a search term.
156			*/
157			public function setRelatedQueries($relatedQueries)
158			{
159			$this->relatedQueries = $relatedQueries;
160			}
161
162			/**
163			* @return Record[] A list of the records for this search and navigation state.
164			*/
165			public function getRecords()
166			{
167			return $this->records;
168			}
169
170			/**
171			* @param Record[] $records Set the records.
172			*/
173			public function setRecords($records)
174			{
175			$this->records = $records;
176			}
177
178			/**
179			* @return Template If a rule has fired, the associated template will be returned.
180			*/
181			public function getTemplate()
182			{
183			return $this->template;
184			}
185
186			/**
187			* @param Template $template Set the template.
188			*/
189			public function setTemplate($template)
190			{
191			$this->template = $template;
192			}
193
194			/**
195			* @return PageInfo Information about the results page.
196			*/
197			public function getPageInfo()
198			{
199			return $this->pageInfo;
200			}
201
202			/**
203			* @param PageInfo $pageInfo Set the page info.
204			*/
205			public function setPageInfo($pageInfo)
206			{
207			$this->pageInfo = $pageInfo;
208			}
209
210			/**
211			* @return Navigation[] A list of all the ways in which you can filter the current result set.
212			*/
213			public function getAvailableNavigation()
214			{
215			return $this->availableNavigation;
216			}
217
218			/**
219			* @param Navigation[] $availableNavigation Set the available navigation.
220			*/
221			public function setAvailableNavigation($availableNavigation)
222			{
223			$this->availableNavigation = $availableNavigation;
224			}
225
226			/**
227			* @return Navigation[] A list of the currently selected navigations. Also known as breadcrumbs.
228			*/
229			public function getSelectedNavigation()
230			{
231			return $this->selectedNavigation;
232			}
233
234			/**
235			* @param Navigation[] $selectedNavigation Set the selected navigations.
236			*/
237			public function setSelectedNavigation($selectedNavigation)
238			{
239			$this->selectedNavigation = $selectedNavigation;
240			}
241
242			/**
243			* @return string A URL to redirect to based on this search term.
244			*/
245			public function getRedirect()
246			{
247			return $this->redirect;
248			}
249
250			/**
251			* @param string $redirect Set the redirect.
252			*/
253			public function setRedirect($redirect)
254			{
255			$this->redirect = $redirect;
256			}
257
258			/**
259			* @return string representation of any errors encountered.
260			*/
261			public function getErrors()
262			{
263			return $this->errors;
264			}
265
266			/**
267			* @param string $errors Set errors.
268			*/
269			public function setErrors($errors)
270			{
271			$this->errors = $errors;
272			}
273
274			/**
275			* @return int A count of the total number of records in this search and navigation state.
276			*/
277			public function getTotalRecordCount()
278			{
279			return $this->totalRecordCount;
280			}
281
282			/**
283			* @param int $totalRecordCount Set the total record count.
284			*/
285			public function setTotalRecordCount($totalRecordCount)
286			{
287			$this->totalRecordCount = $totalRecordCount;
288			}
289
290			/**
291			* @return Metadata[] A list of metadata as set in the area management section of the command center.
292			*/
293			public function getSiteParams()
294			{
295			return $this->siteParams;
296			}
297
298			/**
299			* @param Metadata[] $siteParams Set the site metadata.
300			*/
301			public function setSiteParams($siteParams)
302			{
303			$this->siteParams = $siteParams;
304			}
305
306			/**
307			* @return string The query sent to the bridge.
308			*/
309			public function getQuery()
310			{
311			return $this->query;
312			}
313
314			/**
315			* @param string $query Sets the query to the bridge.
316			*/
317			public function setQuery($query)
318			{
319			$this->query = $query;
320			}
321
322			/**
323			* @return string The original query sent to the search service.
324			*/
325			public function getOriginalQuery()
326			{
327			return $this->originalQuery;
328			}
329
330			/**
331			* @param string $originalQuery Sets the original query sent to the search service.
332			*/
333			public function setOriginalQuery($originalQuery)
334			{
335			$this->originalQuery = $originalQuery;
336			}
337
338			/**
339			* @return string The corrected query sent to the engine, if auto-correction is enabled.
340			*/
341			public function getCorrectedQuery()
342			{
343			return $this->correctedQuery;
344			}
345
346			/**
347			* @param string $correctedQuery Sets the corrected query sent to the engine, if auto-correction is enabled.
348			*/
349			public function setCorrectedQuery($correctedQuery)
350			{
351			$this->correctedQuery = $correctedQuery;
352			}
353
354			/**
355			* @return string[] A list of rewrites (spellings, synonyms, etc...) that occurred.
356			*/
357			public function getRewrites()
358			{
359			return $this->rewrites;
360			}
361
362			/**
363			* @param string[] $rewrites Sets the rewrites that occurred.
364			*/
365			public function setRewrites($rewrites)
366			{
367			$this->rewrites = $rewrites;
368			}
369
370			/**
371			* @return string The area that the search fired against.
372			*/
373			public function getArea()
374			{
375			return $this->area;
376			}
377
378			/**
379			* @param string $area Sets the area.
380			*/
381			public function setArea($area)
382			{
383			$this->area = $area;
384			}
385
386			/**
387			* @return string
388			*/
389			public function getBiasingProfile()
390			{
391			return $this->biasingProfile;
392			}
393
394			/**
395			* @param string $biasingProfile
396			*/
397			public function setBiasingProfile($biasingProfile)
398			{
399			$this->biasingProfile = $biasingProfile;
400			}
401
402			/**
403			* @return string[]
404			*/
405			public function getWarnings()
406			{
407			return $this->warnings;
408			}
409
410			/**
411			* @param string[] $warnings
412			*/
413			public function setWarnings($warnings)
414			{
415			$this->warnings = $warnings;
416			}
417
418			/**
419			* @return ResultsMetadata
420			*/
421			public function getResultsMetadata()
422			{
423			return $this->resultsMetadata;
424			}
425
426			/**
427			* @param ResultsMetadata $resultsMetadata
428			*/
429			public function setResultsMetadata($resultsMetadata)
430			{
431			$this->resultsMetadata = $resultsMetadata;
432			}
433			}
434

groupby / api-php

Push — SR-1041 ( c8cc1c...ff7836 )

Results::getResultsMetadata() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like