[ECP-9489] Implement PHPStan and fix relevant issues

.github/Makefile

@@ -129,3 +129,11 @@ setup-mftf:
 # Magento Functional Testing Framework
 mftf:
 	vendor/bin/mftf run:group --remove -- AdyenMagentoSuite || vendor/bin/mftf run:failed
+
+phpstan-install:
+	composer require --dev bitexpert/phpstan-magento
+	composer config allow-plugins.phpstan/extension-installer true
+	composer require --dev phpstan/extension-installer
+
+phpstan-run:
+	vendor/bin/phpstan analyse -c vendor/adyen/module-payment/phpstan.neon

.github/workflows/phpstan.yml

@@ -0,0 +1,62 @@
+name: PHPStan analysis workflow
+run-name: PHPStan analysis workflow
+
+on:
+  pull_request:
+    branches: [main]
+  pull_request_target:
+    branches: [main]
+
+jobs:
+  build:
+    if: (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository) || (github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.full_name != github.repository) || (github.event_name == 'workflow_dispatch')
+    environment: ${{ (github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.full_name != github.repository) && 'external' || 'internal' }}
+    strategy:
+      matrix:
+        php-version: ["8.3"]
+        magento-version: ["2.4.7-p2"]
+    runs-on:
+      group: larger-runners
+      labels: ubuntu-latest-8-cores
+    timeout-minutes: 25
+    env:
+      PHP_VERSION: ${{ matrix.php-version }}
+      MAGENTO_VERSION: ${{ matrix.magento-version }}
+      ADYEN_API_KEY: ${{secrets.ADYEN_API_KEY}}
+      ADYEN_CLIENT_KEY: ${{secrets.ADYEN_CLIENT_KEY}}
+      ADYEN_MERCHANT: ${{secrets.ADYEN_MERCHANT}}
+      ADMIN_USERNAME: ${{secrets.MAGENTO_ADMIN_USERNAME}}
+      ADMIN_PASSWORD: ${{secrets.MAGENTO_ADMIN_PASSWORD}}
+      DONATION_ACCOUNT: ${{secrets.DONATION_ACCOUNT}}
+      DEPLOY_SAMPLEDATA: 1
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.ref }}
+
+      - name: Install Magento
+        run: docker compose -f .github/docker-compose.yml run --rm web make magento
+
+      - name: Start web server in background
+        run: docker compose -f .github/docker-compose.yml up -d web
+
+      - name: Setup permissions
+        run: docker exec magento2-container make fs
+
+      - name: Check install
+        run: docker exec magento2-container make sys-check
+
+      - name: Install plugin
+        run: docker exec -u www-data magento2-container make plugin
+
+      - name: Install PHPStan dependencies
+        run: docker compose -f .github/docker-compose.yml run --rm web make phpstan-install
+
+      - name: Kill Cron Jobs
+        run: docker exec magento2-container /etc/init.d/cron stop
+
+      - name: Setup permissions
+        run: docker exec magento2-container make fs
+
+      - name: Run PHPStan
+        run: docker exec magento2-container make phpstan-run

Api/Repository/AdyenCreditmemoRepositoryInterface.php

@@ -0,0 +1,66 @@
+<?php
+/**
+ *
+ * Adyen Payment Module
+ *
+ * Copyright (c) 2025 Adyen N.V.
+ * This file is open source and available under the MIT license.
+ * See the LICENSE file for more info.
+ *
+ * Author: Adyen <[email protected]>
+ */
+
+namespace Adyen\Payment\Api\Repository;
+
+use Adyen\Payment\Api\Data\CreditmemoInterface;
+use Adyen\Payment\Api\Data\NotificationInterface;
+use Magento\Framework\Api\SearchCriteriaInterface;
+use Magento\Framework\Api\SearchResultsInterface;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
+
+interface AdyenCreditmemoRepositoryInterface
+{
+    /**
+     * Retrieve adyen_creditmemo entity by the ID.
+     *
+     * @param int $entityId
+     * @return CreditmemoInterface Adyen creditmemo entity
+     * @throws NoSuchEntityException
+     */
+    public function get(int $entityId): CreditmemoInterface;
+
+    /**
+     * Retrieve adyen_creditmemo entities by `adyen_order_payment_id`.
+     *
+     * @param int $adyenOrderPaymentId
+     * @return CreditmemoInterface[]|null
+     */
+    public function getByAdyenOrderPaymentId(int $adyenOrderPaymentId): ?array;
+
+    /**
+     * Retrieve adyen_creditmemo entity by the given notification using the `pspreference` column.
+     *
+     * @param NotificationInterface $notification
+     * @return CreditmemoInterface|null
+     */
+    public function getByRefundWebhook(NotificationInterface $notification): ?CreditmemoInterface;
+
+    /**
+     * Retrieve adyen_creditmemo entities which match a specified criteria.
+     *
+     * @param SearchCriteriaInterface $searchCriteria
+     * @return SearchResultsInterface
+     *
+     * @throws LocalizedException
+     */
+    public function getList(SearchCriteriaInterface $searchCriteria): SearchResultsInterface;
+
+    /**
+     * Performs persist operations for a specified adyen_creditmemo.
+     *
+     * @param CreditmemoInterface $entity adyen_creditmemo entity.
+     * @return CreditmemoInterface
+     */
+    public function save(CreditmemoInterface $entity): CreditmemoInterface;
+}

