Fix error issues reported by PhpSta level2 tool in Model folder

BoltApp · Dec 21, 2023 · 68e9af2 · 68e9af2
1 parent 79fff75
commit 68e9af2
Show file tree

Hide file tree

Showing 37 changed files with 153 additions and 123 deletions.
diff --git a/Api/CreateOrderInterface.php b/Api/CreateOrderInterface.php
@@ -33,7 +33,7 @@ interface CreateOrderInterface
      * @param mixed  $order - which contain token and cart nodes.
      * @param string $currency
      *
-     * @return void
+     * @return mixed
      */
     public function execute(
         $type = null,

diff --git a/Api/LegacyApiInterface.php b/Api/LegacyApiInterface.php
@@ -36,7 +36,7 @@ interface LegacyApiInterface
      * @param mixed $display_id
      * @param mixed $source_transaction_id
      * @param mixed $source_transaction_reference
-     * @return void
+     * @return mixed
      */
 
     public function manage(
@@ -61,7 +61,7 @@ public function manage(
      * @param mixed $remove_items
      * @param mixed $discount_codes_to_add
      * @param mixed $discount_codes_to_remove
-     * @return Bolt\Boltpay\Api\Data\UpdateCartResultInterface|mixed
+     * @return \Bolt\Boltpay\Api\Data\UpdateCartResultInterface|mixed
      */
     public function updateCart(
         $cart,
@@ -123,7 +123,7 @@ public function validateDiscount();
      * @param mixed  $order - which contain token and cart nodes.
      * @param string $currency
      *
-     * @return void
+     * @return mixed
      */
     public function createOrder($type = null, $order = null, $currency = null);
 }
diff --git a/Api/OrderManagementInterface.php b/Api/OrderManagementInterface.php
@@ -47,7 +47,7 @@ interface OrderManagementInterface
      * @param mixed $source_transaction_id
      * @param mixed $source_transaction_reference
      *
-     * @return void
+     * @return mixed
      */
     public function manage(
         $id = null,

diff --git a/Api/ShippingInterface.php b/Api/ShippingInterface.php
@@ -33,5 +33,14 @@ interface ShippingInterface
      * @param mixed $shipping_address shipping address
      * @return \Bolt\Boltpay\Api\Data\ShippingDataInterface
      */
-    public function execute($cart, $shipping_address);
+
+    /**
+     * @param $cart
+     * @param $shipping_address
+     * @param $shipping_option
+     * @param $ship_to_store_option
+     * @return \Bolt\Boltpay\Api\Data\ShippingDataInterface
+     */
+    public function execute($cart, $shipping_address, $shipping_option = null, $ship_to_store_option = null);
+
 }
diff --git a/Helper/Order.php b/Helper/Order.php
@@ -2426,10 +2426,11 @@ private function isFullyCaptured ($order, $transaction)
      * @param float $amount
      * @param bool $notify
      *
-     * @return bool
+     * @return Invoice|mixed
      * @throws \Exception
      * @throws LocalizedException
      */
+
     public function createOrderInvoice($order, $amount, $notify = false, $transactionId = null)
     {
         $currencyCode = $order->getOrderCurrencyCode();

diff --git a/Model/Api/CartManagement.php b/Model/Api/CartManagement.php
@@ -46,7 +46,7 @@ class CartManagement implements CartManagementInterface
     private $bugsnag;
 
     /**
-     * @var QuoteIdMaskFactory
+     * @var QuoteIdMaskFactory|mixed
      */
     private $quoteIdMaskFactory;
 
@@ -101,7 +101,7 @@ public function getMaskedId($cartId = '')
             if (!$maskedQuoteID) {
                 $maskedQuoteID = $this->generateMaskQuoteId($cartId);
                 if (!$maskedQuoteID) {
-                    throw new WebapiException(__('Masked quote ID does not found'), 0, WebapiException::HTTP_NOT_FOUND);
+                    throw new WebapiException(__('Masked quote ID does not found'), 0, WebapiException::HTTP_NOT_FOUND); // @phpstan-ignore-line
                 }
 
             }
@@ -112,7 +112,7 @@ public function getMaskedId($cartId = '')
             throw $e;
         } catch (Exception $e) {
             $this->bugsnag->notifyException($e);
-            throw new WebapiException(__($e->getMessage()), 0, WebapiException::HTTP_INTERNAL_ERROR);
+            throw new WebapiException(__($e->getMessage()), 0, WebapiException::HTTP_INTERNAL_ERROR); // @phpstan-ignore-line
         }
     }
 
@@ -143,7 +143,7 @@ public function update($cartId = null, $isActive = null)
         try {
             $quote = $this->cartHelper->getQuoteById($cartId);
             if (!$quote) {
-                throw new WebapiException(__('Quote does not found'), 0, WebapiException::HTTP_NOT_FOUND);
+                throw new WebapiException(__('Quote does not found'), 0, WebapiException::HTTP_NOT_FOUND); // @phpstan-ignore-line
             }
 
             $quote->setIsActive((bool)$isActive)->save();
@@ -152,7 +152,7 @@ public function update($cartId = null, $isActive = null)
             throw $e;
         } catch (Exception $e) {
             $this->bugsnag->notifyException($e);
-            throw new WebapiException(__($e->getMessage()), 0, WebapiException::HTTP_INTERNAL_ERROR);
+            throw new WebapiException(__($e->getMessage()), 0, WebapiException::HTTP_INTERNAL_ERROR); // @phpstan-ignore-line
         }
     }
 
@@ -178,7 +178,7 @@ public function getCartIdByMaskedId($maskedQuoteId)
             throw $e;
         } catch (Exception $e) {
             $this->bugsnag->notifyException($e);
-            throw new WebapiException(__($e->getMessage()), 0, WebapiException::HTTP_INTERNAL_ERROR);
+            throw new WebapiException(__($e->getMessage()), 0, WebapiException::HTTP_INTERNAL_ERROR); // @phpstan-ignore-line
         }
     }
 

