• Home
• izzum
• statemachine
• Context

PHP Class izzum\statemachine\Context

A Context is created by your application to provide the right dependencies ('context') for the statemachine to work with. It seperates the concerns for the statemachine of how you are reading/writing state data and of how you access your domain models. Important are: - the entity id, which references an application domain specific object like 'Order' or 'Customer' that goes through some finite states in it's lifecycle. - the machine name, which is the type identifier for the machine and related to the entity (eg: 'order-machine') - persistence adapter, which reads/writes to/from a storage facility - entity_builder, which constructs the stateful entity. The entity is the object that will be acted upon by the Statemachine. This stateful object will be uniquely identified by it's id, which will mostly be some sort of primary key for that object that is defined by the application specific implementation. A reference to the stateful object can be obtained via the factory method getEntity(). This class delegates reading and writing states to specific implementations of the Adapter classes. this is useful for testing and creating specific behaviour for statemachines that need extra functionality to get and set the correct states. ファイルを表示 Open project: rolfvreijdenberger/izzum-statemachine Class Usage Examples

Protected Properties

Property	Type	Description
$entity_builder	EntityBuilder	the builder to get the reference to the entity.
$identifier	Identifier	the Identifier that uniquely identifies the statemachine
$persistence_adapter	izzum\statemachine\persistence\Adapter	the instance for getting to the persistence layer
$statemachine	StateMachine	Only a statemachine that uses this Context should set itself on the Context, providing a bidirectional association.

Public Methods

Method	Description
__construct ( Identifier $identifier, EntityBuilder $entity_builder = null, Adapter $persistence_adapter = null )	Constructor
__toString ( )
add ( string $state, string $message = null ) : boolean	adds the state data to the persistence layer if it is not there.
getBuilder ( ) : EntityBuilder	returns the builder used to get the application domain specific model.
getEntity ( boolean $create_fresh_entity = false ) : mixed	Gets a (cached) reference to the application domain specific model, for example an 'Order' or 'Customer' that transitions through states in it's lifecycle.
getEntityId ( ) : string	gets the entity id that represents the unique identifier for the application domain specific model.
getId ( boolean $readable = false, boolean $with_state = false ) : string	get the unique identifier for an Context, which consists of the machine name and the entity_id in parseable form, with an optional state
getIdentifier ( ) : Identifier	get the Identifier
getMachine ( ) : string	gets the statemachine name that handles the entity
getPersistenceAdapter ( ) : Adapter	gets the Context state reader/writer.
getState ( ) : string	gets the state.
getStateMachine ( ) : StateMachine	gets the associated statemachine (if a statemachine is associated)
setFailedTransition ( Transition $transition, Exception $e )	stores a failed transition, called by the statemachine This is a transition that has failed since it: - was not allowed - where an exception was thrown from a rule or command - etc. any general transition failure
setState ( string $state, string $message = null ) : boolan	Sets the state
setStateMachine ( StateMachine $statemachine )	Provides a bidirectional association with the statemachine.
toString ( ) : string	get the toString representation

Method Details

Property Details