Update to client v0.9.4

New function: getDatabaseVersion()
New function: getActiveEmployeeList()
New function: payInvoice()
New function: encryptString()

Author: Mplus Software

Mplusqapiclient.php

@@ -2,7 +2,7 @@
 
 class MplusQAPIclient
 {
-  const CLIENT_VERSION  = '0.9.2';
+  const CLIENT_VERSION  = '0.9.4';
 
   var $MIN_API_VERSION_MAJOR = 0;
   var $MIN_API_VERSION_MINOR = 9;
@@ -347,6 +347,20 @@ public function getApiVersion()
 
   //----------------------------------------------------------------------------
 
+  public function getDatabaseVersion()
+  {
+    try {
+      $result = $this->client->getDatabaseVersion();
+      return $this->parser->parseDatabaseVersion($result);
+    } catch (SoapFault $e) {
+      throw new MplusQAPIException('SoapFault occurred: '.$e->getMessage(), 0, $e);
+    } catch (Exception $e) {
+      throw new MplusQAPIException('Exception occurred: '.$e->getMessage(), 0, $e);
+    }
+  } // END getDatabaseVersion()
+
+  //----------------------------------------------------------------------------
+
   public function getAvailableTerminalList()
   {
     try {
@@ -392,6 +406,20 @@ public function getArticlesInLayout($terminal)
 
   //----------------------------------------------------------------------------
 
+  public function getActiveEmployeeList($terminal)
+  {
+    try {
+      $result = $this->client->getActiveEmployeeList($this->parser->convertTerminal($terminal));
+      return $this->parser->parseActiveEmployeeList($result);
+    } catch (SoapFault $e) {
+      throw new MplusQAPIException('SoapFault occurred: '.$e->getMessage(), 0, $e);
+    } catch (Exception $e) {
+      throw new MplusQAPIException('Exception occurred: '.$e->getMessage(), 0, $e);
+    }
+  } // END getActiveEmployeeList()
+
+  //----------------------------------------------------------------------------
+
   public function getVatGroupList()
   {
     try {
@@ -590,6 +618,20 @@ public function payOrder($orderId, $prepay, $paymentList)
 
   //----------------------------------------------------------------------------
 
+  public function payInvoice($invoiceId, $paymentList)
+  {
+    try {
+      $result = $this->client->payInvoice($this->parser->convertPayInvoiceRequest($invoiceId, $paymentList));
+      return $this->parser->parsePayInvoiceResult($result);
+    } catch (SoapFault $e) {
+      throw new MplusQAPIException('SoapFault occurred: '.$e->getMessage(), 0, $e);
+    } catch (Exception $e) {
+      throw new MplusQAPIException('Exception occurred: '.$e->getMessage(), 0, $e);
+    }
+  } // END payInvoice()
+
+  //----------------------------------------------------------------------------
+
   public function deliverOrder($orderId)
   {
     try {
@@ -716,20 +758,6 @@ public function findInvoice($extInvoiceId)
 
   //----------------------------------------------------------------------------
 
-  public function payInvoice($orderId, $prepay, $paymentList)
-  {
-    try {
-      $result = $this->client->payInvoice($this->parser->convertPayInvoiceRequest($orderId, $prepay, $paymentList));
-      return $this->parser->parsePayOrderResult($result);
-    } catch (SoapFault $e) {
-      throw new MplusQAPIException('SoapFault occurred: '.$e->getMessage(), 0, $e);
-    } catch (Exception $e) {
-      throw new MplusQAPIException('Exception occurred: '.$e->getMessage(), 0, $e);
-    }
-  } // END payInvoice()
-
-  //----------------------------------------------------------------------------
-
   public function getJournals($fromFinancialDate, $throughFinancialDate, $branchNumbers, $journalFilterList = array())
   {
     try {
@@ -1019,6 +1047,22 @@ public function sendMessage($branchNumber, $terminalNumber, $text)
     }
   } // END sendMessage()
 
+  //----------------------------------------------------------------------------
+
+  public function encryptString($plainString, $encryptionKey)
+  {
+    try {
+      $result = $this->client->encryptString($this->parser->convertEncryptStringRequest($plainString, $encryptionKey));
+      return $this->parser->parseEncryptStringResult($result);
+    } catch (SoapFault $e) {
+      throw new MplusQAPIException('SoapFault occurred: '.$e->getMessage(), 0, $e);
+    } catch (Exception $e) {
+      throw new MplusQAPIException('Exception occurred: '.$e->getMessage(), 0, $e);
+    }
+  } // END encryptString()
+
+  //----------------------------------------------------------------------------
+
 }
 
 //==============================================================================
@@ -1051,6 +1095,20 @@ public function parseApiVersion($soapApiVersion)
 
   //----------------------------------------------------------------------------
 
+  public function parseDatabaseVersion($soapdatabaseVersion)
+  {
+    $databaseVersion = false;
+    if (isset($soapdatabaseVersion->majorNumber)) {
+      $databaseVersion = objectToArray($soapdatabaseVersion);
+    }
+    else if (isset($soapdatabaseVersion['majorNumber'])) {
+      $databaseVersion = $soapdatabaseVersion;
+    }
+    return $databaseVersion;
+  } // END parseDatabaseVersion()
+
+  //----------------------------------------------------------------------------
+
   public function parseTerminalList($soapTerminalList) {
     if (isset($soapTerminalList->return)) {
       $soapTerminalList = $soapTerminalList->return;
@@ -1076,6 +1134,20 @@ public function parseTerminalList($soapTerminalList) {
 
   //----------------------------------------------------------------------------
 
+  public function parseActiveEmployeeList($soapActiveEmployeeList) 
+  {
+    if (isset($soapActiveEmployeeList->return)) {
+      $soapActiveEmployeeList = $soapActiveEmployeeList->return;
+    }
+    $active_employees = array();
+    foreach ($soapActiveEmployeeList as $soapActiveEmployee) {
+      $active_employees[] = objectToArray($soapActiveEmployee);
+    }
+    return $active_employees;
+  } // END parseActiveEmployeeList()
+
+  //----------------------------------------------------------------------------
+
   public function parseVatGroupList($soapVatGroupList) 
   {
     if (isset($soapVatGroupList->vatGroup)) {
@@ -1356,6 +1428,15 @@ public function parseOrderCategories($soapOrderCategories)
     }
     return false;
   } // END parseOrderCategories()
+  
+  //----------------------------------------------------------------------------
+
+  public function parsePayInvoiceResult($soapPayInvoiceResult) {
+    if (isset($soapPayInvoiceResult->result) and $soapPayInvoiceResult->result == 'PAY-INVOICE-RESULT-OK') {
+      return true;
+    }
+    return false;
+  } // END parsePayInvoiceResult()
 
   //----------------------------------------------------------------------------
 
@@ -1831,7 +1912,16 @@ public function parseSendMessageResult($soapSendMessageResult) {
       return strtolower($soapSendMessageResult->response) == 'true';
     }
     return false;
-  } // END parseSendMessageResult())
+  } // END parseSendMessageResult()
+
+//----------------------------------------------------------------------------
+
+  public function parseEncryptStringResult($soapEncryptStringResult) {
+    if (isset($soapEncryptStringResult->encryptedString)) {
+      return $soapEncryptStringResult->encryptedString;
+    }
+    return false;
+  } // END parseEncryptStringResult()
 
   //----------------------------------------------------------------------------
 
@@ -2170,6 +2260,18 @@ public function convertGetCashCountListRequest($fromFinancialDate, $throughFinan
 
   //----------------------------------------------------------------------------
 
+  public function convertPayInvoiceRequest($invoiceId, $paymentList)
+  {
+    $array = array('request'=>array(
+      'invoiceId'=>$invoiceId,
+      'paymentList'=>$this->convertPaymentList($paymentList),
+      ));
+    $object = arrayToObject($array);
+    return $object;
+  } // END convertPayInvoiceRequest()
+
+  //----------------------------------------------------------------------------
+
   public function convertPayOrderRequest($orderId, $prepay, $paymentList)
   {
     $array = array('request'=>array(
@@ -2282,6 +2384,16 @@ public function convertSendMessageRequest($branchNumber, $terminalNumber, $text)
 
   //----------------------------------------------------------------------------
 
+  public function convertEncryptStringRequest($plainString, $encryptionKey)
+  {
+    $object = arrayToObject(array('request'=>array(
+      'plainString'=>$plainString,
+      'encryptionKey'=>$encryptionKey)));
+    return $object;
+  } // END convertEncryptStringRequest()
+
+  //----------------------------------------------------------------------------
+
   public function convertExtOrderId($extOrderId) {
     return arrayToObject(array('extOrderId'=>$extOrderId));
   } // END convertExtOrderId()