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

GeoIP2::geocodeQuery() D
last analyzed 2018-04-11 17:41 UTC

↳ Parent: GeoIP2

Complexity

Conditions	19
Paths	10

Size

Total Lines	44
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	44
rs	4.9141
c	0
b	0
f	0
cc	19
eloc	28
nc	10
nop	1

How to fix 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\GeoIP2;

use Geocoder\Collection;
use Geocoder\Model\Address;
use Geocoder\Model\AddressCollection;
use Geocoder\Query\GeocodeQuery;
use Geocoder\Query\ReverseQuery;
use Geocoder\Provider\AbstractProvider;
use Geocoder\Provider\Provider;
use Geocoder\Exception\UnsupportedOperation;
use Geocoder\Exception\InvalidCredentials;
use Geocoder\Exception\QuotaExceeded;
use GeoIp2\Exception\AddressNotFoundException;
use GeoIp2\Exception\AuthenticationException;
use GeoIp2\Exception\OutOfQueriesException;

/**
 * @author Jens Wiese <[email protected]>
 */
final class GeoIP2 extends AbstractProvider implements Provider
{
    /**
     * @var GeoIP2Adapter
     */
    private $adapter;

    public function __construct(GeoIP2Adapter $adapter)
    {
        $this->adapter = $adapter;
    }

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

        if ('127.0.0.1' === $address) {
            return new AddressCollection([$this->getLocationForLocalhost()]);
        }

        $result = json_decode($this->executeQuery($address));

        if (null === $result) {
            return new AddressCollection([]);
        }

        $adminLevels = [];
        if (isset($result->subdivisions) && is_array($result->subdivisions)) {
            foreach ($result->subdivisions as $i => $subdivision) {
                $name = (isset($subdivision->names->{$locale}) ? $subdivision->names->{$locale} : null);
                $code = (isset($subdivision->iso_code) ? $subdivision->iso_code : null);

                if (null !== $name || null !== $code) {
                    $adminLevels[] = ['name' => $name, 'code' => $code, 'level' => $i + 1];
                }
            }
        }