diff --git a/Model/Api/CreateOrder.php b/Model/Api/CreateOrder.php
@@ -40,6 +40,7 @@
 use Magento\CatalogInventory\Helper\Data as CatalogInventoryData;
 use Bolt\Boltpay\Helper\Session as SessionHelper;
 use Bolt\Boltpay\Model\EventsForThirdPartyModules;
+use Magento\Sales\Model\Order;
 
 /**
  * Class CreateOrder
@@ -313,7 +314,7 @@ public function execute(
     /**
      * @param Quote $immutableQuote
      * @param \stdClass $transaction
-     * @return OrderModel
+     * @return Order
      * @throws \Exception
      * @throws BoltException
      */
@@ -471,7 +472,7 @@ public function validateQuoteData($quote, $transaction)
     /**
      * Validate minimum order amount
      *
-     * @param Quote $quote
+     * @param Quote|mixed $quote
      * @throws BoltException
      */
     public function validateMinimumAmount($quote)
@@ -511,7 +512,7 @@ private function arrayDiff($A, $B)
     }
 
     /**
-     * @param Quote  $quote
+     * @param Quote|mixed  $quote
      * @param               $transaction
      * @throws BoltException
      * @throws NoSuchEntityException
@@ -570,7 +571,7 @@ function ($item) {
     /**
      * Check if quote have errors.
      *
-     * @param QuoteItem $quoteItem
+     * @param QuoteItem|mixed $quoteItem
      * @return bool
      * @throws BoltException
      */
@@ -647,14 +648,17 @@ public function validateItemPrice($itemSku, $itemPrice, &$transactionItems)
                 return true;
             }
         }
