fjbender / magento-2

Model/Api/Request/Authorization.php

Spacing +30 added lines, -30 removed lines

@@ -116,20 +116,20 @@ 
      */
     public function sendRequest(PayoneMethod $oPayment, Order $oOrder, $dAmount)
     {
-        $this->setOrderId($oOrder->getRealOrderId());// save order id to object for later use
+        $this->setOrderId($oOrder->getRealOrderId()); // save order id to object for later use
 
-        $this->addParameter('request', $oPayment->getAuthorizationMode());// add request type
-        $this->addParameter('mode', $oPayment->getOperationMode());// add mode ( live or test )
-        $this->addParameter('customerid', $oOrder->getCustomerId());// add customer id
-        $this->addParameter('aid', $this->shopHelper->getConfigParam('aid'));// add sub account id
-        $this->setAuthorizationParameters($oPayment, $oOrder, $dAmount);// set authorization params
+        $this->addParameter('request', $oPayment->getAuthorizationMode()); // add request type
+        $this->addParameter('mode', $oPayment->getOperationMode()); // add mode ( live or test )
+        $this->addParameter('customerid', $oOrder->getCustomerId()); // add customer id
+        $this->addParameter('aid', $this->shopHelper->getConfigParam('aid')); // add sub account id
+        $this->setAuthorizationParameters($oPayment, $oOrder, $dAmount); // set authorization params
         if ($oPayment->hasCustomConfig()) {// if payment type doesnt use the global settings
-            $this->addCustomParameters($oPayment);// add custom connection settings
+            $this->addCustomParameters($oPayment); // add custom connection settings
         }
 
-        $aResponse = $this->send();// send request to PAYONE Server API
+        $aResponse = $this->send(); // send request to PAYONE Server API
 
-        $this->apiHelper->addPayoneOrderData($oOrder, $this->getParameters(), $aResponse);// add payone data to order
+        $this->apiHelper->addPayoneOrderData($oOrder, $this->getParameters(), $aResponse); // add payone data to order
 
         return $aResponse;
     }
@@ -143,15 +143,15 @@ 
      */
     protected function setUserParameters(PayoneMethod $oPayment, Order $oOrder)
     {
-        $oQuote = $this->checkoutSession->getQuote();// get quote from session
-        $oCustomer = $oQuote->getCustomer();// get customer object from quote
+        $oQuote = $this->checkoutSession->getQuote(); // get quote from session
+        $oCustomer = $oQuote->getCustomer(); // get customer object from quote
         $this->addUserDataParameters($oOrder->getBillingAddress(), $oPayment, $oCustomer->getGender(), $oOrder->getCustomerEmail(), $oCustomer->getDob());
 
         $oShipping = $oOrder->getShippingAddress(); // get shipping address from order
         if ($oShipping) {// shipping address existing?
-            $this->addAddress($oShipping, true);// add regular shipping address
+            $this->addAddress($oShipping, true); // add regular shipping address
         } elseif ($oPayment->getCode() == PayoneConfig::METHOD_PAYPAL && $this->shopHelper->getConfigParam('bill_as_del_address', PayoneConfig::METHOD_PAYPAL, 'payone_payment')) {
-            $this->addAddress($oOrder->getBillingAddress(), true);// add billing address as shipping address
+            $this->addAddress($oOrder->getBillingAddress(), true); // add billing address as shipping address
         }
     }
 
