Omnipay\GoCardless\RedirectFlowGateway

Complexity

Total Complexity

14

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	completeCreateCard()	0	3	1
A	acceptNotification()	0	3	1
A	completePurchase()	0	11	3
A	purchase()	0	6	2
A	fetchEvent()	0	3	1
A	completeRedirectFlow()	0	3	1
A	createCard()	0	3	1
A	fetchPurchase()	0	3	1
A	getName()	0	3	1
A	redirectFlow()	0	3	1
A	acceptNotificationBatch()	0	3	1

<?php

namespace Omnipay\GoCardless;

use Omnipay\Common\Exception\RuntimeException;
use Omnipay\GoCardless\AbstractGateway;
use Omnipay\GoCardless\Message\FetchEventRequest;
use Omnipay\GoCardless\Message\FetchPurchaseRequest;
use Omnipay\GoCardless\Message\RedirectCompleteFlowRequest;
use Omnipay\GoCardless\Message\RedirectCompleteFlowResponse;
use Omnipay\GoCardless\Message\RedirectFlowRequest;
use Omnipay\GoCardless\Message\RedirectFlowResponse;
use Omnipay\GoCardless\Message\PurchaseRequest;
use Omnipay\GoCardless\Message\WebhookEventNotification;
use Omnipay\GoCardless\Message\WebhookNotification;

class RedirectFlowGateway extends AbstractGateway
{
    public function getName()
    {
        return 'GoCardless Redirect Flow';
    }

    // @todo note: might need to do this/add redirectFlowId accessors in order to get superclass unit tests working
    //             but can focus on those after getting the core tests done
    // public function getDefaultParameters()
    // {
    //     return parent::getDefaultParameters() + ['redirectFlowId' => null];
    // }

    // @todo authorize?
    // @todo completeAuthorize?

    /**
     * Begin Redirect flow
     *
     * Treats a mandate as a 'card'
     * 
     * @return RedirectFlowRequest
     */
    public function createCard(array $parameters = array())
    {
        return $this->redirectFlow($parameters);
    }

    /**
     * Complete Redirect flow
     *
     * Treats a mandate as a 'card'
     *
     * @return RedirectCompleteFlowRequest
     */
    public function completeCreateCard(array $parameters = array())
    {
        return $this->completeRedirectFlow($parameters);
    }

    /**
     * Begin Redirect Flow
     *
     * @return RedirectFlowRequest
     */
    public function redirectFlow(array $parameters = array())
    {
        return $this->createRequest(RedirectFlowRequest::class, $parameters);
    }

    /**
     * Complete Redirect Flow
     *
     * @return RedirectCompleteFlowRequest
     */
    public function completeRedirectFlow(array $parameters = array())
    {
        return $this->createRequest(RedirectCompleteFlowRequest::class, $parameters);
    }

    /**
     * Make a payment, or begin redirect flow if no mandate has been given
     *
     * @return RedirectFlowRequest|PurchaseRequest
     */
    public function purchase(array $parameters = array())
    {
        if (empty($parameters['mandateId'])) {
            return $this->redirectFlow($parameters);
        }
        return $this->createRequest(PurchaseRequest::class, $parameters);
    }

    /**
     * Extract the mandate from a completed redirect flow, then make a payment
     *
     * @return RedirectCompleteFlowReponse|PurchaseRequest

The type Omnipay\GoCardless\RedirectCompleteFlowReponse was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function completePurchase(array $parameters = array())
    {
        if (empty($parameters['mandateId'])) {
            $flowResponse = $this->completeRedirectFlow($parameters)->send();
            if (!$flowResponse->isSuccessful()) {
                // @todo change to use `->getRequest()` so it can be re-tried by calling application?
                return $flowResponse;

The expression return $flowResponse returns the type Omnipay\GoCardless\Message\RedirectCompleteFlowResponse which is incompatible with the documented return type Omnipay\GoCardless\Message\PurchaseRequest|Omnipay\GoCardless\RedirectCompleteFlowReponse.

            }
            $parameters['mandateId'] = $flowResponse->getMandateId();
        }
        return $this->purchase($parameters);

The expression return $this->purchase($parameters) also could return the type Omnipay\GoCardless\Message\RedirectFlowRequest which is incompatible with the documented return type Omnipay\GoCardless\Message\PurchaseRequest|Omnipay\GoCardless\RedirectCompleteFlowReponse.

    }

    /**
     * Parse webhook to validate/process pending transactions
     */
    public function acceptNotification(array $parameters = array())
    {
        return $this->createRequest(WebhookEventNotification::class, $parameters);
    }

    /**
     * Parse batch of webhooks to validate and provide events for {@see self::acceptNotification()}
     *
     * @todo do we both with parameters?
     */
    public function acceptNotificationBatch(array $parameters = array())
    {
        return $this->createRequest(WebhookNotification::class, $parameters);
    }

    /**
     * Fetch the details for a specific event (webhook notification)
     */
    public function fetchEvent(array $parameters = array())
    {
        return $this->createRequest(FetchEventRequest::class, $parameters);
    }

    /**
     * Fetch the details for a specific payment
     */
    public function fetchPurchase(array $parameters = array())
    {
        return $this->createRequest(FetchPurchaseRequest::class, $parameters);
    }
}