File Message/RestResponse.php | Omnipay Fat Zebra / Paystream Gateway Module API Documentation

  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159:

<?php
/**
 * Fat Zebra REST Response
 */

namespace Omnipay\Fatzebra\Message;

use Omnipay\Common\Message\AbstractResponse;
use Omnipay\Common\Message\RequestInterface;

/**
 * Fat Zebra REST Response
 *
 * This is the response class for all Fat Zebra REST requests.
 *
 * @see \Omnipay\Fatzebra\FatzebraGateway
 */
class RestResponse extends AbstractResponse
{
    protected $statusCode;

    public function __construct(RequestInterface $request, $data, $statusCode = 200)
    {
        parent::__construct($request, $data);
        $this->statusCode = $statusCode;
    }

    public function isSuccessful()
    {
        // The Fat Zebra gateway returns errors in several possible different ways.
        if ($this->getCode() >= 400) {
            return false;
        }

        if (! empty($this->data['errors'])) {
            return false;
        }

        if (isset($this->data['response']['successful'])) {
            return $this->data['response']['successful'];
        }

        return true;
    }

    public function getTransactionReference()
    {
        // This is usually correct for payments, authorizations, etc
        if (! empty($this->data['response']) && ! empty($this->data['response']['id'])) {
            return $this->data['response']['id'];
        }

        // This is correct for tokenize
        if (! empty($this->data['response']) && ! empty($this->data['response']['token'])) {
            return $this->data['response']['token'];
        }

        // This is correct for create customer
        if (! empty($this->data['response']) && ! empty($this->data['response']['card_token'])) {
            return $this->data['response']['card_token'];
        }

        // This is correct for create plan
        if (! empty($this->data['response']) && ! empty($this->data['response']['plan'])) {
            return $this->data['response']['plan'];
        }

        return null;
    }

    /**
     * Get Card Reference
     *
     * This is used after createCard or createCustomer to get the credit card token to be
     * used in future transactions.
     *
     * @return string
     */
    public function getCardReference()
    {
        if (isset($this->data['response']['token'])) {
            return $this->data['response']['token'];
        }
        if (isset($this->data['response']['card_token'])) {
            return $this->data['response']['card_token'];
        }
    }

    /**
     * Get Customer Reference
     *
     * This is used after createCustomer to get the customer token to be
     * used in future transactions.
     *
     * @return string
     */
    public function getCustomerReference()
    {
        if (isset($this->data['response']['customer'])) {
            return $this->data['response']['customer'];
        }
        if (isset($this->data['response']['id'])) {
            return $this->data['response']['id'];
        }
    }

    /**
     * Get Plan Reference
     *
     * This is used after createPlan to get the plan token to be
     * used in future transactions.
     *
     * @return string
     */
    public function getPlanReference()
    {
        if (isset($this->data['response']['plan'])) {
            return $this->data['response']['plan'];
        }
    }

    /**
     * Get Subscription Reference
     *
     * This is used after createSubscription to get the subscription token to be
     * used in future transactions.
     *
     * @return string
     */
    public function getSubscriptionReference()
    {
        if (isset($this->data['response']['id'])) {
            return $this->data['response']['id'];
        }
    }

    public function getMessage()
    {
        if (isset($this->data['errors']) && count($this->data['errors']) > 0) {
            return implode(', ', $this->data['errors']);
        }

        if (isset($this->data['response']['message'])) {
            return $this->data['response']['message'];
        }

        return null;
    }

    public function getCode()
    {
        if (isset($this->data['response']['response_code'])) {
            return $this->data['response']['response_code'];
        }

        return $this->statusCode;
    }
}

Namespaces

Classes

Interfaces

Exceptions