IEntity Interface Reference

Inheritance diagram for IEntity:

Collaboration diagram for IEntity:

Public Member Functions
	getState ()
	setState ($state, $time)
	processEvent ($function, $result)
Public Member Functions inherited from IEntity
	setEngine (IEngine $workflow)

---

Detailed Description

Interface for state workflow entity implementations

---

Member Function Documentation

getState

(

)

Gets current state of instance

User classes must provide implementation to retrieve and return the object state for use in state workflow rules.

Returns:

string object state

Here is the caller graph for this function:

processEvent	(		$function,
			$result
	)

Processes given function and result

Implementing classes must process function and result and set the next state as defined in state workflow definition.

Parameters:

string	$function	function executed
string	$result	result of the executed function

Implemented in Entity.

setState	(		$state,
			$time
	)

Sets current state of instance

User classes must provide implementation to store the object state. The state should be durable.

Parameters:

string	$state	state to store
integer	$time	timestamp of this event

Here is the caller graph for this function:

---

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

• lib360/workflow/state/IEntity.php