Class AbstractResponse

Abstract Response

This abstract class implements ResponseInterface and defines a basic set of functions that all Omnipay Requests are intended to include.

Objects of this class or a subclass are usually created in the Request object (subclass of AbstractRequest) as the return parameters from the send() function.

Example -- validating and sending a request:

$myResponse = $myRequest->send();
  // now do something with the $myResponse object, test for success, etc.

Omnipay\Common\Message\AbstractResponse implements Omnipay\Common\Message\ResponseInterface

Direct known subclasses

Omnipay\Dummy\Message\Response, Omnipay\VivaPayments\Message\RestResponse

Indirect known subclasses

Omnipay\VivaPayments\Message\RedirectResponse

Abstract
Namespace: Omnipay\Common\Message
See: Omnipay\Common\Message\ResponseInterface
Located at Common/Message/AbstractResponse.php

Methods summary
`public`	# `__construct( Omnipay\Common\Message\RequestInterface $request, mixed $data )` Constructor Constructor Parameters `$request` the initiating request. `$data`
`public Omnipay\Common\Message\RequestInterface`	# `getRequest( )` Get the initiating request object. Get the initiating request object. Returns `Omnipay\Common\Message\RequestInterface` Implementation of `Omnipay\Common\Message\ResponseInterface::getRequest()`
`public boolean`	# `isPending( )` Is the response successful? Is the response successful? Returns boolean
`public boolean`	# `isRedirect( )` Does the response require a redirect? Does the response require a redirect? Returns boolean Implementation of `Omnipay\Common\Message\ResponseInterface::isRedirect()`
`public boolean`	# `isTransparentRedirect( )` Is the response a transparent redirect? Is the response a transparent redirect? Returns boolean
`public boolean`	# `isCancelled( )` Is the transaction cancelled by the user? Is the transaction cancelled by the user? Returns boolean Implementation of `Omnipay\Common\Message\ResponseInterface::isCancelled()`
`public mixed`	# `getData( )` Get the response data. Get the response data. Returns mixed Implementation of `Omnipay\Common\Message\MessageInterface::getData()`
`public null\|string`	# `getMessage( )` Response Message Response Message Returns null\|string A response message from the payment gateway Implementation of `Omnipay\Common\Message\ResponseInterface::getMessage()`
`public null\|string`	# `getCode( )` Response code Response code Returns null\|string A response code from the payment gateway Implementation of `Omnipay\Common\Message\ResponseInterface::getCode()`
`public null\|string`	# `getTransactionReference( )` Gateway Reference Gateway Reference Returns null\|string A reference provided by the gateway to represent this transaction Implementation of `Omnipay\Common\Message\ResponseInterface::getTransactionReference()`
`public string`	# `getTransactionId( )` Get the transaction ID as generated by the merchant website. Get the transaction ID as generated by the merchant website. Returns string
`public`	# `redirect( )` Automatically perform any required redirect Automatically perform any required redirect This method is meant to be a helper for simple scenarios. If you want to customize the redirection page, just call the getRedirectUrl() and getRedirectData() methods directly. Codecoverageignore
`public Symfony\Component\HttpFoundation\RedirectResponse`	# `getRedirectResponse( )` Returns Symfony\Component\HttpFoundation\RedirectResponse

Methods inherited from Omnipay\Common\Message\ResponseInterface
`isSuccessful()`

Properties summary
`protected Omnipay\Common\Message\RequestInterface`	`$request` The embodied request object. The embodied request object.	#
`protected mixed`	`$data` The data contained in the response. The data contained in the response.	#

Namespaces

Classes

Interfaces

Class AbstractResponse

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Implementation of

Returns

Returns

Implementation of

Returns

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Codecoverageignore

Returns