API Documentation

Queue/Adapter/Null.php

Includes Classes 
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
subpackage
Adapter
version
$Id: Null.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Queue_Adapter_Null

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_Adapter_Null

Extends from
Zend_Queue_Adapter_AdapterAbstract
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
subpackage
Adapter
Methods
__construct
isExists
create
delete
getQueues
count
send
receive
deleteMessage
getCapabilities

Description

Class testing. No supported functions. Also used to disable a Zend_Queue.

Methods

__construct

__construct( array|Zend_Config $options, null|Zend_Queue $queue = null ) : void

Constructor

Arguments
$options
arrayZend_Config
$queue
nullZend_Queue
Details
visibility
public
final
false
static
false

count

count(  $queue = null ) :

Return the approximate number of messages in the queue

Arguments
$queue
Details
visibility
public
final
false
static
false
throws
- not supported.

create

create(  $name,  $timeout = null ) :

Create a new queue

Arguments
$name
$timeout
Details
visibility
public
final
false
static
false
throws
- not supported.

delete

delete(  $name ) :

Delete a queue and all of it's messages

Arguments
$name
Details
visibility
public
final
false
static
false
throws
- not supported.

deleteMessage

deleteMessage(  $message ) :

Delete a message from the queue

Arguments
$message
Details
visibility
public
final
false
static
false
throws
- not supported.

getCapabilities

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

getQueues

getQueues( ) :

Get an array of all available queues

Details
visibility
public
final
false
static
false
throws
- not supported.

isExists

isExists(  $name ) :

Does a queue already exist?

Arguments
$name
Details
visibility
public
final
false
static
false
throws
- not supported.

receive

receive(  $maxMessages = null,  $timeout = null,  $queue = null ) :

Get messages in the queue

Arguments
$maxMessages
$timeout
$queue
Details
visibility
public
final
false
static
false
throws
- not supported.

send

send(  $message,  $queue = null ) :

Send a message to the queue

Arguments
$message
$queue
Details
visibility
public
final
false
static
false
throws
- not supported.
Documentation was generated by DocBlox.