@@ -50,7 +50,7 @@ |
||
| 50 | 50 | * |
| 51 | 51 | * @param \Magento\Backend\Block\Template\Context $context |
| 52 | 52 | * @param \Magento\Framework\Data\Form\Element\Factory $elementFactory |
| 53 | - * @param \Payone\Core\Model\Source\TransactionStatus $klarnaCountries |
|
| 53 | + * @param \Payone\Core\Model\Source\KlarnaCountry $klarnaCountries |
|
| 54 | 54 | * @param array $data |
| 55 | 55 | * @return void |
| 56 | 56 | */ |
@@ -43,7 +43,6 @@ |
||
| 43 | 43 | * |
| 44 | 44 | * @param \Magento\Framework\App\Action\Context $context |
| 45 | 45 | * @param \Magento\Checkout\Model\Session $checkoutSession |
| 46 | - * @param \Magento\Framework\Url\Helper\Data $urlHelper |
|
| 47 | 46 | * @return void |
| 48 | 47 | */ |
| 49 | 48 | public function __construct( |
@@ -78,7 +78,7 @@ |
||
| 78 | 78 | /** |
| 79 | 79 | * Redirect to payment-provider or to success page |
| 80 | 80 | * |
| 81 | - * @return void |
|
| 81 | + * @return \Magento\Framework\Controller\Result\Redirect |
|
| 82 | 82 | */ |
| 83 | 83 | public function execute() |
| 84 | 84 | { |
@@ -142,6 +142,7 @@ |
||
| 142 | 142 | /** |
| 143 | 143 | * Generate the request url out of the params and die api url |
| 144 | 144 | * |
| 145 | + * @param string $sApiUrl |
|
| 145 | 146 | * @return string |
| 146 | 147 | */ |
| 147 | 148 | public function getRequestUrl($aParameters, $sApiUrl) |
@@ -129,9 +129,9 @@ discard block |
||
| 129 | 129 | foreach ($aResponse as $iLinenum => $sLine) {// go through line by line |
| 130 | 130 | $iPos = strpos($sLine, "="); |
| 131 | 131 | if ($iPos > 0) {// is a "=" as delimiter existing? |
| 132 | - $aOutput[substr($sLine, 0, $iPos)] = trim(substr($sLine, $iPos+1)); |
|
| 132 | + $aOutput[substr($sLine, 0, $iPos)] = trim(substr($sLine, $iPos + 1)); |
|
| 133 | 133 | } elseif (!empty($sLine)) {// is line not empty? |
| 134 | - $aOutput[$iLinenum] = $sLine;// add the line unedited |
|
| 134 | + $aOutput[$iLinenum] = $sLine; // add the line unedited |
|
| 135 | 135 | } |
| 136 | 136 | } |
| 137 | 137 | } |
@@ -171,11 +171,11 @@ discard block |
||
| 171 | 171 | public function addPayoneOrderData(SalesOrder $oOrder, $aRequest, $aResponse) |
| 172 | 172 | { |
| 173 | 173 | if (isset($aResponse['txid'])) {// txid existing? |
| 174 | - $oOrder->setPayoneTxid($aResponse['txid']);// add txid to order entity |
|
| 174 | + $oOrder->setPayoneTxid($aResponse['txid']); // add txid to order entity |
|
| 175 | 175 | } |
| 176 | - $oOrder->setPayoneRefnr($aRequest['reference']);// add refnr to order entity |
|
| 177 | - $oOrder->setPayoneAuthmode($aRequest['request']);// add authmode to order entity |
|
| 178 | - $oOrder->setPayoneMode($aRequest['mode']);// add payone mode to order entity |
|
| 176 | + $oOrder->setPayoneRefnr($aRequest['reference']); // add refnr to order entity |
|
| 177 | + $oOrder->setPayoneAuthmode($aRequest['request']); // add authmode to order entity |
|
| 178 | + $oOrder->setPayoneMode($aRequest['mode']); // add payone mode to order entity |
|
| 179 | 179 | if (isset($aRequest['mandate_identification'])) {// mandate id existing in request? |
| 180 | 180 | $oOrder->setPayoneMandateId($aRequest['mandate_identification']); |
| 181 | 181 | } elseif (isset($aResponse['mandate_identification'])) {// mandate id existing in response? |
@@ -191,11 +191,11 @@ discard block |
||
| 191 | 191 | */ |
| 192 | 192 | public function isInvoiceDataNeeded(PayoneMethod $oPayment) |
| 193 | 193 | { |
| 194 | - $sType = $this->getConfigParam('request_type');// auth or preauth? |
|
| 195 | - $blInvoiceEnabled = (bool)$this->getConfigParam('transmit_enabled', 'invoicing');// invoicing enabled? |
|
| 194 | + $sType = $this->getConfigParam('request_type'); // auth or preauth? |
|
| 195 | + $blInvoiceEnabled = (bool)$this->getConfigParam('transmit_enabled', 'invoicing'); // invoicing enabled? |
|
| 196 | 196 | if ($oPayment->needsProductInfo() || ($sType == PayoneConfig::REQUEST_TYPE_AUTHORIZATION && $blInvoiceEnabled)) { |
| 197 | - return true;// invoice data needed |
|
| 197 | + return true; // invoice data needed |
|
| 198 | 198 | } |
| 199 | - return false;// invoice data not needed |
|
| 199 | + return false; // invoice data not needed |
|
| 200 | 200 | } |
| 201 | 201 | } |
@@ -102,7 +102,6 @@ |
||
| 102 | 102 | /** |
| 103 | 103 | * Get the region object for the state and country given by PayPal |
| 104 | 104 | * |
| 105 | - * @param array $aResponse |
|
| 106 | 105 | * @return Region|bool |
| 107 | 106 | */ |
| 108 | 107 | public function getRegion($sCountry, $sState) |
@@ -95,6 +95,7 @@ discard block |
||
| 95 | 95 | /** |
| 96 | 96 | * Return the order related to the given TransactionStatus |
| 97 | 97 | * |
| 98 | + * @param string $sTxid |
|
| 98 | 99 | * @return SalesOrder|null |
| 99 | 100 | */ |
| 100 | 101 | public function getOrderByTxid($sTxid) |
@@ -160,7 +161,6 @@ discard block |
||
| 160 | 161 | * Fill billing and shipping addresses with the needed information from the response |
| 161 | 162 | * |
| 162 | 163 | * @param Address $oAddress |
| 163 | - * @param array $aResponse |
|
| 164 | 164 | * @return Address |
| 165 | 165 | */ |
| 166 | 166 | public function fillSingleAddress(Address $oAddress, $sFirstname, $sLastname, $sStreet, $sCity, $sZip, $sCountry, $sState) |
@@ -129,8 +129,8 @@ |
||
| 129 | 129 | } |
| 130 | 130 | |
| 131 | 131 | if (!empty($aRates)) {// more than one shipping method existing? |
| 132 | - ksort($aRates);// sort by price ascending |
|
| 133 | - return array_shift($aRates);// return the cheapest shipping-method |
|
| 132 | + ksort($aRates); // sort by price ascending |
|
| 133 | + return array_shift($aRates); // return the cheapest shipping-method |
|
| 134 | 134 | } |
| 135 | 135 | return false; |
| 136 | 136 | } |
@@ -181,7 +181,7 @@ |
||
| 181 | 181 | * |
| 182 | 182 | * @param double $dPrice price of any sort |
| 183 | 183 | * @param int $iDecimals number of digits behind the decimal point |
| 184 | - * @return double |
|
| 184 | + * @return string |
|
| 185 | 185 | */ |
| 186 | 186 | public function formatNumber($dPrice, $iDecimals = 2) |
| 187 | 187 | { |
@@ -135,7 +135,7 @@ discard block |
||
| 135 | 135 | if (!empty($sText)) { |
| 136 | 136 | $sText = str_replace(array_keys($aSubstitutionArray), array_values($aSubstitutionArray), $sText); |
| 137 | 137 | if ($iMaxLength !== false && strlen($sText) > $iMaxLength) { |
| 138 | - $sText = substr($sText, 0, $iMaxLength);// shorten text if too long |
|
| 138 | + $sText = substr($sText, 0, $iMaxLength); // shorten text if too long |
|
| 139 | 139 | } |
| 140 | 140 | return $sText; |
| 141 | 141 | } |
@@ -150,7 +150,7 @@ discard block |
||
| 150 | 150 | */ |
| 151 | 151 | public function getInvoiceAppendix(SalesOrder $oOrder) |
| 152 | 152 | { |
| 153 | - $sText = $this->getConfigParam('invoice_appendix', 'invoicing');// get invoice appendix from config |
|
| 153 | + $sText = $this->getConfigParam('invoice_appendix', 'invoicing'); // get invoice appendix from config |
|
| 154 | 154 | $aSubstitutionArray = [ |
| 155 | 155 | '{{order_increment_id}}' => $oOrder->getIncrementId(), |
| 156 | 156 | '{{customer_id}}' => $oOrder->getCustomerId(), |
@@ -168,7 +168,7 @@ discard block |
||
| 168 | 168 | */ |
| 169 | 169 | public function getNarrativeText(SalesOrder $oOrder, PayoneMethod $oPayment) |
| 170 | 170 | { |
| 171 | - $sText = $this->getConfigParam($oPayment->getCode(), 'text');// get narrative text for payment from config |
|
| 171 | + $sText = $this->getConfigParam($oPayment->getCode(), 'text'); // get narrative text for payment from config |
|
| 172 | 172 | $aSubstitutionArray = [ |
| 173 | 173 | '{{order_increment_id}}' => $oOrder->getIncrementId(), |
| 174 | 174 | ]; |
@@ -117,7 +117,7 @@ |
||
| 117 | 117 | * @param Order $oOrder Order object |
| 118 | 118 | * @param array $aPositions Is given with non-complete captures or debits |
| 119 | 119 | * @param bool $blDebit Is the call coming from a debit request |
| 120 | - * @return float |
|
| 120 | + * @return integer |
|
| 121 | 121 | */ |
| 122 | 122 | public function addProductInfo(Base $oRequest, Order $oOrder, $aPositions = false, $blDebit = false) |
| 123 | 123 | { |
@@ -100,14 +100,14 @@ discard block |
||
| 100 | 100 | */ |
| 101 | 101 | protected function addInvoicePosition($sId, $dPrice, $sItemType, $iAmount, $sDesc, $dVat) |
| 102 | 102 | { |
| 103 | - $this->oRequest->addParameter('id['.$this->iIndex.']', $sId);// add invoice item id |
|
| 104 | - $this->oRequest->addParameter('pr['.$this->iIndex.']', $this->toolkitHelper->formatNumber($dPrice) * 100);// expected in smallest unit of currency |
|
| 105 | - $this->oRequest->addParameter('it['.$this->iIndex.']', $sItemType);// add invoice item type |
|
| 106 | - $this->oRequest->addParameter('no['.$this->iIndex.']', $iAmount);// add invoice item amount |
|
| 107 | - $this->oRequest->addParameter('de['.$this->iIndex.']', $sDesc);// add invoice item description |
|
| 108 | - $this->oRequest->addParameter('va['.$this->iIndex.']', $this->toolkitHelper->formatNumber($dVat * 100, 0));// expected * 100 to also handle vats with decimals |
|
| 109 | - $this->dAmount += $dPrice * $iAmount;// needed for return of the main method |
|
| 110 | - $this->iIndex++;// increase index for next item |
|
| 103 | + $this->oRequest->addParameter('id['.$this->iIndex.']', $sId); // add invoice item id |
|
| 104 | + $this->oRequest->addParameter('pr['.$this->iIndex.']', $this->toolkitHelper->formatNumber($dPrice) * 100); // expected in smallest unit of currency |
|
| 105 | + $this->oRequest->addParameter('it['.$this->iIndex.']', $sItemType); // add invoice item type |
|
| 106 | + $this->oRequest->addParameter('no['.$this->iIndex.']', $iAmount); // add invoice item amount |
|
| 107 | + $this->oRequest->addParameter('de['.$this->iIndex.']', $sDesc); // add invoice item description |
|
| 108 | + $this->oRequest->addParameter('va['.$this->iIndex.']', $this->toolkitHelper->formatNumber($dVat * 100, 0)); // expected * 100 to also handle vats with decimals |
|
| 109 | + $this->dAmount += $dPrice * $iAmount; // needed for return of the main method |
|
| 110 | + $this->iIndex++; // increase index for next item |
|
| 111 | 111 | } |
| 112 | 112 | |
| 113 | 113 | /** |
@@ -121,22 +121,22 @@ discard block |
||
| 121 | 121 | */ |
| 122 | 122 | public function addProductInfo(Base $oRequest, Order $oOrder, $aPositions = false, $blDebit = false) |
| 123 | 123 | { |
| 124 | - $this->oRequest = $oRequest;// write request to property for manipulation of the object |
|
| 125 | - $sInvoiceAppendix = $this->toolkitHelper->getInvoiceAppendix($oOrder);// get invoice appendix |
|
| 124 | + $this->oRequest = $oRequest; // write request to property for manipulation of the object |
|
| 125 | + $sInvoiceAppendix = $this->toolkitHelper->getInvoiceAppendix($oOrder); // get invoice appendix |
|
| 126 | 126 | if (!empty($sInvoiceAppendix)) {// invoice appendix existing? |
| 127 | - $this->oRequest->addParameter('invoiceappendix', $sInvoiceAppendix);// add appendix to request |
|
| 127 | + $this->oRequest->addParameter('invoiceappendix', $sInvoiceAppendix); // add appendix to request |
|
| 128 | 128 | } |
| 129 | 129 | |
| 130 | 130 | foreach ($oOrder->getAllItems() as $oItem) {// add invoice items for all order items |
| 131 | 131 | if ($oItem->isDummy() === false) {// prevent variant-products of adding 2 items |
| 132 | - $this->addProductItem($oItem, $aPositions);// add product invoice params to request |
|
| 132 | + $this->addProductItem($oItem, $aPositions); // add product invoice params to request |
|
| 133 | 133 | } |
| 134 | 134 | } |
| 135 | 135 | |
| 136 | - $blFirstCapture = true;// Is first capture? |
|
| 136 | + $blFirstCapture = true; // Is first capture? |
|
| 137 | 137 | if ($aPositions === false || $blFirstCapture === true || $blDebit === true) { |
| 138 | - $this->addShippingItem($oOrder, $aPositions, $blDebit);// add shipping invoice params to request |
|
| 139 | - $this->addDiscountItem($oOrder, $aPositions, $blDebit);// add discount invoice params to request |
|
| 138 | + $this->addShippingItem($oOrder, $aPositions, $blDebit); // add shipping invoice params to request |
|
| 139 | + $this->addDiscountItem($oOrder, $aPositions, $blDebit); // add discount invoice params to request |
|
| 140 | 140 | } |
| 141 | 141 | return $this->dAmount; |
| 142 | 142 | } |
@@ -151,14 +151,14 @@ discard block |
||
| 151 | 151 | protected function addProductItem($oItem, $aPositions) |
| 152 | 152 | { |
| 153 | 153 | if ($aPositions === false || array_key_exists($oItem->getProductId(), $aPositions) !== false) {// full or single-invoice? |
| 154 | - $dItemAmount = $oItem->getQtyOrdered();// get ordered item amount |
|
| 154 | + $dItemAmount = $oItem->getQtyOrdered(); // get ordered item amount |
|
| 155 | 155 | if ($aPositions !== false && array_key_exists($oItem->getProductId(), $aPositions) !== false) {// product existing in single-invoice? |
| 156 | - $dItemAmount = $aPositions[$oItem->getProductId()]['amount'];// use amount from single-invoice |
|
| 156 | + $dItemAmount = $aPositions[$oItem->getProductId()]['amount']; // use amount from single-invoice |
|
| 157 | 157 | } |
| 158 | - $dBrutPrice = $oItem->getBasePrice() + ($oItem->getBaseTaxAmount() / $oItem->getQtyOrdered());// cals single item price |
|
| 158 | + $dBrutPrice = $oItem->getBasePrice() + ($oItem->getBaseTaxAmount() / $oItem->getQtyOrdered()); // cals single item price |
|
| 159 | 159 | $this->addInvoicePosition($oItem->getSku(), $dBrutPrice, 'goods', $dItemAmount, $oItem->getName(), $oItem->getTaxPercent()); |
| 160 | 160 | if ($this->dTax === false) {// is dTax not set yet? |
| 161 | - $this->dTax = $oItem->getTaxPercent();// set the tax for following entities which dont have the vat attached to it |
|
| 161 | + $this->dTax = $oItem->getTaxPercent(); // set the tax for following entities which dont have the vat attached to it |
|
| 162 | 162 | } |
| 163 | 163 | } |
| 164 | 164 | } |
@@ -175,11 +175,11 @@ discard block |
||
| 175 | 175 | { |
| 176 | 176 | // shipping costs existing or given for partial captures/debits? |
| 177 | 177 | if ($oOrder->getBaseShippingInclTax() != 0 && ($aPositions === false || ($blDebit === false || array_key_exists('oxdelcost', $aPositions) !== false))) { |
| 178 | - $sDelDesc = __('Surcharge').' '.__('Shipping Costs');// default description |
|
| 178 | + $sDelDesc = __('Surcharge').' '.__('Shipping Costs'); // default description |
|
| 179 | 179 | if ($oOrder->getBaseShippingInclTax() < 0) {// negative shipping cost |
| 180 | - $sDelDesc = __('Deduction').' '.__('Shipping Costs');// change item description to deduction |
|
| 180 | + $sDelDesc = __('Deduction').' '.__('Shipping Costs'); // change item description to deduction |
|
| 181 | 181 | } |
| 182 | - $sShippingSku = $this->toolkitHelper->getConfigParam('sku', 'costs', 'payone_misc');// get configured shipping SKU |
|
| 182 | + $sShippingSku = $this->toolkitHelper->getConfigParam('sku', 'costs', 'payone_misc'); // get configured shipping SKU |
|
| 183 | 183 | $this->addInvoicePosition($sShippingSku, $oOrder->getBaseShippingInclTax(), 'shipment', 1, $sDelDesc, $this->dTax); |
| 184 | 184 | } |
| 185 | 185 | } |
@@ -200,16 +200,16 @@ discard block |
||
| 200 | 200 | if ($aPositions === false) {// full invoice? |
| 201 | 201 | // The calculations broken down to single items of Magento2 are unprecise and the Payone API will send an error if |
| 202 | 202 | // the calculated positions don't match, so we compensate for rounding-problems here |
| 203 | - $dDiff = ($this->dAmount + $oOrder->getBaseDiscountAmount()) - $oOrder->getGrandTotal();// calc rounding discrepancy |
|
| 204 | - $dDiscount -= $dDiff;// subtract difference from discount |
|
| 203 | + $dDiff = ($this->dAmount + $oOrder->getBaseDiscountAmount()) - $oOrder->getGrandTotal(); // calc rounding discrepancy |
|
| 204 | + $dDiscount -= $dDiff; // subtract difference from discount |
|
| 205 | 205 | } |
| 206 | - $sDiscountSku = $this->toolkitHelper->getConfigParam('sku', 'discount', 'payone_misc');// get configured discount SKU |
|
| 207 | - $sDesc = (string)__('Discount');// default description |
|
| 206 | + $sDiscountSku = $this->toolkitHelper->getConfigParam('sku', 'discount', 'payone_misc'); // get configured discount SKU |
|
| 207 | + $sDesc = (string)__('Discount'); // default description |
|
| 208 | 208 | if ($oOrder->getCouponCode()) {// was a coupon code used? |
| 209 | - $sDiscountSku = $this->toolkitHelper->getConfigParam('sku', 'voucher', 'payone_misc');// get configured voucher SKU |
|
| 210 | - $sDesc = (string)__('Coupon').' - '.$oOrder->getCouponCode();// add counpon code to description |
|
| 209 | + $sDiscountSku = $this->toolkitHelper->getConfigParam('sku', 'voucher', 'payone_misc'); // get configured voucher SKU |
|
| 210 | + $sDesc = (string)__('Coupon').' - '.$oOrder->getCouponCode(); // add counpon code to description |
|
| 211 | 211 | } |
| 212 | - $this->addInvoicePosition($sDiscountSku, $dDiscount, 'voucher', 1, $sDesc, $this->dTax);// add invoice params to request |
|
| 212 | + $this->addInvoicePosition($sDiscountSku, $dDiscount, 'voucher', 1, $sDesc, $this->dTax); // add invoice params to request |
|
| 213 | 213 | } |
| 214 | 214 | } |
| 215 | 215 | } |
@@ -167,7 +167,6 @@ |
||
| 167 | 167 | /** |
| 168 | 168 | * Main method executing checksum check |
| 169 | 169 | * |
| 170 | - * @param bool $blOutput |
|
| 171 | 170 | * @return string |
| 172 | 171 | */ |
| 173 | 172 | public function checkChecksumXml() |
@@ -113,9 +113,9 @@ |
||
| 113 | 113 | } |
| 114 | 114 | if ($this->blGotModuleInfo === true) {// was composer.json readable? |
| 115 | 115 | $sRequestUrl = $this->sVersionCheckUrl.'?module='.$this->sModuleId.'&version='.$this->sModuleVersion; |
| 116 | - $sResponse = file_get_contents($sRequestUrl);// request info from fatchip checksum server |
|
| 116 | + $sResponse = file_get_contents($sRequestUrl); // request info from fatchip checksum server |
|
| 117 | 117 | if (!empty($sResponse)) {// Did the server answer? |
| 118 | - $aFiles = json_decode($sResponse);// Decode the json encoded answer from the server |
|
| 118 | + $aFiles = json_decode($sResponse); // Decode the json encoded answer from the server |
|
| 119 | 119 | } |
| 120 | 120 | } |
| 121 | 121 | return $aFiles; |