Property | Type | Description | |
---|---|---|---|
$httpClient | Guzzle\Http\ClientInterface | The request client. | |
$httpRequest | The HTTP request object. | ||
$negativeAmountAllowed | boolean | ||
$parameters | Symfony\Component\HttpFoundation\ParameterBag | The request parameters | |
$response | Omnipay\Common\Message\ResponseInterface | An associated ResponseInterface. | |
$zeroAmountAllowed | boolean |
Method | Description | |
---|---|---|
__construct ( Guzzle\Http\ClientInterface $httpClient, |
Create a new Request | |
formatCurrency ( $amount ) : string | Format an amount for the payment currency. | |
getAmount ( ) : string | Validates and returns the formated amount. | |
getAmountInteger ( ) : integer | Get the payment amount as an integer. | |
getCancelUrl ( ) : string | Get the request cancel URL. | |
getCard ( ) : |
Get the card. | |
getCardReference ( ) : string | Get the card reference. | |
getClientIp ( ) : string | Get the client IP address. | |
getCurrency ( ) : string | Get the payment currency code. | |
getCurrencyDecimalPlaces ( ) : integer | Get the number of decimal places in the payment currency. | |
getCurrencyNumeric ( ) : integer | Get the payment currency number. | |
getDescription ( ) : string | Get the request description. | |
getIssuer ( ) : string | Get the payment issuer. | |
getItems ( ) : Omnipay\Common\ItemBag | null | A list of items in this order | |
getNotifyUrl ( ) : string | Get the request notify URL. | |
getParameters ( ) : array | Get all parameters as an associative array. | |
getPaymentMethod ( ) : string | Get the payment issuer. | |
getResponse ( ) : Omnipay\Common\Message\ResponseInterface | Get the associated Response. | |
getReturnUrl ( ) : string | Get the request return URL. | |
getTestMode ( ) : boolean | Gets the test mode of the request from the gateway. | |
getToken ( ) : string | Get the card token. | |
getTransactionId ( ) : string | Get the transaction ID. | |
getTransactionReference ( ) : string | Get the transaction reference. | |
initialize ( array $parameters = [] ) | Initialize the object with parameters. | |
send ( ) : Omnipay\Common\Message\ResponseInterface | Send the request | |
setAmount ( string $value ) : |
Sets the payment amount. | |
setCancelUrl ( string $value ) : |
Sets the request cancel URL. | |
setCard ( |
Sets the card. | |
setCardReference ( string $value ) : |
Sets the card reference. | |
setClientIp ( string $value ) : |
Sets the client IP address. | |
setCurrency ( string $value ) : |
Sets the payment currency code. | |
setDescription ( string $value ) : |
Sets the request description. | |
setIssuer ( string $value ) : |
Set the payment issuer. | |
setItems ( Omnipay\Common\ItemBag | array $items ) : |
Set the items in this order | |
setNotifyUrl ( string $value ) : |
Sets the request notify URL. | |
setPaymentMethod ( string $value ) : |
Set the payment method. | |
setReturnUrl ( string $value ) : |
Sets the request return URL. | |
setTestMode ( boolean $value ) : |
Sets the test mode of the request. | |
setToken ( string $value ) : |
Sets the card token. | |
setTransactionId ( string $value ) : |
Sets the transaction ID. | |
setTransactionReference ( string $value ) : |
Sets the transaction reference. | |
toFloat ( $value ) : float | Convert an amount into a float. | |
validate ( ) | Validate the request. |
Method | Description | |
---|---|---|
getParameter ( string $key ) : mixed | Get a single parameter. | |
setParameter ( string $key, mixed $value ) : |
Set a single parameter |
Method | Description | |
---|---|---|
getCurrencyDecimalFactor ( ) |
public __construct ( Guzzle\Http\ClientInterface $httpClient, |
||
$httpClient | Guzzle\Http\ClientInterface | A Guzzle client to make API calls with |
$httpRequest | A Symfony HTTP request object |
public formatCurrency ( $amount ) : string | ||
return | string |
public getAmountInteger ( ) : integer | ||
return | integer |
public getCancelUrl ( ) : string | ||
return | string |
public getCard ( ) : |
||
return |
public getCardReference ( ) : string | ||
return | string |
public getClientIp ( ) : string | ||
return | string |
public getCurrency ( ) : string | ||
return | string |
public getCurrencyDecimalPlaces ( ) : integer | ||
return | integer |
public getCurrencyNumeric ( ) : integer | ||
return | integer |
public getDescription ( ) : string | ||
return | string |
public getNotifyUrl ( ) : string | ||
return | string |
protected getParameter ( string $key ) : mixed | ||
$key | string | The parameter key |
return | mixed |
public getParameters ( ) : array | ||
return | array |
public getPaymentMethod ( ) : string | ||
return | string |
public getResponse ( ) : Omnipay\Common\Message\ResponseInterface | ||
return | Omnipay\Common\Message\ResponseInterface |
public getReturnUrl ( ) : string | ||
return | string |
public getTestMode ( ) : boolean | ||
return | boolean |
public getTransactionId ( ) : string | ||
return | string |
public getTransactionReference ( ) : string | ||
return | string |
public initialize ( array $parameters = [] ) | ||
$parameters | array | An associative array of parameters |
public send ( ) : Omnipay\Common\Message\ResponseInterface | ||
return | Omnipay\Common\Message\ResponseInterface |
public setCancelUrl ( string $value ) : |
||
$value | string | |
return | Provides a fluent interface |
public setCard ( |
||
$value | ||
return | Provides a fluent interface |
public setCardReference ( string $value ) : |
||
$value | string | |
return | Provides a fluent interface |
public setClientIp ( string $value ) : |
||
$value | string | |
return | Provides a fluent interface |
public setCurrency ( string $value ) : |
||
$value | string | |
return | Provides a fluent interface |
public setDescription ( string $value ) : |
||
$value | string | |
return | Provides a fluent interface |
public setNotifyUrl ( string $value ) : |
||
$value | string | |
return | Provides a fluent interface |
protected setParameter ( string $key, mixed $value ) : |
||
$key | string | The parameter key |
$value | mixed | The value to set |
return | Provides a fluent interface |
public setPaymentMethod ( string $value ) : |
||
$value | string | |
return | Provides a fluent interface |
public setReturnUrl ( string $value ) : |
||
$value | string | |
return | Provides a fluent interface |
public setTestMode ( boolean $value ) : |
||
$value | boolean | True for test mode on. |
return |
public setTransactionId ( string $value ) : |
||
$value | string | |
return | Provides a fluent interface |
public setTransactionReference ( string $value ) : |
||
$value | string | |
return | Provides a fluent interface |
public validate ( ) |
protected ClientInterface,Guzzle\Http $httpClient | ||
return | Guzzle\Http\ClientInterface |
protected Request,Symfony\Component\HttpFoundation $httpRequest | ||
return |
protected ParameterBag,Symfony\Component\HttpFoundation $parameters | ||
return | Symfony\Component\HttpFoundation\ParameterBag |
protected ResponseInterface,Omnipay\Common\Message $response | ||
return | Omnipay\Common\Message\ResponseInterface |