Route4Me::getApiKey() - Code Metrics - Inspection of "Update Geocoding.php" - route4me/route4me-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( fbdbe5...f8b914 )

by Oleg

created 2018-12-23 13:33 UTC

Route4Me::getApiKey() A

↳ Parent: Route4Me

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
namespace Route4Me;

use Route4Me\Exception\ApiError;
use Route4Me\Exception\myErrorHandler;
use Route4Me\Enum\Endpoint;

class Route4Me
{
    static public $apiKey;
    static public $baseUrl = Endpoint::BASE_URL;

    public static function setApiKey($apiKey)
    {
        self::$apiKey = $apiKey;
    }

    public static function getApiKey()
    {
        return self::$apiKey;
    }

    public static function setBaseUrl($baseUrl)
    {
        self::$baseUrl = $baseUrl;
    }

    public static function getBaseUrl()
    {
        return self::$baseUrl;
    }
    
    public static function fileUploadRequest($options) {
        $query = isset($options['query']) ? array_filter($options['query']) : array();

        if (sizeof($query)==0) {
            return null;
        }
        
        $body = isset($options['body']) ? array_filter($options['body']) : null;
            
        $fname = isset($body['strFilename']) ? $body['strFilename'] : '';
        
        if ($fname=='') {
            return null;  
        } 

        $rpath = function_exists('curl_file_create') ? curl_file_create(realpath($fname)) : '@'.realpath($fname);
        
        $url = self::$baseUrl.$options['url'].'?'.http_build_query(array_merge(array('api_key' => self::getApiKey()), $query));
        
        $ch = curl_init($url);
        
        $curlOpts = array(
            CURLOPT_POST => true,
            CURLOPT_RETURNTRANSFER => false,
            CURLOPT_TIMEOUT        => 60,
            CURLOPT_FOLLOWLOCATION => true,
            CURLOPT_SSL_VERIFYHOST => FALSE,
            CURLOPT_SSL_VERIFYPEER => FALSE
        );
        
        curl_setopt_array($ch, $curlOpts);
        
        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
        
        curl_setopt($ch, CURLOPT_HTTPHEADER, array(
            "Content-Type: multipart/form-data",
            'Content-Disposition: form-data; name="strFilename"'
        ));
        
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
        curl_setopt($ch, CURLOPT_POSTFIELDS, array('strFilename' => $rpath)); 
        
        $result = curl_exec($ch);

        $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        curl_close($ch);

        $json = json_decode($result, true);
        
        if (200==$code) {
            return $json;
        } elseif (isset($json['errors'])) {
            throw new ApiError(implode(', ', $json['errors']));
        } else {
            throw new ApiError('Something wrong');
        }
    }

    public static function makeRequst($options) {
        $errorHandler = new myErrorHandler();

        $old_error_handler = set_error_handler(array($errorHandler, "proc_error"));
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        $method = isset($options['method']) ? $options['method'] : 'GET';
        $query = isset($options['query']) ? array_filter($options['query'], function($x) { return !is_null($x); } ) : array();

        $body = isset($options['body']) ? $options['body'] : null;
        $file = isset($options['FILE']) ? $options['FILE'] : null;
        $headers = array(
            "User-Agent: Route4Me php-sdk"
        );

        if (isset($options['HTTPHEADER'])) {
            $headers[] = $options['HTTPHEADER'];
        }

        if (isset($options['HTTPHEADERS'])) {
            foreach ($options['HTTPHEADERS'] As $header) {
                $headers[] = $header;
            } 
        }

        $ch = curl_init();

        $url = isset($options['url']) ? $options['url'].'?'.http_build_query(array_merge(
            $query, array('api_key' => self::getApiKey())
        )) : "";

        $baseUrl = self::getBaseUrl();
 
        $curlOpts = array(
            CURLOPT_URL            => $baseUrl.$url,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_TIMEOUT        => 80,
            CURLOPT_FOLLOWLOCATION => true,
            CURLOPT_SSL_VERIFYHOST => FALSE,
            CURLOPT_SSL_VERIFYPEER => FALSE,
            CURLOPT_HTTPHEADER     => $headers
        );
        
        curl_setopt_array($ch, $curlOpts);
        
        if ($file!=null) {
            curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 0);
            $fp=fopen($file, 'r');
            curl_setopt($ch, CURLOPT_INFILE, $fp);
            curl_setopt($ch, CURLOPT_INFILESIZE, filesize($file));
        }

