wirecardBrasil / magento2

Controller/Webhooks/Refund.php

<?php
/**
 * Copyright © Wirecard Brasil. All rights reserved.
 *
 * @author    Bruno Elisei <brunoelisei@o2ti.com>
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Moip\Magento2\Controller\Webhooks;

use Exception;
use Magento\Framework\Api\SearchCriteriaBuilder;

The type Magento\Framework\Api\SearchCriteriaBuilder was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Framework\App\Action\Action;

The type Magento\Framework\App\Action\Action was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Framework\App\Action\Context;

The type Magento\Framework\App\Action\Context was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Framework\App\CsrfAwareActionInterface as Crsf;

The type Magento\Framework\App\CsrfAwareActionInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Framework\App\Request\InvalidRequestException;

The type Magento\Framework\App\Request\InvalidRequestException was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Framework\App\RequestInterface;

The type Magento\Framework\App\RequestInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Framework\Controller\Result\JsonFactory;

The type Magento\Framework\Controller\Result\JsonFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Framework\Serialize\Serializer\Json;

The type Magento\Framework\Serialize\Serializer\Json was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Payment\Model\Method\Logger;

The type Magento\Payment\Model\Method\Logger was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Sales\Api\CreditmemoRepositoryInterface;

The type Magento\Sales\Api\CreditmemoRepositoryInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Sales\Api\Data\OrderInterfaceFactory;

The type Magento\Sales\Api\Data\OrderInterfaceFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Sales\Model\Order\Creditmemo;

The type Magento\Sales\Model\Order\Creditmemo was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Sales\Model\Order\CreditmemoFactory;

The type Magento\Sales\Model\Order\CreditmemoFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Sales\Model\Order\Invoice;

The type Magento\Sales\Model\Order\Invoice was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Sales\Model\Service\CreditmemoService;

The type Magento\Sales\Model\Service\CreditmemoService was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Store\Model\StoreManagerInterface;

The type Magento\Store\Model\StoreManagerInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Moip\Magento2\Gateway\Config\Config;

/**
 * Class Refund - Receives communication for refunded payment.
 */
class Refund extends Action implements Crsf
{
    /**
     * createCsrfValidationException.
     *
     * @param RequestInterface $request
     *
     * @return null
     */
    public function createCsrfValidationException(RequestInterface $request): InvalidRequestException
    {
        if ($request) {

$request is of type Magento\Framework\App\RequestInterface, thus it always evaluated to true.

            return null;

The expression return null returns the type null which is incompatible with the type-hinted return Magento\Framework\App\Request\InvalidRequestException.

        }

The function implicitly returns null when the if condition on line 45 is false. This is incompatible with the type-hinted return Magento\Framework\App\Request\InvalidRequestException. Consider adding a return statement or allowing null as return value.

    }

    /**
     * validateForCsrf.
     *
     * @param RequestInterface $request
     *
     * @return bool true
     */
    public function validateForCsrf(RequestInterface $request): bool
    {
        if ($request) {

$request is of type Magento\Framework\App\RequestInterface, thus it always evaluated to true.

            return true;
        }

The function implicitly returns null when the if condition on line 59 is false. This is incompatible with the type-hinted return boolean. Consider adding a return statement or allowing null as return value.

    }

    /**
     * @var logger
     */
    protected $logger;

    /**
     * @var orderFactory

The type Moip\Magento2\Controller\Webhooks\orderFactory was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected $orderFactory;

    /**
     * @var resultJsonFactory

The type Moip\Magento2\Controller\Webhooks\resultJsonFactory was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected $resultJsonFactory;

    /**
     * @var storeManager

The type Moip\Magento2\Controller\Webhooks\storeManager was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected $storeManager;

    /**
     * @var Json
     */
    protected $json;

    /**
     * @var CreditmemoRepositoryInterface
     */
    private $creditmemoRepository;

    /**
     * @var schCriteriaBuilder

The type Moip\Magento2\Controller\Webhooks\schCriteriaBuilder was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected $schCriteriaBuilder;

    /**
     * @param Context               $context
     * @param logger                $logger
     * @param Config                $config
     * @param OrderInterfaceFactory $orderFactory
     * @param JsonFactory           $resultJsonFactory
     * @param Json                  $json
     */
    public function __construct(
        Context $context,
        Config $config,
        Logger $logger,
        OrderInterfaceFactory $orderFactory,
        CreditmemoFactory $creditmemoFactory,
        CreditmemoService $creditmemoService,
        Invoice $invoice,
        StoreManagerInterface $storeManager,
        JsonFactory $resultJsonFactory,
        Json $json,
        CreditmemoRepositoryInterface $creditmemoRepository,
        SearchCriteriaBuilder $schCriteriaBuilder
    ) {
        parent::__construct($context);
        $this->config = $config;

The property config does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->logger = $logger;
        $this->orderFactory = $orderFactory;
        $this->creditmemoFactory = $creditmemoFactory;

The property creditmemoFactory does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->creditmemoService = $creditmemoService;

The property creditmemoService does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->invoice = $invoice;

The property invoice does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->storeManager = $storeManager;
        $this->resultJsonFactory = $resultJsonFactory;
        $this->json = $json;
        $this->creditmemoRepository = $creditmemoRepository;
        $this->schCriteriaBuilder = $schCriteriaBuilder;
    }

