SearchRequest::setQ() - Code Metrics - Inspection of "Update CHANGELOG" - webeweb/geo-api-library - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 97fc71...726d4b )

by WEBEWEB

created 2021-04-13 17:11 UTC

SearchRequest::setQ() A

↳ Parent: SearchRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/*
 * This file is part of the geo-api-library package.
 *
 * (c) 2020 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Library\GeoAPI\Request\Adresse;

use WBW\Library\Core\Model\Attribute\StringTypeTrait;
use WBW\Library\GeoAPI\Model\Attribute\FloatLatTrait;
use WBW\Library\GeoAPI\Model\Attribute\FloatLonTrait;
use WBW\Library\GeoAPI\Request\AbstractRequest;

/**
 * Search request.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Library\GeoAPI\Request\Adresse
 */
class SearchRequest extends AbstractRequest {

    use FloatLatTrait;
    use FloatLonTrait;
    use StringTypeTrait;

    /**
     * Resource path.
     *
     * @var string
     */
    const RESOURCE_PATH = "/search/";

    /**
     * Type "house number".
     *
     * @var string
     */
    const TYPE_HOUSE_NUMBER = "housenumber";

    /**
     * Type "locality".
     *
     * @var string
     */
    const TYPE_LOCALITY = "locality";

    /**
     * Type "municipality".
     *
     * @var string
     */
    const TYPE_MUNICIPALITY = "municipality";

    /**
     * Type "street".
     *
     * @var string
     */
    const TYPE_STREET = "street";

    /**
     * Autocomplete.
     *
     * @var bool|null
     */
    private $autocomplete;

    /**
     * City code.
     *
     * @var string|null
     */
    private $cityCode;

    /**
     * Limit.
     *
     * @var int|null
     */
    private $limit;

    /**
     * Postcode.
     *
     * @var string|null
     */
    private $postcode;

    /**
     * Query.
     *
     * @var string|null
     */
    private $q;

    /**
     * Constructor.
     *
     * @param string|null $q The query.
     */
    public function __construct(string $q = null) {
        parent::__construct();
        $this->setQ($q);
    }

    /**
     * Enumerates the types.
     *
     * @return string[] Returns the types.
     */
    public static function enumTypes(): array {
        return [
            self::TYPE_HOUSE_NUMBER,
            self::TYPE_LOCALITY,
            self::TYPE_MUNICIPALITY,
            self::TYPE_STREET,
        ];
    }

    /**
     * Get the autocomplete.
     *
     * @return bool|null Returns the autocomplete.
     */
    public function getAutocomplete(): ?bool {
        return $this->autocomplete;
    }

    /**
     * Get the city code.
     *
     * @return string|null Returns the city code.
     */
    public function getCityCode(): ?string {
        return $this->cityCode;
    }

    /**
     * Get the limit.
     *
     * @return int|null Returns the limit.
     */
    public function getLimit(): ?int {
        return $this->limit;
    }

    /**
     * Get the postcode.
     *
     * @return string|null Returns the postcode.
     */
    public function getPostcode(): ?string {
        return $this->postcode;
    }

    /**
     * Get the query.
     *
     * @return string|null Returns the query.
     */
    public function getQ(): ?string {
        return $this->q;
    }

    /**
     * {@inheritDoc}
     */
    public function getResourcePath(): string {
        return self::RESOURCE_PATH;
    }

    /**
     * Get the autocomplete.
     *
     * @param bool|null $autocomplete The autocomplete.
     * @return SearchRequest Returns this search request.
     */
    public function setAutocomplete(?bool $autocomplete): SearchRequest {
        $this->autocomplete = $autocomplete;
        return $this;
    }

    /**
     * Set the city code.
     *
     * @param string|null $cityCode The city code.
     * @return SearchRequest Returns this search request.
     */
    public function setCityCode(?string $cityCode): SearchRequest {
        $this->cityCode = $cityCode;
        return $this;
    }

    /**
     * Set the limit.
     *
     * @param int|null $limit The limit.
     * @return SearchRequest Returns this search request.
     */
    public function setLimit(?int $limit): SearchRequest {
        $this->limit = $limit;
        return $this;
    }

    /**
     * Set the postcode.
     *
     * @param string|null $postcode The postcode.
     * @return SearchRequest Returns this search request.
     */
    public function setPostcode(?string $postcode): SearchRequest {
        $this->postcode = $postcode;
        return $this;
    }

    /**
     * Set the query.
     *
     * @param string|null $q The query.
     * @return SearchRequest Returns this search request.
     */
    public function setQ(?string $q): SearchRequest {
        $this->q = $q;
        return $this;
    }
}

