API Documentation

Service/Amazon/Query.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
Amazon  
version
$Id: Query.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Service_Amazon_Query

Extends from
\Zend_Service_Amazon
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
Amazon  

Properties

Propertyprotectedarray  $_search= 'array'

Search parameters

Default valuearrayDetails
Type
array
Propertyprotectedstring  $_searchIndex= 'null'

Search index

Default valuenullDetails
Type
string

Methods

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

Prepares query parameters

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
\Zend_Service_Amazon_Query Provides a fluent interface
Throws
Exception Description
\Zend_Service_Exception
methodpublic__construct( string $appId, string $countryCode = US,  $secretKey = null ) : \Zend_Service_Amazon

Constructs a new Amazon Web Services Client

Inherited from: \Zend_Service_Amazon::__construct()
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

Inherited from: \Zend_Service_Amazon::_checkErrors()
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

Inherited from: \Zend_Service_Amazon::_prepareOptions()
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

Inherited from: \Zend_Service_Amazon::buildRawSignature()
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

Inherited from: \Zend_Service_Amazon::computeSignature()
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

Inherited from: \Zend_Service_Amazon::getRestClient()
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

Inherited from: \Zend_Service_Amazon::itemLookup()
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

Inherited from: \Zend_Service_Amazon::itemSearch()
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

Inherited from: \Zend_Service_Amazon::setRestClient()
Parameters
Name Type Description
$client Zend_Rest_Client
Returns
Type Description
\Zend_Service_Amazon
Documentation was generated by DocBlox 0.13.3.