Inheritance diagram for Omnipay\Common\Message\AbstractResponse:

Public Member Functions
	__construct (RequestInterface $request, $data)

	__construct (RequestInterface $request, $data)

	getCode ()

	getCode ()

	getData ()

	getData ()

	getMessage ()

	getMessage ()

	getRedirectData ()

	getRedirectMethod ()

	getRedirectResponse ()

	getRedirectResponse ()

	getRedirectUrl ()

	getRequest ()

	getRequest ()

	getTransactionId ()

	getTransactionId ()

	getTransactionReference ()

	getTransactionReference ()

	isCancelled ()

	isCancelled ()

	isPending ()

	isPending ()

	isRedirect ()

	isRedirect ()

	isTransparentRedirect ()

	isTransparentRedirect ()

	redirect ()

	redirect ()

Public Member Functions inherited from Omnipay\Common\Message\ResponseInterface
	isSuccessful ()

	isSuccessful ()

Protected Member Functions
	validateRedirect ()

Protected Attributes
	$data

	$request

Detailed Description

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.

See also: ResponseInterface

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.

Definition at line 31 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

Omnipay\Common\Message\AbstractResponse::__construct	(	RequestInterface	$request,
			$data
	)

Constructor

Parameters

RequestInterface	$request	the initiating request.
mixed	$data

Reimplemented in Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\ExpressTransactionSearchResponse, and Omnipay\PayPal\Message\ExpressTransactionSearchResponse.

Definition at line 60 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

References Omnipay\Common\Message\AbstractResponse\$data, and Omnipay\Common\Message\AbstractResponse\$request.

◆ __construct() [2/2]

Omnipay\Common\Message\AbstractResponse::__construct	(	RequestInterface	$request,
			$data
	)

Constructor

Parameters

RequestInterface	$request	the initiating request.
mixed	$data

Reimplemented in Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\ExpressTransactionSearchResponse, and Omnipay\PayPal\Message\ExpressTransactionSearchResponse.

Definition at line 59 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

References Omnipay\Common\Message\AbstractResponse\$data, and Omnipay\Common\Message\AbstractResponse\$request.

Member Function Documentation

◆ getCode() [1/2]

Omnipay\Common\Message\AbstractResponse::getCode ( )

Response code

Returns: null|string A response code from the payment gateway

Implements Omnipay\Common\Message\ResponseInterface.

Reimplemented in Omnipay\PayPal\Message\RestResponse, and Omnipay\PayPal\Message\RestResponse.

Definition at line 140 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

◆ getCode() [2/2]

Omnipay\Common\Message\AbstractResponse::getCode ( )

Response code

Returns: null|string A response code from the payment gateway

Implements Omnipay\Common\Message\ResponseInterface.

Reimplemented in Omnipay\PayPal\Message\RestResponse, and Omnipay\PayPal\Message\RestResponse.

Definition at line 141 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

◆ getData() [1/2]

Omnipay\Common\Message\AbstractResponse::getData ( )

Get the response data.

Returns: mixed

Implements Omnipay\Common\Message\MessageInterface.

Definition at line 120 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

References Omnipay\Common\Message\AbstractResponse\$data.

◆ getData() [2/2]

Omnipay\Common\Message\AbstractResponse::getData ( )

Get the response data.

Returns: mixed

Implements Omnipay\Common\Message\MessageInterface.

Definition at line 121 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

References Omnipay\Common\Message\AbstractResponse\$data.

◆ getMessage() [1/2]

Omnipay\Common\Message\AbstractResponse::getMessage ( )

Response Message

Returns: null|string A response message from the payment gateway

Implements Omnipay\Common\Message\ResponseInterface.

Reimplemented in Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\Response, and Omnipay\PayPal\Message\Response.

Definition at line 130 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

◆ getMessage() [2/2]

Omnipay\Common\Message\AbstractResponse::getMessage ( )

Response Message

Returns: null|string A response message from the payment gateway

Implements Omnipay\Common\Message\ResponseInterface.

Reimplemented in Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\Response, and Omnipay\PayPal\Message\Response.

Definition at line 131 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

◆ getRedirectData()

Omnipay\Common\Message\AbstractResponse::getRedirectData ( )

Gets the redirect form data array, if the redirect method is POST.

Returns: array

Reimplemented in Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, and Omnipay\PayPal\Message\ExpressAuthorizeResponse.

Definition at line 190 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

Referenced by Omnipay\Common\Message\AbstractResponse\getRedirectResponse().

◆ getRedirectMethod()

Omnipay\Common\Message\AbstractResponse::getRedirectMethod ( )

Get the required redirect method (either GET or POST).

Returns: string

Reimplemented in Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, and Omnipay\PayPal\Message\ExpressAuthorizeResponse.

Definition at line 180 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

Referenced by Omnipay\Common\Message\AbstractResponse\getRedirectResponse(), and Omnipay\Common\Message\AbstractResponse\validateRedirect().

◆ getRedirectResponse() [1/2]

Omnipay\Common\Message\AbstractResponse::getRedirectResponse ( )

Returns: HttpRedirectResponse

Definition at line 185 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

References Omnipay\Common\Message\AbstractResponse\getRedirectData(), Omnipay\Common\Message\AbstractResponse\getRedirectMethod(), Omnipay\Common\Message\AbstractResponse\getRedirectUrl(), and Omnipay\Common\Message\AbstractResponse\isRedirect().

Referenced by Omnipay\Common\Message\AbstractResponse\redirect().

◆ getRedirectResponse() [2/2]

