CalculateDistance::getApiUrl() - Code Metrics - johnnymast/redbox-distance - Measure and Improve Code Quality continuously with Scrutinizer

CalculateDistance::getApiUrl() A
last analyzed 2020-05-16 00:28 UTC

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php

namespace Redbox\Distance;

class CalculateDistance
{
    /**
     * We will use this url to test our distance information from.
     *
     * @see \Redbox\Distance\CalculateDistance::calculateDistance()
     */
    const MAPS_DISTANCE_MATRIX_API_URL = 'https://maps.googleapis.com/maps/api/distancematrix/json';

    /**
     * Kilometer to miles conversion rate.
     */
    const KM_TO_MILES_CONVERTER = 0.62137;

    /**
     * Kilometer to yards conversion rate.
     */
    const KM_TO_YARD_CONVERTER = 1093.6133;

    /**
     * The useragent string we use in the curl request.
     */
    const USER_AGENT = 'Calculate Distance V1.2.3';

    /**
     * The source string.
     *
     * @var string
     */
    protected $source = '';

    /**
     * The destination string.
     *
     * @var string
     */
    protected $destination = '';

    /**
     * The Google API key.
     *
     * @var string
     */
    protected $googleAPIkey = '';

    /**
     * Define the request options.
     *
     * @var array
     */
    protected $urlOptions = [];

    /**
     * Option to disable SSL verification,
     * i would suggest enabling it.
     *
     * @var bool
     */
    protected $disable_ssl_verifier = true;

    /**
     * The API url.
     *
     * @var string
     */
    protected $api_url = '';

    /**
     * CalculateDistance constructor.
     */
    public function __construct()
    {
        $this->urlOptions = [
            'origins' => '',
            'destinations' => '',
            'mode' => 'driving',
            'language' => 'en-EN',
            'sensor' => 'false',
            'key' => '',
        ];
        $this->setApiUrl(self::MAPS_DISTANCE_MATRIX_API_URL);
    }

    /**
     * Set the ApiUrl
     *
     * @param string $api_url
     * @return $this
     */
    public function setApiUrl($api_url)
    {
        $this->api_url = $api_url;

        return $this;
    }

    /**
     * This is not required as the documentation states but if it becomes required
     * you can set it with this function.
     *
     * @param $googleAPIkey
     * @return $this
     */
    public function setGoogleAPIkey($googleAPIkey)
    {
        $this->googleAPIkey = $googleAPIkey;

        return $this;
    }

    /**
     * Should we use SSL Verifier (Curl) yes or no.
     *
     * @param $disable_ssl_verifier
     * @return $this
     */
    public function setUseSslVerifier($disable_ssl_verifier)
    {
        $this->disable_ssl_verifier = $disable_ssl_verifier;

        return $this;
    }

    /**
     * Set the destination.
     *
     * @param string $destination
     * @return $this
     */
    public function setDestination($destination)
    {
        $this->destination = $destination;

        return $this;
    }

    /**
     * Set the source.
     *
     * @param $source
     * @return $this
     */
    public function setSource($source)
    {
        $this->source = $source;

        return $this;
    }

    /**
     * Return the destination.
     *
     * @return string
     */
    private function getDestination()
    {
        return $this->destination;
    }

    /**
     * Get the API Url.
     *
     * @return string
     */
    public function getApiUrl()
    {
        return $this->api_url;
    }

    /**
     * Are we using SSL verifier?
     *
     * @return bool
     */
    private function useSslVerifier()
    {
        return $this->disable_ssl_verifier;
    }

    /**
     * Return the source.
     *
     * @return string
     */
    private function getSource()
    {
        return $this->source;
    }

    /**
     * Return the url options.
     *
     * @return array
     */
    private function getUrlOptions()
    {
        return $this->urlOptions;
    }

    /**
     * Execute the request to Google Services.
     *
     * @param string $url
     * @return mixed
     */
    private function requestData($url = "")
    {
        $curl = curl_init();
        curl_setopt_array($curl, [
            CURLOPT_RETURNTRANSFER => 1,
            CURLOPT_URL => $url,
            CURLOPT_USERAGENT => self::USER_AGENT,
        ]);
        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->useSslVerifier());
        $resp = curl_exec($curl);
        curl_close($curl);