        switch ($method) {
        case 'DELETE':
            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE"); 
            break;
        case 'DELETEARRAY':
            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE"); 
            curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($query));
            break;
        case 'PUT':
            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
            break;
        case 'POST':
           if (isset($body)) {
                $bodyData = json_encode($body);
               if (isset($options['HTTPHEADER'])) {
                  if (strpos($options['HTTPHEADER'], "multipart/form-data")>0) {
                      $bodyData = $body;
                  }
               }
               
               curl_setopt($ch, CURLOPT_POSTFIELDS, $bodyData); 
            } 
            break;
        case 'ADD':
            curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($query)); break;
        }

        if (is_numeric(array_search($method, array('DELETE', 'PUT')))) {
            if (isset($body)) {
                curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body)); 
            } 
        }

        $result = curl_exec($ch);

        $isxml = FALSE;
        $jxml = "";
        if (strpos($result, '<?xml')>-1) {
            $xml = simplexml_load_string($result);
            //$jxml = json_encode($xml);
            $jxml = self::object2array($xml);
            $isxml = TRUE;
        }
        
        $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        curl_close($ch);
        
        if (200==$code) {
            if ($isxml) {
                $json = $jxml;
            } else {
                $json = json_decode($result, true);
            }
            
            if (isset($json['errors'])) {
                throw new ApiError(implode(', ', $json['errors']));
            } else {
                return $json;
            }
        } elseif (409==$code) {
            throw new ApiError('Wrong API key');
        } else {
            throw new ApiError('Something wrong');
        }
    }

    /**
     * @param $object: JSON object
     */
    public static function object2array($object)
    {
        return @json_decode(@json_encode($object), 1);
    }

    
    /**
     * Prints on the screen main keys and values of the array 
     * @param $results: object to be printed on the screen.
     * @param $deepPrinting: if true, object will be printed recursively.
     */
    public static function simplePrint($results, $deepPrinting = null)
    {
        if (isset($results)) {
            if (is_array($results)) {
                foreach ($results as $key=>$result) {
                    if (is_array($result)) {
                        foreach ($result as $key1=>$result1) {
                            if (is_array($result1)) {
                                  if ($deepPrinting) {
                                      echo "<br>$key1 ------><br>";
                                      Route4Me::simplePrint($result1, true);
                                      echo "------<br>";
                                  } else {
                                      echo $key1." --> "."Array() <br>";
                                  } 
                            } else {

                                if (is_object($result1)) {
                                    if ($deepPrinting) {
                                        echo "<br>$key1 ------><br>";
                                        $oarray = (array)$result1;
                                        Route4Me::simplePrint($oarray, true);
                                        echo "------<br>";
                                    } else {
                                        echo $key1." --> "."Object <br>";
                                    } 
                                } else {
                                    if (!is_null($result1)) {
                                        echo $key1." --> ".$result1."<br>"; 
                                    }   
                                }
                            }
                        }
                    } else {

                        if (is_object($result)) {
                            if ($deepPrinting) {
                                echo "<br>$key ------><br>";
                                $oarray = (array)$result;
                                Route4Me::simplePrint($oarray, true);
                                echo "------<br>";
                            } else {
                                echo $key." --> "."Object <br>";
                            } 
                        } else {
                            if (!is_null($result)) {
                                echo $key." --> ".$result."<br>";
                            }
                        }
                        
                    }
                    //echo "<br>";
                }
            } 
        }
    }

    /**
     * Generates query or body parameters.
     * @param $allFields: all known fields could be used for parameters generation.
     * @param $params: input parameters (array or object)
     */
    public static function generateRequestParameters($allFields, $params)
    {
        $generatedParams = array();
        
        if (is_array($params)) {
            foreach ($allFields as $field) {
                if (isset($params[$field])) {
                    $generatedParams[$field] = $params[$field];
                }
            }
        } elseif (is_object($params)) {

            foreach ($allFields as $field) {
                if (isset($params->{$field})) {
                    $generatedParams[$field] = $params->{$field};
                }
            }
        }

        return $generatedParams;
    }
    
    /**
     * Returns an array of the object properties
     * @param $object: An object.
     * @param $exclude: array of the object parameters to be excluded from the returned array.
     */
    public static function getObjectProperties($object, $exclude)
    {
        $objectParameters = array();
        
        foreach (get_object_vars($object) as $key => $value) {
            if (property_exists($object, $key)) {
                if (!is_numeric(array_search($key, $exclude))) {
                    array_push($objectParameters, $key);
                }
            }
        }
        
        return $objectParameters;
    }
    
    /**
     * Returns url path generated from the array of the fields and parameters.
     * @param $allFields; array of the paossible fields (parameter names).
     * @param $params: input parameters (array or object).
     */
    public static function generateUrlPath($allFields, $params)
    {
        $generatedPath = "";

        if (is_array($params)) {
            foreach ($allFields as $field) {
                if (isset($params[$field])) {
                    $generatedPath .= $params[$field].'/';
                }
            }
        } elseif (is_object($params)) {

            foreach ($allFields as $field) {
                if (isset($params->{$field})) {
                    $generatedPath .= $params->{$field}.'/';
                }
            }
        }
        
        return $generatedPath;
    }
}


