AbstractPlaceSearchRequest::buildQuery() - Code Metrics - Inspection of "Merge pull request #6 from koertho/patch-1" - bresam/ivory-google-map - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 39762b...5dff0a )

by Samuel

created 2020-07-13 08:21 UTC

AbstractPlaceSearchRequest::buildQuery() B

↳ Parent: AbstractPlaceSearchRequest

Complexity

Conditions	8
Paths	128

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	8.013

Importance

Changes

Metric	Value
dl	0
loc	34
ccs	16
cts	17
cp	0.9412
rs	7.9448
c	0
b	0
f	0
cc	8
nc	128
nop	0
crap	8.013

<?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 null !== $this->location;
    }

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

    public function setLocation(Coordinate $location = null)
    {
        $this->location = $location;
    }

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

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

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

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

    /**
     * @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 null !== $this->maxPrice;
    }

    /**
     * @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 null !== $this->openNow;
    }

    /**
     * @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 null !== $this->type;
    }

    /**
     * @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 null !== $this->language;
    }

    /**
     * @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;
    }

    /**
     * @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	56	public function hasLocation()
60		{
61	56	return null !== $this->location;
62		}
63
64		/**
65		* @return Coordinate\|null
66		*/
67	12	public function getLocation()
68		{
69	12	return $this->location;
70		}
71
72	28	public function setLocation(Coordinate $location = null)
73		{
74	28	$this->location = $location;
75	28	}
76
77		/**
78		* @return bool
79		*/
80	52	public function hasRadius()
81		{
82	52	return null !== $this->radius;
83		}
84
85		/**
86		* @return float
87		*/
88	8	public function getRadius()
89		{
90	8	return $this->radius;
91		}
92
93		/**
94		* @param float $radius
95		*/
96	28	public function setRadius($radius)
97		{
98	28	$this->radius = $radius;
99	28	}
100
101		/**
102		* @return bool
103		*/
104	52	public function hasMinPrice()
105		{
106	52	return null !== $this->minPrice;
107		}
108
109		/**
110		* @return int\|null
111		*/
112	8	public function getMinPrice()
113		{
114	8	return $this->minPrice;
115		}
116
117		/**
118		* @param int\|null $minPrice
119		*/
120	8	public function setMinPrice($minPrice)
121		{
122	8	$this->minPrice = $minPrice;
123	8	}
124
125		/**
126		* @return bool
127		*/
128	52	public function hasMaxPrice()
129		{
130	52	return null !== $this->maxPrice;
131		}
132
133		/**
134		* @return int\|null
135		*/
136	8	public function getMaxPrice()
137		{
138	8	return $this->maxPrice;
139		}
140
141		/**
142		* @param int\|null $maxPrice
143		*/
144	8	public function setMaxPrice($maxPrice)
145		{
146	8	$this->maxPrice = $maxPrice;
147	8	}
148
149		/**
150		* @return bool
151		*/
152	52	public function hasOpenNow()
153		{
154	52	return null !== $this->openNow;
155		}
156
157		/**
158		* @return bool\|null
159		*/
160	8	public function isOpenNow()
161		{
162	8	return $this->openNow;
163		}
164
165		/**
166		* @param bool\|null $openNow
167		*/
168	4	public function setOpenNow($openNow)
169		{
170	4	$this->openNow = $openNow;
171	4	}
172
173		/**
174		* @return bool
175		*/
176	52	public function hasType()
177		{
178	52	return null !== $this->type;
179		}
180
181		/**
182		* @return string\|null
183		*/
184	8	public function getType()
185		{
186	8	return $this->type;
187		}
188
189		/**
190		* @param string\|null $type
191		*/
192	8	public function setType($type)
193		{
194	8	$this->type = $type;
195	8	}
196
197		/**
198		* @return bool
199		*/
200	52	public function hasLanguage()
201		{
202	52	return null !== $this->language;
203		}
204
205		/**
206		* @return string\|null
207		*/
208	8	public function getLanguage()
209		{
210	8	return $this->language;
211		}
212
213		/**
214		* @param string\|null $language
215		*/
216	8	public function setLanguage($language)
217		{
218	8	$this->language = $language;
219	8	}
220
221		/**
222		* {@inheritdoc}
223		*/
224	44	public function buildQuery()
225		{
226	44	$query = [];
227
228	44	if ($this->hasLocation()) {
229	8	$query['location'] = $this->buildCoordinate($this->location);
		0 ignored issues – show Bug introduced 2020-05-14 20:01 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...
230		}
231
232	44	if ($this->hasRadius()) {
233	4	$query['radius'] = $this->radius;
234		}
235
236	44	if ($this->hasMinPrice()) {
237	4	$query['minprice'] = $this->minPrice;
238		}
239
240	44	if ($this->hasMaxPrice()) {
241	4	$query['maxprice'] = $this->maxPrice;
242		}
243
244	44	if ($this->hasOpenNow()) {
245		$query['opennow'] = $this->openNow;
246		}
247
248	44	if ($this->hasType()) {
249	4	$query['type'] = $this->type;
250		}
251
252	44	if ($this->hasLanguage()) {
253	4	$query['language'] = $this->language;
254		}
255
256	44	return $query;
257		}
258
259		/**
260		* @return string
261		*/
262	8	private function buildCoordinate(Coordinate $place)
263		{
264	8	return $place->getLatitude().','.$place->getLongitude();
265		}
266		}
267

bresam / ivory-google-map

Push — master ( 39762b...5dff0a )

AbstractPlaceSearchRequest::buildQuery() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like