class-sageapi.php

<?php
/**
 * WP-Sage-API
 *
 * @package WP-Sage-API
 */

/*
* Plugin Name: WP Sage API
* Plugin URI: https://github.com/wp-api-libraries/wp-sage-api
* Description: Perform API requests to Sage 100 in WordPress.
* Author: WP API Libraries
* Version: 1.0.0
* Author URI: https://wp-api-libraries.com
* GitHub Plugin URI: https://github.com/wp-api-libraries/wp-sage-api
* GitHub Branch: master
*/

/* Exit if accessed directly. */
defined( 'ABSPATH' ) || exit;


/* Check if class exists. */
if ( ! class_exists( 'SageAPI' ) ) {

	/**
	 * Sage API Class.
	 */
	class SageAPI {

		/**
		 * Route being called.
		 *
		 * @var string
		 */
		public $route = '';

		/**
		 * Base API URL.
		 *
		 * @var string
		 */
		public static $base_uri;

		/**
		 * API Username.
		 *
		 * @var string
		 */
		public static $username;

		/**
		 * API Password.
		 *
		 * @var string
		 */
		public static $password;

		/**
		 * Company Code.
		 *
		 * @var string
		 */
		public static $company_code;

		/**
		 * Links for pagination
		 *
		 * @var string
		 */
		public $sdata_links;

		/**
		 * Initialize the API object
		 *
		 * @since 0.1
		 * @param string $base_uri The endpoint URL.
		 * @param string $username connection username.
		 * @param string $password connection password.
		 * @param string $company_code identifies the company.
		 */
		public function __construct( $base_uri, $username, $password, $company_code ) {

			static::$username     = $username;
			static::$password     = $password;
			static::$company_code = $company_code;
			static::$base_uri     = $base_uri . '/' . $company_code . '/';

		}


		/**
		 * Prepares API request.
		 *
		 * @param  string $route   API route to make the call to.
		 * @param  array  $args    Arguments to pass into the API call.
		 * @param  string $method  HTTP Method to use for request.
		 * @return self            Returns an instance of itself so it can be chained to the fetch method.
		 */
		protected function build_request( string $route, array $args = array(), string $method = 'GET' ) {

			// Headers get added first.
			$this->set_headers();
			// Add Method and Route.
			$this->args['method']    = $method;
			$this->args['sslverify'] = true;
			$this->route             = $route;

			if ( 'GET' === $method ) {
				$this->route = add_query_arg( array_filter( $args ), $route );
			} else {
				$this->args['body'] = $args;
			}

			return $this;
		}

		/**
		 * Fetch the request from the API.
		 *
		 * @param  array $args Arguments.
		 */
		protected function fetch( $args = array() ) {

			$format = $args['format'] ?? '';

			// Make the request.
			$response = wp_remote_request( static::$base_uri . $this->route, $this->args ) ?? '';

			// Make sure Response is not Error.
			if ( is_wp_error( $response ) ) {
					return $response->get_error_messages();
			}

			// Retrieve Status code & body.
			$code = wp_remote_retrieve_response_code( $response ) ?? '';

			// Return WP_Error if request is not successful.
			if ( ! $this->is_status_ok( $code ) ) {
				return new WP_Error( 'response-error', sprintf( 'Status: %d', $code ) );
			} else {

				// Get Response Body.
				$body = wp_remote_retrieve_body( $response ) ?? '';

				if ( ! is_wp_error( $body ) && ! empty( $body ) ) {

					if ( 'xml' !== $format || empty( $format ) ) {

						$parsed_xml = $this->xmlstr_to_array( $body ) ?? array();

						$results = array(
							'results'          => $this->get_payload( $parsed_xml ),
							'total_results'    => $this->get_total_results( $parsed_xml ),
							'start_index'      => $this->get_start_index( $parsed_xml ),
							'items_per_page'   => $this->get_items_per_page( $parsed_xml ),
							'has_more'         => $this->get_has_more( $parsed_xml ),
							'next_start_index' => $this->get_next_start_index( $parsed_xml ),
							'next_count'       => $this->get_next_count( $parsed_xml ),
							'_sage_links'      => $this->get_sdata_links( $parsed_xml ),
						);

						$this->clear();

						if ( 'json' === $format ) {
								return wp_json_encode( $results );
						} else {
							return $results;
						}

						return $results;

					} else {

						return $body;
					}
				} else {

					return null;
				}
			}

		}

		/**
		 * Set request headers.
		 */
		public function set_headers() {
			$this->args['headers'] = array(
				'Authorization' => 'Basic ' . base64_encode( static::$username . ':' . static::$password ), // @codingStandardsIgnoreLine
			);
		}

		/**
		 * Clear query data.
		 */
		public function clear() {
			$this->args = array();
		}

		/**
		 * Get SData Links.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 * @return array SData Links.
		 */
		public function get_sdata_links( array $parsed_xml ) {

			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {

				$links = $parsed_xml['link'] ?? array();

				$sdata_links = array();

				if ( $links ) {
					foreach ( $links as $link ) {

						$results = wp_parse_url( $link['attributes']['href'] ) ?? '';
						parse_str( $results['query'], $query_vars );

						$start_index = intval( $query_vars['startIndex'] ) ?? '';
						$count       = intval( $query_vars['count'] ) ?? '';

						$sdata_links[] = array(
							'rel'        => esc_attr( $link['attributes']['rel'] ),
							'link'       => $link['attributes']['href'],
							'startIndex' => $start_index,
							'count'      => $count,
						);
					}
				}

				return $sdata_links;
			}

		}

		/**
		 * Get Has More.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 * @return boolean True or False, if more pages.
		 */
		public function get_has_more( array $parsed_xml ) {

			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {

				$links = $parsed_xml['link'] ?? array();

				$has_more = false;

				if ( $links ) {
					foreach ( $links as $link ) {

						$results = wp_parse_url( $link['attributes']['href'] ) ?? '';
						parse_str( $results['query'], $query_vars );

						if ( 'last' === $link['attributes']['rel'] ) {
							$has_more = true;
						}
					}
				}

				return $has_more;
			}

		}

		/**
		 * Get Next Link.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_next_link( array $parsed_xml ) {

			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {

				$sdata_links = $this->get_sdata_links( $parsed_xml ) ?? array();

				if ( $sdata_links ) {

					foreach ( $sdata_links as $sdata_link ) {
						if ( 'next' === $sdata_link['rel'] ) {
							$results = wp_parse_url( $sdata_link['link'] ) ?? '';
							parse_str( $results['query'], $query_vars );
							return $query_vars;
						}
					}
				}

				return null;

			}

		}

		/**
		 * Get Next Start Index.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_next_start_index( array $parsed_xml ) {

			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {

				$sdata_links = $this->get_sdata_links( $parsed_xml ) ?? array();

				if ( $sdata_links ) {

					foreach ( $sdata_links as $sdata_link ) {
						if ( 'next' === $sdata_link['rel'] ) {
							$results = wp_parse_url( $sdata_link['link'] ) ?? '';
							parse_str( $results['query'], $query_vars );
							return intval( $query_vars['startIndex'] );
						}
					}
				}

				return null;

			}

		}

		/**
		 * Get Next Count.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_next_count( array $parsed_xml ) {

			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {

				$sdata_links = $this->get_sdata_links( $parsed_xml ) ?? array();

				if ( $sdata_links ) {

					foreach ( $sdata_links as $sdata_link ) {
						if ( 'next' === $sdata_link['rel'] ) {
							$results = wp_parse_url( $sdata_link['link'] ) ?? '';
							parse_str( $results['query'], $query_vars );
							return intval( $query_vars['count'] );
						}
					}
				}

				return null;

			}

		}

		/**
		 * Get Self Link.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_self_link( array $parsed_xml ) {

			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {

				$sdata_links = $this->get_sdata_links( $parsed_xml ) ?? array();

				if ( $sdata_links ) {
					foreach ( $sdata_links as $sdata_link ) {
						if ( 'self' === $sdata_link['rel'] ) {
							$results = wp_parse_url( $sdata_link['link'] ) ?? '';
							parse_str( $results['query'], $query_vars );
							return $query_vars;

						}
					}
				}
			}

		}

		/**
		 * Get Last Link.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_last_link( array $parsed_xml ) {

			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {

				$sdata_links = $this->get_sdata_links( $parsed_xml ) ?? array();

				if ( $sdata_links ) {
					foreach ( $sdata_links as $sdata_link ) {
						if ( 'last' === $sdata_link['rel'] ) {
							$results = wp_parse_url( $sdata_link['link'] ) ?? '';
							parse_str( $results['query'], $query_vars );
							return $query_vars;
						}
					}
				}
			}

		}

		/**
		 * Get First Link.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_first_link( array $parsed_xml ) {

			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {

				$sdata_links = $this->get_sdata_links( $parsed_xml ) ?? array();

				if ( $sdata_links ) {
					foreach ( $sdata_links as $sdata_link ) {
						if ( 'first' === $sdata_link['rel'] ) {
							$results = wp_parse_url( $sdata_link['link'] ) ?? '';
							parse_str( $results['query'], $query_vars );
							return $query_vars;
						}
					}
				}
			}

		}

		/**
		 * Decamelize String.
		 *
		 * @param  string $string String.
		 * @return [type]         [description]
		 */
		public function decamelize( string $string ) {
			return strtolower( preg_replace( array( '/([a-z\d])([A-Z])/', '/([^_])([A-Z][a-z])/' ), '$1_$2', $string ) );
		}


		/**
		 * Get Previous Link.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_previous_link( array $parsed_xml ) {

			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {

				$sdata_links = $this->get_sdata_links( $parsed_xml ) ?? array();

				if ( $sdata_links ) {
					foreach ( $sdata_links as $sdata_link ) {
						if ( 'previous' === $sdata_link['rel'] ) {
							$results = wp_parse_url( $sdata_link['link'] ) ?? '';
							parse_str( $results['query'], $query_vars );
							return $query_vars;
						}
					}
				}
			}

		}

		/**
		 * Get Total Results.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_total_results( array $parsed_xml ) {
			$total_results = '';
			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {
				$total = $parsed_xml['opensearch:totalResults'] ?? '';
				if ( $total ) {
					$total_results = intval( $total ) ?? '';
					return $total_results;
				}
			}
		}

		/**
		 * Get Start Index.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_start_index( array $parsed_xml ) {
			$start_index = '';
			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {
				$index = $parsed_xml['opensearch:startIndex'] ?? '';
				if ( $index ) {
					$start_index = intval( $parsed_xml['opensearch:startIndex'] ) ?? '';
					return $start_index;
				}
			}
		}

		/**
		 * Get Items per Page.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_items_per_page( array $parsed_xml ) {
			$items_per_page = '';
			if ( ! empty( $parsed_xml ) && ! is_wp_error( $parsed_xml ) ) {
				$items = $parsed_xml['opensearch:itemsPerPage'] ?? '';
				if ( $items ) {
					$items_per_page = intval( $items ) ?? '';
					return $items_per_page;
				}
			}
		}

		/**
		 * Check if HTTP status code is a success.
		 *
		 * @param  int $code HTTP status code.
		 * @return boolean       True if status is within valid range.
		 */
		public function is_status_ok( $code ) {
			return ( 200 <= $code && 300 > $code );
		}

		/**
		 * Convert xml string to php array
		 *
		 * @param  string $xml XML.
		 * @return array  PHP Array from XML.
		 */
		public function xmlstr_to_array( string $xml ): array {
			if ( $xml ) {
				assert( \class_exists( '\DOMDocument' ) );
				$doc = new \DOMDocument();
				$doc->loadXML( $xml );
				$root            = $doc->documentElement; // @codingStandardsIgnoreLine
				$output          = (array) $this->domnode_to_array( $root );
				$output['@root'] = $root->tagName; // @codingStandardsIgnoreLine
				return $output ?? array();
			} else {
				return array();
			}
		}

		/**
		 * Dom Element to Array.
		 *
		 * @param  [type] $node Dom Element Node.
		 * @return array|string
		 */
		public function domnode_to_array( $node ) {
			$output = array();
			switch ( $node->nodeType ) { // @codingStandardsIgnoreLine
				case 4: // XML_CDATA_SECTION_NODE.
				case 3: // XML_TEXT_NODE.
						$output = trim( $node->textContent ); // @codingStandardsIgnoreLine
					break;
				case 1: // XML_ELEMENT_NODE.
					for ( $i = 0, $m = $node->childNodes->length; $i < $m; $i++ ) { // @codingStandardsIgnoreLine
						$child = $node->childNodes->item( $i ); // @codingStandardsIgnoreLine
						$v     = $this->domnode_to_array( $child );
						if ( isset( $child->tagName ) ) { // @codingStandardsIgnoreLine
							  $t = $child->tagName; // @codingStandardsIgnoreLine
							if ( ! isset( $output[ $t ] ) ) {
								$output[ $t ] = array();
							}
							$output[ $t ][] = $v;
						} elseif ( $v || '0' === $v ) {
							$output = (string) $v;
						}
					}
					if ( $node->attributes->length && ! is_array( $output ) ) { // Has attributes but isn't an array.
						$output = array( 'content' => $output ); // Change output into an array.
					}
					if ( is_array( $output ) ) {
						if ( $node->attributes->length ) {
							$a = array();
							foreach ( $node->attributes as $attr_name => $attr_node ) {
								$a[ $attr_name ] = (string) $attr_node->value;
							}
							$output['attributes'] = $a;
						}
						foreach ( $output as $t => $v ) {
							if ( 'attributes' !== $t && is_array( $v ) && 1 === count( $v ) ) {
								$output[ $t ] = $v[0];
							}
						}
					}
					break;
			}
			return $output;
		}

		/**
		 * Get Generator.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_generator( $parsed_xml ) {
			if ( ! empty( $parsed_xml ) ) {
				return $parsed_xml['generator'] ?? '';
			}
		}

		/**
		 * Get Title.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_title( $parsed_xml ) {
			if ( ! empty( $parsed_xml ) ) {
				return $parsed_xml['title'] ?? '';
			}
		}

		/**
		 * [get_category description]
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_category( $parsed_xml ) {
			if ( ! empty( $parsed_xml ) ) {
				return $parsed_xml['category'] ?? '';
			}
		}

		/**
		 * [get_author description]
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_author( $parsed_xml ) {
			if ( ! empty( $parsed_xml ) ) {
				return $parsed_xml['author'] ?? '';
			}
		}

		/**
		 * [get_id description]
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_id( $parsed_xml ) {
			if ( ! empty( $parsed_xml ) ) {
				return esc_url( $parsed_xml['id'] ) ?? '';
			}
		}

		/**
		 * [get_content description]
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_content( $parsed_xml ) {
			if ( ! empty( $parsed_xml ) ) {
				return $parsed_xml['content'] ?? '';
			}
		}

		/**
		 * [get_http_status description]
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_http_status( $parsed_xml ) {
			if ( ! empty( $parsed_xml ) ) {
				return $parsed_xml['http:httpStatus'] ?? '';
			}
		}

		/**
		 * [get_entry_author description]
		 *
		 * @param  array $entry Entry.
		 */
		public function get_entry_author( $entry ) {
			if ( ! empty( $entry ) ) {
				return $entry['author']['name'] ?? '';
			}
		}

		/**
		 * [get_entry_content description]
		 *
		 * @param  array $entry Entry.
		 */
		public function get_entry_content( $entry ) {
			if ( ! empty( $entry ) ) {
				return $entry['content'] ?? '';
			}
		}

		/**
		 * [get_entry_id description]
		 *
		 * @param  array $entry Entry.
		 */
		public function get_entry_id( $entry ) {
			if ( ! empty( $entry ) ) {
				$entry_id = $entry['id'] ?? '';
				return esc_url_raw( $entry_id ) ?? '';
			}
		}

		/**
		 * [get_entry_title description]
		 *
		 * @param  array $entry Entry.
		 */
		public function get_entry_title( $entry ) {
			if ( ! empty( $entry ) ) {
				return $entry['title'] ?? '';
			}
		}

		/**
		 * [get_entry_updated description]
		 *
		 * @param  array $entry Entry.
		 */
		public function get_entry_updated( $entry ) {
			if ( ! empty( $entry ) ) {
				return $entry['updated'] ?? '';
			}
		}

		/**
		 * [get_entry_http_status description]
		 *
		 * @param  array $entry Entry.
		 */
		public function get_entry_http_status( $entry ) {
			if ( ! empty( $entry ) ) {
				return intval( $entry['http:httpStatus'] ) ?? '';
			}
		}

		/**
		 * [get_updated description]
		 *
		 * @param  [type] $parsed_xml Parsed XML.
		 */
		public function get_updated( $parsed_xml ) {
			if ( ! empty( $parsed_xml ) ) {
				return $parsed_xml['updated'] ?? '';
			}
		}

		/**
		 * Get Payload.
		 *
		 * @param  array $parsed_xml Parsed XML.
		 */
		public function get_payload( array $parsed_xml ) {

			$payloads = array();
			$data     = array();

			if ( ! empty( $parsed_xml ) && $this->get_items_per_page( $parsed_xml ) > 1 ) {

				if ( $parsed_xml['entry'] ) {
					foreach ( $parsed_xml['entry'] as $entry ) {
						$entry_payload = $entry['sdata:payload'] ?? '';

								$payloads[] = array(
									'id'      => $this->get_entry_id( $entry ) ?? '',
									'author'  => $this->get_entry_author( $entry ) ?? '',
									'status'  => $this->get_entry_http_status( $entry ) ?? '',
									'updated' => $this->get_entry_updated( $entry ) ?? '',
									'data'    => array_values( $entry_payload )[0] ?? '',
								) ?? array();
					}
				}
			} else {

						$entry_payload = $parsed_xml['entry']['sdata:payload'] ?? '';

				if ( $entry_payload ) {

						$payloads[] = array(
							'id'      => $this->get_id( $parsed_xml ) ?? '',
							'author'  => $this->get_entry_author( $parsed_xml ) ?? '',
							'status'  => $this->get_http_status( $parsed_xml ) ?? '',
							'updated' => $this->get_updated( $parsed_xml ) ?? '',
							'data'    => array_values( $entry_payload )[0] ?? '',
						) ?? array();

				}
			}

			return $payloads;

		}

	}

	require_once trailingslashit( dirname( __FILE__ ) ) . 'autoloader.php';
}