        return new AddressCollection([
            Address::createFromArray([
                'providedBy' => $this->getName(),
                'countryCode' => (isset($result->country->iso_code) ? $result->country->iso_code : null),
                'country' => (isset($result->country->names->{$locale}) ? $result->country->names->{$locale} : null),
                'locality' => (isset($result->city->names->{$locale}) ? $result->city->names->{$locale} : null),
                'latitude' => (isset($result->location->latitude) ? $result->location->latitude : null),
                'longitude' => (isset($result->location->longitude) ? $result->location->longitude : null),
                'timezone' => (isset($result->location->time_zone) ? $result->location->time_zone : null),
                'postalCode' => (isset($result->postal->code) ? $result->postal->code : null),
                'adminLevels' => $adminLevels,
            ]),
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function reverseQuery(ReverseQuery $query): Collection
    {
        throw new UnsupportedOperation('The GeoIP2 provider is not able to do reverse geocoding.');
    }

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

    /**
     * @param string $address
     */
    private function executeQuery(string $address): string
    {
        $uri = sprintf('file://geoip?%s', $address);

        try {
            $result = $this->adapter->getContent($uri);
        } catch (AddressNotFoundException $e) {
            return '';
        } catch (AuthenticationException $e) {
            throw new InvalidCredentials(
                $e->getMessage(),
                $e->getCode(),
                $e
            );
        } catch (OutOfQueriesException $e) {
            throw new QuotaExceeded(
                $e->getMessage(),
                $e->getCode(),
                $e
            );
        }

        return $result;
    }
}


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\GeoIP2;
14
15			use Geocoder\Collection;
16			use Geocoder\Model\Address;
17			use Geocoder\Model\AddressCollection;
18			use Geocoder\Query\GeocodeQuery;
19			use Geocoder\Query\ReverseQuery;
20			use Geocoder\Provider\AbstractProvider;
21			use Geocoder\Provider\Provider;
22			use Geocoder\Exception\UnsupportedOperation;
23			use Geocoder\Exception\InvalidCredentials;
24			use Geocoder\Exception\QuotaExceeded;
25			use GeoIp2\Exception\AddressNotFoundException;
26			use GeoIp2\Exception\AuthenticationException;
27			use GeoIp2\Exception\OutOfQueriesException;
28
29			/**
30			* @author Jens Wiese <[email protected]>
31			*/
32			final class GeoIP2 extends AbstractProvider implements Provider
33			{
34			/**
35			* @var GeoIP2Adapter
36			*/
37			private $adapter;
38
39			public function __construct(GeoIP2Adapter $adapter)
40			{
41			$this->adapter = $adapter;
42			}
43
44			/**
45			* {@inheritdoc}
46			*/
47			public function geocodeQuery(GeocodeQuery $query): Collection
48			{
49			$address = $query->getText();
50			$locale = $query->getLocale() ?: 'en'; // Default to English
51			if (!filter_var($address, FILTER_VALIDATE_IP)) {
52			throw new UnsupportedOperation('The GeoIP2 provider does not support street addresses, only IP addresses.');
53			}
54
55			if ('127.0.0.1' === $address) {
56			return new AddressCollection([$this->getLocationForLocalhost()]);
57			}
58
59			$result = json_decode($this->executeQuery($address));
60
61			if (null === $result) {
62			return new AddressCollection([]);
63			}
64
65			$adminLevels = [];
66			if (isset($result->subdivisions) && is_array($result->subdivisions)) {
67			foreach ($result->subdivisions as $i => $subdivision) {
68			$name = (isset($subdivision->names->{$locale}) ? $subdivision->names->{$locale} : null);
69			$code = (isset($subdivision->iso_code) ? $subdivision->iso_code : null);
70
71			if (null !== $name \|\| null !== $code) {
72			$adminLevels[] = ['name' => $name, 'code' => $code, 'level' => $i + 1];
73			}
74			}
75			}
76
77			return new AddressCollection([
78			Address::createFromArray([
79			'providedBy' => $this->getName(),
80			'countryCode' => (isset($result->country->iso_code) ? $result->country->iso_code : null),
81			'country' => (isset($result->country->names->{$locale}) ? $result->country->names->{$locale} : null),
82			'locality' => (isset($result->city->names->{$locale}) ? $result->city->names->{$locale} : null),
83			'latitude' => (isset($result->location->latitude) ? $result->location->latitude : null),
84			'longitude' => (isset($result->location->longitude) ? $result->location->longitude : null),
85			'timezone' => (isset($result->location->time_zone) ? $result->location->time_zone : null),
86			'postalCode' => (isset($result->postal->code) ? $result->postal->code : null),
87			'adminLevels' => $adminLevels,
88			]),
89			]);
90			}
91
92			/**
93			* {@inheritdoc}
94			*/
95			public function reverseQuery(ReverseQuery $query): Collection
96			{
97			throw new UnsupportedOperation('The GeoIP2 provider is not able to do reverse geocoding.');
98			}
99
100			/**
101			* {@inheritdoc}
102			*/
103			public function getName(): string
104			{
105			return 'geoip2';
106			}
107
108			/**
109			* @param string $address
110			*/
111			private function executeQuery(string $address): string
112			{
113			$uri = sprintf('file://geoip?%s', $address);
114
115			try {
116			$result = $this->adapter->getContent($uri);
117			} catch (AddressNotFoundException $e) {
118			return '';
119			} catch (AuthenticationException $e) {
120			throw new InvalidCredentials(
121			$e->getMessage(),
122			$e->getCode(),
123			$e
124			);
125			} catch (OutOfQueriesException $e) {
126			throw new QuotaExceeded(
127			$e->getMessage(),
128			$e->getCode(),
129			$e
130			);
131			}
132
133			return $result;
134			}
135			}
136

GitHub Access Token became invalid

GeoIP2::geocodeQuery() D
last analyzed 2018-04-11 17:41 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

geocoder-php / Geocoder

GitHub Access Token became invalid

GeoIP2::geocodeQuery() D last analyzed 2018-04-11 17:41 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

GeoIP2::geocodeQuery() D
last analyzed 2018-04-11 17:41 UTC