Service/Amazon/SimpleDb.php
inherited
Classes
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_Amazon
- Subpackage
- SimpleDb
\Zend_Service_Amazon_SimpleDb
Abstract Amazon class that handles the credentials for any of the Web Services that Amazon offers
- Parent(s)
- \Zend_Service_Amazon_Abstract < \Zend_Service_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
string $_accessKey = - Type
- string
- Inherited_from
- \Zend_Service_Amazon_Abstract::$$_accessKey
string $_defaultAccessKey = nullnullDetails- Type
- string
- Inherited_from
- \Zend_Service_Amazon_Abstract::$$_defaultAccessKey
string $_defaultSecretKey = nullnullDetails- Type
- string
- Inherited_from
- \Zend_Service_Amazon_Abstract::$$_defaultSecretKey
\Zend_Http_Client $_httpClient = nullHTTP Client used to query all web services
Inherited from: \Zend_Service_Abstract::$$_httpClient\Zend_Service_Amazon_Abstract::$$_httpClientnullDetails- Type
- \Zend_Http_Client
- Inherited_from
- \Zend_Service_Abstract::$$_httpClient
- Inherited_from
- \Zend_Service_Amazon_Abstract::$$_httpClient
$_httpTimeout = 10Period after which HTTP request will timeout in seconds
10Details- Type
- n/a
$_sdbApiVersion = '2009-04-15'The API version to use
'2009-04-15'Details- Type
- n/a
$_sdbEndpoint = 'sdb.amazonaws.com/'The HTTP query server
'sdb.amazonaws.com/'Details- Type
- n/a
string $_secretKey = - Type
- string
- Inherited_from
- \Zend_Service_Amazon_Abstract::$$_secretKey
$_signatureMethod = 'HmacSHA256'Signature Encoding Method
'HmacSHA256'Details- Type
- n/a
$_signatureVersion = '2'Signature Version
'2'Details- Type
- n/a
Methods
__construct( $accessKey, $secretKey) : voidCreate Amazon SimpleDB client.
| Name | Type | Description |
|---|---|---|
| $accessKey | ||
| $secretKey |
_addRequiredParameters(array $parameters) : arrayAdds required authentication and version parameters to an array of parameters
The required parameters are: - AWSAccessKey - SignatureVersion - Timestamp - Version and - Signature
If a required parameter is already set in the $parameters array, it is overwritten.
| Name | Type | Description |
|---|---|---|
| $parameters | array | the array to which to add the required parameters. |
| Type | Description |
|---|---|
| array |
_checkForErrors(\Zend_Service_Amazon_SimpleDb_Response $response) : voidChecks for errors responses from Amazon
| Name | Type | Description |
|---|---|---|
| $response | \Zend_Service_Amazon_SimpleDb_Response | the response object to check. |
| Exception | Description |
|---|---|
| \Zend_Service_Amazon_SimpleDb_Exception | if one or more errors are returned from Amazon. |
_getAccessKey() : stringMethod to fetch the Access Key
Inherited from: \Zend_Service_Amazon_Abstract::_getAccessKey()| Type | Description |
|---|---|
| string |
_getSecretKey() : stringMethod to fetch the Secret AWS Key
Inherited from: \Zend_Service_Amazon_Abstract::_getSecretKey()| Type | Description |
|---|---|
| string |
_sendRequest(array $params = array()) : \Zend_Service_Amazon_SimpleDb_ResponseSends a HTTP request to the SimpleDB service using Zend_Http_Client
| Name | Type | Description |
|---|---|---|
| $params | array | List of parameters to send with the request |
| Type | Description |
|---|---|
| \Zend_Service_Amazon_SimpleDb_Response |
| Exception | Description |
|---|---|
| \Zend_Service_Amazon_SimpleDb_Exception |
_signParameters( $paramaters) : stringComputes the RFC 2104-compliant HMAC signature for request parameters
This implements the Amazon Web Services signature, as per the following specification:
Sort all request parameters (including SignatureVersion and excluding Signature, the value of which is being created), ignoring case.
Iterate over the sorted list and append the parameter name (in its original case) and then its value. Do not URL-encode the parameter values before constructing this string. Do not use any separator characters when appending strings.
| Name | Type | Description |
|---|---|---|
| $paramaters |
| Type | Description |
|---|---|
| string | the signed data. |
batchPutAttributes(array $items, string $domainName, array $replace = array()) : voidAdd many attributes at once
| Name | Type | Description |
|---|---|---|
| $items | array | |
| $domainName | string | |
| $replace | array |
createDomain(string $domainName) : booleanCreate a new domain
| Name | Type | Description |
|---|---|---|
| $domainName | string | Valid domain name of the domain to create |
| Type | Description |
|---|---|
| boolean | True if successful, false if not |
deleteAttributes(string $domainName, string $itemName, array $attributes = array()) : voidDelete attributes
| Name | Type | Description |
|---|---|---|
| $domainName | string | |
| $itemName | string | |
| $attributes | array |
deleteDomain(string $domainName) : booleanDelete a domain
| Name | Type | Description |
|---|---|---|
| $domainName | string | Valid domain name of the domain to delete |
| Type | Description |
|---|---|
| boolean | True if successful, false if not |
domainMetadata(string $domainName) : arrayRetrieve domain metadata
| Name | Type | Description |
|---|---|---|
| $domainName | string | Name of the domain for which metadata will be requested |
| Type | Description |
|---|---|
| array | Key/value array of metadatum names and values. |
getAttributes(string $domainName, $itemName, $attributeName = null) : voidGet attributes API method
| Name | Type | Description |
|---|---|---|
| $domainName | string | Domain name within database |
| $itemName | string |
|
| $attributeName |
getHttpClient() : \Zend_Http_ClientGets the HTTP client object.
Inherited from: \Zend_Service_Abstract::getHttpClient()\Zend_Service_Amazon_Abstract::getHttpClient()| Type | Description |
|---|---|
| \Zend_Http_Client |
listDomains(int $maxNumberOfDomains = 100, int $nextToken = null) : arrayList domains
| Name | Type | Description |
|---|---|---|
| $maxNumberOfDomains | int | |
| $nextToken | int |
| Type | Description |
|---|---|
| array | 0 or more domain names |
putAttributes(string $domainName, string $itemName, array | \Traverable $attributes, array $replace = array()) : voidPush attributes
| Name | Type | Description |
|---|---|---|
| $domainName | string | |
| $itemName | string | |
| $attributes | array | \Traverable | |
| $replace | array |
quote(string $value) : stringQuote SDB value
Wraps it in ''
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| string |
quoteName(string $name) : stringQuote SDB column or table name
Wraps it in ``
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| string |
select(string $selectExpression, null | string $nextToken = null) : \Zend_Service_Amazon_SimpleDb_PageSelect items from the database
| Name | Type | Description |
|---|---|---|
| $selectExpression | string | |
| $nextToken | null | string |
| Type | Description |
|---|---|
| \Zend_Service_Amazon_SimpleDb_Page |
setEndpoint(string | \Zend_Uri_Http $endpoint) : \Zend_Service_Amazon_SimpleDbSet SimpleDB endpoint to use
| Name | Type | Description |
|---|---|---|
| $endpoint | string | \Zend_Uri_Http |
| Type | Description |
|---|---|
| \Zend_Service_Amazon_SimpleDb |
setHttpClient(\Zend_Http_Client $httpClient) : voidSets the HTTP client object to use for retrieving the feeds.
Inherited from: \Zend_Service_Abstract::setHttpClient()\Zend_Service_Amazon_Abstract::setHttpClient()If none is set, the default Zend_Http_Client will be used.
| Name | Type | Description |
|---|---|---|
| $httpClient | \Zend_Http_Client |
setKeys( $accessKey, $secretKey) : voidSet the keys to use when accessing SQS.
Inherited from: \Zend_Service_Amazon_Abstract::setKeys()| Name | Type | Description |
|---|---|---|
| $accessKey | ||
| $secretKey |