@@ -165,22 +165,22 @@ 
      */
     protected function setAuthorizationParameters(PayoneMethod $oPayment, Order $oOrder, $dAmount)
     {
-        $sRefNr = $this->shopHelper->getConfigParam('ref_prefix').$oOrder->getIncrementId();// ref_prefix to prevent duplicate refnumbers in testing environments
-        $sRefNr = $oPayment->formatReferenceNumber($sRefNr);// some payment methods have refnr regulations
-        $this->addParameter('reference', $sRefNr);// add ref-nr to request
-        $this->addParameter('amount', number_format($dAmount, 2, '.', '')*100);// add price to request
-        $this->addParameter('currency', $oOrder->getOrderCurrencyCode());// add currency to request
+        $sRefNr = $this->shopHelper->getConfigParam('ref_prefix').$oOrder->getIncrementId(); // ref_prefix to prevent duplicate refnumbers in testing environments
+        $sRefNr = $oPayment->formatReferenceNumber($sRefNr); // some payment methods have refnr regulations
+        $this->addParameter('reference', $sRefNr); // add ref-nr to request
+        $this->addParameter('amount', number_format($dAmount, 2, '.', '') * 100); // add price to request
+        $this->addParameter('currency', $oOrder->getOrderCurrencyCode()); // add currency to request
         if ($this->shopHelper->getConfigParam('transmit_ip') == '1') {// is IP transmission needed?
-            $sIp = $this->environmentHelper->getRemoteIp();// get remote IP
+            $sIp = $this->environmentHelper->getRemoteIp(); // get remote IP
             if ($sIp != '') {// is IP not empty
-                $this->addParameter('ip', $sIp);// add IP address to the request
+                $this->addParameter('ip', $sIp); // add IP address to the request
             }
         }
-        $this->setUserParameters($oPayment, $oOrder);// add user data - addresses etc.
-        $this->setPaymentParameters($oPayment, $oOrder);// add payment specific parameters
+        $this->setUserParameters($oPayment, $oOrder); // add user data - addresses etc.
+        $this->setPaymentParameters($oPayment, $oOrder); // add payment specific parameters
 
         if ($this->apiHelper->isInvoiceDataNeeded($oPayment)) {//
-            $this->invoiceGenerator->addProductInfo($this, $oOrder);// add invoice parameters
+            $this->invoiceGenerator->addProductInfo($this, $oOrder); // add invoice parameters
         }
     }
 
@@ -193,15 +193,15 @@ 
      */
     protected function setPaymentParameters(PayoneMethod $oPayment, Order $oOrder)
     {
-        $this->addParameter('clearingtype', $oPayment->getClearingtype());// add payment type to request
+        $this->addParameter('clearingtype', $oPayment->getClearingtype()); // add payment type to request
         $sNarrativeText = $this->toolkitHelper->getNarrativeText($oOrder, $oPayment);
         if (!empty($sNarrativeText)) {// narrative text existing?
-            $this->addParameter('narrative_text', $sNarrativeText);// add narrative text parameter
+            $this->addParameter('narrative_text', $sNarrativeText); // add narrative text parameter
         }
-        $aPaymentParams = $oPayment->getPaymentSpecificParameters($oOrder);// get payment params specific to the payment type
-        $this->aParameters = array_merge($this->aParameters, $aPaymentParams);// merge payment params with other params
+        $aPaymentParams = $oPayment->getPaymentSpecificParameters($oOrder); // get payment params specific to the payment type
+        $this->aParameters = array_merge($this->aParameters, $aPaymentParams); // merge payment params with other params
         if ($oPayment->needsRedirectUrls() === true) {// does the used payment type need redirect urls?
-            $this->addRedirectUrls($oPayment);// add needed redirect urls
+            $this->addRedirectUrls($oPayment); // add needed redirect urls
         }
     }
 
@@ -214,9 +214,9 @@ 
     protected function addCustomParameters(PayoneMethod $oPayment)
     {
         foreach ($this->aCustomParamMap as $sParamName => $sConfigName) {// add all custom parameters
-            $sCustomConfig = $oPayment->getCustomConfigParam($sConfigName);// get custom config param
+            $sCustomConfig = $oPayment->getCustomConfigParam($sConfigName); // get custom config param
             if (!empty($sCustomConfig)) {// only add if the param is configured
-                $this->addParameter($sParamName, $sCustomConfig);// add custom param to request
+                $this->addParameter($sParamName, $sCustomConfig); // add custom param to request
             }
         }
     }

