Documentation

AmazonFinancialGroupList extends AmazonFinanceCore
in package

Application

implements Iterator

Pulls a list of financial event groups from Amazon.

This Amazon Finance Core object retrieves a list of financial event groups from Amazon. In order to do this, a start date is required. This object can use tokens when retrieving the list.

Interfaces, Classes and Traits

Iterator

$config : mixed
$env : mixed
$i : mixed
$index : mixed
$list : mixed
$marketplaceId : mixed
$mockFiles : mixed
$mockIndex : mixed
$mockMode : mixed
$options : mixed
$proxyInfo : mixed
$rawResponses : mixed
$storeName : mixed
$throttleCount : mixed
$throttleGroup : mixed
$throttleLimit : mixed
$throttleSafe : mixed
$throttleStop : mixed
$throttleTime : mixed
$tokenFlag : mixed
$tokenUseFlag : mixed
$urlbase : mixed
$urlbranch : mixed
current() : type: Iterator function
fetchGroupList() : bool: Fetches a list of financial event groups from Amazon.
fetchURL() : array<string|int, mixed>: Get url or send POST data
getAccountTail() : string|bool: Returns the account tail for the specified entry.
getBeginningBalance() : array<string|int, mixed>|string|bool: Returns the balance at the beginning of the settlement period for the specified entry.
getConvertedTotal() : array<string|int, mixed>|string|bool: Returns the converted total for the specified entry.
getEndDate() : string|bool: Returns the end date for the specified entry.
getGroupId() : string|bool: Returns the ID for the specified entry.
getGroups() : array<string|int, mixed>|bool: Returns all financial event groups.
getLastResponse() : array<string|int, mixed>|bool: Gives the latest response data received from Amazon.
getOptions() : array<string|int, mixed>: Returns options array.
getOriginalTotal() : array<string|int, mixed>|string|bool: Returns the original total for the specified entry.
getProcessingStatus() : string|bool: Returns the processing status for the specified entry.
getRawResponses() : array<string|int, mixed>|bool: Gives all response code received from Amazon.
getStartDate() : string|bool: Returns the start date for the specified entry.
getThrottleCountForLastRequest() : int: Gives the number of times the last call to sendRequest was throttled
getTraceId() : string|bool: Returns the trace ID for the specified entry.
getTransferDate() : string|bool: Returns the transfer date for the specified entry.
getTransferStatus() : string|bool: Returns the transfer status for the specified entry.
hasToken() : bool: Returns whether or not a token is available.
key() : type: Iterator function
next() : mixed: Iterator function
rewind() : mixed: Iterator function
setConfig() : mixed
setMaxResultsPerPage() : bool: Sets the maximum number of responses per page. (Optional)
setMock() : mixed: Enables or disables Mock Mode for the object.
setStore() : mixed: Sets the store values.
setThrottleStop() : mixed: Enables or disables the throttle stop.
setTimeLimits() : bool: Sets the time frame options. (Required*)
setUseToken() : bool: Sets whether or not the object should automatically use tokens if it receives one.
valid() : type: Iterator function
__construct() : mixed: AmazonCore constructor sets up key information used in all Amazon requests.
_calculateStringToSignV2() : string: generates the string to sign, copied from Amazon
_getParametersAsString() : string: Fuses all of the parameters together into a string, copied from Amazon
_sign() : string: Runs the hash, copied from Amazon
_signParameters() : string: validates signature and sets up signing of them, copied from Amazon
_urlencode() : string: Reformats the provided string using rawurlencode while also replacing ~, copied from Amazon
checkResponse() : bool: Checks whether or not the response is OK.
checkToken() : bool: Checks for a token and changes the proper options
fetchMockFile() : SimpleXMLObject|string|bool: Fetches the given mock file, or attempts to.
fetchMockResponse() : bool|array<string|int, mixed>: Generates a fake HTTP response using the mock file list.
genQuery() : string: Handles generation of the signed query string.
genTime() : string: Generates timestamp in ISO8601 format.
log() : bool: Writes a message to the log.
parseXml() : bool: Parses XML response into array.
prepareToken() : mixed: Sets up options for using tokens.
resetMock() : mixed: Sets mock index back to 0.
sendRequest() : array<string|int, mixed>: Sends a request to Amazon via cURL
sleep() : mixed: Sleeps for the throttle time and records to the log.

