eZ Publish: eZWorkflowType Class Reference

eZ Publish [trunk]

! eZKernel The class eZWorkflowType does More...

Inheritance diagram for eZWorkflowType:

List of all members.

Public Member Functions
	attribute ($attr)
	attributeDecoder ($event, $attr)
	attributes ()
	cleanup ($process, $event)
	cleanupAfterRemoving ($attr=array())
	customWorkflowEventHTTPAction ($http, $action, $workflowEvent)
	eventDescription ()
	execute ($process, $event)
	eZWorkflowType ($group, $type, $groupName, $name)
	fetchHTTPInput ($http, $base, $event)
	fixupHTTPInput ($http, $base, $event)
	hasAttribute ($attr)
	initializeEvent ($event)
	isAllowed ($moduleName, $functionName, $connectType)
	needCleanup ()
	setActivationDate ($date)
	setAttribute ($attr, $value)
	setInformation ($inf)
	setTriggerTypes ($allowedTypes)
	storeDefinedEventData ($event)
	storeEventData ($event, $version)
	typeFunctionalAttributes ()
	validateHTTPInput ($http, $base, $event, &$validation)
	workflowEventContent ($event)
Static Public Member Functions
static	allowedTypes ()
static	createType ($typeString)
static	fetchRegisteredTypes ()
static	loadAndRegisterAllTypes ()
static	loadAndRegisterType ($typeString)
static	registerType ($group, $type, $class_name)
static	statusName ($status)
static	statusNameMap ()
	Get status name map.
Public Attributes
	$ActivationDate
	$Group
	$GroupName
	$Information
	$Name
	$TriggerTypes = array( '*' => true )
	$Type
	$TypeString
const	STATUS_ACCEPTED = 1
const	STATUS_DEFERRED_TO_CRON = 3
const	STATUS_DEFERRED_TO_CRON_REPEAT = 4
const	STATUS_FETCH_TEMPLATE = 7
const	STATUS_FETCH_TEMPLATE_REPEAT = 8
const	STATUS_NONE = 0
const	STATUS_REDIRECT = 10
const	STATUS_REDIRECT_REPEAT = 11
const	STATUS_REJECTED = 2
const	STATUS_RUN_SUB_EVENT = 5
const	STATUS_WORKFLOW_CANCELLED = 6
const	STATUS_WORKFLOW_DONE = 9
const	STATUS_WORKFLOW_RESET = 12

Detailed Description

! eZKernel The class eZWorkflowType does

Definition at line 17 of file ezworkflowtype.php.

Member Function Documentation

static eZWorkflowType::allowedTypes ( ) [static]

Definition at line 121 of file ezworkflowtype.php.

Referenced by loadAndRegisterAllTypes().

eZWorkflowType::attribute ( $ attr )

Reimplemented in eZPaymentGatewayType, eZApproveType, eZMultiplexerType, and eZWaitUntilDateType.

Definition at line 217 of file ezworkflowtype.php.

eZWorkflowType::attributeDecoder	(	$	event,
		$	attr
	)

Reimplemented in eZPaymentGatewayType, eZFinishUserRegisterType, eZApproveType, and eZMultiplexerType.

Definition at line 312 of file ezworkflowtype.php.

eZWorkflowType::attributes ( )

Reimplemented in eZPaymentGatewayType, eZApproveType, eZMultiplexerType, eZWaitUntilDateType, and eZFinishUserRegisterType.

Definition at line 205 of file ezworkflowtype.php.

Referenced by eZFinishUserRegisterType\attributes(), eZWaitUntilDateType\attributes(), eZMultiplexerType\attributes(), eZApproveType\attributes(), eZPaymentGatewayType\attributes(), and hasAttribute().

eZWorkflowType::cleanup	(	$	process,
		$	event
	)

Reimplemented in eZPaymentGatewayType.

Definition at line 308 of file ezworkflowtype.php.

eZWorkflowType::cleanupAfterRemoving ( $ attr = array() )

Reimplemented in eZApproveType.

Definition at line 304 of file ezworkflowtype.php.

static eZWorkflowType::createType ( $ typeString ) [static]

Definition at line 61 of file ezworkflowtype.php.

Referenced by eZWorkflowEvent\eventType(), and eZWorkflow\workflowType().

eZWorkflowType::customWorkflowEventHTTPAction	(	$	http,
		$	action,
		$	workflowEvent
	)

Reimplemented in eZApproveType, and eZWaitUntilDateType.

Definition at line 322 of file ezworkflowtype.php.