    /**
     * Command Refund.
     *
     * @return json
     */
    public function execute()
    {
        if (!$this->getRequest()->isPost()) {
            $resultPage = $this->resultJsonFactory->create();
            $resultPage->setHttpResponseCode(404);

            return $resultPage;
        }

        $resultPage = $this->resultJsonFactory->create();
        $response = $this->getRequest()->getContent();
        $originalNotification = $this->json->unserialize($response);
        $authorization = $this->getRequest()->getHeader('Authorization');
        $storeId = $this->storeManager->getStore()->getId();
        $storeCaptureToken = $this->config->getMerchantGatewayRefundToken($storeId);

        if ($storeCaptureToken === $authorization) {
            $resource = $originalNotification['resource'];
            $extRefundId = $resource['refund']['id'];
            $extStatus = $resource['refund']['status'];

            $creditmemos = $this->getCreditMemoByTransactionId($extRefundId);
            if (count($creditmemos)) {
                foreach ($creditmemos as $creditmemo) {
                    if ($extStatus === 'REQUESTED') {
                        $creditmemo->setState(Creditmemo::STATE_OPEN);
                    } elseif ($extStatus === 'COMPLETED') {
                        $creditmemo->setState(Creditmemo::STATE_REFUNDED);
                    } elseif ($extStatus === 'FAILED') {
                        $creditmemo->setState(Creditmemo::STATE_CANCELED);
                    }

                    try {
                        $creditmemo->save();
                    } catch (\Exception $exc) {
                        $resultPage->setHttpResponseCode(500);
                        $resultPage->setJsonData(
                            $this->json->serialize([
                                'error'   => 400,
                                'message' => $exc->getMessage(),
                            ])
                        );
                    }

                    continue;
                }
            } else {
                $extOrderId = $resource['refund']['_links']['order']['title'];
                $creditmemo = $this->createNewCreditMemo($extOrderId, $extRefundId);
                if ($creditmemo) {

$creditmemo is of type Magento\Sales\Model\Order\Creditmemo, thus it always evaluated to true.

                    if ($extStatus === 'REQUESTED') {
                        $creditmemo->setState(Creditmemo::STATE_OPEN);
                    } elseif ($extStatus === 'COMPLETED') {
                        $creditmemo->setState(Creditmemo::STATE_REFUNDED);
                    } elseif ($extStatus === 'FAILED') {
                        $creditmemo->setState(Creditmemo::STATE_CANCELED);
                    }

                    try {
                        $this->creditmemoService->refund($creditmemo);
                    } catch (\Exception $exc) {
                        $resultPage->setHttpResponseCode(500);
                        $resultPage->setJsonData(
                            $this->json->serialize([
                                'error'   => 400,
                                'message' => $exc->getMessage(),
                            ])
                        );
                    }
                } else {
                    return $resultPage->setJsonData(
                        $this->json->serialize([
                            'error'   => 404,
                            'message' => 'The transaction could not be refund',
                        ])
                    );
                }
            }

            return $resultPage->setJsonData(
                $this->json->serialize([
                    'success'    => 1,
                    'extOrderId' => $extRefundId,
                    'state'      => $creditmemo->getState(),

The variable $creditmemo does not seem to be defined for all execution paths leading up to this point.

                ])
            );
        }

        $resultPage->setHttpResponseCode(401);

        return $resultPage;
    }

    /**
     * Get Creditmemo.
     *
     * @params $extOrderId
     *
     * @return creditmemo
     */
    public function getCreditMemoByTransactionId(string $transactionId)
    {
        $searchCriteria = $this->schCriteriaBuilder
            ->addFilter('transaction_id', $transactionId)->create();

        try {
            $creditmemos = $this->creditmemoRepository->getList($searchCriteria);
            $creditmemoRecords = $creditmemos->getItems();
        } catch (Exception $exception) {
            $this->logger->critical($exception->getMessage());
            $creditmemoRecords = null;
        }

        return $creditmemoRecords;
    }

    /**
     * Create new creditmemo.
     *
     * @params $extOrderId
     * @parmas $extRefundId
     *
     * @return creditmemo
     */
    public function createNewCreditMemo(string $extOrderId, string $extRefundId)
    {
        $order = $this->orderFactory->create()->load($extOrderId, 'ext_order_id');
        $creditmemo = null;

        $payment = $order->getPayment();
        $invoices = $order->getInvoiceCollection();

        if ($invoices) {
            foreach ($invoices as $invoiceLoad) {
                $invoiceincrementid = $invoiceLoad->getIncrementId();
            }
            $invoiceobj = $this->invoice->loadByIncrementId($invoiceincrementid);

The variable $invoiceincrementid seems to be defined by a foreach iteration on line 273. Are you sure the iterator is never empty, otherwise this variable is not defined?

            $creditmemo = $this->creditmemoFactory->createByOrder($order);
            $payment->setTransactionId($extRefundId);
            $creditmemo->setInvoice($invoiceobj);
        }

        return $creditmemo;
    }
}