1			<?php
2
3			/*
4			* This file is part of the geo-api-library package.
5			*
6			* (c) 2020 WEBEWEB
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace WBW\Library\GeoAPI\Request\Adresse;
13
14			use WBW\Library\Core\Model\Attribute\StringTypeTrait;
15			use WBW\Library\GeoAPI\Model\Attribute\FloatLatTrait;
16			use WBW\Library\GeoAPI\Model\Attribute\FloatLonTrait;
17			use WBW\Library\GeoAPI\Request\AbstractRequest;
18
19			/**
20			* Search request.
21			*
22			* @author webeweb <https://github.com/webeweb/>
23			* @package WBW\Library\GeoAPI\Request\Adresse
24			*/
25			class SearchRequest extends AbstractRequest {
26
27			use FloatLatTrait;
28			use FloatLonTrait;
29			use StringTypeTrait;
30
31			/**
32			* Resource path.
33			*
34			* @var string
35			*/
36			const RESOURCE_PATH = "/search/";
37
38			/**
39			* Type "house number".
40			*
41			* @var string
42			*/
43			const TYPE_HOUSE_NUMBER = "housenumber";
44
45			/**
46			* Type "locality".
47			*
48			* @var string
49			*/
50			const TYPE_LOCALITY = "locality";
51
52			/**
53			* Type "municipality".
54			*
55			* @var string
56			*/
57			const TYPE_MUNICIPALITY = "municipality";
58
59			/**
60			* Type "street".
61			*
62			* @var string
63			*/
64			const TYPE_STREET = "street";
65
66			/**
67			* Autocomplete.
68			*
69			* @var bool\|null
70			*/
71			private $autocomplete;
72
73			/**
74			* City code.
75			*
76			* @var string\|null
77			*/
78			private $cityCode;
79
80			/**
81			* Limit.
82			*
83			* @var int\|null
84			*/
85			private $limit;
86
87			/**
88			* Postcode.
89			*
90			* @var string\|null
91			*/
92			private $postcode;
93
94			/**
95			* Query.
96			*
97			* @var string\|null
98			*/
99			private $q;
100
101			/**
102			* Constructor.
103			*
104			* @param string\|null $q The query.
105			*/
106			public function __construct(string $q = null) {
107			parent::__construct();
108			$this->setQ($q);
109			}
110
111			/**
112			* Enumerates the types.
113			*
114			* @return string[] Returns the types.
115			*/
116			public static function enumTypes(): array {
117			return [
118			self::TYPE_HOUSE_NUMBER,
119			self::TYPE_LOCALITY,
120			self::TYPE_MUNICIPALITY,
121			self::TYPE_STREET,
122			];
123			}
124
125			/**
126			* Get the autocomplete.
127			*
128			* @return bool\|null Returns the autocomplete.
129			*/
130			public function getAutocomplete(): ?bool {
131			return $this->autocomplete;
132			}
133
134			/**
135			* Get the city code.
136			*
137			* @return string\|null Returns the city code.
138			*/
139			public function getCityCode(): ?string {
140			return $this->cityCode;
141			}
142
143			/**
144			* Get the limit.
145			*
146			* @return int\|null Returns the limit.
147			*/
148			public function getLimit(): ?int {
149			return $this->limit;
150			}
151
152			/**
153			* Get the postcode.
154			*
155			* @return string\|null Returns the postcode.
156			*/
157			public function getPostcode(): ?string {
158			return $this->postcode;
159			}
160
161			/**
162			* Get the query.
163			*
164			* @return string\|null Returns the query.
165			*/
166			public function getQ(): ?string {
167			return $this->q;
168			}
169
170			/**
171			* {@inheritDoc}
172			*/
173			public function getResourcePath(): string {
174			return self::RESOURCE_PATH;
175			}
176
177			/**
178			* Get the autocomplete.
179			*
180			* @param bool\|null $autocomplete The autocomplete.
181			* @return SearchRequest Returns this search request.
182			*/
183			public function setAutocomplete(?bool $autocomplete): SearchRequest {
184			$this->autocomplete = $autocomplete;
185			return $this;
186			}
187
188			/**
189			* Set the city code.
190			*
191			* @param string\|null $cityCode The city code.
192			* @return SearchRequest Returns this search request.
193			*/
194			public function setCityCode(?string $cityCode): SearchRequest {
195			$this->cityCode = $cityCode;
196			return $this;
197			}
198
199			/**
200			* Set the limit.
201			*
202			* @param int\|null $limit The limit.
203			* @return SearchRequest Returns this search request.
204			*/
205			public function setLimit(?int $limit): SearchRequest {
206			$this->limit = $limit;
207			return $this;
208			}
209
210			/**
211			* Set the postcode.
212			*
213			* @param string\|null $postcode The postcode.
214			* @return SearchRequest Returns this search request.
215			*/
216			public function setPostcode(?string $postcode): SearchRequest {
217			$this->postcode = $postcode;
218			return $this;
219			}
220
221			/**
222			* Set the query.
223			*
224			* @param string\|null $q The query.
225			* @return SearchRequest Returns this search request.
226			*/
227			public function setQ(?string $q): SearchRequest {
228			$this->q = $q;
229			return $this;
230			}
231			}

webeweb / geo-api-library

Push — master ( 97fc71...726d4b )

SearchRequest::setQ() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like