AbstractPlaceSearchRequest::buildQuery() - Code Metrics - Inspection of "[Service] Add Place support" - egeloen/ivory-google-map - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — place-services ( fedba7 )

by Eric

created 2016-08-27 19:38 UTC

AbstractPlaceSearchRequest::buildQuery() D

↳ Parent: AbstractPlaceSearchRequest

Complexity

Conditions	8
Paths	128

Size

Total Lines	34
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	34
rs	4.6666
cc	8
eloc	17
nc	128
nop	0

<?php

/*
 * This file is part of the Ivory Google Map package.
 *
 * (c) Eric GELOEN <[email protected]>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace Ivory\GoogleMap\Service\Place\Search\Request;

use Ivory\GoogleMap\Base\Coordinate;

/**
 * @author GeLo <[email protected]>
 */
abstract class AbstractPlaceSearchRequest implements PlaceSearchRequestInterface
{
    /**
     * @var Coordinate|null
     */
    private $location;

    /**
     * @var float|null
     */
    private $radius;

    /**
     * @var int|null
     */
    private $minPrice;

    /**
     * @var int|null
     */
    private $maxPrice;

    /**
     * @var bool|null
     */
    private $openNow;

    /**
     * @var string|null
     */
    private $type;

    /**
     * @var string|null
     */
    private $language;

    /**
     * @return bool
     */
    public function hasLocation()
    {
        return $this->location !== null;
    }

    /**
     * @return Coordinate|null
     */
    public function getLocation()
    {
        return $this->location;
    }

    /**
     * @param Coordinate|null $location
     */
    public function setLocation(Coordinate $location = null)
    {
        $this->location = $location;
    }

    /**
     * @return bool
     */
    public function hasRadius()
    {
        return $this->radius !== null;
    }

    /**
     * @return float
     */
    public function getRadius()
    {
        return $this->radius;
    }

    /**
     * @param float $radius
     */
    public function setRadius($radius)
    {
        $this->radius = $radius;
    }

    /**
     * @return bool
     */
    public function hasMinPrice()
    {
        return $this->minPrice !== null;
    }

    /**
     * @return int|null
     */
    public function getMinPrice()
    {
        return $this->minPrice;
    }

    /**
     * @param int|null $minPrice
     */
    public function setMinPrice($minPrice)
    {
        $this->minPrice = $minPrice;
    }

    /**
     * @return bool
     */
    public function hasMaxPrice()
    {
        return $this->maxPrice !== null;
    }

    /**
     * @return int|null
     */
    public function getMaxPrice()
    {
        return $this->maxPrice;
    }

    /**
     * @param int|null $maxPrice
     */
    public function setMaxPrice($maxPrice)
    {
        $this->maxPrice = $maxPrice;
    }

    /**
     * @return bool
     */
    public function hasOpenNow()
    {
        return $this->openNow !== null;
    }

    /**
     * @return bool|null
     */
    public function isOpenNow()
    {
        return $this->openNow;
    }

    /**
     * @param bool|null $openNow
     */
    public function setOpenNow($openNow)
    {
        $this->openNow = $openNow;
    }

    /**
     * @return bool
     */
    public function hasType()
    {
        return $this->type !== null;
    }

    /**
     * @return string|null
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @param string|null $type
     */
    public function setType($type)
    {
        $this->type = $type;
    }

    /**
     * @return bool
     */
    public function hasLanguage()
    {
        return $this->language !== null;
    }

    /**
     * @return string|null
     */
    public function getLanguage()
    {
        return $this->language;
    }

    /**
     * @param string|null $language
     */
    public function setLanguage($language)
    {
        $this->language = $language;
    }

