Larium\Pay\Response

Complexity

Total Complexity

9

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

90%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	1
A	isSuccess()	0	4	1
A	getTransactionId()	0	4	1
A	getErrorCode()	0	4	1
A	getMessage()	0	4	1
A	getResponseCode()	0	4	1
A	getPayload()	0	4	1
A	getRawRequest()	0	4	1
A	getRawResponse()	0	4	1

<?php

namespace Larium\Pay;

class Response
{
    /**
     * @var bool
     */
    private $success;

    /**
     * @var string
     */
    private $message;

    /**
     * @var string
     */
    private $transactionId;

    /**
     * @var string|int
     */
    private $errorCode;

    /**
     * @var string
     */
    private $responseCode;

    /**
     * @var array
     */
    private $payload;

    /**
     * @var string
     */
    private $rawRequest;

    /**
     * @var string
     */
    private $rawResponse;

    /**
     * @param bool $success
     * @param string $message
     * @param string $transactionId
     * @param string $errorCode
     * @param string $responseCode
     * @param array $payload
     * @param string $rawRequest
     * @param string $rawResponse
     */
    public function __construct(
        $success,
        $message,
        $transactionId,
        $errorCode = '0',
        $responseCode = '00',
        array $payload = [],
        $rawResponse = null,
        $rawRequest = null
    ) {
        $this->success = $success;
        $this->message = $message;
        $this->transactionId = $transactionId;
        $this->errorCode = $errorCode;
        $this->responseCode = $responseCode;
        $this->payload = $payload;
        $this->rawRequest = $rawRequest;
        $this->rawResponse = $rawResponse;
    }

    /**
     * Returns whether response is success or not.
     *
     * @return bool
     */
    public function isSuccess()
    {
        return $this->success;
    }

    /**
     * Returns the unique transaction id from gateway.
     *
     * @return string
     */
    public function getTransactionId()
    {
        return $this->transactionId;
    }

    /**
     * Returns the error code from gateway, if exists.
     *
     * @return string|int
     */
    public function getErrorCode()
    {
        return $this->errorCode;
    }

    /**
     * Returns a human readable message for current transaction response,
     * either on success or failed transactions.
     *
     * @return string
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * Returns the credit card response code from gateway, if exits.
     *
     * This must be the {@link [https://en.wikipedia.org/wiki/ISO_8583#Response_code][ISO 8583]} ISO 8583 response code.
     *
     * @return string
     */
    public function getResponseCode()
    {
        return $this->responseCode;
    }

    /**
     * Returns any gateway response element as an associative array.
     * Array may contain nested elements.
     *
     * @return array
     */
    public function getPayload()
    {
        return $this->payload;
    }

    public function getRawRequest()
    {
        return $this->rawRequest;
    }

    public function getRawResponse()
    {
        return $this->rawResponse;
    }
}