Service/Amazon/Query.php

Show: PublicProtectedPrivateinherited
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: Query.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Service_Amazon_Query

Package: Zend\Service\Amazon
Parent(s)
\Zend_Service_Amazon
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_baseUri = null
inherited
Inherited from: \Zend_Service_Amazon::$$_baseUri
Default valuenullDetails
Type
string
Inherited_from
\Zend_Service_Amazon::$$_baseUri  
>VPropertyprotectedarray $_baseUriList = array('US' => 'http://webservices.amazon.com', 'UK' => 'http://webservices.amazon.co.uk', 'DE' => 'http://webservices.amazon.de', 'JP' => 'http://webservices.amazon.co.jp', 'FR' => 'http://webservices.amazon.fr', 'CA' => 'http://webservices.amazon.ca')
inherited
List of Amazon Web Service base URLs, indexed by country code
Inherited from: \Zend_Service_Amazon::$$_baseUriList
Default valuearray('US' => 'http://webservices.amazon.com', 'UK' => 'http://webservices.amazon.co.uk', 'DE' => 'http://webservices.amazon.de', 'JP' => 'http://webservices.amazon.co.jp', 'FR' => 'http://webservices.amazon.fr', 'CA' => 'http://webservices.amazon.ca')Details
Type
array
Inherited_from
\Zend_Service_Amazon::$$_baseUriList  
>VPropertyprotected\Zend_Rest_Client $_rest = null
inherited
Reference to REST client object
Inherited from: \Zend_Service_Amazon::$$_rest
Default valuenullDetails
Type
\Zend_Rest_Client
Inherited_from
\Zend_Service_Amazon::$$_rest  
>VPropertyprotectedarray $_search = array()
Search parameters
Default valuearray()Details
Type
array
>VPropertyprotectedstring $_searchIndex = null
Search index
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_secretKey = null
inherited
Inherited from: \Zend_Service_Amazon::$$_secretKey
Default valuenullDetails
Type
string
Inherited_from
\Zend_Service_Amazon::$$_secretKey  
>VPropertypublicstring $appId
inherited
Amazon Web Services Access Key ID
Inherited from: \Zend_Service_Amazon::$$appId
Details
Type
string
Inherited_from
\Zend_Service_Amazon::$$appId  

Methods

methodpublic__call(string $method, array $args) : \Zend_Service_Amazon_Query

Prepares query parameters

Parameters
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
\Zend_Service_Amazon_QueryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Service_Exception
methodpublic__construct(string $appId, string $countryCode = 'US',  $secretKey = null) : \Zend_Service_Amazon
inherited

Constructs a new Amazon Web Services Client

Inherited from: \Zend_Service_Amazon::__construct()
Parameters
NameTypeDescription
$appIdstring

Developer's Amazon appid

$countryCodestring

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

$secretKey
Returns
TypeDescription
\Zend_Service_Amazon
Throws
ExceptionDescription
\Zend_Service_Exception
methodprotected_checkErrors(\DOMDocument $dom) : void
staticinherited

Check result for errors

Inherited from: \Zend_Service_Amazon::_checkErrors()
Parameters
NameTypeDescription
$dom\DOMDocument
Throws
ExceptionDescription
\Zend_Service_Exception
methodprotected_prepareOptions(string $query, array $options, array $defaultOptions) : array
inherited

Prepare options for request

Inherited from: \Zend_Service_Amazon::_prepareOptions()
Parameters
NameTypeDescription
$querystring

Action to perform

$optionsarray

User supplied options

$defaultOptionsarray

Default options

Returns
TypeDescription
array
methodpublicbuildRawSignature(string $baseUri, array $options) : string
staticinherited

Build the Raw Signature Text

Inherited from: \Zend_Service_Amazon::buildRawSignature()
Parameters
NameTypeDescription
$baseUristring
$optionsarray
Returns
TypeDescription
string
methodpubliccomputeSignature(string $baseUri, string $secretKey, array $options) : string
staticinherited

Compute Signature for Authentication with Amazon Product Advertising Webservices

Inherited from: \Zend_Service_Amazon::computeSignature()
Parameters
NameTypeDescription
$baseUristring
$secretKeystring
$optionsarray
Returns
TypeDescription
string
methodpublicgetRestClient() : \Zend_Rest_Client
inherited

Returns a reference to the REST client

Inherited from: \Zend_Service_Amazon::getRestClient()
Returns
TypeDescription
\Zend_Rest_Client
methodpublicitemLookup(string $asin, array $options = array()) : \Zend_Service_Amazon_Item | \Zend_Service_Amazon_ResultSet
inherited

Look up item(s) by ASIN

Inherited from: \Zend_Service_Amazon::itemLookup()
Parameters
NameTypeDescription
$asinstring

Amazon ASIN ID

$optionsarray

Query Options

Returns
TypeDescription
\Zend_Service_Amazon_Item | \Zend_Service_Amazon_ResultSet
Throws
ExceptionDescription
\Zend_Service_Exception
Details
See
\http://www.amazon.com/gp/aws/sdk/main.html/102-9041115-9057709?s=AWSEcommerceService&v=2011-08-01&p=ApiReference/ItemLookupOperation  
methodpublicitemSearch(array $options) : \Zend_Service_Amazon_ResultSet
inherited

Search for Items

Inherited from: \Zend_Service_Amazon::itemSearch()
Parameters
NameTypeDescription
$optionsarray

Options to use for the Search Query

Returns
TypeDescription
\Zend_Service_Amazon_ResultSet
Throws
ExceptionDescription
\Zend_Service_Exception
Details
See
\http://www.amazon.com/gp/aws/sdk/main.html/102-9041115-9057709?s=AWSEcommerceService&v=2011-08-01&p=ApiReference/ItemSearchOperation  
methodpublicsetRestClient(\Zend_Rest_Client $client) : \Zend_Service_Amazon
inherited

Set REST client

Inherited from: \Zend_Service_Amazon::setRestClient()
Parameters
NameTypeDescription
$client\Zend_Rest_Client
Returns
TypeDescription
\Zend_Service_Amazon
Documentation was generated by phpDocumentor 2.0.0a12.