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

Completed

Pull Request — master (#177)

by Eric

created 2016-08-27 19:40 UTC

PlaceDetailService::buildAlternativePlaceIds() A

↳ Parent: PlaceDetailService

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

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

<?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\Detail;

use Http\Client\HttpClient;
use Http\Message\MessageFactory;
use Ivory\GoogleMap\Base\Bound;
use Ivory\GoogleMap\Base\Coordinate;
use Ivory\GoogleMap\Service\AbstractParsableService;
use Ivory\GoogleMap\Service\Base\AddressComponent;
use Ivory\GoogleMap\Service\Base\Geometry;
use Ivory\GoogleMap\Service\Place\Base\AlternatePlaceId;
use Ivory\GoogleMap\Service\Place\Base\AspectRating;
use Ivory\GoogleMap\Service\Place\Base\OpenClosePeriod;
use Ivory\GoogleMap\Service\Place\Base\OpeningHours;
use Ivory\GoogleMap\Service\Place\Base\Period;
use Ivory\GoogleMap\Service\Place\Base\Photo;
use Ivory\GoogleMap\Service\Place\Base\Place;
use Ivory\GoogleMap\Service\Place\Base\Review;
use Ivory\GoogleMap\Service\Place\Detail\Request\PlaceDetailRequestInterface;
use Ivory\GoogleMap\Service\Place\Detail\Response\PlaceDetailResponse;
use Ivory\GoogleMap\Service\Utility\Parser;

/**
 * @author GeLo <[email protected]>
 */
class PlaceDetailService extends AbstractParsableService
{
    /**
     * @param HttpClient     $client
     * @param MessageFactory $messageFactory
     * @param Parser|null    $parser
     */
    public function __construct(HttpClient $client, MessageFactory $messageFactory, Parser $parser = null)
    {
        parent::__construct($client, $messageFactory, 'http://maps.googleapis.com/maps/api/place/details', $parser);
    }

    /**
     * {@inheritdoc}
     */
    public function setHttps($https)
    {
        if (!$https) {
            throw new \InvalidArgumentException('The http scheme is not supported.');
        }

        parent::setHttps($https);
    }

    /**
     * @param PlaceDetailRequestInterface $request
     *
     * @return PlaceDetailResponse
     */
    public function process(PlaceDetailRequestInterface $request)
    {
        $httpRequest = $this->createRequest($request);
        $httpResponse = $this->getClient()->sendRequest($httpRequest);

        $data = $this->parse((string) $httpResponse->getBody(), [
            'pluralization_rules' => [
                'address_component' => 'address_components',
                'aspect'            => 'aspects',
                'html_attribution'  => 'html_attributions',
                'period'            => 'periods',
                'photo'             => 'photos',
                'type'              => 'types',
                'review'            => 'reviews',
            ],
        ]);

        $response = $this->buildResponse($data);
        $response->setRequest($request);

        return $response;
    }

    /**
     * @param mixed[] $data
     *
     * @return PlaceDetailResponse
     */
    private function buildResponse(array $data)

    {
        $response = new PlaceDetailResponse();
        $response->setStatus($data['status']);

        if (isset($data['result'])) {
            $response->setResult($this->buildResult($data['result']));
        }

        if (isset($data['html_attributions'])) {
            $response->setHtmlAttributions($data['html_attributions']);
        }

        return $response;
    }

    /**
     * @param mixed[] $data
     *
     * @return Place
     */
    private function buildResult(array $data)
    {
        $result = new Place();
        $result->setId($data['id']);
        $result->setPlaceId($data['place_id']);
        $result->setName($data['name']);
        $result->setFormattedAddress($data['formatted_address']);
        $result->setFormattedPhoneNumber($data['formatted_phone_number']);
        $result->setInternationalPhoneNumber($data['international_phone_number']);
        $result->setUrl($data['url']);
        $result->setIcon($data['icon']);
        $result->setScope($data['scope']);
        $result->setRating($data['rating']);
        $result->setUtcOffset($data['utc_offset']);
        $result->setVicinity($data['vicinity']);
        $result->setWebsite($data['website']);
        $result->setTypes($data['types']);
        $result->setAddressComponents($this->buildAddressComponents($data['address_components']));
        $result->setPhotos($this->buildPhotos($data['photos']));
        $result->setGeometry($this->buildGeometry($data['geometry']));
        $result->setOpeningHours($this->buildOpeningHours($data['opening_hours']));
        $result->setReviews($this->buildReviews($data['reviews']));

        if (isset($data['price_level'])) {
            $result->setPriceLevel($data['price_level']);
        }

        if (isset($data['permanently_closed'])) {
            $result->setPermanentlyClose($data['permanently_closed']);
        }

        if (isset($data['alt_ids'])) {
            $result->setAlternatePlaceIds($this->buildAlternativePlaceIds($data['alt_ids']));
        }

        return $result;
    }

    /**
     * @param mixed[] $data
     *
     * @return AddressComponent[]
     */
    private function buildAddressComponents(array $data)
    {
        $addressComponents = [];

        foreach ($data as $addressComponent) {
            $addressComponents[] = $this->buildAddressComponent($addressComponent);
        }

        return $addressComponents;
    }

    /**
     * @param mixed[] $data
     *
     * @return AddressComponent
     */
    private function buildAddressComponent(array $data)

    {
        $address = new AddressComponent();
        $address->setLongName($data['long_name']);
        $address->setShortName($data['short_name']);
        $address->setTypes($data['types']);

        return $address;
    }

    /**
     * @param mixed[] $data
     *
     * @return Photo[]
     */
    private function buildPhotos(array $data)
    {
        $photos = [];

        foreach ($data as $photo) {
            $photos[] = $this->buildPhoto($photo);
        }

        return $photos;
    }

    /**
     * @param mixed[] $data
     *
     * @return Photo
     */
    private function buildPhoto(array $data)

    {
        $photo = new Photo();
        $photo->setReference($data['photo_reference']);
        $photo->setWidth($data['width']);
        $photo->setHeight($data['height']);
        $photo->setHtmlAttributions($data['html_attributions']);

        return $photo;
    }

    /**
     * @param mixed[] $data
     *
     * @return AlternatePlaceId[]
     */
    private function buildAlternativePlaceIds(array $data)
    {
        $alternativePlaceIds = [];

        foreach ($data as $alternativePlaceId) {
            $alternativePlaceIds[] = $this->buildAlternativePlaceId($alternativePlaceId);
        }

        return $alternativePlaceIds;
    }

    /**
     * @param mixed[] $data
     *
     * @return AlternatePlaceId
     */
    private function buildAlternativePlaceId(array $data)

    {
        $alternativePlaceId = new AlternatePlaceId();
        $alternativePlaceId->setPlaceId($data['place_id']);
        $alternativePlaceId->setScope($data['scope']);

        return $alternativePlaceId;
    }

    /**
     * @param mixed[] $data
     *
     * @return Review[]
     */
    private function buildReviews(array $data)
    {
        $reviews = [];

        foreach ($data as $review) {
            $reviews[] = $this->buildReview($review);
        }

        return $reviews;
    }

    /**
     * @param mixed[] $data
     *
     * @return Review
     */
    private function buildReview(array $data)
    {
        $review = new Review();
        $review->setAuthorName($data['author_name']);
        $review->setAuthorUrl($data['author_url']);
        $review->setText($data['text']);
        $review->setRating($data['rating']);
        $review->setTime(new \DateTime('@'.$data['time']));
        $review->setLanguage($data['language']);
        $review->setAspects($this->buildAspectRatings($data['aspects']));

        return $review;
    }

    /**
     * @param mixed[] $data
     *
     * @return AspectRating[]
     */
    private function buildAspectRatings(array $data)
    {
        $aspectRatings = [];

        foreach ($data as $aspectRating) {
            $aspectRatings[] = $this->buildAspectRating($aspectRating);
        }

        return $aspectRatings;
    }

    /**
     * @param mixed[] $data
     *
     * @return AspectRating
     */
    private function buildAspectRating(array $data)
    {
        if (isset($data['types'])) {
            $data['type'] = reset($data['types']);
        }

        $aspectRating = new AspectRating();
        $aspectRating->setType($data['type']);
        $aspectRating->setRating($data['rating']);

        return $aspectRating;
    }

    /**
     * @param mixed[] $data
     *
     * @return Geometry
     */
    private function buildGeometry(array $data)
    {
        $geometry = new Geometry();
        $geometry->setLocation($this->buildCoordinate($data['location']));

        if (isset($data['viewport'])) {
            $geometry->setViewport($this->buildBound($data['viewport']));
        }

        return $geometry;
    }

    /**
     * @param array $data
     *
     * @return OpeningHours
     */
    private function buildOpeningHours(array $data)
    {
        $openingHours = new OpeningHours();
        $openingHours->setOpenNow($data['open_now']);
        $openingHours->setWeekdayTexts($data['weekday_text']);
        $openingHours->setPeriods($this->buildPeriods($data['periods']));

        return $openingHours;
    }

    /**
     * @param mixed[] $data
     *
     * @return Period[]
     */
    private function buildPeriods(array $data)
    {
        $periods = [];

        foreach ($data as $period) {
            $periods[] = $this->buildPeriod($period);
        }

        return $periods;
    }

    /**
     * @param mixed[] $data
     *
     * @return Period
     */
    private function buildPeriod(array $data)
    {
        $period = new Period();
        $period->setOpen($this->buildOpenClosePeriod($data['open']));
        $period->setClose($this->buildOpenClosePeriod($data['close']));

        return $period;
    }

    /**
     * @param mixed[] $data
     *
     * @return OpenClosePeriod
     */
    private function buildOpenClosePeriod(array $data)
    {
        $openClosePeriod = new OpenClosePeriod();
        $openClosePeriod->setDay($data['day']);
        $openClosePeriod->setTime(\DateTime::createFromFormat('!Hi', $data['time']));


        return $openClosePeriod;
    }

    /**
     * @param mixed[] $data
     *
     * @return Bound
     */
    private function buildBound(array $data)
    {
        return new Bound(
            $this->buildCoordinate($data['southwest']),
            $this->buildCoordinate($data['northeast'])
        );
    }

    /**
     * @param mixed[] $data
     *
     * @return Coordinate
     */
    private function buildCoordinate(array $data)
    {
        return new Coordinate($data['lat'], $data['lng']);
    }
}


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\Detail;
13
14		use Http\Client\HttpClient;
15		use Http\Message\MessageFactory;
16		use Ivory\GoogleMap\Base\Bound;
17		use Ivory\GoogleMap\Base\Coordinate;
18		use Ivory\GoogleMap\Service\AbstractParsableService;
19		use Ivory\GoogleMap\Service\Base\AddressComponent;
20		use Ivory\GoogleMap\Service\Base\Geometry;
21		use Ivory\GoogleMap\Service\Place\Base\AlternatePlaceId;
22		use Ivory\GoogleMap\Service\Place\Base\AspectRating;
23		use Ivory\GoogleMap\Service\Place\Base\OpenClosePeriod;
24		use Ivory\GoogleMap\Service\Place\Base\OpeningHours;
25		use Ivory\GoogleMap\Service\Place\Base\Period;
26		use Ivory\GoogleMap\Service\Place\Base\Photo;
27		use Ivory\GoogleMap\Service\Place\Base\Place;
28		use Ivory\GoogleMap\Service\Place\Base\Review;
29		use Ivory\GoogleMap\Service\Place\Detail\Request\PlaceDetailRequestInterface;
30		use Ivory\GoogleMap\Service\Place\Detail\Response\PlaceDetailResponse;
31		use Ivory\GoogleMap\Service\Utility\Parser;
32
33		/**
34		* @author GeLo <[email protected]>
35		*/
36		class PlaceDetailService extends AbstractParsableService
37		{
38		/**
39		* @param HttpClient $client
40		* @param MessageFactory $messageFactory
41		* @param Parser\|null $parser
42		*/
43		public function __construct(HttpClient $client, MessageFactory $messageFactory, Parser $parser = null)
44		{
45		parent::__construct($client, $messageFactory, 'http://maps.googleapis.com/maps/api/place/details', $parser);
46		}
47
48		/**
49		* {@inheritdoc}
50		*/
51		public function setHttps($https)
52		{
53		if (!$https) {
54		throw new \InvalidArgumentException('The http scheme is not supported.');
55		}
56
57		parent::setHttps($https);
58		}
59
60		/**
61		* @param PlaceDetailRequestInterface $request
62		*
63		* @return PlaceDetailResponse
64		*/
65		public function process(PlaceDetailRequestInterface $request)
66		{
67		$httpRequest = $this->createRequest($request);
68		$httpResponse = $this->getClient()->sendRequest($httpRequest);
69
70		$data = $this->parse((string) $httpResponse->getBody(), [
71		'pluralization_rules' => [
72		'address_component' => 'address_components',
73		'aspect' => 'aspects',
74		'html_attribution' => 'html_attributions',
75		'period' => 'periods',
76		'photo' => 'photos',
77		'type' => 'types',
78		'review' => 'reviews',
79		],
80		]);
81
82		$response = $this->buildResponse($data);
83		$response->setRequest($request);
84
85		return $response;
86		}
87
88		/**
89		* @param mixed[] $data
90		*
91		* @return PlaceDetailResponse
92		*/
93	View Code Duplication	private function buildResponse(array $data)
		0 ignored issues – show Duplication introduced 2016-08-27 19:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
94		{
95		$response = new PlaceDetailResponse();
96		$response->setStatus($data['status']);
97
98		if (isset($data['result'])) {
99		$response->setResult($this->buildResult($data['result']));
100		}
101
102		if (isset($data['html_attributions'])) {
103		$response->setHtmlAttributions($data['html_attributions']);
104		}
105
106		return $response;
107		}
108
109		/**
110		* @param mixed[] $data
111		*
112		* @return Place
113		*/
114		private function buildResult(array $data)
115		{
116		$result = new Place();
117		$result->setId($data['id']);
118		$result->setPlaceId($data['place_id']);
119		$result->setName($data['name']);
120		$result->setFormattedAddress($data['formatted_address']);
121		$result->setFormattedPhoneNumber($data['formatted_phone_number']);
122		$result->setInternationalPhoneNumber($data['international_phone_number']);
123		$result->setUrl($data['url']);
124		$result->setIcon($data['icon']);
125		$result->setScope($data['scope']);
126		$result->setRating($data['rating']);
127		$result->setUtcOffset($data['utc_offset']);
128		$result->setVicinity($data['vicinity']);
129		$result->setWebsite($data['website']);
130		$result->setTypes($data['types']);
131		$result->setAddressComponents($this->buildAddressComponents($data['address_components']));
132		$result->setPhotos($this->buildPhotos($data['photos']));
133		$result->setGeometry($this->buildGeometry($data['geometry']));
134		$result->setOpeningHours($this->buildOpeningHours($data['opening_hours']));
135		$result->setReviews($this->buildReviews($data['reviews']));
136
137		if (isset($data['price_level'])) {
138		$result->setPriceLevel($data['price_level']);
139		}
140
141		if (isset($data['permanently_closed'])) {
142		$result->setPermanentlyClose($data['permanently_closed']);
143		}
144
145		if (isset($data['alt_ids'])) {
146		$result->setAlternatePlaceIds($this->buildAlternativePlaceIds($data['alt_ids']));
147		}
148
149		return $result;
150		}
151
152		/**
153		* @param mixed[] $data
154		*
155		* @return AddressComponent[]
156		*/
157		private function buildAddressComponents(array $data)
158		{
159		$addressComponents = [];
160
161		foreach ($data as $addressComponent) {
162		$addressComponents[] = $this->buildAddressComponent($addressComponent);
163		}
164
165		return $addressComponents;
166		}
167
168		/**
169		* @param mixed[] $data
170		*
171		* @return AddressComponent
172		*/
173	View Code Duplication	private function buildAddressComponent(array $data)
		0 ignored issues – show Duplication introduced 2016-08-27 19:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
174		{
175		$address = new AddressComponent();
176		$address->setLongName($data['long_name']);
177		$address->setShortName($data['short_name']);
178		$address->setTypes($data['types']);
179
180		return $address;
181		}
182
183		/**
184		* @param mixed[] $data
185		*
186		* @return Photo[]
187		*/
188		private function buildPhotos(array $data)
189		{
190		$photos = [];
191
192		foreach ($data as $photo) {
193		$photos[] = $this->buildPhoto($photo);
194		}
195
196		return $photos;
197		}
198
199		/**
200		* @param mixed[] $data
201		*
202		* @return Photo
203		*/
204	View Code Duplication	private function buildPhoto(array $data)
		0 ignored issues – show Duplication introduced 2016-08-27 19:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
205		{
206		$photo = new Photo();
207		$photo->setReference($data['photo_reference']);
208		$photo->setWidth($data['width']);
209		$photo->setHeight($data['height']);
210		$photo->setHtmlAttributions($data['html_attributions']);
211
212		return $photo;
213		}
214
215		/**
216		* @param mixed[] $data
217		*
218		* @return AlternatePlaceId[]
219		*/
220		private function buildAlternativePlaceIds(array $data)
221		{
222		$alternativePlaceIds = [];
223
224		foreach ($data as $alternativePlaceId) {
225		$alternativePlaceIds[] = $this->buildAlternativePlaceId($alternativePlaceId);
226		}
227
228		return $alternativePlaceIds;
229		}
230
231		/**
232		* @param mixed[] $data
233		*
234		* @return AlternatePlaceId
235		*/
236	View Code Duplication	private function buildAlternativePlaceId(array $data)
		0 ignored issues – show Duplication introduced 2016-08-27 19:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
237		{
238		$alternativePlaceId = new AlternatePlaceId();
239		$alternativePlaceId->setPlaceId($data['place_id']);
240		$alternativePlaceId->setScope($data['scope']);
241
242		return $alternativePlaceId;
243		}
244
245		/**
246		* @param mixed[] $data
247		*
248		* @return Review[]
249		*/
250		private function buildReviews(array $data)
251		{
252		$reviews = [];
253
254		foreach ($data as $review) {
255		$reviews[] = $this->buildReview($review);
256		}
257
258		return $reviews;
259		}
260
261		/**
262		* @param mixed[] $data
263		*
264		* @return Review
265		*/
266		private function buildReview(array $data)
267		{
268		$review = new Review();
269		$review->setAuthorName($data['author_name']);
270		$review->setAuthorUrl($data['author_url']);
271		$review->setText($data['text']);
272		$review->setRating($data['rating']);
273		$review->setTime(new \DateTime('@'.$data['time']));
274		$review->setLanguage($data['language']);
275		$review->setAspects($this->buildAspectRatings($data['aspects']));
276
277		return $review;
278		}
279
280		/**
281		* @param mixed[] $data
282		*
283		* @return AspectRating[]
284		*/
285		private function buildAspectRatings(array $data)
286		{
287		$aspectRatings = [];
288
289		foreach ($data as $aspectRating) {
290		$aspectRatings[] = $this->buildAspectRating($aspectRating);
291		}
292
293		return $aspectRatings;
294		}
295
296		/**
297		* @param mixed[] $data
298		*
299		* @return AspectRating
300		*/
301		private function buildAspectRating(array $data)
302		{
303		if (isset($data['types'])) {
304		$data['type'] = reset($data['types']);
305		}
306
307		$aspectRating = new AspectRating();
308		$aspectRating->setType($data['type']);
309		$aspectRating->setRating($data['rating']);
310
311		return $aspectRating;
312		}
313
314		/**
315		* @param mixed[] $data
316		*
317		* @return Geometry
318		*/
319		private function buildGeometry(array $data)
320		{
321		$geometry = new Geometry();
322		$geometry->setLocation($this->buildCoordinate($data['location']));
323
324		if (isset($data['viewport'])) {
325		$geometry->setViewport($this->buildBound($data['viewport']));
326		}
327
328		return $geometry;
329		}
330
331		/**
332		* @param array $data
333		*
334		* @return OpeningHours
335		*/
336		private function buildOpeningHours(array $data)
337		{
338		$openingHours = new OpeningHours();
339		$openingHours->setOpenNow($data['open_now']);
340		$openingHours->setWeekdayTexts($data['weekday_text']);
341		$openingHours->setPeriods($this->buildPeriods($data['periods']));
342
343		return $openingHours;
344		}
345
346		/**
347		* @param mixed[] $data
348		*
349		* @return Period[]
350		*/
351		private function buildPeriods(array $data)
352		{
353		$periods = [];
354
355		foreach ($data as $period) {
356		$periods[] = $this->buildPeriod($period);
357		}
358
359		return $periods;
360		}
361
362		/**
363		* @param mixed[] $data
364		*
365		* @return Period
366		*/
367		private function buildPeriod(array $data)
368		{
369		$period = new Period();
370		$period->setOpen($this->buildOpenClosePeriod($data['open']));
371		$period->setClose($this->buildOpenClosePeriod($data['close']));
372
373		return $period;
374		}
375
376		/**
377		* @param mixed[] $data
378		*
379		* @return OpenClosePeriod
380		*/
381		private function buildOpenClosePeriod(array $data)
382		{
383		$openClosePeriod = new OpenClosePeriod();
384		$openClosePeriod->setDay($data['day']);
385		$openClosePeriod->setTime(\DateTime::createFromFormat('!Hi', $data['time']));
		0 ignored issues – show Security Bug introduced 2016-08-27 19:42 UTC by Report Bug Copy Issue Report It seems like `\DateTime::createFromFormat('!Hi', $data['time'])` targeting `DateTime::createFromFormat()` can also be of type `false`; however, `Ivory\GoogleMap\Service\...nClosePeriod::setTime()` does only seem to accept `null\|object<DateTime>`, did you maybe forget to handle an error condition? Loading history...
386
387		return $openClosePeriod;
388		}
389
390		/**
391		* @param mixed[] $data
392		*
393		* @return Bound
394		*/
395		private function buildBound(array $data)
396		{
397		return new Bound(
398		$this->buildCoordinate($data['southwest']),
399		$this->buildCoordinate($data['northeast'])
400		);
401		}
402
403		/**
404		* @param mixed[] $data
405		*
406		* @return Coordinate
407		*/
408		private function buildCoordinate(array $data)
409		{
410		return new Coordinate($data['lat'], $data['lng']);
411		}
412		}
413

egeloen / ivory-google-map

GitHub Access Token became invalid

Pull Request — master (#177)

PlaceDetailService::buildAlternativePlaceIds() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like