1. class
  2. MangoPay
  3. \
  4. Libraries
  5. \
  6. RestTool

RestTool

class RestTool (View source)

Class to prepare HTTP request, call the request and decode the response

Constants

VERSION

Methods

array
GetRequestHeaders()

Return HTTP header to send with request

RequestType
GetRequestType()

Return HTTP request method

array|string
GetRequestData()

Return HTTP request data

string
GetRequestUrl()

Return HTTP request url

__construct(MangoPayApi $root, bool $authRequired = true, bool $clientIdRequired = true)

Constructor

AddRequestHttpHeader($httpHeader)

No description

object
Request(string $urlPath, string $apiVersion, RequestType $requestType, array $requestData = null, string $idempotencyKey = null, Pagination $pagination = null, array $additionalUrlParams = null)

Call request to MangoPay API

object
RequestMultipart(string $urlPath, string $apiVersion, RequestType $requestType, string $file, string $fileName, string $idempotencyKey = null)

Perform a POST/PUT request with a multipart file

Details

at line 43
array GetRequestHeaders()

Return HTTP header to send with request

Return Value

array

at line 58
RequestType GetRequestType()

Return HTTP request method

Return Value

RequestType

at line 73
array|string GetRequestData()

Return HTTP request data

Return Value

array|string

at line 96
string GetRequestUrl()

Return HTTP request url

Return Value

string

at line 109
__construct(MangoPayApi $root, bool $authRequired = true, bool $clientIdRequired = true)

Constructor

Parameters

MangoPayApi $root

Root/parent instance that holds the OAuthToken and Configuration instance
bool $authRequired

Variable to flag that in request the authentication data are required
bool $clientIdRequired

Variable to flag if the request path should contain the clientId or not

at line 117
AddRequestHttpHeader($httpHeader)

No description

Parameters

$httpHeader

at line 136
object Request(string $urlPath, string $apiVersion, RequestType $requestType, array $requestData = null, string $idempotencyKey = null, Pagination $pagination = null, array $additionalUrlParams = null)

Call request to MangoPay API

Parameters

string $urlPath

Part of the full path of the API URL
string $apiVersion

Version of the API
RequestType $requestType

Type of request
array $requestData

Data to send in request
string $idempotencyKey
Pagination $pagination

Pagination object
array $additionalUrlParams

with additional parameters to URL. Expected keys: "sort" and "filter"

Return Value

object

Response data

at line 182
object RequestMultipart(string $urlPath, string $apiVersion, RequestType $requestType, string $file, string $fileName, string $idempotencyKey = null)

Perform a POST/PUT request with a multipart file

Parameters

string $urlPath

Part of the full path of the API URL
string $apiVersion

Version of the API
RequestType $requestType

Type of request
string $file

The file as binary string
string $fileName

The file name
string $idempotencyKey

Optional idempotency key for post requests

Return Value

object

Response data

Exceptions

ResponseException