$config


    protected
        mixed
    $config

$env


    protected
        mixed
    $env

$i


    protected
        mixed
    $i
     = 0

$index


    protected
        mixed
    $index
     = 0

$list


    protected
        mixed
    $list

$marketplaceId


    protected
        mixed
    $marketplaceId

$mockFiles


    protected
        mixed
    $mockFiles

$mockIndex


    protected
        mixed
    $mockIndex
     = 0

$mockMode


    protected
        mixed
    $mockMode
     = false

$options


    protected
        mixed
    $options

$proxyInfo


    protected
        mixed
    $proxyInfo
     = []

$rawResponses


    protected
        mixed
    $rawResponses
     = []

$storeName


    protected
        mixed
    $storeName

$throttleCount


    protected
        mixed
    $throttleCount
     = 0

$throttleGroup


    protected
        mixed
    $throttleGroup

$throttleLimit


    protected
        mixed
    $throttleLimit

$throttleSafe


    protected
        mixed
    $throttleSafe

$throttleStop


    protected
        mixed
    $throttleStop
     = false

$throttleTime


    protected
        mixed
    $throttleTime

$tokenFlag


    protected
        mixed
    $tokenFlag
     = false

$tokenUseFlag


    protected
        mixed
    $tokenUseFlag
     = false

$urlbase


    protected
        mixed
    $urlbase

$urlbranch


    protected
        mixed
    $urlbranch

current()

Iterator function


    public
                current() : type

Return values

type —

fetchGroupList()

Fetches a list of financial event groups from Amazon.


    public
                fetchGroupList([bool $r = true ]) : bool

Submits a ListFinancialEventGroups request to Amazon. In order to do this, a start date must be set. Amazon will send the list back as a response, which can be retrieved using getGroups. Other methods are available for fetching specific values from the list. This operation can potentially involve tokens.

Parameters

$r : bool = true: [optional]
When set to FALSE, the function will not recurse, defaults to TRUE

Return values

bool —

FALSE if something goes wrong

fetchURL()

Get url or send POST data


    public
                fetchURL(string $url, array<string|int, mixed> $param) : array<string|int, mixed>

Parameters

$url : string
$param : array<string|int, mixed>: ['Header'] $param['Post']

Return values

array<string|int, mixed> —

$return['ok'] 1 - success, (0,-1) - fail $return['body'] - response $return['error'] - error, if "ok" is not 1 $return['head'] - http header

getAccountTail()

Returns the account tail for the specified entry.


    public
                getAccountTail(int $i) : string|bool

This method will return FALSE if the list has not yet been filled.

Parameters

$i : int: [optional]
List index to retrieve the value from. Defaults to 0.

Return values

string|bool —

single value, or FALSE if Non-numeric index

getBeginningBalance()

Returns the balance at the beginning of the settlement period for the specified entry.


    public
                getBeginningBalance(int $i[, bool $only = false ]) : array<string|int, mixed>|string|bool

This method will return FALSE if the list has not yet been filled. If an array is returned, it will have the fields Amount and CurrencyCode.

Parameters

$i : int: [optional]
List index to retrieve the value from. Defaults to 0.
$only : bool = false: [optional]
set to TRUE to get only the amount

Return values

array<string|int, mixed>|string|bool —

array, single value, or FALSE if Non-numeric index

getConvertedTotal()

Returns the converted total for the specified entry.


    public
                getConvertedTotal(int $i[, bool $only = false ]) : array<string|int, mixed>|string|bool

