PAYONE-GmbH / magento-2

Helper/Api.php

Doc Comments +1 added lines

@@ -142,6 +142,7 @@
     /**
      * Generate the request url out of the params and die api url
      *
+     * @param string $sApiUrl
      * @return string
      */
     public function getRequestUrl($aParameters, $sApiUrl)

Spacing +11 added lines, -11 removed lines

@@ -95,7 +95,7 @@ 
         $aParsedRequestUrl = parse_url($sRequestUrl);
 
         if ($aParsedRequestUrl === false) {
-            throw new \Exception("Malformed URL " . $sRequestUrl);
+            throw new \Exception("Malformed URL ".$sRequestUrl);
         }
         return $aParsedRequestUrl;
     }
@@ -141,9 +141,9 @@ 
             foreach ($aResponse as $iLinenum => $sLine) {// go through line by line
                 $iPos = strpos($sLine, "=");
                 if ($iPos > 0) {// is a "=" as delimiter existing?
-                    $aOutput[substr($sLine, 0, $iPos)] = trim(substr($sLine, $iPos+1));
+                    $aOutput[substr($sLine, 0, $iPos)] = trim(substr($sLine, $iPos + 1));
                 } elseif (!empty($sLine)) {// is line not empty?
-                    $aOutput[$iLinenum] = $sLine;// add the line unedited
+                    $aOutput[$iLinenum] = $sLine; // add the line unedited
                 }
             }
         }
@@ -183,11 +183,11 @@ 
     public function addPayoneOrderData(SalesOrder $oOrder, $aRequest, $aResponse)
     {
         if (isset($aResponse['txid'])) {// txid existing?
-            $oOrder->setPayoneTxid($aResponse['txid']);// add txid to order entity
+            $oOrder->setPayoneTxid($aResponse['txid']); // add txid to order entity
         }
-        $oOrder->setPayoneRefnr($aRequest['reference']);// add refnr to order entity
-        $oOrder->setPayoneAuthmode($aRequest['request']);// add authmode to order entity
-        $oOrder->setPayoneMode($aRequest['mode']);// add payone mode to order entity
+        $oOrder->setPayoneRefnr($aRequest['reference']); // add refnr to order entity
+        $oOrder->setPayoneAuthmode($aRequest['request']); // add authmode to order entity
+        $oOrder->setPayoneMode($aRequest['mode']); // add payone mode to order entity
         if (isset($aRequest['mandate_identification'])) {// mandate id existing in request?
             $oOrder->setPayoneMandateId($aRequest['mandate_identification']);
         } elseif (isset($aResponse['mandate_identification'])) {// mandate id existing in response?
@@ -203,11 +203,11 @@ 
      */
     public function isInvoiceDataNeeded(PayoneMethod $oPayment)
     {
-        $sType = $this->getConfigParam('request_type');// auth or preauth?
-        $blInvoiceEnabled = (bool)$this->getConfigParam('transmit_enabled', 'invoicing');// invoicing enabled?
+        $sType = $this->getConfigParam('request_type'); // auth or preauth?
+        $blInvoiceEnabled = (bool)$this->getConfigParam('transmit_enabled', 'invoicing'); // invoicing enabled?
         if ($oPayment->needsProductInfo() || ($sType == PayoneConfig::REQUEST_TYPE_AUTHORIZATION && $blInvoiceEnabled)) {
-            return true;// invoice data needed
+            return true; // invoice data needed
         }
-        return false;// invoice data not needed
+        return false; // invoice data not needed
     }
 }

Helper/Customer.php

Doc Comments -1 removed lines

@@ -102,7 +102,6 @@
     /**
      * Get the region object for the state and country given by PayPal
      *
-     * @param  array $aResponse
      * @return Region|bool
      */
     public function getRegion($sCountry, $sState)

Helper/Order.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,6 +95,7 @@ 
     /**
      * Return the order related to the given TransactionStatus
      *
+     * @param string $sTxid
      * @return SalesOrder|null
      */
     public function getOrderByTxid($sTxid)
@@ -160,7 +161,6 @@ 
      * Fill billing and shipping addresses with the needed information from the response
      *
      * @param  Address $oAddress
-     * @param  array   $aResponse
      * @return Address
      */
     public function fillSingleAddress(Address $oAddress, $sFirstname, $sLastname, $sStreet, $sCity, $sZip, $sCountry, $sState)

Spacing +2 added lines, -2 removed lines

@@ -129,8 +129,8 @@
         }
 
         if (!empty($aRates)) {// more than one shipping method existing?
-            ksort($aRates);// sort by price ascending
-            return array_shift($aRates);// return the cheapest shipping-method
+            ksort($aRates); // sort by price ascending
+            return array_shift($aRates); // return the cheapest shipping-method
         }
         return false;
     }

