Docs For Class Services

Services_Amazon (Constructor) [line 248]

Services_Amazon Services_Amazon(
string
$access_key_id, string
$secret_access_key, [string
$associate_tag = null])

Constructor

See: Services_Amazon::setBaseUrl()
See: Services_Amazon::setVersion()
See: Services_Amazon::setAssociateTag()
See: Services_Amazon::setSecretAccessKey()
See: Services_Amazon::setAccessKeyID()
Access: public

Parameters:

string	`$access_key_id`	—	An Amazon Access Key ID used when quering Amazon servers
string	`$secret_access_key`	—	An Amazon Secret Access Key used when quering Amazon servers
string	`$associate_tag`	—	An Amazon Associate Tag used in the URL's so a commision may be payed

[ Top ]

BrowseNodeLookup [line 549]

array BrowseNodeLookup(
string
$browsenode_id, [array
$options = array()])

Retrieves information about a browse node

Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $result = $amazon->BrowseNodeLookup('283155'); // 283155='Books'
 ?>

Return: The array of information returned by the query
Access: public

Parameters:

string	`$browsenode_id`	—	The browse node ID
array	`$options`	—	The optional parameters

[ Top ]

CartAdd [line 580]

array CartAdd(
string
$cart_id, string
$hmac, array
$item, [array
$options = array()])

Adds items to an existing remote shopping cart

Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $item = array('ASIN' => 'aaaaaaaaaa', 'Quantity' => 1);
 // $item = array(array('ASIN' => 'aaaaaaaaaa', 'Quantity' => 1),
 //               array('OfferListingId' => 'bbbbbbbbbb', 'Quantity' => 10),
 //               array('ASIN' => 'cccccccccc', 'Quantity' => 20));
 $result = $amazon->CartAdd('[Cart ID]', '[HMAC]', $item);
 ?>

Return: The array of information returned by the query
See: Services_Amazon::CartClear(), Services_Amazon::CartCreate(), Services_Amazon::CartModify()
Access: public

Parameters:

string	`$cart_id`	—	A unique identifier for a cart
string	`$hmac`	—	A unique security token
array	`$item`	—	Products and the quantities
array	`$options`	—	The optional parameters

[ Top ]

CartClear [line 600]

array CartClear(
string
$cart_id, string
$hmac, [array
$options = array()])

Removes all the contents of a remote shopping cart

Return: The array of information returned by the query
See: Services_Amazon::CartAdd(), Services_Amazon::CartCreate(), Services_Amazon::CartGet(), Services_Amazon::CartModify()
Access: public

Parameters:

string	`$cart_id`	—	A unique identifier for a cart
string	`$hmac`	—	A unique security token
array	`$options`	—	The optional parameters

[ Top ]

CartCreate [line 629]

array CartCreate(
array
$item, [array
$options = array()])

Creates a new remote shopping cart

Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $item = array('ASIN' => 'aaaaaaaaaa', 'Quantity' => 1);
 // $item = array(array('ASIN' => 'aaaaaaaaaa', 'Quantity' => 1),
 //               array('ASIN' => 'cccccccccc', 'Quantity' => 20));
 $result = $amazon->CartCreate($item);
 ?>

Return: The array of information returned by the query
See: Services_Amazon::CartAdd(), Services_Amazon::CartClear(), Services_Amazon::CartGet(), Services_Amazon::CartModify()
Access: public

Parameters:

array	`$item`	—	Products and the quantities
array	`$options`	—	The optional parameters

[ Top ]

CartGet [line 647]

array CartGet(
string
$cart_id, string
$hmac, [array
$options = array()])

Retrieves the contents of a remote shopping cart

Return: The array of information returned by the query
See: Services_Amazon::CartAdd(), Services_Amazon::CartClear(), Services_Amazon::CartCreate(), Services_Amazon::CartModify()
Access: public

Parameters:

string	`$cart_id`	—	A unique identifier for a cart
string	`$hmac`	—	A unique security token
array	`$options`	—	The optional parameters

[ Top ]

CartModify [line 679]

array CartModify(
string
$cart_id, string
$hmac, array
$item, [array
$options = array()])

Modifies the quantity of items in a cart and changes cart items to saved items

Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $item = array('CartItemId' => 'aaaaaaaaaa', 'Quantity' => 1);
 // $item = array('CartItemId' => 'aaaaaaaaaa', 'Action' => 'SaveForLater');
 // $item = array(array('CartItemId' => 'aaaaaaaaaa', 'Quantity' => 1),
 //               array('CartItemId' => 'cccccccccc', 'Quantity' => 20));
 $result = $amazon->CartModify('[Cart ID]', '[HMAC]', $item);
 ?>

