Queue/Message.php

Show:

inherited

Classes
- \Zend_Queue_Message

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: Message
Version: $Id: Message.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Queue_Message
jump to top

Package: Zend\Queue\Message

Class for managing queue messages

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

Properties

boolean $_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

array $_data = array()

The data for the queue message

Default valuearray()Details

Type: array

\Zend_Queue $_queue = null

Zend_Queue parent class or instance

Default valuenullDetails

Type: \Zend_Queue

string $_queueClass = null

Name of the class of the Zend_Queue

Default valuenullDetails

Type: string

Methods

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

Constructor

Parameters

Name	Type	Description
$options	array

Throws

Exception	Description
\Zend_Queue_Exception

__get(string $key) : string

Retrieve message field value

Parameters

Name	Type	Description
$key	string	The user-specified key name.

Returns

Type	Description
string	The corresponding key value.

Throws

Exception	Description
\Zend_Queue_Exception	if the $key is not a column in the message.

__isset(string $key) : boolean

Test existence of message field

Parameters

Name	Type	Description
$key	string	The column key.

Returns

Type	Description
boolean

__set(string $key, mixed $value) : void

Set message field value

Parameters

Name	Type	Description
$key	string	The message key.
$value	mixed	The value for the property.

Throws

Exception	Description
\Zend_Queue_Exception

__sleep() : array

Store queue and data in serialized object

Returns

Type	Description
array

__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.

getQueue() : \Zend_Queue | null

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

Returns

Type	Description
\Zend_Queue \| null

getQueueClass() : string

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

Returns

Type	Description
string

setFromArray(array $data) : \Zend_Queue_Message

Sets all data in the row from an array.

Parameters

Name	Type	Description
$data	array

Returns

Type	Description
\Zend_Queue_Message	Provides a fluent interface

setQueue(\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

Name	Type	Description
$queue	\Zend_Queue

Returns

Type	Description
boolean

toArray() : array

Returns the column/value data as an array.

Returns

Type	Description
array

Queue/Message.php

\Zend_Queue_Messagejump to top

Properties

Methods

\Zend_Queue_Message
jump to top