NominatimClient - Code Metrics - mauro-moreno/openstreetmap-api-client - Measure and Improve Code Quality continuously with Scrutinizer

NominatimClient A
last analyzed 2016-02-11 03:42 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

94.29%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	9
c	1
b	0
f	0
lcom	1
cbo	1
dl	0
loc	110
ccs	33
cts	35
cp	0.9429
rs	10

5 Methods

Rating	Name	Size	Complexity
A	__construct()	17	3
B	reverse()	28	3
A	isLatitude()	4	1
A	isLongitude()	7	1
A	getGuzzleClient()	4	1

<?php
/**
 * Class NominatimClient
 *
 * @author Mauro Moreno <[email protected]>
 */
namespace MauroMoreno\OpenStreetMap\Client;

use GuzzleHttp\Client as GuzzleClient;

/**
 * Class NominatimClient
 * @package MauroMoreno\OpenStreetMap\Client
 */
class NominatimClient
{

    /**
     * Base URL
     */
    const BASE_URI = 'http://nominatim.openstreetmap.org';

    /**
     * @var GuzzleClient
     */
    private $guzzleClient;

    /**
     * NominatimClient constructor.
     * @param array $config
     */
    public function __construct(array $config = [])
    {
        $defaults['base_uri'] = self::BASE_URI;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        // Format xml or json
        if (!isset($config['format'])) {
            $config['format'] = 'json';
        }

        // Address details
        if (!isset($config['addressdetails'])) {
            $config['addressdetails'] = 1;
        }

        $defaults = array_merge($defaults, $config);
        $this->guzzleClient = new GuzzleClient($defaults);
    }

    /**
     * Reverse action
     *
     * @param $latitude
     * @param $longitude
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function reverse($latitude, $longitude)
    {
        if (!$this->isLatitude($latitude)) {
            throw new \InvalidArgumentException(
                'Wrong value for latitude.'
            );
        }

        if (!$this->isLongitude($longitude)) {
            throw new \InvalidArgumentException(
                'Wrong value for longitude.'
            );
        }

        $response = $this->guzzleClient->get(
            'reverse',
            [
                'query' => [
                    'format' => $this->guzzleClient->getConfig('format'),
                    'lat'    => $latitude,
                    'lon'    => $longitude,
                    'addressdetails' => $this->guzzleClient->getConfig('addressdetails')
                ],
            ]
        );

        return $response;
    }

    /**
     * Validate is latitude
     *
     * @param $value
     *
     * @return int
     */
    private function isLatitude($value)
    {
        return preg_match('/^[-]?(([0-8]?[0-9])\.(\d+))|(90(\.0+)?)$/', $value);
    }

    /**
     * Validate is longitude
     *
     * @param $value
     *
     * @return int
     */
    private function isLongitude($value)
    {
        return preg_match(
            '/^[-]?((((1[0-7][0-9])|([0-9]?[0-9]))\.(\d+))|180(\.0+)?)$/',
            $value
        );
    }

    /**
     * Get Guzzle Client
     *
     * @return GuzzleClient
     */
    public function getGuzzleClient()
    {
        return $this->guzzleClient;
    }

}

1		<?php
2		/**
3		* Class NominatimClient
4		*
5		* @author Mauro Moreno <[email protected]>
6		*/
7		namespace MauroMoreno\OpenStreetMap\Client;
8
9		use GuzzleHttp\Client as GuzzleClient;
10
11		/**
12		* Class NominatimClient
13		* @package MauroMoreno\OpenStreetMap\Client
14		*/
15		class NominatimClient
16		{
17
18		/**
19		* Base URL
20		*/
21		const BASE_URI = 'http://nominatim.openstreetmap.org';
22
23		/**
24		* @var GuzzleClient
25		*/
26		private $guzzleClient;
27
28		/**
29		* NominatimClient constructor.
30		* @param array $config
31		*/
32	4	public function __construct(array $config = [])
33		{
34	4	$defaults['base_uri'] = self::BASE_URI;
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-02-11 03:23 UTC by Report Bug Copy Issue Report `$defaults` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$defaults = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
35
36		// Format xml or json
37	4	if (!isset($config['format'])) {
38	4	$config['format'] = 'json';
39	4	}
40
41		// Address details
42	4	if (!isset($config['addressdetails'])) {
43	4	$config['addressdetails'] = 1;
44	4	}
45
46	4	$defaults = array_merge($defaults, $config);
47	4	$this->guzzleClient = new GuzzleClient($defaults);
48	4	}
49
50		/**
51		* Reverse action
52		*
53		* @param $latitude
54		* @param $longitude
55		*
56		* @return \Psr\Http\Message\ResponseInterface
57		*/
58	3	public function reverse($latitude, $longitude)
59		{
60	3	if (!$this->isLatitude($latitude)) {
61	2	throw new \InvalidArgumentException(
62		'Wrong value for latitude.'
63	2	);
64		}
65
66	1	if (!$this->isLongitude($longitude)) {
67		throw new \InvalidArgumentException(
68		'Wrong value for longitude.'
69		);
70		}
71
72	1	$response = $this->guzzleClient->get(
73	1	'reverse',
74		[
75		'query' => [
76	1	'format' => $this->guzzleClient->getConfig('format'),
77	1	'lat' => $latitude,
78	1	'lon' => $longitude,
79	1	'addressdetails' => $this->guzzleClient->getConfig('addressdetails')
80	1	],
81		]
82	1	);
83
84	1	return $response;
85		}
86
87		/**
88		* Validate is latitude
89		*
90		* @param $value
91		*
92		* @return int
93		*/
94	3	private function isLatitude($value)
95		{
96	3	return preg_match('/^[-]?(([0-8]?[0-9])\.(\d+))\|(90(\.0+)?)$/', $value);
97		}
98
99		/**
100		* Validate is longitude
101		*
102		* @param $value
103		*
104		* @return int
105		*/
106	1	private function isLongitude($value)
107		{
108	1	return preg_match(
109	1	'/^[-]?((((1[0-7][0-9])\|([0-9]?[0-9]))\.(\d+))\|180(\.0+)?)$/',
110		$value
111	1	);
112		}
113
114		/**
115		* Get Guzzle Client
116		*
117		* @return GuzzleClient
118		*/
119	2	public function getGuzzleClient()
120		{
121	2	return $this->guzzleClient;
122		}
123
124		}

mauro-moreno / openstreetmap-api-client

NominatimClient A last analyzed 2016-02-11 03:42 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like

NominatimClient A
last analyzed 2016-02-11 03:42 UTC