dereuromark / cakephp-workflow
State machine and workflow engine for CakePHP with PHP 8 Attributes, YAML support, and admin UI
Package info
github.com/dereuromark/cakephp-workflow
Type:cakephp-plugin
pkg:composer/dereuromark/cakephp-workflow
Requires
- php: >=8.2
- cakephp/cakephp: ^5.2
Requires (Dev)
- cakephp/bake: ^3.0
- cakephp/migrations: ^5.0.0
- nette/neon: ^3.0
- php-collective/code-sniffer: ^0.6.0
- phpunit/phpunit: ^11.5 || ^12.5 || ^13.0
- symfony/yaml: ^6.0 || ^7.0 || ^8.0
Suggests
- cakephp/bake: Optional for bake workflow_state scaffolding (^3.0)
- nette/neon: Required for NEON workflow definitions (^3.0)
- symfony/yaml: Required for YAML workflow definitions (^6.0 || ^7.0 || ^8.0)
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-10-11 23:12:00 UTC
README
See the version map for other CakePHP branches.
State machine and workflow engine for CakePHP with PHP 8 Attributes, YAML/NEON config support, and admin UI.
Tip
Try the live demo: https://sandbox.dereuromark.de/workflow-sandbox
There is also a demo app with more details to experiment with
Documentation
Follow Installation and Getting started for a persisted workflow on an existing table.
The website covers attribute and configuration-file definitions, guards, transition commands, ORM integration, logging, locking, timeouts, diagrams and the optional admin interface. Server-side SVG and PNG diagram exports require Graphviz; the in-page Mermaid widget does not.
The admin interface denies access until an application configures
Workflow.adminAccess. Review authorization before exposing workflow routes.
Contributing
Run the relevant PHPUnit tests, composer cs-check and composer stan before
submitting source changes. Documentation lives in docs/; run npm ci and
npm run docs:build from that directory.