Documentation

AmazonSubscription extends AmazonSubscriptionCore
in package

Application

Creates a subscription on Amazon or updates it, or registers subscription destinations.

This Amazon Subscriptions Core object creates or updates subscriptions and subscription destinations on Amazon for a particular marketplace. In order to do any of these actions, a marketplace ID is needed in addition to a destination's delivery channel and list of attributes. The current store's configured marketplace is used by default. In order to fetch or delete a subscription, a notification type is also needed. In order to create a subscription, an indicator of whether or not the subscription is enabled is required in addition to a notification type.

$config : mixed
$data : mixed
$env : 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
$urlbase : mixed
$urlbranch : mixed
createSubscription() : bool: Creates a subscription on Amazon.
deleteSubscription() : bool: Deletes a subscription on Amazon.
deregisterDestination() : bool: Deregisters a subscription destination on Amazon.
fetchSubscription() : bool: Fetches a subscription from Amazon.
fetchURL() : array<string|int, mixed>: Get url or send POST data
getAttributes() : array<string|int, mixed>|bool: Returns the attribute list for the retrieved subscription's destination.
getDeliveryChannel() : string|bool: Returns the delivery channel for the retrieved subscription's destination.
getIsEnabled() : string|bool: Returns whether the retrieved subscription is enabled or not.
getLastResponse() : array<string|int, mixed>|bool: Gives the latest response data received from Amazon.
getNotificationType() : string|bool: Returns the notification type for the retrieved subscription.
getOptions() : array<string|int, mixed>: Returns options array.
getRawResponses() : array<string|int, mixed>|bool: Gives all response code received from Amazon.
getSubscription() : array<string|int, mixed>|bool: Returns the full array of subscription information.
getThrottleCountForLastRequest() : int: Gives the number of times the last call to sendRequest was throttled
registerDestination() : bool: Registers a subscription destination on Amazon.
setAttributes() : bool: Sets the destination attributes. (Required)
setConfig() : mixed
setDeliveryChannel() : bool: Sets the delivery channel. (Required)
setIsEnabled() : mixed: Sets whether or not the subscription is enabled. (Required for subscriptions)
setMarketplace() : bool: Sets the marketplace associated with the subscription or destination. (Optional)
setMock() : mixed: Enables or disables Mock Mode for the object.
setNotificationType() : bool: Sets the notification type. (Required for subscriptions)
setStore() : mixed: Sets the store values.
setThrottleStop() : mixed: Enables or disables the throttle stop.
testDestination() : bool: Sends a request to Amazon to send a test notification to a subscription destination.
updateSubscription() : bool: Updates a subscription on Amazon.
__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.
prepareCreate() : mixed: Sets up options for using createSubscription.
prepareDelete() : mixed: Sets up options for using deleteSubscription.
prepareDeregister() : mixed: Sets up options for using deregisterDestination.
prepareGet() : mixed: Sets up options for using fetchSubscription.
prepareRegister() : mixed: Sets up options for using registerDestination.
prepareTest() : mixed: Sets up options for using testDestination.
prepareUpdate() : mixed: Sets up options for using updateSubscription.
resetAttributes() : mixed: Resets the destination attribute options.
resetDestinationParams() : mixed: Resets the destination-specific parameters.
resetMock() : mixed: Sets mock index back to 0.
resetSubscriptionParams() : mixed: Resets the subscription-specific parameters.
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

$data


    protected
        mixed
    $data

$env


    protected
        mixed
    $env

$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

$urlbase


    protected
        mixed
    $urlbase

$urlbranch


    protected
        mixed
    $urlbranch

createSubscription()

Creates a subscription on Amazon.


    public
                createSubscription() : bool

Submits a CreateSubscription request to Amazon. Amazon will send back an empty response. The following parameters are required: marketplace ID, delivery channel, attributes, notification type, and enabled status.

Return values

bool —

FALSE if something goes wrong

deleteSubscription()

Deletes a subscription on Amazon.


    public
                deleteSubscription() : bool

Submits a DeleteSubscription request to Amazon. Amazon will send back an empty response. The following parameters are required: marketplace ID, delivery channel, attributes, notification type, and enabled status.

Return values

bool —

FALSE if something goes wrong

deregisterDestination()

Deregisters a subscription destination on Amazon.


    public
                deregisterDestination() : bool

Submits a DeregisterDestination request to Amazon. Amazon will send back an empty response. The following parameters are required: marketplace ID, delivery channel, and attributes.

Return values

bool —

FALSE if something goes wrong

fetchSubscription()

Fetches a subscription from Amazon.


    public
                fetchSubscription() : bool

Submits a GetSubscription request to Amazon. Amazon will send the data back as a response, which can be retrived using getSubscription. The following parameters are required: marketplace ID, delivery channel, attributes, notification type, and enabled status.

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

getAttributes()

Returns the attribute list for the retrieved subscription's destination.


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

See setAttributes for list of possible keys. This method will return FALSE if the data has not been set yet.

Return values

array<string|int, mixed>|bool —

associative array, or FALSE if not set yet

getDeliveryChannel()

Returns the delivery channel for the retrieved subscription's destination.


    public
                getDeliveryChannel() : string|bool

See setDeliveryChannel for list of possible values. This method will return FALSE if the data has not been set yet.

Return values

string|bool —

single value, or FALSE if not set yet

getIsEnabled()

Returns whether the retrieved subscription is enabled or not.


    public
                getIsEnabled() : string|bool

Note that this method will return the string "false" if Amazon indicates that the subscription is not enabled. This method will return boolean FALSE if the date has not been set yet.

