ReferenceInterface Interface Reference

Inheritance diagram for ReferenceInterface

Public Member Functions
	invalidateCache ()
	Invalidate cached data. More...
	getState ()
	Read state machine state. More...
	getDefinition ()
	Get state machine definition. More...
	isTransitionAllowed (string $transitionName)
	Return true when the transition is available. More...
	invokeTransition (string $transitionName,... $args)
	Invoke transition of the state machine. More...
	get (string $propertyName)
	Return value of the given property. More...
	getMachineType ()
	Get state machine type. More...
	getMachineId ()
	Get ID of the state machine. More...

Public Attributes
const	NOT_EXISTS = ""

Member Function Documentation

invalidateCache()

invalidateCache

(

)

Invalidate cached data.

Todo:

Remove invalidateCache() and implement proper locking before invoking a transition.

getState()

getState

(

)

Read state machine state.

getDefinition()

getDefinition

(

)

Get state machine definition.

isTransitionAllowed()

isTransitionAllowed

(

string

$transitionName

)

Return true when the transition is available.

invokeTransition()

invokeTransition	(	string	$transitionName,
			$args
	)

Invoke transition of the state machine.

get()

get

(

string

$propertyName

)

Return value of the given property.

getMachineType()

getMachineType ( )

inherited

Get state machine type.

getMachineId()

getMachineId ( )

inherited

Get ID of the state machine.

The ID must be unique within state machine type.

Member Data Documentation

NOT_EXISTS

const NOT_EXISTS = ""