ArcGISOnline::geocodeQuery() - Code Metrics - geocoder-php/Geocoder - Measure and Improve Code Quality continuously with Scrutinizer

ArcGISOnline::geocodeQuery() C
last analyzed 2018-04-11 17:41 UTC

↳ Parent: ArcGISOnline

Complexity

Conditions	12
Paths	100

Size

Total Lines	53
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	53
rs	6.3525
c	0
b	0
f	0
cc	12
eloc	34
nc	100
nop	1

How to fix Long Method Complexity

<?php

declare(strict_types=1);

/*
 * This file is part of the Geocoder package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */

namespace Geocoder\Provider\ArcGISOnline;

use Geocoder\Collection;
use Geocoder\Exception\InvalidArgument;
use Geocoder\Exception\InvalidServerResponse;
use Geocoder\Exception\UnsupportedOperation;
use Geocoder\Model\Address;
use Geocoder\Model\AddressCollection;
use Geocoder\Query\GeocodeQuery;
use Geocoder\Query\ReverseQuery;
use Geocoder\Http\Provider\AbstractHttpProvider;
use Geocoder\Provider\Provider;
use Http\Client\HttpClient;

/**
 * @author ALKOUM Dorian <[email protected]>
 */
final class ArcGISOnline extends AbstractHttpProvider implements Provider
{
    /**
     * @var string
     */
    const ENDPOINT_URL = 'https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/find?text=%s';

    /**
     * @var string
     */
    const REVERSE_ENDPOINT_URL = 'https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode?location=%F,%F';

    /**
     * @var string
     */
    private $sourceCountry;

    /**
     * @param HttpClient $client        An HTTP adapter
     * @param string     $sourceCountry Country biasing (optional)

     */
    public function __construct(HttpClient $client, string $sourceCountry = null)
    {
        parent::__construct($client);

        $this->sourceCountry = $sourceCountry;
    }

    /**
     * {@inheritdoc}
     */
    public function geocodeQuery(GeocodeQuery $query): Collection
    {
        $address = $query->getText();
        if (filter_var($address, FILTER_VALIDATE_IP)) {
            throw new UnsupportedOperation('The ArcGISOnline provider does not support IP addresses, only street addresses.');
        }

        // Save a request if no valid address entered
        if (empty($address)) {
            throw new InvalidArgument('Address cannot be empty.');
        }

        $url = sprintf(self::ENDPOINT_URL, urlencode($address));
        $json = $this->executeQuery($url, $query->getLimit());

        // no result
        if (empty($json->locations)) {
            return new AddressCollection([]);
        }

        $results = [];
        foreach ($json->locations as $location) {
            $data = $location->feature->attributes;

            $coordinates = (array) $location->feature->geometry;
            $streetName = !empty($data->StAddr) ? $data->StAddr : null;
            $streetNumber = !empty($data->AddNum) ? $data->AddNum : null;
            $city = !empty($data->City) ? $data->City : null;
            $zipcode = !empty($data->Postal) ? $data->Postal : null;
            $countryCode = !empty($data->Country) ? $data->Country : null;

            $adminLevels = [];
            foreach (['Region', 'Subregion'] as $i => $property) {
                if (!empty($data->{$property})) {
                    $adminLevels[] = ['name' => $data->{$property}, 'level' => $i + 1];
                }
            }

            $results[] = Address::createFromArray([
                'providedBy' => $this->getName(),
                'latitude' => $coordinates['y'],
                'longitude' => $coordinates['x'],
                'streetNumber' => $streetNumber,
                'streetName' => $streetName,
                'locality' => $city,
                'postalCode' => $zipcode,
                'adminLevels' => $adminLevels,
                'countryCode' => $countryCode,
            ]);
        }

        return new AddressCollection($results);
    }

