Open Monograph Press  3.3.0
Public Member Functions | Protected Member Functions | Protected Attributes
Omnipay\Common\Message\AbstractRequest Class Reference
Inheritance diagram for Omnipay\Common\Message\AbstractRequest:
Omnipay\Common\Message\RequestInterface Omnipay\Common\Message\MessageInterface Omnipay\Common\AbstractGatewayTest_MockAbstractRequest Omnipay\Common\Message\AbstractRequestTest_MockAbstractRequest Omnipay\PayPal\Message\AbstractRequest Omnipay\PayPal\Message\AbstractRestRequest Omnipay\PayPal\Message\CaptureRequest Omnipay\PayPal\Message\ExpressAuthorizeRequest Omnipay\PayPal\Message\ExpressCompleteAuthorizeRequest Omnipay\PayPal\Message\ExpressFetchCheckoutRequest Omnipay\PayPal\Message\ExpressTransactionSearchRequest Omnipay\PayPal\Message\ExpressVoidRequest Omnipay\PayPal\Message\FetchTransactionRequest Omnipay\PayPal\Message\ProAuthorizeRequest Omnipay\PayPal\Message\RefundRequest Omnipay\PayPal\Message\RestAuthorizeRequest Omnipay\PayPal\Message\RestCancelSubscriptionRequest Omnipay\PayPal\Message\RestCaptureRequest Omnipay\PayPal\Message\RestCompletePurchaseRequest Omnipay\PayPal\Message\RestCompleteSubscriptionRequest Omnipay\PayPal\Message\RestCreateCardRequest Omnipay\PayPal\Message\RestCreatePlanRequest Omnipay\PayPal\Message\RestCreateSubscriptionRequest Omnipay\PayPal\Message\RestDeleteCardRequest Omnipay\PayPal\Message\RestFetchPurchaseRequest Omnipay\PayPal\Message\RestFetchTransactionRequest Omnipay\PayPal\Message\RestListPlanRequest Omnipay\PayPal\Message\RestListPurchaseRequest Omnipay\PayPal\Message\RestReactivateSubscriptionRequest Omnipay\PayPal\Message\RestRefundCaptureRequest Omnipay\PayPal\Message\RestRefundRequest Omnipay\PayPal\Message\RestSearchTransactionRequest Omnipay\PayPal\Message\RestSuspendSubscriptionRequest Omnipay\PayPal\Message\RestTokenRequest Omnipay\PayPal\Message\RestUpdatePlanRequest Omnipay\PayPal\Message\RestVoidRequest

Public Member Functions

 __construct (ClientInterface $httpClient, HttpRequest $httpRequest)
 
 __construct (ClientInterface $httpClient, HttpRequest $httpRequest)
 
 formatCurrency ($amount)
 
 formatCurrency ($amount)
 
 getAmount ()
 
 getAmount ()
 
 getAmountInteger ()
 
 getAmountInteger ()
 
 getCancelUrl ()
 
 getCancelUrl ()
 
 getCard ()
 
 getCard ()
 
 getCardReference ()
 
 getCardReference ()
 
 getClientIp ()
 
 getClientIp ()
 
 getCurrency ()
 
 getCurrency ()
 
 getCurrencyDecimalPlaces ()
 
 getCurrencyDecimalPlaces ()
 
 getCurrencyNumeric ()
 
 getCurrencyNumeric ()
 
 getDescription ()
 
 getDescription ()
 
 getIssuer ()
 
 getIssuer ()
 
 getItems ()
 
 getItems ()
 
 getNotifyUrl ()
 
 getNotifyUrl ()
 
 getParameters ()
 
 getPaymentMethod ()
 
 getPaymentMethod ()
 
 getResponse ()
 
 getResponse ()
 
 getReturnUrl ()
 
 getReturnUrl ()
 
 getTestMode ()
 
 getTestMode ()
 
 getToken ()
 
 getToken ()
 
 getTransactionId ()
 
 getTransactionId ()
 
 getTransactionReference ()
 
 getTransactionReference ()
 
 initialize (array $parameters=array())
 
 initialize (array $parameters=array())
 
 send ()
 
 send ()
 
 setAmount ($value)
 
 setAmount ($value)
 
 setAmountInteger ($value)
 
 setCancelUrl ($value)
 
 setCancelUrl ($value)
 
 setCard ($value)
 
 setCard ($value)
 
 setCardReference ($value)
 
 setCardReference ($value)
 
 setClientIp ($value)
 
 setClientIp ($value)
 
 setCurrency ($value)
 
 setCurrency ($value)
 
 setDescription ($value)
 
 setDescription ($value)
 
 setIssuer ($value)
 
 setIssuer ($value)
 
 setItems ($items)
 
 setItems ($items)
 
 setMoney (Money $value)
 
 setNotifyUrl ($value)
 
 setNotifyUrl ($value)
 
 setPaymentMethod ($value)
 
 setPaymentMethod ($value)
 
 setReturnUrl ($value)
 
 setReturnUrl ($value)
 
 setTestMode ($value)
 
 setTestMode ($value)
 
 setToken ($value)
 
 setToken ($value)
 
 setTransactionId ($value)
 
 setTransactionId ($value)
 
 setTransactionReference ($value)
 
 setTransactionReference ($value)
 
 toFloat ($value)
 
 validate ()
 
- Public Member Functions inherited from Omnipay\Common\Message\RequestInterface
 sendData ($data)
 
 sendData ($data)
 
- Public Member Functions inherited from Omnipay\Common\Message\MessageInterface
 getData ()
 
 getData ()
 

Protected Member Functions

 getCurrencies ()
 
 getParameter ($key)
 
 setParameter ($key, $value)
 
 setParameter ($key, $value)
 

Protected Attributes

 $currencies
 
 $httpClient
 
 $httpRequest
 
 $negativeAmountAllowed = false
 
 $parameters
 
 $response
 
 $zeroAmountAllowed = true
 

Detailed Description

Abstract Request

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

