API Documentation

Queue/Adapter/PlatformJobQueue.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: PlatformJobQueue.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Queue_Adapter_PlatformJobQueue

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

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
Properties
$_zendQueue
Methods
__construct
isExists
create
delete
getQueues
count
send
receive
deleteMessage
isJobIdExist
getCapabilities
__sleep
__wakeup

Description

Zend Platform JobQueue adapter

Properties

$_zendQueue
jump to class

ZendApi_JobQueue $_zendQueue = ''

Details

$_zendQueue
ZendApi_JobQueue
visibility
protected
default
final
false
static
false

Methods

__construct
jump to class

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

Constructor

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

__sleep
jump to class

__sleep( ) : array

Serialize

Output
array
Details
visibility
public
final
false
static
false

__wakeup
jump to class

__wakeup( ) : void

Unserialize

Details
visibility
public
final
false
static
false

count
jump to class

count( Zend_Queue|null $queue = null ) : integer

Return the approximate number of messages in the queue

Arguments
$queue
Zend_Queuenull
Output
integer
Details
visibility
public
final
false
static
false

create
jump to class

create( string $name, integer $timeout = null ) : void

Create a new queue

Arguments
$name
string
queue name
$timeout
integer
default visibility timeout
Details
visibility
public
final
false
static
false
throws

delete
jump to class

delete( string $name ) : void

Delete a queue and all of its messages

Arguments
$name
string
queue name
Details
visibility
public
final
false
static
false
throws

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.

Arguments
$message
Zend_Queue_Message
Output
boolean
Details
visibility
public
final
false
static
false
throws

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

getQueues
jump to class

getQueues( ) : void

Get an array of all available queues

Details
visibility
public
final
false
static
false
throws

isExists
jump to class

isExists( string $name ) : boolean

Does a queue already exist?

Arguments
$name
string
Output
boolean
Details
visibility
public
final
false
static
false
throws
(not supported)

isJobIdExist
jump to class

isJobIdExist(  $id ) :
Arguments
$id
Details
visibility
public
final
false
static
false

receive
jump to class

receive( integer $maxMessages = null, integer $timeout = null, Zend_Queue $queue = null ) : ArrayIterator

Get messages in the queue

Arguments
$maxMessages
integer
Maximum number of messages to return
$timeout
integer
Ignored
$queue
Zend_Queue
Not supported
Output
ArrayIterator
Details
visibility
public
final
false
static
false
throws

send
jump to class

send( array $message, Zend_Queue $queue = null ) : Zend_Queue_Message

Send a message to the queue

Arguments
$message
array
| ZendAPI_job $message Message to send to the active queue
$queue
Zend_Queue
Not supported
Output
Zend_Queue_Message
Details
visibility
public
final
false
static
false
throws
Documentation was generated by DocBlox.