PluginProbe
WPGet API – Connect to any external REST API / 1.4.0
WPGet API – Connect to any external REST API v1.4.0
1.9.2 1.9.3 1.9.4 1.9.5 1.9.6 1.9.7 1.9.8 1.9.9 2.0.0 2.0.1 2.0.2 2.0.3 2.0.4 2.0.5 2.0.6 2.1.0 2.1.1 2.1.3 2.1.4 2.1.5 2.2.0 2.2.1 2.2.10 2.2.2 2.2.3 All 97 releases
← All changes | includes/class-api.php +105 -547 2.1.51.4.0 View file →
@@ -26,13 +26,9 @@
26 26 public $endpoint = ''; // the endpoint that we will get
27 27 public $query_parameters = ''; // the query paramaters appended to url
28 28 public $header_parameters = ''; // the header paramaters
29 29 public $body_parameters = ''; // the body paramaters
30 - public $body_json_encode = ''; // body_json_encode body
31 - public $body_url_encode = ''; // urlencode body
32 - public $body_base64_encode = ''; // base64 encode body
33 - public $body_xml_format = ''; // xml format body
34 - public $xml_root_node = 'root'; // root node for xml
30 + public $body_json_encode = ''; // the body_json_encode
35 31
36 32 public $response = ''; // the returned response
37 33
38 34 public $final_url = ''; // final URL
@@ -37,17 +33,12 @@
37 33
38 34 public $final_url = ''; // final URL
39 35 public $final_request_args = array(); // final request_args
40 36
41 - public $results_format = 'json_string'; // results format
37 + public $results_format = 'json_string'; // reseults format
42 38
43 - public $response_code = ''; // the response code from the call
44 -
45 39 public $timeout = 10; // the timeout
46 - public $sslverify = 1; // ssl verify
47 - public $debug = false;
48 -
49 - public $pro_plugin = false;
40 + public $sslverify = 1; // the paramaters
50 41
51 42
52 43 /**
53 44 * Main constructor
@@ -65,9 +56,9 @@
65 56 $this->endpoint_id = sanitize_text_field( $endpoint_id );
66 57 $this->keys = $keys;
67 58 $this->args = $args;
68 59
69 - add_filter( 'wpgetapi_raw_data', array( $this, 'maybe_add_debug_info' ), 99, 2 );
60 + add_filter( 'wpgetapi_raw_data', array( $this, 'maybe_add_debug_info' ), 5, 2 );
70 61
71 62 }
72 63
73 64
@@ -75,31 +66,8 @@
75 66 * Init our api data
76 67 */
77 68 public function init() {
78 69
79 - $this->pro_plugin = is_plugin_active( 'wpgetapi-extras/wpgetapi-extras.php' ) ? true : false;
80 -
81 - // if we are doing importer plugin,
82 - // we need to intercept and modify most of our methods values
83 - if( $this->api_id === 'wpgetapi_importer' ) {
84 -
85 - $data = apply_filters( 'wpgetapi_api_importer_init', $this );
86 -
87 - if( $data ) {
88 -
89 - foreach ($data as $key => $value) {
90 - $this->{$key} = $value;
91 - }
92 -
93 - $this->query_parameters = ! empty( $this->query_parameters ) ? $this->do_parameters( $this->query_parameters ) : array();
94 - $this->header_parameters = ! empty( $this->header_parameters ) ? $this->do_parameters( $this->header_parameters ) : array();
95 - $this->body_parameters = ! empty( $this->body_parameters ) ? $this->do_parameters( $this->body_parameters ) : array();
96 - return;
97 -
98 - }
99 -
100 - }
101 -
102 70 // do some checks
103 71 if( empty( $this->setup ) || ! isset( $this->setup['apis'] ) || empty( $this->setup['apis'] ) )
104 72 return 'No API found.';
105 73
@@ -118,9 +86,9 @@
118 86 // loop through endpoints
119 87 foreach ( $this->api['endpoints'] as $index => $endpoint ) {
120 88
121 89 if( $this->endpoint_id == $endpoint['id'] ) {
122 -
90 +
123 91 $this->method = isset( $endpoint['method'] ) && $endpoint['method'] != '' ? sanitize_text_field( $endpoint['method'] ) : 'GET';
124 92 $this->cache_time = isset( $endpoint['cache_time'] ) && ! empty( $endpoint['cache_time'] ) ? absint( $endpoint['cache_time'] ) : '';
125 93 $this->endpoint = isset( $endpoint['endpoint'] ) && ! empty( $endpoint['endpoint'] ) ? sanitize_text_field( $endpoint['endpoint'] ) : '';
126 94
@@ -129,40 +97,11 @@
129 97 $this->header_parameters = isset( $endpoint['header_parameters'] ) && ! empty( $endpoint['header_parameters'] ) ? $this->do_parameters( $endpoint['header_parameters'] ) : array();
130 98
131 99 $this->body_parameters = isset( $endpoint['body_parameters'] ) && ! empty( $endpoint['body_parameters'] ) ? $this->do_parameters( $endpoint['body_parameters'] ) : array();
132 100
133 - // how to encode the body
134 - $this->body_json_encode = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'true' ? true : false;
135 - $this->body_url_encode = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'url' ? true : false;
136 - $this->body_base64_encode = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'base64' ? true : false;
137 - $this->body_xml_format = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'xml' ? true : false;
138 -
139 - $this->xml_root_node = isset( $endpoint['xml_root'] ) && ! empty( $endpoint['xml_root'] ) ? $endpoint['xml_root'] : $this->xml_root_node;
140 -
101 + $this->body_json_encode = isset( $endpoint['body_json_encode'] ) && ! empty( $endpoint['body_json_encode'] ) ? sanitize_text_field( $endpoint['body_json_encode'] ) : true;
141 102 $this->results_format = isset( $endpoint['results_format'] ) ? sanitize_text_field( $endpoint['results_format'] ) : $this->results_format;
142 -
143 -
144 - if(
145 - // set the format to php array data if html format is set
146 - ( isset( $this->args['format'] ) && $this->args['format'] == 'html' && $this->results_format != 'xml_array' ) ||
147 - // set the format to php array data if it is set in the args (coming from the importer)
148 - ( isset( $this->args['results_format'] ) && $this->args['results_format'] == 'json_decoded' )
149 - ) {
150 - $this->results_format = 'json_decoded';
151 - }
152 -
153 - // set the format to JSON string if it is set in the args (coming from the wpdatatables integration)
154 - if( isset( $this->args['results_format'] ) && $this->args['results_format'] == 'json_string' ) {
155 - $this->results_format = 'json_string';
156 - }
157 -
158 - // set the format to JSON string if it is set in the args (coming from the wpdatatables integration)
159 - if( isset( $this->args['results_format'] ) && $this->args['results_format'] == 'json_decoded' ) {
160 - $this->results_format = 'json_decoded';
161 - }
162 -
163 103 }
164 -
165 104 }
166 105
167 106 $this->timeout = isset( $this->api['timeout'] ) && ! empty( $this->api['timeout'] ) ? $this->api['timeout'] : $this->timeout;
168 107 $this->sslverify = isset( $this->api['sslverify'] ) ? absint( $this->api['sslverify'] ) : $this->sslverify;
@@ -175,21 +114,58 @@
175 114 *
176 115 * @param string $field Field to retrieve
177 116 */
178 117 public function endpoint_output() {
118 + return $this->do_the_call();
119 + }
179 120
180 - do_action( 'wpgetapi_before_do_the_call', $this );
181 121
182 - return $this->do_the_call();
122 + /**
123 + * Sort out the parameters if they exist
124 + */
125 + public function do_parameters( $parameters ) {
126 +
127 + $new_array = array();
128 + $parameters = $this->decrypt($parameters);
183 129
130 + if( is_array( $parameters ) ) {
131 + foreach ( $parameters as $key => $parameter ) {
132 + if( ! empty( $parameter['name'] ) && ! empty( $parameter['value'] ) ) {
133 + $parameter['value'] = stripslashes( $parameter['value'] );
134 + $new_array[ sanitize_text_field( $parameter['name'] ) ] = $parameter['value'];
135 + }
136 + }
137 + }
138 +
139 + // look for array or json string and sort these out - for using such things in shortcode
140 + if( is_array( $new_array ) ) {
141 +
142 + foreach ( $new_array as $key => $value ) {
143 +
144 + // checking if the parameters have a json string
145 + if ( substr( $value, 0, 1 ) === '{' && substr( $value, -1 ) === '}' ) {
146 + $new_array[ $key ] = json_decode( $value, true);
147 + }
148 +
149 + // checking if the parameters have an array within the string
150 + // if they do, create them as an actual array
151 + if ( substr( $value, 0, 1 ) === '[' && substr( $value, -1 ) === ']' ) {
152 + $new_array[ $key ] = array( $value );
153 + }
154 +
155 + }
156 +
157 + }
158 +
159 + return $new_array;
160 +
184 161 }
185 162
186 -
187 163 /**
188 164 * Send the request and return our data
189 165 */
190 166 public function do_the_call() {
191 -
167 +
192 168 $this->init();
193 169
194 170 // build the URL
195 171 $this->final_url = apply_filters( 'wpgetapi_final_url', $this->build_url(), $this );
@@ -195,60 +171,28 @@
195 171 $this->final_url = apply_filters( 'wpgetapi_final_url', $this->build_url(), $this );
196 172
197 173 // build the request args
198 174 $this->final_request_args = apply_filters( 'wpgetapi_final_request_args', $this->build_request_args(), $this );
199 -
200 - /**
201 - * Check if we should stop or not. Setting $on to true, will stop us calling the api.
202 - * @param bool $on Whether on is set or not.
203 - */
204 175
205 - if ( apply_filters( 'wpgetapi_should_we_stop', false, $this ) ) {
206 - return;
207 - }
208 -
209 176 // POST request
210 177 if( $this->method == 'POST' )
211 178 $this->response = $this->POST_request();
212 179
213 - // PUT request
214 - if( $this->method == 'PUT' )
215 - $this->response = $this->PUT_request();
216 -
217 - // PATCH request
218 - if( $this->method == 'PATCH' )
219 - $this->response = $this->PATCH_request();
220 -
221 180 // GET request
222 181 if( $this->method == 'GET' )
223 182 $this->response = $this->GET_request();
224 183
225 - // DELETE request
226 - if( $this->method == 'DELETE' )
227 - $this->response = $this->DELETE_request();
228 -
229 184 // wp error
230 185 if( is_wp_error( $this->response ) ) {
231 - return apply_filters( 'wpgetapi_raw_error_data', json_encode( $this->response ), $this );
186 + return apply_filters( 'wpgetapi_raw_data', json_encode( $this->response ), $this );
232 187 }
233 188
234 - // get response_code
235 - $this->response_code = wp_remote_retrieve_response_code( $this->response );
189 + $data = wp_remote_retrieve_body( $this->response );
236 190
237 - // action to intercept call depending on response_code
238 - $this->response = apply_filters( 'wpgetapi_before_retrieve_body', $this->response, $this->response_code, $this );
239 -
240 - // get body
241 - // modified in version 1.6.1 to allow for OAuth 2.0 plugin returning body already
242 - $data = isset( $this->response['body'] ) ? $this->response['body'] : $this->response;
243 -
244 191 // returning in JSON format
245 192 if( $this->results_format == 'json_string' || $this->results_format == 'json_decoded' )
246 - $data = $this->return_data( $data );
193 + $data = $this->output_json( $data );
247 194
248 - if( $data === 'null' )
249 - $data = 'Result is null. Check that all endpoint settings are correct.';
250 -
251 195 return apply_filters( 'wpgetapi_raw_data', $data, $this );
252 196
253 197 }
254 198
@@ -261,33 +205,15 @@
261 205 // first make sure our endpoint starts with a slash
262 206 if ( substr( $this->endpoint, 0, 1 ) != '/' )
263 207 $this->endpoint = '/' . $this->endpoint;
264 208
265 - // if we have item_key from api to posts plugin
266 - // replace our keyword with the actual item_key value
267 - if ( isset( $this->args['item_key'] ) && strpos( $this->endpoint, '(importer:item_key)' ) !== false ) {
268 - $this->endpoint = str_replace( '(importer:item_key)', $this->args['item_key'], $this->endpoint );
269 - }
270 -
271 - $this->endpoint = apply_filters( 'wpgetapi_endpoint', $this->endpoint, $this );
272 -
273 209 $url = untrailingslashit( $this->base_url ) . $this->endpoint;
274 210
275 - // if we have a URL pagination event from the import plugin
276 - // we need to modify the URL here
277 - if( isset( $this->args['paginate_url'] ) )
278 - $url = $this->args['paginate_url'];
279 -
280 - // filter our params - added for use in Oauth 2.0 plugin
281 - $params = apply_filters( 'wpgetapi_query_parameters', $this->query_parameters, $this );
282 -
283 211 // add empty array - was getting errors if it was just null or false
284 - $params = empty( $params ) ? array(''=>'') : $params;
212 + $params = empty( $this->query_parameters ) ? array(''=>'') : $this->query_parameters;
285 213
286 - $result = add_query_arg( $params, $url );
214 + return add_query_arg( $params, $url );
287 215
288 - return $result;
289 -
290 216 }
291 217
292 218
293 219 /**
@@ -301,70 +227,21 @@
301 227 ), $this );
302 228
303 229
304 230 // if doing POST request, include body paramters
305 - if( $this->method == 'POST' || $this->method == 'PUT' || $this->method == 'DELETE' || $this->method == 'PATCH' ) {
231 + if( $this->method == 'POST' ) {
232 +
233 + $this->body_parameters = apply_filters( 'wpgetapi_body_parameters', $this->body_parameters, $this );
306 234
307 - // tokens are sent through here
308 - $this->body_parameters = apply_filters( 'wpgetapi_body_parameters', $this->body_parameters, $this );
309 -
310 - // do we json_encode the entire body
311 - if( $this->body_json_encode == true ) {
235 + // do we json_encode the entire body as a string
236 + if( $this->body_json_encode === true || $this->body_json_encode === 'true' )
312 237 $this->body_parameters = json_encode( $this->body_parameters );
313 - }
314 238
315 - // do we urlencode the entire body
316 - if( $this->body_parameters && $this->body_url_encode == true ) {
317 -
318 - // checking if the parameters have a json string (raw)
319 - if (
320 - ( ! is_array( $this->body_parameters ) ) &&
321 - ( substr( $this->body_parameters, 0, 1 ) === '{' || substr( $this->body_parameters, 0, 1 ) === '[' )
322 - ) {
323 - $this->body_parameters = json_decode( $this->body_parameters, true );
324 - }
325 -
326 - $this->body_parameters = http_build_query( $this->body_parameters, '', '&' );
239 + // add our body parameters
240 + $headers['headers']['body'] = $this->body_parameters;
327 241
328 - }
329 -
330 - // do we xml the entire body
331 - if( $this->body_parameters && $this->body_xml_format == true ) {
332 -
333 - $root_node = $this->xml_root_node != '' ? '<' . $this->xml_root_node . '/>' : '';
334 -
335 - $xml_element = apply_filters( 'wpgetapi_xml_element', '<?xml version="1.0" encoding="UTF-8"?>' . $root_node );
336 -
337 - $xml = new SimpleXmlElement( $xml_element );
338 -
339 - foreach( $this->body_parameters as $key => $value) {
340 - $xml->addChild( $key, $value );
341 - }
342 -
343 - $this->body_parameters = $xml->asXML();
344 -
345 - }
346 -
347 - // do we base64 encode the entire body
348 - if( $this->body_parameters && $this->body_base64_encode == true ) {
349 -
350 - $this->body_parameters = is_array( $this->body_parameters ) ? json_encode( $this->body_parameters ) : $this->body_parameters;
351 - $this->body_parameters = base64_encode( $this->body_parameters );
352 -
353 - }
354 -
355 - $this->body_parameters = apply_filters( 'wpgetapi_modify_formatted_body_parameters', $this->body_parameters, $this );
356 -
357 - // add our body parameters
358 - if( $this->body_parameters && ! empty( $this->body_parameters ) )
359 - $headers['body'] = $this->body_parameters;
360 -
361 242 }
362 243
363 - // get our body paramters as they are formatted
364 - // this won't change anything, it just allows us to get the parameters
365 - $this->body_parameters = apply_filters( 'wpgetapi_final_body_parameters', $this->body_parameters, $this );
366 -
367 244 // add headers to our final request args
368 245 $this->final_request_args = wp_parse_args( $headers, $this->final_request_args );
369 246
370 247 // build the args taht are sent to the request
@@ -380,236 +257,50 @@
380 257
381 258 }
382 259
383 260
384 -
385 -
386 261 /**
387 262 * Do a GET request
388 263 */
389 264 public function GET_request() {
390 -
391 265 $response = '';
392 266 // so we can so something before the remote_get (caching)
393 267 $response = apply_filters( 'wpgetapi_before_get_request', $response, $this );
394 -
395 268 if( empty( $response ) )
396 269 $response = wp_remote_get( $this->final_url, $this->final_request_args );
397 270
398 271 return $response;
272 + }
399 273
400 - }
401 274
402 275 /**
403 276 * Do a POST request
404 277 */
405 278 public function POST_request() {
406 -
407 - $response = '';
408 - // so we can so something before the remote_post (caching)
409 - $response = apply_filters( 'wpgetapi_before_post_request', $response, $this );
410 -
411 - //$this->final_request_args['method'] = 'POST';
412 -
413 - if( empty( $response ) )
414 - $response = wp_remote_post( $this->final_url, $this->final_request_args );
415 -
279 + $response = wp_remote_post( $this->final_url, $this->final_request_args );
416 280 return $response;
417 281 }
418 282
419 - /**
420 - * Do a PUT request
421 - */
422 - public function PUT_request() {
423 - $this->final_request_args['method'] = 'PUT';
424 - $response = wp_remote_request( $this->final_url, $this->final_request_args );
425 - return $response;
426 - }
427 283
428 284 /**
429 - * Do a PATCH request
285 + * return JSON data
430 286 */
431 - public function PATCH_request() {
432 - $this->final_request_args['method'] = 'PATCH';
433 - $response = wp_remote_request( $this->final_url, $this->final_request_args );
434 - return $response;
435 - }
287 + public function output_json( $data ) {
436 288
437 - /**
438 - * Do a DELETE request
439 - */
440 - public function DELETE_request() {
441 - $this->final_request_args['method'] = 'DELETE';
442 - $response = wp_remote_request( $this->final_url, $this->final_request_args );
443 - return $response;
444 - }
445 -
446 -
447 - /**
448 - * return data
449 - */
450 - public function return_data( $data ) {
451 -
452 - $data = apply_filters( 'wpgetapi_json_response_body_before_decode', $data, $this->keys );
453 -
454 289 // converts all data to arrays, removing objects
455 - if( is_string( $data ) ) {
456 - $decode = json_decode( $data, true );
457 - if( json_last_error() ) {
458 - return esc_html( $data );
459 - } else {
460 - $data = $decode;
461 - }
462 - }
290 + $data = json_decode( $data, true );
291 + $data = apply_filters( 'wpgetapi_json_response_body', $data, $this->keys );
463 292
464 - $data = apply_filters( 'wpgetapi_json_response_body', $data, $this->keys );
465 -
466 293 if( $this->results_format == 'json_string' )
467 - return trim( json_encode( $data, JSON_PRETTY_PRINT ),'"');
468 -
294 + return trim( json_encode( $data ),'"');
295 +
469 296 if( $this->results_format == 'json_decoded' )
470 297 return $data;
471 298
472 299 }
473 300
474 - /**
475 - * Sort out the parameters if they exist
476 - */
477 - public function do_parameters( $parameters ) {
478 301
479 - $new_array = array();
480 - $raw = '';
481 - $parameters = $this->decrypt( $parameters );
482 -
483 - if( is_array( $parameters ) ) {
484 - foreach ( $parameters as $key => $parameter ) {
485 -
486 - if( ! empty( $parameter['name'] ) && ! empty( $parameter['value'] ) ) {
487 -
488 - $parameter['value'] = stripslashes( $parameter['value'] );
489 -
490 - // if we have wpgetapi_on, delete it so we don't send to api
491 - if( $parameter['name'] == 'wpgetapi_on' ) {
492 - unset( $parameters[ $key ] );
493 - continue;
494 - }
495 -
496 - // if we have item_key from api to posts plugin
497 - // replace our keyword with the actual item_key value
498 - if ( isset( $this->args['item_key'] ) && strpos( $parameter['value'], '(importer:item_key)' ) !== false ) {
499 - $parameter['value'] = str_replace( '(importer:item_key)', $this->args['item_key'], $parameter['value'] );
500 - }
501 -
502 - $new_array[ sanitize_text_field( $parameter['name'] ) ] = $parameter['value'];
503 -
504 - // if we are sending raw body
505 - } else if( empty( $parameter['name'] ) && ! empty( $parameter['value'] ) ) {
506 -
507 - $raw = stripslashes( $parameter['value'] );
508 -
509 - }
510 -
511 - }
512 - }
513 -
514 - // now look for array or json string and sort these out - for using such things in shortcode
515 - if( ! empty( $new_array ) ) {
516 -
517 - foreach ( $new_array as $key => $value ) {
518 -
519 - // checking if the parameters have a json string
520 - if ( strpos( $value, '{"' ) !== false && strpos( $value, '}' ) !== false ) {
521 -
522 - $tmp_val = $value;
523 - $tmp_val = json_decode( $tmp_val, true );
524 - $new_array[ $key ] = $tmp_val ? $tmp_val : $value;
525 -
526 - } else
527 -
528 - // checking if the parameters have an array within the string
529 - // if they do, create them as an actual array
530 - if ( substr( $value, 0, 1 ) === '[' && substr( $value, -1 ) === ']' ) {
531 - $value = trim( $value,"[]" );
532 - $new_array[ $key ] = array( $value );
533 - }
534 -
535 - // set value as integer
536 - if ( strpos( $value, 'integer(' ) !== false && substr( $value, -1 ) === ')' ) {
537 -
538 - preg_match("/\(([^\)]*)\)/", $value, $match );
539 - $result = trim( $match[1] );
540 -
541 - // checking if we have additional token within
542 - // and we need to send this directly to PRO plugin from here
543 - if( strpos( $value, '(' ) !== false && strpos( $value, ':' ) !== false && $this->pro_plugin ) {
544 - $result = $this->replace_tokens( $result );
545 - } else {
546 - $result = $result;
547 - }
548 -
549 - $new_array[ $key ] = absint( $result );
550 -
551 - }
552 -
553 - // set value as float
554 - if ( strpos( $value, 'float(' ) !== false && substr( $value, -1 ) === ')' ) {
555 -
556 - preg_match("/\(([^\)]*)\)/", $value, $match );
557 - $result = trim( $match[1] );
558 - if ( substr( $result, 0, 1 ) === '"' && substr( $result, -1 ) === '"' )
559 - $result = trim( $result,'""' );
560 -
561 - // checking if we have additional token within
562 - // and we need to send this directly to PRO plugin from here
563 - if( strpos( $value, '(' ) !== false && strpos( $value, ':' ) !== false && $this->pro_plugin ) {
564 - $result = $this->replace_tokens( $result );
565 - }
566 -
567 - $new_array[ $key ] = (float) $result;
568 -
569 - }
570 -
571 - // set value as boolean
572 - if ( strpos( $value, 'boolean(' ) !== false && substr( $value, -1 ) === ')' ) {
573 - preg_match("/\(([^\)]*)\)/", $value, $match );
574 - $result = $match[1];
575 -
576 - // checking if we have additional token within
577 - // and we need to send this directly to PRO plugin from here
578 - if( strpos( $value, '(' ) !== false && strpos( $value, ':' ) !== false && $this->pro_plugin ) {
579 - $result = $this->replace_tokens( $result );
580 - } else {
581 - $result = $result;
582 - }
583 -
584 - $result = filter_var( $result, FILTER_VALIDATE_BOOLEAN );
585 -
586 - $new_array[ $key ] = $result;
587 -
588 - }
589 -
590 - }
591 -
592 - }
593 -
594 - return $raw ? $raw : $new_array;
595 -
596 - }
597 -
598 -
599 302 /**
600 - * Do a direct token replacement if PRO plugin installed and is required.
601 - */
602 - public function replace_tokens( $value ) {
603 - $tokens = new WpGetApi_Extras_Tokens();
604 - $action_args = isset( $this->args['action_args'] ) ? $this->args['action_args'] : null;
605 - $value = ( substr( $value, -1 ) !== ')' ? $value . ')' : $value );
606 - $result = $tokens->replace_tokens( $value, $action_args );
607 - return $result;
608 - }
609 -
610 -
611 - /**
612 303 * decrypt our parameters from the DB
613 304 */
614 305 public function decrypt( $array_or_string ) {
615 306
@@ -634,86 +325,20 @@
634 325
635 326 /**
636 327 * debug
637 328 */
638 - public function maybe_add_debug_info( $data, $wpgetapi ) {
329 + public function maybe_add_debug_info( $data, $this_data ) {
639 330
640 - if(
641 - ( isset( $this->args['debug'] ) && ( $this->args['debug'] === true || $this->args['debug'] === 'true' ) ) ||
642 - ( isset( $this->args['test_endpoint'] ) && ( $this->args['test_endpoint'] === true ) )
643 - ) {
331 + if( isset( $this->args['debug'] ) && ( $this->args['debug'] === true || $this->args['debug'] === 'true' ) ) {
644 332
645 - $this->debug = true;
646 -
647 - // admin test endpoint button
648 - $testing = isset( $this->args['test_endpoint'] ) && ( $this->args['test_endpoint'] === true ) ? true : false;
649 -
650 - // get api status from response code
651 - $status = array(
652 - 'title' => 'Error in API response.',
653 - 'desc' => 'Check all details within your endpoint. Something is misconfigured.',
654 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
655 - );
656 -
657 - if( $this->response_code >= 200 && $this->response_code <= 299 ) {
658 - $status = array(
659 - 'title' => 'Success!',
660 - 'desc' => 'Your API is returning a success message and is returning the data as shown in the Data Output section below. You can modify this by changing the Results Format option or see <a href="https://wpgetapi.com/docs/format-api-data-as-html/">here</a> for info on formatting this data.',
661 - 'type' => '<span class="dashicons dashicons-yes-alt"></span>'
662 - );
663 - }
664 - if( $this->response_code >= 400 && $this->response_code <= 499 ) {
665 - $status = array(
666 - 'title' => 'Bad Request',
667 - 'desc' => 'This could indicate that the URL you are calling is incorrect or that some other data is missing or incorrect. Please check your Base URL and Endpoint are correct as well as the Request Method.',
668 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
669 - );
670 - }
671 - if( $this->response_code == 401 ) {
672 - $status = array(
673 - 'title' => 'Unauthorised',
674 - 'desc' => 'You are successfully connecting to your API. But your API key, login or API credentials are incorrect. See <a href="https://wpgetapi.com/docs/authentication-authorization/">here</a> for info on correctly authorizing your API requests.',
675 - 'type' => '<span class="dashicons dashicons-warning"></span>'
676 - );
677 - }
678 - if( $this->response_code == 403 ) {
679 - $status = array(
680 - 'title' => 'Forbidden',
681 - 'desc' => 'This could indicate that you may need to get your IP address whitelisted with your API provider or that you do not have access to this API.',
682 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
683 - );
684 - }
685 - if( $this->response_code == 405 ) {
686 - $status = array(
687 - 'title' => 'Method Not Allowed',
688 - 'desc' => 'Try changing the Request Method within the endpoint settings.',
689 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
690 - );
691 - }
692 - if( $this->response_code == 415 ) {
693 - $status = array(
694 - 'title' => 'Unsupported Media Type',
695 - 'desc' => 'Try adding "Content-type" to the Headers with the Value of "json/application" as shown <a href="https://wpgetapi.com/docs/troubleshooting/">here</a>.',
696 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
697 - );
698 - }
699 - if( $this->response_code >= 500 && $this->response_code <= 599 ) {
700 - $status = array(
701 - 'title' => 'Internal Server Error',
702 - 'desc' => 'This indicates an issue with the API server. Contact your API provider.',
703 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
704 - );
705 - }
706 -
707 -
708 333 ob_start(); ?>
709 334
710 335 <style>
711 336
712 337 .wpgetapi-debug {
713 - background: #fff;
338 + background: #f4f4f4;
714 339 padding: 20px;
715 - box-shadow: 0 0 1px #aaa;
340 + border: 1px solid #ccc;
716 341 margin: 20px;
717 342 font-size: 15px;
718 343 }
719 344 .wpgetapi-debug
@@ -728,9 +353,9 @@
728 353 }
729 354 .wpgetapi-debug p.small {
730 355 font-size: 85%;
731 356 color: #999;
732 - margin: 0 0 12px !important;
357 + margin-bottom: 15px !important
733 358 }
734 359 .wpgetapi-debug h5 {
735 360 font-weight: bold;
736 361 font-size: 18px;
@@ -740,155 +365,86 @@
740 365 .wpgetapi-debug .debug-item {
741 366 margin: 10px 0;
742 367 background: #fff;
743 368 padding: 15px 20px;
744 - display: inline-block !important;
369 + display: inline-block !important;;
745 370 width: 100% !important;
746 - box-shadow: 0 4px 4px -2px rgb(0 0 0 / 9%);
747 - border: 1px solid #eee;
748 - margin-bottom: 20px !important;
371 + box-shadow: 0 0 5px rgba(0,0,0,0.1)
749 372 }
750 373 .wpgetapi-debug .debug-item h6 {
751 374 font-weight: bold;
752 - font-size: 14px;
753 - margin: 0;
375 + font-size: 16px;
376 + margin: 0 0 3px;
754 377 text-transform: none !important;
755 378 }
756 379 .wpgetapi-debug .debug-item .debug-result,
757 380 .wpgetapi-debug .debug-item .debug-result pre {
758 381 font-family: monospace !important;
759 - font-size: 13px !important;
382 + font-size: 15px !important;
760 383 margin: 0 !important;
761 - padding: 8px 12px;
762 - background: #f4f7f9;
384 + padding: 10px 12px;
385 + background: #f8f8f8;
763 386 }
764 387 .wpgetapi-debug .debug-item .debug-result pre {
765 388 border: none;
766 389 padding: 5px
767 390 }
768 -.wpgetapi-debug.testing {
769 - background: transparent;
770 - padding: 0;
771 - box-shadow: none;
772 -}
773 -.wpgetapi-debug.testing .debug-item {
774 - margin: 5px 0;
775 -}
776 -.wpgetapi-debug.testing .debug-item.status {
777 - border: none;
778 - box-shadow: none;
779 - margin-bottom: 15px;
780 -}
781 -.wpgetapi-debug .debug-item.status h5 {
782 - font-size: 15px;
783 -}
784 -.wpgetapi-debug .status .dashicons {
785 - margin: 0 5px 3px 0;
786 -}
787 -.wpgetapi-debug .status .dashicons-yes-alt {
788 - color: #5e9929;
789 -}
790 -.wpgetapi-debug .status .dashicons-dismiss {
791 - color: #cc4646;
792 -}
793 -.wpgetapi-debug .status .dashicons-warning {
794 - color: #dfa12e;
795 -}
796 -.wpgetapi-debug .status .desc {
797 - font-size: 14px;
798 - font-weight: 400 !important;
799 -}
391 +
800 392 </style>
801 393
802 - <div class="wpgetapi-debug <?php echo $testing ? 'testing' : ''; ?>">
394 + <div class="wpgetapi-debug">
803 395
804 - <?php if( $testing ) { ?>
396 + <h5><strong>WPGetAPI, Debug Mode - Plugin Version <?php esc_html_e( WpGetApi()->version ); ?></strong></h5>
397 + <p class="small">Below you will find debug info for the current API call. To turn this off, set debug to false in your shortcode or template tag.<br>Connecting to API's can be tricky - if you require help, please see the <a target="_blank" href="https://wpgetapi.com/docs/">Documentation</a> and if you can't find the answer then please use the contact form on our <a target="_blank" title="Connect WordPress with external API" href="https://wpgetapi.com/">website</a> to get assistance.</p>
805 398
806 - <div class="debug-item status">
807 - <div class="">
808 - <h5><?php _e( $status['type'] ); ?> <?php esc_html_e( $status['title'] ); ?></h5>
809 - <span class="desc"><?php _e( $status['desc'] ); ?></span>
810 - </div>
811 - </div>
812 - <div class="debug-item">
813 - <h6><?php esc_html_e( 'Full URL', 'wpgetapi' ); ?></h6>
814 - <p class="small"><?php esc_html_e( 'The full URL that is being called.', 'wpgetapi' ); ?></p>
815 - <div class="debug-result"><?php esc_html_e( $this->final_url ); ?></div>
816 - </div>
817 -
818 - <div class="debug-item">
819 - <h6><?php esc_html_e( 'Data Output', 'wpgetapi' ); ?></h6>
820 - <p class="small"><?php esc_html_e( 'The output that has been returned from the API. This is what the shortcode or template tag will display and can be formatted however you like.', 'wpgetapi' ); ?></p>
821 - <div class="debug-result"><?php wpgetapi_pp( $data ); ?></div>
822 - </div>
823 -
824 - <div class="debug-item">
825 - <h6><?php esc_html_e( 'Final Request Arguments', 'wpgetapi' ); ?></h6>
826 - <p class="small"><?php esc_html_e( 'The final request arguments sent in the API request. Includes headers and body arguments.', 'wpgetapi' ); ?></p>
827 - <div class="debug-result"><?php wpgetapi_pp( $this->final_request_args ); ?></div>
828 - </div>
829 -
830 - <div class="debug-item">
831 - <h6><?php esc_html_e( 'Response', 'wpgetapi' ); ?></h6>
832 - <p class="small"><?php esc_html_e( 'The full response from the API request.', 'wpgetapi' ); ?></p>
833 - <div class="debug-result"><?php wpgetapi_pp( $this->response); ?></div>
834 - </div>
835 -
836 - <?php } else { ?>
837 -
838 - <h5><strong><?php esc_html_e( 'WPGetAPI, Debug Mode - Plugin Version', 'wpgetapi' ); ?> <?php esc_html_e( WpGetApi()->version ); ?></strong></h5>
839 - <p class="small"><?php esc_html_e( 'Below you will find debug info for the current API call. To turn this off, set debug to false in your shortcode or template tag.', 'wpgetapi' ); ?><br><?php esc_html_e( 'Connecting to API\'s can be tricky - if you require help, please see the', 'wpgetapi' ); ?> <a target="_blank" href="https://wpgetapi.com/docs/"><?php esc_html_e( 'Documentation', 'wpgetapi' ); ?></a>.</p>
840 -
841 399 <div class="debug-item">
842 - <h6><?php esc_html_e( 'Full URL', 'wpgetapi' ); ?></h6>
843 - <p class="small"><?php esc_html_e( 'The full URL that is being called.', 'wpgetapi' ); ?></p>
400 + <h6>Full URL</h6>
401 + <p class="small">The full URL that is being called.</p>
844 402 <div class="debug-result"><?php esc_html_e( $this->final_url ); ?></div>
845 403 </div>
846 404
847 405 <div class="debug-item">
848 - <h6><?php esc_html_e( 'Data Output', 'wpgetapi' ); ?></h6>
849 - <p class="small"><?php esc_html_e( 'The resulting output that has been returned from the API.', 'wpgetapi' ); ?></p>
406 + <h6>Data Output</h6>
407 + <p class="small">The resulting output that has been returned from the API.</p>
850 408 <div class="debug-result"><?php wpgetapi_pp( $data ); ?></div>
851 409 </div>
852 410
853 411 <div class="debug-item">
854 - <h6><?php esc_html_e( 'Query String', 'wpgetapi' ); ?></h6>
855 - <p class="small"><?php esc_html_e( 'The query string parameters (if any) that you have set within the endpoint settings.', 'wpgetapi' ); ?></p>
412 + <h6>Arguments</h6>
413 + <p class="small">The arguments set within your shortcode or template tag.</p>
414 + <div class="debug-result"><?php wpgetapi_pp( $this->args ); ?></div>
415 + </div>
416 +
417 + <div class="debug-item">
418 + <h6>Query String</h6>
419 + <p class="small">The query string parameters (if any) that you have set within the endpoint settings.</p>
856 420 <div class="debug-result"><?php wpgetapi_pp( $this->query_parameters ); ?></div>
857 421 </div>
858 422
859 423 <div class="debug-item">
860 - <h6><?php esc_html_e( 'Headers', 'wpgetapi' ); ?></h6>
861 - <p class="small"><?php esc_html_e( 'The header parameters (if any) that you have set within the endpoint settings.', 'wpgetapi' ); ?></p>
424 + <h6>Headers</h6>
425 + <p class="small">The headers parameters (if any) that you have set within the endpoint settings.</p>
862 426 <div class="debug-result"><?php wpgetapi_pp( $this->header_parameters ); ?></div>
863 427 </div>
864 428
865 429 <div class="debug-item">
866 - <h6><?php esc_html_e( 'Body', 'wpgetapi' ); ?></h6>
867 - <p class="small"><?php esc_html_e( 'The body parameters (if any) that you have set within the endpoint settings.', 'wpgetapi' ); ?></p>
430 + <h6>Body</h6>
431 + <p class="small">The body parameters (if any) that you have set within the endpoint settings.</p>
868 432 <div class="debug-result"><?php wpgetapi_pp( $this->body_parameters ); ?></div>
869 433 </div>
870 434
871 435 <div class="debug-item">
872 - <h6><?php esc_html_e( 'Final Request Arguments', 'wpgetapi' ); ?></h6>
873 - <p class="small"><?php esc_html_e( 'The final request arguments sent in the API request. Includes headers and body arguments.', 'wpgetapi' ); ?></p>
436 + <h6>Final Request Arguments</h6>
437 + <p class="small">The final request arguments sent in the API request. Includes headers and body arguments.</p>
874 438 <div class="debug-result"><?php wpgetapi_pp( $this->final_request_args ); ?></div>
875 439 </div>
876 440
877 441 <div class="debug-item">
878 - <h6><?php esc_html_e( 'Arguments', 'wpgetapi' ); ?></h6>
879 - <p class="small"><?php esc_html_e( 'The arguments set within your shortcode or template tag.', 'wpgetapi' ); ?></p>
880 - <div class="debug-result"><?php wpgetapi_pp( $this->args ); ?></div>
881 - </div>
882 -
883 - <div class="debug-item">
884 - <h6><?php esc_html_e( 'Response', 'wpgetapi' ); ?></h6>
885 - <p class="small"><?php esc_html_e( 'The full response from the API request.', 'wpgetapi' ); ?></p>
442 + <h6>Response</h6>
443 + <p class="small">The full response from the API request.</p>
886 444 <div class="debug-result"><?php wpgetapi_pp( $this->response); ?></div>
887 445 </div>
888 446
889 - <?php } ?>
890 -
891 447 </div>
892 448
893 449 <?php
894 450
@@ -898,9 +454,11 @@
898 454
899 455 return $data;
900 456
901 457 }
458 +
459 +
902 460
903 461 }
904 462
905 463
906 464 }