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