Model/Api/Invoice.php

Doc Comments +1 added lines, -1 removed lines

@@ -117,7 +117,7 @@
      * @param  Order $oOrder     Order object
      * @param  array $aPositions Is given with non-complete captures or debits
      * @param  bool  $blDebit    Is the call coming from a debit request
-     * @return float
+     * @return integer
      */
     public function addProductInfo(Base $oRequest, Order $oOrder, $aPositions = false, $blDebit = false)
     {

Spacing +29 added lines, -29 removed lines

@@ -100,14 +100,14 @@ 
      */
     protected function addInvoicePosition($sId, $dPrice, $sItemType, $iAmount, $sDesc, $dVat)
     {
-        $this->oRequest->addParameter('id['.$this->iIndex.']', $sId);// add invoice item id
-        $this->oRequest->addParameter('pr['.$this->iIndex.']', $this->toolkitHelper->formatNumber($dPrice) * 100);// expected in smallest unit of currency
-        $this->oRequest->addParameter('it['.$this->iIndex.']', $sItemType);// add invoice item type
-        $this->oRequest->addParameter('no['.$this->iIndex.']', $iAmount);// add invoice item amount
-        $this->oRequest->addParameter('de['.$this->iIndex.']', $sDesc);// add invoice item description
-        $this->oRequest->addParameter('va['.$this->iIndex.']', $this->toolkitHelper->formatNumber($dVat * 100, 0));// expected * 100 to also handle vats with decimals
-        $this->dAmount += $dPrice * $iAmount;// needed for return of the main method
-        $this->iIndex++;// increase index for next item
+        $this->oRequest->addParameter('id['.$this->iIndex.']', $sId); // add invoice item id
+        $this->oRequest->addParameter('pr['.$this->iIndex.']', $this->toolkitHelper->formatNumber($dPrice) * 100); // expected in smallest unit of currency
+        $this->oRequest->addParameter('it['.$this->iIndex.']', $sItemType); // add invoice item type
+        $this->oRequest->addParameter('no['.$this->iIndex.']', $iAmount); // add invoice item amount
+        $this->oRequest->addParameter('de['.$this->iIndex.']', $sDesc); // add invoice item description
+        $this->oRequest->addParameter('va['.$this->iIndex.']', $this->toolkitHelper->formatNumber($dVat * 100, 0)); // expected * 100 to also handle vats with decimals
+        $this->dAmount += $dPrice * $iAmount; // needed for return of the main method
+        $this->iIndex++; // increase index for next item
     }
 
     /**
@@ -121,22 +121,22 @@ 
      */
     public function addProductInfo(Base $oRequest, Order $oOrder, $aPositions = false, $blDebit = false)
     {
-        $this->oRequest = $oRequest;// write request to property for manipulation of the object
-        $sInvoiceAppendix = $this->toolkitHelper->getInvoiceAppendix($oOrder);// get invoice appendix
+        $this->oRequest = $oRequest; // write request to property for manipulation of the object
+        $sInvoiceAppendix = $this->toolkitHelper->getInvoiceAppendix($oOrder); // get invoice appendix
         if (!empty($sInvoiceAppendix)) {// invoice appendix existing?
-            $this->oRequest->addParameter('invoiceappendix', $sInvoiceAppendix);// add appendix to request
+            $this->oRequest->addParameter('invoiceappendix', $sInvoiceAppendix); // add appendix to request
         }
 
         foreach ($oOrder->getAllItems() as $oItem) {// add invoice items for all order items
             if ($oItem->isDummy() === false) {// prevent variant-products of adding 2 items
-                $this->addProductItem($oItem, $aPositions);// add product invoice params to request
+                $this->addProductItem($oItem, $aPositions); // add product invoice params to request
             }
         }
 
-        $blFirstCapture = true;// Is first capture?
+        $blFirstCapture = true; // Is first capture?
         if ($aPositions === false || $blFirstCapture === true || $blDebit === true) {
-            $this->addShippingItem($oOrder, $aPositions, $blDebit);// add shipping invoice params to request
-            $this->addDiscountItem($oOrder, $aPositions, $blDebit);// add discount invoice params to request
+            $this->addShippingItem($oOrder, $aPositions, $blDebit); // add shipping invoice params to request
+            $this->addDiscountItem($oOrder, $aPositions, $blDebit); // add discount invoice params to request
         }
         return $this->dAmount;
     }
@@ -151,14 +151,14 @@ 
     protected function addProductItem($oItem, $aPositions)
     {
         if ($aPositions === false || array_key_exists($oItem->getProductId(), $aPositions) !== false) {// full or single-invoice?
-            $dItemAmount = $oItem->getQtyOrdered();// get ordered item amount
+            $dItemAmount = $oItem->getQtyOrdered(); // get ordered item amount
             if ($aPositions !== false && array_key_exists($oItem->getProductId(), $aPositions) !== false) {// product existing in single-invoice?
-                $dItemAmount = $aPositions[$oItem->getProductId()]['amount'];// use amount from single-invoice
+                $dItemAmount = $aPositions[$oItem->getProductId()]['amount']; // use amount from single-invoice
             }
-            $dBrutPrice = $oItem->getBasePrice() + ($oItem->getBaseTaxAmount() / $oItem->getQtyOrdered());// cals single item price
+            $dBrutPrice = $oItem->getBasePrice() + ($oItem->getBaseTaxAmount() / $oItem->getQtyOrdered()); // cals single item price
             $this->addInvoicePosition($oItem->getSku(), $dBrutPrice, 'goods', $dItemAmount, $oItem->getName(), $oItem->getTaxPercent());
             if ($this->dTax === false) {// is dTax not set yet?
-                $this->dTax = $oItem->getTaxPercent();// set the tax for following entities which dont have the vat attached to it
+                $this->dTax = $oItem->getTaxPercent(); // set the tax for following entities which dont have the vat attached to it
             }
         }
     }
@@ -175,11 +175,11 @@ 
     {
         // shipping costs existing or given for partial captures/debits?
         if ($oOrder->getBaseShippingInclTax() != 0 && ($aPositions === false || ($blDebit === false || array_key_exists('oxdelcost', $aPositions) !== false))) {
-            $sDelDesc = __('Surcharge').' '.__('Shipping Costs');// default description
+            $sDelDesc = __('Surcharge').' '.__('Shipping Costs'); // default description
             if ($oOrder->getBaseShippingInclTax() < 0) {// negative shipping cost
-                $sDelDesc = __('Deduction').' '.__('Shipping Costs');// change item description to deduction
+                $sDelDesc = __('Deduction').' '.__('Shipping Costs'); // change item description to deduction
             }
-            $sShippingSku = $this->toolkitHelper->getConfigParam('sku', 'costs', 'payone_misc');// get configured shipping SKU
+            $sShippingSku = $this->toolkitHelper->getConfigParam('sku', 'costs', 'payone_misc'); // get configured shipping SKU
             $this->addInvoicePosition($sShippingSku, $oOrder->getBaseShippingInclTax(), 'shipment', 1, $sDelDesc, $this->dTax);
         }
     }
@@ -200,16 +200,16 @@ 
             if ($aPositions === false) {// full invoice?
                 // The calculations broken down to single items of Magento2 are unprecise and the Payone API will send an error if
                 // the calculated positions don't match, so we compensate for rounding-problems here
-                $dDiff = ($this->dAmount + $oOrder->getBaseDiscountAmount()) - $oOrder->getGrandTotal();// calc rounding discrepancy
-                $dDiscount -= $dDiff;// subtract difference from discount
+                $dDiff = ($this->dAmount + $oOrder->getBaseDiscountAmount()) - $oOrder->getGrandTotal(); // calc rounding discrepancy
+                $dDiscount -= $dDiff; // subtract difference from discount
             }
-            $sDiscountSku = $this->toolkitHelper->getConfigParam('sku', 'discount', 'payone_misc');// get configured discount SKU
-            $sDesc = (string)__('Discount');// default description
+            $sDiscountSku = $this->toolkitHelper->getConfigParam('sku', 'discount', 'payone_misc'); // get configured discount SKU
+            $sDesc = (string)__('Discount'); // default description
             if ($oOrder->getCouponCode()) {// was a coupon code used?
-                $sDiscountSku = $this->toolkitHelper->getConfigParam('sku', 'voucher', 'payone_misc');// get configured voucher SKU
-                $sDesc = (string)__('Coupon').' - '.$oOrder->getCouponCode();// add counpon code to description
+                $sDiscountSku = $this->toolkitHelper->getConfigParam('sku', 'voucher', 'payone_misc'); // get configured voucher SKU
+                $sDesc = (string)__('Coupon').' - '.$oOrder->getCouponCode(); // add counpon code to description
             }
-            $this->addInvoicePosition($sDiscountSku, $dDiscount, 'voucher', 1, $sDesc, $this->dTax);// add invoice params to request
+            $this->addInvoicePosition($sDiscountSku, $dDiscount, 'voucher', 1, $sDesc, $this->dTax); // add invoice params to request
         }
     }
 }

