! eZKernel The class eZWorkflow does More...

Inheritance diagram for eZWorkflow:

Collaboration diagram for eZWorkflow:

Public Member Functions
	cleanupWorkFlowProcess ()
	creator ()
	eZWorkflow ($row)
	fetchEventCount ($version=false)
	fetchEventIndexed ($index)
	fetchEvents ($asObject=true, $version=false)
	groupList ()
	ingroupIDList ()
	ingroupList ()
	isAllowed ($moduleName, $functionName, $connectType)
	modifier ()
	removeThis ($remove_childs=false)
	setVersion ($version, $set_childs=false)
	store ($store_childs=false)
	storeDefined ($store_childs=false)
	workflowType ()
Static Public Member Functions
static	adjustEventPlacements ($events)
static	create ($user_id)
static	definition ()
	Returns the definition for the object, the default implementation is to return an empty array.
static	fetch ($id, $asObject=true, $version=0)
static	fetchEventCountByWorkflowID ($id, $version=0)
static	fetchEventsByWorkflowID ($id, $asObject=true, $version=0)
static	fetchLimited ($moduleName, $functionName, $connectType)
static	fetchList ($version=0, $enabled=1, $asObject=true)
static	fetchListCount ($version=0, $enabled=1)
static	removeEvents ($events=false, $id=false, $version=false)
static	removeTemporary ()
static	removeWorkflow ($id, $version)
static	setIsEnabled ($enabled, $id, $version=0)
static	statusName ($status)
static	statusNameMap ()
	Get status name map.
Public Attributes
	$AllGroups
	$Created
	$CreatorID
	$ID
	$InGroupIDs
	$InGroups
	$IsEnabled
	$Modified
	$ModifierID
	$Name
	$Version
	$WorkflowTypeString
const	STATUS_BUSY = 1
const	STATUS_CANCELLED = 5
const	STATUS_DEFERRED_TO_CRON = 4
const	STATUS_DONE = 2
const	STATUS_FAILED = 3
const	STATUS_FETCH_TEMPLATE = 6
const	STATUS_FETCH_TEMPLATE_REPEAT = 10
const	STATUS_NONE = 0
const	STATUS_REDIRECT = 7
const	STATUS_RESET = 8
const	STATUS_WAITING_PARENT = 9

Detailed Description

! eZKernel The class eZWorkflow does

Definition at line 17 of file ezworkflow.php.

Member Function Documentation

static eZWorkflow::adjustEventPlacements ( $ events ) [static]

Definition at line 223 of file ezworkflow.php.

eZWorkflow::cleanupWorkFlowProcess ( )

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 522 of file ezworkflow.php.

static eZWorkflow::create ( $ user_id ) [static]

Definition at line 105 of file ezworkflow.php.

eZWorkflow::creator ( )

Definition at line 465 of file ezworkflow.php.

static eZWorkflow::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: public 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" ); }

Returns:: array

Reimplemented from eZPersistentObject.

Definition at line 36 of file ezworkflow.php.

Referenced by fetch(), fetchList(), fetchListCount(), removeWorkflow(), and setIsEnabled().

eZWorkflow::eZWorkflow ( $ row )

Definition at line 31 of file ezworkflow.php.

Referenced by create().

static eZWorkflow::fetch	(	$	id,
		$	asObject = `true`,
		$	version = `0`
	)		`[static]`

Definition at line 307 of file ezworkflow.php.

Referenced by creator(), eZMultiplexerType\execute(), modifier(), and eZWorkflowFunctions\removeGroup().

eZWorkflow::fetchEventCount ( $ version = false )

Definition at line 431 of file ezworkflow.php.

static eZWorkflow::fetchEventCountByWorkflowID	(	$	id,
		$	version = `0`
	)		`[static]`

Definition at line 450 of file ezworkflow.php.

eZWorkflow::fetchEventIndexed ( $ index )

Definition at line 394 of file ezworkflow.php.

eZWorkflow::fetchEvents	(	$	asObject = `true`,
		$	version = `false`
	)

Definition at line 413 of file ezworkflow.php.

Referenced by cleanupWorkFlowProcess(), isAllowed(), setVersion(), store(), and storeDefined().

static eZWorkflow::fetchEventsByWorkflowID	(	$	id,
		$	asObject = `true`,
		$	version = `0`
	)		`[static]`

Definition at line 424 of file ezworkflow.php.

static eZWorkflow::fetchLimited	(	$	moduleName,
		$	functionName,
		$	connectType
	)		`[static]`

Fetch workflows based on module, function and connection type

Parameters:

$moduleName	module name
$functionName	function name
$connectType	connection type

Returns:: array of allowed workflows limited by trigger

Definition at line 326 of file ezworkflow.php.

Referenced by eZTrigger\fetchAllowedWorkflows().

static eZWorkflow::fetchList	(	$	version = `0`,
		$	enabled = `1`,
		$	asObject = `true`
	)		`[static]`

Definition at line 369 of file ezworkflow.php.

Referenced by eZMultiplexerType\attribute(), fetchLimited(), groupList(), removeSelectedGroups(), and removeTemporary().

static eZWorkflow::fetchListCount	(	$	version = `0`,
		$	enabled = `1`
	)		`[static]`

Definition at line 379 of file ezworkflow.php.

eZWorkflow::groupList ( )

Definition at line 507 of file ezworkflow.php.

eZWorkflow::ingroupIDList ( )

Definition at line 493 of file ezworkflow.php.

eZWorkflow::ingroupList ( )

Definition at line 485 of file ezworkflow.php.

eZWorkflow::isAllowed	(	$	moduleName,
		$	functionName,
		$	connectType
	)

Check if a trigger specified trigger is allowed to use with this workflow

Parameters:

$moduleName	module name
$functionName	function name
$connectType	connection type

Returns:: true if allowed, false if not.

Definition at line 353 of file ezworkflow.php.

Referenced by fetchLimited().

eZWorkflow::modifier ( )

Definition at line 475 of file ezworkflow.php.

static eZWorkflow::removeEvents	(	$	events = `false`,
		$	id = `false`,
		$	version = `false`
	)		`[static]`

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 195 of file ezworkflow.php.

static eZWorkflow::removeTemporary ( ) [static]

Removes all temporary versions.

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 175 of file ezworkflow.php.

eZWorkflow::removeThis ( $ remove_childs = false )

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 147 of file ezworkflow.php.

static eZWorkflow::removeWorkflow	(	$	id,
		$	version
	)		`[static]`

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 136 of file ezworkflow.php.

static eZWorkflow::setIsEnabled	(	$	enabled,
		$	id,
		$	version = `0`
	)		`[static]`

Definition at line 121 of file ezworkflow.php.

eZWorkflow::setVersion	(	$	version,
		$	set_childs = `false`
	)

Definition at line 287 of file ezworkflow.php.

static eZWorkflow::statusName ( $ status ) [static]

Definition at line 97 of file ezworkflow.php.

static eZWorkflow::statusNameMap ( ) [static]

Get status name map.

Returns:: array Status name map.

Definition at line 551 of file ezworkflow.php.

Referenced by eZWorkflowFunctionCollection\fetchWorkflowStatuses(), and statusName().

eZWorkflow::store ( $ store_childs = false )

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.

Reimplemented from eZPersistentObject.

Definition at line 238 of file ezworkflow.php.

Referenced by storeDefined().

eZWorkflow::storeDefined ( $ store_childs = false )

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 264 of file ezworkflow.php.

eZWorkflow::workflowType ( )

Definition at line 513 of file ezworkflow.php.