PluginProbe
WPGet API – Connect to any external REST API / 1.4.6
WPGet API – Connect to any external REST API v1.4.6
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 +103 -532 2.1.51.4.6 View file →
@@ -28,11 +28,8 @@
28 28 public $header_parameters = ''; // the header paramaters
29 29 public $body_parameters = ''; // the body paramaters
30 30 public $body_json_encode = ''; // body_json_encode body
31 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
35 32
36 33 public $response = ''; // the returned response
37 34
38 35 public $final_url = ''; // final URL
@@ -37,17 +34,12 @@
37 34
38 35 public $final_url = ''; // final URL
39 36 public $final_request_args = array(); // final request_args
40 37
41 - public $results_format = 'json_string'; // results format
38 + public $results_format = 'json_string'; // reseults format
42 39
43 - public $response_code = ''; // the response code from the call
44 -
45 40 public $timeout = 10; // the timeout
46 - public $sslverify = 1; // ssl verify
47 - public $debug = false;
48 -
49 - public $pro_plugin = false;
41 + public $sslverify = 1; // the paramaters
50 42
51 43
52 44 /**
53 45 * Main constructor
@@ -65,9 +57,9 @@
65 57 $this->endpoint_id = sanitize_text_field( $endpoint_id );
66 58 $this->keys = $keys;
67 59 $this->args = $args;
68 60
69 - add_filter( 'wpgetapi_raw_data', array( $this, 'maybe_add_debug_info' ), 99, 2 );
61 + add_filter( 'wpgetapi_raw_data', array( $this, 'maybe_add_debug_info' ), 5, 2 );
70 62
71 63 }
72 64
73 65
@@ -75,31 +67,8 @@
75 67 * Init our api data
76 68 */
77 69 public function init() {
78 70
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 71 // do some checks
103 72 if( empty( $this->setup ) || ! isset( $this->setup['apis'] ) || empty( $this->setup['apis'] ) )
104 73 return 'No API found.';
105 74
@@ -118,9 +87,9 @@
118 87 // loop through endpoints
119 88 foreach ( $this->api['endpoints'] as $index => $endpoint ) {
120 89
121 90 if( $this->endpoint_id == $endpoint['id'] ) {
122 -
91 +
123 92 $this->method = isset( $endpoint['method'] ) && $endpoint['method'] != '' ? sanitize_text_field( $endpoint['method'] ) : 'GET';
124 93 $this->cache_time = isset( $endpoint['cache_time'] ) && ! empty( $endpoint['cache_time'] ) ? absint( $endpoint['cache_time'] ) : '';
125 94 $this->endpoint = isset( $endpoint['endpoint'] ) && ! empty( $endpoint['endpoint'] ) ? sanitize_text_field( $endpoint['endpoint'] ) : '';
126 95
@@ -129,40 +98,13 @@
129 98 $this->header_parameters = isset( $endpoint['header_parameters'] ) && ! empty( $endpoint['header_parameters'] ) ? $this->do_parameters( $endpoint['header_parameters'] ) : array();
130 99
131 100 $this->body_parameters = isset( $endpoint['body_parameters'] ) && ! empty( $endpoint['body_parameters'] ) ? $this->do_parameters( $endpoint['body_parameters'] ) : array();
132 101
133 - // how to encode the body
134 102 $this->body_json_encode = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'true' ? true : false;
135 103 $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 104
139 - $this->xml_root_node = isset( $endpoint['xml_root'] ) && ! empty( $endpoint['xml_root'] ) ? $endpoint['xml_root'] : $this->xml_root_node;
140 -
141 105 $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 106 }
164 -
165 107 }
166 108
167 109 $this->timeout = isset( $this->api['timeout'] ) && ! empty( $this->api['timeout'] ) ? $this->api['timeout'] : $this->timeout;
168 110 $this->sslverify = isset( $this->api['sslverify'] ) ? absint( $this->api['sslverify'] ) : $this->sslverify;
@@ -175,21 +117,58 @@
175 117 *
176 118 * @param string $field Field to retrieve
177 119 */
178 120 public function endpoint_output() {
121 + return $this->do_the_call();
122 + }
179 123
180 - do_action( 'wpgetapi_before_do_the_call', $this );
181 124
182 - return $this->do_the_call();
125 + /**
126 + * Sort out the parameters if they exist
127 + */
128 + public function do_parameters( $parameters ) {
129 +
130 + $new_array = array();
131 + $parameters = $this->decrypt($parameters);
183 132
133 + if( is_array( $parameters ) ) {
134 + foreach ( $parameters as $key => $parameter ) {
135 + if( ! empty( $parameter['name'] ) && ! empty( $parameter['value'] ) ) {
136 + $parameter['value'] = stripslashes( $parameter['value'] );
137 + $new_array[ sanitize_text_field( $parameter['name'] ) ] = $parameter['value'];
138 + }
139 + }
140 + }
141 +
142 + // look for array or json string and sort these out - for using such things in shortcode
143 + if( is_array( $new_array ) ) {
144 +
145 + foreach ( $new_array as $key => $value ) {
146 +
147 + // checking if the parameters have a json string
148 + if ( substr( $value, 0, 1 ) === '{' && substr( $value, -1 ) === '}' ) {
149 + $new_array[ $key ] = json_decode( $value, true);
150 + }
151 +
152 + // checking if the parameters have an array within the string
153 + // if they do, create them as an actual array
154 + if ( substr( $value, 0, 1 ) === '[' && substr( $value, -1 ) === ']' ) {
155 + $new_array[ $key ] = array( $value );
156 + }
157 +
158 + }
159 +
160 + }
161 +
162 + return $new_array;
163 +
184 164 }
185 165
186 -
187 166 /**
188 167 * Send the request and return our data
189 168 */
190 169 public function do_the_call() {
191 -
170 +
192 171 $this->init();
193 172
194 173 // build the URL
195 174 $this->final_url = apply_filters( 'wpgetapi_final_url', $this->build_url(), $this );
@@ -195,60 +174,28 @@
195 174 $this->final_url = apply_filters( 'wpgetapi_final_url', $this->build_url(), $this );
196 175
197 176 // build the request args
198 177 $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 178
205 - if ( apply_filters( 'wpgetapi_should_we_stop', false, $this ) ) {
206 - return;
207 - }
208 -
209 179 // POST request
210 180 if( $this->method == 'POST' )
211 181 $this->response = $this->POST_request();
212 182
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 183 // GET request
222 184 if( $this->method == 'GET' )
223 185 $this->response = $this->GET_request();
224 186
225 - // DELETE request
226 - if( $this->method == 'DELETE' )
227 - $this->response = $this->DELETE_request();
228 -
229 187 // wp error
230 188 if( is_wp_error( $this->response ) ) {
231 189 return apply_filters( 'wpgetapi_raw_error_data', json_encode( $this->response ), $this );
232 190 }
233 191
234 - // get response_code
235 - $this->response_code = wp_remote_retrieve_response_code( $this->response );
192 + $data = wp_remote_retrieve_body( $this->response );
236 193
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 194 // returning in JSON format
245 195 if( $this->results_format == 'json_string' || $this->results_format == 'json_decoded' )
246 196 $data = $this->return_data( $data );
247 197
248 - if( $data === 'null' )
249 - $data = 'Result is null. Check that all endpoint settings are correct.';
250 -
251 198 return apply_filters( 'wpgetapi_raw_data', $data, $this );
252 199
253 200 }
254 201
@@ -261,33 +208,15 @@
261 208 // first make sure our endpoint starts with a slash
262 209 if ( substr( $this->endpoint, 0, 1 ) != '/' )
263 210 $this->endpoint = '/' . $this->endpoint;
264 211
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 212 $url = untrailingslashit( $this->base_url ) . $this->endpoint;
274 213
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 214 // add empty array - was getting errors if it was just null or false
284 - $params = empty( $params ) ? array(''=>'') : $params;
215 + $params = empty( $this->query_parameters ) ? array(''=>'') : $this->query_parameters;
285 216
286 - $result = add_query_arg( $params, $url );
217 + return add_query_arg( $params, $url );
287 218
288 - return $result;
289 -
290 219 }
291 220
292 221
293 222 /**
@@ -301,60 +230,27 @@
301 230 ), $this );
302 231
303 232
304 233 // if doing POST request, include body paramters
305 - if( $this->method == 'POST' || $this->method == 'PUT' || $this->method == 'DELETE' || $this->method == 'PATCH' ) {
234 + if( $this->method == 'POST' ) {
235 +
236 + $this->body_parameters = apply_filters( 'wpgetapi_body_parameters', $this->body_parameters, $this );
306 237
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 ) {
238 + // do we json_encode the entire body as a string
239 + if( $this->body_json_encode == true )
312 240 $this->body_parameters = json_encode( $this->body_parameters );
313 - }
314 241
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 );
242 +
243 + // do we urlencode the entire body as a string
244 + if( $this->body_url_encode == true ) {
245 + $data_raw = '';
246 + foreach ($this->body_parameters as $key => $value){
247 + $data_raw = $data_raw . $key . "=" . urlencode($value) . "&";
324 248 }
249 + $this->body_parameters = $data_raw;
325 250
326 - $this->body_parameters = http_build_query( $this->body_parameters, '', '&' );
327 -
328 251 }
329 252
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 253 // add our body parameters
358 254 if( $this->body_parameters && ! empty( $this->body_parameters ) )
359 255 $headers['body'] = $this->body_parameters;
360 256
@@ -359,12 +255,8 @@
359 255 $headers['body'] = $this->body_parameters;
360 256
361 257 }
362 258
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 259 // add headers to our final request args
368 260 $this->final_request_args = wp_parse_args( $headers, $this->final_request_args );
369 261
370 262 // build the args taht are sent to the request
@@ -380,236 +272,50 @@
380 272
381 273 }
382 274
383 275
384 -
385 -
386 276 /**
387 277 * Do a GET request
388 278 */
389 279 public function GET_request() {
390 -
391 280 $response = '';
392 281 // so we can so something before the remote_get (caching)
393 282 $response = apply_filters( 'wpgetapi_before_get_request', $response, $this );
394 -
395 283 if( empty( $response ) )
396 284 $response = wp_remote_get( $this->final_url, $this->final_request_args );
397 285
398 286 return $response;
287 + }
399 288
400 - }
401 289
402 290 /**
403 291 * Do a POST request
404 292 */
405 293 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 -
294 + $response = wp_remote_post( $this->final_url, $this->final_request_args );
416 295 return $response;
417 296 }
418 297
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 298
428 299 /**
429 - * Do a PATCH request
430 - */
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 - }
436 -
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 300 * return data
449 301 */
450 302 public function return_data( $data ) {
451 -
452 - $data = apply_filters( 'wpgetapi_json_response_body_before_decode', $data, $this->keys );
453 -
303 +
454 304 // 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 - }
305 + $data = json_decode( $data, true );
306 + $data = apply_filters( 'wpgetapi_json_response_body', $data, $this->keys );
463 307
464 - $data = apply_filters( 'wpgetapi_json_response_body', $data, $this->keys );
465 -
466 308 if( $this->results_format == 'json_string' )
467 - return trim( json_encode( $data, JSON_PRETTY_PRINT ),'"');
468 -
309 + return trim( json_encode( $data ),'"');
310 +
469 311 if( $this->results_format == 'json_decoded' )
470 312 return $data;
471 313
472 314 }
473 315
474 - /**
475 - * Sort out the parameters if they exist
476 - */
477 - public function do_parameters( $parameters ) {
478 316
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 317 /**
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 318 * decrypt our parameters from the DB
613 319 */
614 320 public function decrypt( $array_or_string ) {
615 321
@@ -634,86 +340,20 @@
634 340
635 341 /**
636 342 * debug
637 343 */
638 - public function maybe_add_debug_info( $data, $wpgetapi ) {
344 + public function maybe_add_debug_info( $data, $this_data ) {
639 345
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 - ) {
346 + if( isset( $this->args['debug'] ) && ( $this->args['debug'] === true || $this->args['debug'] === 'true' ) ) {
644 347
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 348 ob_start(); ?>
709 349
710 350 <style>
711 351
712 352 .wpgetapi-debug {
713 - background: #fff;
353 + background: #f4f4f4;
714 354 padding: 20px;
715 - box-shadow: 0 0 1px #aaa;
355 + border: 1px solid #ccc;
716 356 margin: 20px;
717 357 font-size: 15px;
718 358 }
719 359 .wpgetapi-debug
@@ -728,9 +368,9 @@
728 368 }
729 369 .wpgetapi-debug p.small {
730 370 font-size: 85%;
731 371 color: #999;
732 - margin: 0 0 12px !important;
372 + margin-bottom: 15px !important
733 373 }
734 374 .wpgetapi-debug h5 {
735 375 font-weight: bold;
736 376 font-size: 18px;
@@ -740,154 +380,85 @@
740 380 .wpgetapi-debug .debug-item {
741 381 margin: 10px 0;
742 382 background: #fff;
743 383 padding: 15px 20px;
744 - display: inline-block !important;
384 + display: inline-block !important;;
745 385 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;
386 + box-shadow: 0 0 5px rgba(0,0,0,0.1)
749 387 }
750 388 .wpgetapi-debug .debug-item h6 {
751 389 font-weight: bold;
752 - font-size: 14px;
753 - margin: 0;
390 + font-size: 16px;
391 + margin: 0 0 3px;
754 392 text-transform: none !important;
755 393 }
756 394 .wpgetapi-debug .debug-item .debug-result,
757 395 .wpgetapi-debug .debug-item .debug-result pre {
758 396 font-family: monospace !important;
759 - font-size: 13px !important;
397 + font-size: 15px !important;
760 398 margin: 0 !important;
761 - padding: 8px 12px;
762 - background: #f4f7f9;
399 + padding: 10px 12px;
400 + background: #f8f8f8;
763 401 }
764 402 .wpgetapi-debug .debug-item .debug-result pre {
765 403 border: none;
766 404 padding: 5px
767 405 }
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 -}
406 +
800 407 </style>
801 408
802 - <div class="wpgetapi-debug <?php echo $testing ? 'testing' : ''; ?>">
409 + <div class="wpgetapi-debug">
803 410
804 - <?php if( $testing ) { ?>
411 + <h5><strong>WPGetAPI, Debug Mode - Plugin Version <?php esc_html_e( WpGetApi()->version ); ?></strong></h5>
412 + <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 413
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 414 <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>
415 + <h6>Full URL</h6>
416 + <p class="small">The full URL that is being called.</p>
844 417 <div class="debug-result"><?php esc_html_e( $this->final_url ); ?></div>
845 418 </div>
846 419
847 420 <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>
421 + <h6>Data Output</h6>
422 + <p class="small">The resulting output that has been returned from the API.</p>
850 423 <div class="debug-result"><?php wpgetapi_pp( $data ); ?></div>
851 424 </div>
852 425
853 426 <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>
427 + <h6>Arguments</h6>
428 + <p class="small">The arguments set within your shortcode or template tag.</p>
429 + <div class="debug-result"><?php wpgetapi_pp( $this->args ); ?></div>
430 + </div>
431 +
432 + <div class="debug-item">
433 + <h6>Query String</h6>
434 + <p class="small">The query string parameters (if any) that you have set within the endpoint settings.</p>
856 435 <div class="debug-result"><?php wpgetapi_pp( $this->query_parameters ); ?></div>
857 436 </div>
858 437
859 438 <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>
439 + <h6>Headers</h6>
440 + <p class="small">The headers parameters (if any) that you have set within the endpoint settings.</p>
862 441 <div class="debug-result"><?php wpgetapi_pp( $this->header_parameters ); ?></div>
863 442 </div>
864 443
865 444 <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>
445 + <h6>Body</h6>
446 + <p class="small">The body parameters (if any) that you have set within the endpoint settings.</p>
868 447 <div class="debug-result"><?php wpgetapi_pp( $this->body_parameters ); ?></div>
869 448 </div>
870 449
871 450 <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>
451 + <h6>Final Request Arguments</h6>
452 + <p class="small">The final request arguments sent in the API request. Includes headers and body arguments.</p>
874 453 <div class="debug-result"><?php wpgetapi_pp( $this->final_request_args ); ?></div>
875 454 </div>
876 455
877 456 <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>
457 + <h6>Response</h6>
458 + <p class="small">The full response from the API request.</p>
886 459 <div class="debug-result"><?php wpgetapi_pp( $this->response); ?></div>
887 460 </div>
888 -
889 - <?php } ?>
890 461
891 462 </div>
892 463
893 464 <?php