Omnipay\BillPay\Gateway

Complexity

Total Complexity

13

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	authorize()	0	4	1
A	capture()	0	4	1
A	getDefaultParameters()	0	9	1
A	getMerchantId()	0	4	1
A	getName()	0	4	1
A	getPortalId()	0	4	1
A	getSecurityKey()	0	4	1
A	invoiceCreated()	0	4	1
A	purchase()	0	4	1
A	refund()	0	4	1
A	setMerchantId()	0	6	1
A	setPortalId()	0	6	1
A	setSecurityKey()	0	6	1

<?php

namespace Omnipay\BillPay;

use Omnipay\BillPay\Message\AuthorizeRequest;
use Omnipay\BillPay\Message\CaptureRequest;
use Omnipay\BillPay\Message\InvoiceCreatedRequest;
use Omnipay\BillPay\Message\RefundRequest;
use Omnipay\Common\AbstractGateway;

/**
 * Class Gateway
 *
 * @author    Andreas Lange <andreas.lange@connox.de>
 * @copyright 2016, Connox GmbH
 * @license   MIT
 */
class Gateway extends AbstractGateway
{
    /**
     * Create a authorize request.
     *
     * @param array $parameters
     *
     * @return AuthorizeRequest
     */
    public function authorize(array $parameters = [])
    {
        return $this->createRequest(AuthorizeRequest::class, $parameters);
    }

    /**
     * @param array $parameters
     *
     * @return CaptureRequest
     */
    public function capture(array $parameters = [])
    {
        return $this->createRequest(CaptureRequest::class, $parameters);
    }

    /**
     * @return array
     */
    public function getDefaultParameters()
    {
        return [
            'merchantId' => '',
            'portalId' => '',
            'securityKey' => '',
            'testMode' => false,
        ];
    }

    /**
     * @return int Merchant ID
     */
    public function getMerchantId()
    {
        return $this->getParameter('merchantId');
    }

    /**
     * Get gateway display name
     * This can be used by carts to get the display name for each gateway.
     */
    public function getName()
    {
        return 'BillPay';
    }

    /**
     * @return int Portal ID
     */
    public function getPortalId()
    {
        return $this->getParameter('portalId');
    }

    /**
     * @return string MD5 hash of the security key generated for this portal. (generated and delivered by BillPay)
     */
    public function getSecurityKey()
    {
        return $this->getParameter('securityKey');
    }

    /**
     * Creates a invoice created request
     *
     * @param array $parameters
     *
     * @return InvoiceCreatedRequest
     */
    public function invoiceCreated(array $parameters = [])
    {
        return $this->createRequest(InvoiceCreatedRequest::class, $parameters);
    }

    /**
     * Create a purchase request (is alias of authorize)
     *
     * @param array $parameters
     *
     * @return AuthorizeRequest
     */
    public function purchase(array $parameters = [])
    {
        return $this->authorize($parameters)->setCaptureRequestNecessary(false);
    }

    /**
     * Create a refund request.
     *
     * @param array $parameters
     *
     * @return RefundRequest
     */
    public function refund(array $parameters = [])
    {
        return $this->createRequest(RefundRequest::class, $parameters);
    }

    /**
     * @param int $value Merchant ID
     *
     * @return Gateway
     */
    public function setMerchantId($value)
    {
        $this->setParameter('merchantId', $value);

        return $this;
    }

    /**
     * @param int $value Portal ID
     *
     * @return Gateway
     */
    public function setPortalId($value)
    {
        $this->setParameter('portalId', $value);

        return $this;
    }

    /**
     * @param string $value MD5 hash of the security key generated for this portal. (generated and delivered by BillPay)
     *
     * @return Gateway
     */
    public function setSecurityKey($value)
    {
        $this->setParameter('securityKey', $value);

        return $this;
    }
}