Requests of this class are usually created using the createRequest function of the gateway and then actioned using methods within this class or a class that extends this class.

Example – creating a request:

class MyRequest extends \Omnipay\Common\Message\AbstractRequest {};

class MyGateway extends \Omnipay\Common\AbstractGateway { function myRequest($parameters) { $this->createRequest('MyRequest', $parameters); } }

// Create the gateway object $gw = Omnipay::create('MyGateway');

// Create the request object $myRequest = $gw->myRequest($someParameters);

Example – validating and sending a request:

try { $myRequest->validate(); $myResponse = $myRequest->send(); } catch (InvalidRequestException $e) { print "Something went wrong: " . $e->getMessage() . "\n"; } // now do something with the $myResponse object, test for success, etc.

See also
RequestInterface
AbstractResponse

Abstract Request

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

Requests of this class are usually created using the createRequest function of the gateway and then actioned using methods within this class or a class that extends this class.

Example – creating a request:

class MyRequest extends \Omnipay\Common\Message\AbstractRequest {};

class MyGateway extends \Omnipay\Common\AbstractGateway { function myRequest($parameters) { $this->createRequest('MyRequest', $parameters); } }

// Create the gateway object $gw = Omnipay::create('MyGateway');

// Create the request object $myRequest = $gw->myRequest($someParameters);

Example – validating and sending a request:

try { $myRequest->validate(); $myResponse = $myRequest->send(); } catch (InvalidRequestException $e) { print "Something went wrong: " . $e->getMessage() . "\n"; } // now do something with the $myResponse object, test for success, etc.

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

Constructor & Destructor Documentation

◆ __construct() [1/2]

Omnipay\Common\Message\AbstractRequest::__construct ( ClientInterface  $httpClient,
HttpRequest  $httpRequest 
)

Create a new Request

Parameters
ClientInterface$httpClientA Guzzle client to make API calls with
HttpRequest$httpRequestA Symfony HTTP request object

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

References Omnipay\Common\Message\AbstractRequest\$httpClient, Omnipay\Common\Message\AbstractRequest\$httpRequest, and Omnipay\Common\Message\AbstractRequest\initialize().

◆ __construct() [2/2]

Omnipay\Common\Message\AbstractRequest::__construct ( ClientInterface  $httpClient,
HttpRequest  $httpRequest 
)

Create a new Request

Parameters
ClientInterface$httpClientA HTTP client to make API calls with
HttpRequest$httpRequestA Symfony HTTP request object

Definition at line 132 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\$httpClient, Omnipay\Common\Message\AbstractRequest\$httpRequest, and Omnipay\Common\Message\AbstractRequest\initialize().

Member Function Documentation

◆ formatCurrency() [1/2]

Omnipay\Common\Message\AbstractRequest::formatCurrency (   $amount)

Format an amount for the payment currency.

Returns
string

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

References Omnipay\Common\Message\AbstractRequest\getCurrencyDecimalPlaces().

Referenced by Omnipay\Common\Message\AbstractRequest\getAmount(), and Omnipay\PayPal\Message\AbstractRequest\getItemData().

◆ formatCurrency() [2/2]

Omnipay\Common\Message\AbstractRequest::formatCurrency (   $amount)

Format an amount for the payment currency.

Parameters
string$amount
Returns
string

Definition at line 458 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getCurrencies().

◆ getAmount() [1/2]

Omnipay\Common\Message\AbstractRequest::getAmount ( )

Validates and returns the formated amount.

Exceptions
InvalidRequestExceptionon any validation failure.
Returns
string The amount formatted to the correct number of decimal places for the selected currency.

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

References Omnipay\Common\Message\AbstractRequest\formatCurrency(), Omnipay\Common\Message\AbstractRequest\getCurrencyDecimalPlaces(), Omnipay\Common\Message\AbstractRequest\getParameter(), and Omnipay\Common\Message\AbstractRequest\toFloat().

