eZWorkflowProcess Class Reference

Inheritance diagram for eZWorkflowProcess:

Collaboration diagram for eZWorkflowProcess:

List of all members.

Public Member Functions
	advance ($next_event_id=0, $next_event_pos=0, $status=0)
	advanceToNext ()
	content ()
	currentEvent ()
	eZWorkflowProcess ($row)
	lastWorkflowEvent ()
	node ()
	parameterList ()
	removeThis ()
	reset ()
	run (&$workflow, &$workflowEvent, &$eventLog)
	setParameters ($parameterList=null)
	user ()
	workflow ()
	workflowEvent ()
Static Public Member Functions
	cleanup ()
static	create ($processKey, $parameters)
static	createKey ($parameters, $keys=null)
static	definition ()
static	fetch ($id, $asObject=true)
static	fetchForContent ($workflowID, $userID, $contentID, $contentVersion, $nodeID, $asObject=true)
static	fetchForSession ($sessionKey, $workflowID, $asObject=true)
static	fetchForStatus ($status=eZWorkflow::STATUS_DEFERRED_TO_CRON, $asObject=true)
static	fetchList ($conds=null, $asObject=true, $offset=false, $limit=false)
static	fetchListByKey ($searchKey, $asObject=true)
static	fetchUserList ($userID, $asObject=true)
Public Attributes
	$ActivationDate
	$ContentID
	$Created
	$EventID
	$EventPosition
	$EventStatus
	$ID
	$LastEventID
	$LastEventPosition
	$LastEventStatus
	$Modified
	$NodeID
	$UserID
	$WorkflowID

---

Detailed Description

Definition at line 37 of file ezworkflowprocess.php.

---

Member Function Documentation

eZWorkflowProcess::advance	(	$	next_event_id = 0,
		$	next_event_pos = 0,
		$	status = 0
	)

Definition at line 186 of file ezworkflowprocess.php.

Referenced by run().

eZWorkflowProcess::advanceToNext

(

)

Definition at line 559 of file ezworkflowprocess.php.

eZWorkflowProcess::cleanup

(

)

[static]

Removes all workflow processes from database.

Note:

Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 668 of file ezworkflowprocess.php.

eZWorkflowProcess::content

(

)

Definition at line 583 of file ezworkflowprocess.php.

static eZWorkflowProcess::create	(	$	processKey,
		$	parameters
	)		[static]

Definition at line 150 of file ezworkflowprocess.php.

Referenced by eZMultiplexerType\execute(), and eZTrigger\runTrigger().

static eZWorkflowProcess::createKey	(	$	parameters,
		$	keys = null
	)		[static]

Definition at line 470 of file ezworkflowprocess.php.

Referenced by eZMultiplexerType\execute(), and eZTrigger\runTrigger().

eZWorkflowProcess::currentEvent

(

)

Definition at line 555 of file ezworkflowprocess.php.

static eZWorkflowProcess::definition

(

)

[static]

Returns:

the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

• fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
• keys - an array of fields which is used for uniquely identifying the object in the table.
• function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
• set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
• increment_key - the field which is incremented on table inserts.
• class_name - the classname which is used for instantiating new objecs when fetching from the database.
• sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
• name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 44 of file ezworkflowprocess.php.

Referenced by fetch(), fetchForContent(), fetchForSession(), fetchForStatus(), fetchList(), fetchListByKey(), fetchUserList(), and removeThis().

eZWorkflowProcess::eZWorkflowProcess

(

$

row

)

Definition at line 39 of file ezworkflowprocess.php.

Referenced by create().

static eZWorkflowProcess::fetch	(	$	id,
		$	asObject = true
	)		[static]

Definition at line 453 of file ezworkflowprocess.php.

Referenced by content(), lastWorkflowEvent(), node(), removeThis(), run(), workflow(), and workflowEvent().

static eZWorkflowProcess::fetchForContent	(	$	workflowID,
		$	userID,
		$	contentID,
		$	contentVersion,
		$	nodeID,
		$	asObject = true
	)		[static]

Definition at line 517 of file ezworkflowprocess.php.

static eZWorkflowProcess::fetchForSession	(	$	sessionKey,
		$	workflowID,
		$	asObject = true
	)		[static]

Definition at line 546 of file ezworkflowprocess.php.

static eZWorkflowProcess::fetchForStatus	(	$	status = eZWorkflow::STATUS_DEFERRED_TO_CRON,
		$	asObject = true
	)		[static]

Definition at line 531 of file ezworkflowprocess.php.

static eZWorkflowProcess::fetchList	(	$	conds = null,
		$	asObject = true,
		$	offset = false,
		$	limit = false
	)		[static]

Definition at line 461 of file ezworkflowprocess.php.

static eZWorkflowProcess::fetchListByKey	(	$	searchKey,
		$	asObject = true
	)		[static]

Definition at line 501 of file ezworkflowprocess.php.

Referenced by eZMultiplexerType\execute(), and eZTrigger\runTrigger().

static eZWorkflowProcess::fetchUserList	(	$	userID,
		$	asObject = true
	)		[static]

Definition at line 509 of file ezworkflowprocess.php.

eZWorkflowProcess::lastWorkflowEvent

(

)

Definition at line 619 of file ezworkflowprocess.php.

eZWorkflowProcess::node

(

)

Definition at line 592 of file ezworkflowprocess.php.

eZWorkflowProcess::parameterList

(

)

Definition at line 628 of file ezworkflowprocess.php.

eZWorkflowProcess::removeThis

(

)

Note:

Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 641 of file ezworkflowprocess.php.

eZWorkflowProcess::reset

(

)

Definition at line 174 of file ezworkflowprocess.php.

Referenced by run().

eZWorkflowProcess::run	(	&$	workflow,
		&$	workflowEvent,
		&$	eventLog
	)

Definition at line 197 of file ezworkflowprocess.php.

eZWorkflowProcess::setParameters

(

$

parameterList = null

)

Definition at line 563 of file ezworkflowprocess.php.

eZWorkflowProcess::user

(

)

Definition at line 574 of file ezworkflowprocess.php.

eZWorkflowProcess::workflow

(

)

Definition at line 601 of file ezworkflowprocess.php.

eZWorkflowProcess::workflowEvent

(

)

Definition at line 610 of file ezworkflowprocess.php.

---

Member Data Documentation

eZWorkflowProcess::$ActivationDate

Definition at line 688 of file ezworkflowprocess.php.

eZWorkflowProcess::$ContentID

Definition at line 678 of file ezworkflowprocess.php.

eZWorkflowProcess::$Created

Definition at line 686 of file ezworkflowprocess.php.

eZWorkflowProcess::$EventID

Definition at line 680 of file ezworkflowprocess.php.

eZWorkflowProcess::$EventPosition

Definition at line 681 of file ezworkflowprocess.php.

eZWorkflowProcess::$EventStatus

Definition at line 685 of file ezworkflowprocess.php.

eZWorkflowProcess::$ID

Definition at line 675 of file ezworkflowprocess.php.

eZWorkflowProcess::$LastEventID

Definition at line 682 of file ezworkflowprocess.php.

eZWorkflowProcess::$LastEventPosition

Definition at line 683 of file ezworkflowprocess.php.

eZWorkflowProcess::$LastEventStatus

Definition at line 684 of file ezworkflowprocess.php.

eZWorkflowProcess::$Modified

Definition at line 687 of file ezworkflowprocess.php.

eZWorkflowProcess::$NodeID

Definition at line 679 of file ezworkflowprocess.php.

eZWorkflowProcess::$UserID

Definition at line 677 of file ezworkflowprocess.php.

eZWorkflowProcess::$WorkflowID

Definition at line 676 of file ezworkflowprocess.php.

---

The documentation for this class was generated from the following file:

• ezworkflowprocess.php