class AuthorizationTokenManager extends ApiBase (View source)

Authorization token manager

Properties

protected MangoPayApi $_root

Root/parent instance that holds the OAuthToken and Configuration instance

from  ApiBase

Methods

mixed
getLogger()

No description

from  ApiBase
__construct($root)

Constructor

string
GetRequestUrl(string $key)

Get URL for REST Mango Pay API

from  ApiBase
GetRequestType(string $key)

Get request type for REST Mango Pay API

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

Create object in API

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

Get entity object from API

from  ApiBase
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

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

Save object in API

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

Executes a POST request

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

Cast response object to entity object

from  ApiBase
array
BuildRequestData(object $entity)

Get array with request data

from  ApiBase
GetObjectForIdempotencyUrl($url)

No description

from  ApiBase
GetToken($autenticationKey)

Gets the current authorization token.

StoreToken(OAuthToken $token)

Stores authorization token passed as an argument in the underlying storage strategy implementation.

RegisterCustomStorageStrategy(IStorageStrategy $customStorageStrategy)

Registers custom storage strategy implementation.

Details

protected mixed getLogger()

No description

Return Value

mixed

__construct($root)

Constructor

Parameters

$root

protected string GetRequestUrl(string $key)

Get URL for REST Mango Pay API

Parameters

string $key

Key with data

Return Value

string

protected RequestType GetRequestType(string $key)

Get request type for REST Mango Pay API

Parameters

string $key

Key with data

Return Value

RequestType

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

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

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

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

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

Executes a POST request

Parameters

$methodKey

Key with request data

$entity

Entity object

$responseClassName

Name of entity class from response

$entityId

Entity identifier

Return Value

object

Response data

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

protected array BuildRequestData(object $entity)

Get array with request data

Parameters

object $entity

Entity object to send as request data

Return Value

array

protected GetObjectForIdempotencyUrl($url)

No description

Parameters

$url

OAuthToken GetToken($autenticationKey)

Gets the current authorization token.

In the very first call, this method creates a new token before returning. If currently stored token is expired, this method creates a new one.

Parameters

$autenticationKey

Return Value

OAuthToken

Valid OAuthToken instance.

StoreToken(OAuthToken $token)

Stores authorization token passed as an argument in the underlying storage strategy implementation.

Parameters

OAuthToken $token

Token instance to be stored.

RegisterCustomStorageStrategy(IStorageStrategy $customStorageStrategy)

Registers custom storage strategy implementation.

By default, the DefaultStorageStrategy instance is used. There is no need to explicitly call this method until some more complex storage implementation is needed.

Parameters

IStorageStrategy $customStorageStrategy

IStorageStrategy interface implementation.