Model/Api/Request/Capture.php

Spacing +3 added lines, -3 removed lines

@@ -79,12 +79,12 @@
         $this->setOrderId($oOrder->getRealOrderId());
 
         $this->addParameter('request', 'capture'); // Request method
-        $this->addParameter('mode', $oPayment->getOperationMode());// PayOne Portal Operation Mode (live or test)
+        $this->addParameter('mode', $oPayment->getOperationMode()); // PayOne Portal Operation Mode (live or test)
         $this->addParameter('language', Locale::getPrimaryLanguage(Locale::getDefault()));
 
         // Total order sum in smallest currency unit
-        $this->addParameter('amount', number_format($dAmount, 2, '.', '')*100);
-        $this->addParameter('currency', $oOrder->getOrderCurrencyCode());// Currency
+        $this->addParameter('amount', number_format($dAmount, 2, '.', '') * 100);
+        $this->addParameter('currency', $oOrder->getOrderCurrencyCode()); // Currency
 
         $this->addParameter('txid', $iTxid); // PayOne Transaction ID
         $this->addParameter('sequencenumber', $this->databaseHelper->getSequenceNumber($iTxid));

Model/Api/Request/Genericpayment/PayPalExpress.php

Spacing +2 added lines, -2 removed lines

@@ -48,10 +48,10 @@
     {
         $this->addParameter('request', 'genericpayment');
         $this->addParameter('mode', $oPayment->getOperationMode());
-        $this->addParameter('aid', $this->shopHelper->getConfigParam('aid'));// ID of PayOne Sub-Account
+        $this->addParameter('aid', $this->shopHelper->getConfigParam('aid')); // ID of PayOne Sub-Account
         $this->addParameter('clearingtype', 'wlt');
         $this->addParameter('wallettype', 'PPE');
-        $this->addParameter('amount', number_format($oQuote->getGrandTotal(), 2, '.', '')*100);
+        $this->addParameter('amount', number_format($oQuote->getGrandTotal(), 2, '.', '') * 100);
         $this->addParameter('currency', $oQuote->getQuoteCurrencyCode());
         $this->addParameter('narrative_text', 'Test');
 

Model/Api/Request/AddressRequest.php

Spacing +2 added lines, -2 removed lines

@@ -77,7 +77,7 @@ 
     {
         $sPre = '';
         if ($blIsShipping === true) {
-            $sPre = 'shipping_';// add shipping prefix for shipping addresses
+            $sPre = 'shipping_'; // add shipping prefix for shipping addresses
         }
         $this->addParameter($sPre.'firstname', $oAddress->getFirstname());
         $this->addParameter($sPre.'lastname', $oAddress->getLastname());
@@ -86,7 +86,7 @@ 
         }
 
         $aStreet = $oAddress->getStreet();
-        $sStreet = is_array($aStreet) ? implode(' ', $aStreet) : $aStreet;// street may be an array
+        $sStreet = is_array($aStreet) ? implode(' ', $aStreet) : $aStreet; // street may be an array
         $this->addParameter($sPre.'street', trim($sStreet));
         $this->addParameter($sPre.'zip', $oAddress->getPostcode());
         $this->addParameter($sPre.'city', $oAddress->getCity());

Model/Api/Request/Managemandate.php

Spacing +2 added lines, -2 removed lines

@@ -77,8 +77,8 @@
         $oCustomer = $oQuote->getCustomer();
 
         $this->addParameter('request', 'managemandate'); // Request method
-        $this->addParameter('mode', $oPayment->getOperationMode());// PayOne Portal Operation Mode (live or test)
-        $this->addParameter('aid', $this->shopHelper->getConfigParam('aid'));// ID of PayOne Sub-Account
+        $this->addParameter('mode', $oPayment->getOperationMode()); // PayOne Portal Operation Mode (live or test)
+        $this->addParameter('aid', $this->shopHelper->getConfigParam('aid')); // ID of PayOne Sub-Account
         $this->addParameter('clearingtype', 'elv');
 
         $this->addParameter('customerid', $oCustomer->getId());

Model/Api/Request/Getfile.php

Spacing +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
                 'content' => http_build_query($this->aParameters),
             ],
         ];