This method will return FALSE if the list has not yet been filled. If an array is returned, it will have the fields Amount and CurrencyCode.

Parameters

$i : int: [optional]
List index to retrieve the value from. Defaults to 0.
$only : bool = false: [optional]
set to TRUE to get only the amount

Return values

array<string|int, mixed>|string|bool —

array, single value, or FALSE if Non-numeric index

getEndDate()

Returns the end date for the specified entry.


    public
                getEndDate(int $i) : string|bool

This method will return FALSE if the list has not yet been filled.

Parameters

$i : int: [optional]
List index to retrieve the value from. Defaults to 0.

Return values

string|bool —

date in ISO 8601 format, or FALSE if Non-numeric index

getGroupId()

Returns the ID for the specified entry.


    public
                getGroupId(int $i) : string|bool

This method will return FALSE if the list has not yet been filled.

Parameters

$i : int: [optional]
List index to retrieve the value from. Defaults to 0.

Return values

string|bool —

single value, or FALSE if Non-numeric index

getGroups()

Returns all financial event groups.


    public
                getGroups() : array<string|int, mixed>|bool

Each financial event group array will have the following keys:

FinancialEventGroupId
ProcessingStatus - "Open" or "Closed"
FundTransferStatus
OriginalTotal - array

Amount - number
CurrencyCode - ISO 4217 currency code

ConvertedTotal - array with the fields Amount and CurrencyCode
FundTransferDate - ISO 8601 date format
TraceId
AccountTail
BeginningBalance - array with the fields Amount and CurrencyCode
FinancialEventGroupStart - ISO 8601 date format
FinancialEventGroupEnd - ISO 8601 date format

Return values

array<string|int, mixed>|bool —

multi-dimensional array, or FALSE if list not filled yet

getLastResponse()

Gives the latest response data received from Amazon.


    public
                getLastResponse([int $i = null ]) : array<string|int, mixed>|bool

Response arrays contain the following keys:

head - The raw HTTP head, including the response code and content length
body - The raw HTTP body, which will almost always be in XML format
code - The HTTP response code extracted from the head for convenience
answer - The HTTP response message extracted from the head for convenience
ok - Contains a 1 if the response was normal, or 0 if there was a problem
headarray - An associative array of the head data, for convenience

Parameters

$i : int = null: [optional]
If set, retrieves the specific response instead of the last one. If the index for the response is not used, FALSE will be returned.

Return values

array<string|int, mixed>|bool —

associative array of HTTP response or FALSE if not set yet

getOptions()

Returns options array.


    public
                getOptions() : array<string|int, mixed>

Gets the options for the object, for debugging or recording purposes. Note that this also includes key information such as your Amazon Access Key ID.

Return values

array<string|int, mixed> —

All of the options for the object.

getOriginalTotal()

Returns the original total for the specified entry.


    public
                getOriginalTotal(int $i[, bool $only = false ]) : array<string|int, mixed>|string|bool

This method will return FALSE if the list has not yet been filled. If an array is returned, it will have the fields Amount and CurrencyCode.

Parameters

$i : int: [optional]
List index to retrieve the value from. Defaults to 0.
$only : bool = false: [optional]
set to TRUE to get only the amount

Return values

array<string|int, mixed>|string|bool —

array, single value, or FALSE if Non-numeric index

getProcessingStatus()

Returns the processing status for the specified entry.


    public
                getProcessingStatus(int $i) : string|bool

This method will return FALSE if the list has not yet been filled.

Parameters

$i : int: [optional]
List index to retrieve the value from. Defaults to 0.

Return values

string|bool —

"Open" or "Closed", or FALSE if Non-numeric index

getRawResponses()

Gives all response code received from Amazon.


    public
                getRawResponses() : array<string|int, mixed>|bool

Return values

array<string|int, mixed>|bool —

list of associative arrays of HTTP response or FALSE if not set yet

getStartDate()

