hiqdev\yii2\merchant\controllers\PayController

Complexity

Total Complexity

22

Size/Duplication

Total Lines	169
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	9

Test Coverage

Coverage

0%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	actions()	0	8	1
A	getMerchantModule()	0	4	1
A	beforeAction()	0	8	2
A	actionCancel()	0	6	2
A	actionReturn()	0	11	2
A	actionCheckReturn()	0	20	4
A	actionNotify()	0	11	3
A	checkNotify()	0	4	1
A	actionProxyNotification()	0	4	1
A	actionDeposit()	0	16	4
A	renderDeposit()	0	14	1

<?php
/**
 * Yii2 extension for payment processing with Omnipay, Payum and more later.
 *
 * @link      https://github.com/hiqdev/yii2-merchant
 * @package   yii2-merchant
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\yii2\merchant\controllers;

use hiqdev\yii2\merchant\actions\RequestAction;
use hiqdev\yii2\merchant\models\DepositForm;
use hiqdev\yii2\merchant\models\DepositRequest;
use hiqdev\yii2\merchant\Module;
use hiqdev\yii2\merchant\transactions\Transaction;
use Yii;
use yii\base\InvalidConfigException;
use yii\web\BadRequestHttpException;
use yii\web\NotFoundHttpException;
use yii\web\Response;

class PayController extends \yii\web\Controller
{
    public function actions()
    {
        return array_merge(parent::actions(), [
            'request' => [
                'class' => RequestAction::class
            ]
        ]);
    }

    /**
     * @return Module|\yii\base\Module
     */
    public function getMerchantModule()
    {
        return $this->module;
    }

    /**
     * Disable CSRF validation for POST requests we receive from outside
     * {@inheritdoc}
     */
    public function beforeAction($action)
    {
        if (in_array($this->action->id, ['notify', 'return', 'cancel', 'proxy-notification'], true)) {
            Yii::$app->controller->enableCsrfValidation = false;
        }

        return parent::beforeAction($action);
    }

    /**
     * @return Response
     */
    public function actionCancel()
    {
        Yii::$app->session->addFlash('error', Yii::t('merchant', 'Payment failed or cancelled'));

        return $this->redirect($this->getMerchantModule()->previousUrl() ?: ['deposit']);
    }

    /**
     * @param string|null $transactionId
     *
     * Parameters are NOT required because some merchants may NOT send them, or send in POST or JSON bode.
     * The main purpose of these parameters is handling of special routes using UrlManager
     *
     * @return string
     * @throws InvalidConfigException
     */
    public function actionReturn(string $transactionId = null)
    {
        $transaction = $this->checkNotify($transactionId);
        if ($transaction === null) {
            return $this->actionCancel();
        }

        return $this->render('return', [
            'transactionId' => $transaction->getId(),
        ]);
    }

    /**
     * @param string $transactionId
     * @throws BadRequestHttpException
     * @return array
     */
    public function actionCheckReturn($transactionId)
    {
        Yii::$app->response->format = Response::FORMAT_JSON;
        $transaction = $this->getMerchantModule()->findTransaction($transactionId);

        if ($transaction === null) {
            throw new NotFoundHttpException('Transaction does not exist');
        }

        if ($transaction->getParameter('username') !== $this->getMerchantModule()->getUsername()) {
            throw new BadRequestHttpException('Access denied', 403);
        }

        return [
            'status' => $transaction->getSuccess(),
            'url'    => $transaction->isConfirmed()
                ? $transaction->getParameter('finishUrl')
                : $transaction->getParameter('cancelUrl'),
        ];
    }

    /**
     * Action handles notifications from payment systems,
     * processes them and report success or error for the payment system.
     *
     * @param string|null $transactionId Parameters is NOT required because some merchants may NOT send it, or send in POST or JSON body.
     * The main purpose of these parameters is handling of special routes using UrlManager
     *
     * @return null|string
     * @throws InvalidConfigException
     */
    public function actionNotify(string $transactionId = null)
    {
        $transaction = $this->checkNotify($transactionId);
        if ($transaction === null) {
            return 'Unknown transaction';
        }

        Yii::$app->response->format = Response::FORMAT_RAW;

        return $transaction->isConfirmed() ? 'OK' : $transaction->getParameter('error');
    }

    /**
     * Check notifications.
     * TODO: implement actual request check and proper handling.
     *
     * @param string|null $transactionId Parameters is NOT required because some merchants may NOT send it, or send in POST or JSON body.
     * The main purpose of these parameters is handling of special routes using UrlManager
     *
     * @return Transaction|null
     * @throws InvalidConfigException
     */
    public function checkNotify(string $transactionId = null): ?Transaction

The parameter $transactionId is not used and could be removed.

    {
        throw new InvalidConfigException('Method checkNotify must be implemented');
    }

    public function actionProxyNotification()
    {
        throw new InvalidConfigException('Method actionProxyNotification must be implemented');
    }

    public function actionDeposit()
    {
        $merchantModule = $this->getMerchantModule();

        $model   = Yii::createObject($merchantModule->depositFromClass);
        $request = Yii::$app->request;
        if ($model->load($request->isPost ? $request->post() : $request->get()) && $model->validate()) {
            return $this->renderDeposit($model);
        }

        return $this->render('deposit-form', [
            'model' => $model,
            'availableMerchants' => $this->getMerchantModule()->getPurchaseRequestCollection()->getItems(),
            'availableCurrencies' => $this->getMerchantModule()->getAvailableCurrenciesCollection()->getList(),
        ]);
    }

    /**
     * Renders depositing buttons for given request data.
     *
     * @param DepositForm $form request data
     * @return \yii\web\Response
     */
    public function renderDeposit($form)
    {
        $request = new DepositRequest();
        $request->amount = $form->amount;

The property $amount was declared of type string, but $form->amount is of type double. Maybe add a type cast?

        $request->currency = $form->currency;
        $request->finishUrl = $form->finishUrl;

        $requests = $this->getMerchantModule()->getPurchaseRequestCollection($request)->getItems();

        return $this->render('deposit', [
            'requests' => $requests,
            'depositForm' => $form
        ]);
    }
}