        return utf8_encode($resp);
    }

    /**
     * Query the distance from Google Services.
     *
     * @return mixed|null
     */
    private function calculateDistance()
    {

        $data = [
                'origins' => urlencode($this->getSource()),
                'destinations' => urlencode($this->getDestination()),
                'key' => $this->googleAPIkey,
            ] + $this->getUrlOptions();

        $request_string = '';
        $cnt = 0;
        foreach ($data as $key => $val) {
            $request_string .= ($cnt > 0 ? '&' : '').$key.'='.$val;
            $cnt++;
        }

        $url = $this->getApiUrl().'?'.$request_string;
        $response = $this->requestData($url);

        $route = json_decode($response);

        if ($route && ($rows = current($route->rows))) {
            $elements = current($rows->elements);

            return $elements;
        }

        return null;
    }

    /**
     * Return the distance calculated to Kilometers.
     *
     * @return float|int
     */
    public function getDistanceInKM()
    {
        $route = $this->calculateDistance();
        if (is_null($route) === false) {
            if (isset($route->distance->value)) {
                return round($route->distance->value / 1000);
            }
        }

        return -1;
    }

    /**
     * Return the distance calculated to Miles.
     *
     * @return float|int
     */
    public function getDistanceInMiles()
    {
        return $this->convertResult(self::KM_TO_MILES_CONVERTER);
    }

    /**
     * Return the distance calculated to Yards.
     *
     * @return float|int
     */
    public function getDistanceInYards()
    {
        return $this->convertResult(self::KM_TO_YARD_CONVERTER);
    }

    /**
     * This function will do the sum and calculate the distance correctly.
     *
     * @param $type
     * @return float|int
     */
    private function convertResult($type)
    {
        $result = $this->getDistanceInKM();
        if ($result > -1) {
            return ($result * $type);
        }

        return $result;
    }
}