Omnipay\Common\Message\AbstractResponse::getRedirectResponse ( )

Returns: HttpRedirectResponse|HttpResponse

Definition at line 211 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

References Omnipay\Common\Message\AbstractResponse\getRedirectData(), Omnipay\Common\Message\AbstractResponse\getRedirectMethod(), Omnipay\Common\Message\AbstractResponse\getRedirectUrl(), and Omnipay\Common\Message\AbstractResponse\validateRedirect().

◆ getRedirectUrl()

Omnipay\Common\Message\AbstractResponse::getRedirectUrl ( )

Gets the redirect target url.

Returns: string

Reimplemented in Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, and Omnipay\PayPal\Message\RestAuthorizeResponse.

Definition at line 170 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

Referenced by Omnipay\Common\Message\AbstractResponse\getRedirectResponse(), and Omnipay\Common\Message\AbstractResponse\validateRedirect().

◆ getRequest() [1/2]

Omnipay\Common\Message\AbstractResponse::getRequest ( )

Get the initiating request object.

Returns: RequestInterface

Implements Omnipay\Common\Message\ResponseInterface.

Definition at line 70 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

References Omnipay\Common\Message\AbstractResponse\$request.

◆ getRequest() [2/2]

Omnipay\Common\Message\AbstractResponse::getRequest ( )

Get the initiating request object.

Returns: RequestInterface

Implements Omnipay\Common\Message\ResponseInterface.

Definition at line 71 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

References Omnipay\Common\Message\AbstractResponse\$request.

Referenced by Omnipay\PayPal\Message\ExpressAuthorizeResponse\getCheckoutEndpoint().

◆ getTransactionId() [1/2]

Omnipay\Common\Message\AbstractResponse::getTransactionId ( )

Get the transaction ID as generated by the merchant website.

Returns: string

Definition at line 160 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

◆ getTransactionId() [2/2]

Omnipay\Common\Message\AbstractResponse::getTransactionId ( )

Get the transaction ID as generated by the merchant website.

Returns: string

Definition at line 161 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

◆ getTransactionReference() [1/2]

Omnipay\Common\Message\AbstractResponse::getTransactionReference ( )

Gateway Reference

Returns: null|string A reference provided by the gateway to represent this transaction

Implements Omnipay\Common\Message\ResponseInterface.

Reimplemented in Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\RestResponse, and Omnipay\PayPal\Message\RestResponse.

Definition at line 150 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

◆ getTransactionReference() [2/2]

Omnipay\Common\Message\AbstractResponse::getTransactionReference ( )

Gateway Reference

Returns: null|string A reference provided by the gateway to represent this transaction

Implements Omnipay\Common\Message\ResponseInterface.

Reimplemented in Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\RestResponse, and Omnipay\PayPal\Message\RestResponse.

Definition at line 151 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

◆ isCancelled() [1/2]

Omnipay\Common\Message\AbstractResponse::isCancelled ( )

Is the transaction cancelled by the user?

Returns: boolean

Implements Omnipay\Common\Message\ResponseInterface.

Definition at line 110 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

◆ isCancelled() [2/2]

Omnipay\Common\Message\AbstractResponse::isCancelled ( )

Is the transaction cancelled by the user?

Returns: boolean

Implements Omnipay\Common\Message\ResponseInterface.

Definition at line 111 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

◆ isPending() [1/2]

Omnipay\Common\Message\AbstractResponse::isPending ( )

Is the response successful?

Returns: boolean

Reimplemented in Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse, Omnipay\PayPal\Message\Response, and Omnipay\PayPal\Message\Response.

Definition at line 80 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

◆ isPending() [2/2]

Omnipay\Common\Message\AbstractResponse::isPending ( )

Is the response successful?

Returns: boolean

Reimplemented in Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse, Omnipay\PayPal\Message\Response, and Omnipay\PayPal\Message\Response.

Definition at line 81 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

◆ isRedirect() [1/2]

Omnipay\Common\Message\AbstractResponse::isRedirect ( )

Does the response require a redirect?

Returns: boolean

Implements Omnipay\Common\Message\ResponseInterface.

Reimplemented in Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, and Omnipay\PayPal\Message\RestAuthorizeResponse.

Definition at line 90 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

◆ isRedirect() [2/2]

Omnipay\Common\Message\AbstractResponse::isRedirect ( )

Does the response require a redirect?

Returns: boolean

Implements Omnipay\Common\Message\ResponseInterface.

Reimplemented in Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, and Omnipay\PayPal\Message\RestAuthorizeResponse.

Definition at line 91 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

Referenced by Omnipay\Common\Message\AbstractResponse\getRedirectResponse(), and Omnipay\Common\Message\AbstractResponse\validateRedirect().

◆ isTransparentRedirect() [1/2]

Omnipay\Common\Message\AbstractResponse::isTransparentRedirect ( )

Is the response a transparent redirect?

Returns: boolean

Definition at line 100 of file vendor/omnipay/common/src/Common/Message/AbstractResponse.php.

◆ isTransparentRedirect() [2/2]

Omnipay\Common\Message\AbstractResponse::isTransparentRedirect ( )

Is the response a transparent redirect?

Returns: boolean

Definition at line 101 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

◆ redirect() [1/2]

Omnipay\Common\Message\AbstractResponse::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

Returns: void

Definition at line 176 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/AbstractResponse.php.

References Omnipay\Common\Message\AbstractResponse\getRedirectResponse().

◆ redirect() [2/2]

Omnipay\Common\Message\AbstractResponse::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.