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

ApiBase

abstract class ApiBase (View source)

Base class for MangoPay API managers

Properties

protected MangoPayApi $_root

Root/parent instance that holds the OAuthToken and Configuration instance

Methods

mixed
getLogger()

No description

__construct(MangoPayApi $root)

Constructor Root/parent instance that holds the OAuthToken and Configuration instance

string
GetRequestUrl(string $key)

Get URL for REST Mango Pay API

RequestType
GetRequestType(string $key)

Get request type for REST Mango Pay API

GetApiVersion($key)

No description

object
CreateObject(string $methodKey, object $entity, object $responseClassName = null, string $entityId = null, $subEntityId = null, $idempotencyKey = null)

Create object in API

object
CreateOrUpdateMultipartObject(string $methodKey, string $file, string $fileName, string $responseClassName = null, string $entityId = null, string $idempotencyKey = null)

No description

object
GetObject(string $methodKey, object $responseClassName, $firstEntityId = null, $secondEntityId = null, $thirdEntityId = null, $clientIdRequired = true)

Get entity object from API

object
GetObjectManyQueryParams(string $methodKey, object $responseClassName, ...$queryParams)

Get entity object from API endpoint that has a lot of query params

object
GetObjectWithPagination(string $methodKey, object $responseClassName, $pagination = null, $filter = null, $clientIdRequired = true)

Get entity object from API on a request path that contains pagination and other query params

object[]
GetList(string $methodKey, Pagination $pagination, object $responseClassName = null, string $entityId = null, object $filter = null, Sorting $sorting = null, $secondEntityId = null, $clientIdRequired = true)

Get lst with entities object from API

object
SaveObject(string $methodKey, object $entity, object $responseClassName = null, $secondEntityId = null, $thirdEntityId = null)

Save object in API

DeleteObject($methodKey, $entity, $responseClassName = null)

No description

object
ExecutePostRequest($methodKey, $entity, $responseClassName, $entityId = null, $idempotency_key = null)

Executes a POST request

Error
CastResponseToError(object $response)

Cast response object to an error object

CastResponseToEntity(object $response, string $entityClassName, $asDependentObject = false)

Cast response object to entity object

array
BuildRequestData(object $entity)

Get array with request data

GetObjectForIdempotencyUrl($url)

No description

Details

at line 19
protected mixed getLogger()

No description

Return Value

mixed

at line 312
__construct(MangoPayApi $root)

Constructor Root/parent instance that holds the OAuthToken and Configuration instance

Parameters

MangoPayApi $root

at line 322
protected string GetRequestUrl(string $key)

Get URL for REST Mango Pay API

Parameters

string $key

Key with data

Return Value

string

at line 332
protected RequestType GetRequestType(string $key)

Get request type for REST Mango Pay API

Parameters

string $key

Key with data

Return Value

RequestType

at line 337
protected GetApiVersion($key)

No description

Parameters

$key

at line 353
protected object CreateObject(string $methodKey, object $entity, object $responseClassName = null, string $entityId = null, $subEntityId = null, $idempotencyKey = null)

Create object in API

Parameters

string $methodKey

Key with request data
object $entity

Entity object
object $responseClassName

Name of entity class from response
string $entityId

Entity identifier
$subEntityId
$idempotencyKey

Return Value

object

Response data

at line 392
protected object CreateOrUpdateMultipartObject(string $methodKey, string $file, string $fileName, string $responseClassName = null, string $entityId = null, string $idempotencyKey = null)

No description

Parameters

string $methodKey

Key with request data
string $file

The file content (raw binary string)
string $fileName

The file name
string $responseClassName

Name of entity class from response
string $entityId

Optional entity identifier
string $idempotencyKey

Optional idempotency key

Return Value

object

Response data

Exceptions

Exception

at line 421
protected object GetObject(string $methodKey, object $responseClassName, $firstEntityId = null, $secondEntityId = null, $thirdEntityId = null, $clientIdRequired = true)

Get entity object from API

Parameters

string $methodKey

Key with request data
object $responseClassName

Name of entity class from response
$firstEntityId
$secondEntityId
$thirdEntityId
$clientIdRequired

Return Value

object

Response data

Exceptions

Exception

at line 450
protected object GetObjectManyQueryParams(string $methodKey, object $responseClassName, ...$queryParams)

Get entity object from API endpoint that has a lot of query params

Parameters

string $methodKey

Key with request data
object $responseClassName

Name of entity class from response
...$queryParams

Return Value

object

Response data

Exceptions

Exception

at line 470
protected object GetObjectWithPagination(string $methodKey, object $responseClassName, $pagination = null, $filter = null, $clientIdRequired = true)

Get entity object from API on a request path that contains pagination and other query params

Parameters

string $methodKey

Key with request data
object $responseClassName

Name of entity class from response
$pagination
$filter
$clientIdRequired

Return Value

object

Response data

Exceptions

Exception

at line 508
protected object[] GetList(string $methodKey, Pagination $pagination, object $responseClassName = null, string $entityId = null, object $filter = null, Sorting $sorting = null, $secondEntityId = null, $clientIdRequired = true)

Get lst with entities object from API

Parameters

string $methodKey

Key with request data
Pagination $pagination

Pagination object
object $responseClassName

Name of entity class from response
string $entityId

Entity identifier
object $filter

Object to filter data
Sorting $sorting

Object to sorting data
$secondEntityId
$clientIdRequired

Return Value

object[]

Response data

at line 546
protected object SaveObject(string $methodKey, object $entity, object $responseClassName = null, $secondEntityId = null, $thirdEntityId = null)

Save object in API

Parameters

string $methodKey

Key with request data
object $entity

Entity object to save
object $responseClassName

Name of entity class from response
$secondEntityId
$thirdEntityId

Return Value

object

Response data

at line 574
protected DeleteObject($methodKey, $entity, $responseClassName = null)

No description

Parameters

$methodKey
$entity
$responseClassName

at line 600
protected object ExecutePostRequest($methodKey, $entity, $responseClassName, $entityId = null, $idempotency_key = null)

Executes a POST request

Parameters

$methodKey

Key with request data
$entity

Entity object
$responseClassName

Name of entity class from response
$entityId

Entity identifier
$idempotency_key

Return Value

object

Response data

at line 625
protected Error CastResponseToError(object $response)

Cast response object to an error object

Parameters

object $response

Object from API response

Return Value

Error

The error

at line 661
protected CastResponseToEntity(object $response, string $entityClassName, $asDependentObject = false)

Cast response object to entity object

Parameters

object $response

Object from API response
string $entityClassName

Name of entity class to cast
$asDependentObject

at line 776
protected array BuildRequestData(object $entity)

Get array with request data

Parameters

object $entity

Entity object to send as request data

Return Value

array

at line 837
protected GetObjectForIdempotencyUrl($url)

No description

Parameters

$url