Returns the start date for the specified entry.


    public
                getStartDate(int $i) : string|bool

This method will return FALSE if the list has not yet been filled.

Parameters

$i : int: [optional]
List index to retrieve the value from. Defaults to 0.

Return values

string|bool —

date in ISO 8601 format, or FALSE if Non-numeric index

getThrottleCountForLastRequest()

Gives the number of times the last call to sendRequest was throttled


    public
                getThrottleCountForLastRequest() : int

Return values

int —

getTraceId()

Returns the trace ID for the specified entry.


    public
                getTraceId(int $i) : string|bool

This method will return FALSE if the list has not yet been filled.

Parameters

$i : int: [optional]
List index to retrieve the value from. Defaults to 0.

Return values

string|bool —

single value, or FALSE if Non-numeric index

getTransferDate()

Returns the transfer date for the specified entry.


    public
                getTransferDate(int $i) : string|bool

This method will return FALSE if the list has not yet been filled.

Parameters

$i : int: [optional]
List index to retrieve the value from. Defaults to 0.

Return values

string|bool —

date in ISO 8601 format, or FALSE if Non-numeric index

getTransferStatus()

Returns the transfer status for the specified entry.


    public
                getTransferStatus(int $i) : string|bool

This method will return FALSE if the list has not yet been filled.

Parameters

$i : int: [optional]
List index to retrieve the value from. Defaults to 0.

Return values

string|bool —

single value, or FALSE if Non-numeric index

hasToken()

Returns whether or not a token is available.


    public
                hasToken() : bool

Return values

bool —

key()

Iterator function


    public
                key() : type

Return values

type —

next()

Iterator function


    public
                next() : mixed

Return values

mixed —

rewind()

Iterator function


    public
                rewind() : mixed

Return values

mixed —

setConfig()


    public
                setConfig() : mixed

Return values

mixed —

setMaxResultsPerPage()

Sets the maximum number of responses per page. (Optional)


    public
                setMaxResultsPerPage(int $num) : bool

This method sets the maximum number of Financial Event Groups for Amazon to return per page. If this parameter is not set, Amazon will send 100 at a time.

Parameters

$num : int: Positive integer from 1 to 100.

Return values

bool —

FALSE if improper input

setMock()

Enables or disables Mock Mode for the object.


    public
                setMock([bool $b = true ][, array<string|int, mixed>|string|int $files = null ]) : mixed

Use this method when you want to test your object without sending actual requests to Amazon. When Mock Mode is enabled, responses are pulled from files you specify instead of sending the request. Be careful, as this means that the parameters you send will not necessarily match the response you get back. The files are pulled in order of the list, looping back to the first file after the last file is used. The log records every time a file is set or used, or if the file is missing. This method is also used to set response codes used by certain functions. Mock Mode is particularly useful when you need to test functions such as canceling orders or adding new products.

Parameters

$b : bool = true: [optional]
When set to TRUE, Mock Mode is enabled for the object. Defaults to TRUE.
$files : array<string|int, mixed>|string|int = null: [optional]
The list of files (or single file) to be used with Mock Mode. If a single string is given, this method will put it into an array. Integers can also be given, for use in fetchMockResponse. These numbers should only be response codes, such as 200 or 404.

Return values

mixed —

setStore()

Sets the store values.


    public
                setStore(string $s) : mixed

This method sets a number of key values from the config file. These values include your Merchant ID, Access Key ID, and Secret Key, and are critical for making requests with Amazon. If the store cannot be found in the config file, or if any of the key values are missing, the incident will be logged.

Parameters

$s : string: The store name to look for.

Return values

mixed —

setThrottleStop()

Enables or disables the throttle stop.


    public
                setThrottleStop([bool $b = true ]) : mixed

When the throttle stop is enabled, throttled requests will not be repeated. This setting is off by default.

Parameters

$b : bool = true: Defaults to TRUE.

Return values

mixed —

setTimeLimits()

