Some refactoring (defining baseData for an API type).

Author: judgej

src/Message/AbstractRequest.php

@@ -217,36 +217,6 @@ protected function hashString($string)
         throw new InvalidRequestException('Unknown hashing method.');
     }
 
-    /**
-     * Base data required for all Sewrver transactions.
-     */
-    protected function getBaseData()
-    {
-        $data = array();
-
-        $data['request'] = $this->request_code;
-
-        $data['mid'] = $this->getMerchantId();
-        $data['portalid'] = $this->getPortalId();
-
-        // Only md5 is used to encode the key for the Server API (no hashing is
-        // needed over the secure server-to-serever connection).
-        $data['key'] = md5($this->getPortalKey());
-
-        $data['api_version'] = AbstractShopGateway::API_VERSION;
-
-        $data['mode'] = (bool)$this->getTestMode() ? AbstractShopGateway::MODE_TEST : AbstractShopGateway::MODE_LIVE;
-
-        $data['encoding'] = $this->getEncoding();
-        $data['language'] = $this->getLanguage();
-
-        if ($this->getClearingType()) {
-            $data['clearingtype'] = $this->getClearingType();
-        }
-
-        return $data;
-    }
-
     /**
      * Collect the personal data to send to the Gateway.
      */

src/Message/ShopFrontendAuthorizeRequest.php

@@ -48,17 +48,15 @@ class ShopFrontendAuthorizeRequest extends ShopServerAuthorizeRequest
     protected $defaultItemId = '000000';
 
     /**
-     * The data is used to generate the POST form to send the user
-     * off to the PAYONE credit card form.
+     * Base data required for all Front End transactions.
      */
-    public function getData()
+    protected function getBaseData()
     {
-        // The base data.
-        $data = [
+        $data = array(
             'portalid' => $this->getPortalId(),
-            'aid' => $this->getSubAccountId(),
             'api_version' => AbstractShopGateway::API_VERSION,
-            'mode' => $this->getTestMode()
+            'aid' => $this->getSubAccountId(),
+            'mode' => (bool)$this->getTestMode()
                 ? AbstractShopGateway::MODE_TEST
                 : AbstractShopGateway::MODE_LIVE,
             'request' => $this->getRequestCode(),
@@ -67,7 +65,19 @@ public function getData()
             'amount' => $this->getAmountInteger(),
             'currency' => $this->getCurrency(),
             'encoding' => $this->getEncoding(),
-        ];
+        );
+
+        return $data;
+    }
+
+    /**
+     * The data is used to generate the POST form to send the user
+     * off to the PAYONE credit card form.
+     */
+    public function getData()
+    {
+        // The base data.
+        $data = $this->getBaseData();
 
         // Add basket contents next.
         // It seems that we MUST have at least one item in
@@ -111,7 +121,7 @@ public function getData()
             $data['invoiceid'] = $this->getInvoiceId();
         }
 
-        // The errorurl does NOT appear in the Frontend documentation, but does
+        // The errorurl does not appear in the Frontend documentation, but does
         // work and is implemented in other platform gateways.
 
         $data += $this->getDataUrl();
@@ -129,7 +139,6 @@ public function getData()
         }
 
         // Create the hash.
-        // All data collected so far must be "protected" by the hash.
         $data['hash'] = $this->hashArray($data);
 
         $data += $this->getDataPersonal();

src/Message/ShopServerAuthorizeRequest.php

@@ -6,24 +6,50 @@
 * PAYONE Shop Authorize Request
 */
 
+use Omnipay\Payone\AbstractShopGateway;
+
 class ShopServerAuthorizeRequest extends AbstractRequest
 {
     /**
      * The "request" parameter.
      */
     protected $request_code = 'preauthorization';
 
+    /**
+     * Base data required for all Server transactions.
+     */
+    protected function getBaseData()
+    {
+        $data = array(
+            'request' => $this->request_code,
+            'mid' => $this->getMerchantId(),
+            'portalid' => $this->getPortalId(),
+            'api_version' => AbstractShopGateway::API_VERSION,
+            // Only md5 is used to encode the key for the Server API (no hashing is
+            // needed over the secure server-to-server connection).
+            'key' => md5($this->getPortalKey()),
+            'mode' => (bool)$this->getTestMode()
+                ? AbstractShopGateway::MODE_TEST
+                : AbstractShopGateway::MODE_LIVE,
+            'encoding' => $this->getEncoding(),
+            'language' => $this->getLanguage(),
+        );
+
+        return $data;
+    }
+
     /**
      * Collect the data together to send to the Gateway.
      */
     public function getData()
     {
         $data = $this->getBaseData();
 
+        $data['clearingtype'] = $this->getClearingType();
+
         $data['aid'] = $this->getSubAccountId();
 
         // CC details
-
         $data += $this->getDataCard();
 
         // Merchant site reference.
@@ -36,7 +62,6 @@ public function getData()
         $data['currency'] = $this->getCurrency();
 
         // Personal data.
-
         $data += $this->getDataPersonal();
 
         if ($this->getParam() !== null) {
@@ -52,15 +77,12 @@ public function getData()
         }
 
         // URL orverrides.
-
         $data += $this->getDataUrl();
 
         // Shipping details.
-
         $data += $this->getDataShipping();
 
         // Items/Cart details
-
         $data += $this->getDataItems();
 
         return $data;

src/Message/ShopServerCardCheckRequest.php

@@ -6,7 +6,7 @@
 * PAYONE Shop Server Credit Card Check Request
 */
 
-class ShopServerCardCheckRequest extends AbstractRequest
+class ShopServerCardCheckRequest extends ShopServerAuthorizeRequest
 {
     /**
      * The "request" parameter.