1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Workflow
  7. \
  8. StateMachine

StateMachine

class StateMachine extends Workflow

Methods

__construct(Definition $definition, MarkingStoreInterface $markingStore = null, EventDispatcherInterface $dispatcher = null, string $name = 'unnamed')

No description

Marking
getMarking(object $subject)

Returns the object's Marking.

from Workflow
bool
can(object $subject, string $transitionName)

Returns true if the transition is enabled.

from Workflow
TransitionBlockerList
buildTransitionBlockerList($subject, string $transitionName)

Builds a TransitionBlockerList to know why a transition is blocked.

from Workflow
Marking
apply(object $subject, string $transitionName)

Fire a transition.

from Workflow
Transition[]
getEnabledTransitions(object $subject)

Returns all enabled transitions.

from Workflow
string
getName()

No description

from Workflow
Definition
getDefinition()

No description

from Workflow
MarkingStoreInterface
getMarkingStore()

No description

from Workflow
MetadataStoreInterface
getMetadataStore()

No description

from Workflow

Details

__construct(Definition $definition, MarkingStoreInterface $markingStore = null, EventDispatcherInterface $dispatcher = null, string $name = 'unnamed')

Parameters

Definition $definition
MarkingStoreInterface $markingStore
EventDispatcherInterface $dispatcher
string $name

Marking getMarking(object $subject)

Returns the object's Marking.

Parameters

object $subject A subject

Return Value

Marking The Marking

Exceptions

LogicException

bool can(object $subject, string $transitionName)

Returns true if the transition is enabled.

Parameters

object $subject A subject
string $transitionName A transition

Return Value

bool true if the transition is enabled

TransitionBlockerList buildTransitionBlockerList($subject, string $transitionName)

Builds a TransitionBlockerList to know why a transition is blocked.

Parameters

$subject
string $transitionName

Return Value

TransitionBlockerList

Marking apply(object $subject, string $transitionName)

Fire a transition.

Parameters

object $subject A subject
string $transitionName A transition

Return Value

Marking The new Marking

Exceptions

LogicException If the transition is not applicable

Transition[] getEnabledTransitions(object $subject)

Returns all enabled transitions.

Parameters

object $subject A subject

Return Value

Transition[] All enabled transitions

string getName()

Return Value

string

Definition getDefinition()

Return Value

Definition

MarkingStoreInterface getMarkingStore()

Return Value

MarkingStoreInterface

MetadataStoreInterface getMetadataStore()

Return Value

MetadataStoreInterface