Return: The array of information returned by the query
See: Services_Amazon::CartAdd(), Services_Amazon::CartClear(), Services_Amazon::CartCreate(), Services_Amazon::CartGet()
Access: public

Parameters:

string	`$cart_id`	—	A unique identifier for a cart
string	`$hmac`	—	A unique security token
array	`$item`	—	The CartItemId and the quantities or the Action
array	`$options`	—	The optional parameters

[ Top ]

CustomerContentLookup [line 698]

array CustomerContentLookup(
string
$customer_id, [array
$options = array()])

Retrieves publicly available content written by specific Amazon customers

Return: The array of information returned by the query
See: Services_Amazon::CustomerContentSearch()
Access: public

Parameters:

string	`$customer_id`	—	A customer ID
array	`$options`	—	The optional parameters

[ Top ]

CustomerContentSearch [line 715]

array CustomerContentSearch(
[array
$customer = null], [array
$options = array()])

Searches for Amazon customers by name or email address

Return: The array of information returned by the query
See: Services_Amazon::CustomerContentLookup()
Access: public

Parameters:

array	`$customer`	—	A customer's name or its email
array	`$options`	—	The optional parameters

[ Top ]

doBatch [line 1040]

array doBatch(
string
$operation, array
$shared, [array
$params1 = array()], [array
$params2 = array()])

Combines requests for the same operation into a single request

Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $shared = array('SearchIndex' => 'Books',
                 'Keywords' => 'php');
 $params1 = array('ItemPage' => '1');
 $params2 = array('ItemPage' => '2');
 $result = $amazon->doBatch('ItemSearch', $shared, $params1, $params2);
 ?>

Return: The array of information returned by the query
Access: public

Parameters:

string	`$operation`	—	The operation
array	`$shared`	—	Shared parameters
array	`$params1`	—	The parameters specific to the first request
array	`$params2`	—	The parameters specific to the second request

[ Top ]

doMultiOperation [line 1078]

array doMultiOperation(
string
$operation1, array
$params1, string
$operation2, array
$params2)

Combines the different operations into a single request

Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $params1 = array('SearchIndex' => 'Books',
                  'Title' => 'sushi');
 $params2 = array('Keywords' => 'tempura');
 $result = $amazon->doMultiOperation('ItemSearch', $params1,
                                     'SellerListingSearch', $params2);
 ?>

Return: The array of information returned by the query
Access: public

Parameters:

string	`$operation1`	—	The first operation
array	`$params1`	—	The parameters specific to the first request
string	`$operation2`	—	The second operation
array	`$params2`	—	The parameters specific to the second request

[ Top ]

getApiVersion [line 262]

string getApiVersion(
)

Retrieves the current version of this classes API

Return: The API version
Access: public

[ Top ]

getError [line 495]

array getError(
)

Retrieves the error code and message

 if (PEAR::isError($result)) {

     $error = $amazon->getError();
     echo $error['Code'];
     echo $error['Message'];
 }

Return: All errors
Access: public

[ Top ]

getErrors [line 476]

array getErrors(
)

Retrieves all error codes and messages

 if (PEAR::isError($result)) {

     foreach ($amazon->getErrors() as $error) {
         echo $error['Code'];
         echo $error['Message'];
     }
 }

Return: All errors
Access: public

[ Top ]

getLastUrl [line 517]

string getLastUrl(
)

Retrieves the last URL accessed to the Amazon (for debugging)

Return: The Last URL
Access: public

[ Top ]

getProcessingTime [line 506]

string getProcessingTime(
)

Retrieves the processing time

Return: Processing time
Access: public

[ Top ]

getRawResult [line 528]

string getRawResult(
)

Retrieves the raw result

Return: The raw result
Access: public

[ Top ]

Help [line 740]

array Help(
string
$help_type, string
$about, [array
$options = array()])

Retrieves information about operations and response groups

Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $result = $amazon->Help('Operation', 'ItemLookup');
 ?>

Return: The array of information returned by the query
Access: public

Parameters:

string	`$help_type`	—	The type of information
string	`$about`	—	The name of an operation or a response group
array	`$options`	—	The optional parameters

[ Top ]

ItemLookup [line 768]

array ItemLookup(
string
$item_id, [array
$options = array()])

Retrieves information for products

Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $options = array();
 $options['ResponseGroup'] = 'Large';
 $result = $amazon->ItemLookup('[ASIN(s)]', $options);
 ?>

Return: The array of information returned by the query
See: Services_Amazon::ItemSearch()
Access: public

Parameters:

string	`$item_id`	—	Product IDs
array	`$options`	—	The optional parameters

[ Top ]

ItemSearch [line 800]

array ItemSearch(
string
$search_index, [array
$options = array()])

