Service/Amazon/Query.php

Show:

inherited

Classes
- \Zend_Service_Amazon_Query

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 [email protected] 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
jump to top

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

string $_baseUri = null

inherited

Inherited from: \Zend_Service_Amazon::$$_baseUri

Default valuenullDetails

Type: string
Inherited_from: \Zend_Service_Amazon::$$_baseUri

array $_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 value

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')

Details

Type: array
Inherited_from: \Zend_Service_Amazon::$$_baseUriList

\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

array $_search = array()

Search parameters

Default valuearray()Details

Type: array

string $_searchIndex = null

Search index

Default valuenullDetails

Type: string

string $_secretKey = null

inherited

Inherited from: \Zend_Service_Amazon::$$_secretKey

Default valuenullDetails

Type: string
Inherited_from: \Zend_Service_Amazon::$$_secretKey

string $appId =

inherited

Amazon Web Services Access Key ID

Inherited from: \Zend_Service_Amazon::$$appId

Details

Type: string
Inherited_from: \Zend_Service_Amazon::$$appId

Methods

__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

__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

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

_checkErrors(\DOMDocument $dom) : void

staticinherited

Check result for errors

Inherited from: \Zend_Service_Amazon::_checkErrors()

Parameters

Name	Type	Description
$dom	\DOMDocument

Throws

Exception	Description
\Zend_Service_Exception

_prepareOptions(string $query, array $options, array $defaultOptions) : array

inherited

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

buildRawSignature(string $baseUri, array $options) : string

staticinherited

Build the Raw Signature Text

Inherited from: \Zend_Service_Amazon::buildRawSignature()

Parameters

Name	Type	Description
$baseUri	string
$options	array

Returns

Type	Description
string

computeSignature(string $baseUri, string $secretKey, array $options) : string

staticinherited

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

getRestClient() : \Zend_Rest_Client

inherited

Returns a reference to the REST client

Inherited from: \Zend_Service_Amazon::getRestClient()

Returns

Type	Description
\Zend_Rest_Client

itemLookup(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

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: \global\http://www.amazon.com/gp/aws/sdk/main.html/102-9041115-9057709?s=AWSEcommerceService&v=2011-08-01&p=ApiReference/ItemLookupOperation

itemSearch(array $options) : \Zend_Service_Amazon_ResultSet

inherited

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: \global\http://www.amazon.com/gp/aws/sdk/main.html/102-9041115-9057709?s=AWSEcommerceService&v=2011-08-01&p=ApiReference/ItemSearchOperation

search() : \Zend_Service_Amazon_Item | \Zend_Service_Amazon_ResultSet

Search using the prepared query

Returns

Type	Description
\Zend_Service_Amazon_Item \| \Zend_Service_Amazon_ResultSet

setRestClient( $client) : \Zend_Service_Amazon

inherited

Set REST client

Inherited from: \Zend_Service_Amazon::setRestClient()

Parameters

Name	Type	Description
$client		Zend_Rest_Client

Returns

Type	Description
\Zend_Service_Amazon

Service/Amazon/Query.php

\Zend_Service_Amazon_Queryjump to top

Properties

Methods

\Zend_Service_Amazon_Query
jump to top