    /**
     * {@inheritdoc}
     */
    public function reverseQuery(ReverseQuery $query): Collection
    {
        $coordinates = $query->getCoordinates();
        $longitude = $coordinates->getLongitude();
        $latitude = $coordinates->getLatitude();

        $url = sprintf(self::REVERSE_ENDPOINT_URL, $longitude, $latitude);
        $json = $this->executeQuery($url, $query->getLimit());

        if (property_exists($json, 'error')) {
            return new AddressCollection([]);
        }

        $data = $json->address;

        $streetName = !empty($data->Address) ? $data->Address : null;
        $city = !empty($data->City) ? $data->City : null;
        $zipcode = !empty($data->Postal) ? $data->Postal : null;
        $region = !empty($data->Region) ? $data->Region : null;
        $county = !empty($data->Subregion) ? $data->Subregion : null;
        $countryCode = !empty($data->CountryCode) ? $data->CountryCode : null;

        return new AddressCollection([
            Address::createFromArray([
                'providedBy' => $this->getName(),
                'latitude' => $latitude,
                'longitude' => $longitude,
                'streetName' => $streetName,
                'locality' => $city,
                'postalCode' => $zipcode,
                'region' => $region,
                'countryCode' => $countryCode,
                'county' => $county,
            ]),
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function getName(): string
    {
        return 'arcgis_online';
    }

    /**
     * @param string $query
     * @param int    $limit
     *
     * @return string
     */
    private function buildQuery(string $query, int $limit): string
    {
        if (null !== $this->sourceCountry) {
            $query = sprintf('%s&sourceCountry=%s', $query, $this->sourceCountry);
        }

        return sprintf('%s&maxLocations=%d&f=%s&outFields=*', $query, $limit, 'json');
    }

    /**
     * @param string $url
     * @param int    $limit
     *
     * @return \stdClass
     */
    private function executeQuery(string $url, int $limit): \stdClass
    {
        $url = $this->buildQuery($url, $limit);
        $content = $this->getUrlContents($url);
        $json = json_decode($content);

        // API error
        if (!isset($json)) {
            throw InvalidServerResponse::create($url);
        }

        return $json;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Geocoder package.
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*
10			* @license MIT License
11			*/
12
13			namespace Geocoder\Provider\ArcGISOnline;
14
15			use Geocoder\Collection;
16			use Geocoder\Exception\InvalidArgument;
17			use Geocoder\Exception\InvalidServerResponse;
18			use Geocoder\Exception\UnsupportedOperation;
19			use Geocoder\Model\Address;
20			use Geocoder\Model\AddressCollection;
21			use Geocoder\Query\GeocodeQuery;
22			use Geocoder\Query\ReverseQuery;
23			use Geocoder\Http\Provider\AbstractHttpProvider;
24			use Geocoder\Provider\Provider;
25			use Http\Client\HttpClient;
26
27			/**
28			* @author ALKOUM Dorian <[email protected]>
29			*/
30			final class ArcGISOnline extends AbstractHttpProvider implements Provider
31			{
32			/**
33			* @var string
34			*/
35			const ENDPOINT_URL = 'https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/find?text=%s';
36
37			/**
38			* @var string
39			*/
40			const REVERSE_ENDPOINT_URL = 'https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode?location=%F,%F';
41
42			/**
43			* @var string
44			*/
45			private $sourceCountry;
46
47			/**
48			* @param HttpClient $client An HTTP adapter
49			* @param string $sourceCountry Country biasing (optional)
			0 ignored issues – show Documentation introduced 2017-06-17 08:56 UTC by Report Bug Copy Issue Report Should the type for parameter `$sourceCountry` not be `null\|string`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
50			*/
51			public function __construct(HttpClient $client, string $sourceCountry = null)
52			{
53			parent::__construct($client);
54
55			$this->sourceCountry = $sourceCountry;
56			}
57
58			/**
59			* {@inheritdoc}
60			*/
61			public function geocodeQuery(GeocodeQuery $query): Collection
62			{
63			$address = $query->getText();
64			if (filter_var($address, FILTER_VALIDATE_IP)) {
65			throw new UnsupportedOperation('The ArcGISOnline provider does not support IP addresses, only street addresses.');
66			}
67
68			// Save a request if no valid address entered
69			if (empty($address)) {
70			throw new InvalidArgument('Address cannot be empty.');
71			}
72
73			$url = sprintf(self::ENDPOINT_URL, urlencode($address));
74			$json = $this->executeQuery($url, $query->getLimit());
75
76			// no result
77			if (empty($json->locations)) {
78			return new AddressCollection([]);
79			}
80
81			$results = [];
82			foreach ($json->locations as $location) {
83			$data = $location->feature->attributes;
84
85			$coordinates = (array) $location->feature->geometry;
86			$streetName = !empty($data->StAddr) ? $data->StAddr : null;
87			$streetNumber = !empty($data->AddNum) ? $data->AddNum : null;
88			$city = !empty($data->City) ? $data->City : null;
89			$zipcode = !empty($data->Postal) ? $data->Postal : null;
90			$countryCode = !empty($data->Country) ? $data->Country : null;
91
92			$adminLevels = [];
93			foreach (['Region', 'Subregion'] as $i => $property) {
94			if (!empty($data->{$property})) {
95			$adminLevels[] = ['name' => $data->{$property}, 'level' => $i + 1];
96			}
97			}
98
99			$results[] = Address::createFromArray([
100			'providedBy' => $this->getName(),
101			'latitude' => $coordinates['y'],
102			'longitude' => $coordinates['x'],
103			'streetNumber' => $streetNumber,
104			'streetName' => $streetName,
105			'locality' => $city,
106			'postalCode' => $zipcode,
107			'adminLevels' => $adminLevels,
108			'countryCode' => $countryCode,
109			]);
110			}
111
112			return new AddressCollection($results);
113			}
114
115			/**
116			* {@inheritdoc}
117			*/
118			public function reverseQuery(ReverseQuery $query): Collection
119			{
120			$coordinates = $query->getCoordinates();
121			$longitude = $coordinates->getLongitude();
122			$latitude = $coordinates->getLatitude();
123
124			$url = sprintf(self::REVERSE_ENDPOINT_URL, $longitude, $latitude);
125			$json = $this->executeQuery($url, $query->getLimit());
126
127			if (property_exists($json, 'error')) {
128			return new AddressCollection([]);
129			}
130
131			$data = $json->address;
132
133			$streetName = !empty($data->Address) ? $data->Address : null;
134			$city = !empty($data->City) ? $data->City : null;
135			$zipcode = !empty($data->Postal) ? $data->Postal : null;
136			$region = !empty($data->Region) ? $data->Region : null;
137			$county = !empty($data->Subregion) ? $data->Subregion : null;
138			$countryCode = !empty($data->CountryCode) ? $data->CountryCode : null;
139
140			return new AddressCollection([
141			Address::createFromArray([
142			'providedBy' => $this->getName(),
143			'latitude' => $latitude,
144			'longitude' => $longitude,
145			'streetName' => $streetName,
146			'locality' => $city,
147			'postalCode' => $zipcode,
148			'region' => $region,
149			'countryCode' => $countryCode,
150			'county' => $county,
151			]),
152			]);
153			}
154
155			/**
156			* {@inheritdoc}
157			*/
158			public function getName(): string
159			{
160			return 'arcgis_online';
161			}
162
163			/**
164			* @param string $query
165			* @param int $limit
166			*
167			* @return string
168			*/
169			private function buildQuery(string $query, int $limit): string
170			{
171			if (null !== $this->sourceCountry) {
172			$query = sprintf('%s&sourceCountry=%s', $query, $this->sourceCountry);
173			}
174
175			return sprintf('%s&maxLocations=%d&f=%s&outFields=*', $query, $limit, 'json');
176			}
177
178			/**
179			* @param string $url
180			* @param int $limit
181			*
182			* @return \stdClass
183			*/
184			private function executeQuery(string $url, int $limit): \stdClass
185			{
186			$url = $this->buildQuery($url, $limit);
187			$content = $this->getUrlContents($url);
188			$json = json_decode($content);
189
190			// API error
191			if (!isset($json)) {
192			throw InvalidServerResponse::create($url);
193			}
194
195			return $json;
196			}
197			}
198

geocoder-php / Geocoder

GitHub Access Token became invalid

ArcGISOnline::geocodeQuery() C last analyzed 2018-04-11 17:41 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

ArcGISOnline::geocodeQuery() C
last analyzed 2018-04-11 17:41 UTC