-        $this->bugsnag->registerCallback(function ($report) use ($itemPrice, $transactionUnitPrice) {
-            $report->setMetaData([
-                'Pre Auth' => [
-                    'item.price' => $itemPrice,
-                    'transaction.unit_price' => $transactionUnitPrice,
-                ]
-            ]);
-        });
+        if (isset($transactionUnitPrice)) {
+            $this->bugsnag->registerCallback(function ($report) use ($itemPrice, $transactionUnitPrice) {
+                $report->setMetaData([
+                    'Pre Auth' => [
+                        'item.price' => $itemPrice,
+                        'transaction.unit_price' => $transactionUnitPrice,
+                    ]
+                ]);
+            });
+        }
+
         throw new BoltException(
             __('Price does not match. Item sku: ' . $itemSku),
             null,
@@ -693,7 +697,7 @@ public function validateTax($quote, $transaction)
     }
 
     /**
-     * @param Quote $quote
+     * @param Quote|mixed $quote
      * @param \stdClass $transaction
      * @return void
      * @throws BoltException

diff --git a/Model/Api/Data/AutomatedTesting/Address.php b/Model/Api/Data/AutomatedTesting/Address.php
@@ -204,7 +204,7 @@ public function setCountry($country)
     }
 
     /**
-     * @return array|mixed
+     * @return array
      */
     public function jsonSerialize(): array
     {

diff --git a/Model/Api/Data/AutomatedTesting/OrderItem.php b/Model/Api/Data/AutomatedTesting/OrderItem.php
@@ -250,7 +250,7 @@ public function setTotal($total)
     }
 
     /**
-     * @return array|mixed
+     * @return array
      */
     public function jsonSerialize(): array
     {

diff --git a/Model/Api/Data/DebugInfo.php b/Model/Api/Data/DebugInfo.php
@@ -132,7 +132,7 @@ public function getBoltConfigSettings()
     }
 
     /**
-     * @param \Bolt\Boltpay\Model\Api\Data\BoltConfigSetting[]
+     * @param \Bolt\Boltpay\Model\Api\Data\BoltConfigSetting[] $boltConfigSettings
      *
      * @return $this
      */
@@ -151,7 +151,7 @@ public function getOtherPluginVersions()
     }
 
     /**
-     * @param \Bolt\Boltpay\Model\Api\Data\PluginVersion[]
+     * @param \Bolt\Boltpay\Model\Api\Data\PluginVersion[] $otherPluginVersions
      *
      * @return $this
      */

diff --git a/Model/Api/Data/GetProductData.php b/Model/Api/Data/GetProductData.php
@@ -103,7 +103,7 @@ public function getParent()
      * Set parent info.
      *
      * @api
-     * @param ProductInventoryInfoInterface
+     * @param ProductInventoryInfoInterface $parent
      *
      * @return $this
      */