Searches for products

Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $options = array();
 $options['Keywords'] = 'sushi';
 $options['Sort'] = 'salesrank';
 $options['ResponseGroup'] = 'ItemIds,ItemAttributes,Images';
 $result = $amazon->ItemSearch('Books', $options);
 ?>

Return: The array of information returned by the query
See: Services_Amazon::ItemLookup()
Access: public

Parameters:

string	`$search_index`	—	A search index
array	`$options`	—	The optional parameters

[ Top ]

ListLookup [line 818]

array ListLookup(
string
$list_type, string
$list_id, [array
$options = array()])

Retrieves products in a specific list

Return: The array of information returned by the query
See: Services_Amazon::ListSearch()
Access: public

Parameters:

string	`$list_type`	—	The type of list
string	`$list_id`	—	A list ID
array	`$options`	—	The optional parameters

[ Top ]

ListSearch [line 846]

array ListSearch(
string
$list_type, array
$keywords, [array
$options = array()])

Searches for a wish list, baby registry, or wedding registry

Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $keywords = array('Name' => 'hoge');
 $result = $amazon->ListSearch('WishList', $keywords);
 ?>

Return: The array of information returned by the query
See: Services_Amazon::ListLookup()
Access: public

Parameters:

string	`$list_type`	—	The type of list
array	`$keywords`	—	Parameters to search for
array	`$options`	—	The optional parameters

[ Top ]

SellerListingLookup [line 865]

array SellerListingLookup(
string
$id_type, string
$id, [array
$options = array()])

Retrieves information about Amazon zShops and Marketplace products

Return: The array of information returned by the query
See: Services_Amazon::SellerListingSearch()
Access: public

Parameters:

string	`$id_type`	—	The type of ID
string	`$id`	—	The exchange ID or the listing ID
array	`$options`	—	The optional parameters

[ Top ]

SellerListingSearch [line 892]

array SellerListingSearch(
string
$search_index, [array
$options = array()])

Searches for Amazon zShops and Marketplace products

Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $keywords = array('Keywords' => 'pizza');
 $result = $amazon->SellerListingSearch('zShops', $keywords);
 ?>

Return: The array of information returned by the query
See: Services_Amazon::SellerListingLookup()
Access: public

Parameters:

string	`$search_index`	—	The type of seller listings
array	`$options`	—	The optional parameters

[ Top ]

SellerLookup [line 908]

array SellerLookup(
string
$seller_id, [array
$options = array()])

Retrieves information about specific sellers

Return: The array of information returned by the query
Access: public

Parameters:

string	`$seller_id`	—	IDs for Amazon sellers
array	`$options`	—	The optional parameters

[ Top ]

setAccessKeyID [line 274]

void setAccessKeyID(
string
$access_key_id)

Sets an Access Key ID

Access: public

Parameters:

string $access_key_id — An Access Key ID

[ Top ]

setAssociateID [line 321]

void setAssociateID(
string
$associd)

Sets an Associate ID

Access: public

Parameters:

string $associd — An Associate ID

[ Top ]

setAssociateTag [line 310]

void setAssociateTag(
string
$associate_tag)

Sets an Associate Tag

Access: public

Parameters:

string $associate_tag — An Associate Tag

[ Top ]

setBaseUrl [line 333]

void setBaseUrl(
string
$url)

Sets the base URL

Access: public

Parameters:

string $url — The base url

[ Top ]

setCache [line 397]

mixed setCache(
[string
$container = 'file'], [array
$container_options = array()])

Enables caching the data

Requires Cache to be installed. Example:

 <?php

 $amazon = new Services_Amazon('[your Access Key ID here]', '[your Secret Access key here]');
 $amazon->setCache('file', array('cache_dir' => 'cache/'));
 $amazon->setCacheExpire(86400); // 86400 seconds = 24 hours
 $result = $amazon->BrowseNodeLookup('283155');
 ?>

Return: A PEAR_Error on error, a true on success
See: Services_Amazon::setCacheExpire()
Access: public

Parameters:

string	`$container`	—	Name of container class
array	`$container_options`	—	Array with container class options

[ Top ]

setCacheExpire [line 428]

void setCacheExpire(
integer
$secs)

Sets cache expire time

Amazon dictates that any prices that are displayed that may be over an hour old should be accompanied by some sort of timestamp. You can get around that by expiring any queries that use the time in an hour (3600 seconds).

See: Services_Amazon::setCache()
Access: public

Parameters:

integer $secs — Expire time in seconds

[ Top ]

setLocale [line 347]

mixed setLocale(
string
$locale)

Sets the locale passed when making a query to Amazon

Currently US, UK, DE, JP, FR, and CA are supported