eZWorkflowType::eventDescription ( )

Definition at line 261 of file ezworkflowtype.php.

Referenced by attribute().

eZWorkflowType::execute	(	$	process,
		$	event
	)

Reimplemented in eZMultiplexerType, eZApproveType, eZPaymentGatewayType, eZWaitUntilDateType, eZSimpleShippingType, and eZFinishUserRegisterType.

Definition at line 266 of file ezworkflowtype.php.

eZWorkflowType::eZWorkflowType	(	$	group,
		$	type,
		$	groupName,
		$	name
	)

Definition at line 33 of file ezworkflowtype.php.

Referenced by eZWorkflowEventType\eZWorkflowEventType(), and eZWorkflowGroupType\eZWorkflowGroupType().

eZWorkflowType::fetchHTTPInput	(	$	http,
		$	base,
		$	event
	)

Reimplemented in eZApproveType, eZPaymentGatewayType, eZMultiplexerType, and eZWaitUntilDateType.

Definition at line 285 of file ezworkflowtype.php.

static eZWorkflowType::fetchRegisteredTypes ( ) [static]

Definition at line 95 of file ezworkflowtype.php.

Referenced by eZContentObject\purge().

eZWorkflowType::fixupHTTPInput	(	$	http,
		$	base,
		$	event
	)

Definition at line 280 of file ezworkflowtype.php.

eZWorkflowType::hasAttribute ( $ attr )

Reimplemented in eZPaymentGatewayType, eZApproveType, eZMultiplexerType, and eZWaitUntilDateType.

Definition at line 212 of file ezworkflowtype.php.

eZWorkflowType::initializeEvent ( $ event )

Reimplemented in eZPaymentGatewayType, eZMultiplexerType, and eZApproveType.

Definition at line 271 of file ezworkflowtype.php.

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

Check if specified trigger is allowed

Parameters:

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

Returns:: true is allowed, false if not.

Definition at line 345 of file ezworkflowtype.php.

static eZWorkflowType::loadAndRegisterAllTypes ( ) [static]

Definition at line 133 of file ezworkflowtype.php.

Referenced by fetchRegisteredTypes().

static eZWorkflowType::loadAndRegisterType ( $ typeString ) [static]

Definition at line 159 of file ezworkflowtype.php.

Referenced by createType(), and loadAndRegisterAllTypes().

eZWorkflowType::needCleanup ( )

Reimplemented in eZPaymentGatewayType.

Definition at line 299 of file ezworkflowtype.php.

static eZWorkflowType::registerType	(	$	group,
		$	type,
		$	class_name
	)		`[static]`

Definition at line 142 of file ezworkflowtype.php.

Referenced by eZWorkflowEventType\registerEventType(), and eZWorkflowGroupType\registerGroupType().

eZWorkflowType::setActivationDate ( $ date )

Definition at line 289 of file ezworkflowtype.php.

Referenced by eZWaitUntilDateType\execute(), and eZMultiplexerType\execute().

eZWorkflowType::setAttribute	(	$	attr,
		$	value
	)

Definition at line 242 of file ezworkflowtype.php.

eZWorkflowType::setInformation ( $ inf )

Definition at line 294 of file ezworkflowtype.php.

Referenced by eZWaitUntilDateType\execute(), and eZApproveType\execute().

eZWorkflowType::setTriggerTypes ( $ allowedTypes )

Set trigger types.

Parameters:

allowed trigger types format : array( <module> => array( <function> => array( <event> ) ) ) if all is allowed, array( '*' => true )

Definition at line 256 of file ezworkflowtype.php.

Referenced by eZFinishUserRegisterType\__construct(), eZApproveType\eZApproveType(), eZSimpleShippingType\eZSimpleShippingType(), and eZWaitUntilDateType\eZWaitUntilDateType().

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

Definition at line 53 of file ezworkflowtype.php.

Referenced by eZWorkflowProcess\run().

static eZWorkflowType::statusNameMap ( ) [static]

Get status name map.

Returns:: array Status name map

Definition at line 370 of file ezworkflowtype.php.

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

eZWorkflowType::storeDefinedEventData ( $ event )

Reimplemented in eZWaitUntilDateType.

Definition at line 333 of file ezworkflowtype.php.

eZWorkflowType::storeEventData	(	$	event,
		$	version
	)

Reimplemented in eZWaitUntilDateType.

Definition at line 330 of file ezworkflowtype.php.

eZWorkflowType::typeFunctionalAttributes ( )

Reimplemented in eZPaymentGatewayType, eZApproveType, eZMultiplexerType, and eZFinishUserRegisterType.

