@@ -4,380 +4,380 @@ discard block |
||
4 | 4 | |
5 | 5 | class CurlHttpClient |
6 | 6 | { |
7 | - public $ch; |
|
8 | - public $debug = false; |
|
9 | - public $error_msg; |
|
10 | - |
|
11 | - public function CurlHttpClient($debug = false) |
|
12 | - { |
|
13 | - $this->debug = $debug; |
|
14 | - $this->init(); |
|
15 | - } |
|
16 | - |
|
17 | - public function init() |
|
18 | - { |
|
19 | - // initialize curl handle |
|
20 | - $this->ch = curl_init(); |
|
21 | - //set various options |
|
22 | - //set error in case http return code bigger than 300 |
|
23 | - curl_setopt($this->ch, CURLOPT_FAILONERROR, true); |
|
24 | - // use gzip if possible |
|
25 | - curl_setopt($this->ch, CURLOPT_ENCODING, 'gzip, deflate'); |
|
26 | - // do not veryfy ssl |
|
27 | - // this is important for windows |
|
28 | - // as well for being able to access pages with non valid cert |
|
29 | - curl_setopt($this->ch, CURLOPT_SSL_VERIFYPEER, 0); |
|
30 | - } |
|
31 | - |
|
32 | - /** |
|
33 | - * Set username/pass for basic http auth. |
|
34 | - * |
|
35 | - * @param string user |
|
36 | - * @param string pass |
|
37 | - */ |
|
38 | - public function setCredentials($username, $password) |
|
39 | - { |
|
40 | - curl_setopt($this->ch, CURLOPT_USERPWD, "$username:$password"); |
|
41 | - } |
|
42 | - |
|
43 | - /** |
|
44 | - * Set referrer. |
|
45 | - * |
|
46 | - * @param string referrer url |
|
47 | - */ |
|
48 | - public function setReferrer($referrer_url) |
|
49 | - { |
|
50 | - curl_setopt($this->ch, CURLOPT_REFERER, $referrer_url); |
|
51 | - } |
|
52 | - |
|
53 | - /** |
|
54 | - * Set client's userAgent. |
|
55 | - * |
|
56 | - * @param string user agent |
|
57 | - */ |
|
58 | - public function setUserAgent($userAgent) |
|
59 | - { |
|
60 | - curl_setopt($this->ch, CURLOPT_USERAGENT, $userAgent); |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * Set to receive output headers in all output functions. |
|
65 | - * |
|
66 | - * @param bool true to include all response headers with output, false otherwise |
|
67 | - */ |
|
68 | - public function includeResponseHeaders($value) |
|
69 | - { |
|
70 | - curl_setopt($this->ch, CURLOPT_HEADER, $value); |
|
71 | - } |
|
72 | - |
|
73 | - /** |
|
74 | - * Set proxy to use for each curl request. |
|
75 | - * |
|
76 | - * @param string proxy |
|
77 | - */ |
|
78 | - public function setProxy($proxy) |
|
79 | - { |
|
80 | - curl_setopt($this->ch, CURLOPT_PROXY, $proxy); |
|
81 | - } |
|
82 | - |
|
83 | - /** |
|
84 | - * Send post data to target URL |
|
85 | - * return data returned from url or false if error occured. |
|
86 | - * |
|
87 | - * @param string url |
|
88 | - * @param mixed post data (assoc array ie. $foo['post_var_name'] = $value or as string like var=val1&var2=val2) |
|
89 | - * @param string ip address to bind (default null) |
|
90 | - * @param int timeout in sec for complete curl operation (default 10) |
|
91 | - * |
|
92 | - * @return string data |
|
93 | - */ |
|
94 | - public function sendPostData($url, $postdata, $ip = null, $timeout = 10) |
|
95 | - { |
|
96 | - //set various curl options first |
|
97 | - // set url to post to |
|
98 | - curl_setopt($this->ch, CURLOPT_URL, $url); |
|
99 | - // return into a variable rather than displaying it |
|
100 | - curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true); |
|
101 | - |
|
102 | - //bind to specific ip address if it is sent trough arguments |
|
103 | - if ($ip) { |
|
104 | - if ($this->debug) { |
|
105 | - echo "Binding to ip $ip\n"; |
|
106 | - } |
|
107 | - curl_setopt($this->ch, CURLOPT_INTERFACE, $ip); |
|
108 | - } |
|
109 | - |
|
110 | - //set curl function timeout to $timeout |
|
111 | - curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout); |
|
112 | - |
|
113 | - //set method to post |
|
114 | - curl_setopt($this->ch, CURLOPT_POST, true); |
|
115 | - // set post string |
|
116 | - curl_setopt($this->ch, CURLOPT_POSTFIELDS, $postdata); |
|
117 | - |
|
118 | - //and finally send curl request |
|
119 | - $result = curl_exec_redir($this->ch); |
|
120 | - if (curl_errno($this->ch)) { |
|
121 | - if ($this->debug) { |
|
122 | - echo "Error Occured in Curl\n"; |
|
123 | - echo 'Error number: '.curl_errno($this->ch)."\n"; |
|
124 | - echo 'Error message: '.curl_error($this->ch)."\n"; |
|
125 | - } |
|
126 | - |
|
127 | - return false; |
|
128 | - } else { |
|
129 | - return $result; |
|
130 | - } |
|
131 | - } |
|
132 | - |
|
133 | - /** |
|
134 | - * fetch data from target URL |
|
135 | - * return data returned from url or false if error occured. |
|
136 | - * |
|
137 | - * @param string url |
|
138 | - * @param string ip address to bind (default null) |
|
139 | - * @param int timeout in sec for complete curl operation (default 5) |
|
140 | - * |
|
141 | - * @return string data |
|
142 | - */ |
|
143 | - public function fetchUrl($url, $ip = null, $timeout = 5) |
|
144 | - { |
|
145 | - // set url to post to |
|
146 | - curl_setopt($this->ch, CURLOPT_URL, $url); |
|
147 | - |
|
148 | - //set method to get |
|
149 | - curl_setopt($this->ch, CURLOPT_HTTPGET, true); |
|
150 | - // return into a variable rather than displaying it |
|
151 | - curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true); |
|
152 | - |
|
153 | - //bind to specific ip address if it is sent trough arguments |
|
154 | - if ($ip) { |
|
155 | - if ($this->debug) { |
|
156 | - echo "Binding to ip $ip\n"; |
|
157 | - } |
|
158 | - |
|
159 | - curl_setopt($this->ch, CURLOPT_INTERFACE, $ip); |
|
160 | - } |
|
161 | - |
|
162 | - //set curl function timeout to $timeout |
|
163 | - curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout); |
|
164 | - |
|
165 | - //and finally send curl request |
|
166 | - $result = curl_exec_redir($this->ch); |
|
167 | - if (curl_errno($this->ch)) { |
|
168 | - if ($this->debug) { |
|
169 | - echo "Error Occured in Curl\n"; |
|
170 | - echo 'Error number: '.curl_errno($this->ch)."\n"; |
|
171 | - echo 'Error message: '.curl_error($this->ch)."\n"; |
|
172 | - } |
|
173 | - |
|
174 | - return false; |
|
175 | - } else { |
|
176 | - return $result; |
|
177 | - } |
|
178 | - } |
|
179 | - |
|
180 | - /** |
|
181 | - * Fetch data from target URL |
|
182 | - * and store it directly to file. |
|
183 | - * |
|
184 | - * @param string url |
|
185 | - * @param resource value stream resource(ie. fopen) |
|
186 | - * @param string ip address to bind (default null) |
|
187 | - * @param int timeout in sec for complete curl operation (default 5) |
|
188 | - * |
|
189 | - * @return bool true on success false othervise |
|
190 | - */ |
|
191 | - public function fetchIntoFile($url, $fp, $ip = null, $timeout = 5) |
|
192 | - { |
|
193 | - // set url to post to |
|
194 | - curl_setopt($this->ch, CURLOPT_URL, $url); |
|
195 | - //set method to get |
|
196 | - curl_setopt($this->ch, CURLOPT_HTTPGET, true); |
|
197 | - // store data into file rather than displaying it |
|
198 | - curl_setopt($this->ch, CURLOPT_FILE, $fp); |
|
199 | - |
|
200 | - //bind to specific ip address if it is sent trough arguments |
|
201 | - if ($ip) { |
|
202 | - if ($this->debug) { |
|
203 | - echo "Binding to ip $ip\n"; |
|
204 | - } |
|
205 | - curl_setopt($this->ch, CURLOPT_INTERFACE, $ip); |
|
206 | - } |
|
207 | - |
|
208 | - //set curl function timeout to $timeout |
|
209 | - curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout); |
|
210 | - |
|
211 | - //and finally send curl request |
|
212 | - $result = curl_exec_redir($this->ch); |
|
213 | - if (curl_errno($this->ch)) { |
|
214 | - if ($this->debug) { |
|
215 | - echo "Error Occured in Curl\n"; |
|
216 | - echo 'Error number: '.curl_errno($this->ch)."\n"; |
|
217 | - echo 'Error message: '.curl_error($this->ch)."\n"; |
|
218 | - } |
|
219 | - |
|
220 | - return false; |
|
221 | - } else { |
|
222 | - return true; |
|
223 | - } |
|
224 | - } |
|
225 | - |
|
226 | - /** |
|
227 | - * Send multipart post data to the target URL |
|
228 | - * return data returned from url or false if error occured |
|
229 | - * (contribution by vule nikolic, [email protected]). |
|
230 | - * |
|
231 | - * @param string url |
|
232 | - * @param array assoc post data array ie. $foo['post_var_name'] = $value |
|
233 | - * @param array assoc $file_field_array, contains file_field name = value - path pairs |
|
234 | - * @param string ip address to bind (default null) |
|
235 | - * @param int timeout in sec for complete curl operation (default 30 sec) |
|
236 | - * |
|
237 | - * @return string data |
|
238 | - */ |
|
239 | - public function sendMultipartPostData($url, $postdata, $file_field_array = [], $ip = null, $timeout = 30) |
|
240 | - { |
|
241 | - //set various curl options first |
|
242 | - // set url to post to |
|
243 | - curl_setopt($this->ch, CURLOPT_URL, $url); |
|
244 | - // return into a variable rather than displaying it |
|
245 | - curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true); |
|
246 | - |
|
247 | - //bind to specific ip address if it is sent trough arguments |
|
248 | - if ($ip) { |
|
249 | - if ($this->debug) { |
|
250 | - echo "Binding to ip $ip\n"; |
|
251 | - } |
|
252 | - |
|
253 | - curl_setopt($this->ch, CURLOPT_INTERFACE, $ip); |
|
254 | - } |
|
255 | - |
|
256 | - //set curl function timeout to $timeout |
|
257 | - curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout); |
|
258 | - //set method to post |
|
259 | - curl_setopt($this->ch, CURLOPT_POST, true); |
|
260 | - // disable Expect header |
|
261 | - // hack to make it working |
|
262 | - $headers = ['Expect: ']; |
|
263 | - curl_setopt($this->ch, CURLOPT_HTTPHEADER, $headers); |
|
264 | - // initialize result post array |
|
265 | - $result_post = []; |
|
266 | - //generate post string |
|
267 | - $post_array = []; |
|
268 | - $post_string_array = []; |
|
269 | - |
|
270 | - if (!is_array($postdata)) { |
|
271 | - return false; |
|
272 | - } |
|
273 | - |
|
274 | - foreach ($postdata as $key => $value) { |
|
275 | - $post_array[$key] = $value; |
|
276 | - $post_string_array[] = urlencode($key).'='.urlencode($value); |
|
277 | - } |
|
278 | - |
|
279 | - $post_string = implode('&', $post_string_array); |
|
280 | - if ($this->debug) { |
|
281 | - echo "Post String: $post_string\n"; |
|
282 | - } |
|
283 | - |
|
284 | - // set post string |
|
285 | - //curl_setopt($this->ch, CURLOPT_POSTFIELDS, $post_string); |
|
286 | - // set multipart form data - file array field-value pairs |
|
287 | - if (!empty($file_field_array)) { |
|
288 | - foreach ($file_field_array as $var_name => $var_value) { |
|
289 | - if (false !== strpos(PHP_OS, 'WIN')) { |
|
290 | - $var_value = str_replace('/', '\\', $var_value); |
|
291 | - } // win hack |
|
292 | - $file_field_array[$var_name] = '@'.$var_value; |
|
293 | - } |
|
294 | - } |
|
295 | - |
|
296 | - // set post data |
|
297 | - $result_post = array_merge($post_array, $file_field_array); |
|
298 | - curl_setopt($this->ch, CURLOPT_POSTFIELDS, $result_post); |
|
299 | - |
|
300 | - //and finally send curl request |
|
301 | - $result = curl_exec_redir($this->ch); |
|
302 | - if (curl_errno($this->ch)) { |
|
303 | - if ($this->debug) { |
|
304 | - echo "Error Occured in Curl\n"; |
|
305 | - echo 'Error number: '.curl_errno($this->ch)."\n"; |
|
306 | - echo 'Error message: '.curl_error($this->ch)."\n"; |
|
307 | - } |
|
308 | - |
|
309 | - return false; |
|
310 | - } else { |
|
311 | - return $result; |
|
312 | - } |
|
313 | - } |
|
314 | - |
|
315 | - /** |
|
316 | - * Set file location where cookie data will be stored and send on each new request. |
|
317 | - * |
|
318 | - * @param string absolute path to cookie file (must be in writable dir) |
|
319 | - */ |
|
320 | - public function storeCookies($cookie_file) |
|
321 | - { |
|
322 | - // use cookies on each request (cookies stored in $cookie_file) |
|
323 | - curl_setopt($this->ch, CURLOPT_COOKIEJAR, $cookie_file); |
|
324 | - curl_setopt($this->ch, CURLOPT_COOKIEFILE, $cookie_file); |
|
325 | - } |
|
326 | - |
|
327 | - /** |
|
328 | - * Set custom cookie. |
|
329 | - * |
|
330 | - * @param string cookie |
|
331 | - */ |
|
332 | - public function setCookie($cookie) |
|
333 | - { |
|
334 | - curl_setopt($this->ch, CURLOPT_COOKIE, $cookie); |
|
335 | - } |
|
336 | - |
|
337 | - /** |
|
338 | - * Get last URL info |
|
339 | - * usefull when original url was redirected to other location. |
|
340 | - * |
|
341 | - * @return string url |
|
342 | - */ |
|
343 | - public function getEffectiveUrl() |
|
344 | - { |
|
345 | - return curl_getinfo($this->ch, CURLINFO_EFFECTIVE_URL); |
|
346 | - } |
|
347 | - |
|
348 | - /** |
|
349 | - * Get http response code. |
|
350 | - * |
|
351 | - * @return int |
|
352 | - */ |
|
353 | - public function getHttpResponseCode() |
|
354 | - { |
|
355 | - return curl_getinfo($this->ch, CURLINFO_HTTP_CODE); |
|
356 | - } |
|
357 | - |
|
358 | - /** |
|
359 | - * Return last error message and error number. |
|
360 | - * |
|
361 | - * @return string error msg |
|
362 | - */ |
|
363 | - public function getErrorMsg() |
|
364 | - { |
|
365 | - $err = 'Error number: '.curl_errno($this->ch)."\n"; |
|
366 | - $err .= 'Error message: '.curl_error($this->ch)."\n"; |
|
367 | - |
|
368 | - return $err; |
|
369 | - } |
|
370 | - |
|
371 | - /** |
|
372 | - * Close curl session and free resource |
|
373 | - * Usually no need to call this function directly |
|
374 | - * in case you do you have to call init() to recreate curl. |
|
375 | - */ |
|
376 | - public function close() |
|
377 | - { |
|
378 | - //close curl session and free up resources |
|
379 | - curl_close($this->ch); |
|
380 | - } |
|
7 | + public $ch; |
|
8 | + public $debug = false; |
|
9 | + public $error_msg; |
|
10 | + |
|
11 | + public function CurlHttpClient($debug = false) |
|
12 | + { |
|
13 | + $this->debug = $debug; |
|
14 | + $this->init(); |
|
15 | + } |
|
16 | + |
|
17 | + public function init() |
|
18 | + { |
|
19 | + // initialize curl handle |
|
20 | + $this->ch = curl_init(); |
|
21 | + //set various options |
|
22 | + //set error in case http return code bigger than 300 |
|
23 | + curl_setopt($this->ch, CURLOPT_FAILONERROR, true); |
|
24 | + // use gzip if possible |
|
25 | + curl_setopt($this->ch, CURLOPT_ENCODING, 'gzip, deflate'); |
|
26 | + // do not veryfy ssl |
|
27 | + // this is important for windows |
|
28 | + // as well for being able to access pages with non valid cert |
|
29 | + curl_setopt($this->ch, CURLOPT_SSL_VERIFYPEER, 0); |
|
30 | + } |
|
31 | + |
|
32 | + /** |
|
33 | + * Set username/pass for basic http auth. |
|
34 | + * |
|
35 | + * @param string user |
|
36 | + * @param string pass |
|
37 | + */ |
|
38 | + public function setCredentials($username, $password) |
|
39 | + { |
|
40 | + curl_setopt($this->ch, CURLOPT_USERPWD, "$username:$password"); |
|
41 | + } |
|
42 | + |
|
43 | + /** |
|
44 | + * Set referrer. |
|
45 | + * |
|
46 | + * @param string referrer url |
|
47 | + */ |
|
48 | + public function setReferrer($referrer_url) |
|
49 | + { |
|
50 | + curl_setopt($this->ch, CURLOPT_REFERER, $referrer_url); |
|
51 | + } |
|
52 | + |
|
53 | + /** |
|
54 | + * Set client's userAgent. |
|
55 | + * |
|
56 | + * @param string user agent |
|
57 | + */ |
|
58 | + public function setUserAgent($userAgent) |
|
59 | + { |
|
60 | + curl_setopt($this->ch, CURLOPT_USERAGENT, $userAgent); |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * Set to receive output headers in all output functions. |
|
65 | + * |
|
66 | + * @param bool true to include all response headers with output, false otherwise |
|
67 | + */ |
|
68 | + public function includeResponseHeaders($value) |
|
69 | + { |
|
70 | + curl_setopt($this->ch, CURLOPT_HEADER, $value); |
|
71 | + } |
|
72 | + |
|
73 | + /** |
|
74 | + * Set proxy to use for each curl request. |
|
75 | + * |
|
76 | + * @param string proxy |
|
77 | + */ |
|
78 | + public function setProxy($proxy) |
|
79 | + { |
|
80 | + curl_setopt($this->ch, CURLOPT_PROXY, $proxy); |
|
81 | + } |
|
82 | + |
|
83 | + /** |
|
84 | + * Send post data to target URL |
|
85 | + * return data returned from url or false if error occured. |
|
86 | + * |
|
87 | + * @param string url |
|
88 | + * @param mixed post data (assoc array ie. $foo['post_var_name'] = $value or as string like var=val1&var2=val2) |
|
89 | + * @param string ip address to bind (default null) |
|
90 | + * @param int timeout in sec for complete curl operation (default 10) |
|
91 | + * |
|
92 | + * @return string data |
|
93 | + */ |
|
94 | + public function sendPostData($url, $postdata, $ip = null, $timeout = 10) |
|
95 | + { |
|
96 | + //set various curl options first |
|
97 | + // set url to post to |
|
98 | + curl_setopt($this->ch, CURLOPT_URL, $url); |
|
99 | + // return into a variable rather than displaying it |
|
100 | + curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true); |
|
101 | + |
|
102 | + //bind to specific ip address if it is sent trough arguments |
|
103 | + if ($ip) { |
|
104 | + if ($this->debug) { |
|
105 | + echo "Binding to ip $ip\n"; |
|
106 | + } |
|
107 | + curl_setopt($this->ch, CURLOPT_INTERFACE, $ip); |
|
108 | + } |
|
109 | + |
|
110 | + //set curl function timeout to $timeout |
|
111 | + curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout); |
|
112 | + |
|
113 | + //set method to post |
|
114 | + curl_setopt($this->ch, CURLOPT_POST, true); |
|
115 | + // set post string |
|
116 | + curl_setopt($this->ch, CURLOPT_POSTFIELDS, $postdata); |
|
117 | + |
|
118 | + //and finally send curl request |
|
119 | + $result = curl_exec_redir($this->ch); |
|
120 | + if (curl_errno($this->ch)) { |
|
121 | + if ($this->debug) { |
|
122 | + echo "Error Occured in Curl\n"; |
|
123 | + echo 'Error number: '.curl_errno($this->ch)."\n"; |
|
124 | + echo 'Error message: '.curl_error($this->ch)."\n"; |
|
125 | + } |
|
126 | + |
|
127 | + return false; |
|
128 | + } else { |
|
129 | + return $result; |
|
130 | + } |
|
131 | + } |
|
132 | + |
|
133 | + /** |
|
134 | + * fetch data from target URL |
|
135 | + * return data returned from url or false if error occured. |
|
136 | + * |
|
137 | + * @param string url |
|
138 | + * @param string ip address to bind (default null) |
|
139 | + * @param int timeout in sec for complete curl operation (default 5) |
|
140 | + * |
|
141 | + * @return string data |
|
142 | + */ |
|
143 | + public function fetchUrl($url, $ip = null, $timeout = 5) |
|
144 | + { |
|
145 | + // set url to post to |
|
146 | + curl_setopt($this->ch, CURLOPT_URL, $url); |
|
147 | + |
|
148 | + //set method to get |
|
149 | + curl_setopt($this->ch, CURLOPT_HTTPGET, true); |
|
150 | + // return into a variable rather than displaying it |
|
151 | + curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true); |
|
152 | + |
|
153 | + //bind to specific ip address if it is sent trough arguments |
|
154 | + if ($ip) { |
|
155 | + if ($this->debug) { |
|
156 | + echo "Binding to ip $ip\n"; |
|
157 | + } |
|
158 | + |
|
159 | + curl_setopt($this->ch, CURLOPT_INTERFACE, $ip); |
|
160 | + } |
|
161 | + |
|
162 | + //set curl function timeout to $timeout |
|
163 | + curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout); |
|
164 | + |
|
165 | + //and finally send curl request |
|
166 | + $result = curl_exec_redir($this->ch); |
|
167 | + if (curl_errno($this->ch)) { |
|
168 | + if ($this->debug) { |
|
169 | + echo "Error Occured in Curl\n"; |
|
170 | + echo 'Error number: '.curl_errno($this->ch)."\n"; |
|
171 | + echo 'Error message: '.curl_error($this->ch)."\n"; |
|
172 | + } |
|
173 | + |
|
174 | + return false; |
|
175 | + } else { |
|
176 | + return $result; |
|
177 | + } |
|
178 | + } |
|
179 | + |
|
180 | + /** |
|
181 | + * Fetch data from target URL |
|
182 | + * and store it directly to file. |
|
183 | + * |
|
184 | + * @param string url |
|
185 | + * @param resource value stream resource(ie. fopen) |
|
186 | + * @param string ip address to bind (default null) |
|
187 | + * @param int timeout in sec for complete curl operation (default 5) |
|
188 | + * |
|
189 | + * @return bool true on success false othervise |
|
190 | + */ |
|
191 | + public function fetchIntoFile($url, $fp, $ip = null, $timeout = 5) |
|
192 | + { |
|
193 | + // set url to post to |
|
194 | + curl_setopt($this->ch, CURLOPT_URL, $url); |
|
195 | + //set method to get |
|
196 | + curl_setopt($this->ch, CURLOPT_HTTPGET, true); |
|
197 | + // store data into file rather than displaying it |
|
198 | + curl_setopt($this->ch, CURLOPT_FILE, $fp); |
|
199 | + |
|
200 | + //bind to specific ip address if it is sent trough arguments |
|
201 | + if ($ip) { |
|
202 | + if ($this->debug) { |
|
203 | + echo "Binding to ip $ip\n"; |
|
204 | + } |
|
205 | + curl_setopt($this->ch, CURLOPT_INTERFACE, $ip); |
|
206 | + } |
|
207 | + |
|
208 | + //set curl function timeout to $timeout |
|
209 | + curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout); |
|
210 | + |
|
211 | + //and finally send curl request |
|
212 | + $result = curl_exec_redir($this->ch); |
|
213 | + if (curl_errno($this->ch)) { |
|
214 | + if ($this->debug) { |
|
215 | + echo "Error Occured in Curl\n"; |
|
216 | + echo 'Error number: '.curl_errno($this->ch)."\n"; |
|
217 | + echo 'Error message: '.curl_error($this->ch)."\n"; |
|
218 | + } |
|
219 | + |
|
220 | + return false; |
|
221 | + } else { |
|
222 | + return true; |
|
223 | + } |
|
224 | + } |
|
225 | + |
|
226 | + /** |
|
227 | + * Send multipart post data to the target URL |
|
228 | + * return data returned from url or false if error occured |
|
229 | + * (contribution by vule nikolic, [email protected]). |
|
230 | + * |
|
231 | + * @param string url |
|
232 | + * @param array assoc post data array ie. $foo['post_var_name'] = $value |
|
233 | + * @param array assoc $file_field_array, contains file_field name = value - path pairs |
|
234 | + * @param string ip address to bind (default null) |
|
235 | + * @param int timeout in sec for complete curl operation (default 30 sec) |
|
236 | + * |
|
237 | + * @return string data |
|
238 | + */ |
|
239 | + public function sendMultipartPostData($url, $postdata, $file_field_array = [], $ip = null, $timeout = 30) |
|
240 | + { |
|
241 | + //set various curl options first |
|
242 | + // set url to post to |
|
243 | + curl_setopt($this->ch, CURLOPT_URL, $url); |
|
244 | + // return into a variable rather than displaying it |
|
245 | + curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true); |
|
246 | + |
|
247 | + //bind to specific ip address if it is sent trough arguments |
|
248 | + if ($ip) { |
|
249 | + if ($this->debug) { |
|
250 | + echo "Binding to ip $ip\n"; |
|
251 | + } |
|
252 | + |
|
253 | + curl_setopt($this->ch, CURLOPT_INTERFACE, $ip); |
|
254 | + } |
|
255 | + |
|
256 | + //set curl function timeout to $timeout |
|
257 | + curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout); |
|
258 | + //set method to post |
|
259 | + curl_setopt($this->ch, CURLOPT_POST, true); |
|
260 | + // disable Expect header |
|
261 | + // hack to make it working |
|
262 | + $headers = ['Expect: ']; |
|
263 | + curl_setopt($this->ch, CURLOPT_HTTPHEADER, $headers); |
|
264 | + // initialize result post array |
|
265 | + $result_post = []; |
|
266 | + //generate post string |
|
267 | + $post_array = []; |
|
268 | + $post_string_array = []; |
|
269 | + |
|
270 | + if (!is_array($postdata)) { |
|
271 | + return false; |
|
272 | + } |
|
273 | + |
|
274 | + foreach ($postdata as $key => $value) { |
|
275 | + $post_array[$key] = $value; |
|
276 | + $post_string_array[] = urlencode($key).'='.urlencode($value); |
|
277 | + } |
|
278 | + |
|
279 | + $post_string = implode('&', $post_string_array); |
|
280 | + if ($this->debug) { |
|
281 | + echo "Post String: $post_string\n"; |
|
282 | + } |
|
283 | + |
|
284 | + // set post string |
|
285 | + //curl_setopt($this->ch, CURLOPT_POSTFIELDS, $post_string); |
|
286 | + // set multipart form data - file array field-value pairs |
|
287 | + if (!empty($file_field_array)) { |
|
288 | + foreach ($file_field_array as $var_name => $var_value) { |
|
289 | + if (false !== strpos(PHP_OS, 'WIN')) { |
|
290 | + $var_value = str_replace('/', '\\', $var_value); |
|
291 | + } // win hack |
|
292 | + $file_field_array[$var_name] = '@'.$var_value; |
|
293 | + } |
|
294 | + } |
|
295 | + |
|
296 | + // set post data |
|
297 | + $result_post = array_merge($post_array, $file_field_array); |
|
298 | + curl_setopt($this->ch, CURLOPT_POSTFIELDS, $result_post); |
|
299 | + |
|
300 | + //and finally send curl request |
|
301 | + $result = curl_exec_redir($this->ch); |
|
302 | + if (curl_errno($this->ch)) { |
|
303 | + if ($this->debug) { |
|
304 | + echo "Error Occured in Curl\n"; |
|
305 | + echo 'Error number: '.curl_errno($this->ch)."\n"; |
|
306 | + echo 'Error message: '.curl_error($this->ch)."\n"; |
|
307 | + } |
|
308 | + |
|
309 | + return false; |
|
310 | + } else { |
|
311 | + return $result; |
|
312 | + } |
|
313 | + } |
|
314 | + |
|
315 | + /** |
|
316 | + * Set file location where cookie data will be stored and send on each new request. |
|
317 | + * |
|
318 | + * @param string absolute path to cookie file (must be in writable dir) |
|
319 | + */ |
|
320 | + public function storeCookies($cookie_file) |
|
321 | + { |
|
322 | + // use cookies on each request (cookies stored in $cookie_file) |
|
323 | + curl_setopt($this->ch, CURLOPT_COOKIEJAR, $cookie_file); |
|
324 | + curl_setopt($this->ch, CURLOPT_COOKIEFILE, $cookie_file); |
|
325 | + } |
|
326 | + |
|
327 | + /** |
|
328 | + * Set custom cookie. |
|
329 | + * |
|
330 | + * @param string cookie |
|
331 | + */ |
|
332 | + public function setCookie($cookie) |
|
333 | + { |
|
334 | + curl_setopt($this->ch, CURLOPT_COOKIE, $cookie); |
|
335 | + } |
|
336 | + |
|
337 | + /** |
|
338 | + * Get last URL info |
|
339 | + * usefull when original url was redirected to other location. |
|
340 | + * |
|
341 | + * @return string url |
|
342 | + */ |
|
343 | + public function getEffectiveUrl() |
|
344 | + { |
|
345 | + return curl_getinfo($this->ch, CURLINFO_EFFECTIVE_URL); |
|
346 | + } |
|
347 | + |
|
348 | + /** |
|
349 | + * Get http response code. |
|
350 | + * |
|
351 | + * @return int |
|
352 | + */ |
|
353 | + public function getHttpResponseCode() |
|
354 | + { |
|
355 | + return curl_getinfo($this->ch, CURLINFO_HTTP_CODE); |
|
356 | + } |
|
357 | + |
|
358 | + /** |
|
359 | + * Return last error message and error number. |
|
360 | + * |
|
361 | + * @return string error msg |
|
362 | + */ |
|
363 | + public function getErrorMsg() |
|
364 | + { |
|
365 | + $err = 'Error number: '.curl_errno($this->ch)."\n"; |
|
366 | + $err .= 'Error message: '.curl_error($this->ch)."\n"; |
|
367 | + |
|
368 | + return $err; |
|
369 | + } |
|
370 | + |
|
371 | + /** |
|
372 | + * Close curl session and free resource |
|
373 | + * Usually no need to call this function directly |
|
374 | + * in case you do you have to call init() to recreate curl. |
|
375 | + */ |
|
376 | + public function close() |
|
377 | + { |
|
378 | + //close curl session and free up resources |
|
379 | + curl_close($this->ch); |
|
380 | + } |
|
381 | 381 | } |
382 | 382 | |
383 | 383 | /** |
@@ -386,63 +386,63 @@ discard block |
||
386 | 386 | */ |
387 | 387 | function curlExecRedir($ch) |
388 | 388 | { |
389 | - static $curl_loops = 0; |
|
390 | - static $curl_max_loops = 20; |
|
389 | + static $curl_loops = 0; |
|
390 | + static $curl_max_loops = 20; |
|
391 | 391 | |
392 | - if ($curl_loops++ >= $curl_max_loops) { |
|
393 | - $curl_loops = 0; |
|
392 | + if ($curl_loops++ >= $curl_max_loops) { |
|
393 | + $curl_loops = 0; |
|
394 | 394 | |
395 | - return false; |
|
396 | - } |
|
395 | + return false; |
|
396 | + } |
|
397 | 397 | |
398 | - curl_setopt($ch, CURLOPT_HTTPHEADER, ['Expect:']); |
|
399 | - curl_setopt($ch, CURLOPT_HEADER, true); |
|
400 | - curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); |
|
401 | - curl_setopt($ch, CURLOPT_VERBOSE, false); |
|
402 | - $data = curl_exec($ch); |
|
403 | - $data = str_replace("\r", "\n", str_replace("\r\n", "\n", $data)); |
|
404 | - list($header, $data) = explode("\n\n", $data, 2); |
|
405 | - $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); |
|
398 | + curl_setopt($ch, CURLOPT_HTTPHEADER, ['Expect:']); |
|
399 | + curl_setopt($ch, CURLOPT_HEADER, true); |
|
400 | + curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); |
|
401 | + curl_setopt($ch, CURLOPT_VERBOSE, false); |
|
402 | + $data = curl_exec($ch); |
|
403 | + $data = str_replace("\r", "\n", str_replace("\r\n", "\n", $data)); |
|
404 | + list($header, $data) = explode("\n\n", $data, 2); |
|
405 | + $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); |
|
406 | 406 | |
407 | - //echo "*** Got HTTP code: $http_code ***\n"; |
|
408 | - //echo "** Got headers: \n$header\n\n"; |
|
407 | + //echo "*** Got HTTP code: $http_code ***\n"; |
|
408 | + //echo "** Got headers: \n$header\n\n"; |
|
409 | 409 | |
410 | - if (301 == $http_code || 302 == $http_code) { |
|
411 | - // If we're redirected, we should revert to GET |
|
412 | - curl_setopt($ch, CURLOPT_HTTPGET, true); |
|
410 | + if (301 == $http_code || 302 == $http_code) { |
|
411 | + // If we're redirected, we should revert to GET |
|
412 | + curl_setopt($ch, CURLOPT_HTTPGET, true); |
|
413 | 413 | |
414 | - $matches = []; |
|
415 | - preg_match('/Location:\s*(.*?)(\n|$)/i', $header, $matches); |
|
416 | - $url = @parse_url(trim($matches[1])); |
|
414 | + $matches = []; |
|
415 | + preg_match('/Location:\s*(.*?)(\n|$)/i', $header, $matches); |
|
416 | + $url = @parse_url(trim($matches[1])); |
|
417 | 417 | |
418 | - if (!$url) { |
|
419 | - //couldn't process the url to redirect to |
|
420 | - $curl_loops = 0; |
|
418 | + if (!$url) { |
|
419 | + //couldn't process the url to redirect to |
|
420 | + $curl_loops = 0; |
|
421 | 421 | |
422 | - return $data; |
|
423 | - } |
|
422 | + return $data; |
|
423 | + } |
|
424 | 424 | |
425 | - $last_url = parse_url(curl_getinfo($ch, CURLINFO_EFFECTIVE_URL)); |
|
426 | - if (empty($url['scheme'])) { |
|
427 | - $url['scheme'] = $last_url['scheme']; |
|
428 | - } |
|
425 | + $last_url = parse_url(curl_getinfo($ch, CURLINFO_EFFECTIVE_URL)); |
|
426 | + if (empty($url['scheme'])) { |
|
427 | + $url['scheme'] = $last_url['scheme']; |
|
428 | + } |
|
429 | 429 | |
430 | - if (empty($url['host'])) { |
|
431 | - $url['host'] = $last_url['host']; |
|
432 | - } |
|
430 | + if (empty($url['host'])) { |
|
431 | + $url['host'] = $last_url['host']; |
|
432 | + } |
|
433 | 433 | |
434 | - if (empty($url['path'])) { |
|
435 | - $url['path'] = $last_url['path']; |
|
436 | - } |
|
434 | + if (empty($url['path'])) { |
|
435 | + $url['path'] = $last_url['path']; |
|
436 | + } |
|
437 | 437 | |
438 | - $new_url = $url['scheme'].'://'.$url['host'].$url['path'].(!empty($url['query']) ? '?'.$url['query'] : ''); |
|
439 | - //echo "Being redirected to $new_url\n"; |
|
440 | - curl_setopt($ch, CURLOPT_URL, $new_url); |
|
438 | + $new_url = $url['scheme'].'://'.$url['host'].$url['path'].(!empty($url['query']) ? '?'.$url['query'] : ''); |
|
439 | + //echo "Being redirected to $new_url\n"; |
|
440 | + curl_setopt($ch, CURLOPT_URL, $new_url); |
|
441 | 441 | |
442 | - return curl_exec_redir($ch); |
|
443 | - } else { |
|
444 | - $curl_loops = 0; |
|
442 | + return curl_exec_redir($ch); |
|
443 | + } else { |
|
444 | + $curl_loops = 0; |
|
445 | 445 | |
446 | - return $data; |
|
447 | - } |
|
446 | + return $data; |
|
447 | + } |
|
448 | 448 | } |
@@ -286,7 +286,7 @@ discard block |
||
286 | 286 | // set multipart form data - file array field-value pairs |
287 | 287 | if (!empty($file_field_array)) { |
288 | 288 | foreach ($file_field_array as $var_name => $var_value) { |
289 | - if (false !== strpos(PHP_OS, 'WIN')) { |
|
289 | + if (false!==strpos(PHP_OS, 'WIN')) { |
|
290 | 290 | $var_value = str_replace('/', '\\', $var_value); |
291 | 291 | } // win hack |
292 | 292 | $file_field_array[$var_name] = '@'.$var_value; |
@@ -389,7 +389,7 @@ discard block |
||
389 | 389 | static $curl_loops = 0; |
390 | 390 | static $curl_max_loops = 20; |
391 | 391 | |
392 | - if ($curl_loops++ >= $curl_max_loops) { |
|
392 | + if ($curl_loops++>=$curl_max_loops) { |
|
393 | 393 | $curl_loops = 0; |
394 | 394 | |
395 | 395 | return false; |
@@ -407,7 +407,7 @@ discard block |
||
407 | 407 | //echo "*** Got HTTP code: $http_code ***\n"; |
408 | 408 | //echo "** Got headers: \n$header\n\n"; |
409 | 409 | |
410 | - if (301 == $http_code || 302 == $http_code) { |
|
410 | + if (301==$http_code || 302==$http_code) { |
|
411 | 411 | // If we're redirected, we should revert to GET |
412 | 412 | curl_setopt($ch, CURLOPT_HTTPGET, true); |
413 | 413 |
@@ -10,194 +10,194 @@ |
||
10 | 10 | */ |
11 | 11 | class MemberAuthenticationResponse extends \Route4Me\Common |
12 | 12 | { |
13 | - /** @var boolean $status |
|
14 | - * True, if authentication process was finished successfuly. |
|
15 | - */ |
|
16 | - public $status; |
|
17 | - |
|
18 | - /** @var string $geocoding_service |
|
19 | - * Geocoding service |
|
20 | - */ |
|
21 | - public $geocoding_service; |
|
22 | - |
|
23 | - /** @var int $session_id |
|
24 | - * Session ID |
|
25 | - */ |
|
26 | - public $session_id; |
|
27 | - |
|
28 | - /** @var string $session_guid |
|
29 | - * Session guid |
|
30 | - */ |
|
31 | - public $session_guid; |
|
32 | - |
|
33 | - /** @var int $member_id |
|
34 | - * Member ID |
|
35 | - */ |
|
36 | - public $member_id; |
|
37 | - |
|
38 | - /** @var string $api_key |
|
39 | - * API key of an user |
|
40 | - */ |
|
41 | - public $api_key; |
|
42 | - |
|
43 | - /** @var int $tracking_ttl |
|
44 | - * Tracking TTL |
|
45 | - */ |
|
46 | - public $tracking_ttl; |
|
47 | - |
|
48 | - /** @var string $update_channel_name |
|
49 | - * Update channel name |
|
50 | - */ |
|
51 | - public $update_channel_name; |
|
52 | - |
|
53 | - /** @var string $geofence_polygon_shape |
|
54 | - * Geofence polygon shape. ENUM('circle', 'poly', 'rect'). |
|
55 | - */ |
|
56 | - public $geofence_polygon_shape ; |
|
57 | - |
|
58 | - /** @var int $geofence_polygon_size |
|
59 | - * Geofence polygon size |
|
60 | - */ |
|
61 | - public $geofence_polygon_size; |
|
62 | - |
|
63 | - /** @var int $geofence_time_onsite_trigger_secs |
|
64 | - * Geofence time onsite trigger in seconds. |
|
65 | - */ |
|
66 | - public $geofence_time_onsite_trigger_secs; |
|
67 | - |
|
68 | - /** @var int $geofence_minimum_trigger_speed |
|
69 | - * Geofence minimum trigger speed. |
|
70 | - */ |
|
71 | - public $geofence_minimum_trigger_speed; |
|
72 | - |
|
73 | - /** @var boolean $is_subscription_past_due |
|
74 | - * If true, subscription is past due. |
|
75 | - */ |
|
76 | - public $is_subscription_past_due; |
|
77 | - |
|
78 | - /** @var string $visited_departed_enabled |
|
79 | - * if true, triggering of the visited and departed activities is enabled. |
|
80 | - */ |
|
81 | - public $visited_departed_enabled; |
|
82 | - |
|
83 | - /** @var string $long_press_enabled |
|
84 | - * if true, long press is enabled. |
|
85 | - */ |
|
86 | - public $long_press_enabled; |
|
87 | - |
|
88 | - /** @var string $account_type_id |
|
89 | - * The account type ID |
|
90 | - */ |
|
91 | - public $account_type_id; |
|
92 | - |
|
93 | - /** @var string $account_type_alias |
|
94 | - * Account type alias. |
|
95 | - */ |
|
96 | - public $account_type_alias; |
|
97 | - |
|
98 | - /** @var string $member_type |
|
99 | - * A type of the member. |
|
100 | - * Available values: |
|
101 | - * 'PRIMARY_ACCOUNT', |
|
102 | - * 'SUB_ACCOUNT_ADMIN', |
|
103 | - * 'SUB_ACCOUNT_REGIONAL_MANAGER', |
|
104 | - * 'SUB_ACCOUNT_DISPATCHER', |
|
105 | - * 'SUB_ACCOUNT_PLANNER', |
|
106 | - * 'SUB_ACCOUNT_DRIVER', |
|
107 | - * 'SUB_ACCOUNT_ANALYST', |
|
108 | - * 'SUB_ACCOUNT_VENDOR', |
|
109 | - * 'SUB_ACCOUNT_CUSTOMER_SERVICE' |
|
110 | - */ |
|
111 | - public $member_type; |
|
112 | - |
|
113 | - /** @var string $max_stops_per_route |
|
114 | - * Maximum stops per route. |
|
115 | - */ |
|
116 | - public $max_stops_per_route; |
|
117 | - |
|
118 | - /** @var string $max_routes |
|
119 | - * Maximum number of the routes. |
|
120 | - */ |
|
121 | - public $max_routes; |
|
122 | - |
|
123 | - /** @var int $routes_planned |
|
124 | - * Number of the planned routes by an user. |
|
125 | - */ |
|
126 | - public $routes_planned; |
|
127 | - |
|
128 | - /** @var string $preferred_units |
|
129 | - * Preferred units. Enum('km', 'mi'). |
|
130 | - */ |
|
131 | - public $preferred_units; |
|
132 | - |
|
133 | - /** @var string $preferred_language |
|
134 | - * Preferred language. Enum('en', 'fr'). |
|
135 | - */ |
|
136 | - public $preferred_language; |
|
137 | - |
|
138 | - /** @var string $HIDE_ROUTED_ADDRESSES |
|
139 | - * If true, routed addresses will be hidden. |
|
140 | - */ |
|
141 | - public $HIDE_ROUTED_ADDRESSES; |
|
142 | - |
|
143 | - /** @var string $HIDE_VISITED_ADDRESSES |
|
144 | - * If true, visited addresses will be hidden. |
|
145 | - */ |
|
146 | - public $HIDE_VISITED_ADDRESSES; |
|
147 | - |
|
148 | - /** @var string $HIDE_NONFUTURE_ROUTES |
|
149 | - * If equal to true, nonfuture addresses will be hidden. |
|
150 | - */ |
|
151 | - public $HIDE_NONFUTURE_ROUTES; |
|
152 | - |
|
153 | - /** @var string $READONLY_USER |
|
154 | - * If equal to true, user can only read data. |
|
155 | - */ |
|
156 | - public $READONLY_USER; |
|
157 | - |
|
158 | - /** @var int $auto_logout_ts |
|
159 | - * Time in seconds. If a user is inactive during this period, he will be logout. |
|
160 | - */ |
|
161 | - public $auto_logout_ts; |
|
162 | - |
|
163 | - /** @var string $last_known_member_payment_device |
|
164 | - * Last known member payment device (e.g. 'web') |
|
165 | - */ |
|
166 | - public $last_known_member_payment_device; |
|
167 | - |
|
168 | - /** @var int $account_expires_timestamp |
|
169 | - * Account expire date |
|
170 | - */ |
|
171 | - public $account_expires_timestamp; |
|
172 | - |
|
173 | - /** @var boolean $account_past_due |
|
174 | - * Account past due |
|
175 | - */ |
|
176 | - public $account_past_due; |
|
177 | - |
|
178 | - /** @var array $licensed_modules |
|
179 | - * Licensed module. e.g.: |
|
180 | - * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING', |
|
181 | - * 'MODULE__VOICE_NAVIGATION:TRUE', |
|
182 | - * 'MODULE__VOICE_NAVIGATION' |
|
183 | - */ |
|
184 | - public $licensed_modules; |
|
185 | - |
|
186 | - /** @var int $last_active_timestamp |
|
187 | - * Last active timestamp |
|
188 | - */ |
|
189 | - public $last_active_timestamp; |
|
190 | - |
|
191 | - public static function fromArray(array $params) |
|
192 | - { |
|
193 | - $memberAurhenticateResponse = new self(); |
|
194 | - |
|
195 | - foreach ($params as $key => $value) { |
|
196 | - if (property_exists($memberAurhenticateResponse, $key)) { |
|
197 | - $memberAurhenticateResponse->{$key} = $value; |
|
198 | - } |
|
199 | - } |
|
200 | - |
|
201 | - return $memberAurhenticateResponse; |
|
202 | - } |
|
13 | + /** @var boolean $status |
|
14 | + * True, if authentication process was finished successfuly. |
|
15 | + */ |
|
16 | + public $status; |
|
17 | + |
|
18 | + /** @var string $geocoding_service |
|
19 | + * Geocoding service |
|
20 | + */ |
|
21 | + public $geocoding_service; |
|
22 | + |
|
23 | + /** @var int $session_id |
|
24 | + * Session ID |
|
25 | + */ |
|
26 | + public $session_id; |
|
27 | + |
|
28 | + /** @var string $session_guid |
|
29 | + * Session guid |
|
30 | + */ |
|
31 | + public $session_guid; |
|
32 | + |
|
33 | + /** @var int $member_id |
|
34 | + * Member ID |
|
35 | + */ |
|
36 | + public $member_id; |
|
37 | + |
|
38 | + /** @var string $api_key |
|
39 | + * API key of an user |
|
40 | + */ |
|
41 | + public $api_key; |
|
42 | + |
|
43 | + /** @var int $tracking_ttl |
|
44 | + * Tracking TTL |
|
45 | + */ |
|
46 | + public $tracking_ttl; |
|
47 | + |
|
48 | + /** @var string $update_channel_name |
|
49 | + * Update channel name |
|
50 | + */ |
|
51 | + public $update_channel_name; |
|
52 | + |
|
53 | + /** @var string $geofence_polygon_shape |
|
54 | + * Geofence polygon shape. ENUM('circle', 'poly', 'rect'). |
|
55 | + */ |
|
56 | + public $geofence_polygon_shape ; |
|
57 | + |
|
58 | + /** @var int $geofence_polygon_size |
|
59 | + * Geofence polygon size |
|
60 | + */ |
|
61 | + public $geofence_polygon_size; |
|
62 | + |
|
63 | + /** @var int $geofence_time_onsite_trigger_secs |
|
64 | + * Geofence time onsite trigger in seconds. |
|
65 | + */ |
|
66 | + public $geofence_time_onsite_trigger_secs; |
|
67 | + |
|
68 | + /** @var int $geofence_minimum_trigger_speed |
|
69 | + * Geofence minimum trigger speed. |
|
70 | + */ |
|
71 | + public $geofence_minimum_trigger_speed; |
|
72 | + |
|
73 | + /** @var boolean $is_subscription_past_due |
|
74 | + * If true, subscription is past due. |
|
75 | + */ |
|
76 | + public $is_subscription_past_due; |
|
77 | + |
|
78 | + /** @var string $visited_departed_enabled |
|
79 | + * if true, triggering of the visited and departed activities is enabled. |
|
80 | + */ |
|
81 | + public $visited_departed_enabled; |
|
82 | + |
|
83 | + /** @var string $long_press_enabled |
|
84 | + * if true, long press is enabled. |
|
85 | + */ |
|
86 | + public $long_press_enabled; |
|
87 | + |
|
88 | + /** @var string $account_type_id |
|
89 | + * The account type ID |
|
90 | + */ |
|
91 | + public $account_type_id; |
|
92 | + |
|
93 | + /** @var string $account_type_alias |
|
94 | + * Account type alias. |
|
95 | + */ |
|
96 | + public $account_type_alias; |
|
97 | + |
|
98 | + /** @var string $member_type |
|
99 | + * A type of the member. |
|
100 | + * Available values: |
|
101 | + * 'PRIMARY_ACCOUNT', |
|
102 | + * 'SUB_ACCOUNT_ADMIN', |
|
103 | + * 'SUB_ACCOUNT_REGIONAL_MANAGER', |
|
104 | + * 'SUB_ACCOUNT_DISPATCHER', |
|
105 | + * 'SUB_ACCOUNT_PLANNER', |
|
106 | + * 'SUB_ACCOUNT_DRIVER', |
|
107 | + * 'SUB_ACCOUNT_ANALYST', |
|
108 | + * 'SUB_ACCOUNT_VENDOR', |
|
109 | + * 'SUB_ACCOUNT_CUSTOMER_SERVICE' |
|
110 | + */ |
|
111 | + public $member_type; |
|
112 | + |
|
113 | + /** @var string $max_stops_per_route |
|
114 | + * Maximum stops per route. |
|
115 | + */ |
|
116 | + public $max_stops_per_route; |
|
117 | + |
|
118 | + /** @var string $max_routes |
|
119 | + * Maximum number of the routes. |
|
120 | + */ |
|
121 | + public $max_routes; |
|
122 | + |
|
123 | + /** @var int $routes_planned |
|
124 | + * Number of the planned routes by an user. |
|
125 | + */ |
|
126 | + public $routes_planned; |
|
127 | + |
|
128 | + /** @var string $preferred_units |
|
129 | + * Preferred units. Enum('km', 'mi'). |
|
130 | + */ |
|
131 | + public $preferred_units; |
|
132 | + |
|
133 | + /** @var string $preferred_language |
|
134 | + * Preferred language. Enum('en', 'fr'). |
|
135 | + */ |
|
136 | + public $preferred_language; |
|
137 | + |
|
138 | + /** @var string $HIDE_ROUTED_ADDRESSES |
|
139 | + * If true, routed addresses will be hidden. |
|
140 | + */ |
|
141 | + public $HIDE_ROUTED_ADDRESSES; |
|
142 | + |
|
143 | + /** @var string $HIDE_VISITED_ADDRESSES |
|
144 | + * If true, visited addresses will be hidden. |
|
145 | + */ |
|
146 | + public $HIDE_VISITED_ADDRESSES; |
|
147 | + |
|
148 | + /** @var string $HIDE_NONFUTURE_ROUTES |
|
149 | + * If equal to true, nonfuture addresses will be hidden. |
|
150 | + */ |
|
151 | + public $HIDE_NONFUTURE_ROUTES; |
|
152 | + |
|
153 | + /** @var string $READONLY_USER |
|
154 | + * If equal to true, user can only read data. |
|
155 | + */ |
|
156 | + public $READONLY_USER; |
|
157 | + |
|
158 | + /** @var int $auto_logout_ts |
|
159 | + * Time in seconds. If a user is inactive during this period, he will be logout. |
|
160 | + */ |
|
161 | + public $auto_logout_ts; |
|
162 | + |
|
163 | + /** @var string $last_known_member_payment_device |
|
164 | + * Last known member payment device (e.g. 'web') |
|
165 | + */ |
|
166 | + public $last_known_member_payment_device; |
|
167 | + |
|
168 | + /** @var int $account_expires_timestamp |
|
169 | + * Account expire date |
|
170 | + */ |
|
171 | + public $account_expires_timestamp; |
|
172 | + |
|
173 | + /** @var boolean $account_past_due |
|
174 | + * Account past due |
|
175 | + */ |
|
176 | + public $account_past_due; |
|
177 | + |
|
178 | + /** @var array $licensed_modules |
|
179 | + * Licensed module. e.g.: |
|
180 | + * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING', |
|
181 | + * 'MODULE__VOICE_NAVIGATION:TRUE', |
|
182 | + * 'MODULE__VOICE_NAVIGATION' |
|
183 | + */ |
|
184 | + public $licensed_modules; |
|
185 | + |
|
186 | + /** @var int $last_active_timestamp |
|
187 | + * Last active timestamp |
|
188 | + */ |
|
189 | + public $last_active_timestamp; |
|
190 | + |
|
191 | + public static function fromArray(array $params) |
|
192 | + { |
|
193 | + $memberAurhenticateResponse = new self(); |
|
194 | + |
|
195 | + foreach ($params as $key => $value) { |
|
196 | + if (property_exists($memberAurhenticateResponse, $key)) { |
|
197 | + $memberAurhenticateResponse->{$key} = $value; |
|
198 | + } |
|
199 | + } |
|
200 | + |
|
201 | + return $memberAurhenticateResponse; |
|
202 | + } |
|
203 | 203 | } |
204 | 204 | \ No newline at end of file |
@@ -53,7 +53,7 @@ |
||
53 | 53 | /** @var string $geofence_polygon_shape |
54 | 54 | * Geofence polygon shape. ENUM('circle', 'poly', 'rect'). |
55 | 55 | */ |
56 | - public $geofence_polygon_shape ; |
|
56 | + public $geofence_polygon_shape; |
|
57 | 57 | |
58 | 58 | /** @var int $geofence_polygon_size |
59 | 59 | * Geofence polygon size |
@@ -7,51 +7,51 @@ |
||
7 | 7 | */ |
8 | 8 | class MemberCapabilities extends \Route4Me\Common |
9 | 9 | { |
10 | - /* |
|
10 | + /* |
|
11 | 11 | * Array of the avoidance zone IDs. |
12 | 12 | */ |
13 | - public $avoid = []; |
|
13 | + public $avoid = []; |
|
14 | 14 | |
15 | - /* |
|
15 | + /* |
|
16 | 16 | * Road avoid options: "Highways", "Tolls", "highways,tolls". |
17 | 17 | */ |
18 | - public $avoid_roads = []; |
|
18 | + public $avoid_roads = []; |
|
19 | 19 | |
20 | - /* |
|
20 | + /* |
|
21 | 21 | * Restriction options. |
22 | 22 | */ |
23 | - public $features = []; |
|
23 | + public $features = []; |
|
24 | 24 | |
25 | - /* |
|
25 | + /* |
|
26 | 26 | * Travel modes: "Highways", "Tolls", "highways,tolls". |
27 | 27 | */ |
28 | - public $travelModes = []; |
|
28 | + public $travelModes = []; |
|
29 | 29 | |
30 | - /* |
|
30 | + /* |
|
31 | 31 | * Navigate options |
32 | 32 | */ |
33 | - public $navigateBy = []; |
|
33 | + public $navigateBy = []; |
|
34 | 34 | |
35 | - /* |
|
35 | + /* |
|
36 | 36 | * Array of the license modules |
37 | 37 | */ |
38 | - public $LicensedModules = []; |
|
38 | + public $LicensedModules = []; |
|
39 | 39 | |
40 | - /* |
|
40 | + /* |
|
41 | 41 | * If true, the member subscription is commercial. |
42 | 42 | */ |
43 | - public $commercial; |
|
43 | + public $commercial; |
|
44 | 44 | |
45 | - public static function fromArray(array $params) |
|
46 | - { |
|
47 | - $memberCapabilities = new self(); |
|
45 | + public static function fromArray(array $params) |
|
46 | + { |
|
47 | + $memberCapabilities = new self(); |
|
48 | 48 | |
49 | - foreach ($params as $key => $value) { |
|
50 | - if (property_exists($memberCapabilities, $key)) { |
|
51 | - $memberCapabilities->{$key} = $value; |
|
52 | - } |
|
53 | - } |
|
49 | + foreach ($params as $key => $value) { |
|
50 | + if (property_exists($memberCapabilities, $key)) { |
|
51 | + $memberCapabilities->{$key} = $value; |
|
52 | + } |
|
53 | + } |
|
54 | 54 | |
55 | - return $memberCapabilities; |
|
56 | - } |
|
55 | + return $memberCapabilities; |
|
56 | + } |
|
57 | 57 | } |
@@ -9,411 +9,411 @@ |
||
9 | 9 | */ |
10 | 10 | class MemberResponse extends \Route4Me\Common |
11 | 11 | { |
12 | - /** @var boolean $authenticated |
|
13 | - * A boolean flag indicating if the session is valid. |
|
14 | - */ |
|
15 | - public $authenticated; |
|
16 | - |
|
17 | - /** @var boolean $status |
|
18 | - * Process status |
|
19 | - */ |
|
20 | - public $status; |
|
21 | - |
|
22 | - /** @var string $geocoding_service |
|
23 | - * Geocoding service |
|
24 | - */ |
|
25 | - public $geocoding_service; |
|
26 | - |
|
27 | - /** @var string $session_id |
|
28 | - * The integer session id of the current session. |
|
29 | - */ |
|
30 | - public $session_id; |
|
31 | - |
|
32 | - /** @var string $session_guid |
|
33 | - * An MD5 hash string of the currently authenticated sesssion, |
|
34 | - * important to use this with future requests. |
|
35 | - */ |
|
36 | - public $session_guid; |
|
37 | - |
|
38 | - /** @var string $member_first_name |
|
39 | - * The first name of the user. |
|
40 | - */ |
|
41 | - public $member_first_name; |
|
42 | - |
|
43 | - /** @var string $member_last_name |
|
44 | - * The last name of the user. |
|
45 | - */ |
|
46 | - public $member_last_name; |
|
47 | - |
|
48 | - /** @var int $member_timestamp_added |
|
49 | - * The unix timestamp when the user joined the service. |
|
50 | - */ |
|
51 | - public $member_timestamp_added; |
|
52 | - |
|
53 | - /** @var string $industry |
|
54 | - * The industry the authenticated user specified. |
|
55 | - */ |
|
56 | - public $industry; |
|
57 | - |
|
58 | - /** @var int $member_id |
|
59 | - * Member ID |
|
60 | - */ |
|
61 | - public $member_id; |
|
62 | - |
|
63 | - /** @var string $member_email |
|
64 | - * Member email |
|
65 | - */ |
|
66 | - public $member_email; |
|
67 | - |
|
68 | - /** @var boolean $is_trial |
|
69 | - * If the user is currently a trial customer. |
|
70 | - */ |
|
71 | - public $is_trial; |
|
72 | - |
|
73 | - /** @var boolean $is_active |
|
74 | - * If the user is currently an active customer. |
|
75 | - */ |
|
76 | - public $is_active; |
|
77 | - |
|
78 | - /** @var string $api_key |
|
79 | - * User's API key |
|
80 | - */ |
|
81 | - public $api_key; |
|
82 | - |
|
83 | - /** @var int $tracking_ttl |
|
84 | - * Tracking TTL |
|
85 | - */ |
|
86 | - public $tracking_ttl; |
|
87 | - |
|
88 | - /** @var boolean $hide_billing_section |
|
89 | - * Hide billing section. |
|
90 | - */ |
|
91 | - public $hide_billing_section; |
|
92 | - |
|
93 | - /** @var string $last_known_member_payment_device |
|
94 | - * Last known member payment device (e.g. 'web'). |
|
95 | - */ |
|
96 | - public $last_known_member_payment_device; |
|
97 | - |
|
98 | - /** @var array $licensed_modules |
|
99 | - * Licensed module. e.g.: |
|
100 | - * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING', |
|
101 | - * 'MODULE__VOICE_NAVIGATION:TRUE', |
|
102 | - * 'MODULE__VOICE_NAVIGATION' |
|
103 | - */ |
|
104 | - public $licensed_modules; |
|
105 | - |
|
106 | - /** @var boolean $member_business_type |
|
107 | - * Member business type (e.g. 'BUSINESS_EMPLOYEE'). |
|
108 | - */ |
|
109 | - public $member_business_type; |
|
110 | - |
|
111 | - /** @var string $geofence_polygon_shape |
|
112 | - * Geofence polygon shape. Available values: |
|
113 | - * 'circle', 'poly', 'rect'. |
|
114 | - */ |
|
115 | - public $geofence_polygon_shape; |
|
116 | - |
|
117 | - /** @var int $geofence_polygon_size |
|
118 | - * Geofence polygon size |
|
119 | - */ |
|
120 | - public $geofence_polygon_size; |
|
121 | - |
|
122 | - /** @var int $geofence_time_onsite_trigger_secs |
|
123 | - * Geofence onsite trigger time (seconds). |
|
124 | - */ |
|
125 | - public $geofence_time_onsite_trigger_secs; |
|
126 | - |
|
127 | - /** @var int $geofence_minimum_trigger_speed |
|
128 | - * Geofence's minimum trigger speed. |
|
129 | - */ |
|
130 | - public $geofence_minimum_trigger_speed; |
|
131 | - |
|
132 | - /** @var bool $is_subscription_past_due |
|
133 | - * True if the subscription is past due. |
|
134 | - */ |
|
135 | - public $is_subscription_past_due; |
|
136 | - |
|
137 | - /** @var string $visited_departed_enabled |
|
138 | - * If true, triggering of the visited and departed activities is enabled. |
|
139 | - */ |
|
140 | - public $visited_departed_enabled; |
|
141 | - |
|
142 | - /** @var string $long_press_enabled |
|
143 | - * If true, long press is enabled. |
|
144 | - */ |
|
145 | - public $long_press_enabled; |
|
146 | - |
|
147 | - /** @var int $account_type_id |
|
148 | - * The account type ID. |
|
149 | - */ |
|
150 | - public $account_type_id; |
|
151 | - |
|
152 | - /** @var string $current_price |
|
153 | - * Current price (e.g. '0.000'). |
|
154 | - */ |
|
155 | - public $current_price; |
|
156 | - |
|
157 | - /** @var int $initially_requested_account_type_id |
|
158 | - * Initially Requested account type ID. |
|
159 | - */ |
|
160 | - public $initially_requested_account_type_id; |
|
161 | - |
|
162 | - /** @var string $account_type_alias |
|
163 | - * Account type alias |
|
164 | - */ |
|
165 | - public $account_type_alias; |
|
166 | - |
|
167 | - /** @var string $member_type |
|
168 | - * Member type. Available values: |
|
169 | - * PRIMARY_ACCOUNT, SUB_ACCOUNT_ADMIN, SUB_ACCOUNT_REGIONAL_MANAGER, |
|
170 | - * SUB_ACCOUNT_DISPATCHER, SUB_ACCOUNT_PLANNER, SUB_ACCOUNT_DRIVER, |
|
171 | - * SUB_ACCOUNT_ANALYSTSUB_ACCOUNT_VENDORSUB_ACCOUNT_CUSTOMER_SERVICE |
|
172 | - */ |
|
173 | - public $member_type; |
|
174 | - |
|
175 | - /** @var string $OWNER_MEMBER_ID |
|
176 | - * Parent user ID. |
|
177 | - */ |
|
178 | - public $OWNER_MEMBER_ID; |
|
179 | - |
|
180 | - /** @var string $ROOT_OWNER_MEMBER_ID |
|
181 | - * Root owner member ID (e.g. '402088'). |
|
182 | - */ |
|
183 | - public $ROOT_OWNER_MEMBER_ID; |
|
184 | - |
|
185 | - /** @var string $ROOT_OWNER_MEMBER_EMAIL |
|
186 | - * Root owner member email. |
|
187 | - */ |
|
188 | - public $ROOT_OWNER_MEMBER_EMAIL; |
|
189 | - |
|
190 | - /** @var string $ROOT_OWNER_MEMBER_API_KEY |
|
191 | - * Root owner member API key. |
|
192 | - */ |
|
193 | - public $ROOT_OWNER_MEMBER_API_KEY; |
|
194 | - |
|
195 | - /** @var string $geocodingMethod |
|
196 | - * Geocoding method |
|
197 | - */ |
|
198 | - public $geocodingMethod; |
|
199 | - |
|
200 | - /** @var string $service_type |
|
201 | - * Service type (e.g. 'pre5'). |
|
202 | - */ |
|
203 | - public $service_type; |
|
204 | - |
|
205 | - /** @var string $validated_by |
|
206 | - * Validated by (e.g. 'ADMIN_PANEL'). |
|
207 | - */ |
|
208 | - public $validated_by; |
|
209 | - |
|
210 | - /** @var int $max_stops_per_route |
|
211 | - * Maximum allowed number of the stops per route. |
|
212 | - */ |
|
213 | - public $max_stops_per_route; |
|
214 | - |
|
215 | - /** @var int $max_routes |
|
216 | - * Maximum allowed number of the generated routes. |
|
217 | - */ |
|
218 | - public $max_routes; |
|
219 | - |
|
220 | - /** @var int $max_route |
|
221 | - * Maximum allowed number of the generated routes. |
|
222 | - */ |
|
223 | - public $max_route; |
|
224 | - |
|
225 | - /** @var int $route_planned |
|
226 | - * Planned route numbers |
|
227 | - */ |
|
228 | - public $route_planned; |
|
229 | - |
|
230 | - /** @var int $routes_planned |
|
231 | - * Routes Planned |
|
232 | - */ |
|
233 | - public $routes_planned; |
|
234 | - |
|
235 | - /** @var int $total_routes_planned |
|
236 | - * Total planned routes. |
|
237 | - */ |
|
238 | - public $total_routes_planned; |
|
239 | - |
|
240 | - /** @var int $authentication_count |
|
241 | - * Authentication count. |
|
242 | - */ |
|
243 | - public $authentication_count; |
|
244 | - |
|
245 | - /** @var string $salesforce_unique_record_id |
|
246 | - * Salesforce unique record ID. |
|
247 | - */ |
|
248 | - public $salesforce_unique_record_id; |
|
249 | - |
|
250 | - /** @var string $salesforce_account_id |
|
251 | - * Salesforce account ID |
|
252 | - */ |
|
253 | - public $salesforce_account_id; |
|
254 | - |
|
255 | - /** @var string $salesforce_lead_id |
|
256 | - * Salesforce lead ID |
|
257 | - */ |
|
258 | - public $salesforce_lead_id; |
|
259 | - |
|
260 | - /** @var int $max_api_optimization_addresses |
|
261 | - * The maximun number of addresses the authenticated user |
|
262 | - * can optimize in this billing cycle. |
|
263 | - */ |
|
264 | - public $max_api_optimization_addresses; |
|
265 | - |
|
266 | - /** @var int $max_api_geocoding_addresses |
|
267 | - * The maximun number of geocodings the authenticated user |
|
268 | - * can optimize in this billing cycle. |
|
269 | - */ |
|
270 | - public $max_api_geocoding_addresses; |
|
271 | - |
|
272 | - /** @var int $max_api_directions_addresses |
|
273 | - * The maximum number of driving route transactions the authenticated |
|
274 | - * user can execute in this billing cycle. |
|
275 | - */ |
|
276 | - public $max_api_directions_addresses; |
|
277 | - |
|
278 | - /** @var int $max_api_validation_addresses |
|
279 | - * The maximun number of address validation transactions the authenticated |
|
280 | - * user can execute in this billing cycle. |
|
281 | - */ |
|
282 | - public $max_api_validation_addresses; |
|
283 | - |
|
284 | - /** @var int $max_stops_per_unoptimized_route |
|
285 | - * The maximum number of stops the authenticated user |
|
286 | - * can put into a route with optimization disabled. |
|
287 | - */ |
|
288 | - public $max_stops_per_unoptimized_route; |
|
289 | - |
|
290 | - /** @var int $max_api_distance_tx |
|
291 | - * The maximum number of distance transactions the authenticated |
|
292 | - * user can execute in this billing cycle. |
|
293 | - */ |
|
294 | - public $max_api_distance_tx; |
|
295 | - |
|
296 | - /** @var boolean $blDisplayUpgradeTrackingHTML |
|
297 | - * Display upgrade tracking HTML. |
|
298 | - */ |
|
299 | - public $blDisplayUpgradeTrackingHTML; |
|
300 | - |
|
301 | - /** @var int $intTrackingTrigger |
|
302 | - * Tracking trigger (int). |
|
303 | - */ |
|
304 | - public $intTrackingTrigger; |
|
305 | - |
|
306 | - /** @var int $last_payment_ts |
|
307 | - * The last unix timestamp when this user was successfully charged. |
|
308 | - */ |
|
309 | - public $last_payment_ts; |
|
310 | - |
|
311 | - /** @var int $last_failed_payment_ts |
|
312 | - * The last unix timestamp when this user was failed to pay. |
|
313 | - */ |
|
314 | - public $last_failed_payment_ts; |
|
315 | - |
|
316 | - /** @var int $account_expires_timestamp |
|
317 | - * Account expire date |
|
318 | - */ |
|
319 | - public $account_expires_timestamp; |
|
320 | - |
|
321 | - /** @var boolean $account_past_due |
|
322 | - * Account past due |
|
323 | - */ |
|
324 | - public $account_past_due; |
|
325 | - |
|
326 | - /** @var string $ui_input_method |
|
327 | - * UI input method |
|
328 | - */ |
|
329 | - public $ui_input_method; |
|
330 | - |
|
331 | - /** @var string $registration_app |
|
332 | - * Registration application |
|
333 | - */ |
|
334 | - public $registration_app; |
|
335 | - |
|
336 | - /** @var string $registration_device |
|
337 | - * Registration device |
|
338 | - */ |
|
339 | - public $registration_device; |
|
340 | - |
|
341 | - /** @var string $preferred_units |
|
342 | - * Preferred units (mi, km) |
|
343 | - */ |
|
344 | - public $preferred_units; |
|
345 | - |
|
346 | - /** @var string $preferred_language |
|
347 | - * Preferred language (en, fr) |
|
348 | - */ |
|
349 | - public $preferred_language; |
|
350 | - |
|
351 | - /** @var string $hide_routed_addresses |
|
352 | - * If true, routed addresses will be hidden. |
|
353 | - */ |
|
354 | - public $hide_routed_addresses; |
|
355 | - |
|
356 | - /** @var string $show_superuser_addresses |
|
357 | - * Show superuser addresses ('0', '1'). |
|
358 | - */ |
|
359 | - public $show_superuser_addresses; |
|
360 | - |
|
361 | - /** @var string $appdirect_url |
|
362 | - * Application direction URL |
|
363 | - */ |
|
364 | - public $appdirect_url; |
|
365 | - |
|
366 | - /** @var int $timestamp_trial_expiration |
|
367 | - * Timestamp trial expiration |
|
368 | - */ |
|
369 | - public $timestamp_trial_expiration; |
|
370 | - |
|
371 | - /** @var string $update_channel_name |
|
372 | - * Update channel name |
|
373 | - */ |
|
374 | - public $update_channel_name; |
|
375 | - |
|
376 | - /** @var int $max_subusers_cnt |
|
377 | - * Maximum subusers count |
|
378 | - */ |
|
379 | - public $max_subusers_cnt; |
|
380 | - |
|
381 | - /** @var string $hide_visited_addresses |
|
382 | - * If true, visited addresses will be hidden. |
|
383 | - */ |
|
384 | - public $hide_visited_addresses; |
|
385 | - |
|
386 | - /** @var string $HIDE_NONFUTURE_ROUTES |
|
387 | - * If true, nonfuture routes will be hidden. |
|
388 | - */ |
|
389 | - public $HIDE_NONFUTURE_ROUTES; |
|
390 | - |
|
391 | - /** @var string $display_max_routes_future_days |
|
392 | - * Display maximum routes future days ('0', '1'). |
|
393 | - */ |
|
394 | - public $display_max_routes_future_days; |
|
395 | - |
|
396 | - /** @var string $READONLY_USER |
|
397 | - * Readonly uer ('0', '1'). |
|
398 | - */ |
|
399 | - public $READONLY_USER; |
|
400 | - |
|
401 | - /** @var int $auto_logout_ts |
|
402 | - * Time in seconds. A user will be logged out after been inactive during specified by this parameter seconds. |
|
403 | - */ |
|
404 | - public $auto_logout_ts; |
|
405 | - |
|
406 | - public static function fromArray(array $params) |
|
407 | - { |
|
408 | - $memberResponse = new self(); |
|
409 | - |
|
410 | - foreach ($params as $key => $value) { |
|
411 | - if (property_exists($memberResponse, $key)) { |
|
412 | - $memberResponse->{$key} = $value; |
|
413 | - } |
|
414 | - } |
|
415 | - |
|
416 | - return $memberResponse; |
|
417 | - } |
|
12 | + /** @var boolean $authenticated |
|
13 | + * A boolean flag indicating if the session is valid. |
|
14 | + */ |
|
15 | + public $authenticated; |
|
16 | + |
|
17 | + /** @var boolean $status |
|
18 | + * Process status |
|
19 | + */ |
|
20 | + public $status; |
|
21 | + |
|
22 | + /** @var string $geocoding_service |
|
23 | + * Geocoding service |
|
24 | + */ |
|
25 | + public $geocoding_service; |
|
26 | + |
|
27 | + /** @var string $session_id |
|
28 | + * The integer session id of the current session. |
|
29 | + */ |
|
30 | + public $session_id; |
|
31 | + |
|
32 | + /** @var string $session_guid |
|
33 | + * An MD5 hash string of the currently authenticated sesssion, |
|
34 | + * important to use this with future requests. |
|
35 | + */ |
|
36 | + public $session_guid; |
|
37 | + |
|
38 | + /** @var string $member_first_name |
|
39 | + * The first name of the user. |
|
40 | + */ |
|
41 | + public $member_first_name; |
|
42 | + |
|
43 | + /** @var string $member_last_name |
|
44 | + * The last name of the user. |
|
45 | + */ |
|
46 | + public $member_last_name; |
|
47 | + |
|
48 | + /** @var int $member_timestamp_added |
|
49 | + * The unix timestamp when the user joined the service. |
|
50 | + */ |
|
51 | + public $member_timestamp_added; |
|
52 | + |
|
53 | + /** @var string $industry |
|
54 | + * The industry the authenticated user specified. |
|
55 | + */ |
|
56 | + public $industry; |
|
57 | + |
|
58 | + /** @var int $member_id |
|
59 | + * Member ID |
|
60 | + */ |
|
61 | + public $member_id; |
|
62 | + |
|
63 | + /** @var string $member_email |
|
64 | + * Member email |
|
65 | + */ |
|
66 | + public $member_email; |
|
67 | + |
|
68 | + /** @var boolean $is_trial |
|
69 | + * If the user is currently a trial customer. |
|
70 | + */ |
|
71 | + public $is_trial; |
|
72 | + |
|
73 | + /** @var boolean $is_active |
|
74 | + * If the user is currently an active customer. |
|
75 | + */ |
|
76 | + public $is_active; |
|
77 | + |
|
78 | + /** @var string $api_key |
|
79 | + * User's API key |
|
80 | + */ |
|
81 | + public $api_key; |
|
82 | + |
|
83 | + /** @var int $tracking_ttl |
|
84 | + * Tracking TTL |
|
85 | + */ |
|
86 | + public $tracking_ttl; |
|
87 | + |
|
88 | + /** @var boolean $hide_billing_section |
|
89 | + * Hide billing section. |
|
90 | + */ |
|
91 | + public $hide_billing_section; |
|
92 | + |
|
93 | + /** @var string $last_known_member_payment_device |
|
94 | + * Last known member payment device (e.g. 'web'). |
|
95 | + */ |
|
96 | + public $last_known_member_payment_device; |
|
97 | + |
|
98 | + /** @var array $licensed_modules |
|
99 | + * Licensed module. e.g.: |
|
100 | + * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING', |
|
101 | + * 'MODULE__VOICE_NAVIGATION:TRUE', |
|
102 | + * 'MODULE__VOICE_NAVIGATION' |
|
103 | + */ |
|
104 | + public $licensed_modules; |
|
105 | + |
|
106 | + /** @var boolean $member_business_type |
|
107 | + * Member business type (e.g. 'BUSINESS_EMPLOYEE'). |
|
108 | + */ |
|
109 | + public $member_business_type; |
|
110 | + |
|
111 | + /** @var string $geofence_polygon_shape |
|
112 | + * Geofence polygon shape. Available values: |
|
113 | + * 'circle', 'poly', 'rect'. |
|
114 | + */ |
|
115 | + public $geofence_polygon_shape; |
|
116 | + |
|
117 | + /** @var int $geofence_polygon_size |
|
118 | + * Geofence polygon size |
|
119 | + */ |
|
120 | + public $geofence_polygon_size; |
|
121 | + |
|
122 | + /** @var int $geofence_time_onsite_trigger_secs |
|
123 | + * Geofence onsite trigger time (seconds). |
|
124 | + */ |
|
125 | + public $geofence_time_onsite_trigger_secs; |
|
126 | + |
|
127 | + /** @var int $geofence_minimum_trigger_speed |
|
128 | + * Geofence's minimum trigger speed. |
|
129 | + */ |
|
130 | + public $geofence_minimum_trigger_speed; |
|
131 | + |
|
132 | + /** @var bool $is_subscription_past_due |
|
133 | + * True if the subscription is past due. |
|
134 | + */ |
|
135 | + public $is_subscription_past_due; |
|
136 | + |
|
137 | + /** @var string $visited_departed_enabled |
|
138 | + * If true, triggering of the visited and departed activities is enabled. |
|
139 | + */ |
|
140 | + public $visited_departed_enabled; |
|
141 | + |
|
142 | + /** @var string $long_press_enabled |
|
143 | + * If true, long press is enabled. |
|
144 | + */ |
|
145 | + public $long_press_enabled; |
|
146 | + |
|
147 | + /** @var int $account_type_id |
|
148 | + * The account type ID. |
|
149 | + */ |
|
150 | + public $account_type_id; |
|
151 | + |
|
152 | + /** @var string $current_price |
|
153 | + * Current price (e.g. '0.000'). |
|
154 | + */ |
|
155 | + public $current_price; |
|
156 | + |
|
157 | + /** @var int $initially_requested_account_type_id |
|
158 | + * Initially Requested account type ID. |
|
159 | + */ |
|
160 | + public $initially_requested_account_type_id; |
|
161 | + |
|
162 | + /** @var string $account_type_alias |
|
163 | + * Account type alias |
|
164 | + */ |
|
165 | + public $account_type_alias; |
|
166 | + |
|
167 | + /** @var string $member_type |
|
168 | + * Member type. Available values: |
|
169 | + * PRIMARY_ACCOUNT, SUB_ACCOUNT_ADMIN, SUB_ACCOUNT_REGIONAL_MANAGER, |
|
170 | + * SUB_ACCOUNT_DISPATCHER, SUB_ACCOUNT_PLANNER, SUB_ACCOUNT_DRIVER, |
|
171 | + * SUB_ACCOUNT_ANALYSTSUB_ACCOUNT_VENDORSUB_ACCOUNT_CUSTOMER_SERVICE |
|
172 | + */ |
|
173 | + public $member_type; |
|
174 | + |
|
175 | + /** @var string $OWNER_MEMBER_ID |
|
176 | + * Parent user ID. |
|
177 | + */ |
|
178 | + public $OWNER_MEMBER_ID; |
|
179 | + |
|
180 | + /** @var string $ROOT_OWNER_MEMBER_ID |
|
181 | + * Root owner member ID (e.g. '402088'). |
|
182 | + */ |
|
183 | + public $ROOT_OWNER_MEMBER_ID; |
|
184 | + |
|
185 | + /** @var string $ROOT_OWNER_MEMBER_EMAIL |
|
186 | + * Root owner member email. |
|
187 | + */ |
|
188 | + public $ROOT_OWNER_MEMBER_EMAIL; |
|
189 | + |
|
190 | + /** @var string $ROOT_OWNER_MEMBER_API_KEY |
|
191 | + * Root owner member API key. |
|
192 | + */ |
|
193 | + public $ROOT_OWNER_MEMBER_API_KEY; |
|
194 | + |
|
195 | + /** @var string $geocodingMethod |
|
196 | + * Geocoding method |
|
197 | + */ |
|
198 | + public $geocodingMethod; |
|
199 | + |
|
200 | + /** @var string $service_type |
|
201 | + * Service type (e.g. 'pre5'). |
|
202 | + */ |
|
203 | + public $service_type; |
|
204 | + |
|
205 | + /** @var string $validated_by |
|
206 | + * Validated by (e.g. 'ADMIN_PANEL'). |
|
207 | + */ |
|
208 | + public $validated_by; |
|
209 | + |
|
210 | + /** @var int $max_stops_per_route |
|
211 | + * Maximum allowed number of the stops per route. |
|
212 | + */ |
|
213 | + public $max_stops_per_route; |
|
214 | + |
|
215 | + /** @var int $max_routes |
|
216 | + * Maximum allowed number of the generated routes. |
|
217 | + */ |
|
218 | + public $max_routes; |
|
219 | + |
|
220 | + /** @var int $max_route |
|
221 | + * Maximum allowed number of the generated routes. |
|
222 | + */ |
|
223 | + public $max_route; |
|
224 | + |
|
225 | + /** @var int $route_planned |
|
226 | + * Planned route numbers |
|
227 | + */ |
|
228 | + public $route_planned; |
|
229 | + |
|
230 | + /** @var int $routes_planned |
|
231 | + * Routes Planned |
|
232 | + */ |
|
233 | + public $routes_planned; |
|
234 | + |
|
235 | + /** @var int $total_routes_planned |
|
236 | + * Total planned routes. |
|
237 | + */ |
|
238 | + public $total_routes_planned; |
|
239 | + |
|
240 | + /** @var int $authentication_count |
|
241 | + * Authentication count. |
|
242 | + */ |
|
243 | + public $authentication_count; |
|
244 | + |
|
245 | + /** @var string $salesforce_unique_record_id |
|
246 | + * Salesforce unique record ID. |
|
247 | + */ |
|
248 | + public $salesforce_unique_record_id; |
|
249 | + |
|
250 | + /** @var string $salesforce_account_id |
|
251 | + * Salesforce account ID |
|
252 | + */ |
|
253 | + public $salesforce_account_id; |
|
254 | + |
|
255 | + /** @var string $salesforce_lead_id |
|
256 | + * Salesforce lead ID |
|
257 | + */ |
|
258 | + public $salesforce_lead_id; |
|
259 | + |
|
260 | + /** @var int $max_api_optimization_addresses |
|
261 | + * The maximun number of addresses the authenticated user |
|
262 | + * can optimize in this billing cycle. |
|
263 | + */ |
|
264 | + public $max_api_optimization_addresses; |
|
265 | + |
|
266 | + /** @var int $max_api_geocoding_addresses |
|
267 | + * The maximun number of geocodings the authenticated user |
|
268 | + * can optimize in this billing cycle. |
|
269 | + */ |
|
270 | + public $max_api_geocoding_addresses; |
|
271 | + |
|
272 | + /** @var int $max_api_directions_addresses |
|
273 | + * The maximum number of driving route transactions the authenticated |
|
274 | + * user can execute in this billing cycle. |
|
275 | + */ |
|
276 | + public $max_api_directions_addresses; |
|
277 | + |
|
278 | + /** @var int $max_api_validation_addresses |
|
279 | + * The maximun number of address validation transactions the authenticated |
|
280 | + * user can execute in this billing cycle. |
|
281 | + */ |
|
282 | + public $max_api_validation_addresses; |
|
283 | + |
|
284 | + /** @var int $max_stops_per_unoptimized_route |
|
285 | + * The maximum number of stops the authenticated user |
|
286 | + * can put into a route with optimization disabled. |
|
287 | + */ |
|
288 | + public $max_stops_per_unoptimized_route; |
|
289 | + |
|
290 | + /** @var int $max_api_distance_tx |
|
291 | + * The maximum number of distance transactions the authenticated |
|
292 | + * user can execute in this billing cycle. |
|
293 | + */ |
|
294 | + public $max_api_distance_tx; |
|
295 | + |
|
296 | + /** @var boolean $blDisplayUpgradeTrackingHTML |
|
297 | + * Display upgrade tracking HTML. |
|
298 | + */ |
|
299 | + public $blDisplayUpgradeTrackingHTML; |
|
300 | + |
|
301 | + /** @var int $intTrackingTrigger |
|
302 | + * Tracking trigger (int). |
|
303 | + */ |
|
304 | + public $intTrackingTrigger; |
|
305 | + |
|
306 | + /** @var int $last_payment_ts |
|
307 | + * The last unix timestamp when this user was successfully charged. |
|
308 | + */ |
|
309 | + public $last_payment_ts; |
|
310 | + |
|
311 | + /** @var int $last_failed_payment_ts |
|
312 | + * The last unix timestamp when this user was failed to pay. |
|
313 | + */ |
|
314 | + public $last_failed_payment_ts; |
|
315 | + |
|
316 | + /** @var int $account_expires_timestamp |
|
317 | + * Account expire date |
|
318 | + */ |
|
319 | + public $account_expires_timestamp; |
|
320 | + |
|
321 | + /** @var boolean $account_past_due |
|
322 | + * Account past due |
|
323 | + */ |
|
324 | + public $account_past_due; |
|
325 | + |
|
326 | + /** @var string $ui_input_method |
|
327 | + * UI input method |
|
328 | + */ |
|
329 | + public $ui_input_method; |
|
330 | + |
|
331 | + /** @var string $registration_app |
|
332 | + * Registration application |
|
333 | + */ |
|
334 | + public $registration_app; |
|
335 | + |
|
336 | + /** @var string $registration_device |
|
337 | + * Registration device |
|
338 | + */ |
|
339 | + public $registration_device; |
|
340 | + |
|
341 | + /** @var string $preferred_units |
|
342 | + * Preferred units (mi, km) |
|
343 | + */ |
|
344 | + public $preferred_units; |
|
345 | + |
|
346 | + /** @var string $preferred_language |
|
347 | + * Preferred language (en, fr) |
|
348 | + */ |
|
349 | + public $preferred_language; |
|
350 | + |
|
351 | + /** @var string $hide_routed_addresses |
|
352 | + * If true, routed addresses will be hidden. |
|
353 | + */ |
|
354 | + public $hide_routed_addresses; |
|
355 | + |
|
356 | + /** @var string $show_superuser_addresses |
|
357 | + * Show superuser addresses ('0', '1'). |
|
358 | + */ |
|
359 | + public $show_superuser_addresses; |
|
360 | + |
|
361 | + /** @var string $appdirect_url |
|
362 | + * Application direction URL |
|
363 | + */ |
|
364 | + public $appdirect_url; |
|
365 | + |
|
366 | + /** @var int $timestamp_trial_expiration |
|
367 | + * Timestamp trial expiration |
|
368 | + */ |
|
369 | + public $timestamp_trial_expiration; |
|
370 | + |
|
371 | + /** @var string $update_channel_name |
|
372 | + * Update channel name |
|
373 | + */ |
|
374 | + public $update_channel_name; |
|
375 | + |
|
376 | + /** @var int $max_subusers_cnt |
|
377 | + * Maximum subusers count |
|
378 | + */ |
|
379 | + public $max_subusers_cnt; |
|
380 | + |
|
381 | + /** @var string $hide_visited_addresses |
|
382 | + * If true, visited addresses will be hidden. |
|
383 | + */ |
|
384 | + public $hide_visited_addresses; |
|
385 | + |
|
386 | + /** @var string $HIDE_NONFUTURE_ROUTES |
|
387 | + * If true, nonfuture routes will be hidden. |
|
388 | + */ |
|
389 | + public $HIDE_NONFUTURE_ROUTES; |
|
390 | + |
|
391 | + /** @var string $display_max_routes_future_days |
|
392 | + * Display maximum routes future days ('0', '1'). |
|
393 | + */ |
|
394 | + public $display_max_routes_future_days; |
|
395 | + |
|
396 | + /** @var string $READONLY_USER |
|
397 | + * Readonly uer ('0', '1'). |
|
398 | + */ |
|
399 | + public $READONLY_USER; |
|
400 | + |
|
401 | + /** @var int $auto_logout_ts |
|
402 | + * Time in seconds. A user will be logged out after been inactive during specified by this parameter seconds. |
|
403 | + */ |
|
404 | + public $auto_logout_ts; |
|
405 | + |
|
406 | + public static function fromArray(array $params) |
|
407 | + { |
|
408 | + $memberResponse = new self(); |
|
409 | + |
|
410 | + foreach ($params as $key => $value) { |
|
411 | + if (property_exists($memberResponse, $key)) { |
|
412 | + $memberResponse->{$key} = $value; |
|
413 | + } |
|
414 | + } |
|
415 | + |
|
416 | + return $memberResponse; |
|
417 | + } |
|
418 | 418 | |
419 | 419 | } |
420 | 420 | \ No newline at end of file |
@@ -7,20 +7,20 @@ |
||
7 | 7 | */ |
8 | 8 | class MemberConfigurationResponse extends \Route4Me\Common |
9 | 9 | { |
10 | - /* |
|
10 | + /* |
|
11 | 11 | * Configuration result |
12 | 12 | */ |
13 | - public $result; |
|
13 | + public $result; |
|
14 | 14 | |
15 | - /* |
|
15 | + /* |
|
16 | 16 | * How many configuration key -> data pairs affected |
17 | 17 | */ |
18 | - public $affected; |
|
18 | + public $affected; |
|
19 | 19 | |
20 | - /* |
|
20 | + /* |
|
21 | 21 | * |
22 | 22 | */ |
23 | - public $data = []; |
|
23 | + public $data = []; |
|
24 | 24 | |
25 | 25 | |
26 | 26 |
@@ -13,152 +13,152 @@ |
||
13 | 13 | |
14 | 14 | class MemberConfiguration extends \Route4Me\Common |
15 | 15 | { |
16 | - /* |
|
16 | + /* |
|
17 | 17 | * The member ID |
18 | 18 | */ |
19 | - public $member_id; |
|
19 | + public $member_id; |
|
20 | 20 | |
21 | - /* |
|
21 | + /* |
|
22 | 22 | * The member's config key |
23 | 23 | */ |
24 | - public $config_key; |
|
24 | + public $config_key; |
|
25 | 25 | |
26 | - /* |
|
26 | + /* |
|
27 | 27 | * The member's config value |
28 | 28 | */ |
29 | - public $config_value; |
|
29 | + public $config_value; |
|
30 | 30 | |
31 | - /* |
|
31 | + /* |
|
32 | 32 | * True, if the value is hidden. |
33 | 33 | */ |
34 | - public $is_hidden_value; |
|
34 | + public $is_hidden_value; |
|
35 | 35 | |
36 | - /* |
|
36 | + /* |
|
37 | 37 | * If true, the value is showable. |
38 | 38 | */ |
39 | - public $can_unhide_value; |
|
39 | + public $can_unhide_value; |
|
40 | 40 | |
41 | - public function __construct() |
|
42 | - { |
|
43 | - Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
44 | - } |
|
41 | + public function __construct() |
|
42 | + { |
|
43 | + Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
44 | + } |
|
45 | 45 | |
46 | - public static function fromArray(array $params) |
|
47 | - { |
|
48 | - $memberConfiguration = new Self(); |
|
46 | + public static function fromArray(array $params) |
|
47 | + { |
|
48 | + $memberConfiguration = new Self(); |
|
49 | 49 | |
50 | - foreach ($params as $key => $value) { |
|
51 | - if (property_exists($memberConfiguration, $key)) { |
|
52 | - $memberConfiguration->{$key} = $value; |
|
53 | - } else { |
|
54 | - throw new BadParam("Correct parameter must be provided. Wrong Parameter: $key"); |
|
55 | - } |
|
56 | - } |
|
50 | + foreach ($params as $key => $value) { |
|
51 | + if (property_exists($memberConfiguration, $key)) { |
|
52 | + $memberConfiguration->{$key} = $value; |
|
53 | + } else { |
|
54 | + throw new BadParam("Correct parameter must be provided. Wrong Parameter: $key"); |
|
55 | + } |
|
56 | + } |
|
57 | 57 | |
58 | - return $memberConfiguration; |
|
59 | - } |
|
58 | + return $memberConfiguration; |
|
59 | + } |
|
60 | 60 | |
61 | - /* |
|
61 | + /* |
|
62 | 62 | * Create new member configuration key-value pair. |
63 | 63 | * @param array $params |
64 | 64 | * Contains key-value pair: 'config_key': 'config_value' |
65 | 65 | * @param string $errorText |
66 | 66 | * Error message text |
67 | 67 | */ |
68 | - public function CreateNewConfigurationData($params, &$errorText) |
|
69 | - { |
|
70 | - $allBodyFields = ['config_key', 'config_value']; |
|
71 | - |
|
72 | - $response = null; |
|
73 | - |
|
74 | - try { |
|
75 | - $response = Route4Me::makeRequst([ |
|
76 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
77 | - 'method' => 'POST', |
|
78 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
79 | - ]); |
|
80 | - } catch (Exception $ex) { |
|
81 | - $errorText = $ex->getMessage(); |
|
82 | - } finally { |
|
83 | - return $response; |
|
84 | - } |
|
85 | - } |
|
86 | - |
|
87 | - /* |
|
68 | + public function CreateNewConfigurationData($params, &$errorText) |
|
69 | + { |
|
70 | + $allBodyFields = ['config_key', 'config_value']; |
|
71 | + |
|
72 | + $response = null; |
|
73 | + |
|
74 | + try { |
|
75 | + $response = Route4Me::makeRequst([ |
|
76 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
77 | + 'method' => 'POST', |
|
78 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
79 | + ]); |
|
80 | + } catch (Exception $ex) { |
|
81 | + $errorText = $ex->getMessage(); |
|
82 | + } finally { |
|
83 | + return $response; |
|
84 | + } |
|
85 | + } |
|
86 | + |
|
87 | + /* |
|
88 | 88 | * Update the value of the specified key. |
89 | 89 | * @param array $params |
90 | 90 | * Contains key-value pair: 'config_key': 'config_value'. |
91 | 91 | * @param string $errorText |
92 | 92 | * Error message text |
93 | 93 | */ |
94 | - public function UpdateConfigurationData($params, &$errorText) |
|
95 | - { |
|
96 | - $allBodyFields = ['config_key', 'config_value']; |
|
97 | - |
|
98 | - $response = null; |
|
99 | - |
|
100 | - try { |
|
101 | - $response = Route4Me::makeRequst([ |
|
102 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
103 | - 'method' => 'PUT', |
|
104 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params) |
|
105 | - ]); |
|
106 | - } catch (Exception $ex) { |
|
107 | - $errorText = $ex->getMessage(); |
|
108 | - } finally { |
|
109 | - return $response; |
|
110 | - } |
|
111 | - } |
|
112 | - |
|
113 | - /* |
|
94 | + public function UpdateConfigurationData($params, &$errorText) |
|
95 | + { |
|
96 | + $allBodyFields = ['config_key', 'config_value']; |
|
97 | + |
|
98 | + $response = null; |
|
99 | + |
|
100 | + try { |
|
101 | + $response = Route4Me::makeRequst([ |
|
102 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
103 | + 'method' => 'PUT', |
|
104 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params) |
|
105 | + ]); |
|
106 | + } catch (Exception $ex) { |
|
107 | + $errorText = $ex->getMessage(); |
|
108 | + } finally { |
|
109 | + return $response; |
|
110 | + } |
|
111 | + } |
|
112 | + |
|
113 | + /* |
|
114 | 114 | * Removes specified member configuration key. |
115 | 115 | * @param array $params |
116 | 116 | * Contains key-value pair: 'config_key': 'config_value'. |
117 | 117 | * @param string $errorText |
118 | 118 | * Error message text |
119 | 119 | */ |
120 | - public function RemoveConfigurationData($params, &$errorText) |
|
121 | - { |
|
122 | - if (!isset($params['config_key'])) { |
|
123 | - $errorText = 'The parameter config_key is not specified'; |
|
124 | - return null; |
|
125 | - } |
|
126 | - |
|
127 | - $response = null; |
|
128 | - |
|
129 | - try { |
|
130 | - $response = Route4Me::makeRequst([ |
|
131 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
132 | - 'method' => 'DELETE', |
|
133 | - 'body' => [ |
|
134 | - 'config_key' => isset($params['config_key']) ? $params['config_key'] : null |
|
135 | - ], |
|
136 | - ]); |
|
137 | - } catch (Exception $ex) { |
|
138 | - $errorText = $ex->getMessage(); |
|
139 | - } finally { |
|
140 | - return $response; |
|
141 | - } |
|
142 | - } |
|
143 | - |
|
144 | - /* |
|
120 | + public function RemoveConfigurationData($params, &$errorText) |
|
121 | + { |
|
122 | + if (!isset($params['config_key'])) { |
|
123 | + $errorText = 'The parameter config_key is not specified'; |
|
124 | + return null; |
|
125 | + } |
|
126 | + |
|
127 | + $response = null; |
|
128 | + |
|
129 | + try { |
|
130 | + $response = Route4Me::makeRequst([ |
|
131 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
132 | + 'method' => 'DELETE', |
|
133 | + 'body' => [ |
|
134 | + 'config_key' => isset($params['config_key']) ? $params['config_key'] : null |
|
135 | + ], |
|
136 | + ]); |
|
137 | + } catch (Exception $ex) { |
|
138 | + $errorText = $ex->getMessage(); |
|
139 | + } finally { |
|
140 | + return $response; |
|
141 | + } |
|
142 | + } |
|
143 | + |
|
144 | + /* |
|
145 | 145 | * Retrieves configuration data from a member account. |
146 | 146 | * param array $params |
147 | 147 | * If specified, it contains the key 'config_key' and retrieved only corresponding configuration data, |
148 | 148 | * if not, all member configuration data retrieved. |
149 | 149 | */ |
150 | - public function GetConfigurationData($params=null) |
|
151 | - { |
|
152 | - $allQueryFields = ['config_key']; |
|
153 | - |
|
154 | - $response = Route4Me::makeRequst([ |
|
155 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
156 | - 'method' => 'GET', |
|
157 | - 'query' => [ |
|
158 | - 'config_key' => isset($params['config_key']) ? $params['config_key'] : null |
|
159 | - ], |
|
160 | - ]); |
|
161 | - |
|
162 | - return $response; |
|
163 | - } |
|
150 | + public function GetConfigurationData($params=null) |
|
151 | + { |
|
152 | + $allQueryFields = ['config_key']; |
|
153 | + |
|
154 | + $response = Route4Me::makeRequst([ |
|
155 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
156 | + 'method' => 'GET', |
|
157 | + 'query' => [ |
|
158 | + 'config_key' => isset($params['config_key']) ? $params['config_key'] : null |
|
159 | + ], |
|
160 | + ]); |
|
161 | + |
|
162 | + return $response; |
|
163 | + } |
|
164 | 164 | } |
165 | 165 | \ No newline at end of file |
@@ -147,7 +147,7 @@ |
||
147 | 147 | * If specified, it contains the key 'config_key' and retrieved only corresponding configuration data, |
148 | 148 | * if not, all member configuration data retrieved. |
149 | 149 | */ |
150 | - public function GetConfigurationData($params=null) |
|
150 | + public function GetConfigurationData($params = null) |
|
151 | 151 | { |
152 | 152 | $allQueryFields = ['config_key']; |
153 | 153 |
@@ -9,22 +9,22 @@ |
||
9 | 9 | */ |
10 | 10 | class ResultsResponseV4 extends \Route4Me\Common |
11 | 11 | { |
12 | - /** @var MemberResponseV4[] $results */ |
|
13 | - public $results; |
|
12 | + /** @var MemberResponseV4[] $results */ |
|
13 | + public $results; |
|
14 | 14 | |
15 | - /** @var int $total */ |
|
16 | - public $total; |
|
15 | + /** @var int $total */ |
|
16 | + public $total; |
|
17 | 17 | |
18 | - public static function fromArray(array $params) |
|
19 | - { |
|
20 | - $resultsResponseV4 = new self(); |
|
18 | + public static function fromArray(array $params) |
|
19 | + { |
|
20 | + $resultsResponseV4 = new self(); |
|
21 | 21 | |
22 | - foreach ($params as $key => $value) { |
|
23 | - if (property_exists($resultsResponseV4, $key)) { |
|
24 | - $resultsResponseV4->{$key} = $value; |
|
25 | - } |
|
26 | - } |
|
22 | + foreach ($params as $key => $value) { |
|
23 | + if (property_exists($resultsResponseV4, $key)) { |
|
24 | + $resultsResponseV4->{$key} = $value; |
|
25 | + } |
|
26 | + } |
|
27 | 27 | |
28 | - return $resultsResponseV4; |
|
29 | - } |
|
28 | + return $resultsResponseV4; |
|
29 | + } |
|
30 | 30 | } |
31 | 31 | \ No newline at end of file |
@@ -9,137 +9,137 @@ |
||
9 | 9 | */ |
10 | 10 | class MemberResponseV4 extends \Route4Me\Common |
11 | 11 | { |
12 | - /** @var string $HIDE_NONFUTURE_ROUTES |
|
13 | - * If true, the nonfuture routes will be hidden ('TRUE', 'FALSE'). |
|
14 | - */ |
|
15 | - public $HIDE_NONFUTURE_ROUTES; |
|
16 | - |
|
17 | - /** @var string $HIDE_ROUTED_ADDRESSES |
|
18 | - * If true, the routed addresses will be hidden ('TRUE', 'FALSE'). |
|
19 | - */ |
|
20 | - public $HIDE_ROUTED_ADDRESSES; |
|
21 | - |
|
22 | - /** @var string $HIDE_VISITED_ADDRESSES |
|
23 | - * If true, the visited addresses will be hidden ('TRUE', 'FALSE'). |
|
24 | - */ |
|
25 | - public $HIDE_VISITED_ADDRESSES; |
|
26 | - |
|
27 | - /** @var string $member_id |
|
28 | - * The member ID |
|
29 | - */ |
|
30 | - public $member_id; |
|
31 | - |
|
32 | - /** @var string $OWNER_MEMBER_ID |
|
33 | - * The user's account owner ID. |
|
34 | - */ |
|
35 | - public $OWNER_MEMBER_ID; |
|
36 | - |
|
37 | - /** @var string $READONLY_USER |
|
38 | - * If true, the user has read-only access type ('TRUE', 'FALSE'). |
|
39 | - */ |
|
40 | - public $READONLY_USER; |
|
41 | - |
|
42 | - /** @var string $SHOW_ALL_DRIVERS |
|
43 | - * If true, all drivers are visible to the user ('TRUE', 'FALSE'). |
|
44 | - */ |
|
45 | - public $SHOW_ALL_DRIVERS; |
|
46 | - |
|
47 | - /** @var string $SHOW_ALL_VEHICLES |
|
48 | - * If true, all vehicles are visible to the user ('1', '0'). |
|
49 | - */ |
|
50 | - public $SHOW_ALL_VEHICLES; |
|
51 | - |
|
52 | - /** @var string $date_of_birth |
|
53 | - * Birthdate of the user. |
|
54 | - */ |
|
55 | - public $date_of_birth; |
|
56 | - |
|
57 | - /** @var string $member_email |
|
58 | - * User's email. |
|
59 | - */ |
|
60 | - public $member_email; |
|
61 | - |
|
62 | - /** @var stringn $member_first_name |
|
63 | - * User's first name. |
|
64 | - */ |
|
65 | - public $member_first_name; |
|
66 | - |
|
67 | - /** @var string $member_last_name |
|
68 | - * User's last name. |
|
69 | - */ |
|
70 | - public $member_last_name; |
|
71 | - |
|
72 | - /** @var string $member_phone |
|
73 | - * User's phone number. |
|
74 | - */ |
|
75 | - public $member_phone; |
|
76 | - |
|
77 | - /** @var string $member_picture |
|
78 | - * A link to the user's picture. |
|
79 | - */ |
|
80 | - public $member_picture; |
|
81 | - |
|
82 | - /** @var string $member_type |
|
83 | - * Member type. Available values: |
|
84 | - * PRIMARY_ACCOUNT, SUB_ACCOUNT_ADMIN, SUB_ACCOUNT_REGIONAL_MANAGER, |
|
85 | - * SUB_ACCOUNT_DISPATCHER, SUB_ACCOUNT_PLANNER, SUB_ACCOUNT_DRIVER |
|
86 | - */ |
|
87 | - public $member_type; |
|
88 | - |
|
89 | - /** @var string $member_zipcode |
|
90 | - * User zipcode. |
|
91 | - */ |
|
92 | - public $member_zipcode; |
|
93 | - |
|
94 | - /** @var string $preferred_language |
|
95 | - * Preferred language (en, fr). |
|
96 | - */ |
|
97 | - public $preferred_language; |
|
98 | - |
|
99 | - /** @var string $preferred_units |
|
100 | - * Preferred unit (mi, km). |
|
101 | - */ |
|
102 | - public $preferred_units; |
|
103 | - |
|
104 | - /** @var string $timezone |
|
105 | - * Member's location timezone. |
|
106 | - */ |
|
107 | - public $timezone; |
|
108 | - |
|
109 | - /** @var string $user_reg_country_id |
|
110 | - * Registration country ID of a user. |
|
111 | - */ |
|
112 | - public $user_reg_country_id; |
|
113 | - |
|
114 | - /** @var string $user_reg_state_id |
|
115 | - * Registration state ID of a user. |
|
116 | - */ |
|
117 | - public $user_reg_state_id; |
|
118 | - |
|
119 | - /** @var int $level |
|
120 | - * Subordination level. 0 is the highest level. |
|
121 | - */ |
|
122 | - public $level; |
|
123 | - |
|
124 | - /** @var array $custom_data |
|
125 | - * The user's custom data. |
|
126 | - */ |
|
127 | - public $custom_data; |
|
128 | - |
|
129 | - /** @var string $api_key*/ |
|
130 | - public $api_key; |
|
131 | - |
|
132 | - public static function fromArray(array $params) |
|
133 | - { |
|
134 | - $memberResponseV4 = new self(); |
|
135 | - |
|
136 | - foreach ($params as $key => $value) { |
|
137 | - if (property_exists($memberResponseV4, $key)) { |
|
138 | - $memberResponseV4->{$key} = $value; |
|
139 | - } |
|
140 | - } |
|
141 | - |
|
142 | - return $memberResponseV4; |
|
143 | - } |
|
12 | + /** @var string $HIDE_NONFUTURE_ROUTES |
|
13 | + * If true, the nonfuture routes will be hidden ('TRUE', 'FALSE'). |
|
14 | + */ |
|
15 | + public $HIDE_NONFUTURE_ROUTES; |
|
16 | + |
|
17 | + /** @var string $HIDE_ROUTED_ADDRESSES |
|
18 | + * If true, the routed addresses will be hidden ('TRUE', 'FALSE'). |
|
19 | + */ |
|
20 | + public $HIDE_ROUTED_ADDRESSES; |
|
21 | + |
|
22 | + /** @var string $HIDE_VISITED_ADDRESSES |
|
23 | + * If true, the visited addresses will be hidden ('TRUE', 'FALSE'). |
|
24 | + */ |
|
25 | + public $HIDE_VISITED_ADDRESSES; |
|
26 | + |
|
27 | + /** @var string $member_id |
|
28 | + * The member ID |
|
29 | + */ |
|
30 | + public $member_id; |
|
31 | + |
|
32 | + /** @var string $OWNER_MEMBER_ID |
|
33 | + * The user's account owner ID. |
|
34 | + */ |
|
35 | + public $OWNER_MEMBER_ID; |
|
36 | + |
|
37 | + /** @var string $READONLY_USER |
|
38 | + * If true, the user has read-only access type ('TRUE', 'FALSE'). |
|
39 | + */ |
|
40 | + public $READONLY_USER; |
|
41 | + |
|
42 | + /** @var string $SHOW_ALL_DRIVERS |
|
43 | + * If true, all drivers are visible to the user ('TRUE', 'FALSE'). |
|
44 | + */ |
|
45 | + public $SHOW_ALL_DRIVERS; |
|
46 | + |
|
47 | + /** @var string $SHOW_ALL_VEHICLES |
|
48 | + * If true, all vehicles are visible to the user ('1', '0'). |
|
49 | + */ |
|
50 | + public $SHOW_ALL_VEHICLES; |
|
51 | + |
|
52 | + /** @var string $date_of_birth |
|
53 | + * Birthdate of the user. |
|
54 | + */ |
|
55 | + public $date_of_birth; |
|
56 | + |
|
57 | + /** @var string $member_email |
|
58 | + * User's email. |
|
59 | + */ |
|
60 | + public $member_email; |
|
61 | + |
|
62 | + /** @var stringn $member_first_name |
|
63 | + * User's first name. |
|
64 | + */ |
|
65 | + public $member_first_name; |
|
66 | + |
|
67 | + /** @var string $member_last_name |
|
68 | + * User's last name. |
|
69 | + */ |
|
70 | + public $member_last_name; |
|
71 | + |
|
72 | + /** @var string $member_phone |
|
73 | + * User's phone number. |
|
74 | + */ |
|
75 | + public $member_phone; |
|
76 | + |
|
77 | + /** @var string $member_picture |
|
78 | + * A link to the user's picture. |
|
79 | + */ |
|
80 | + public $member_picture; |
|
81 | + |
|
82 | + /** @var string $member_type |
|
83 | + * Member type. Available values: |
|
84 | + * PRIMARY_ACCOUNT, SUB_ACCOUNT_ADMIN, SUB_ACCOUNT_REGIONAL_MANAGER, |
|
85 | + * SUB_ACCOUNT_DISPATCHER, SUB_ACCOUNT_PLANNER, SUB_ACCOUNT_DRIVER |
|
86 | + */ |
|
87 | + public $member_type; |
|
88 | + |
|
89 | + /** @var string $member_zipcode |
|
90 | + * User zipcode. |
|
91 | + */ |
|
92 | + public $member_zipcode; |
|
93 | + |
|
94 | + /** @var string $preferred_language |
|
95 | + * Preferred language (en, fr). |
|
96 | + */ |
|
97 | + public $preferred_language; |
|
98 | + |
|
99 | + /** @var string $preferred_units |
|
100 | + * Preferred unit (mi, km). |
|
101 | + */ |
|
102 | + public $preferred_units; |
|
103 | + |
|
104 | + /** @var string $timezone |
|
105 | + * Member's location timezone. |
|
106 | + */ |
|
107 | + public $timezone; |
|
108 | + |
|
109 | + /** @var string $user_reg_country_id |
|
110 | + * Registration country ID of a user. |
|
111 | + */ |
|
112 | + public $user_reg_country_id; |
|
113 | + |
|
114 | + /** @var string $user_reg_state_id |
|
115 | + * Registration state ID of a user. |
|
116 | + */ |
|
117 | + public $user_reg_state_id; |
|
118 | + |
|
119 | + /** @var int $level |
|
120 | + * Subordination level. 0 is the highest level. |
|
121 | + */ |
|
122 | + public $level; |
|
123 | + |
|
124 | + /** @var array $custom_data |
|
125 | + * The user's custom data. |
|
126 | + */ |
|
127 | + public $custom_data; |
|
128 | + |
|
129 | + /** @var string $api_key*/ |
|
130 | + public $api_key; |
|
131 | + |
|
132 | + public static function fromArray(array $params) |
|
133 | + { |
|
134 | + $memberResponseV4 = new self(); |
|
135 | + |
|
136 | + foreach ($params as $key => $value) { |
|
137 | + if (property_exists($memberResponseV4, $key)) { |
|
138 | + $memberResponseV4->{$key} = $value; |
|
139 | + } |
|
140 | + } |
|
141 | + |
|
142 | + return $memberResponseV4; |
|
143 | + } |
|
144 | 144 | |
145 | 145 | } |
146 | 146 | \ No newline at end of file |
@@ -8,360 +8,360 @@ |
||
8 | 8 | |
9 | 9 | class Member extends \Route4Me\Common |
10 | 10 | { |
11 | - public $device_id; |
|
12 | - public $device_type; |
|
13 | - public $format; |
|
14 | - |
|
15 | - public $strEmail; |
|
16 | - public $strPassword; |
|
17 | - public $strPassword_1; |
|
18 | - public $strPassword_2; |
|
19 | - public $strFirstName; |
|
20 | - public $strLastName; |
|
21 | - public $strIndustry; |
|
22 | - public $chkTerms; |
|
23 | - public $plan; |
|
24 | - |
|
25 | - public $session_guid; |
|
26 | - public $member_id; |
|
27 | - |
|
28 | - public $email_address; |
|
29 | - public $first_name; |
|
30 | - public $last_name; |
|
31 | - public $phone_number; |
|
32 | - public $company_name; |
|
33 | - public $webinar_date; |
|
34 | - |
|
35 | - public $subscription_name; |
|
36 | - public $token; |
|
37 | - public $payload; |
|
38 | - |
|
39 | - public $HIDE_ROUTED_ADDRESSES; |
|
40 | - public $member_phone; |
|
41 | - public $member_zipcode; |
|
42 | - public $route_count; |
|
43 | - public $member_email; |
|
44 | - public $HIDE_VISITED_ADDRESSES; |
|
45 | - public $READONLY_USER; |
|
46 | - public $member_type; |
|
47 | - public $date_of_birth; |
|
48 | - public $member_first_name; |
|
49 | - public $member_password; |
|
50 | - public $HIDE_NONFUTURE_ROUTES; |
|
51 | - public $member_last_name; |
|
52 | - public $SHOW_ALL_VEHICLES; |
|
53 | - public $SHOW_ALL_DRIVERS; |
|
54 | - |
|
55 | - public $config_key; |
|
56 | - public $config_value; |
|
57 | - |
|
58 | - public $preferred_units; |
|
59 | - public $preferred_language; |
|
60 | - public $timezone; |
|
61 | - public $OWNER_MEMBER_ID; |
|
62 | - public $user_reg_state_id; |
|
63 | - public $user_reg_country_id; |
|
64 | - public $member_picture; |
|
65 | - public $api_key; |
|
66 | - public $custom_data; |
|
67 | - public $level; |
|
68 | - |
|
69 | - public function __construct() |
|
70 | - { |
|
71 | - Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
72 | - } |
|
73 | - |
|
74 | - public static function fromArray(array $params) |
|
75 | - { |
|
76 | - $member = new self(); |
|
77 | - |
|
78 | - foreach ($params as $key => $value) { |
|
79 | - if (property_exists($member, $key)) { |
|
80 | - $member->{$key} = $value; |
|
81 | - } |
|
82 | - } |
|
83 | - |
|
84 | - return $member; |
|
85 | - } |
|
86 | - |
|
87 | - public static function getUsers() |
|
88 | - { |
|
89 | - $response = Route4Me::makeRequst([ |
|
90 | - 'url' => Endpoint::USER_V4, |
|
91 | - 'method' => 'GET', |
|
92 | - ]); |
|
93 | - |
|
94 | - return $response; |
|
95 | - } |
|
96 | - |
|
97 | - public static function getUser($params) |
|
98 | - { |
|
99 | - $response = Route4Me::makeRequst([ |
|
100 | - 'url' => Endpoint::USER_V4, |
|
101 | - 'method' => 'GET', |
|
102 | - 'query' => [ |
|
103 | - 'member_id' => isset($params['member_id']) ? $params['member_id'] : null, |
|
104 | - ], |
|
105 | - ]); |
|
106 | - |
|
107 | - return $response; |
|
108 | - } |
|
109 | - |
|
110 | - public static function getUserLocations($param) |
|
111 | - { |
|
112 | - $response = Route4Me::makeRequst([ |
|
113 | - 'url' => Endpoint::VIEW_USER_LOCATIONS, |
|
114 | - 'method' => 'GET', |
|
115 | - 'query' => [ |
|
116 | - 'query' => $param, |
|
117 | - ], |
|
118 | - ]); |
|
119 | - |
|
120 | - return $response; |
|
121 | - } |
|
122 | - |
|
123 | - public static function addDeviceRecord($params) |
|
124 | - { |
|
125 | - $allQueryFields = ['device_id', 'device_type']; |
|
126 | - $allBodyFields = ['device_id', 'device_type', 'format']; |
|
127 | - |
|
128 | - $response = Route4Me::makeRequst([ |
|
129 | - 'url' => Endpoint::VERIFY_DEVICE_LICENSE, |
|
130 | - 'method' => 'POST', |
|
131 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
132 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
133 | - ]); |
|
134 | - |
|
135 | - return $response; |
|
136 | - } |
|
137 | - |
|
138 | - public static function createMember($params) |
|
139 | - { |
|
140 | - $excludeFields = ['session_guid', 'member_id', 'token', 'payload', 'webinar_date', |
|
141 | - 'company_name', 'config_key', 'config_value', 'api_key', ]; |
|
142 | - |
|
143 | - $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields); |
|
144 | - |
|
145 | - $response = Route4Me::makeRequst([ |
|
146 | - 'url' => Endpoint::USER_V4, |
|
147 | - 'method' => 'POST', |
|
148 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
149 | - ]); |
|
150 | - |
|
151 | - return $response; |
|
152 | - } |
|
153 | - |
|
154 | - public static function getRandomMemberByType($memberType) |
|
155 | - { |
|
156 | - $members = self::getUsers(); |
|
157 | - |
|
158 | - if (is_null($members) || !isset($members['results'])) { |
|
159 | - return null; |
|
160 | - } |
|
161 | - |
|
162 | - $memberIDs = []; |
|
163 | - |
|
164 | - foreach ($members['results'] as $memb) { |
|
165 | - if (isset($memb['member_id']) && isset($memb['member_type'])) { |
|
166 | - if ($memberType == $memb['member_type']) { |
|
167 | - $memberIDs[] = $memb['member_id']; |
|
168 | - } |
|
169 | - } |
|
170 | - } |
|
171 | - |
|
172 | - if (sizeof($memberIDs) < 1) { |
|
173 | - return null; |
|
174 | - } |
|
175 | - |
|
176 | - $randomIndex = rand(0, sizeof($memberIDs) - 1); |
|
177 | - |
|
178 | - return $memberIDs[$randomIndex]; |
|
179 | - } |
|
180 | - |
|
181 | - public static function updateMember($body) |
|
182 | - { |
|
183 | - $excludeFields = ['session_guid', 'token', 'payload', 'webinar_date', |
|
184 | - 'company_name', 'config_key', 'config_value', 'api_key', ]; |
|
185 | - |
|
186 | - $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields); |
|
187 | - |
|
188 | - $response = Route4Me::makeRequst([ |
|
189 | - 'url' => Endpoint::USER_V4, |
|
190 | - 'method' => 'PUT', |
|
191 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $body), |
|
192 | - ]); |
|
193 | - |
|
194 | - return $response; |
|
195 | - } |
|
196 | - |
|
197 | - public static function deleteMember($body, &$errorText) |
|
198 | - { |
|
199 | - $response = null; |
|
200 | - |
|
201 | - try { |
|
202 | - $response = Route4Me::makeRequst([ |
|
203 | - 'url' => Endpoint::USER_V4, |
|
204 | - 'method' => 'DELETE', |
|
205 | - 'body' => [ |
|
206 | - 'member_id' => isset($body->member_id) ? $body->member_id : null, |
|
207 | - ], |
|
208 | - ]); |
|
209 | - } catch (Exception $ex) { |
|
210 | - $errorText = $ex->getMessage(); |
|
211 | - $response = null; |
|
212 | - } finally { |
|
213 | - return $response; |
|
214 | - } |
|
215 | - } |
|
216 | - |
|
217 | - public static function newAccountRegistration($params, &$errorText) |
|
218 | - { |
|
219 | - $allQueryFields = ['plan']; |
|
220 | - $allBodyFields = ['strEmail', 'strPassword_1', 'strPassword_2', 'strFirstName', |
|
221 | - 'strLastName', 'format', 'strIndustry', 'chkTerms', 'device_type', 'strSubAccountType', |
|
222 | - 'blDisableMarketing', 'blDisableAccountActivationEmail', ]; |
|
223 | - |
|
224 | - $response = null; |
|
225 | - |
|
226 | - try { |
|
227 | - $response = Route4Me::makeRequst([ |
|
228 | - 'url' => Endpoint::REGISTER_ACTION, |
|
229 | - 'method' => 'POST', |
|
230 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
231 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
232 | - 'HTTPHEADER' => 'Content-Type: multipart/form-data', |
|
233 | - ]); |
|
234 | - } catch (Exception $ex) { |
|
235 | - $response = null; |
|
236 | - $errorText = "Cannot registrate new account <br> ".$ex->getMessage(); |
|
237 | - } finally { |
|
238 | - return $response; |
|
239 | - } |
|
240 | - } |
|
241 | - |
|
242 | - public static function validateSession($params) |
|
243 | - { |
|
244 | - $allQueryFields = ['session_guid', 'member_id', 'format']; |
|
245 | - |
|
246 | - $response = Route4Me::makeRequst([ |
|
247 | - 'url' => Endpoint::VALIDATE_SESSION, |
|
248 | - 'method' => 'GET', |
|
249 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
250 | - ]); |
|
251 | - |
|
252 | - return $response; |
|
253 | - } |
|
254 | - |
|
255 | - public static function memberAuthentication($params) |
|
256 | - { |
|
257 | - $allBodyFields = ['strEmail', 'strPassword', 'format']; |
|
258 | - |
|
259 | - $response = Route4Me::makeRequst([ |
|
260 | - 'url' => Endpoint::AUTHENTICATE, |
|
261 | - 'method' => 'POST', |
|
262 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
263 | - 'HTTPHEADER' => 'Content-Type: multipart/form-data', |
|
264 | - ]); |
|
265 | - |
|
266 | - return $response; |
|
267 | - } |
|
268 | - |
|
269 | - public static function webinarRegistration($params) |
|
270 | - { |
|
271 | - $allBodyFields = ['email_address', 'first_name', 'last_name', 'phone_number', |
|
272 | - 'company_name', 'member_id', 'webinar_date', ]; |
|
273 | - |
|
274 | - $response = null; |
|
275 | - |
|
276 | - try { |
|
277 | - $response = Route4Me::makeRequst([ |
|
278 | - 'url' => Endpoint::WEBINAR_REGISTER, |
|
279 | - 'method' => 'POST', |
|
280 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
281 | - ]); |
|
282 | - } catch (Exception $ex) { |
|
283 | - $response = null; |
|
284 | - } finally { |
|
285 | - return $response; |
|
286 | - } |
|
287 | - } |
|
288 | - |
|
289 | - public static function purchaseUserLicense($params) |
|
290 | - { |
|
291 | - $allQueryFields = ['device_id']; |
|
292 | - $allBodyFields = ['member_id', 'session_guid', 'device_id', 'device_type', |
|
293 | - 'subscription_name', 'token', 'payload', 'format', ]; |
|
294 | - |
|
295 | - $response = Route4Me::makeRequst([ |
|
296 | - 'url' => Endpoint::USER_LICENSE, |
|
297 | - 'method' => 'POST', |
|
298 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
299 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
300 | - ]); |
|
301 | - |
|
302 | - return $response; |
|
303 | - } |
|
304 | - |
|
305 | - public static function newMemberConfigKey($params) |
|
306 | - { |
|
307 | - $allBodyFields = ['config_key', 'config_value']; |
|
308 | - |
|
309 | - $response = Route4Me::makeRequst([ |
|
310 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
311 | - 'method' => 'POST', |
|
312 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
313 | - ]); |
|
314 | - |
|
315 | - return $response; |
|
316 | - } |
|
317 | - |
|
318 | - public static function removeMemberConfigKey($params) |
|
319 | - { |
|
320 | - $allBodyFields = ['config_key']; |
|
321 | - |
|
322 | - $response = Route4Me::makeRequst([ |
|
323 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
324 | - 'method' => 'DELETE', |
|
325 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
326 | - ]); |
|
327 | - |
|
328 | - return $response; |
|
329 | - } |
|
330 | - |
|
331 | - public static function getMemberConfigData($params) |
|
332 | - { |
|
333 | - $allQueryFields = ['config_key']; |
|
334 | - |
|
335 | - $response = Route4Me::makeRequst([ |
|
336 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
337 | - 'method' => 'GET', |
|
338 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
339 | - ]); |
|
340 | - |
|
341 | - return $response; |
|
342 | - } |
|
343 | - |
|
344 | - public static function updateMemberConfigKey($params) |
|
345 | - { |
|
346 | - $allBodyFields = ['config_key', 'config_value']; |
|
347 | - |
|
348 | - $response = Route4Me::makeRequst([ |
|
349 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
350 | - 'method' => 'PUT', |
|
351 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
352 | - ]); |
|
353 | - |
|
354 | - return $response; |
|
355 | - } |
|
356 | - |
|
357 | - public static function getMemberCapabilities() |
|
358 | - { |
|
359 | - $response = Route4Me::makeRequst([ |
|
360 | - 'url' => Endpoint::MEMBER_CAPABILITIES, |
|
361 | - 'method' => 'GET', |
|
362 | - 'query' => Route4Me::generateRequestParameters([], null), |
|
363 | - ]); |
|
364 | - |
|
365 | - return $response; |
|
366 | - } |
|
11 | + public $device_id; |
|
12 | + public $device_type; |
|
13 | + public $format; |
|
14 | + |
|
15 | + public $strEmail; |
|
16 | + public $strPassword; |
|
17 | + public $strPassword_1; |
|
18 | + public $strPassword_2; |
|
19 | + public $strFirstName; |
|
20 | + public $strLastName; |
|
21 | + public $strIndustry; |
|
22 | + public $chkTerms; |
|
23 | + public $plan; |
|
24 | + |
|
25 | + public $session_guid; |
|
26 | + public $member_id; |
|
27 | + |
|
28 | + public $email_address; |
|
29 | + public $first_name; |
|
30 | + public $last_name; |
|
31 | + public $phone_number; |
|
32 | + public $company_name; |
|
33 | + public $webinar_date; |
|
34 | + |
|
35 | + public $subscription_name; |
|
36 | + public $token; |
|
37 | + public $payload; |
|
38 | + |
|
39 | + public $HIDE_ROUTED_ADDRESSES; |
|
40 | + public $member_phone; |
|
41 | + public $member_zipcode; |
|
42 | + public $route_count; |
|
43 | + public $member_email; |
|
44 | + public $HIDE_VISITED_ADDRESSES; |
|
45 | + public $READONLY_USER; |
|
46 | + public $member_type; |
|
47 | + public $date_of_birth; |
|
48 | + public $member_first_name; |
|
49 | + public $member_password; |
|
50 | + public $HIDE_NONFUTURE_ROUTES; |
|
51 | + public $member_last_name; |
|
52 | + public $SHOW_ALL_VEHICLES; |
|
53 | + public $SHOW_ALL_DRIVERS; |
|
54 | + |
|
55 | + public $config_key; |
|
56 | + public $config_value; |
|
57 | + |
|
58 | + public $preferred_units; |
|
59 | + public $preferred_language; |
|
60 | + public $timezone; |
|
61 | + public $OWNER_MEMBER_ID; |
|
62 | + public $user_reg_state_id; |
|
63 | + public $user_reg_country_id; |
|
64 | + public $member_picture; |
|
65 | + public $api_key; |
|
66 | + public $custom_data; |
|
67 | + public $level; |
|
68 | + |
|
69 | + public function __construct() |
|
70 | + { |
|
71 | + Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
72 | + } |
|
73 | + |
|
74 | + public static function fromArray(array $params) |
|
75 | + { |
|
76 | + $member = new self(); |
|
77 | + |
|
78 | + foreach ($params as $key => $value) { |
|
79 | + if (property_exists($member, $key)) { |
|
80 | + $member->{$key} = $value; |
|
81 | + } |
|
82 | + } |
|
83 | + |
|
84 | + return $member; |
|
85 | + } |
|
86 | + |
|
87 | + public static function getUsers() |
|
88 | + { |
|
89 | + $response = Route4Me::makeRequst([ |
|
90 | + 'url' => Endpoint::USER_V4, |
|
91 | + 'method' => 'GET', |
|
92 | + ]); |
|
93 | + |
|
94 | + return $response; |
|
95 | + } |
|
96 | + |
|
97 | + public static function getUser($params) |
|
98 | + { |
|
99 | + $response = Route4Me::makeRequst([ |
|
100 | + 'url' => Endpoint::USER_V4, |
|
101 | + 'method' => 'GET', |
|
102 | + 'query' => [ |
|
103 | + 'member_id' => isset($params['member_id']) ? $params['member_id'] : null, |
|
104 | + ], |
|
105 | + ]); |
|
106 | + |
|
107 | + return $response; |
|
108 | + } |
|
109 | + |
|
110 | + public static function getUserLocations($param) |
|
111 | + { |
|
112 | + $response = Route4Me::makeRequst([ |
|
113 | + 'url' => Endpoint::VIEW_USER_LOCATIONS, |
|
114 | + 'method' => 'GET', |
|
115 | + 'query' => [ |
|
116 | + 'query' => $param, |
|
117 | + ], |
|
118 | + ]); |
|
119 | + |
|
120 | + return $response; |
|
121 | + } |
|
122 | + |
|
123 | + public static function addDeviceRecord($params) |
|
124 | + { |
|
125 | + $allQueryFields = ['device_id', 'device_type']; |
|
126 | + $allBodyFields = ['device_id', 'device_type', 'format']; |
|
127 | + |
|
128 | + $response = Route4Me::makeRequst([ |
|
129 | + 'url' => Endpoint::VERIFY_DEVICE_LICENSE, |
|
130 | + 'method' => 'POST', |
|
131 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
132 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
133 | + ]); |
|
134 | + |
|
135 | + return $response; |
|
136 | + } |
|
137 | + |
|
138 | + public static function createMember($params) |
|
139 | + { |
|
140 | + $excludeFields = ['session_guid', 'member_id', 'token', 'payload', 'webinar_date', |
|
141 | + 'company_name', 'config_key', 'config_value', 'api_key', ]; |
|
142 | + |
|
143 | + $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields); |
|
144 | + |
|
145 | + $response = Route4Me::makeRequst([ |
|
146 | + 'url' => Endpoint::USER_V4, |
|
147 | + 'method' => 'POST', |
|
148 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
149 | + ]); |
|
150 | + |
|
151 | + return $response; |
|
152 | + } |
|
153 | + |
|
154 | + public static function getRandomMemberByType($memberType) |
|
155 | + { |
|
156 | + $members = self::getUsers(); |
|
157 | + |
|
158 | + if (is_null($members) || !isset($members['results'])) { |
|
159 | + return null; |
|
160 | + } |
|
161 | + |
|
162 | + $memberIDs = []; |
|
163 | + |
|
164 | + foreach ($members['results'] as $memb) { |
|
165 | + if (isset($memb['member_id']) && isset($memb['member_type'])) { |
|
166 | + if ($memberType == $memb['member_type']) { |
|
167 | + $memberIDs[] = $memb['member_id']; |
|
168 | + } |
|
169 | + } |
|
170 | + } |
|
171 | + |
|
172 | + if (sizeof($memberIDs) < 1) { |
|
173 | + return null; |
|
174 | + } |
|
175 | + |
|
176 | + $randomIndex = rand(0, sizeof($memberIDs) - 1); |
|
177 | + |
|
178 | + return $memberIDs[$randomIndex]; |
|
179 | + } |
|
180 | + |
|
181 | + public static function updateMember($body) |
|
182 | + { |
|
183 | + $excludeFields = ['session_guid', 'token', 'payload', 'webinar_date', |
|
184 | + 'company_name', 'config_key', 'config_value', 'api_key', ]; |
|
185 | + |
|
186 | + $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields); |
|
187 | + |
|
188 | + $response = Route4Me::makeRequst([ |
|
189 | + 'url' => Endpoint::USER_V4, |
|
190 | + 'method' => 'PUT', |
|
191 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $body), |
|
192 | + ]); |
|
193 | + |
|
194 | + return $response; |
|
195 | + } |
|
196 | + |
|
197 | + public static function deleteMember($body, &$errorText) |
|
198 | + { |
|
199 | + $response = null; |
|
200 | + |
|
201 | + try { |
|
202 | + $response = Route4Me::makeRequst([ |
|
203 | + 'url' => Endpoint::USER_V4, |
|
204 | + 'method' => 'DELETE', |
|
205 | + 'body' => [ |
|
206 | + 'member_id' => isset($body->member_id) ? $body->member_id : null, |
|
207 | + ], |
|
208 | + ]); |
|
209 | + } catch (Exception $ex) { |
|
210 | + $errorText = $ex->getMessage(); |
|
211 | + $response = null; |
|
212 | + } finally { |
|
213 | + return $response; |
|
214 | + } |
|
215 | + } |
|
216 | + |
|
217 | + public static function newAccountRegistration($params, &$errorText) |
|
218 | + { |
|
219 | + $allQueryFields = ['plan']; |
|
220 | + $allBodyFields = ['strEmail', 'strPassword_1', 'strPassword_2', 'strFirstName', |
|
221 | + 'strLastName', 'format', 'strIndustry', 'chkTerms', 'device_type', 'strSubAccountType', |
|
222 | + 'blDisableMarketing', 'blDisableAccountActivationEmail', ]; |
|
223 | + |
|
224 | + $response = null; |
|
225 | + |
|
226 | + try { |
|
227 | + $response = Route4Me::makeRequst([ |
|
228 | + 'url' => Endpoint::REGISTER_ACTION, |
|
229 | + 'method' => 'POST', |
|
230 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
231 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
232 | + 'HTTPHEADER' => 'Content-Type: multipart/form-data', |
|
233 | + ]); |
|
234 | + } catch (Exception $ex) { |
|
235 | + $response = null; |
|
236 | + $errorText = "Cannot registrate new account <br> ".$ex->getMessage(); |
|
237 | + } finally { |
|
238 | + return $response; |
|
239 | + } |
|
240 | + } |
|
241 | + |
|
242 | + public static function validateSession($params) |
|
243 | + { |
|
244 | + $allQueryFields = ['session_guid', 'member_id', 'format']; |
|
245 | + |
|
246 | + $response = Route4Me::makeRequst([ |
|
247 | + 'url' => Endpoint::VALIDATE_SESSION, |
|
248 | + 'method' => 'GET', |
|
249 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
250 | + ]); |
|
251 | + |
|
252 | + return $response; |
|
253 | + } |
|
254 | + |
|
255 | + public static function memberAuthentication($params) |
|
256 | + { |
|
257 | + $allBodyFields = ['strEmail', 'strPassword', 'format']; |
|
258 | + |
|
259 | + $response = Route4Me::makeRequst([ |
|
260 | + 'url' => Endpoint::AUTHENTICATE, |
|
261 | + 'method' => 'POST', |
|
262 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
263 | + 'HTTPHEADER' => 'Content-Type: multipart/form-data', |
|
264 | + ]); |
|
265 | + |
|
266 | + return $response; |
|
267 | + } |
|
268 | + |
|
269 | + public static function webinarRegistration($params) |
|
270 | + { |
|
271 | + $allBodyFields = ['email_address', 'first_name', 'last_name', 'phone_number', |
|
272 | + 'company_name', 'member_id', 'webinar_date', ]; |
|
273 | + |
|
274 | + $response = null; |
|
275 | + |
|
276 | + try { |
|
277 | + $response = Route4Me::makeRequst([ |
|
278 | + 'url' => Endpoint::WEBINAR_REGISTER, |
|
279 | + 'method' => 'POST', |
|
280 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
281 | + ]); |
|
282 | + } catch (Exception $ex) { |
|
283 | + $response = null; |
|
284 | + } finally { |
|
285 | + return $response; |
|
286 | + } |
|
287 | + } |
|
288 | + |
|
289 | + public static function purchaseUserLicense($params) |
|
290 | + { |
|
291 | + $allQueryFields = ['device_id']; |
|
292 | + $allBodyFields = ['member_id', 'session_guid', 'device_id', 'device_type', |
|
293 | + 'subscription_name', 'token', 'payload', 'format', ]; |
|
294 | + |
|
295 | + $response = Route4Me::makeRequst([ |
|
296 | + 'url' => Endpoint::USER_LICENSE, |
|
297 | + 'method' => 'POST', |
|
298 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
299 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
300 | + ]); |
|
301 | + |
|
302 | + return $response; |
|
303 | + } |
|
304 | + |
|
305 | + public static function newMemberConfigKey($params) |
|
306 | + { |
|
307 | + $allBodyFields = ['config_key', 'config_value']; |
|
308 | + |
|
309 | + $response = Route4Me::makeRequst([ |
|
310 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
311 | + 'method' => 'POST', |
|
312 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
313 | + ]); |
|
314 | + |
|
315 | + return $response; |
|
316 | + } |
|
317 | + |
|
318 | + public static function removeMemberConfigKey($params) |
|
319 | + { |
|
320 | + $allBodyFields = ['config_key']; |
|
321 | + |
|
322 | + $response = Route4Me::makeRequst([ |
|
323 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
324 | + 'method' => 'DELETE', |
|
325 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
326 | + ]); |
|
327 | + |
|
328 | + return $response; |
|
329 | + } |
|
330 | + |
|
331 | + public static function getMemberConfigData($params) |
|
332 | + { |
|
333 | + $allQueryFields = ['config_key']; |
|
334 | + |
|
335 | + $response = Route4Me::makeRequst([ |
|
336 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
337 | + 'method' => 'GET', |
|
338 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
339 | + ]); |
|
340 | + |
|
341 | + return $response; |
|
342 | + } |
|
343 | + |
|
344 | + public static function updateMemberConfigKey($params) |
|
345 | + { |
|
346 | + $allBodyFields = ['config_key', 'config_value']; |
|
347 | + |
|
348 | + $response = Route4Me::makeRequst([ |
|
349 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
350 | + 'method' => 'PUT', |
|
351 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
352 | + ]); |
|
353 | + |
|
354 | + return $response; |
|
355 | + } |
|
356 | + |
|
357 | + public static function getMemberCapabilities() |
|
358 | + { |
|
359 | + $response = Route4Me::makeRequst([ |
|
360 | + 'url' => Endpoint::MEMBER_CAPABILITIES, |
|
361 | + 'method' => 'GET', |
|
362 | + 'query' => Route4Me::generateRequestParameters([], null), |
|
363 | + ]); |
|
364 | + |
|
365 | + return $response; |
|
366 | + } |
|
367 | 367 | } |
@@ -163,13 +163,13 @@ |
||
163 | 163 | |
164 | 164 | foreach ($members['results'] as $memb) { |
165 | 165 | if (isset($memb['member_id']) && isset($memb['member_type'])) { |
166 | - if ($memberType == $memb['member_type']) { |
|
166 | + if ($memberType==$memb['member_type']) { |
|
167 | 167 | $memberIDs[] = $memb['member_id']; |
168 | 168 | } |
169 | 169 | } |
170 | 170 | } |
171 | 171 | |
172 | - if (sizeof($memberIDs) < 1) { |
|
172 | + if (sizeof($memberIDs)<1) { |
|
173 | 173 | return null; |
174 | 174 | } |
175 | 175 |