sbooker/workflow

Simple workflow for FSM implementation

2.0.0 2023-06-14 07:18 UTC

Requires

• php: ^8.1
• php-ds/php-ds: ^1.2

Requires (Dev)

• ext-dom: *
• ext-xml: *
• ext-xmlwriter: *
• phpunit/phpunit: ^10.2

MIT

• Sergey Knigin

• workflow
• state machine
• fsm

README

Installation

pecl install ds
composer require sbooker/workflow

Usage

// Step 1. Create Status Enum

use Sbooker\Workflow\Status;

enum ConcreteStatus: string implements Status
{
    use \Sbooker\Workflow\EnumTrait;
    
    case first = "first";
    case second = "second";
}

// Step 2. Define workflow

use Sbooker\Workflow\Workflow;
use Ds\Map;
use Ds\Set;

final class ConcreteWorkflow extends Workflow
{
    public function __construct()
    {
        parent::__construct(ConcreteStatus::first);
    }


    protected function buildTransitionMap(): Map
    {
        $map = new Map();
        $map->put(ConcreteStatus::first, new Set([ConcreteStatus::second]));
        return $map;
    }

    protected function getStatusClass(): string
    {
        return ConcreteStatus::class;
    }    
}

// Step 3. Use workflow in your entity for state control
class ConcreteEntity {
    // ...
    private ConcreteWorkflow $workflow;
    // ...

    public function __construct() {
        // ...
        $this->workflow = new ConcreteWorkflow();
        // ...
    }
    
    public function doSecond(): void {
        // ...
        $this->workflow->transitTo(ConcreteStatus::second());
        // ...
    }
} 

License

See LICENSE file.