Api/Repository/AdyenInvoiceRepositoryInterface.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ *
+ * Adyen Payment Module
+ *
+ * Copyright (c) 2025 Adyen N.V.
+ * This file is open source and available under the MIT license.
+ * See the LICENSE file for more info.
+ *
+ * Author: Adyen <[email protected]>
+ */
+
+namespace Adyen\Payment\Api\Repository;
+
+use Adyen\Payment\Api\Data\InvoiceInterface;
+use Adyen\Payment\Api\Data\NotificationInterface;
+use Magento\Framework\Api\SearchCriteriaInterface;
+use Magento\Framework\Api\SearchResultsInterface;
+use Magento\Framework\Exception\LocalizedException;
+
+interface AdyenInvoiceRepositoryInterface
+{
+    /**
+     * Retrieve adyen_invoice entities which match a specified criteria.
+     *
+     * @param SearchCriteriaInterface $searchCriteria
+     * @return SearchResultsInterface
+     *
+     * @throws LocalizedException
+     */
+    public function getList(SearchCriteriaInterface $searchCriteria): SearchResultsInterface;
+
+    /**
+     * Retrieve adyen_invoice entity by the given notification using the `pspreference` column.
+     *
+     * @param NotificationInterface $notification
+     * @return InvoiceInterface|null
+     */
+    public function getByCaptureWebhook(NotificationInterface $notification): ?InvoiceInterface;
+
+    /**
+     * Retrieve adyen_invoice entities by `adyen_order_payment_id`.
+     *
+     * @param int $adyenOrderPaymentId
+     * @return InvoiceInterface[]|null
+     */
+    public function getByAdyenOrderPaymentId(int $adyenOrderPaymentId): ?array;
+
+    /**
+     * Performs persist operations for a specified adyen_invoice.
+     *
+     * @param InvoiceInterface $entity adyen_invoice entity
+     * @return InvoiceInterface
+     */
+    public function save(InvoiceInterface $entity): InvoiceInterface;
+}

Api/Repository/AdyenOrderPaymentRepositoryInterface.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ *
+ * Adyen Payment Module
+ *
+ * Copyright (c) 2025 Adyen N.V.
+ * This file is open source and available under the MIT license.
+ * See the LICENSE file for more info.
+ *
+ * Author: Adyen <[email protected]>
+ */
+
+namespace Adyen\Payment\Api\Repository;
+
+use Adyen\Payment\Api\Data\OrderPaymentInterface;
+use Magento\Framework\Api\SearchCriteriaInterface;
+use Magento\Framework\Api\SearchResultsInterface;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
+
+interface AdyenOrderPaymentRepositoryInterface
+{
+    const AVAILABLE_CAPTURE_STATUSES = [
+        OrderPaymentInterface::CAPTURE_STATUS_AUTO_CAPTURE,
+        OrderPaymentInterface::CAPTURE_STATUS_MANUAL_CAPTURE,
+        OrderPaymentInterface::CAPTURE_STATUS_PARTIAL_CAPTURE,
+        OrderPaymentInterface::CAPTURE_STATUS_NO_CAPTURE
+    ];
+
+    /**
+     * Retrieve adyen_order_payment entity by the ID.
+     *
+     * @param int $entityId
+     * @return OrderPaymentInterface Adyen order payment entity
+     * @throws NoSuchEntityException
+     */
+    public function get(int $entityId): OrderPaymentInterface;
+
+    /**
+     * Retrieve adyen_order_payment entities by `payment_id`.
+     *
+     * @param int $paymentId
+     * @param array $captureStatuses
+     * @return OrderPaymentInterface[]|null
+     */
+    public function getByPaymentId(int $paymentId, array $captureStatuses = []): ?array;
+
+    /**
+     * Retrieve adyen_order_payment entities which match a specified criteria.
+     *
+     * @param SearchCriteriaInterface $searchCriteria
+     * @return SearchResultsInterface
+     *
+     * @throws LocalizedException
+     */
+    public function getList(SearchCriteriaInterface $searchCriteria): SearchResultsInterface;
+}

