Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spryker/cakephp-statemachine

CakePHP StateMachine engine as plugin by Spryker Systems GmbH
https://github.com/spryker/cakephp-statemachine

cakephp cakephp-plugin finite-state-machine php state-machine

Last synced: 21 days ago
JSON representation

CakePHP StateMachine engine as plugin by Spryker Systems GmbH

Host: GitHub
URL: https://github.com/spryker/cakephp-statemachine
Owner: spryker
License: other
Created: 2019-01-09T09:52:36.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-10-07T17:14:11.000Z (3 months ago)
Last Synced: 2024-12-01T20:22:28.299Z (about 1 month ago)
Topics: cakephp, cakephp-plugin, finite-state-machine, php, state-machine
Language: PHP
Size: 638 KB
Stars: 5
Watchers: 63
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# CakePHP StateMachine Plugin

[![CI](https://github.com/spryker/cakephp-statemachine/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/spryker/cakephp-statemachine/actions/workflows/ci.yml)
[![PHPStan level](https://img.shields.io/badge/style-level%208-brightgreen.svg?style=flat-square&label=phpstan)](https://github.com/phpstan/phpstan)
[![Latest Stable Version](https://poser.pugx.org/spryker/cakephp-statemachine/v/stable.svg)](https://packagist.org/spryker/dereuromark/cakephp-statemachine)
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.4-8892BF.svg)](https://php.net/)

StateMachine engine for CakePHP applications.

This branch is for use with **CakePHP 4.2+**. For details see [version map](https://github.com/spryker/cakephp-statemachine/wiki#cakephp-version-map).

## Features

- Easy to use and modify
- Live preview as rendered image
- Simple admin interface included.

Note: This plugin is a sandbox/showcase for state machines.
Use with Caution.

## License

License is not open source, but open code.

The plugin is offered are provided free of charge by Spryker Systems GmbH and can be used in any CakePHP project.
They are experimental and under the Spryker Sandbox License (see LICENSE file).
However, Spryker does not warrant or assume any liability for errors that occur during use.
Spryker does not guarantee their full functionality neither does Spryker assume liability for any disadvantages related to the use of the experimental plugin.
Spryker does not guarantee any updates, upgrades or similar to the experimental plugin.
By installing the experimental plugin, the project agrees to these terms of use. Please check LICENSE every 90 days.

## Install

### Requirements

StateMachine plugin requires GraphViz.
Please check https://graphviz.gitlab.io/download/ in order to install it for your system.

### Composer (preferred)
```
composer require spryker/cakephp-statemachine
```

## Setup
Enable the plugin in your `config/bootstrap.php` or call
```
bin/cake plugin load StateMachine
```

Run migrations:
```
bin/cake migrations migrate -p StateMachine
```
Or just copy the migration file into your app `src/config/Migrations/`, modify if needed, and then run it as part of your app migrations.

Fully tested so far are PostgreSQL and MySQL, but by using the ORM all major databases should be supported.

## Usage

Navigate to `http://example.local/admin/state-machine` to view your currently setup state machines.

See [Documentation](/docs) for more details.