Sets the time frame options. (Required*)


    public
                setTimeLimits(string $s[, string $e = null ]) : bool

This method sets the start and end times for the next request. If this parameter is set, Amazon will only return Financial Event Groups that occurred between the two times given. Only the starting time is required to fetch financial event groups. The parameters are passed through strtotime, so values such as "-1 hour" are fine.

Parameters

$s : string: A time string for the earliest time.
$e : string = null: [optional]
A time string for the latest time.

Return values

bool —

FALSE if improper input

setUseToken()

Sets whether or not the object should automatically use tokens if it receives one.


    public
                setUseToken([bool $b = true ]) : bool

If this option is set to TRUE, the object will automatically perform the necessary operations to retrieve the rest of the list using tokens. If this option is off, the object will only ever retrieve the first section of the list.

Parameters

$b : bool = true: [optional]
Defaults to TRUE

Return values

bool —

FALSE if improper input

valid()

Iterator function


    public
                valid() : type

Return values

type —

__construct()

AmazonCore constructor sets up key information used in all Amazon requests.


    protected
                __construct(string $s[, bool $mock = false ][, array<string|int, mixed>|string $m = null ]) : mixed

This constructor is called when initializing all objects in this library. The parameters are passed by the child objects' constructors.

Parameters

$s : string: Name for the store you want to use as seen in the config file. If this is not set to a valid name, none of these objects will work.
$mock : bool = false: [optional]
This is a flag for enabling Mock Mode. When this is set to TRUE, the object will fetch responses from files you specify instead of sending the requests to Amazon. The log will indicate whether mock mode is on or off each time an object is initialized. This defaults to FALSE.
$m : array<string|int, mixed>|string = null: [optional]
The files (or file) to use in Mock Mode. When Mock Mode is enabled, the object will retrieve one of these files from the list to use as a response. See setMock for more information.

Return values

mixed —

_calculateStringToSignV2()

generates the string to sign, copied from Amazon


    protected
                _calculateStringToSignV2(array<string|int, mixed> $parameters) : string

Parameters

$parameters : array<string|int, mixed>

Return values

string —

_getParametersAsString()

Fuses all of the parameters together into a string, copied from Amazon


    protected
                _getParametersAsString(array<string|int, mixed> $parameters) : string

Parameters

$parameters : array<string|int, mixed>

Return values

string —

_sign()

Runs the hash, copied from Amazon


    protected
                _sign(string $data, string $key, string $algorithm) : string

Parameters

$data : string
$key : string
$algorithm : string: 'HmacSHA1' or 'HmacSHA256'

Return values

string —

_signParameters()

validates signature and sets up signing of them, copied from Amazon


    protected
                _signParameters(array<string|int, mixed> $parameters, string $key) : string

Parameters

$parameters : array<string|int, mixed>
$key : string

Return values

string —

signed string

_urlencode()

Reformats the provided string using rawurlencode while also replacing ~, copied from Amazon


    protected
                _urlencode(string $value) : string

Almost the same as using rawurlencode

Parameters

$value : string

Return values

string —

checkResponse()

Checks whether or not the response is OK.


    protected
                checkResponse(array<string|int, mixed> $r) : bool

Verifies whether or not the HTTP response has the 200 OK code. If the code is not 200, the incident and error message returned are logged.

Parameters

$r : array<string|int, mixed>: The HTTP response array. Expects the array to have the fields code, body, and error.

Return values

bool —

TRUE if the status is 200 OK, FALSE otherwise.

checkToken()

Checks for a token and changes the proper options


    protected
                checkToken(SimpleXMLObject $xml) : bool

Parameters

$xml : SimpleXMLObject: response data

Return values

bool —

FALSE if no XML data

fetchMockFile()

Fetches the given mock file, or attempts to.


    protected
                fetchMockFile([bool $load = true ]) : SimpleXMLObject|string|bool

