Merge remote-tracking branch 'origin'

Author: Richard

xtcommerce-cardgate-master/cardgate/classes/cardgate-clientlib-php/src/Address.php

@@ -104,7 +104,7 @@ final class Address extends Entity {
 
 		/**
 		 * Sets the gender.
-		 * @param string $sGender The gender to set.
+		 * @param string $sGender_ The gender to set.
 		 * @return Address Returns this, makes the call chainable.
 		 * @throws Exception
 		 * @access public

xtcommerce-cardgate-master/cardgate/classes/cardgate-clientlib-php/src/Cart.php

@@ -47,7 +47,7 @@ final class Cart {
 		 * @param string $iPrice_ The price of the cart item.
 		 * @param string $sLink_ An optional link to the product.
 		 * @return Item Returns the item that was added.
-		 * @throws Exception
+		 * @throws Exception|\ReflectionException
 		 * @access public
 		 * @api
 		 */

xtcommerce-cardgate-master/cardgate/classes/cardgate-clientlib-php/src/Client.php

@@ -35,7 +35,7 @@ final class Client {
 		/**
 		 * Client version.
 		 */
-		const CLIENT_VERSION = "1.1.7";
+		const CLIENT_VERSION = "1.1.10";
 
 		/**
 		 * Url to use for production.
@@ -117,6 +117,25 @@ final class Client {
 		 */
 		private $_oMethods = NULL;
 
+		/**
+		 * Debug level. 0 = None, 1 = Include result in errors, 2 = Verbose CURL calls.
+		 * @var int
+		 * @access private
+		 */
+		const DEBUG_NONE    = 0;
+		const DEBUG_RESULTS = 1;
+		const DEBUG_VERBOSE = 2;
+
+		private $_iDebugLevel = 0;
+
+		/**
+		 * Last request and result for debugging.
+		 * @var string
+		 * @access private
+		 */
+		private $_sLastRequest = NULL;
+		private $_sLastResult = NULL;
+
 		/**
 		 * The constructor.
 		 * @param int $iMerchantId_ The merchant id for the client.
@@ -130,6 +149,22 @@ function __construct( $iMerchantId_, $sKey_, $bTestmode_ = FALSE ) {
 			$this->setMerchantId( $iMerchantId_ )->setKey( $sKey_ )->setTestmode( $bTestmode_ );
 		}
 
+		/**
+		 * Prevent leaking info in dumps.
+		 * @ignore
+		 */
+		public function __debugInfo() {
+			return [
+				'Version'       => $this->_oVersion,
+				'Testmode'    => $this->_bTestmode,
+				'DebugLevel'  => $this->_iDebugLevel,
+				'iMerchantId' => $this->_iMerchantId,
+				'API_URL'     => $this->getUrl(),
+				'LastRequest' => $this->_sLastRequest,
+				'LastResult'  => $this->_sLastResult
+			];
+		}
+
 		/**
 		 * Toggle testmode.
 		 * @param bool $bTestmode_ Enable or disable testmode for this client.
@@ -156,6 +191,49 @@ public function getTestmode() {
 			return $this->_bTestmode;
 		}
 
+		/**
+		 * Set debug level.
+		 * @param int $iDebugLevel_ Level: 0 = None, 1 = Include request/resule in errors, 2 = Verbose cURL calls.
+		 * @return $this
+		 * @access public
+		 * @api
+		 */
+		public function setDebugLevel( $iLevel_ ) {
+			$this->_iDebugLevel = $iLevel_;
+			return $this;
+		}
+
+		/**
+		 * Get current debug level setting.
+		 * @return int The current debug level.
+		 * @access public
+		 * @api
+		 */
+		public function getDebugLevel() {
+			return $this->_iDebugLevel;
+		}
+
+		/**
+		 * Get debug information according to debug level.
+		 * @param bool $bStartWithNewLine_ Optional flag to indicate the info should start with a new-line.
+		 * @param bool $bAddResult_ Optional flag to indicate the result should be included too.
+		 * @return string Debug info or empty if level = 0.
+		 * @access public
+		 * @api
+		 */
+		public function getDebugInfo( $bStartWithNewLine_ = TRUE, $bAddResult_ = TRUE ) {
+			if ( $this->getDebugLevel() > self::DEBUG_NONE ) {
+				$sResult = ( $bStartWithNewLine_ ? PHP_EOL : '' );
+				$sResult .= 'Request: ' . $this->getLastRequest();
+				if ( $bAddResult_ ) {
+					$sResult .= PHP_EOL . 'Result: ' . $this->getLastResult();
+				}
+				return $sResult;
+			} else {
+				return '';
+			}
+		}
+
 		/**
 		 * Configure the client object with a merchant id.
 		 * @param int $iMerchantId_ Merchant id to set.
@@ -277,6 +355,26 @@ public function getUrl() {
 			}
 		}
 
+		/**
+		 * Get the last request sent to the API.
+		 * @return string The request string.
+		 * @access public
+		 * @api
+		 */
+		public function getLastRequest() {
+			return (string) $this->_sLastRequest;
+		}
+
+		/**
+		 * Get the last result from an API call.
+		 * @return string The result string.
+		 * @access public
+		 * @api
+		 */
+		public function getLastResult() {
+			return (string) $this->_sLastResult;
+		}
+
 		/**
 		 * Pull the config from the API using a token provided by the site setup button in the backoffice.
 		 * @return array Returns an array with settings.
@@ -409,10 +507,6 @@ public function doRequest( $sResource_, $aData_ = NULL, $sHttpMethod_ = 'POST' )
 			if ( is_array( $aData_ ) ) {
 				$aData_['ip'] = $this->getIp();
 				$aData_['language_id'] = $this->getLanguage();
-				if ( 'GET' == $sHttpMethod_ ) {
-					$sDelim = ( FALSE === strchr( $sUrl, '?' ) ? '?' : '&' );
-					$sUrl .= $sDelim . http_build_query( $aData_ );
-				}
 			} elseif ( is_null( $aData_ ) ) {
 				$aData_ = [ 'ip' => $this->getIp(), 'language_id' => $this->getLanguage() ];
 			} else {
@@ -424,7 +518,6 @@ public function doRequest( $sResource_, $aData_ = NULL, $sHttpMethod_ = 'POST' )
 			}
 
 			$rCh = curl_init();
-			curl_setopt( $rCh, CURLOPT_URL, $sUrl );
 			curl_setopt( $rCh, CURLOPT_HTTPAUTH, CURLAUTH_BASIC );
 			curl_setopt( $rCh, CURLOPT_USERPWD, $this->_iMerchantId . ':' . $this->_sKey );
 			curl_setopt( $rCh, CURLOPT_RETURNTRANSFER, 1 );
@@ -443,22 +536,36 @@ public function doRequest( $sResource_, $aData_ = NULL, $sHttpMethod_ = 'POST' )
 			}
 
 			if ( 'POST' == $sHttpMethod_ ) {
+				$this->_sLastRequest = json_encode( $aData_ );
+				curl_setopt( $rCh, CURLOPT_URL, $sUrl );
 				curl_setopt( $rCh, CURLOPT_POST, TRUE );
-				curl_setopt( $rCh, CURLOPT_POSTFIELDS, json_encode( $aData_ ) );
+				curl_setopt( $rCh, CURLOPT_POSTFIELDS, $this->_sLastRequest );
+				$this->_sLastRequest = "[POST $sUrl] " . $this->_sLastRequest;
+			} else {
+				$this->_sLastRequest = $sUrl
+					. ( FALSE === strchr( $sUrl, '?' ) ? '?' : '&' )
+					. http_build_query( $aData_ )
+				;
+				curl_setopt( $rCh, CURLOPT_URL, $this->_sLastRequest );
 			}
 
-			if ( FALSE == ( $sResults = curl_exec( $rCh ) ) ) {
+			if ( self::DEBUG_VERBOSE == $this->_iDebugLevel ) {
+				curl_setopt( $rCh, CURLOPT_VERBOSE, TRUE );
+			}
+
+			$this->_sLastResult = curl_exec( $rCh );
+			if ( FALSE == $this->_sLastResult ) {
 				$sError = curl_error( $rCh );
 				curl_close( $rCh );
 				throw new Exception( 'Client.Request.Curl.Error', $sError );
 			} else {
 				curl_close( $rCh );
 			}
-			if ( NULL === ( $aResults = json_decode( $sResults, TRUE ) ) ) {
-				throw new Exception( 'Client.Request.JSON.Invalid', 'remote gave invalid JSON: ' . $sResults );
+			if ( NULL === ( $aResults = json_decode( $this->_sLastResult, TRUE ) ) ) {
+				throw new Exception( 'Client.Request.JSON.Invalid', 'remote gave invalid JSON: ' . $this->_sLastResult );
 			}
 			if ( isset( $aResults['error'] ) ) {
-				throw new Exception( 'Client.Request.Remote.' . $aResults['error']['code'], $aResults['error']['message'] );
+				throw new Exception( 'Client.Request.Remote.' . $aResults['error']['code'], $aResults['error']['message']	. $this->getDebugInfo()	);
 			}
 
 			return $aResults;

xtcommerce-cardgate-master/cardgate/classes/cardgate-clientlib-php/src/Entity.php

@@ -42,7 +42,7 @@ abstract class Entity {
 		 * @ignore
 		 * @internal To make the data in an Entity available through magic functions (setName, getAmount, unsetName,
 		 * hasCart) populate the _aFields property below. To make autocompletion work in Zend, use the @method phpdoc
-		 * directove like this: @method null setId( int $iId ).
+		 * directive like this: @method null setId( int $iId ).
 		 * Example: [ 'MerchantId' => 'merchant_id', 'Name' => 'name' ]
 		 */
 		static protected $_aFields = [];
@@ -52,15 +52,16 @@ abstract class Entity {
 		 * @param string $sPrefix_ Optionally prefix all the data entries.
 		 * @return array Returns an array with the data in the entity.
 		 */
-		public function getData( $sPrefix_ = FALSE ) {
-			$aResult = [];
-			foreach( $this->_aData as $sKey => $mValue ) {
-				if ( is_string( $sPrefix_ ) ) {
-					$sKey = $sPrefix_ . $sKey;
+		public function getData( $sPrefix_ = NULL ) {
+			if ( is_string( $sPrefix_ ) ) {
+				$aResult = [];
+				foreach( $this->_aData as $sKey => $mValue ) {
+					$aResult[$sPrefix_ . $sKey] = $mValue;
 				}
-				$aResult[$sKey] = $mValue;
+				return $aResult;
+			} else {
+				return $this->_aData;
 			}
-			return $aResult;
 		}
 
 		/**

xtcommerce-cardgate-master/cardgate/classes/cardgate-clientlib-php/src/Item.php

@@ -134,9 +134,10 @@ final class Item extends Entity {
 		 * @param int $iType_ The cart item type.
 		 * @param string $sSKU_ The SKU of the cart item.
 		 * @param string $sName_ The name of the cart item (productname).
+		 * @param $iQuantity_
 		 * @param int $iPrice_ The price of the cart item.
 		 * @param string $sLink_ An optional link to the product.
-		 * @throws Exception
+		 * @throws Exception|\ReflectionException
 		 * @access public
 		 * @api
 		 */
@@ -184,7 +185,6 @@ function setVat( $fVat_ ) {
 		 * Sets the vat included flag.
 		 * @param bool $bVatIncluded_ The vat included flag to set.
 		 * @return Item Returns this, makes the call chainable.
-		 * @throws Exception
 		 * @access public
 		 * @api
 		 */

xtcommerce-cardgate-master/cardgate/classes/cardgate-clientlib-php/src/Method.php

@@ -112,6 +112,26 @@ final class Method {
 		 */
 		const BILLINK = 'billink';
 
+		/**
+		 * IDEALQR
+		 */
+		const IDEALQR = 'idealqr';
+
+		/**
+		 * Paysafecash
+		 */
+		const PAYSAFECASH = 'paysafecash';
+		
+		/**
+		 * SofortPay
+		 */
+		const SOFORTPAY = 'sofortpay';
+		
+		/**
+		 * Gift Card
+		 */
+		const GIFTCARD = 'giftcard';
+
 		/**
 		 * The client associated with this payment method.
 		 * @var Client
@@ -137,17 +157,19 @@ final class Method {
 		 * The constructor.
 		 * @param Client $oClient_ The client associated with this transaction.
 		 * @param string $sId_ The payment method identifier to create a method instance for.
-		 * @throws Exception
+		 * @throws Exception|\ReflectionException
 		 * @access public
 		 * @api
+		 * @throws
 		 */
 		function __construct( Client $oClient_, $sId_, $sName_ ) {
+			static $aValidMethods; // use static cache for this
+
+			if ( ! isset( $aValidMethods ) ) {
+				$aValidMethods  = ( new \ReflectionClass( '\cardgate\api\Method' ) )->getConstants();
+			}
 			$this->_oClient = $oClient_;
-			try {
-				if ( ! in_array( $sId_, ( new \ReflectionClass( '\cardgate\api\Method' ) )->getConstants() ) ) {
-					throw new Exception('Method.PaymentMethod.Invalid', 'invalid payment method: ' . $sId_);
-				}
-			} catch ( \ReflectionException $oException_ ) {
+			if ( ! in_array( $sId_, $aValidMethods ) ) {
 				throw new Exception('Method.PaymentMethod.Invalid', 'invalid payment method: ' . $sId_);
 			}
 			$this->setId( $sId_ );
@@ -220,10 +242,23 @@ public function getName() {
 		 * @api
 		 */
 		public function getIssuers() {
-			$sResource = $this->_sId . '/issuers/';
-
-			$aResult = $this->_oClient->doRequest( $sResource, NULL, 'GET' );
 
+			if ( TRUE ) {
+				// Use the static version which is automatically updated every day
+				$aResult = [
+					'issuers' => $this->_oClient->doRequest(
+						$this->_oClient->getTestMode()
+							?   '../../../cache/idealDirectoryCUROPayments-TEST.json'
+							:   '../../../cache/idealDirectoryCUROPayments.json'
+						, NULL, 'GET'
+					)
+				];
+			} else {
+				// Retrieve using API call.
+				// TODO: The response should be cached on the local system for 24 hours!
+				$sResource = $this->_sId . '/issuers/';
+				$aResult = $this->_oClient->doRequest( $sResource, NULL, 'GET' );
+			}
 			if ( empty( $aResult['issuers'] ) ) {
 				throw new Exception( 'Method.Issuers.Invalid', 'invalid issuer data returned' );
 			}

xtcommerce-cardgate-master/cardgate/classes/cardgate-clientlib-php/src/Subscription.php

@@ -104,6 +104,13 @@ final class Subscription extends Transaction {
 		 */
 		private $_sEndDate;
 
+		/**
+		 * The status of the subscription.
+		 * @var string
+		 * @access private
+		 */
+		private $_sStatus;
+
 		/**
 		 * The constructor.
 		 * @param Client $oClient_ The client associated with this subscription.
@@ -118,7 +125,11 @@ final class Subscription extends Transaction {
 		 */
 		function __construct( Client $oClient_, $iSiteId_, $iPeriod_, $sPeriodType_, $iPeriodAmount_, $sCurrency_ = 'EUR' ) {
 			$this->_oClient = $oClient_;
-			$this->setSiteId( $iSiteId_ )->setPeriod( $iPeriod_ )->setPeriodType( $sPeriodType_ )->setPeriodPrice( $iPeriodAmount_ )->setCurrency( $sCurrency_ );
+			$this->setSiteId( $iSiteId_ )
+			     ->setPeriod( $iPeriod_ )
+			     ->setPeriodType( $sPeriodType_ )
+			     ->setPeriodPrice( $iPeriodAmount_ )
+			     ->setCurrency( $sCurrency_ );
 		}
 
 		/**
@@ -450,7 +461,7 @@ public function register() {
 				empty( $aResult )
 				|| empty( $aResult['subscription'] )
 			) {
-				throw new Exception( 'Subscription.Request.Invalid', 'invalid payment data returned' );
+				throw new Exception( 'Subscription.Request.Invalid', 'unexpected result: ' . $this->_oClient->getLastResult() . $this->_oClient->getDebugInfo( TRUE, FALSE ) );
 			}
 			$this->_sId = $aResult['subscription'];
 			if (
@@ -491,7 +502,8 @@ public function changeStatus( $sStatus_ ) {
 			$aResult = $this->_oClient->doRequest( $sResource, $aData, 'POST' );
 
 			if ( FALSE == $aResult['success'] ) {
-				throw new Exception( 'Subscription.Request.Invalid', 'error changing status' );
+				// oClient will have thrown an error if there was a proper error from the API, so this is weird!
+				throw new Exception( 'Subscription.Request.Invalid', 'unexpected result: ' . $this->_oClient->getLastResult() . $this->_oClient->getDebugInfo( TRUE, FALSE ) );
 			}
 
 			return TRUE;