API Documentation

Zend/Service/Amazon.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
Amazon  
Version
$Id: Amazon.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_Amazon

Package: Zend\Service\Amazon

Children
\Zend_Service_Amazon_Query
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_baseUri= 'null'

Default valuenullDetails
Type
string
Propertyprotectedarray  $_baseUriList= 'array('US' => 'http://webservices.amazon.com''

List of Amazon Web Service base URLs, indexed by country code

Default valuearray('US' => 'http://webservices.amazon.com'Details
Type
array
Propertyprotected\Zend_Rest_Client  $_rest= 'null'

Reference to REST client object

Default valuenullDetails
Type
\Zend_Rest_Client
Propertyprotectedstring  $_secretKey= 'null'

Default valuenullDetails
Type
string
Propertypublicstring  $appId= ''

Amazon Web Services Access Key ID

Details
Type
string

Methods

methodpublic__construct( string $appId, string $countryCode = 'US',  $secretKey = null ) : \Zend_Service_Amazon

Constructs a new Amazon Web Services Client

Parameters
Name Type Description
$appId string

Developer's Amazon appid

$countryCode string

Country code for Amazon service; may be US, UK, DE, JP, FR, CA

$secretKey
Returns
Type Description
\Zend_Service_Amazon
Throws
Exception Description
\Zend_Service_Exception
methodprotected_checkErrors( \DOMDocument $dom ) : void
static

Check result for errors

Parameters
Name Type Description
$dom \DOMDocument
Throws
Exception Description
\Zend_Service_Exception
methodprotected_prepareOptions( string $query, array $options, array $defaultOptions ) : array

Prepare options for request

Parameters
Name Type Description
$query string

Action to perform

$options array

User supplied options

$defaultOptions array

Default options

Returns
Type Description
array
methodpublicbuildRawSignature( string $baseUri, array $options ) : string
static

Build the Raw Signature Text

Parameters
Name Type Description
$baseUri string
$options array
Returns
Type Description
string
methodpubliccomputeSignature( string $baseUri, string $secretKey, array $options ) : string
static

Compute Signature for Authentication with Amazon Product Advertising Webservices

Parameters
Name Type Description
$baseUri string
$secretKey string
$options array
Returns
Type Description
string
methodpublicgetRestClient( ) : \Zend_Rest_Client

Returns a reference to the REST client

Returns
Type Description
\Zend_Rest_Client
methodpublicitemLookup( string $asin, array $options = array() ) : \Zend_Service_Amazon_Item|\Zend_Service_Amazon_ResultSet

Look up item(s) by ASIN

Parameters
Name Type Description
$asin string

Amazon ASIN ID

$options array

Query Options

Returns
Type Description
\Zend_Service_Amazon_Item|\Zend_Service_Amazon_ResultSet
Throws
Exception Description
\Zend_Service_Exception
Details
See
\http://www.amazon.com/gp/aws/sdk/main.html/102-9041115-9057709?s=AWSEcommerceService&v=2005-10-05&p=ApiReference/ItemLookupOperation  
methodpublicitemSearch( array $options ) : \Zend_Service_Amazon_ResultSet

Search for Items

Parameters
Name Type Description
$options array

Options to use for the Search Query

Returns
Type Description
\Zend_Service_Amazon_ResultSet
Throws
Exception Description
\Zend_Service_Exception
Details
See
\http://www.amazon.com/gp/aws/sdk/main.html/102-9041115-9057709?s=AWSEcommerceService&v=2005-10-05&p=ApiReference/ItemSearchOperation  
methodpublicsetRestClient(  $client ) : \Zend_Service_Amazon

Set REST client

Parameters
Name Type Description
$client

Zend_Rest_Client

Returns
Type Description
\Zend_Service_Amazon
Documentation was generated by DocBlox 0.15.1.