Omnipay\BillPay\Message\ResponseData\BaseDataTrait

Complexity

Total Complexity

9

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
	getData()	0	1	?
A	getCode()	0	6	2
A	getMessage()	0	6	2
A	getStatus()	0	6	2
A	getTransactionReference()	0	6	2
A	isSuccessful()	0	6	1

<?php

namespace Omnipay\BillPay\Message\ResponseData;

use SimpleXMLElement;

/**
 * Access base data in the response, internal usage only
 *
 * @author    Andreas Lange <andreas.lange@connox.de>
 * @copyright 2016, Connox GmbH
 * @license   MIT
 */
trait BaseDataTrait
{
    /**
     * Response code
     *
     * @return null|string A response code from the payment gateway
     */
    public function getCode()
    {
        $data = $this->getData();

        return (string)$data['error_code'] ? : null;
    }

    /**
     * @return SimpleXMLElement
     *
     * @codeCoverageIgnore
     */
    abstract public function getData();

    /**
     * Response Message
     *
     * @return null|string A response message from the payment gateway
     */
    public function getMessage()
    {
        $data = $this->getData();

        return (string)$data['customer_message'] ? : null;
    }

    /**
     * Status information of the response i.e. APPROVED
     *
     * @return null|string
     */
    public function getStatus()
    {
        $data = $this->getData();

        return (string)$data['status'] ? : null;
    }

    /**
     * Gateway Reference
     *
     * @return null|string A reference provided by the gateway to represent this transaction
     */
    public function getTransactionReference()
    {
        $data = $this->getData();

        return (string)$data['bptid'] ? : null;
    }

    /**
     * Is the response successful?
     *
     * @return bool
     */
    public function isSuccessful()
    {
        $data = $this->getData();

        return (string)$data['error_code'] === '0';
    }
}