interface WorkflowInterface

Describes a workflow instance.

Methods

Marking
getMarking(object$subject)

Returns the object's Marking.

bool
can(object$subject,string$transitionName)

Returns true if the transition is enabled.

TransitionBlockerList
buildTransitionBlockerList(object$subject,string$transitionName)

Builds a TransitionBlockerList to know why a transition is blocked.

Marking
apply(object$subject,string$transitionName,array$context =[])

Fire a transition.

array
getEnabledTransitions(object$subject)

Returns all enabled transitions.

string
getName()

No description

Definition
getDefinition()

No description

MetadataStoreInterface
getMetadataStore()

No description

Details

Marking getMarking(object$subject)

Returns the object's Marking.

Parameters

object $subject

Return Value

Marking

Exceptions

LogicException

bool can(object$subject,string$transitionName)

Returns true if the transition is enabled.

Parameters

object $subject
string $transitionName

Return Value

bool

TransitionBlockerList buildTransitionBlockerList(object$subject,string$transitionName)

Builds a TransitionBlockerList to know why a transition is blocked.

Parameters

object $subject
string $transitionName

Return Value

TransitionBlockerList

Marking apply(object$subject,string$transitionName,array$context =[])

Fire a transition.

Parameters

object $subject
string $transitionName
array $context

Return Value

Marking

Exceptions

LogicException If the transition is not applicable

array getEnabledTransitions(object$subject)

Returns all enabled transitions.

Parameters

object $subject

Return Value

array

string getName()

Return Value

string

Definition getDefinition()

Return Value

Definition

MarkingStoreInterface getMarkingStore()

Return Value

MarkingStoreInterface

MetadataStoreInterface getMetadataStore()

Return Value

MetadataStoreInterface