Return: A PEAR_Error on error, a true on success
Access: public

Parameters:

string $locale — The new locale to use

[ Top ]

setProxy [line 442]

void setProxy(
string
$host, [int
$port = 8080], [string
$user = null], [string
$pass = null])

Sets a proxy

Access: public

Parameters:

string	`$host`	—	Proxy host
int	`$port`	—	Proxy port
string	`$user`	—	Proxy username
string	`$pass`	—	Proxy password

[ Top ]

setSecretAccessKey [line 298]

void setSecretAccessKey(

$secret_access_key, string
$subid)

Sets a Secret Access Key

Access: public

Parameters:

string	`$subid`	—	A Secret Access Key
	`$secret_access_key`	—

[ Top ]

setSubscriptionID [line 286]

void setSubscriptionID(
string
$subid)

Sets a Subscription ID (for backward compatibility)

Access: public

Parameters:

string $subid — A Subscription ID

[ Top ]

setTimestamp [line 456]

void setTimestamp(
integer
$time)

Sets a timestamp (for debugging)

Access: public

Parameters:

integer $time — A timestamp

[ Top ]

setVersion [line 372]

void setVersion(
string
$version)

Sets a version

Access: public

Parameters:

string $version — A service version

[ Top ]

SimilarityLookup [line 924]

array SimilarityLookup(
string
$item_id, [array
$options = array()])

Retrieves products that are similar to Amazon products

Return: The array of information returned by the query
Access: public

Parameters:

string	`$item_id`	—	Product IDs
array	`$options`	—	The optional parameters

[ Top ]

TagLookup [line 943]

array TagLookup(
string
$tag_name, [array
$options = array()])

Retrieves information about tags

Return: The array of information returned by the query
Access: public

Parameters:

string	`$tag_name`	—	List of tag names
array	`$options`	—	The optional parameters

[ Top ]

TransactionLookup [line 962]

array TransactionLookup(
string
$transaction_id, [array
$options = array()])

Retrieves information about the status of financial transactions

Return: The array of information returned by the query
Access: public

Parameters:

string	`$transaction_id`	—	Transaction IDs
array	`$options`	—	The optional parameters

[ Top ]

VehiclePartLookup [line 977]

array VehiclePartLookup(
[array
$options = array()])

Retrieves information about a car part

Return: The array of information returned by the query
Access: public

Parameters:

array $options — The optional parameters

[ Top ]

VehiclePartSearch [line 994]

array VehiclePartSearch(
string
$make_id, string
$model_id, string
$year, [array
$options = array()])

Searches the parts that work in the car

Return: The array of information returned by the query
Access: public

Parameters:

string	`$make_id`	—
string	`$model_id`	—
string	`$year`	—
array	`$options`	—	The optional parameters

[ Top ]

VehicleSearch [line 1011]

array VehicleSearch(
[array
$options = array()])

Searches all vehicles

Return: The array of information returned by the query
Access: public

Parameters:

array $options — The optional parameters

[ Top ]

Class: Services_Amazon

Class Overview

Author(s):

Version:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

Services_Amazon (Constructor) [line 248]

Parameters:

BrowseNodeLookup [line 549]

Parameters:

CartAdd [line 580]

Parameters:

CartClear [line 600]

Parameters:

CartCreate [line 629]

Parameters:

CartGet [line 647]

Parameters:

CartModify [line 679]

Parameters:

CustomerContentLookup [line 698]

Parameters:

CustomerContentSearch [line 715]

Parameters:

doBatch [line 1040]

Parameters:

doMultiOperation [line 1078]

Parameters:

getApiVersion [line 262]

getError [line 495]

getErrors [line 476]

getLastUrl [line 517]

getProcessingTime [line 506]

getRawResult [line 528]

Help [line 740]

Parameters:

ItemLookup [line 768]

Parameters:

ItemSearch [line 800]

Parameters:

ListLookup [line 818]

Parameters:

ListSearch [line 846]

Parameters:

SellerListingLookup [line 865]

Parameters:

SellerListingSearch [line 892]

Parameters:

SellerLookup [line 908]

Parameters:

setAccessKeyID [line 274]

Parameters:

setAssociateID [line 321]

Parameters:

setAssociateTag [line 310]

Parameters:

setBaseUrl [line 333]

Parameters:

setCache [line 397]

Parameters:

setCacheExpire [line 428]

Parameters:

setLocale [line 347]

Parameters:

setProxy [line 442]

Parameters:

setSecretAccessKey [line 298]

Parameters:

setSubscriptionID [line 286]

Parameters:

setTimestamp [line 456]

Parameters:

setVersion [line 372]

Parameters:

SimilarityLookup [line 924]

Parameters:

TagLookup [line 943]