Referenced by Omnipay\Common\Message\AbstractRequest\getAmountInteger(), Omnipay\PayPal\Message\CaptureRequest\getData(), Omnipay\PayPal\Message\ExpressCompleteAuthorizeRequest\getData(), Omnipay\PayPal\Message\ProAuthorizeRequest\getData(), Omnipay\PayPal\Message\RefundRequest\getData(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getData(), Omnipay\PayPal\Message\RestRefundCaptureRequest\getData(), Omnipay\PayPal\Message\RestCaptureRequest\getData(), Omnipay\PayPal\Message\RestRefundRequest\getData(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\getData(), and Omnipay\PayPal\Message\RestAuthorizeRequest\getData().

◆ getAmount() [2/2]

Omnipay\Common\Message\AbstractRequest::getAmount ( )

Validates and returns the formatted amount.

Exceptions
InvalidRequestExceptionon any validation failure.
Returns
string The amount formatted to the correct number of decimal places for the selected currency.

Definition at line 331 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getCurrencies().

◆ getAmountInteger() [1/2]

Omnipay\Common\Message\AbstractRequest::getAmountInteger ( )

Get the payment amount as an integer.

Returns
integer

Definition at line 358 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

◆ getAmountInteger() [2/2]

Omnipay\Common\Message\AbstractRequest::getAmountInteger ( )

Get the payment amount as an integer.

Returns
integer

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

References Omnipay\Common\Message\AbstractRequest\getAmount().

◆ getCancelUrl() [1/2]

Omnipay\Common\Message\AbstractRequest::getCancelUrl ( )

Get the request cancel URL.

Returns
string

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\ExpressAuthorizeRequest\getData(), and Omnipay\PayPal\Message\RestAuthorizeRequest\getData().

◆ getCancelUrl() [2/2]

Omnipay\Common\Message\AbstractRequest::getCancelUrl ( )

Get the request cancel URL.

Returns
string

Definition at line 606 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getCard() [1/2]

Omnipay\Common\Message\AbstractRequest::getCard ( )

Get the card.

Returns
CreditCard

Definition at line 205 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getCard() [2/2]

Omnipay\Common\Message\AbstractRequest::getCard ( )

Get the card.

Returns
CreditCard

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\ProAuthorizeRequest\getData(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getData(), Omnipay\PayPal\Message\RestCreateCardRequest\getData(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\getData(), and Omnipay\PayPal\Message\RestAuthorizeRequest\getData().

◆ getCardReference() [1/2]

Omnipay\Common\Message\AbstractRequest::getCardReference ( )

Get the card reference.

Returns
string

Definition at line 251 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getCardReference() [2/2]

Omnipay\Common\Message\AbstractRequest::getCardReference ( )

Get the card reference.

Returns
string

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\RestAuthorizeRequest\getData(), and Omnipay\PayPal\Message\RestDeleteCardRequest\getEndpoint().

◆ getClientIp() [1/2]

Omnipay\Common\Message\AbstractRequest::getClientIp ( )

Get the client IP address.

Returns
string

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\ProAuthorizeRequest\getData().

◆ getClientIp() [2/2]

Omnipay\Common\Message\AbstractRequest::getClientIp ( )

Get the client IP address.

Returns
string

Definition at line 564 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getCurrencies()

Omnipay\Common\Message\AbstractRequest::getCurrencies ( )
protected
Returns
ISOCurrencies

Definition at line 270 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\$currencies.

Referenced by Omnipay\Common\Message\AbstractRequest\formatCurrency(), Omnipay\Common\Message\AbstractRequest\getAmount(), Omnipay\Common\Message\AbstractRequest\getCurrencyDecimalPlaces(), and Omnipay\Common\Message\AbstractRequest\getCurrencyNumeric().

◆ getCurrency() [1/2]

Omnipay\Common\Message\AbstractRequest::getCurrency ( )

Get the payment currency code.

Returns
string

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\Common\Message\AbstractRequest\getCurrencyDecimalPlaces(), Omnipay\Common\Message\AbstractRequest\getCurrencyNumeric(), Omnipay\PayPal\Message\RefundRequest\getData(), Omnipay\PayPal\Message\ExpressCompleteAuthorizeRequest\getData(), Omnipay\PayPal\Message\CaptureRequest\getData(), Omnipay\PayPal\Message\ProAuthorizeRequest\getData(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getData(), Omnipay\PayPal\Message\RestRefundCaptureRequest\getData(), Omnipay\PayPal\Message\RestCaptureRequest\getData(), Omnipay\PayPal\Message\RestRefundRequest\getData(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\getData(), and Omnipay\PayPal\Message\RestAuthorizeRequest\getData().

◆ getCurrency() [2/2]

Omnipay\Common\Message\AbstractRequest::getCurrency ( )

Get the payment currency code.

Returns
string

Definition at line 398 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getCurrencyDecimalPlaces() [1/2]

Omnipay\Common\Message\AbstractRequest::getCurrencyDecimalPlaces ( )

Get the number of decimal places in the payment currency.

Returns
integer

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

References Omnipay\Common\Currency\find(), and Omnipay\Common\Message\AbstractRequest\getCurrency().

Referenced by Omnipay\Common\Message\AbstractRequest\formatCurrency(), and Omnipay\Common\Message\AbstractRequest\getAmount().

◆ getCurrencyDecimalPlaces() [2/2]

Omnipay\Common\Message\AbstractRequest::getCurrencyDecimalPlaces ( )

Get the number of decimal places in the payment currency.

Returns
integer

Definition at line 440 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getCurrencies(), and Omnipay\Common\Message\AbstractRequest\getCurrency().

◆ getCurrencyNumeric() [1/2]

Omnipay\Common\Message\AbstractRequest::getCurrencyNumeric ( )

Get the payment currency number.

Returns
integer

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

References Omnipay\Common\Currency\find(), and Omnipay\Common\Message\AbstractRequest\getCurrency().

◆ getCurrencyNumeric() [2/2]

Omnipay\Common\Message\AbstractRequest::getCurrencyNumeric ( )

Get the payment currency number.

Returns
string|null

Definition at line 422 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getCurrencies(), and Omnipay\Common\Message\AbstractRequest\getCurrency().

◆ getDescription() [1/2]

Omnipay\Common\Message\AbstractRequest::getDescription ( )

Get the request description.

Returns
string

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

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\ExpressCompleteAuthorizeRequest\getData(), Omnipay\PayPal\Message\ProAuthorizeRequest\getData(), Omnipay\PayPal\Message\RestRefundCaptureRequest\getData(), Omnipay\PayPal\Message\RestRefundRequest\getData(), Omnipay\PayPal\Message\RestCancelSubscriptionRequest\getData(), Omnipay\PayPal\Message\RestSuspendSubscriptionRequest\getData(), Omnipay\PayPal\Message\RestReactivateSubscriptionRequest\getData(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\getData(), Omnipay\PayPal\Message\RestCreatePlanRequest\getData(), and Omnipay\PayPal\Message\RestCreateSubscriptionRequest\getData().

◆ getDescription() [2/2]

Omnipay\Common\Message\AbstractRequest::getDescription ( )

Get the request description.

Returns
string

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

Definition at line 471 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getIssuer() [1/2]

Omnipay\Common\Message\AbstractRequest::getIssuer ( )

Get the payment issuer.

This field is used by some European gateways, and normally represents the bank where an account is held (separate from the card brand).

Returns
string

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getIssuer() [2/2]

Omnipay\Common\Message\AbstractRequest::getIssuer ( )

Get the payment issuer.

This field is used by some European gateways, and normally represents the bank where an account is held (separate from the card brand).

Returns
string

Definition at line 651 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getItems() [1/2]

Omnipay\Common\Message\AbstractRequest::getItems ( )

A list of items in this order

Returns
ItemBag|null A bag containing items in this order

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\RestAuthorizeRequest\getData(), and Omnipay\PayPal\Message\AbstractRequest\getItemData().

◆ getItems() [2/2]

Omnipay\Common\Message\AbstractRequest::getItems ( )

A list of items in this order

Returns
ItemBag|null A bag containing items in this order

Definition at line 539 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getNotifyUrl() [1/2]

Omnipay\Common\Message\AbstractRequest::getNotifyUrl ( )

Get the request notify URL.

Returns
string

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\ExpressCompleteAuthorizeRequest\getData().

◆ getNotifyUrl() [2/2]

Omnipay\Common\Message\AbstractRequest::getNotifyUrl ( )

Get the request notify URL.

Returns
string

Definition at line 627 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getParameter()

Omnipay\Common\Message\AbstractRequest::getParameter (   $key)
protected

Get a single parameter.

Parameters
string$keyThe parameter key
Returns
mixed

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

Referenced by Omnipay\PayPal\Message\AbstractRequest\getAddressOverride(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\getAgreementDetails(), Omnipay\PayPal\Message\RestSearchTransactionRequest\getAgreementId(), Omnipay\PayPal\Message\AbstractRequest\getAllowNote(), Omnipay\Common\Message\AbstractRequest\getAmount(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getAuctionItemNumber(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\getBillingAgreement(), Omnipay\PayPal\Message\AbstractRequest\getBorderColor(), Omnipay\PayPal\Message\AbstractRequest\getBrandName(), Omnipay\PayPal\Message\AbstractRequest\getButtonSource(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\getCallback(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\getCallbackTimeout(), Omnipay\Common\Message\AbstractRequest\getCancelUrl(), Omnipay\Common\Message\AbstractRequest\getCard(), Omnipay\Common\Message\AbstractRequest\getCardReference(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\getChargeModel(), Omnipay\PayPal\Message\AbstractRestRequest\getClientId(), Omnipay\Common\Message\AbstractRequest\getClientIp(), Omnipay\PayPal\Message\RestListPurchaseRequest\getCount(), Omnipay\Common\Message\AbstractRequest\getCurrency(), Omnipay\PayPal\Message\AbstractRequest\getCustomerServiceNumber(), Omnipay\Common\Message\AbstractRequest\getDescription(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getEmail(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getEndDate(), Omnipay\PayPal\Message\RestSearchTransactionRequest\getEndDate(), Omnipay\PayPal\Message\RestListPurchaseRequest\getEndTime(), Omnipay\PayPal\Message\RestAuthorizeRequest\getExperienceProfileId(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getFirstName(), Omnipay\PayPal\Message\AbstractRequest\getHandlingAmount(), Omnipay\PayPal\Message\AbstractRequest\getHeaderImageUrl(), Omnipay\PayPal\Message\AbstractRequest\getInsuranceAmount(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getInvoiceNumber(), Omnipay\Common\Message\AbstractRequest\getIssuer(), Omnipay\Common\Message\AbstractRequest\getItems(), Omnipay\PayPal\Message\AbstractRequest\getLandingPage(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getLastName(), Omnipay\PayPal\Message\AbstractRequest\getLocaleCode(), Omnipay\PayPal\Message\AbstractRequest\getLogoImageUrl(), Omnipay\PayPal\Message\AbstractRequest\getMaxAmount(), Omnipay\PayPal\Message\RestCreatePlanRequest\getMerchantPreferences(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\getMerchantPreferences(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getMiddleName(), Omnipay\PayPal\Message\RestCreatePlanRequest\getName(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\getName(), Omnipay\PayPal\Message\AbstractRequest\getNoShipping(), Omnipay\Common\Message\AbstractRequest\getNotifyUrl(), Omnipay\PayPal\Message\RestListPlanRequest\getPage(), Omnipay\PayPal\Message\RestListPlanRequest\getPageSize(), Omnipay\PayPal\Message\AbstractRequest\getPassword(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\getPayerDetails(), Omnipay\PayPal\Message\ExpressCompleteAuthorizeRequest\getPayerID(), Omnipay\PayPal\Message\AbstractRestRequest\getPayerId(), Omnipay\PayPal\Message\RestCreatePlanRequest\getPaymentDefinitions(), Omnipay\Common\Message\AbstractRequest\getPaymentMethod(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\getPlanId(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getProfileId(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getReceiptId(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getReceiver(), Omnipay\Common\Message\AbstractRequest\getReturnUrl(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getSalutation(), Omnipay\PayPal\Message\AbstractRestRequest\getSecret(), Omnipay\PayPal\Message\AbstractRequest\getSellerPaypalAccountId(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\getShippingAddress(), Omnipay\PayPal\Message\AbstractRequest\getShippingAmount(), Omnipay\PayPal\Message\AbstractRequest\getShippingDiscount(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\getShippingOptions(), Omnipay\PayPal\Message\AbstractRequest\getSignature(), Omnipay\PayPal\Message\AbstractRequest\getSolutionType(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getStartDate(), Omnipay\PayPal\Message\RestSearchTransactionRequest\getStartDate(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\getStartDate(), Omnipay\PayPal\Message\RestListPurchaseRequest\getStartId(), Omnipay\PayPal\Message\RestListPurchaseRequest\getStartIndex(), Omnipay\PayPal\Message\RestListPurchaseRequest\getStartTime(), Omnipay\PayPal\Message\RestUpdatePlanRequest\getState(), Omnipay\PayPal\Message\RestListPlanRequest\getStatus(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getStatus(), Omnipay\PayPal\Message\AbstractRequest\getSubject(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getSuffix(), Omnipay\PayPal\Message\AbstractRequest\getTaxAmount(), Omnipay\Common\Message\AbstractRequest\getTestMode(), Omnipay\PayPal\Message\AbstractRestRequest\getToken(), Omnipay\Common\Message\AbstractRequest\getToken(), Omnipay\PayPal\Message\RestListPlanRequest\getTotalRequired(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getTransactionClass(), Omnipay\Common\Message\AbstractRequest\getTransactionId(), Omnipay\Common\Message\AbstractRequest\getTransactionReference(), Omnipay\PayPal\Message\RestCreatePlanRequest\getType(), and Omnipay\PayPal\Message\AbstractRequest\getUsername().

◆ getParameters()

Omnipay\Common\Message\AbstractRequest::getParameters ( )

Get all parameters as an associative array.

Returns
array

Implements Omnipay\Common\Message\RequestInterface.

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

◆ getPaymentMethod() [1/2]

Omnipay\Common\Message\AbstractRequest::getPaymentMethod ( )

Get the payment issuer.

This field is used by some European gateways, which support multiple payment providers with a single API.

Returns
string

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getPaymentMethod() [2/2]

Omnipay\Common\Message\AbstractRequest::getPaymentMethod ( )

Get the payment issuer.

This field is used by some European gateways, which support multiple payment providers with a single API.

Returns
string

Definition at line 678 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getResponse() [1/2]

Omnipay\Common\Message\AbstractRequest::getResponse ( )

Get the associated Response.

Returns
ResponseInterface

Implements Omnipay\Common\Message\RequestInterface.

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

References Omnipay\Common\Message\AbstractRequest\$response.

◆ getResponse() [2/2]

Omnipay\Common\Message\AbstractRequest::getResponse ( )

Get the associated Response.

Returns
ResponseInterface

Implements Omnipay\Common\Message\RequestInterface.

Definition at line 714 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\$response.

◆ getReturnUrl() [1/2]

Omnipay\Common\Message\AbstractRequest::getReturnUrl ( )

Get the request return URL.

Returns
string

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\ExpressAuthorizeRequest\getData(), and Omnipay\PayPal\Message\RestAuthorizeRequest\getData().

◆ getReturnUrl() [2/2]

Omnipay\Common\Message\AbstractRequest::getReturnUrl ( )

Get the request return URL.

Returns
string

Definition at line 585 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getTestMode() [1/2]

Omnipay\Common\Message\AbstractRequest::getTestMode ( )

Gets the test mode of the request from the gateway.

Returns
boolean

Definition at line 184 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getTestMode() [2/2]

Omnipay\Common\Message\AbstractRequest::getTestMode ( )

Gets the test mode of the request from the gateway.

Returns
boolean

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\AbstractRestRequest\getEndpoint(), and Omnipay\PayPal\Message\AbstractRequest\getEndpoint().

◆ getToken() [1/2]

Omnipay\Common\Message\AbstractRequest::getToken ( )

Get the card token.

Returns
string

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

Definition at line 230 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getToken() [2/2]

Omnipay\Common\Message\AbstractRequest::getToken ( )

Get the card token.

Returns
string

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

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\ExpressCompleteAuthorizeRequest\getData(), and Omnipay\PayPal\Message\ExpressFetchCheckoutRequest\getData().

◆ getTransactionId() [1/2]

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

Get the transaction ID.

The transaction ID is the identifier generated by the merchant website.

Returns
string

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\ExpressCompleteAuthorizeRequest\getData(), Omnipay\PayPal\Message\ProAuthorizeRequest\getData(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getData(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\getData(), Omnipay\PayPal\Message\RestAuthorizeRequest\getData(), and Omnipay\PayPal\Message\RestAuthorizeRequest\getDescription().

◆ getTransactionId() [2/2]

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

Get the transaction ID.

The transaction ID is the identifier generated by the merchant website.

Returns
string

Definition at line 494 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ getTransactionReference() [1/2]

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

Get the transaction reference.

The transaction reference is the identifier generated by the remote payment gateway.

Returns
string

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

References Omnipay\Common\Message\AbstractRequest\getParameter().

Referenced by Omnipay\PayPal\Message\CaptureRequest\getData(), Omnipay\PayPal\Message\ExpressVoidRequest\getData(), Omnipay\PayPal\Message\RefundRequest\getData(), Omnipay\PayPal\Message\FetchTransactionRequest\getData(), Omnipay\PayPal\Message\RestVoidRequest\getEndpoint(), Omnipay\PayPal\Message\RestRefundCaptureRequest\getEndpoint(), Omnipay\PayPal\Message\RestFetchPurchaseRequest\getEndpoint(), Omnipay\PayPal\Message\RestFetchTransactionRequest\getEndpoint(), Omnipay\PayPal\Message\RestCaptureRequest\getEndpoint(), Omnipay\PayPal\Message\RestCompletePurchaseRequest\getEndpoint(), Omnipay\PayPal\Message\RestRefundRequest\getEndpoint(), Omnipay\PayPal\Message\RestCancelSubscriptionRequest\getEndpoint(), Omnipay\PayPal\Message\RestReactivateSubscriptionRequest\getEndpoint(), Omnipay\PayPal\Message\RestSuspendSubscriptionRequest\getEndpoint(), Omnipay\PayPal\Message\RestCompleteSubscriptionRequest\getEndpoint(), and Omnipay\PayPal\Message\RestUpdatePlanRequest\getEndpoint().

◆ getTransactionReference() [2/2]

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

Get the transaction reference.

The transaction reference is the identifier generated by the remote payment gateway.

Returns
string

Definition at line 518 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\getParameter().

◆ initialize() [1/2]

Omnipay\Common\Message\AbstractRequest::initialize ( array  $parameters = array())

Initialize the object with parameters.

If any unknown parameters passed, they will be ignored.

Parameters
array$parametersAn associative array of parameters
Returns
$this
Exceptions
RuntimeException

Implements Omnipay\Common\Message\RequestInterface.

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

References Omnipay\Common\Message\AbstractRequest\$parameters, and Omnipay\Common\Helper\initialize().

Referenced by Omnipay\Common\Message\AbstractRequest\__construct().

◆ initialize() [2/2]

Omnipay\Common\Message\AbstractRequest::initialize ( array  $parameters = array())

Initialize the object with parameters.

If any unknown parameters passed, they will be ignored.

Parameters
array$parametersAn associative array of parameters
Returns
$this
Exceptions
RuntimeException

Implements Omnipay\Common\Message\RequestInterface.

Definition at line 149 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\$parameters, and Omnipay\Common\Helper\initialize().

◆ send() [1/2]

Omnipay\Common\Message\AbstractRequest::send ( )

Send the request

Returns
ResponseInterface

Implements Omnipay\Common\Message\RequestInterface.

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

References Omnipay\Common\Message\MessageInterface\getData(), and Omnipay\Common\Message\RequestInterface\sendData().

◆ send() [2/2]

Omnipay\Common\Message\AbstractRequest::send ( )

Send the request

Returns
ResponseInterface

Implements Omnipay\Common\Message\RequestInterface.

Definition at line 702 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\MessageInterface\getData(), and Omnipay\Common\Message\RequestInterface\sendData().

◆ setAmount() [1/2]

Omnipay\Common\Message\AbstractRequest::setAmount (   $value)

Sets the payment amount.

Parameters
string | null$value
Returns
$this

Definition at line 348 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setAmount() [2/2]

Omnipay\Common\Message\AbstractRequest::setAmount (   $value)

Sets the payment amount.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setAmountInteger()

Omnipay\Common\Message\AbstractRequest::setAmountInteger (   $value)

Sets the payment amount as integer.

Parameters
int$value
Returns
$this

Definition at line 373 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setCancelUrl() [1/2]

Omnipay\Common\Message\AbstractRequest::setCancelUrl (   $value)

Sets the request cancel URL.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setCancelUrl() [2/2]

Omnipay\Common\Message\AbstractRequest::setCancelUrl (   $value)

Sets the request cancel URL.

Parameters
string$value
Returns
$this

Definition at line 617 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setCard() [1/2]

Omnipay\Common\Message\AbstractRequest::setCard (   $value)

Sets the card.

Parameters
CreditCard$value
Returns
$this

Definition at line 216 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setCard() [2/2]

Omnipay\Common\Message\AbstractRequest::setCard (   $value)

Sets the card.

Parameters
CreditCard$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setCardReference() [1/2]

Omnipay\Common\Message\AbstractRequest::setCardReference (   $value)

Sets the card reference.

Parameters
string$value
Returns
$this

Definition at line 262 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setCardReference() [2/2]

Omnipay\Common\Message\AbstractRequest::setCardReference (   $value)

Sets the card reference.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setClientIp() [1/2]

Omnipay\Common\Message\AbstractRequest::setClientIp (   $value)

Sets the client IP address.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setClientIp() [2/2]

Omnipay\Common\Message\AbstractRequest::setClientIp (   $value)

Sets the client IP address.

Parameters
string$value
Returns
$this

Definition at line 575 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setCurrency() [1/2]

Omnipay\Common\Message\AbstractRequest::setCurrency (   $value)

Sets the payment currency code.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

Referenced by Omnipay\Common\Message\AbstractRequest\setMoney().

◆ setCurrency() [2/2]

Omnipay\Common\Message\AbstractRequest::setCurrency (   $value)

Sets the payment currency code.

Parameters
string$value
Returns
$this

Definition at line 409 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setDescription() [1/2]

Omnipay\Common\Message\AbstractRequest::setDescription (   $value)

Sets the request description.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setDescription() [2/2]

Omnipay\Common\Message\AbstractRequest::setDescription (   $value)

Sets the request description.

Parameters
string$value
Returns
$this

Definition at line 482 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setIssuer() [1/2]

Omnipay\Common\Message\AbstractRequest::setIssuer (   $value)

Set the payment issuer.

This field is used by some European gateways, and normally represents the bank where an account is held (separate from the card brand).

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setIssuer() [2/2]

Omnipay\Common\Message\AbstractRequest::setIssuer (   $value)

Set the payment issuer.

This field is used by some European gateways, and normally represents the bank where an account is held (separate from the card brand).

Parameters
string$value
Returns
$this

Definition at line 665 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setItems() [1/2]

Omnipay\Common\Message\AbstractRequest::setItems (   $items)

Set the items in this order

Parameters
ItemBag | array$itemsAn array of items in this order
Returns
AbstractRequest

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

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setItems() [2/2]

Omnipay\Common\Message\AbstractRequest::setItems (   $items)

Set the items in this order

Parameters
ItemBag | array$itemsAn array of items in this order
Returns
$this

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

Definition at line 550 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setMoney()

Omnipay\Common\Message\AbstractRequest::setMoney ( Money  $value)

Sets the payment amount as integer.

Parameters
Money$value
Returns
$this

Definition at line 384 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Money\Money\getCurrency(), Omnipay\Common\Message\AbstractRequest\setCurrency(), and Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setNotifyUrl() [1/2]

Omnipay\Common\Message\AbstractRequest::setNotifyUrl (   $value)

Sets the request notify URL.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setNotifyUrl() [2/2]

Omnipay\Common\Message\AbstractRequest::setNotifyUrl (   $value)

Sets the request notify URL.

Parameters
string$value
Returns
$this

Definition at line 638 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setParameter() [1/2]

Omnipay\Common\Message\AbstractRequest::setParameter (   $key,
  $value 
)
protected

Set a single parameter

Parameters
string$keyThe parameter key
mixed$valueThe value to set
Returns
$this
Exceptions
RuntimeExceptionif a request parameter is modified after the request has been sent.

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

◆ setParameter() [2/2]

Omnipay\Common\Message\AbstractRequest::setParameter (   $key,
  $value 
)
protected

Set a single parameter

Parameters
string$keyThe parameter key
mixed$valueThe value to set
Returns
AbstractRequest Provides a fluent interface
Exceptions
RuntimeExceptionif a request parameter is modified after the request has been sent.

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

Referenced by Omnipay\PayPal\Message\AbstractRequest\setAddressOverride(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\setAgreementDetails(), Omnipay\PayPal\Message\RestSearchTransactionRequest\setAgreementId(), Omnipay\PayPal\Message\AbstractRequest\setAllowNote(), Omnipay\Common\Message\AbstractRequest\setAmount(), Omnipay\Common\Message\AbstractRequest\setAmountInteger(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setAuctionItemNumber(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\setBillingAgreement(), Omnipay\PayPal\Message\AbstractRequest\setBorderColor(), Omnipay\PayPal\Message\AbstractRequest\setBrandName(), Omnipay\PayPal\Message\AbstractRequest\setButtonSource(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\setCallback(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\setCallbackTimeout(), Omnipay\Common\Message\AbstractRequest\setCancelUrl(), Omnipay\Common\Message\AbstractRequest\setCard(), Omnipay\Common\Message\AbstractRequest\setCardReference(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\setChargeModel(), Omnipay\PayPal\Message\AbstractRestRequest\setClientId(), Omnipay\Common\Message\AbstractRequest\setClientIp(), Omnipay\PayPal\Message\RestListPurchaseRequest\setCount(), Omnipay\Common\Message\AbstractRequest\setCurrency(), Omnipay\PayPal\Message\AbstractRequest\setCustomerServiceNumber(), Omnipay\Common\Message\AbstractRequest\setDescription(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setEmail(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setEndDate(), Omnipay\PayPal\Message\RestSearchTransactionRequest\setEndDate(), Omnipay\PayPal\Message\RestListPurchaseRequest\setEndTime(), Omnipay\PayPal\Message\RestAuthorizeRequest\setExperienceProfileId(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setFirstName(), Omnipay\PayPal\Message\AbstractRequest\setHandlingAmount(), Omnipay\PayPal\Message\AbstractRequest\setHeaderImageUrl(), Omnipay\PayPal\Message\AbstractRequest\setInsuranceAmount(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setInvoiceNumber(), Omnipay\Common\Message\AbstractRequest\setIssuer(), Omnipay\PayPal\Message\AbstractRequest\setItems(), Omnipay\Common\Message\AbstractRequest\setItems(), Omnipay\PayPal\Message\AbstractRequest\setLandingPage(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setLastName(), Omnipay\PayPal\Message\AbstractRequest\setLocaleCode(), Omnipay\PayPal\Message\AbstractRequest\setLogoImageUrl(), Omnipay\PayPal\Message\AbstractRequest\setMaxAmount(), Omnipay\PayPal\Message\RestCreatePlanRequest\setMerchantPreferences(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\setMerchantPreferences(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setMiddleName(), Omnipay\Common\Message\AbstractRequest\setMoney(), Omnipay\PayPal\Message\RestCreatePlanRequest\setName(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\setName(), Omnipay\PayPal\Message\AbstractRequest\setNoShipping(), Omnipay\Common\Message\AbstractRequest\setNotifyUrl(), Omnipay\PayPal\Message\RestListPlanRequest\setPage(), Omnipay\PayPal\Message\RestListPlanRequest\setPageSize(), Omnipay\PayPal\Message\AbstractRequest\setPassword(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\setPayerDetails(), Omnipay\PayPal\Message\ExpressCompleteAuthorizeRequest\setPayerID(), Omnipay\PayPal\Message\AbstractRestRequest\setPayerId(), Omnipay\PayPal\Message\RestCreatePlanRequest\setPaymentDefinitions(), Omnipay\Common\Message\AbstractRequest\setPaymentMethod(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\setPlanId(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setProfileId(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setReceiptId(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setReceiver(), Omnipay\Common\Message\AbstractRequest\setReturnUrl(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setSalutation(), Omnipay\PayPal\Message\AbstractRestRequest\setSecret(), Omnipay\PayPal\Message\AbstractRequest\setSellerPaypalAccountId(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\setShippingAddress(), Omnipay\PayPal\Message\AbstractRequest\setShippingAmount(), Omnipay\PayPal\Message\AbstractRequest\setShippingDiscount(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\setShippingOptions(), Omnipay\PayPal\Message\AbstractRequest\setSignature(), Omnipay\PayPal\Message\AbstractRequest\setSolutionType(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setStartDate(), Omnipay\PayPal\Message\RestSearchTransactionRequest\setStartDate(), Omnipay\PayPal\Message\RestCreateSubscriptionRequest\setStartDate(), Omnipay\PayPal\Message\RestListPurchaseRequest\setStartId(), Omnipay\PayPal\Message\RestListPurchaseRequest\setStartIndex(), Omnipay\PayPal\Message\RestListPurchaseRequest\setStartTime(), Omnipay\PayPal\Message\RestUpdatePlanRequest\setState(), Omnipay\PayPal\Message\RestListPlanRequest\setStatus(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setStatus(), Omnipay\PayPal\Message\AbstractRequest\setSubject(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setSuffix(), Omnipay\PayPal\Message\AbstractRequest\setTaxAmount(), Omnipay\Common\Message\AbstractRequest\setTestMode(), Omnipay\PayPal\Message\AbstractRestRequest\setToken(), Omnipay\Common\Message\AbstractRequest\setToken(), Omnipay\PayPal\Message\RestListPlanRequest\setTotalRequired(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\setTransactionClass(), Omnipay\Common\Message\AbstractRequest\setTransactionId(), Omnipay\Common\Message\AbstractRequest\setTransactionReference(), Omnipay\PayPal\Message\RestCreatePlanRequest\setType(), and Omnipay\PayPal\Message\AbstractRequest\setUsername().

◆ setPaymentMethod() [1/2]

Omnipay\Common\Message\AbstractRequest::setPaymentMethod (   $value)

Set the payment method.

This field is used by some European gateways, which support multiple payment providers with a single API.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setPaymentMethod() [2/2]

Omnipay\Common\Message\AbstractRequest::setPaymentMethod (   $value)

Set the payment method.

This field is used by some European gateways, which support multiple payment providers with a single API.

Parameters
string$value
Returns
$this

Definition at line 692 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setReturnUrl() [1/2]

Omnipay\Common\Message\AbstractRequest::setReturnUrl (   $value)

Sets the request return URL.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setReturnUrl() [2/2]

Omnipay\Common\Message\AbstractRequest::setReturnUrl (   $value)

Sets the request return URL.

Parameters
string$value
Returns
$this

Definition at line 596 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setTestMode() [1/2]

Omnipay\Common\Message\AbstractRequest::setTestMode (   $value)

Sets the test mode of the request.

Parameters
boolean$valueTrue for test mode on.
Returns
$this

Definition at line 195 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setTestMode() [2/2]

Omnipay\Common\Message\AbstractRequest::setTestMode (   $value)

Sets the test mode of the request.

Parameters
boolean$valueTrue for test mode on.
Returns
AbstractRequest

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setToken() [1/2]

Omnipay\Common\Message\AbstractRequest::setToken (   $value)

Sets the card token.

Parameters
string$value
Returns
$this

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

Definition at line 241 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setToken() [2/2]

Omnipay\Common\Message\AbstractRequest::setToken (   $value)

Sets the card token.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setTransactionId() [1/2]

Omnipay\Common\Message\AbstractRequest::setTransactionId (   $value)

Sets the transaction ID.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setTransactionId() [2/2]

Omnipay\Common\Message\AbstractRequest::setTransactionId (   $value)

Sets the transaction ID.

Parameters
string$value
Returns
$this

Definition at line 505 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setTransactionReference() [1/2]

Omnipay\Common\Message\AbstractRequest::setTransactionReference (   $value)

Sets the transaction reference.

Parameters
string$value
Returns
AbstractRequest Provides a fluent interface

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

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ setTransactionReference() [2/2]

Omnipay\Common\Message\AbstractRequest::setTransactionReference (   $value)

Sets the transaction reference.

Parameters
string$value
Returns
$this

Definition at line 529 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

References Omnipay\Common\Message\AbstractRequest\setParameter().

◆ toFloat()

Omnipay\Common\Message\AbstractRequest::toFloat (   $value)

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

References Omnipay\Common\Helper\toFloat().

Referenced by Omnipay\Common\Message\AbstractRequest\getAmount().

◆ validate()

Omnipay\Common\Message\AbstractRequest::validate ( )

Validate the request.

This method is called internally by gateways to avoid wasting time with an API call when the request is clearly invalid.

Parameters
string... a variable length list of required parameters
Exceptions
InvalidRequestException

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

Referenced by Omnipay\PayPal\Message\CaptureRequest\getData(), Omnipay\PayPal\Message\ExpressFetchCheckoutRequest\getData(), Omnipay\PayPal\Message\ProAuthorizeRequest\getData(), Omnipay\PayPal\Message\RefundRequest\getData(), Omnipay\PayPal\Message\ExpressCompleteAuthorizeRequest\getData(), Omnipay\PayPal\Message\ExpressVoidRequest\getData(), Omnipay\PayPal\Message\FetchTransactionRequest\getData(), Omnipay\PayPal\Message\ExpressTransactionSearchRequest\getData(), Omnipay\PayPal\Message\RestRefundCaptureRequest\getData(), Omnipay\PayPal\Message\RestVoidRequest\getData(), Omnipay\PayPal\Message\RestFetchPurchaseRequest\getData(), Omnipay\PayPal\Message\RestFetchTransactionRequest\getData(), Omnipay\PayPal\Message\RestCaptureRequest\getData(), Omnipay\PayPal\Message\RestDeleteCardRequest\getData(), Omnipay\PayPal\Message\RestRefundRequest\getData(), Omnipay\PayPal\Message\RestCompletePurchaseRequest\getData(), Omnipay\PayPal\Message\RestReactivateSubscriptionRequest\getData(), Omnipay\PayPal\Message\RestCancelSubscriptionRequest\getData(), Omnipay\PayPal\Message\RestSuspendSubscriptionRequest\getData(), Omnipay\PayPal\Message\RestCreateCardRequest\getData(), Omnipay\PayPal\Message\RestUpdatePlanRequest\getData(), Omnipay\PayPal\Message\ExpressAuthorizeRequest\getData(), Omnipay\PayPal\Message\RestCompleteSubscriptionRequest\getData(), Omnipay\PayPal\Message\RestSearchTransactionRequest\getData(), Omnipay\PayPal\Message\RestAuthorizeRequest\getData(), Omnipay\PayPal\Message\RestCreatePlanRequest\getData(), and Omnipay\PayPal\Message\RestCreateSubscriptionRequest\getData().

Field Documentation

◆ $currencies

ISOCurrencies Omnipay\Common\Message\AbstractRequest::$currencies
protected

Definition at line 108 of file vendor/omnipay/common/src/Common/Message/AbstractRequest.php.

Referenced by Omnipay\Common\Message\AbstractRequest\getCurrencies().

◆ $httpClient

ClientInterface Omnipay\Common\Message\AbstractRequest::$httpClient
protected

The request client.

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

Referenced by Omnipay\Common\Message\AbstractRequest\__construct().

◆ $httpRequest

Symfony Component HttpFoundation Request Omnipay\Common\Message\AbstractRequest::$httpRequest
protected

The HTTP request object.

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

Referenced by Omnipay\Common\Message\AbstractRequest\__construct(), Omnipay\PayPal\Message\RestTokenRequest\sendData(), Omnipay\PayPal\Message\AbstractRestRequest\sendData(), and Omnipay\PayPal\Message\AbstractRequest\sendData().

◆ $negativeAmountAllowed

bool Omnipay\Common\Message\AbstractRequest::$negativeAmountAllowed = false
protected

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

◆ $parameters

Symfony Component HttpFoundation ParameterBag Omnipay\Common\Message\AbstractRequest::$parameters
protected

The request parameters

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

Referenced by Omnipay\Common\Message\AbstractRequest\initialize().

◆ $response

ResponseInterface Omnipay\Common\Message\AbstractRequest::$response
protected

An associated ResponseInterface.

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

Referenced by Omnipay\Common\Message\AbstractRequest\getResponse().

◆ $zeroAmountAllowed

bool Omnipay\Common\Message\AbstractRequest::$zeroAmountAllowed = true
protected

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

The documentation for this class was generated from the following file: