Queue/Message.php

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: Message
version: $Id: Message.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Queue_Message

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

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: Message
Properties: $_data; $_connected; $_queue; $_queueClass
Methods: __construct; __get; __set; __isset; __sleep; __wakeup; getQueue; setQueue; getQueueClass; toArray; setFromArray

Description

Class for managing queue messages

Properties

$_connected
jump to class

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.

Details

$_connected: boolean
visibility: protected
default: true
final: false
static: false

$_data
jump to class

array $_data = 'array'

The data for the queue message

Details

$_data: array
visibility: protected
default: array
final: false
static: false

$_queue
jump to class

Zend_Queue $_queue = 'null'

Zend_Queue parent class or instance

Details

$_queue: Zend_Queue
visibility: protected
default: null
final: false
static: false

$_queueClass
jump to class

string $_queueClass = 'null'

Name of the class of the Zend_Queue

Details

$_queueClass: string
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          array $options
              =
              array
          )
        
        :

Constructor

Arguments

$options: array

Details

visibility: public
final: false
static: false
throws

__get
jump to class

__get(
          string $key
          )
        
        :
        string

Retrieve message field value

Arguments

$key: string
The user-specified key name.

Output

string: The corresponding key value.

Details

visibility: public
final: false
static: false
throws: if the $key is not a column in the message.

__isset
jump to class

__isset(
          string $key
          )
        
        :
        boolean

Test existence of message field

Arguments

$key: string
The column key.

Output

boolean

Details

visibility: public
final: false
static: false

__set
jump to class

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

Set message field value

Arguments

$key: string
The message key.
$value: mixed
The value for the property.

Details

visibility: public
final: false
static: false
throws

__sleep
jump to class

__sleep(
          
          )
        
        :
        array

Store queue and data in serialized object

Output

array

Details

visibility: public
final: false
static: false

__wakeup
jump to class

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

Details

visibility: public
final: false
static: false

getQueue
jump to class

getQueue(
          
          )
        
        :
        Zend_Queue|null

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

Output

Zend_Queue|null

Details

visibility: public
final: false
static: false

getQueueClass
jump to class

getQueueClass(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

setFromArray
jump to class

setFromArray(
          array $data
          )
        
        :
        Zend_Queue_Message

Sets all data in the row from an array.

Arguments

$data: array

Output

Zend_Queue_Message: Provides a fluent interface

Details

visibility: public
final: false
static: false

setQueue
jump to class

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.

Arguments

$queue: Zend_Queue

Output

boolean

Details

visibility: public
final: false
static: false

toArray
jump to class

toArray(
          
          )
        
        :
        array

Returns the column/value data as an array.

Output

array

Details

visibility: public
final: false
static: false

API Documentation

Queue/Message.php

Description

Zend_Queue_Messagejump to top

Description

Properties

$_connectedjump to class

Details

$_datajump to class

Details

$_queuejump to class

Details

$_queueClassjump to class

Details

Methods

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__issetjump to class

Arguments

Output

Details

__setjump to class

Arguments

Details

__sleepjump to class

Output

Details

__wakeupjump to class

Details

getQueuejump to class

Output

Details

getQueueClassjump to class

Output

Details

setFromArrayjump to class

Arguments

Output

Details

setQueuejump to class

Arguments

Output

Details

toArrayjump to class

Output

Details

Zend_Queue_Message
jump to top

$_connected
jump to class

$_data
jump to class

$_queue
jump to class

$_queueClass
jump to class

__construct
jump to class

__get
jump to class

__isset
jump to class

__set
jump to class

__sleep
jump to class

__wakeup
jump to class

getQueue
jump to class

getQueueClass
jump to class

setFromArray
jump to class

setQueue
jump to class

toArray
jump to class