-        $oContext  = stream_context_create($aOptions);
+        $oContext = stream_context_create($aOptions);
         $sMandate = file_get_contents($this->sApiUrl, false, $oContext);
         if ($sMandate !== false) {
             $sReturn = $sMandate;

Model/Api/Request/Base.php

Spacing +11 added lines, -11 removed lines

@@ -120,14 +120,14 @@ 
      */
     protected function initRequest()
     {
-        $this->addParameter('mid', $this->shopHelper->getConfigParam('mid'));// PayOne Merchant ID
-        $this->addParameter('portalid', $this->shopHelper->getConfigParam('portalid'));// PayOne Portal ID
-        $this->addParameter('key', md5($this->shopHelper->getConfigParam('key')));// PayOne Portal Key
-        $this->addParameter('encoding', $this->environmentHelper->getEncoding());// Encoding
-        $this->addParameter('integrator_name', 'Magento2');// Shop-system
-        $this->addParameter('integrator_version', $this->shopHelper->getMagentoVersion());// Shop version
-        $this->addParameter('solution_name', 'fatchip');// Company developing the module
-        $this->addParameter('solution_version', PayoneConfig::MODULE_VERSION);// Module version
+        $this->addParameter('mid', $this->shopHelper->getConfigParam('mid')); // PayOne Merchant ID
+        $this->addParameter('portalid', $this->shopHelper->getConfigParam('portalid')); // PayOne Portal ID
+        $this->addParameter('key', md5($this->shopHelper->getConfigParam('key'))); // PayOne Portal Key
+        $this->addParameter('encoding', $this->environmentHelper->getEncoding()); // Encoding
+        $this->addParameter('integrator_name', 'Magento2'); // Shop-system
+        $this->addParameter('integrator_version', $this->shopHelper->getMagentoVersion()); // Shop version
+        $this->addParameter('solution_name', 'fatchip'); // Company developing the module
+        $this->addParameter('solution_version', PayoneConfig::MODULE_VERSION); // Module version
     }
 
     /**
@@ -141,7 +141,7 @@ 
     public function addParameter($sKey, $sValue, $blAddAsNullIfEmpty = false)
     {
         if ($blAddAsNullIfEmpty === true && empty($sValue)) {
-            $sValue = 'NULL';// add value as string NULL - needed in certain situations
+            $sValue = 'NULL'; // add value as string NULL - needed in certain situations
         }
         $this->aParameters[$sKey] = $sValue;
     }
@@ -251,8 +251,8 @@ 
             return $sRequestUrl;
         }
 
-        $aResponse = $this->apiHelper->sendApiRequest($sRequestUrl);// send request to PAYONE
-        $this->apiLog->addApiLogEntry($this, $aResponse, $aResponse['status']);// log request to db
+        $aResponse = $this->apiHelper->sendApiRequest($sRequestUrl); // send request to PAYONE
+        $this->apiLog->addApiLogEntry($this, $aResponse, $aResponse['status']); // log request to db
         return $aResponse;
     }
 }

Model/Api/Invoice.php

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,20 +121,20 @@ 
      */
     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
-            $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;
     }
@@ -149,14 +149,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
             }
         }
     }
@@ -173,11 +173,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);
         }
     }
@@ -198,16 +198,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
         }
     }
 }

Model/Entities/TransactionStatus.php

Spacing +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
         $sRequest = $this->getData($sKey);
         if ($sRequest) {
             if (Toolkit::isUTF8($sRequest)) {
-                $sRequest = utf8_decode($sRequest);// needed for unserializing the array
+                $sRequest = utf8_decode($sRequest); // needed for unserializing the array
             }
             $aRequest = unserialize($sRequest);
             if (is_array($aRequest)) {