Return values

string|bool —

"true" or "false", or FALSE if not set 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

getNotificationType()

Returns the notification type for the retrieved subscription.


    public
                getNotificationType() : string|bool

See setNotificationType for list of possible values. This method will return FALSE if the data has not been set yet.

Return values

string|bool —

single value, 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.

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

getSubscription()

Returns the full array of subscription information.


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

This method will return FALSE if the response data has not yet been filled. The returned array will have the following fields:

NotificationType - see setNotificationType for list of valid values
IsEnabled - "true" or "false"
Destination - array

DeliveryChannel - see setDeliveryChannel for list of valid values
AttributeList - array of key/value pairs

Return values

array<string|int, mixed>|bool —

data array, or FALSE if list not filled yet

getThrottleCountForLastRequest()

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


    public
                getThrottleCountForLastRequest() : int

Return values

int —

registerDestination()

Registers a subscription destination on Amazon.


    public
                registerDestination() : bool

Submits a RegisterDestination request to Amazon. Amazon will send back an empty response. The following parameters are required: marketplace ID, delivery channel, and attributes.

Return values

bool —

FALSE if something goes wrong

setAttributes()

Sets the destination attributes. (Required)


    public
                setAttributes(array<string|int, mixed> $a) : bool

This parameter is required for performing any actions with subscription destinations. The array provided should be an array of key/value pairs. Possible attribute keys: "sqsQueueUrl".

Parameters

$a : array<string|int, mixed>: Array of key/value pairs

Return values

bool —

FALSE if improper input

setConfig()


    public
                setConfig() : mixed

Return values

mixed —

setDeliveryChannel()

Sets the delivery channel. (Required)


    public
                setDeliveryChannel(string $s) : bool

This parameter is required for performing any actions with subscription destinations. Possible delivery channel values: "SQS".

Parameters

$s : string: Delivery channel

Return values

bool —

FALSE if improper input

setIsEnabled()

Sets whether or not the subscription is enabled. (Required for subscriptions)


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

This parameter is required for performing any actions with subscriptions.

Parameters

$b : bool = true: Defaults to TRUE

Return values

mixed —

setMarketplace()

Sets the marketplace associated with the subscription or destination. (Optional)


    public
                setMarketplace(string $m) : bool

The current store's configured marketplace is used by default.

Parameters

$m : string: Marketplace ID

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 —

setNotificationType()

Sets the notification type. (Required for subscriptions)


    public
                setNotificationType(string $s) : bool

This parameter is required for performing any actions with subscriptions.

Parameters

$s : string: See the comment inside for a list of valid values.

Return values

bool —

FALSE if improper input

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 —

testDestination()

Sends a request to Amazon to send a test notification to a subscription destination.


    public
                testDestination() : bool

Submits a SendTestNotificationToDestination request to Amazon. Amazon will send back an empty response. The following parameters are required: marketplace ID, delivery channel, and attributes.

Return values

bool —

FALSE if something goes wrong

updateSubscription()

Updates a subscription on Amazon.


    public
                updateSubscription() : bool

Submits an UpdateSubscription request to Amazon. Amazon will send back an empty response. The following parameters are required: marketplace ID, delivery channel, attributes, notification type, and enabled status.

Return values

bool —

FALSE if something goes wrong

__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

prepareCreate()

Sets up options for using createSubscription.


    protected
                prepareCreate() : mixed

This changes key options for using createSubscription.

Return values

mixed —

prepareDelete()

Sets up options for using deleteSubscription.


    protected
                prepareDelete() : mixed

This changes key options for using deleteSubscription. Please note: because this operation does not use all of the parameters, the enabled status parameter is removed.

Return values

mixed —

prepareDeregister()

Sets up options for using deregisterDestination.


    protected
                prepareDeregister() : mixed

This changes key options for using deregisterDestination. Please note: because this operation does not use all of the parameters, some of the parameters will be removed. The following parameters are removed: notification type and enabled status.

Return values

mixed —

prepareGet()

Sets up options for using fetchSubscription.


    protected
                prepareGet() : mixed

This changes key options for using fetchSubscription. Please note: because this operation does not use all of the parameters, the enabled status parameter is removed.

Return values

mixed —

prepareRegister()

Sets up options for using registerDestination.


    protected
                prepareRegister() : mixed

This changes key options for using registerDestination. Please note: because this operation does not use all of the parameters, some of the parameters will be removed. The following parameters are removed: notification type and enabled status.

Return values

mixed —

prepareTest()

Sets up options for using testDestination.


    protected
                prepareTest() : mixed

This changes key options for using testDestination. Please note: because this operation does not use all of the parameters, some of the parameters will be removed. The following parameters are removed: notification type and enabled status.

Return values

mixed —

prepareUpdate()

Sets up options for using updateSubscription.


    protected
                prepareUpdate() : mixed

This changes key options for using updateSubscription.

Return values

mixed —

resetAttributes()

Resets the destination attribute options.


    protected
                resetAttributes() : mixed

Since the list of attributes is a required parameter, these options should not be removed without replacing them, so this method is not public.

Return values

mixed —

resetDestinationParams()

Resets the destination-specific parameters.


    protected
                resetDestinationParams() : mixed

Since these are required parameters, these options should not be removed without replacing them, so this method is not public.

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 —

resetSubscriptionParams()

Resets the subscription-specific parameters.


    protected
                resetSubscriptionParams() : mixed

Since these are required parameters, these options should not be removed without replacing them, so this method is not public.

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 —