This method is only called when Mock Mode is enabled. This is where files from the mock file list are retrieved and passed back to the caller. The success or failure of the operation will be recorded in the log, including the name and path of the file involved. For retrieving response codes, see fetchMockResponse.

Parameters

$load : bool = true: [optional]
Set this to FALSE to prevent the method from loading the file's contents into a SimpleXMLObject. This is for when the contents of the file are not in XML format, or if you simply want to retrieve the raw string of the file.

Return values

SimpleXMLObject|string|bool —

A SimpleXMLObject holding the contents of the file, or a string of said contents if $load is set to FALSE. The return will be FALSE if the file cannot be fetched for any reason.

fetchMockResponse()

Generates a fake HTTP response using the mock file list.


    protected
                fetchMockResponse() : bool|array<string|int, mixed>

This method uses the response codes in the mock file list to generate an HTTP response. The success or failure of this operation will be recorded in the log, including the response code returned. This is only used by a few operations. The response array will contain the following fields:

head - ignored, but set for the sake of completion
body - empty XML, also ignored
code - the response code fetched from the list
answer - answer message
error - error message, same value as answer, not set if status is 200
ok - 1 or 0, depending on if the status is 200

Return values

bool|array<string|int, mixed> —

An array containing the HTTP response, or simply the value FALSE if the response could not be found or does not match the list of valid responses.

genQuery()

Handles generation of the signed query string.


    protected
                genQuery() : string

This method uses the secret key from the config file to generate the signed query string. It also handles the creation of the timestamp option prior.

Return values

string —

query string to send to cURL

genTime()

Generates timestamp in ISO8601 format.


    protected
                genTime([string $time = false ]) : string

This method creates a timestamp from the provided string in ISO8601 format. The string given is passed through strtotime before being used. The value returned is actually 30 seconds early, to prevent it from tripping up Amazon. If no time is given, the current time is used.

Parameters

$time : string = false: [optional]
The time to use. Since this value is passed through strtotime first, values such as "-1 hour" are fine. Defaults to the current time.

Return values

string —

Unix timestamp of the time, minus 30 seconds.

log()

Writes a message to the log.


    protected
                log(string $msg[, string $level = 'Info' ]) : bool

This method adds a message line to the log file defined by the config. This includes the priority level, user IP, and a backtrace of the call.

Parameters

$msg : string: The message to write to the log.
$level : string = 'Info': [optional]
The priority level of the message. This is merely for the benefit of the user and does not affect how the code runs. The values used in this library are "Info", "Warning", "Urgent", and "Throttle".

Return values

bool —

FALSE if the message is empty, NULL if logging is muted

parseXml()

Parses XML response into array.


    protected
                parseXml(SimpleXMLElement $xml) : bool

This is what reads the response XML and converts it into an array.

Parameters

$xml : SimpleXMLElement: The XML response from Amazon.

Return values

bool —

FALSE if no XML data is found

prepareToken()

Sets up options for using tokens.


    protected
                prepareToken() : mixed

This changes key options for switching between simply fetching a list and fetching the rest of a list using a token. Please note: because the operation for using tokens does not use any other parameters, all other parameters will be removed.

Return values

mixed —

resetMock()

Sets mock index back to 0.


    protected
                resetMock([bool $mute = false ]) : mixed

This method is used for returning to the beginning of the mock file list.

Parameters

$mute : bool = false: [optional]
Set to TRUE to prevent logging.

Return values

mixed —

sendRequest()

Sends a request to Amazon via cURL


    protected
                sendRequest(string $url[, array<string|int, mixed> $param = [] ]) : array<string|int, mixed>

This method will keep trying if the request was throttled.

Parameters

$url : string: URL to feed to cURL
$param : array<string|int, mixed> = []: parameter array to feed to cURL

Return values

array<string|int, mixed> —

cURL response array

sleep()

Sleeps for the throttle time and records to the log.


    protected
                sleep() : mixed

Return values

mixed —