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 -615 2.1.11.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,120 +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 - $root_node = $this->xml_root_node != '' ? '<' . $this->xml_root_node . '/>' : '';
330 - $xml = new SimpleXmlElement( '<?xml version="1.0" encoding="UTF-8"?>' . $root_node );
331 -
332 - foreach( $this->body_parameters as $key => $value) {
333 - $xml->addChild( $key, $value );
334 - }
335 -
336 - $this->body_parameters = $xml->asXML();
337 -
338 - }
339 -
340 - // do we base64 encode the entire body
341 - if( $this->body_parameters && $this->body_base64_encode == true ) {
342 -
343 - $this->body_parameters = is_array( $this->body_parameters ) ? json_encode( $this->body_parameters ) : $this->body_parameters;
344 - $this->body_parameters = base64_encode( $this->body_parameters );
345 -
346 - }
347 -
348 - $this->body_parameters = apply_filters( 'wpgetapi_modify_formatted_body_parameters', $this->body_parameters, $this );
349 -
350 - // add our body parameters
351 - if( $this->body_parameters && ! empty( $this->body_parameters ) )
352 - $headers['body'] = $this->body_parameters;
353 -
354 228 }
355 229
356 - // get our body paramters as they are formatted
357 - // this won't change anything, it just allows us to get the parameters
358 - $this->body_parameters = apply_filters( 'wpgetapi_final_body_parameters', $this->body_parameters, $this );
359 -
360 - // add headers to our final request args
361 - $this->final_request_args = wp_parse_args( $headers, $this->final_request_args );
362 -
363 - // build the args taht are sent to the request
364 - $default_args = apply_filters( 'wpgetapi_default_request_args_parameters', array(
230 + // build the header
231 + $defaults = apply_filters( 'wpgetapi_default_header_parameters', array(
365 232 'timeout' => $this->timeout,
366 233 'sslverify' => $this->sslverify,
367 234 'redirection' => 5,
368 235 'blocking' => true,
@@ -368,200 +235,37 @@
368 235 'blocking' => true,
369 236 'cookies' => array(),
370 237 ) );
371 238
372 - return wp_parse_args( $this->final_request_args, $default_args );
239 + return wp_parse_args( $this->header_parameters, $defaults );
373 240
374 241 }
375 242
376 243
377 -
378 -
379 244 /**
380 245 * Do a GET request
381 246 */
382 247 public function GET_request() {
383 -
384 248 $response = '';
385 249 // so we can so something before the remote_get (caching)
386 250 $response = apply_filters( 'wpgetapi_before_get_request', $response, $this );
387 -
388 251 if( empty( $response ) )
389 - $response = wp_remote_get( $this->final_url, $this->final_request_args );
252 + $response = wp_remote_get( $this->final_url, $this->final_headers );
390 253
391 254 return $response;
255 + }
392 256
393 - }
394 257
395 258 /**
396 259 * Do a POST request
397 260 */
398 261 public function POST_request() {
399 -
400 - $response = '';
401 - // so we can so something before the remote_post (caching)
402 - $response = apply_filters( 'wpgetapi_before_post_request', $response, $this );
403 -
404 - //$this->final_request_args['method'] = 'POST';
405 -
406 - if( empty( $response ) )
407 - $response = wp_remote_post( $this->final_url, $this->final_request_args );
408 -
262 + $response = wp_remote_post( $this->final_url, $this->final_headers );
409 263 return $response;
410 264 }
411 265
412 - /**
413 - * Do a PUT request
414 - */
415 - public function PUT_request() {
416 - $this->final_request_args['method'] = 'PUT';
417 - $response = wp_remote_request( $this->final_url, $this->final_request_args );
418 - return $response;
419 - }
420 266
421 267 /**
422 - * Do a PATCH request
423 - */
424 - public function PATCH_request() {
425 - $this->final_request_args['method'] = 'PATCH';
426 - $response = wp_remote_request( $this->final_url, $this->final_request_args );
427 - return $response;
428 - }
429 -
430 - /**
431 - * Do a DELETE request
432 - */
433 - public function DELETE_request() {
434 - $this->final_request_args['method'] = 'DELETE';
435 - $response = wp_remote_request( $this->final_url, $this->final_request_args );
436 - return $response;
437 - }
438 -
439 -
440 - /**
441 - * return data
442 - */
443 - public function return_data( $data ) {
444 -
445 - $data = apply_filters( 'wpgetapi_json_response_body_before_decode', $data, $this->keys );
446 -
447 - // converts all data to arrays, removing objects
448 - if( is_string( $data ) ) {
449 - $decode = json_decode( $data, true );
450 - if( json_last_error() ) {
451 - return esc_html( $data );
452 - } else {
453 - $data = $decode;
454 - }
455 - }
456 -
457 - $data = apply_filters( 'wpgetapi_json_response_body', $data, $this->keys );
458 -
459 - if( $this->results_format == 'json_string' )
460 - return trim( json_encode( $data, JSON_PRETTY_PRINT ),'"');
461 -
462 - if( $this->results_format == 'json_decoded' )
463 - return $data;
464 -
465 - }
466 -
467 - /**
468 - * Sort out the parameters if they exist
469 - */
470 - public function do_parameters( $parameters ) {
471 -
472 - $new_array = array();
473 - $raw = '';
474 - $parameters = $this->decrypt( $parameters );
475 -
476 - if( is_array( $parameters ) ) {
477 - foreach ( $parameters as $key => $parameter ) {
478 -
479 - if( ! empty( $parameter['name'] ) && ! empty( $parameter['value'] ) ) {
480 -
481 - $parameter['value'] = stripslashes( $parameter['value'] );
482 -
483 - // if we have wpgetapi_on, delete it so we don't send to api
484 - if( $parameter['name'] == 'wpgetapi_on' ) {
485 - unset( $parameters[ $key ] );
486 - continue;
487 - }
488 -
489 - // if we have item_key from api to posts plugin
490 - // replace our keyword with the actual item_key value
491 - if ( isset( $this->args['item_key'] ) && strpos( $parameter['value'], '(importer:item_key)' ) !== false ) {
492 - $parameter['value'] = str_replace( '(importer:item_key)', $this->args['item_key'], $parameter['value'] );
493 - }
494 -
495 - $new_array[ sanitize_text_field( $parameter['name'] ) ] = $parameter['value'];
496 -
497 - // if we are sending raw body
498 - } else if( empty( $parameter['name'] ) && ! empty( $parameter['value'] ) ) {
499 -
500 - $raw = stripslashes( $parameter['value'] );
501 -
502 - }
503 -
504 - }
505 - }
506 -
507 - // now look for array or json string and sort these out - for using such things in shortcode
508 - if( ! empty( $new_array ) ) {
509 -
510 - foreach ( $new_array as $key => $value ) {
511 -
512 - // checking if the parameters have a json string
513 - if ( strpos( $value, '{"' ) !== false && strpos( $value, '}' ) !== false ) {
514 -
515 - $tmp_val = $value;
516 - $tmp_val = json_decode( $tmp_val, true );
517 - $new_array[ $key ] = $tmp_val ? $tmp_val : $value;
518 -
519 - } else
520 -
521 - // checking if the parameters have an array within the string
522 - // if they do, create them as an actual array
523 - if ( substr( $value, 0, 1 ) === '[' && substr( $value, -1 ) === ']' ) {
524 - $value = trim( $value,"[]" );
525 - $new_array[ $key ] = array( $value );
526 - }
527 -
528 - // set value as integer
529 - if ( strpos( $value, 'integer(' ) !== false && substr( $value, -1 ) === ')' ) {
530 - preg_match("/\(([^\)]*)\)/", $value, $match );
531 - $result = $match[1];
532 - $new_array[ $key ] = absint( $result );
533 - }
534 -
535 - // set value as float
536 - if ( strpos( $value, 'float(' ) !== false && substr( $value, -1 ) === ')' ) {
537 - preg_match("/\(([^\)]*)\)/", $value, $match );
538 - $result = $match[1];
539 - if ( substr( $result, 0, 1 ) === '"' && substr( $result, -1 ) === '"' )
540 - $result = trim( $result,'""' );
541 - $new_array[ $key ] = (float) $result;
542 -
543 - }
544 -
545 - // set value as boolean
546 - if ( strpos( $value, 'boolean(' ) !== false && substr( $value, -1 ) === ')' ) {
547 - preg_match("/\(([^\)]*)\)/", $value, $match );
548 - $result = $match[1];
549 - $result = filter_var( $result, FILTER_VALIDATE_BOOLEAN );
550 - $new_array[ $key ] = $result;
551 -
552 - }
553 -
554 - }
555 -
556 - }
557 -
558 - return $raw ? $raw : $new_array;
559 -
560 - }
561 -
562 -
563 - /**
564 268 * decrypt our parameters from the DB
565 269 */
566 270 public function decrypt( $array_or_string ) {
567 271
@@ -568,9 +272,9 @@
568 272 if( is_string($array_or_string) ){
569 273 $array_or_string = $this->encryption->decrypt($array_or_string);
570 274 }elseif( is_array($array_or_string) ){
571 275 foreach ( $array_or_string as $key => &$value ) {
572 - if( $key === 'name' )
276 + if( $key == 'name' )
573 277 continue;
574 278 if ( is_array( $value ) ) {
575 279 $value = $this->decrypt($value);
576 280 }
@@ -575,9 +279,8 @@
575 279 $value = $this->decrypt($value);
576 280 }
577 281 else {
578 282 $value = $this->encryption->decrypt($value);
579 -
580 283 }
581 284 }
582 285 }
583 286 return $array_or_string;
@@ -586,261 +289,34 @@
586 289
587 290 /**
588 291 * debug
589 292 */
590 - public function maybe_add_debug_info( $data, $wpgetapi ) {
293 + public function maybe_add_debug_info( $data, $this_data ) {
591 294
592 - if(
593 - ( isset( $this->args['debug'] ) && ( $this->args['debug'] === true || $this->args['debug'] === 'true' ) ) ||
594 - ( isset( $this->args['test_endpoint'] ) && ( $this->args['test_endpoint'] === true ) )
595 - ) {
295 + if( isset( $this->args['debug'] ) && ( $this->args['debug'] === true || $this->args['debug'] === 'true' ) ) {
596 296
597 - $this->debug = true;
598 -
599 - // admin test endpoint button
600 - $testing = isset( $this->args['test_endpoint'] ) && ( $this->args['test_endpoint'] === true ) ? true : false;
601 -
602 - // get api status from response code
603 - $status = array(
604 - 'title' => 'Error in API response.',
605 - 'desc' => 'Check all details within your endpoint. Something is misconfigured.',
606 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
607 - );
608 -
609 - if( $this->response_code >= 200 && $this->response_code <= 299 ) {
610 - $status = array(
611 - 'title' => 'Success!',
612 - '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.',
613 - 'type' => '<span class="dashicons dashicons-yes-alt"></span>'
614 - );
615 - }
616 - if( $this->response_code >= 400 && $this->response_code <= 499 ) {
617 - $status = array(
618 - 'title' => 'Bad Request',
619 - '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.',
620 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
621 - );
622 - }
623 - if( $this->response_code == 401 ) {
624 - $status = array(
625 - 'title' => 'Unauthorised',
626 - '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.',
627 - 'type' => '<span class="dashicons dashicons-warning"></span>'
628 - );
629 - }
630 - if( $this->response_code == 403 ) {
631 - $status = array(
632 - 'title' => 'Forbidden',
633 - '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.',
634 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
635 - );
636 - }
637 - if( $this->response_code == 405 ) {
638 - $status = array(
639 - 'title' => 'Method Not Allowed',
640 - 'desc' => 'Try changing the Request Method within the endpoint settings.',
641 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
642 - );
643 - }
644 - if( $this->response_code == 415 ) {
645 - $status = array(
646 - 'title' => 'Unsupported Media Type',
647 - '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>.',
648 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
649 - );
650 - }
651 - if( $this->response_code >= 500 && $this->response_code <= 599 ) {
652 - $status = array(
653 - 'title' => 'Internal Server Error',
654 - 'desc' => 'This indicates an issue with the API server. Contact your API provider.',
655 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
656 - );
657 - }
658 -
659 -
660 297 ob_start(); ?>
661 298
662 -<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>
663 303
664 -.wpgetapi-debug {
665 - background: #fff;
666 - padding: 20px;
667 - box-shadow: 0 0 1px #aaa;
668 - margin: 20px;
669 - font-size: 15px;
670 -}
671 -.wpgetapi-debug
672 -.wpgetapi-debug p
673 -.wpgetapi-debug h5
674 -.wpgetapi-debug h6 {
675 - color: #000;
676 - line-height: 1 !important;
677 - text-transform: none !important;
678 - font-family: sans-serif !important;
679 - letter-spacing: 0px !important;
680 -}
681 -.wpgetapi-debug p.small {
682 - font-size: 85%;
683 - color: #999;
684 - margin: 0 0 12px !important;
685 -}
686 -.wpgetapi-debug h5 {
687 - font-weight: bold;
688 - font-size: 18px;
689 - margin: 0 0 3px;
690 - text-transform: none !important;
691 -}
692 -.wpgetapi-debug .debug-item {
693 - margin: 10px 0;
694 - background: #fff;
695 - padding: 15px 20px;
696 - display: inline-block !important;
697 - width: 100% !important;
698 - box-shadow: 0 4px 4px -2px rgb(0 0 0 / 9%);
699 - border: 1px solid #eee;
700 - margin-bottom: 20px !important;
701 -}
702 -.wpgetapi-debug .debug-item h6 {
703 - font-weight: bold;
704 - font-size: 14px;
705 - margin: 0;
706 - text-transform: none !important;
707 -}
708 -.wpgetapi-debug .debug-item .debug-result,
709 -.wpgetapi-debug .debug-item .debug-result pre {
710 - font-family: monospace !important;
711 - font-size: 13px !important;
712 - margin: 0 !important;
713 - padding: 8px 12px;
714 - background: #f4f7f9;
715 -}
716 -.wpgetapi-debug .debug-item .debug-result pre {
717 - border: none;
718 - padding: 5px
719 -}
720 -.wpgetapi-debug.testing {
721 - background: transparent;
722 - padding: 0;
723 - box-shadow: none;
724 -}
725 -.wpgetapi-debug.testing .debug-item {
726 - margin: 5px 0;
727 -}
728 -.wpgetapi-debug.testing .debug-item.status {
729 - border: none;
730 - box-shadow: none;
731 - margin-bottom: 15px;
732 -}
733 -.wpgetapi-debug .debug-item.status h5 {
734 - font-size: 15px;
735 -}
736 -.wpgetapi-debug .status .dashicons {
737 - margin: 0 5px 3px 0;
738 -}
739 -.wpgetapi-debug .status .dashicons-yes-alt {
740 - color: #5e9929;
741 -}
742 -.wpgetapi-debug .status .dashicons-dismiss {
743 - color: #cc4646;
744 -}
745 -.wpgetapi-debug .status .dashicons-warning {
746 - color: #dfa12e;
747 -}
748 -.wpgetapi-debug .status .desc {
749 - font-size: 14px;
750 - font-weight: 400 !important;
751 -}
752 -</style>
304 + <strong>Final URL</strong><br>
305 + <?php esc_html_e( $this->final_url ); ?><br><br>
753 306
754 - <div class="wpgetapi-debug <?php echo $testing ? 'testing' : ''; ?>">
307 + <strong>Data Output</strong><br>
308 + <?php wpgetapi_pp( $data ); ?>
755 309
756 - <?php if( $testing ) { ?>
757 -
758 - <div class="debug-item status">
759 - <div class="">
760 - <h5><?php _e( $status['type'] ); ?> <?php esc_html_e( $status['title'] ); ?></h5>
761 - <span class="desc"><?php _e( $status['desc'] ); ?></span>
762 - </div>
763 - </div>
764 - <div class="debug-item">
765 - <h6><?php esc_html_e( 'Full URL', 'wpgetapi' ); ?></h6>
766 - <p class="small"><?php esc_html_e( 'The full URL that is being called.', 'wpgetapi' ); ?></p>
767 - <div class="debug-result"><?php esc_html_e( $this->final_url ); ?></div>
768 - </div>
769 -
770 - <div class="debug-item">
771 - <h6><?php esc_html_e( 'Data Output', 'wpgetapi' ); ?></h6>
772 - <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>
773 - <div class="debug-result"><?php wpgetapi_pp( $data ); ?></div>
774 - </div>
775 -
776 - <div class="debug-item">
777 - <h6><?php esc_html_e( 'Final Request Arguments', 'wpgetapi' ); ?></h6>
778 - <p class="small"><?php esc_html_e( 'The final request arguments sent in the API request. Includes headers and body arguments.', 'wpgetapi' ); ?></p>
779 - <div class="debug-result"><?php wpgetapi_pp( $this->final_request_args ); ?></div>
780 - </div>
781 -
782 - <div class="debug-item">
783 - <h6><?php esc_html_e( 'Response', 'wpgetapi' ); ?></h6>
784 - <p class="small"><?php esc_html_e( 'The full response from the API request.', 'wpgetapi' ); ?></p>
785 - <div class="debug-result"><?php wpgetapi_pp( $this->response); ?></div>
786 - </div>
310 + <strong>Query Parameters</strong><br>
311 + <?php wpgetapi_pp( $this->query_parameters ); ?>
787 312
788 - <?php } else { ?>
789 -
790 - <h5><strong><?php esc_html_e( 'WPGetAPI, Debug Mode - Plugin Version', 'wpgetapi' ); ?> <?php esc_html_e( WpGetApi()->version ); ?></strong></h5>
791 - <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>
792 -
793 - <div class="debug-item">
794 - <h6><?php esc_html_e( 'Full URL', 'wpgetapi' ); ?></h6>
795 - <p class="small"><?php esc_html_e( 'The full URL that is being called.', 'wpgetapi' ); ?></p>
796 - <div class="debug-result"><?php esc_html_e( $this->final_url ); ?></div>
797 - </div>
798 -
799 - <div class="debug-item">
800 - <h6><?php esc_html_e( 'Data Output', 'wpgetapi' ); ?></h6>
801 - <p class="small"><?php esc_html_e( 'The resulting output that has been returned from the API.', 'wpgetapi' ); ?></p>
802 - <div class="debug-result"><?php wpgetapi_pp( $data ); ?></div>
803 - </div>
804 -
805 - <div class="debug-item">
806 - <h6><?php esc_html_e( 'Query String', 'wpgetapi' ); ?></h6>
807 - <p class="small"><?php esc_html_e( 'The query string parameters (if any) that you have set within the endpoint settings.', 'wpgetapi' ); ?></p>
808 - <div class="debug-result"><?php wpgetapi_pp( $this->query_parameters ); ?></div>
809 - </div>
810 -
811 - <div class="debug-item">
812 - <h6><?php esc_html_e( 'Headers', 'wpgetapi' ); ?></h6>
813 - <p class="small"><?php esc_html_e( 'The header parameters (if any) that you have set within the endpoint settings.', 'wpgetapi' ); ?></p>
814 - <div class="debug-result"><?php wpgetapi_pp( $this->header_parameters ); ?></div>
815 - </div>
816 -
817 - <div class="debug-item">
818 - <h6><?php esc_html_e( 'Body', 'wpgetapi' ); ?></h6>
819 - <p class="small"><?php esc_html_e( 'The body parameters (if any) that you have set within the endpoint settings.', 'wpgetapi' ); ?></p>
820 - <div class="debug-result"><?php wpgetapi_pp( $this->body_parameters ); ?></div>
821 - </div>
822 -
823 - <div class="debug-item">
824 - <h6><?php esc_html_e( 'Final Request Arguments', 'wpgetapi' ); ?></h6>
825 - <p class="small"><?php esc_html_e( 'The final request arguments sent in the API request. Includes headers and body arguments.', 'wpgetapi' ); ?></p>
826 - <div class="debug-result"><?php wpgetapi_pp( $this->final_request_args ); ?></div>
827 - </div>
828 -
829 - <div class="debug-item">
830 - <h6><?php esc_html_e( 'Arguments', 'wpgetapi' ); ?></h6>
831 - <p class="small"><?php esc_html_e( 'The arguments set within your shortcode or template tag.', 'wpgetapi' ); ?></p>
832 - <div class="debug-result"><?php wpgetapi_pp( $this->args ); ?></div>
833 - </div>
834 -
835 - <div class="debug-item">
836 - <h6><?php esc_html_e( 'Response', 'wpgetapi' ); ?></h6>
837 - <p class="small"><?php esc_html_e( 'The full response from the API request.', 'wpgetapi' ); ?></p>
838 - <div class="debug-result"><?php wpgetapi_pp( $this->response); ?></div>
839 - </div>
840 -
841 - <?php } ?>
842 -
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 +
843 319 </div>
844 320
845 321 <?php
846 322
@@ -850,9 +326,11 @@
850 326
851 327 return $data;
852 328
853 329 }
330 +
331 +
854 332
855 333 }
856 334
857 335
858 336 }