Service/Amazon/Sqs.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
subpackage: Amazon_Sqs
version: $Id: Sqs.php 21323 2010-03-04 18:27:32Z stas $
Classes: Zend_Service_Amazon_Sqs

Description

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.

Zend_Service_Amazon_Sqs
jump to top

Extends from: Zend_Service_Amazon_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
see: http://aws.amazon.com/sqs/ Amazon Simple Queue Service
subpackage: Amazon_Sqs
Constants: CREATE_TIMEOUT_DEFAULT
Properties: $_sqsEndpoint; $_sqsApiVersion; $_sqsSignatureVersion; $_sqsSignatureMethod
Methods: __construct; create; delete; getQueues; count; send; receive; deleteMessage; getAttribute; _makeRequest; addRequiredParameters; _signParameters

Description

Class for connecting to the Amazon Simple Queue Service (SQS)

Constants

CREATE_TIMEOUT_DEFAULT
jump to class

 CREATE_TIMEOUT_DEFAULT = '30'

Default timeout for createQueue() function

Details

value: 30

Properties

$_sqsApiVersion
jump to class

$_sqsApiVersion = '2009-02-01'

The API version to use

Details

visibility: protected
default: 2009-02-01
final: false
static: false

$_sqsEndpoint
jump to class

$_sqsEndpoint = 'queue.amazonaws.com'

HTTP end point for the Amazon SQS service

Details

visibility: protected
default: queue.amazonaws.com
final: false
static: false

$_sqsSignatureMethod
jump to class

$_sqsSignatureMethod = 'HmacSHA256'

Signature Encoding Method

Details

visibility: protected
default: HmacSHA256
final: false
static: false

$_sqsSignatureVersion
jump to class

$_sqsSignatureVersion = '2'

Signature Version

Details

visibility: protected
default: 2
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $accessKey
              =
              null, string $secretKey
              =
              null, string $region
              =
              null
          )
        
        :

Constructor

Arguments

$accessKey: string
$secretKey: string
$region: string

Details

visibility: public
final: false
static: false

_makeRequest
jump to class

_makeRequest(
           $queue_url, string $action, array $params
              =
              array
          )
        
        :
        SimpleXMLElement

Make a request to Amazon SQS

Arguments

$queue_url
$action: string
SQS action
$params: array

Output

SimpleXMLElement

Details

visibility: private
final: false
static: false

_signParameters
jump to class

_signParameters(
          string $queue_url,  $paramaters
          )
        
        :
        string

Computes 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.

Arguments

$queue_url: string
Queue URL
$paramaters

Output

string: the signed data.

Details

visibility: protected
final: false
static: false

addRequiredParameters
jump to class

addRequiredParameters(
          string $queue_url, 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.

Arguments

$queue_url: string
Queue URL
$parameters: array
the array to which to add the required parameters.

Output

array

Details

visibility: protected
final: false
static: false

count
jump to class

count(
          string $queue_url
          )
        
        :
        integer

Return the approximate number of messages in the queue

Arguments

$queue_url: string
Queue URL

Output

integer

Details

visibility: public
final: false
static: false
throws

create
jump to class

create(
          string $queue_name, integer $timeout
              =
              null
          )
        
        :
        string|boolean

Create a new queue

Visibility timeout is how long a message is left in the queue "invisible" to other readers. If the message is acknowleged (deleted) before the timeout, then the message is deleted. However, if the timeout expires then the message will be made available to other queue readers.

Arguments

$queue_name: string
queue name
$timeout: integer
default visibility timeout

Output

string|boolean

Details

visibility: public
final: false
static: false
throws

delete
jump to class

delete(
          string $queue_url
          )
        
        :
        boolean

Delete a queue and all of it's messages

Returns false if the queue is not found, true if the queue exists

Arguments

$queue_url: string
queue URL

Output

boolean

Details

visibility: public
final: false
static: false
throws

deleteMessage
jump to class

deleteMessage(
          string $queue_url, string $handle
          )
        
        :
        boolean

Delete a message from the queue

Returns true if the message is deleted, false if the deletion is unsuccessful.

Arguments

$queue_url: string
Queue URL
$handle: string
Message handle as returned by SQS

Output

boolean

Details

visibility: public
final: false
static: false
throws

getAttribute
jump to class

getAttribute(
          string $queue_url, string $attribute
              =
              All
          )
        
        :
        string

Get the attributes for the queue

Arguments

$queue_url: string
Queue URL
$attribute: string

Output

string

Details

visibility: public
final: false
static: false
throws

getQueues
jump to class

getQueues(
          
          )
        
        :
        array

Get an array of all available queues

Output

array

Details

visibility: public
final: false
static: false
throws

receive
jump to class

receive(
          string $queue_url, integer $max_messages
              =
              null, integer $timeout
              =
              null
          )
        
        :
        array

Get messages in the queue

Arguments

$queue_url: string
Queue name
$max_messages: integer
Maximum number of messages to return
$timeout: integer
Visibility timeout for these messages

Output

array

Details

visibility: public
final: false
static: false
throws

send
jump to class

send(
          string $queue_url, string $message
          )
        
        :
        string

Send a message to the queue

Arguments

$queue_url: string
Queue URL
$message: string
Message to send to the queue

Output

string: Message ID

Details

visibility: public
final: false
static: false
throws

API Documentation

Service/Amazon/Sqs.php

Description

Zend_Service_Amazon_Sqsjump to top

Description

Constants

CREATE_TIMEOUT_DEFAULTjump to class

Details

Properties

$_sqsApiVersionjump to class

Details

$_sqsEndpointjump to class

Details

$_sqsSignatureMethodjump to class

Details

$_sqsSignatureVersionjump to class

Details

Methods

__constructjump to class

Arguments

Details

_makeRequestjump to class

Arguments

Output

Details

_signParametersjump to class

Arguments

Output

Details

addRequiredParametersjump to class

Arguments

Output

Details

countjump to class

Arguments

Output

Details

createjump to class

Arguments

Output

Details

deletejump to class

Arguments

Output

Details

deleteMessagejump to class

Arguments

Output

Details

getAttributejump to class

Arguments

Output

Details

getQueuesjump to class

Output

Details

receivejump to class

Arguments

Output

Details

sendjump to class

Arguments

Output

Details

Zend_Service_Amazon_Sqs
jump to top

CREATE_TIMEOUT_DEFAULT
jump to class

$_sqsApiVersion
jump to class

$_sqsEndpoint
jump to class

$_sqsSignatureMethod
jump to class

$_sqsSignatureVersion
jump to class

__construct
jump to class

_makeRequest
jump to class

_signParameters
jump to class

addRequiredParameters
jump to class

count
jump to class

create
jump to class

delete
jump to class

deleteMessage
jump to class

getAttribute
jump to class

getQueues
jump to class

receive
jump to class

send
jump to class