Update the following:

1) Allow facade to accepts objects
2) Change default Minor Version
3) Add vendor support
4) Add parse support for IPPFault
5) Fix Platform Service Call
6) Update _Samples

Author: hlu2

src/Core/Configuration/BaseUrl.php

@@ -1,6 +1,9 @@
 <?php
 namespace QuickBooksOnline\API\Core\Configuration;
 
+use QuickBooksOnline\API\Core\CoreConstants;
+
+
 /**
 * Base Urls for QBO, QBD and IPP
 * -----------------
@@ -35,7 +38,7 @@ public function __construct($Qbo=null, $Ipp=null)
         {
           $this->Ipp = $Ipp;
         }else {
-          $this->Ipp = "https://appcenter.intuit.com/api/";
+          $this->Ipp =  CoreConstants::IPP_BASEURL;
         }
     }
 }

src/Core/Configuration/LocalConfigReader.php

@@ -96,7 +96,7 @@ public static function ReadConfigurationFromFile($filePath, $OAuthOption = CoreC
         }
     }
 
-    public static function ReadConfigurationFromParameters($OAuthConfig, $baseUrl, $defaultLoggingLocation = CoreConstants::DEFAULT_LOGGINGLOCATION, $minorVersion = 3)
+    public static function ReadConfigurationFromParameters($OAuthConfig, $baseUrl, $defaultLoggingLocation = CoreConstants::DEFAULT_LOGGINGLOCATION, $minorVersion = CoreConstants::DEFAULT_SDK_MINOR_VERSION)
     {
         $ippConfig = new IppConfiguration();
         try {

src/Core/CoreConstants.php

@@ -6,6 +6,8 @@
  */
 class CoreConstants
 {
+    //Set the default minor version to 8
+    const DEFAULT_SDK_MINOR_VERSION = "8";
     const DEFAULT_LOGGINGLOCATION = "/tmp/IdsLogs";
 
     const PHP_CLASS_PREFIX = 'IPP';
@@ -157,6 +159,8 @@ class CoreConstants
      */
     const QBO_BASEURL = "https://quickbooks.api.intuit.com/";
 
+    const IPP_BASEURL = "https://appcenter.intuit.com/api/";
+
     /**
      * Id Parameter Name.
      * @var string Id
@@ -239,7 +243,7 @@ class CoreConstants
      * The Request source header value.
      * @var string REQUESTSOURCEHEADER
      */
-    const USERAGENT = "V3PHPSDK3.2.0";
+    const USERAGENT = "V3PHPSDK3.2.6";
 
     public static function getType($string, $return=1)
     {

src/Core/HttpClients/FaultHandler.php

@@ -1,6 +1,7 @@
 <?php
 namespace QuickBooksOnline\API\Core\HttpClients;
 
+use QuickBooksOnline\API\Data\IPPFault;
 /**
  * Handles the 3xx, 4xx and 5xx response status code in the response and handles them.
  * This class use the pecl OAuth Extension. Rewrite it to be native cURL request @Hao
@@ -28,6 +29,17 @@ class FaultHandler
         * The OAuth error message will store here.
         */
      private $oAuthHelperError;
+
+
+     //Intuit Error helper information
+     private $intuitErrorType;
+
+     private $intuitErrorCode;
+
+     private $intuitErrorMessage;
+
+     private $intuitErrorDetail;
+
     /**
      * Initializes a new instance of the FaultHandler class.
      * @param ServiceContext context
@@ -82,4 +94,27 @@ public function getResponseBody()
     {
         return $this->responseBody;
     }
+
+    public function getIntuitErrorType(){
+        return $this->intuitErrorType;
+    }
+
+    public function getIntuitErrorCode(){
+        return $this->intuitErrorCode;
+    }
+
+    public function getIntuitErrorMessage(){
+        return $this->intuitErrorMessage;
+    }
+
+    public function getIntuitErrorDetail(){
+        return $this->intuitErrorDetail;
+    }
+    public function parseResponse($message){
+      $xmlObj = simplexml_load_string($message);
+      $this->intuitErrorType = (string)$xmlObj->Fault->attributes()['type'];
+      $this->intuitErrorCode = (string)$xmlObj->Fault->Error->attributes()['code'];
+      $this->intuitErrorMessage = (string)$xmlObj->Fault->Error->Message;
+      $this->intuitErrorDetail = (string)$xmlObj->Fault->Error->Detail;
+    }
 }

src/Core/HttpClients/IntuitResponse.php

@@ -32,6 +32,7 @@ public function __construct($passedHeaders, $passedBody, $passedHttpResponseCode
                  $this->faultHandler = new FaultHandler();
                  $this->faultHandler->setHttpStatusCode($this->httpResponseCode);
                  $this->faultHandler->setResponseBody($this->body);
+                 $this->faultHandler->parseResponse($this->body);
                  //Manually set the error message
                  $this->faultHandler->setOAuthHelperError("Invalid auth/bad request (got a 401, expected HTTP/1.1 20X or a redirect)");
               }

src/Core/HttpClients/SyncRestHandler.php

@@ -208,7 +208,21 @@ public function sendRequest($requestParameters, $requestBody, $oauthRequestUri)
             }
         } else {
             // IPP call
-            $httpHeaders = array('user-agent' => CoreConstants::USERAGENT);
+            $httpHeaders = array(
+              'Authorization' => $AuthorizationHeader,
+              'host'          => parse_url($requestUri, PHP_URL_HOST),
+              'user-agent' => CoreConstants::USERAGENT
+            );
+            // Log Request Body to a file
+            $this->RequestLogging->LogPlatformRequests($requestBody, $requestUri, $httpHeaders, true);
+
+            if ($requestBody && $this->RequestCompressor) {
+                $this->RequestCompressor->Compress($httpHeaders, $requestBody);
+            }
+
+            if ($this->ResponseCompressor) {
+                $this->ResponseCompressor->PrepareDecompress($httpHeaders);
+            }
         }
 
         $intuitResponse = $this->curlHttpClient->makeAPICall($requestUri, $HttpMethod, $httpHeaders,  $requestBody, null, false);
@@ -283,7 +297,7 @@ private function CallRestService($requestParameters, $requestBody, $oauthRequest
         $this->context->IppConfiguration->Logger->CustomLogger->Log(TraceLevel::Info, "Getting the response from service.");
 
         // Call the service and get response.
-        list($httpWebResponseCode, $httpWebResponseBody) = $request->GetResponse($requestParameters, $requestBody, $oauthRequestUri);
+        list($httpWebResponseCode, $httpWebResponseBody) = $request->sendRequest($requestParameters, $requestBody, $oauthRequestUri);
 
         $this->context->IppConfiguration->Logger->CustomLogger->Log(TraceLevel::Info, "Got the response from service.");
 

src/Core/ServiceContext.php

@@ -180,8 +180,7 @@ public static function ConfigureFromPassedArray(array $settings)
         $baseURL = $settings['baseUrl'];
         $checkedBaseURL = ServiceContext::checkAndAddBaseURLSlash($baseURL);
         $serviceType = CoreConstants::IntuitServicesTypeQBO;
-        //Set the default minor version to 4
-        $IppConfiguration = LocalConfigReader::ReadConfigurationFromParameters($OAuthConfig, $checkedBaseURL, CoreConstants::DEFAULT_LOGGINGLOCATION, "4");
+        $IppConfiguration = LocalConfigReader::ReadConfigurationFromParameters($OAuthConfig, $checkedBaseURL, CoreConstants::DEFAULT_LOGGINGLOCATION, CoreConstants::DEFAULT_SDK_MINOR_VERSION);
         $serviceContextInstance = new ServiceContext($QBORealmID, $serviceType, $OAuthConfig, $IppConfiguration);
         return $serviceContextInstance;
     }
@@ -210,7 +209,8 @@ public function getBaseURL()
             if ($this->serviceType === CoreConstants::IntuitServicesTypeQBO) {
                 $baseurl = $this->IppConfiguration->BaseUrl->Qbo . implode(CoreConstants::SLASH_CHAR, array(CoreConstants::VERSION)) . CoreConstants::SLASH_CHAR;
             }
-            else {
+            else if($this->serviceType === CoreConstants::IntuitServicesTypeIPP){
+                $this->IppConfiguration->BaseUrl->Ipp  =  CoreConstants::IPP_BASEURL;
                 $baseurl = $this->IppConfiguration->BaseUrl->Ipp;
             }
         } catch (\Exception $e) {

src/Data/IPPVendor.php

@@ -205,6 +205,21 @@ public function __construct($keyValInitializers=array(), $verbose=false)
      * @var float
      */
     public $Balance;
+
+    /**
+     * @Definition
+                                Product: ALL
+                                Description: The Bill Rate for that vendor.
+                                Filterable: QBW
+                                Sortable: QBW
+
+     * @xmlType element
+     * @xmlNamespace http://schema.intuit.com/finance/v3
+     * @xmlMinOccurs 0
+     * @xmlName BillRate
+     * @var float
+     */
+    public $BillRate;
     /**
      * @Definition Specifies the date of the Open Balance.
                                 Non QB-writable.

src/Facades/FacadeClassMapper.php

@@ -34,7 +34,7 @@ public static function IPPReferenceTypeNameEntity(){
                //IPPBill
                'PayerRef','VendorRef','APAccountRef',
                //IPPAccount
-               'ParentRef',
+               'ParentRef', 'VendorTypeRef','TermRef', 'PrefillAccountRef',
                //IPPCustomer
                'RootCustomerRef', 'CustomerTypeRef' ,'TaxGroupCodeRef', 'JobTypeRef',
                //IPPBillPayment

src/Facades/FacadeHelper.php

@@ -26,6 +26,13 @@ class FacadeHelper{
    public static function reflectArrayToObject($classNameOrKeyName, $data, $throwException = TRUE) {
      if(!isset($classNameOrKeyName)){ throw new \Exception("The Class Name or Key Name cannot be NULL when generating Objects.");}
      if(!isset($data) || empty($data)){ throw new \Exception("The passed data cannot be NULL.");}
+     if(is_object($data)){
+       if(!Facadehelper::checkIfTheObjectIsAnInstanceOfTheClass($classNameOrKeyName,$data)){
+         throw new \Exception("The assigned object is not an instance of required object:{" . $classNameOrKeyName . "}.");
+       }else{
+         return $data;
+       }
+     }
      //Get reflection class of FacadeHelper
      $trimedData = FacadeHelper::trimSpacesForArrayKeys($data);
      //Any key in the Ignored List will not be processed
@@ -66,22 +73,37 @@ public static function reflectArrayToObject($classNameOrKeyName, $data, $throwEx
                        // }as $val
                        $obj = FacadeHelper::reflectArrayToObject($key, $val, $throwException);
                        FacadeHelper::assignValue($currentObj, $key, $obj);
-                    }
-                    else if(FacadeHelper::isRecurrsiveArray($val)){
+                    } else if(FacadeHelper::isArrayOfObj($val)){
+                         // Array of LineItem object, for example
+                         foreach($val as $valobj){
+                            if(!Facadehelper::checkIfTheObjectIsAnInstanceOfTheClass($key,$valobj)){
+                              throw new \Exception("The assigned object is not an instance of required object:{" . $key . "}.");
+                            }
+                         }
+                         FacadeHelper::assignValue($currentObj, $key, $val);
+                    } else{
                         //The array is a recursive array. It can be an Line or LinkedTxn
                         //Example:
                         // Line": [{ ....}, {...}]
                         //For each element in the array, it is a line
+                        //or It can be an mix of lines and Objects
+                        //Line": [{ ....}, $obj1, {...}]
                         $list = array();
                         foreach ($val as $index => $element) {
-                            $obj = FacadeHelper::reflectArrayToObject($key, $element, $throwException);
-                            array_push($list, $obj);
-                        }
+                            if(is_object($element)){
+                              if(!Facadehelper::checkIfTheObjectIsAnInstanceOfTheClass($key,$element)){
+                                throw new \Exception("The assigned object is not an instance of required object:{" . $key . "}.");
+                              }
+                              array_push($list, $element);
+                            }else if(is_array($element)){
+                              $obj = FacadeHelper::reflectArrayToObject($key, $element, $throwException);
+                              array_push($list, $obj);
+                            }else{
+                              throw new \Exception("Format Error. Expect an element of an array or an object.");
+                            }
+                          }
                         FacadeHelper::assignValue($currentObj, $key, $list);
-                    }else{
-                        throw new \Exception("Internal Error. The Passed Array is neither associated array or recursive array.");
-                    }
-
+                     }
                 }else{
                     //Even the value is a key, the key can be an Enum type or a wrapper
                     if(FacadeHelper::isKeyInComplexList($key)){
@@ -95,9 +117,14 @@ public static function reflectArrayToObject($classNameOrKeyName, $data, $throwEx
                         $createdObj = FacadeHelper::getEnumType($enumTypeClassName, $val);
                         FacadeHelper::assignValue($currentObj, $key, $createdObj);
                     }
-                    //It is a simple type
                     else
                     {
+                      //If it is an object
+                      if(is_object($val)){
+                        if(!Facadehelper::checkIfTheObjectIsAnInstanceOfTheClass($key,$val)){
+                          throw new \Exception("The assigned object is not an instance of required object:{" . $key . "}.");
+                        }
+                      }
                       FacadeHelper::assignValue($currentObj, $key, $val);
                     }
                 }
@@ -176,6 +203,13 @@ public static function isKeyEnumType($key){
    public static function getEnumType($clazz, $val){
       if(!isset($val)) throw new \Exception("Passed param for Enum can't be null.");
       if(class_exists($clazz)){
+          if(is_object($val)){
+              if($val instanceof $clazz){
+                return $val;
+              }else{
+                throw new \Exception("The assigned obj to the enum class Type:{" . $clazz . "} is not matched.");
+              }
+          }
           $enumObj = new $clazz();
           //If $val is string
           if(is_array($val) && !empty($val)){
@@ -212,12 +246,20 @@ public static function getClassMethod($className, $methodName){
    /**
     * Construct an IPPReferenceType based on passed Array or String.
     * If it is passed as an array, handle it.
-    * If it is passed an a String. Construct an array and put the String on the value
+    * If it is passed as a String. Construct an array and put the String on the value
+    * If it is passed as an obj, compare it with IPPReferenceType and return the object
     * @param $data
-    *       It can either be an array or a String
+    *       It can either be an array or a String, or obj
     */
    public static function getIPPReferenceTypeBasedOnArray($data){
       $trimedDataArray = FacadeHelper::trimSpacesForArrayKeys($data);
+      if(is_object($trimedDataArray)){
+           if($trimedDataArray instanceof IPPReferenceType){
+               return $trimedDataArray;
+           }else{
+               throw new \Exception("The assigned obj to IPPReferenceType is not matched with IPPReferenceType.");
+           }
+      }
       //THe ReferenceDataType should only contain at most Two elements
       if(is_array($trimedDataArray)){
         if(sizeof($trimedDataArray) >= 3){
@@ -249,12 +291,20 @@ public static function getIPPReferenceTypeBasedOnArray($data){
   /**
    * If passed params is array, the first element of Array is used in IPPid.
    * If passed params is not an array, the the value is used for Ippid.
+   * If passed params is an obj, the the value is simply returned.
    * @param $data
    *       It can either be an array or a numeric representation
    */
   public static function getIPPId($data){
     //Convert an IPPId based on the Data
     if(!isset($data)) throw new \Exception("Passed param for IPPid can't be null");
+    if(is_object($data)){
+         if($data instanceof IPPid){
+             return $data;
+         }else{
+             throw new \Exception("The assigned obj to IPPid is not matched with IPPid.");
+         }
+    }
     if(is_array($data)){
        $firstElementValue = reset($data);
     }else if(is_numeric($data)){
@@ -305,11 +355,19 @@ public static function trimSpacesForArrayKeys($data){
        if(!isset($data) || empty($data)) return $data;
        if(is_array($data))
        {
-           $trimedKeys = array_map('trim', array_keys($data));
-           $trimedResult = array_combine($trimedKeys, $data);
-           return $trimedResult;
+           if(FacadeHelper::isArrayOfObj($data)){
+                return $data;
+           }else{
+             $trimedKeys = array_map('trim', array_keys($data));
+             $trimedResult = array_combine($trimedKeys, $data);
+             return $trimedResult;
+           }
        }else{
-           return trim($data);
+           if(is_object($data)){
+               return $data;
+           }else{
+             return trim($data);
+           }
        }
    }
 
@@ -379,4 +437,29 @@ private static function assignValue($targetObject, $key, $value){
      }
    }
 
+   private static function checkIfTheObjectIsAnInstanceOfTheClass($className, $object){
+      if($object instanceof $className){
+          return true;
+      }else{
+          $className = FacadeHelper::decorateKeyWithNameSpaceAndPrefix($className);
+          if($object instanceof $className){
+              return true;
+          }
+      }
+      return false;
+   }
+
+   private static function isArrayOfObj($data){
+       if(is_array($data)){
+           foreach($data as $dataMemeber){
+               if(!is_object($dataMemeber)){
+                   return false;
+               }
+           }
+           return true;
+       }
+
+       return false;
+   }
+
 }