Queue.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_Queue
version: $Id: Queue.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Queue

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_Queue
jump to top

Implements
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_Queue
Constants: TIMEOUT; VISIBILITY_TIMEOUT; NAME
Properties: $_adapter; $_options; $_messageClass; $_messageSetClass; $_logger
Methods: __construct; setOptions; setOption; getOptions; hasOption; getOption; setAdapter; getAdapter; setMessageClass; getMessageClass; setMessageSetClass; getMessageSetClass; getName; createQueue; deleteQueue; deleteMessage; send; count; receive; getCapabilities; isSupported; getQueues; _setName; debugInfo

Description

Class for connecting to queues performing common operations.

Constants

TIMEOUT
jump to class

 TIMEOUT = 'timeout'

Use the TIMEOUT constant in the config of a Zend_Queue

Details

value: timeout

VISIBILITY_TIMEOUT
jump to class

 VISIBILITY_TIMEOUT = '30'

Default visibility passed to count

Details

value: 30

NAME
jump to class

 NAME = 'name'

Use the NAME constant in the config of Zend_Queue

Details

value: name

Properties

$_adapter
jump to class

Zend_Queue_Adapter_AdapterInterface $_adapter = 'null'

Details

$_adapter: Zend_Queue_Adapter_AdapterInterface
visibility: protected
default: null
final: false
static: false

$_logger
jump to class

Zend_Log $_logger = 'null'

Details

$_logger: Zend_Log
visibility: protected
default: null
final: false
static: false

$_messageClass
jump to class

string $_messageClass = 'Zend_Queue_Message'

Zend_Queue_Message class

Details

$_messageClass: string
visibility: protected
default: Zend_Queue_Message
final: false
static: false

$_messageSetClass
jump to class

string $_messageSetClass = 'Zend_Queue_Message_Iterator'

Zend_Queue_Message_Iterator class

Details

$_messageSetClass: string
visibility: protected
default: Zend_Queue_Message_Iterator
final: false
static: false

$_options
jump to class

array $_options = 'array'

User-provided configuration

Details

$_options: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          string|Zend_Queue_Adapter|array|Zend_Config|null $spec, Zend_Config|array $options
              =
              array
          )
        
        :
        void

Constructor

Can be called as $queue = new Zend_Queue($config); - or - $queue = new Zend_Queue('array', $config); - or - $queue = new Zend_Queue(null, $config); // Zend_Queue->createQueue();

Arguments

$spec: stringZend_Queue_AdapterarrayZend_Confignull
String or adapter instance, or options array or Zend_Config instance
$options: Zend_Configarray
Zend_Config or a configuration array

Details

visibility: public
final: false
static: false

_setName
jump to class

_setName(
          string $name
          )
        
        :
        Zend_Queue|false

Set the name of the queue

This is AN UNSUPPORTED FUNCTION

Arguments

$name: string

Output

Zend_Queue|false: Provides a fluent interface

Details

visibility: protected
final: false
static: false

count
jump to class

count(
          
          )
        
        :
        integer

Returns the approximate number of messages in the queue

Output

integer

Details

visibility: public
final: false
static: false

createQueue
jump to class

createQueue(
          string $name, integer $timeout
              =
              null
          )
        
        :
        Zend_Queue|false

Create a new queue

Arguments

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

Output

Zend_Queue|false

Details

visibility: public
final: false
static: false
throws

debugInfo
jump to class

debugInfo(
          
          )
        
        :
        array

returns a listing of Zend_Queue details.

useful for debugging

Output

array

Details

visibility: public
final: false
static: false

deleteMessage
jump to class

deleteMessage(
          Zend_Queue_Message $message
          )
        
        :
        boolean

Delete a message from the queue

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

Returns true if the adapter doesn't support message deletion.

Arguments

$message: Zend_Queue_Message

Output

boolean

Details

visibility: public
final: false
static: false
throws

deleteQueue
jump to class

deleteQueue(
          
          )
        
        :
        boolean

Delete the queue this object is working on.

This queue is disabled, regardless of the outcome of the deletion of the queue, because the programmers intent is to disable this queue.

Output

boolean

Details

visibility: public
final: false
static: false

getAdapter
jump to class

getAdapter(
          
          )
        
        :
        Zend_Queue_Adapter_AdapterInterface

Get the adapter for this queue

Output

Zend_Queue_Adapter_AdapterInterface

Details

visibility: public
final: false
static: false

getCapabilities
jump to class

getCapabilities(
          
          )
        
        :
        array

Return a list of queue capabilities functions

$array['function name'] = true or false true is supported, false is not supported.

Output

array

Details

visibility: public
final: false
static: false

getMessageClass
jump to class

getMessageClass(
          
          )
        
        :
        string

Output

string

Details

visibility: public
final: false
static: false

getMessageSetClass
jump to class

getMessageSetClass(
          
          )
        
        :
        string

Output

string

Details

visibility: public
final: false
static: false

getName
jump to class

