API Documentation

Zend/Queue/Adapter/Null.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Queue  
Subpackage
Adapter  
Version
$Id: Null.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Queue_Adapter_Null

Package: Zend\Queue\Adapter

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

Parent(s)
\Zend_Queue_Adapter_AdapterAbstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Methods

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

Constructor

Parameters
Name Type Description
$options array|\Zend_Config
$queue null|\Zend_Queue
methodpubliccount(  $queue = null ) : void

Return the approximate number of messages in the queue

Parameters
Name Type Description
$queue
Throws
Exception Description
\Zend_Queue_Exception - not supported.
methodpubliccreate(  $name,  $timeout = null ) : void

Create a new queue

Parameters
Name Type Description
$name
$timeout
Throws
Exception Description
\Zend_Queue_Exception - not supported.
methodpublicdelete(  $name ) : void

Delete a queue and all of it's messages

Parameters
Name Type Description
$name
Throws
Exception Description
\Zend_Queue_Exception - not supported.
methodpublicdeleteMessage(  $message ) : void

Delete a message from the queue

Parameters
Name Type Description
$message
Throws
Exception Description
\Zend_Queue_Exception - not supported.
methodpublicgetCapabilities( ) : array

Return a list of queue capabilities functions

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

Returns
Type Description
array
methodpublicgetQueues( ) : void

Get an array of all available queues

Throws
Exception Description
\Zend_Queue_Exception - not supported.
methodpublicisExists(  $name ) : void

Does a queue already exist?

Parameters
Name Type Description
$name
Throws
Exception Description
\Zend_Queue_Exception - not supported.
methodpublicreceive(  $maxMessages = null,  $timeout = null,  $queue = null ) : void

Get messages in the queue

Parameters
Name Type Description
$maxMessages
$timeout
$queue
Throws
Exception Description
\Zend_Queue_Exception - not supported.
methodpublicsend(  $message,  $queue = null ) : void

Send a message to the queue

Parameters
Name Type Description
$message
$queue
Throws
Exception Description
\Zend_Queue_Exception - not supported.
Documentation was generated by DocBlox 0.15.1.