README

Small Workflow Bundle

Symfony dependency-injection integration for small/workflow.

Install

composer require small/workflow-bundle (development currently depends on untagged small/workflow:dev-main). Enable Small\WorkflowBundle\SmallWorkflowBundle::class in config/bundles.php.

Configure

config/packages/small_workflow.yaml:

small_workflow:
  workflows:
    affaire:
      file: '%kernel.project_dir%/config/workflows/affaire.yaml'
      handlers:
        submit: App\Workflow\SubmitHandler
      services:
        'App\Workflow\CanSubmit': App\Workflow\CanSubmit
        'App\Workflow\DraftState': App\Workflow\DraftState
      lock: App\Workflow\AffaireLock
      persister: App\Workflow\AffairePersister
      events: App\Workflow\EventDispatcher

Register the referenced application services in the Symfony container. State/guard instances are optional; without registration the core engine can instantiate no-argument classes itself.

Inject

public function __construct(private WorkflowRegistry $workflows) {}

$instance = $this->workflows->for('affaire', new WorkflowContext([
    'affaire' => $affaire,
    'user' => $user,
]));
$vote = $instance->vote();
$vote->getStates();
$vote->getActions();
$vote->getTransitions();
$instance->execute(AffaireAction::Submit);

WorkflowEngineFactory can also be injected to create a fresh engine (create('affaire')) or a bound instance (for('affaire', $context)). WorkflowRegistry offers a simplified named-workflow lookup. Engines do not retain business-entity state. Voting remains advisory; execution rechecks under the application-provided lock.

No persistence mechanism, default lock, database schema or Doctrine integration is installed by this bundle. The application implements persistence and transaction boundaries.

PHP attribute autoconfiguration

Services registered with Symfony autoconfiguration may declare:

#[\Small\WorkflowBundle\Attribute\AsWorkflowService('affaire', 'state')]
final class DraftState extends \Small\Workflow\WorkflowState { /* ... */ }

#[\Small\WorkflowBundle\Attribute\AsWorkflowService('affaire', 'guard')]
final class CanSubmit implements \Small\Workflow\WorkflowGuard { /* ... */ }

#[\Small\WorkflowBundle\Attribute\AsWorkflowService('affaire', 'handler', 'submit')]
final class SubmitHandler implements \Small\Workflow\WorkflowActionHandler { /* ... */ }

Supported service types are state, guard, handler, lock, persister, events. The handler key corresponds to the action declared in the workflow YAML file. The existing services / handlers configuration remains supported. Services referenced by attributes must be autoconfigured in the Symfony container.

The compiler pass validates the workflow files, referenced state classes, guard and handler definitions, and resolves the services before the application starts. Missing dependencies and invalid workflows fail container compilation.

Debug command

bin/console workflow:debug
bin/console workflow:debug affaire

Lists declared workflows, states, transitions and their actions without loading business entities.

small / workflow-bundle

Package info

Security

Statistics