diff --git a/Model/Api/Data/ProductInventoryInfo.php b/Model/Api/Data/ProductInventoryInfo.php
@@ -27,7 +27,7 @@
 class ProductInventoryInfo implements ProductInventoryInfoInterface, \JsonSerializable
 {
     /**
-     * @var Bolt\Boltpay\Api\Data\ProductInterface
+     * @var \Bolt\Boltpay\Api\Data\ProductInterface
      */
     private $product;
 
@@ -41,7 +41,7 @@ class ProductInventoryInfo implements ProductInventoryInfoInterface, \JsonSerial
      * Get product info.
      *
      * @api
-     * @return Bolt\Boltpay\Api\Data\ProductInterface
+     * @return \Bolt\Boltpay\Api\Data\ProductInterface
      */
     public function getProduct()
     {
@@ -52,7 +52,7 @@ public function getProduct()
      * Set product info.
      *
      * @api
-     * @param Bolt\Boltpay\Api\Data\ProductInterface $product
+     * @param \Bolt\Boltpay\Api\Data\ProductInterface $product
      *
      * @return $this
      */
@@ -77,7 +77,7 @@ public function getStock()
      * Get stock info.
      *
      * @api
-     * @param \Magento\CatalogInventory\Api\Data\StockStatusInterface $stockItem
+     * @param \Magento\CatalogInventory\Api\Data\StockStatusInterface $stockStatus
      * @return $this
      */
     public function setStock($stockStatus)
@@ -86,8 +86,6 @@ public function setStock($stockStatus)
         return $this;
     }
 
-
-
     /**
      * @inheritDoc
      */

diff --git a/Model/Api/Data/ShipToStoreOption.php b/Model/Api/Data/ShipToStoreOption.php
@@ -154,7 +154,7 @@ public function getAddress()
      * Set store address.
      *
      * @api
-     * @param \Bolt\Boltpay\Api\Data\StoreAddressInterface $storeAddress
+     * @param \Bolt\Boltpay\Api\Data\StoreAddressInterface $address
      * @return $this
      */
     public function setAddress($address)

diff --git a/Model/Api/Data/ShippingData.php b/Model/Api/Data/ShippingData.php
@@ -52,7 +52,7 @@ public function getShippingOptions()
      * Set available shipping options.
      *
      * @api
-     * @param ShippingOptionInterface[]
+     * @param ShippingOptionInterface[] $shippingOptions
      * @return $this
      */
     public function setShippingOptions($shippingOptions)
@@ -76,7 +76,7 @@ public function getShipToStoreOptions()
      * Set available ship to store options.
      *
      * @api
-     * @param \Bolt\Boltpay\Api\Data\ShipToStoreOptionInterface[]
+     * @param \Bolt\Boltpay\Api\Data\ShipToStoreOptionInterface[] $shipToStoreOptions
      * @return $this
      */
     public function setShipToStoreOptions($shipToStoreOptions)

diff --git a/Model/Api/Data/ShippingOptions.php b/Model/Api/Data/ShippingOptions.php
@@ -54,7 +54,7 @@ public function getShippingOptions()
      * Set available shipping options.
      *
      * @api
-     * @param ShippingOptionInterface[]
+     * @param ShippingOptionInterface[] $shippingOptions
      *
      * @return $this
      */
@@ -80,7 +80,7 @@ public function getTaxResult()
      * Set available shipping options.
      *
      * @api
-     * @param ShippingTaxInterface
+     * @param ShippingTaxInterface $taxResult
      *
      * @return $this
      */

diff --git a/Model/Api/Data/TaxData.php b/Model/Api/Data/TaxData.php
@@ -59,7 +59,7 @@ public function getTaxResult()
      * Set available shipping options.
      *
      * @api
-     * @param TaxResultInterface
+     * @param TaxResultInterface $taxResult
      *
      * @return $this
      */
@@ -84,7 +84,7 @@ public function getShippingOption()
      * Set selected shipping option.
      *
      * @api
-     * @param ShippingOptionInterface
+     * @param ShippingOptionInterface $shippingOption
      * @return $this
      */
     public function setShippingOption($shippingOption)
@@ -108,7 +108,7 @@ public function getShipToStoreOption()
      * Set available ship to store option.
      *
      * @api
-     * @param \Bolt\Boltpay\Api\Data\ShipToStoreOptionInterface
+     * @param \Bolt\Boltpay\Api\Data\ShipToStoreOptionInterface $shipToStoreOption
      * @return $this
      */
     public function setShipToStoreOption($shipToStoreOption)

diff --git a/Model/Api/Data/UniversalWebhookResult.php b/Model/Api/Data/UniversalWebhookResult.php
@@ -27,7 +27,7 @@ class UniversalWebhookResult implements UniversalWebhookResultInterface
     private $status;
 
     /**
-     * @var []
+     * @var array
      */
     private $error;
 
@@ -61,7 +61,7 @@ public function setStatus($status)
      * Get error object
      *
      * @api
-     * @return []
+     * @return array
      */
 
     public function getError()
@@ -73,7 +73,7 @@ public function getError()
      * Set error object
      *
      * @api
-     * @param [] $error
+     * @param array $error
      * @return \Bolt\Boltpay\Api\Data\UniversalWebhookResultInterface
      */
     public function setError($error)