Queue/Message/PlatformJob.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: PlatformJob.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Queue_Message_PlatformJob
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_PlatformJob
- Extends from
- Zend_Queue_Message
- 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
- $_job
- $_id
- Methods
- __construct
- setJobId
- getJobId
- getJob
- __sleep
- getQueueClass
- _setJobProperties
Description
Class for managing Zend Platform JobQueue jobs via Zend_Queue
Properties
$_id
string $_id = 'null'Job identifier
Details
- $_id
- string
- visibility
- protected
- default
- null
- final
- false
- static
- false
$_job
ZendApi_Job $_job = ''
Details
- $_job
- ZendApi_Job
- visibility
- protected
- default
- final
- false
- static
- false
Methods
__construct
__construct(
array $options
=
array
)
:
voidConstructor
The constructor should be an array of options.
If the option 'data' is provided, and is an instance of ZendApi_Job, that object will be used as the internal job; if that option is not a ZendApi_Job instance, an exception will be thrown.
Alternately, you may specify the 'script' parameter, which should be a JobQueue script the job will request. A new ZendApi_Job object will then be created using that script and any options you provide.
Arguments
- $options
- array
Details
- visibility
- public
- final
- false
- static
- false
- throws
__sleep
__sleep(
)
:
arrayStore queue and data in serialized object
Output
- array
Details
- visibility
- public
- final
- false
- static
- false
_setJobProperties
_setJobProperties(
)
:
voidSets properties on the ZendApi_Job instance
Any options in the {@link $_data} array will be checked. Those matching options in ZendApi_Job will be used to set those options in that instance.
Details
- visibility
- protected
- final
- false
- static
- false
getJob
getJob(
)
:
ZendApi_JobRetrieve the internal ZendApi_Job instance
Output
- ZendApi_Job
Details
- visibility
- public
- final
- false
- static
- false
getJobId
getJobId(
)
:
stringRetrieve the job identifier
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
getQueueClass
getQueueClass(
)
:
stringQuery the class name of the Queue object for which this Message was created.
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
setJobId
setJobId(
string $id
)
:
Zend_Queue_Message_PlatformJobSet the job identifier
Used within Zend_Queue only.
Arguments
- $id
- string
Details
- visibility
- public
- final
- false
- static
- false