https://github.com/phpmentors-jp/stagehand-fsm

A finite state machine
https://github.com/phpmentors-jp/stagehand-fsm

Last synced: about 2 months ago
JSON representation

A finite state machine

• Host: GitHub
• URL: https://github.com/phpmentors-jp/stagehand-fsm
• Owner: phpmentors-jp
• License: bsd-2-clause
• Created: 2009-02-12T12:07:20.000Z (almost 16 years ago)
• Default Branch: master
• Last Pushed: 2022-07-19T01:33:07.000Z (over 2 years ago)
• Last Synced: 2024-11-09T16:14:05.670Z (2 months ago)
• Language: PHP
• Homepage: https://github.com/phpmentors-jp/stagehand-fsm/wiki
• Size: 525 KB
• Stars: 36
• Watchers: 4
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Stagehand_FSM

A finite state machine

[![Total Downloads](https://poser.pugx.org/piece/stagehand-fsm/downloads.png)](https://packagist.org/packages/piece/stagehand-fsm)

[![Latest Stable Version](https://poser.pugx.org/piece/stagehand-fsm/v/stable.png)](https://packagist.org/packages/piece/stagehand-fsm)

[![Latest Unstable Version](https://poser.pugx.org/phpmentors/stagehand-fsm/v/unstable.png)](https://packagist.org/packages/phpmentors/stagehand-fsm)

[![Build Status](https://travis-ci.org/phpmentors-jp/stagehand-fsm.svg?branch=master)](https://travis-ci.org/phpmentors-jp/stagehand-fsm)

`Stagehand_FSM` is a [finite state machine](https://en.wikipedia.org/wiki/Finite-state_machine).

Manual state management makes code complex, decreases intentionality. By using `Stagehand_FSM`, state management code can be declaratively represented in the form of FSM. This makes code simpler, increases intentionality.

`Stagehand_FSM` can be used as an infrastructure for [domain-specific languages](http://en.wikipedia.org/wiki/Domain-specific_language) (DSLs). Examples are workflow engines such as [Workflower](https://github.com/phpmentors-jp/workflower), pageflow engines such as [PHPMentorsPageflowerBundle](https://github.com/phpmentors-jp/pageflower-bundle).

```php

addState('locked');

$stateMachineBuilder->addState('unlocked');

$stateMachineBuilder->setStartState('locked');

$stateMachineBuilder->addTransition('locked', 'insertCoin', 'unlocked');

$stateMachineBuilder->addTransition('unlocked', 'pass', 'locked');

$stateMachine = $stateMachineBuilder->getStateMachine();

$stateMachine->start();

echo $stateMachine->getCurrentState()->getStateID() . PHP_EOL; // "locked"

$stateMachine->triggerEvent('insertCoin');

echo $stateMachine->getCurrentState()->getStateID() . PHP_EOL; // "unlocked"

$stateMachine->triggerEvent('pass');

echo $stateMachine->getCurrentState()->getStateID() . PHP_EOL; // "locked"

```

## Features

* Activities (do actions)

* Entry actions

* Exit actions

* Transition actions

* Transition logging

* Guards

* Initial pseudo state

* Final state

* User-defined payload

* User-defined event dispatcher for the state machine events

## Installation

`Stagehand_FSM` can be installed using [Composer](http://getcomposer.org/).

Add the dependency to `piece/stagehand-fsm` into your `composer.json` file as the following:

Stable version:

```

composer require piece/stagehand-fsm "2.6.*"

```

Development version:

```

composer require phpmentors/stagehand-fsm "~3.0@dev"

```

## Support

If you find a bug or have a question, or want to request a feature, create an issue or pull request for it on [Issues](https://github.com/phpmentors-jp/stagehand-fsm/issues).

## Copyright

Copyright (c) 2006-2008, 2011-2018 KUBO Atsuhiro, All rights reserved.

## License

[The BSD 2-Clause License](http://opensource.org/licenses/BSD-2-Clause)