Block/Checkout/Multishipping/Success.php

@@ -16,7 +16,6 @@
 use Adyen\Payment\Helper\Config;
 use Adyen\Payment\Helper\PaymentMethods;
 use Adyen\Payment\Helper\PaymentResponseHandler;
-use Adyen\Payment\Model\PaymentResponse;
 use Adyen\Payment\Model\ResourceModel\PaymentResponse\Collection;
 use Adyen\Payment\Model\Ui\AdyenCheckoutSuccessConfigProvider;
 use Magento\Framework\Api\SearchCriteriaBuilder;
@@ -28,53 +27,17 @@
 
 class Success extends \Magento\Multishipping\Block\Checkout\Success
 {
-    /**
-     * @var bool
-     */
-    private $isAdyenPayment;
-
-    /**
-     * @var PaymentResponse[]
-     */
-    private $paymentResponseEntities;
-
-    /**
-     * @var Data
-     */
-    private $adyenHelper;
-
-    /**
-     * @var StoreManagerInterface
-     */
-    private $storeManager;
-
-    /**
-     * @var SerializerInterface
-     */
-    private $serializerInterface;
-
-    /**
-     * @var AdyenCheckoutSuccessConfigProvider
-     */
-    private $configProvider;
-
-    /**
-     * @var OrderRepositoryInterface
-     */
-    private $orderRepository;
-
-    /**
-     * @var SearchCriteriaBuilder
-     */
-    private $searchCriteriaBuilder;
-
-
-    private $configHelper;
-
-    /**
-     * @var []
-     */
-    private $ordersInfo;
+    private bool $isAdyenPayment;
+    private ?array $paymentResponseEntities;
+    private ?array $ordersInfo;
+    private Data $adyenHelper;
+    private StoreManagerInterface $storeManager;
+    private SerializerInterface $serializerInterface;
+    private AdyenCheckoutSuccessConfigProvider $configProvider;
+    private OrderRepositoryInterface $orderRepository;
+    private SearchCriteriaBuilder $searchCriteriaBuilder;
+    private Config $configHelper;
+    private PaymentMethods $paymentMethodsHelper;
 
     public function __construct(
         Collection $paymentResponseCollection,

Block/Checkout/Success.php

@@ -22,22 +22,25 @@
 use Magento\Framework\Serialize\SerializerInterface;
 use Magento\Framework\View\Element\Template;
 use Magento\Framework\View\Element\Template\Context;
+use Magento\Sales\Api\OrderRepositoryInterface;
 use Magento\Sales\Model\Order;
-use Magento\Sales\Model\OrderFactory;
 use Magento\Store\Model\StoreManagerInterface;
+use Magento\Sales\Model\OrderFactory;
 
 class Success extends Template
 {
     protected $order;
     protected CheckoutSession $checkoutSession;
     protected CustomerSession $customerSession;
-    protected OrderFactory $orderFactory;
     protected Data $adyenHelper;
     protected StoreManagerInterface $storeManager;
     private Config $configHelper;
     private SerializerInterface $serializerInterface;
     private AdyenCheckoutSuccessConfigProvider $configProvider;
     private QuoteIdToMaskedQuoteId $quoteIdToMaskedQuoteId;
+    private OrderRepositoryInterface $orderRepository;
+    /** @deprecated This property has been deprecated and will be removed on V10. */
+    protected OrderFactory $orderFactory;
 
     public function __construct(
         Context $context,
@@ -50,8 +53,11 @@ public function __construct(
         AdyenCheckoutSuccessConfigProvider $configProvider,
         StoreManagerInterface $storeManager,
         SerializerInterface $serializerInterface,
+        OrderRepositoryInterface $orderRepository,
         array $data = []
     ) {
+        parent::__construct($context, $data);
+
         $this->checkoutSession = $checkoutSession;
         $this->customerSession = $customerSession;
         $this->quoteIdToMaskedQuoteId = $quoteIdToMaskedQuoteId;
@@ -61,7 +67,7 @@ public function __construct(
         $this->configProvider = $configProvider;
         $this->storeManager = $storeManager;
         $this->serializerInterface = $serializerInterface;
-        parent::__construct($context, $data);
+        $this->orderRepository = $orderRepository;
     }
 
     /**
@@ -164,7 +170,7 @@ public function getEnvironment()
     public function getOrder()
     {
         if ($this->order == null) {
-            $this->order = $this->orderFactory->create()->load($this->checkoutSession->getLastOrderId());
+            $this->order = $this->orderRepository->get($this->checkoutSession->getLastOrderId());
         }
         return $this->order;
     }