Inheritance diagram for Omnipay\PayPal\Message\AbstractRestRequest:

Public Member Functions
	getClientId ()

	getClientId ()

	getPayerId ()

	getPayerId ()

	getSecret ()

	getSecret ()

	getToken ()

	getToken ()

	sendData ($data)

	sendData ($data)

	setClientId ($value)

	setClientId ($value)

	setPayerId ($value)

	setPayerId ($value)

	setSecret ($value)

	setSecret ($value)

	setToken ($value)

	setToken ($value)

	toJSON ($data, $options=0)

	toJSON ($data, $options=0)

Public Member Functions inherited from Omnipay\Common\Message\AbstractRequest
	__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 ()

	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)

	setTransactionId ($value)

	setTransactionId ($value)

	setTransactionReference ($value)

	setTransactionReference ($value)

	toFloat ($value)

	validate ()

Public Member Functions inherited from Omnipay\Common\Message\MessageInterface
	getData ()

	getData ()

Data Fields
const	API_VERSION = 'v1'

Protected Member Functions
	createResponse ($data, $statusCode)

	createResponse ($data, $statusCode)

	getEndpoint ()

	getEndpoint ()

	getHttpMethod ()

	getHttpMethod ()

Protected Member Functions inherited from Omnipay\Common\Message\AbstractRequest
	getCurrencies ()

	getParameter ($key)

	setParameter ($key, $value)

	setParameter ($key, $value)

Protected Attributes
	$liveEndpoint = 'https://api.paypal.com'

	$payerId = null

	$testEndpoint = 'https://api.sandbox.paypal.com'

Protected Attributes inherited from Omnipay\Common\Message\AbstractRequest
	$currencies

	$httpClient

	$httpRequest

	$negativeAmountAllowed = false

	$parameters

	$response

	$zeroAmountAllowed = true

Detailed Description

PayPal Abstract REST Request

This class forms the base class for PayPal REST requests via the PayPal REST APIs.

A complete REST operation is formed by combining an HTTP method (or “verb”) with the full URI to the resource you’re addressing. For example, here is the operation to create a new payment:

POST https://api.paypal.com/v1/payments/payment

To create a complete request, combine the operation with the appropriate HTTP headers and any required JSON payload.

https://devtools-paypal.com/integrationwizard/ http://paypal.github.io/sdk/ Omnipay

Definition at line 31 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

Member Function Documentation

◆ createResponse() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::createResponse	(	$data,
		$statusCode
	)

protected

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

Definition at line 194 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

◆ createResponse() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::createResponse	(	$data,
		$statusCode
	)

protected

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

Definition at line 210 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

Referenced by Omnipay\PayPal\Message\AbstractRestRequest\sendData().

◆ getClientId() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::getClientId ( )

Definition at line 74 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

Referenced by Omnipay\PayPal\Message\RestTokenRequest\sendData().

◆ getClientId() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::getClientId ( )

Definition at line 74 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ getEndpoint() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::getEndpoint ( )

protected

Definition at line 126 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

References Omnipay\PayPal\Message\AbstractRestRequest\$liveEndpoint, Omnipay\PayPal\Message\AbstractRestRequest\API_VERSION, and Omnipay\Common\Message\AbstractRequest\getTestMode().

Referenced by Omnipay\PayPal\Message\AbstractRestRequest\sendData().

◆ getEndpoint() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::getEndpoint ( )

protected

Definition at line 126 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

References Omnipay\PayPal\Message\AbstractRestRequest\$liveEndpoint, Omnipay\PayPal\Message\AbstractRestRequest\API_VERSION, and Omnipay\Common\Message\AbstractRequest\getTestMode().

◆ getHttpMethod() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::getHttpMethod ( )

protected

Get HTTP Method.

This is nearly always POST but can be over-ridden in sub classes.

Returns: string

Definition at line 121 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

◆ getHttpMethod() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::getHttpMethod ( )

protected

Get HTTP Method.

This is nearly always POST but can be over-ridden in sub classes.

Returns: string

Definition at line 121 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ getPayerId() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::getPayerId ( )

Definition at line 104 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ getPayerId() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::getPayerId ( )

Definition at line 104 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

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

◆ getSecret() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::getSecret ( )

Definition at line 84 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ getSecret() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::getSecret ( )

Definition at line 84 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

Referenced by Omnipay\PayPal\Message\RestTokenRequest\sendData().

◆ getToken() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::getToken ( )

Get the card token.

Returns: string

Reimplemented from Omnipay\Common\Message\AbstractRequest.

Definition at line 94 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

Referenced by Omnipay\PayPal\Message\AbstractRestRequest\sendData().

◆ getToken() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::getToken ( )

Get the card token.

Returns: string

Reimplemented from Omnipay\Common\Message\AbstractRequest.

Definition at line 94 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ sendData() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::sendData ( $data )

Send the request with specified data

Parameters

mixed $data The data to send

Returns: ResponseInterface

Implements Omnipay\Common\Message\RequestInterface.

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

Definition at line 132 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

References Omnipay\Common\Message\AbstractRequest\$httpRequest, Omnipay\PayPal\Message\AbstractRestRequest\createResponse(), Omnipay\PayPal\Message\AbstractRestRequest\getEndpoint(), Omnipay\PayPal\Message\AbstractRestRequest\getHttpMethod(), Omnipay\PayPal\Message\AbstractRestRequest\getToken(), and Omnipay\PayPal\Message\AbstractRestRequest\toJSON().

