Queue/Adapter/Array.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Queue  
Subpackage
Adapter  
Version
$Id$  

\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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_data = array()
Default valuearray()Details
Type
array

Methods

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

Constructor

Parameters
NameTypeDescription
$optionsarray | \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
NameTypeDescription
$queue\Zend_Queue
Returns
TypeDescription
integer
Throws
ExceptionDescription
\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
NameTypeDescription
$namestring

queue name

$timeoutinteger

default visibility timeout

Returns
TypeDescription
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
NameTypeDescription
$namestring

queue name

Returns
TypeDescription
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
NameTypeDescription
$message\Zend_Queue_Message
Returns
TypeDescription
boolean
Throws
ExceptionDescription
\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
TypeDescription
array
methodpublicgetData() : \$this;

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

Returns
TypeDescription
\$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
TypeDescription
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
NameTypeDescription
$namestring
Returns
TypeDescription
boolean
methodpublicreceive(integer $maxMessages = null, integer $timeout = null, \Zend_Queue $queue = null) : \Zend_Queue_Message_Iterator

Get messages in the queue

Parameters
NameTypeDescription
$maxMessagesinteger

Maximum number of messages to return

$timeoutinteger

Visibility timeout for these messages

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

Send a message to the queue

Parameters
NameTypeDescription
$messagestring

Message to send to the active queue

$queue\Zend_Queue
Returns
TypeDescription
\Zend_Queue_Message
Throws
ExceptionDescription
\Zend_Queue_Exception
methodpublicsetData(array $data) : \$this;

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

Parameters
NameTypeDescription
$dataarray
Returns
TypeDescription
\$this;
Documentation was generated by phpDocumentor 2.2.0 .