    /**
     * {@inheritdoc}
     */
    public function buildQuery()
    {
        $query = [];

        if ($this->hasLocation()) {
            $query['location'] = $this->buildCoordinate($this->location);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        if ($this->hasRadius()) {
            $query['radius'] = $this->radius;
        }

        if ($this->hasMinPrice()) {
            $query['minprice'] = $this->minPrice;
        }

        if ($this->hasMaxPrice()) {
            $query['maxprice'] = $this->maxPrice;
        }

        if ($this->hasOpenNow()) {
            $query['opennow'] = $this->openNow;
        }

        if ($this->hasType()) {
            $query['type'] = $this->type;
        }

        if ($this->hasLanguage()) {
            $query['language'] = $this->language;
        }

        return $query;
    }

    /**
     * @param Coordinate $place
     *
     * @return string
     */
    private function buildCoordinate(Coordinate $place)
    {
        return $place->getLatitude().','.$place->getLongitude();
    }
}


1			<?php
2
3			/*
4			* This file is part of the Ivory Google Map package.
5			*
6			* (c) Eric GELOEN <[email protected]>
7			*
8			* For the full copyright and license information, please read the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Ivory\GoogleMap\Service\Place\Search\Request;
13
14			use Ivory\GoogleMap\Base\Coordinate;
15
16			/**
17			* @author GeLo <[email protected]>
18			*/
19			abstract class AbstractPlaceSearchRequest implements PlaceSearchRequestInterface
20			{
21			/**
22			* @var Coordinate\|null
23			*/
24			private $location;
25
26			/**
27			* @var float\|null
28			*/
29			private $radius;
30
31			/**
32			* @var int\|null
33			*/
34			private $minPrice;
35
36			/**
37			* @var int\|null
38			*/
39			private $maxPrice;
40
41			/**
42			* @var bool\|null
43			*/
44			private $openNow;
45
46			/**
47			* @var string\|null
48			*/
49			private $type;
50
51			/**
52			* @var string\|null
53			*/
54			private $language;
55
56			/**
57			* @return bool
58			*/
59			public function hasLocation()
60			{
61			return $this->location !== null;
62			}
63
64			/**
65			* @return Coordinate\|null
66			*/
67			public function getLocation()
68			{
69			return $this->location;
70			}
71
72			/**
73			* @param Coordinate\|null $location
74			*/
75			public function setLocation(Coordinate $location = null)
76			{
77			$this->location = $location;
78			}
79
80			/**
81			* @return bool
82			*/
83			public function hasRadius()
84			{
85			return $this->radius !== null;
86			}
87
88			/**
89			* @return float
90			*/
91			public function getRadius()
92			{
93			return $this->radius;
94			}
95
96			/**
97			* @param float $radius
98			*/
99			public function setRadius($radius)
100			{
101			$this->radius = $radius;
102			}
103
104			/**
105			* @return bool
106			*/
107			public function hasMinPrice()
108			{
109			return $this->minPrice !== null;
110			}
111
112			/**
113			* @return int\|null
114			*/
115			public function getMinPrice()
116			{
117			return $this->minPrice;
118			}
119
120			/**
121			* @param int\|null $minPrice
122			*/
123			public function setMinPrice($minPrice)
124			{
125			$this->minPrice = $minPrice;
126			}
127
128			/**
129			* @return bool
130			*/
131			public function hasMaxPrice()
132			{
133			return $this->maxPrice !== null;
134			}
135
136			/**
137			* @return int\|null
138			*/
139			public function getMaxPrice()
140			{
141			return $this->maxPrice;
142			}
143
144			/**
145			* @param int\|null $maxPrice
146			*/
147			public function setMaxPrice($maxPrice)
148			{
149			$this->maxPrice = $maxPrice;
150			}
151
152			/**
153			* @return bool
154			*/
155			public function hasOpenNow()
156			{
157			return $this->openNow !== null;
158			}
159
160			/**
161			* @return bool\|null
162			*/
163			public function isOpenNow()
164			{
165			return $this->openNow;
166			}
167
168			/**
169			* @param bool\|null $openNow
170			*/
171			public function setOpenNow($openNow)
172			{
173			$this->openNow = $openNow;
174			}
175
176			/**
177			* @return bool
178			*/
179			public function hasType()
180			{
181			return $this->type !== null;
182			}
183
184			/**
185			* @return string\|null
186			*/
187			public function getType()
188			{
189			return $this->type;
190			}
191
192			/**
193			* @param string\|null $type
194			*/
195			public function setType($type)
196			{
197			$this->type = $type;
198			}
199
200			/**
201			* @return bool
202			*/
203			public function hasLanguage()
204			{
205			return $this->language !== null;
206			}
207
208			/**
209			* @return string\|null
210			*/
211			public function getLanguage()
212			{
213			return $this->language;
214			}
215
216			/**
217			* @param string\|null $language
218			*/
219			public function setLanguage($language)
220			{
221			$this->language = $language;
222			}
223
224			/**
225			* {@inheritdoc}
226			*/
227			public function buildQuery()
228			{
229			$query = [];
230
231			if ($this->hasLocation()) {
232			$query['location'] = $this->buildCoordinate($this->location);
			0 ignored issues – show Bug introduced 2016-08-27 19:42 UTC by Report Bug Copy Issue Report It seems like `$this->location` can be `null`; however, `buildCoordinate()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
233			}
234
235			if ($this->hasRadius()) {
236			$query['radius'] = $this->radius;
237			}
238
239			if ($this->hasMinPrice()) {
240			$query['minprice'] = $this->minPrice;
241			}
242
243			if ($this->hasMaxPrice()) {
244			$query['maxprice'] = $this->maxPrice;
245			}
246
247			if ($this->hasOpenNow()) {
248			$query['opennow'] = $this->openNow;
249			}
250
251			if ($this->hasType()) {
252			$query['type'] = $this->type;
253			}
254
255			if ($this->hasLanguage()) {
256			$query['language'] = $this->language;
257			}
258
259			return $query;
260			}
261
262			/**
263			* @param Coordinate $place
264			*
265			* @return string
266			*/
267			private function buildCoordinate(Coordinate $place)
268			{
269			return $place->getLatitude().','.$place->getLongitude();
270			}
271			}
272

egeloen / ivory-google-map

GitHub Access Token became invalid

Push — place-services ( fedba7 )

AbstractPlaceSearchRequest::buildQuery() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like