Service/Amazon/SimpleDb.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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service_Amazon  
Subpackage
SimpleDb  

\Zend_Service_Amazon_SimpleDb
jump to top

Package: 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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_httpTimeout = 10
Period after which HTTP request will timeout in seconds
Default value10Details
Type
n/a
>VPropertyprotected$_sdbApiVersion = '2009-04-15'
The API version to use
Default value'2009-04-15'Details
Type
n/a
>VPropertyprotected$_sdbEndpoint = 'sdb.amazonaws.com/'
The HTTP query server
Default value'sdb.amazonaws.com/'Details
Type
n/a
>VPropertyprotected$_signatureMethod = 'HmacSHA256'
Signature Encoding Method
Default value'HmacSHA256'Details
Type
n/a
>VPropertyprotected$_signatureVersion = '2'
Signature Version
Default value'2'Details
Type
n/a

Methods

methodpublic__construct( $accessKey,  $secretKey) : void

Create Amazon SimpleDB client.

Parameters
NameTypeDescription
$accessKey
$secretKey
methodprotected_addRequiredParameters(array $parameters) : array

Adds 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.
Parameters
NameTypeDescription
$parametersarray

the array to which to add the required parameters.

Returns
TypeDescription
array
methodprivate_checkForErrors(\Zend_Service_Amazon_SimpleDb_Response $response) : void

Checks for errors responses from Amazon

Parameters
NameTypeDescription
$response\Zend_Service_Amazon_SimpleDb_Response

the response object to check.

Throws
ExceptionDescription
\Zend_Service_Amazon_SimpleDb_Exceptionif one or more errors are returned from Amazon.
methodprotected_sendRequest(array $params = array()) : \Zend_Service_Amazon_SimpleDb_Response

Sends a HTTP request to the SimpleDB service using Zend_Http_Client

Parameters
NameTypeDescription
$paramsarray

List of parameters to send with the request

Returns
TypeDescription
\Zend_Service_Amazon_SimpleDb_Response
Throws
ExceptionDescription
\Zend_Service_Amazon_SimpleDb_Exception
methodprotected_signParameters( $paramaters) : string

Computes the RFC 2104-compliant HMAC signature for request parameters

This implements the Amazon Web Services signature, as per the following specification: 1. Sort all request parameters (including SignatureVersion and excluding Signature, the value of which is being created), ignoring case. 2. 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.
Parameters
NameTypeDescription
$paramaters
Returns
TypeDescription
stringthe signed data.
methodpublicbatchPutAttributes(array $items, string $domainName, array $replace = array()) : void

Add many attributes at once

Parameters
NameTypeDescription
$itemsarray
$domainNamestring
$replacearray
methodpubliccreateDomain(string $domainName) : boolean

Create a new domain

Parameters
NameTypeDescription
$domainNamestring

Valid domain name of the domain to create

Returns
TypeDescription
booleanTrue if successful, false if not
methodpublicdeleteAttributes(string $domainName, string $itemName, array $attributes = array()) : void

Delete attributes

Parameters
NameTypeDescription
$domainNamestring
$itemNamestring
$attributesarray
methodpublicdeleteDomain(string $domainName) : boolean

Delete a domain

Parameters
NameTypeDescription
$domainNamestring

Valid domain name of the domain to delete

Returns
TypeDescription
booleanTrue if successful, false if not
methodpublicdomainMetadata(string $domainName) : array

Retrieve domain metadata

Parameters
NameTypeDescription
$domainNamestring

Name of the domain for which metadata will be requested

Returns
TypeDescription
arrayKey/value array of metadatum names and values.
methodpublicgetAttributes(string $domainName,  $itemName,  $attributeName = null) : void

Get attributes API method

Parameters
NameTypeDescription
$domainNamestring

Domain name within database

$itemName
$attributeName
methodpublicgetEndpoint() : \Zend_Uri_Http

Get SimpleDB endpoint

Returns
TypeDescription
\Zend_Uri_Http
methodpubliclistDomains(int $maxNumberOfDomains = 100, int $nextToken = null) : array

List domains

Parameters
NameTypeDescription
$maxNumberOfDomainsint
$nextTokenint
Returns
TypeDescription
array0 or more domain names
methodpublicputAttributes(string $domainName, string $itemName, array | \Traverable $attributes, array $replace = array()) : void

Push attributes

Parameters
NameTypeDescription
$domainNamestring
$itemNamestring
$attributesarray | \Traverable
$replacearray
methodpublicquote(string $value) : string

Quote SDB value

Wraps it in ''
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
string
methodpublicquoteName(string $name) : string

Quote SDB column or table name

Wraps it in ``
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
string
methodpublicselect(string $selectExpression, null | string $nextToken = null) : \Zend_Service_Amazon_SimpleDb_Page

Select items from the database

Parameters
NameTypeDescription
$selectExpressionstring
$nextTokennull | string
Returns
TypeDescription
\Zend_Service_Amazon_SimpleDb_Page
methodpublicsetEndpoint(string | \Zend_Uri_Http $endpoint) : \Zend_Service_Amazon_SimpleDb

Set SimpleDB endpoint to use

Parameters
NameTypeDescription
$endpointstring | \Zend_Uri_Http
Returns
TypeDescription
\Zend_Service_Amazon_SimpleDb
Documentation was generated by phpDocumentor 2.2.0 .