Workflow_ActionInterface Interface Reference

Provide a common interface for workflow actions. More...

Inheritance diagram for Workflow_ActionInterface:

List of all members.

Public Member Functions
	getOptions ()
	Get options attached to the action.
	invoke (Workflow_Model_Transition $transition, P4Cms_Record $record)
	Invoke this action for the given transition and record.
	setOptions (array $options)
	Set options for this action.

---

Detailed Description

Provide a common interface for workflow actions.

Workflow actions allow for automated tasks when a record under workflow changes state (for example, sending email notifications).

Copyright:

2011-2012 Perforce Software. All rights reserved

License:

Please see LICENSE.txt in top-level folder of this distribution.

Version:

2012.2/486814

---

Member Function Documentation

Workflow_ActionInterface::getOptions

(

)

Get options attached to the action.

Returns:

array action options.

Workflow_ActionInterface::invoke	(	Workflow_Model_Transition $	transition,
		P4Cms_Record $	record
	)

Invoke this action for the given transition and record.

Parameters:

Workflow_Model_Transition	$transition	transition to invoke this action for.
P4Cms_Record	$record	record to invoke this action for.

Returns:

Workflow_ActionInterface provides fluent interface.

Implemented in Workflow_Workflow_Action_Noop, and Workflow_Workflow_Action_SendEmail.

Workflow_ActionInterface::setOptions

(

array $

options

)

Set options for this action.

Parameters:

array

$options

action options to set.

---

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

• ActionInterface.php