getName(
          
          )
        
        :
        string

Get the name of the queue

Note: _setName() used to exist, but it caused confusion with createQueue Will evaluate later to see if we should add it back in.

Output

string

Details

visibility: public
final: false
static: false

getOption
jump to class

getOption(
          string $name
          )
        
        :
        null|mixed

Retrieve a single option

Arguments

$name: string

Output

null|mixed: Returns null if option does not exist; option value otherwise

Details

visibility: public
final: false
static: false

getOptions
jump to class

getOptions(
          
          )
        
        :
        array

Returns the configuration options for the queue

Output

array

Details

visibility: public
final: false
static: false

getQueues
jump to class

getQueues(
          
          )
        
        :
        array

Get an array of all available queues

Output

array

Details

visibility: public
final: false
static: false
throws

hasOption
jump to class

hasOption(
          string $name
          )
        
        :
        bool

Determine if a requested option has been defined

Arguments

$name: string

Output

bool

Details

visibility: public
final: false
static: false

isSupported
jump to class

isSupported(
          string $name
          )
        
        :
        boolean

Indicates if a function is supported or not.

Arguments

$name: string

Output

boolean

Details

visibility: public
final: false
static: false

receive
jump to class

receive(
          integer $maxMessages
              =
              null, integer $timeout
              =
              null
          )
        
        :
        Zend_Queue_Message_Iterator

Return the first element in the queue

Arguments

$maxMessages: integer
$timeout: integer

Output

Zend_Queue_Message_Iterator

Details

visibility: public
final: false
static: false

send
jump to class

send(
          mixed $message
          )
        
        :
        Zend_Queue_Message

Send a message to the queue

Arguments

$message: mixed
message

Output

Zend_Queue_Message

Details

visibility: public
final: false
static: false
throws

setAdapter
jump to class

setAdapter(
          string|Zend_Queue_Adapter_AdapterInterface $adapter
          )
        
        :
        Zend_Queue

Set the adapter for this queue

Arguments

$adapter: stringZend_Queue_Adapter_AdapterInterface

Output

Zend_Queue: Provides a fluent interface

Details

visibility: public
final: false
static: false

setMessageClass
jump to class

setMessageClass(
          string $className
          )
        
        :
        Zend_Queue

Arguments

$className: string

Output

Zend_Queue: Provides a fluent interface

Details

visibility: public
final: false
static: false

setMessageSetClass
jump to class

setMessageSetClass(
          string $className
          )
        
        :
        Zend_Queue

Arguments

$className: string

Output

Zend_Queue: Provides a fluent interface

Details

visibility: public
final: false
static: false

setOption
jump to class

setOption(
          string $name, mixed $value
          )
        
        :
        Zend_Queue

Set an individual configuration option

Arguments

$name: string
$value: mixed

Output

Zend_Queue

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Queue

Set queue options

Arguments

$options: array

Output

Zend_Queue

Details

visibility: public
final: false
static: false

API Documentation

Queue.php

Description

Zend_Queuejump to top

Description

Constants

TIMEOUTjump to class

Details

VISIBILITY_TIMEOUTjump to class

Details

NAMEjump to class

Details

Properties

$_adapterjump to class

Details

$_loggerjump to class

Details

$_messageClassjump to class

Details

$_messageSetClassjump to class

Details

$_optionsjump to class

Details

Methods

__constructjump to class

Arguments

Details

_setNamejump to class

Arguments

Output

Details

countjump to class

Output

Details

createQueuejump to class

Arguments

Output

Details

debugInfojump to class

Output

Details

deleteMessagejump to class

Arguments

Output

Details

deleteQueuejump to class

Output

Details

getAdapterjump to class

Output

Details

getCapabilitiesjump to class

Output

Details

getMessageClassjump to class

Output

Details

getMessageSetClassjump to class

Output

Details

getNamejump to class

Output

Details

getOptionjump to class

Arguments

Output

Details

getOptionsjump to class

Output

Details

getQueuesjump to class

Output

Details

hasOptionjump to class

Arguments

Output

Details

isSupportedjump to class

Arguments

Output

Zend_Queue
jump to top

TIMEOUT
jump to class

VISIBILITY_TIMEOUT
jump to class

NAME
jump to class

$_adapter
jump to class

$_logger
jump to class

$_messageClass
jump to class

$_messageSetClass
jump to class

$_options
jump to class

__construct
jump to class

_setName
jump to class

count
jump to class

createQueue
jump to class

debugInfo
jump to class

deleteMessage
jump to class

deleteQueue
jump to class

getAdapter
jump to class

getCapabilities
jump to class

getMessageClass
jump to class

getMessageSetClass
jump to class

getName
jump to class

getOption
jump to class

getOptions
jump to class

getQueues
jump to class

hasOption
jump to class

isSupported
jump to class

receive
jump to class

send
jump to class

setAdapter
jump to class

setMessageClass
jump to class

setMessageSetClass
jump to class

setOption
jump to class

setOptions
jump to class