Helper/ConfigExport.php

Spacing +1 added lines, -1 removed lines

@@ -177,6 +177,6 @@
         if ($this->getPaymentConfig('allowspecific', $sPaymentCode, $sStoreCode, true) == '1') {
             return $this->getPaymentConfig('specificcountry', $sPaymentCode, $sStoreCode, true);
         }
-        return '';// empty return value if all countries are available
+        return ''; // empty return value if all countries are available
     }
 }

Helper/Database.php

Spacing +1 added lines, -1 removed lines

@@ -188,6 +188,6 @@
         if ($iCount === null) {
             return 0;
         }
-        return $iCount+1;
+        return $iCount + 1;
     }
 }

Helper/HostedIframe.php

Spacing +4 added lines, -4 removed lines

@@ -156,15 +156,15 @@
      */
     public function getHostedFieldConfig()
     {
-        $aHostedParams = $this->getHostedParams();// get hosted params from config
+        $aHostedParams = $this->getHostedParams(); // get hosted params from config
 
         $aFieldConfig = [];
         if (!empty($aHostedParams)) {
-            $aFieldConfig['fields'] = $this->getFieldConfig();// generate config for all field types
+            $aFieldConfig['fields'] = $this->getFieldConfig(); // generate config for all field types
             $aFieldConfig['defaultStyle'] = $this->getDefaultStyles($aHostedParams);
             if ($aHostedParams['Errors_active'] == "true") {
-                $aFieldConfig['error'] = 'errorOutput';// area to display error-messages (optional)
-                $aFieldConfig['language'] = $aHostedParams['Errors_lang'];// has to be defined in javascript
+                $aFieldConfig['error'] = 'errorOutput'; // area to display error-messages (optional)
+                $aFieldConfig['language'] = $aHostedParams['Errors_lang']; // has to be defined in javascript
             }
         }
         return $aFieldConfig;

Helper/Toolkit.php

Spacing +3 added lines, -3 removed lines

@@ -135,7 +135,7 @@ 
         if (!empty($sText)) {
             $sText = str_replace(array_keys($aSubstitutionArray), array_values($aSubstitutionArray), $sText);
             if ($iMaxLength !== false && strlen($sText) > $iMaxLength) {
-                $sText = substr($sText, 0, $iMaxLength);// shorten text if too long
+                $sText = substr($sText, 0, $iMaxLength); // shorten text if too long
             }
             return $sText;
         }
@@ -150,7 +150,7 @@ 
      */
     public function getInvoiceAppendix(SalesOrder $oOrder)
     {
-        $sText = $this->getConfigParam('invoice_appendix', 'invoicing');// get invoice appendix from config
+        $sText = $this->getConfigParam('invoice_appendix', 'invoicing'); // get invoice appendix from config
         $aSubstitutionArray = [
             '{{order_increment_id}}' => $oOrder->getIncrementId(),
             '{{customer_id}}' => $oOrder->getCustomerId(),
@@ -168,7 +168,7 @@ 
      */
     public function getNarrativeText(SalesOrder $oOrder, PayoneMethod $oPayment)
     {
-        $sText = $this->getConfigParam($oPayment->getCode(), 'text');// get narrative text for payment from config
+        $sText = $this->getConfigParam($oPayment->getCode(), 'text'); // get narrative text for payment from config
         $aSubstitutionArray = [
             '{{order_increment_id}}' => $oOrder->getIncrementId(),
         ];

Model/Methods/BaseMethod.php

Spacing +17 added lines, -17 removed lines

@@ -235,7 +235,7 @@ 
      */
     public function getInstructions()
     {
-        return trim($this->getConfigData('instructions'));// return description text
+        return trim($this->getConfigData('instructions')); // return description text
     }
 
     /**
@@ -247,9 +247,9 @@ 
     {
         $sRequestType = $this->getAuthorizationMode();
         if ($sRequestType == PayoneConfig::REQUEST_TYPE_PREAUTHORIZATION) {
-            return AbstractMethod::ACTION_AUTHORIZE;// only create order
+            return AbstractMethod::ACTION_AUTHORIZE; // only create order
         } elseif ($sRequestType == PayoneConfig::REQUEST_TYPE_AUTHORIZATION) {
-            return AbstractMethod::ACTION_AUTHORIZE_CAPTURE;// create order and capture
+            return AbstractMethod::ACTION_AUTHORIZE_CAPTURE; // create order and capture
         }
     }
 
@@ -262,9 +262,9 @@ 
      */
     public function authorize(InfoInterface $payment, $amount)
     {
-        $oReturn = parent::authorize($payment, $amount);// execute Magento parent authorization
-        $this->sendPayoneAuthorization($payment, $amount);// send auth request to PAYONE
-        return $oReturn;// return magento parent auth value
+        $oReturn = parent::authorize($payment, $amount); // execute Magento parent authorization
+        $this->sendPayoneAuthorization($payment, $amount); // send auth request to PAYONE
+        return $oReturn; // return magento parent auth value
     }
 
     /**
@@ -276,9 +276,9 @@ 
      */
     public function refund(InfoInterface $payment, $amount)
     {
-        $oReturn = parent::refund($payment, $amount);// execute Magento parent refund
-        $this->sendPayoneDebit($payment, $amount);// send debit request to PAYONE
-        return $oReturn;// return magento parent refund value
+        $oReturn = parent::refund($payment, $amount); // execute Magento parent refund
+        $this->sendPayoneDebit($payment, $amount); // send debit request to PAYONE
+        return $oReturn; // return magento parent refund value
     }
 
     /**
@@ -290,13 +290,13 @@ 
      */
     public function capture(InfoInterface $payment, $amount)
     {
-        $oReturn = parent::capture($payment, $amount);// execute Magento parent capture
+        $oReturn = parent::capture($payment, $amount); // execute Magento parent capture
         if ($payment->getParentTransactionId()) {// does the order already have a transaction?
-            $this->sendPayoneCapture($payment, $amount);// is probably admin invoice capture
+            $this->sendPayoneCapture($payment, $amount); // is probably admin invoice capture
         } else {
-            $this->sendPayoneAuthorization($payment, $amount);// is probably frontend checkout capture
+            $this->sendPayoneAuthorization($payment, $amount); // is probably frontend checkout capture
         }
-        return $oReturn;// return magento parent capture value
+        return $oReturn; // return magento parent capture value
     }
 
     /**
@@ -311,12 +311,12 @@ 
         $iAllowSpecific = $this->shopHelper->getConfigParam('allowspecific');
         $aAvailableCountries = explode(',', $this->shopHelper->getConfigParam('specificcountry'));
         if ($this->hasCustomConfig()) {// check for non-global configuration
-            $iAllowSpecific = $this->getCustomConfigParam('allowspecific');// only specific countries allowed?
-            $aAvailableCountries = explode(',', $this->getCustomConfigParam('specificcountry'));// get allowed countries
+            $iAllowSpecific = $this->getCustomConfigParam('allowspecific'); // only specific countries allowed?
+            $aAvailableCountries = explode(',', $this->getCustomConfigParam('specificcountry')); // get allowed countries
         }
         if ($iAllowSpecific == 1 && !in_array($country, $aAvailableCountries)) {// only specific but not included
-            return false;// cant use for given country
+            return false; // cant use for given country
         }
-        return true;// can use for given country
+        return true; // can use for given country
     }
 }