1		<?php
2		namespace Route4Me;
3
4		use Route4Me\Exception\ApiError;
5		use Route4Me\Exception\myErrorHandler;
6		use Route4Me\Enum\Endpoint;
7
8		class Route4Me
9		{
10		static public $apiKey;
11		static public $baseUrl = Endpoint::BASE_URL;
12
13		public static function setApiKey($apiKey)
14		{
15		self::$apiKey = $apiKey;
16		}
17
18		public static function getApiKey()
19		{
20		return self::$apiKey;
21		}
22
23		public static function setBaseUrl($baseUrl)
24		{
25		self::$baseUrl = $baseUrl;
26		}
27
28		public static function getBaseUrl()
29		{
30		return self::$baseUrl;
31		}
32
33		public static function fileUploadRequest($options) {
34		$query = isset($options['query']) ? array_filter($options['query']) : array();
35
36		if (sizeof($query)==0) {
37		return null;
38		}
39
40		$body = isset($options['body']) ? array_filter($options['body']) : null;
41
42		$fname = isset($body['strFilename']) ? $body['strFilename'] : '';
43
44		if ($fname=='') {
45		return null;
46		}
47
48		$rpath = function_exists('curl_file_create') ? curl_file_create(realpath($fname)) : '@'.realpath($fname);
49
50		$url = self::$baseUrl.$options['url'].'?'.http_build_query(array_merge(array('api_key' => self::getApiKey()), $query));
51
52		$ch = curl_init($url);
53
54		$curlOpts = array(
55		CURLOPT_POST => true,
56		CURLOPT_RETURNTRANSFER => false,
57		CURLOPT_TIMEOUT => 60,
58		CURLOPT_FOLLOWLOCATION => true,
59		CURLOPT_SSL_VERIFYHOST => FALSE,
60		CURLOPT_SSL_VERIFYPEER => FALSE
61		);
62
63		curl_setopt_array($ch, $curlOpts);
64
65		curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
66
67		curl_setopt($ch, CURLOPT_HTTPHEADER, array(
68		"Content-Type: multipart/form-data",
69		'Content-Disposition: form-data; name="strFilename"'
70		));
71
72		curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
73		curl_setopt($ch, CURLOPT_POSTFIELDS, array('strFilename' => $rpath));
74
75		$result = curl_exec($ch);
76
77		$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
78		curl_close($ch);
79
80		$json = json_decode($result, true);
81
82		if (200==$code) {
83		return $json;
84		} elseif (isset($json['errors'])) {
85		throw new ApiError(implode(', ', $json['errors']));
86		} else {
87		throw new ApiError('Something wrong');
88		}
89		}
90
91		public static function makeRequst($options) {
92		$errorHandler = new myErrorHandler();
93
94		$old_error_handler = set_error_handler(array($errorHandler, "proc_error"));
		0 ignored issues – show Unused Code introduced 2017-11-03 12:45 UTC by Report Bug Copy Issue Report `$old_error_handler` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
95
96		$method = isset($options['method']) ? $options['method'] : 'GET';
97		$query = isset($options['query']) ? array_filter($options['query'], function($x) { return !is_null($x); } ) : array();
98
99		$body = isset($options['body']) ? $options['body'] : null;
100		$file = isset($options['FILE']) ? $options['FILE'] : null;
101		$headers = array(
102		"User-Agent: Route4Me php-sdk"
103		);
104
105		if (isset($options['HTTPHEADER'])) {
106		$headers[] = $options['HTTPHEADER'];
107		}
108
109		if (isset($options['HTTPHEADERS'])) {
110		foreach ($options['HTTPHEADERS'] As $header) {
111		$headers[] = $header;
112		}
113		}
114
115		$ch = curl_init();
116
117		$url = isset($options['url']) ? $options['url'].'?'.http_build_query(array_merge(
118		$query, array('api_key' => self::getApiKey())
119		)) : "";
120
121		$baseUrl = self::getBaseUrl();
122
123		$curlOpts = array(
124		CURLOPT_URL => $baseUrl.$url,
125		CURLOPT_RETURNTRANSFER => true,
126		CURLOPT_TIMEOUT => 80,
127		CURLOPT_FOLLOWLOCATION => true,
128		CURLOPT_SSL_VERIFYHOST => FALSE,
129		CURLOPT_SSL_VERIFYPEER => FALSE,
130		CURLOPT_HTTPHEADER => $headers
131		);
132
133		curl_setopt_array($ch, $curlOpts);
134
135		if ($file!=null) {
136		curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 0);
137		$fp=fopen($file, 'r');
138		curl_setopt($ch, CURLOPT_INFILE, $fp);
139		curl_setopt($ch, CURLOPT_INFILESIZE, filesize($file));
140		}
141
142		switch ($method) {
143		case 'DELETE':
144		curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
145		break;
146		case 'DELETEARRAY':
147		curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
148		curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($query));
149		break;
150		case 'PUT':
151		curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
152		break;
153		case 'POST':
154		if (isset($body)) {
155		$bodyData = json_encode($body);
156		if (isset($options['HTTPHEADER'])) {
157		if (strpos($options['HTTPHEADER'], "multipart/form-data")>0) {
158		$bodyData = $body;
159		}
160		}
161
162		curl_setopt($ch, CURLOPT_POSTFIELDS, $bodyData);
163		}
164		break;
165		case 'ADD':
166		curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($query)); break;
167		}
168
169		if (is_numeric(array_search($method, array('DELETE', 'PUT')))) {
170		if (isset($body)) {
171		curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
172		}
173		}
174
175		$result = curl_exec($ch);
176
177		$isxml = FALSE;
178		$jxml = "";
179		if (strpos($result, '<?xml')>-1) {
180		$xml = simplexml_load_string($result);
181		//$jxml = json_encode($xml);
182		$jxml = self::object2array($xml);
183		$isxml = TRUE;
184		}
185
186		$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
187		curl_close($ch);
188
189		if (200==$code) {
190		if ($isxml) {
191		$json = $jxml;
192		} else {
193		$json = json_decode($result, true);
194		}
195
196		if (isset($json['errors'])) {
197		throw new ApiError(implode(', ', $json['errors']));
198		} else {
199		return $json;
200		}
201		} elseif (409==$code) {
202		throw new ApiError('Wrong API key');
203		} else {
204		throw new ApiError('Something wrong');
205		}
206		}
207
208		/**
209		* @param $object: JSON object
210		*/
211		public static function object2array($object)
212		{
213		return @json_decode(@json_encode($object), 1);
214		}
215
216
217		/**
218		* Prints on the screen main keys and values of the array
219		* @param $results: object to be printed on the screen.
220		* @param $deepPrinting: if true, object will be printed recursively.
221		*/
222		public static function simplePrint($results, $deepPrinting = null)
223		{
224		if (isset($results)) {
225		if (is_array($results)) {
226		foreach ($results as $key=>$result) {
227		if (is_array($result)) {
228		foreach ($result as $key1=>$result1) {
229		if (is_array($result1)) {
230		if ($deepPrinting) {
231		echo "<br>$key1 ------><br>";
232		Route4Me::simplePrint($result1, true);
233		echo "------<br>";
234		} else {
235		echo $key1." --> "."Array() <br>";
236		}
237	View Code Duplication	} else {
		0 ignored issues – show Duplication introduced 2018-12-17 11:33 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
238		if (is_object($result1)) {
239		if ($deepPrinting) {
240		echo "<br>$key1 ------><br>";
241		$oarray = (array)$result1;
242		Route4Me::simplePrint($oarray, true);
243		echo "------<br>";
244		} else {
245		echo $key1." --> "."Object <br>";
246		}
247		} else {
248		if (!is_null($result1)) {
249		echo $key1." --> ".$result1."<br>";
250		}
251		}
252		}
253		}
254	View Code Duplication	} else {
		0 ignored issues – show Duplication introduced 2018-12-19 08:28 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
255		if (is_object($result)) {
256		if ($deepPrinting) {
257		echo "<br>$key ------><br>";
258		$oarray = (array)$result;
259		Route4Me::simplePrint($oarray, true);
260		echo "------<br>";
261		} else {
262		echo $key." --> "."Object <br>";
263		}
264		} else {
265		if (!is_null($result)) {
266		echo $key." --> ".$result."<br>";
267		}
268		}
269
270		}
271		//echo "<br>";
272		}
273		}
274		}
275		}
276
277		/**
278		* Generates query or body parameters.
279		* @param $allFields: all known fields could be used for parameters generation.
280		* @param $params: input parameters (array or object)
281		*/
282		public static function generateRequestParameters($allFields, $params)
283		{
284		$generatedParams = array();
285
286		if (is_array($params)) {
287		foreach ($allFields as $field) {
288		if (isset($params[$field])) {
289		$generatedParams[$field] = $params[$field];
290		}
291		}
292	View Code Duplication	} elseif (is_object($params)) {
		0 ignored issues – show Duplication introduced 2018-12-20 16:07 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
293		foreach ($allFields as $field) {
294		if (isset($params->{$field})) {
295		$generatedParams[$field] = $params->{$field};
296		}
297		}
298		}
299
300		return $generatedParams;
301		}
302
303		/**
304		* Returns an array of the object properties
305		* @param $object: An object.
306		* @param $exclude: array of the object parameters to be excluded from the returned array.
307		*/
308		public static function getObjectProperties($object, $exclude)
309		{
310		$objectParameters = array();
311
312		foreach (get_object_vars($object) as $key => $value) {
313		if (property_exists($object, $key)) {
314		if (!is_numeric(array_search($key, $exclude))) {
315		array_push($objectParameters, $key);
316		}
317		}
318		}
319
320		return $objectParameters;
321		}
322
323		/**
324		* Returns url path generated from the array of the fields and parameters.
325		* @param $allFields; array of the paossible fields (parameter names).
326		* @param $params: input parameters (array or object).
327		*/
328		public static function generateUrlPath($allFields, $params)
329		{
330		$generatedPath = "";
331
332		if (is_array($params)) {
333		foreach ($allFields as $field) {
334		if (isset($params[$field])) {
335		$generatedPath .= $params[$field].'/';
336		}
337		}
338	View Code Duplication	} elseif (is_object($params)) {
		0 ignored issues – show Duplication introduced 2018-12-20 16:07 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
339		foreach ($allFields as $field) {
340		if (isset($params->{$field})) {
341		$generatedPath .= $params->{$field}.'/';
342		}
343		}
344		}
345
346		return $generatedPath;
347		}
348		}
349

route4me / route4me-php-sdk

GitHub Access Token became invalid

Push — master ( fbdbe5...f8b914 )

Route4Me::getApiKey() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like