Definition at line 317 of file ezworkflowtype.php.

eZWorkflowType::validateHTTPInput	(	$	http,
		$	base,
		$	event,
		&$	validation
	)

Reimplemented in eZApproveType.

Definition at line 275 of file ezworkflowtype.php.

eZWorkflowType::workflowEventContent ( $ event )

Reimplemented in eZWaitUntilDateType.

Definition at line 326 of file ezworkflowtype.php.

Member Data Documentation

eZWorkflowType::$ActivationDate

Definition at line 388 of file ezworkflowtype.php.

eZWorkflowType::$Group

Definition at line 383 of file ezworkflowtype.php.

eZWorkflowType::$GroupName

Definition at line 386 of file ezworkflowtype.php.

eZWorkflowType::$Information

Definition at line 389 of file ezworkflowtype.php.

eZWorkflowType::$Name

Definition at line 387 of file ezworkflowtype.php.

eZWorkflowType::$TriggerTypes = array( '*' => true )

Definition at line 390 of file ezworkflowtype.php.

eZWorkflowType::$Type

Definition at line 384 of file ezworkflowtype.php.

eZWorkflowType::$TypeString

Definition at line 385 of file ezworkflowtype.php.

const eZWorkflowType::STATUS_ACCEPTED = 1

Definition at line 20 of file ezworkflowtype.php.

Referenced by eZApproveType\checkApproveCollaboration(), eZSimpleShippingType\execute(), eZWaitUntilDateType\execute(), eZRedirectGateway\execute(), eZApproveType\execute(), eZMultiplexerType\execute(), and eZWorkflowProcess\run().

const eZWorkflowType::STATUS_DEFERRED_TO_CRON = 3

Definition at line 22 of file ezworkflowtype.php.

Referenced by eZApproveType\execute(), and eZWorkflowProcess\run().

const eZWorkflowType::STATUS_DEFERRED_TO_CRON_REPEAT = 4

Definition at line 23 of file ezworkflowtype.php.

Referenced by eZApproveType\checkApproveCollaboration(), eZWaitUntilDateType\execute(), eZApproveType\execute(), eZMultiplexerType\execute(), and eZWorkflowProcess\run().

const eZWorkflowType::STATUS_FETCH_TEMPLATE = 7

Definition at line 26 of file ezworkflowtype.php.

Referenced by eZWorkflowProcess\run().

const eZWorkflowType::STATUS_FETCH_TEMPLATE_REPEAT = 8

Definition at line 27 of file ezworkflowtype.php.

Referenced by eZPaymentGatewayType\execute(), eZMultiplexerType\execute(), and eZWorkflowProcess\run().

const eZWorkflowType::STATUS_NONE = 0

Definition at line 19 of file ezworkflowtype.php.

Referenced by execute(), and eZWorkflowProcess\run().

const eZWorkflowType::STATUS_REDIRECT = 10

Definition at line 28 of file ezworkflowtype.php.

Referenced by eZWorkflowProcess\run().

const eZWorkflowType::STATUS_REDIRECT_REPEAT = 11

Definition at line 30 of file ezworkflowtype.php.

Referenced by eZRedirectGateway\execute(), eZMultiplexerType\execute(), and eZWorkflowProcess\run().

const eZWorkflowType::STATUS_REJECTED = 2

Definition at line 21 of file ezworkflowtype.php.

Referenced by eZPaymentGateway\execute(), eZRedirectGateway\execute(), eZPaymentGatewayType\execute(), eZMultiplexerType\execute(), and eZWorkflowProcess\run().

const eZWorkflowType::STATUS_RUN_SUB_EVENT = 5

Definition at line 24 of file ezworkflowtype.php.

Referenced by eZWorkflowProcess\run().

const eZWorkflowType::STATUS_WORKFLOW_CANCELLED = 6

Definition at line 25 of file ezworkflowtype.php.

Referenced by eZApproveType\checkApproveCollaboration(), eZWaitUntilDateType\execute(), eZApproveType\execute(), eZMultiplexerType\execute(), and eZWorkflowProcess\run().

const eZWorkflowType::STATUS_WORKFLOW_DONE = 9

Definition at line 29 of file ezworkflowtype.php.

Referenced by eZWorkflowProcess\run().

const eZWorkflowType::STATUS_WORKFLOW_RESET = 12

Definition at line 31 of file ezworkflowtype.php.

Referenced by eZWorkflowProcess\run().

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

ezworkflowtype.php

eZWorkflowType