API Documentation

Zend/Queue/Adapter/Array.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: Array.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Queue_Adapter_Array

Package: Zend\Queue\Adapter

Class for using a standard PHP array as a 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  

Properties

Propertyprotectedarray  $_data= 'array()'

Default valuearray()Details
Type
array

Methods

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

Constructor

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

serialize

methodpubliccount( \Zend_Queue $queue = null ) : integer

Return the approximate number of messages in the queue

Parameters
Name Type Description
$queue \Zend_Queue
Returns
Type Description
integer
Throws
Exception Description
\Zend_Queue_Exception
methodpubliccreate( string $name, integer $timeout = null ) : 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.

Parameters
Name Type Description
$name string

queue name

$timeout integer

default visibility timeout

Returns
Type Description
boolean
methodpublicdelete( string $name ) : boolean

Delete a queue and all of it's messages

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

Parameters
Name Type Description
$name string

queue name

Returns
Type Description
boolean
methodpublicdeleteMessage( \Zend_Queue_Message $message ) : boolean

Delete a message from the queue

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

Parameters
Name Type Description
$message \Zend_Queue_Message
Returns
Type Description
boolean
Throws
Exception Description
\Zend_Queue_Exception
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
methodpublicgetData( ) : \$this;

returns underlying _data array $queue->getAdapter()->getData();

Returns
Type Description
\$this;
methodpublicgetQueues( ) : array

Get an array of all available queues

Not all adapters support getQueues(), use isSupported('getQueues') to determine if the adapter supports this feature.

Returns
Type Description
array
methodpublicisExists( string $name ) : boolean

Does a queue already exist?

Throws an exception if the adapter cannot determine if a queue exists. use isSupported('isExists') to determine if an adapter can test for queue existance.

Parameters
Name Type Description
$name string
Returns
Type Description
boolean
methodpublicreceive( integer $maxMessages = null, integer $timeout = null, \Zend_Queue $queue = null ) : \Zend_Queue_Message_Iterator

Get messages in the queue

Parameters
Name Type Description
$maxMessages integer

Maximum number of messages to return

$timeout integer

Visibility timeout for these messages

$queue \Zend_Queue
Returns
Type Description
\Zend_Queue_Message_Iterator
methodpublicsend( string $message, \Zend_Queue $queue = null ) : \Zend_Queue_Message

Send a message to the queue

Parameters
Name Type Description
$message string

Message to send to the active queue

$queue \Zend_Queue
Returns
Type Description
\Zend_Queue_Message
Throws
Exception Description
\Zend_Queue_Exception
methodpublicsetData( array $data ) : \$this;

sets the underlying _data array $queue->getAdapter()->setData($data);

Parameters
Name Type Description
$data array
Returns
Type Description
\$this;
Documentation was generated by DocBlox 0.15.1.