1		<?php
2
3		namespace Redbox\Distance;
4
5		class CalculateDistance
6		{
7		/**
8		* We will use this url to test our distance information from.
9		*
10		* @see \Redbox\Distance\CalculateDistance::calculateDistance()
11		*/
12		const MAPS_DISTANCE_MATRIX_API_URL = 'https://maps.googleapis.com/maps/api/distancematrix/json';
13
14		/**
15		* Kilometer to miles conversion rate.
16		*/
17		const KM_TO_MILES_CONVERTER = 0.62137;
18
19		/**
20		* Kilometer to yards conversion rate.
21		*/
22	16	const KM_TO_YARD_CONVERTER = 1093.6133;
23	16
24	16	/**
25	16	* The useragent string we use in the curl request.
26	16	*/
27	16	const USER_AGENT = 'Calculate Distance V1.2.3';
28	16
29	16	/**
30		* The source string.
31	16	*
32	16	* @var string
33		*/
34		protected $source = '';
35
36		/**
37		* The destination string.
38		*
39		* @var string
40	16	*/
41		protected $destination = '';
42	16
43	16	/**
44		* The Google API key.
45		*
46		* @var string
47		*/
48		protected $googleAPIkey = '';
49
50		/**
51		* Define the request options.
52		*
53	2	* @var array
54		*/
55	2	protected $urlOptions = [];
56	2
57		/**
58		* Option to disable SSL verification,
59		* i would suggest enabling it.
60		*
61		* @var bool
62		*/
63		protected $disable_ssl_verifier = true;
64
65	6	/**
66		* The API url.
67	6	*
68	6	* @var string
69		*/
70		protected $api_url = '';
71
72		/**
73		* CalculateDistance constructor.
74		*/
75		public function __construct()
76		{
77	14	$this->urlOptions = [
78		'origins' => '',
79	14	'destinations' => '',
80	14	'mode' => 'driving',
81		'language' => 'en-EN',
82		'sensor' => 'false',
83		'key' => '',
84		];
85		$this->setApiUrl(self::MAPS_DISTANCE_MATRIX_API_URL);
86		}
87
88		/**
89	14	* Set the ApiUrl
90		*
91	14	* @param string $api_url
92	14	* @return $this
93		*/
94		public function setApiUrl($api_url)
95		{
96		$this->api_url = $api_url;
97
98		return $this;
99		}
100	14
101		/**
102	14	* This is not required as the documentation states but if it becomes required
103		* you can set it with this function.
104		*
105		* @param $googleAPIkey
106		* @return $this
107		*/
108		public function setGoogleAPIkey($googleAPIkey)
109		{
110	14	$this->googleAPIkey = $googleAPIkey;
111
112	14	return $this;
113		}
114
115		/**
116		* Should we use SSL Verifier (Curl) yes or no.
117		*
118		* @param $disable_ssl_verifier
119		* @return $this
120	14	*/
121		public function setUseSslVerifier($disable_ssl_verifier)
122	14	{
123		$this->disable_ssl_verifier = $disable_ssl_verifier;
124
125		return $this;
126		}
127
128		/**
129		* Set the destination.
130	14	*
131		* @param string $destination
132	14	* @return $this
133		*/
134		public function setDestination($destination)
135		{
136		$this->destination = $destination;
137
138		return $this;
139		}
140	14
141		/**
142	14	* Set the source.
143		*
144		* @param $source
145		* @return $this
146		*/
147		public function setSource($source)
148		{
149		$this->source = $source;
150
151	14	return $this;
152		}
153	14
154	14	/**
155	14	* Return the destination.
156	14	*
157	14	* @return string
158	14	*/
159	14	private function getDestination()
160	14	{
161	14	return $this->destination;
162		}
163
164		/**
165		* Get the API Url.
166		*
167		* @return string
168		*/
169	14	public function getApiUrl()
170		{
171		return $this->api_url;
172	14	}
173	14
174	14	/**
175	14	* Are we using SSL verifier?
176		*
177	14	* @return bool
178	14	*/
179	14	private function useSslVerifier()
180	14	{
181	14	return $this->disable_ssl_verifier;
182	14	}
183
184	14	/**
185	14	* Return the source.
186		*
187	14	* @return string
188	14	*/
189		private function getSource()
190	14	{
191	6	return $this->source;
192	6	}
193
194	8	/**
195		* Return the url options.
196		*
197		* @return array
198		*/
199		private function getUrlOptions()
200		{
201		return $this->urlOptions;
202	12	}
203
204	12	/**
205	12	* Execute the request to Google Services.
206	6	*
207	6	* @param string $url
208		* @return mixed
209		*/
210	6	private function requestData($url = "")
211		{
212		$curl = curl_init();
213		curl_setopt_array($curl, [
214		CURLOPT_RETURNTRANSFER => 1,
215		CURLOPT_URL => $url,
216		CURLOPT_USERAGENT => self::USER_AGENT,
217		]);
218	4	curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->useSslVerifier());
219		$resp = curl_exec($curl);
220	4	curl_close($curl);
221
222		return utf8_encode($resp);
223		}
224
225		/**
226		* Query the distance from Google Services.
227		*
228	4	* @return mixed\|null
229		*/
230	4	private function calculateDistance()
231		{
232
233		$data = [
234		'origins' => urlencode($this->getSource()),
235		'destinations' => urlencode($this->getDestination()),
236		'key' => $this->googleAPIkey,
237		] + $this->getUrlOptions();
238
239	8	$request_string = '';
240		$cnt = 0;
241	8	foreach ($data as $key => $val) {
242	8	$request_string .= ($cnt > 0 ? '&' : '').$key.'='.$val;
243	4	$cnt++;
244		}
245	4
246		$url = $this->getApiUrl().'?'.$request_string;
247		$response = $this->requestData($url);
248
249		$route = json_decode($response);
250
251		if ($route && ($rows = current($route->rows))) {
252		$elements = current($rows->elements);
253
254		return $elements;
255		}
256
257		return null;
258		}
259
260		/**
261		* Return the distance calculated to Kilometers.
262		*
263		* @return float\|int
264		*/
265		public function getDistanceInKM()
266		{
267		$route = $this->calculateDistance();
268		if (is_null($route) === false) {
269		if (isset($route->distance->value)) {
270		return round($route->distance->value / 1000);
271		}
272		}
273
274		return -1;
275		}
276
277		/**
278		* Return the distance calculated to Miles.
279		*
280		* @return float\|int
281		*/
282		public function getDistanceInMiles()
283		{
284		return $this->convertResult(self::KM_TO_MILES_CONVERTER);
285		}
286
287		/**
288		* Return the distance calculated to Yards.
289		*
290		* @return float\|int
291		*/
292		public function getDistanceInYards()
293		{
294		return $this->convertResult(self::KM_TO_YARD_CONVERTER);
295		}
296
297		/**
298		* This function will do the sum and calculate the distance correctly.
299		*
300		* @param $type
301		* @return float\|int
302		*/
303		private function convertResult($type)
304		{
305		$result = $this->getDistanceInKM();
306		if ($result > -1) {
307		return ($result * $type);
308		}
309
310		return $result;
311		}
312		}

johnnymast / redbox-distance

CalculateDistance::getApiUrl() A last analyzed 2020-05-16 00:28 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CalculateDistance::getApiUrl() A
last analyzed 2020-05-16 00:28 UTC