◆ sendData() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::sendData ( $data )

Send the request with specified data

Parameters

mixed $data The data to send

Returns: ResponseInterface

Implements Omnipay\Common\Message\RequestInterface.

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

Definition at line 132 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

References Omnipay\PayPal\Message\AbstractRestRequest\createResponse(), Omnipay\PayPal\Message\AbstractRestRequest\getEndpoint(), Omnipay\PayPal\Message\AbstractRestRequest\getHttpMethod(), Omnipay\PayPal\Message\AbstractRestRequest\getToken(), and Omnipay\PayPal\Message\AbstractRestRequest\toJSON().

◆ setClientId() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::setClientId ( $value )

Definition at line 79 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ setClientId() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::setClientId ( $value )

Definition at line 79 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ setPayerId() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::setPayerId ( $value )

Definition at line 109 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ setPayerId() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::setPayerId ( $value )

Definition at line 109 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ setSecret() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::setSecret ( $value )

Definition at line 89 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ setSecret() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::setSecret ( $value )

Definition at line 89 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ setToken() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::setToken ( $value )

Sets the card token.

Parameters

string $value

Returns: AbstractRequest Provides a fluent interface

Reimplemented from Omnipay\Common\Message\AbstractRequest.

Definition at line 99 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ setToken() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::setToken ( $value )

Sets the card token.

Parameters

string $value

Returns: AbstractRequest Provides a fluent interface

Reimplemented from Omnipay\Common\Message\AbstractRequest.

Definition at line 99 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

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

◆ toJSON() [1/2]

Omnipay\PayPal\Message\AbstractRestRequest::toJSON	(	$data,
		$options = `0`
	)

Returns object JSON representation required by PayPal. The PayPal REST API requires the use of JSON_UNESCAPED_SLASHES.

Adapted from the official PayPal REST API PHP SDK. (https://github.com/paypal/PayPal-PHP-SDK/blob/master/lib/PayPal/Common/PayPalModel.php)

Parameters

int $options http://php.net/manual/en/json.constants.php

Returns: string

Definition at line 183 of file vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

◆ toJSON() [2/2]

Omnipay\PayPal\Message\AbstractRestRequest::toJSON	(	$data,
		$options = `0`
	)

Returns object JSON representation required by PayPal. The PayPal REST API requires the use of JSON_UNESCAPED_SLASHES.

Adapted from the official PayPal REST API PHP SDK. (https://github.com/paypal/PayPal-PHP-SDK/blob/master/lib/PayPal/Common/PayPalModel.php)

Parameters

int $options http://php.net/manual/en/json.constants.php

Returns: string

Definition at line 199 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

Referenced by Omnipay\PayPal\Message\AbstractRestRequest\sendData().

Field Documentation

◆ $liveEndpoint

string Omnipay\PayPal\Message\AbstractRestRequest::$liveEndpoint = 'https://api.paypal.com'

protected

Live Endpoint URL

When you’re set to go live, use the live credentials assigned to your app to generate a new access token to be used with the live URIs.

URL

Definition at line 62 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

Referenced by Omnipay\PayPal\Message\AbstractRestRequest\getEndpoint().

◆ $payerId

string Omnipay\PayPal\Message\AbstractRestRequest::$payerId = null

protected

PayPal Payer ID

PayerID

Definition at line 72 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

◆ $testEndpoint

string Omnipay\PayPal\Message\AbstractRestRequest::$testEndpoint = 'https://api.sandbox.paypal.com'

protected

Sandbox Endpoint URL

The PayPal REST APIs are supported in two environments. Use the Sandbox environment for testing purposes, then move to the live environment for production processing. When testing, generate an access token with your test credentials to make calls to the Sandbox URIs. When you’re set to go live, use the live credentials assigned to your app to generate a new access token to be used with the live URIs.

URL

Definition at line 49 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

◆ API_VERSION

const Omnipay\PayPal\Message\AbstractRestRequest::API_VERSION = 'v1'

Definition at line 33 of file lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php.

Referenced by Omnipay\PayPal\Message\AbstractRestRequest\getEndpoint().

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

lib/vendor/omnipay/paypal/src/Message/AbstractRestRequest.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ createResponse() [1/2]

◆ createResponse() [2/2]

◆ getClientId() [1/2]

◆ getClientId() [2/2]

◆ getEndpoint() [1/2]

◆ getEndpoint() [2/2]

◆ getHttpMethod() [1/2]

◆ getHttpMethod() [2/2]

◆ getPayerId() [1/2]

◆ getPayerId() [2/2]

◆ getSecret() [1/2]

◆ getSecret() [2/2]

◆ getToken() [1/2]

◆ getToken() [2/2]

◆ sendData() [1/2]

◆ sendData() [2/2]

◆ setClientId() [1/2]

◆ setClientId() [2/2]

◆ setPayerId() [1/2]

◆ setPayerId() [2/2]

◆ setSecret() [1/2]

◆ setSecret() [2/2]

◆ setToken() [1/2]

◆ setToken() [2/2]

◆ toJSON() [1/2]

◆ toJSON() [2/2]

Field Documentation

◆ $liveEndpoint

◆ $payerId

◆ $testEndpoint

◆ API_VERSION