Queue/Message.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
Message  
Version
$Id$  

\Zend_Queue_Message

Package: Zend_Queue\Message
Class for managing queue messages
Children
\Zend_Queue_Message_PlatformJob
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedboolean $_connected = true
Connected is true if we have a reference to a live Zend_Queue_Adapter_Abstract object.
This is false after the Message has been deserialized.
Default valuetrueDetails
Type
boolean
>VPropertyprotectedarray $_data = array()
The data for the queue message
Default valuearray()Details
Type
array
>VPropertyprotected\Zend_Queue $_queue = null
Zend_Queue parent class or instance
Default valuenullDetails
Type
\Zend_Queue
>VPropertyprotectedstring $_queueClass = null
Name of the class of the Zend_Queue
Default valuenullDetails
Type
string

Methods

methodpublic__construct(array $options = array()) : void

Constructor

Parameters
NameTypeDescription
$optionsarray
Throws
ExceptionDescription
\Zend_Queue_Exception
methodpublic__get(string $key) : string

Retrieve message field value

Parameters
NameTypeDescription
$keystring

The user-specified key name.

Returns
TypeDescription
stringThe corresponding key value.
Throws
ExceptionDescription
\Zend_Queue_Exceptionif the $key is not a column in the message.
methodpublic__isset(string $key) : boolean

Test existence of message field

Parameters
NameTypeDescription
$keystring

The column key.

Returns
TypeDescription
boolean
methodpublic__set(string $key, mixed $value) : void

Set message field value

Parameters
NameTypeDescription
$keystring

The message key.

$valuemixed

The value for the property.

Throws
ExceptionDescription
\Zend_Queue_Exception
methodpublic__sleep() : array

Store queue and data in serialized object

Returns
TypeDescription
array
methodpublic__wakeup() : void

Setup to do on wakeup.

A de-serialized Message should not be assumed to have access to a live queue connection, so set _connected = false.
methodpublicgetQueue() : \Zend_Queue | null

Returns the queue object, or null if this is disconnected message

Returns
TypeDescription
\Zend_Queue | null
methodpublicgetQueueClass() : string

Query the class name of the Queue object for which this Message was created.

Returns
TypeDescription
string
methodpublicsetFromArray(array $data) : \Zend_Queue_Message

Sets all data in the row from an array.

Parameters
NameTypeDescription
$dataarray
Returns
TypeDescription
\Zend_Queue_MessageProvides a fluent interface
methodpublicsetQueue(\Zend_Queue $queue) : boolean

Set the queue object, to re-establish a live connection to the queue for a Message that has been de-serialized.

Parameters
NameTypeDescription
$queue\Zend_Queue
Returns
TypeDescription
boolean
methodpublictoArray() : array

Returns the column/value data as an array.

Returns
TypeDescription
array
Documentation was generated by phpDocumentor 2.2.0 .