limen/php-graflow

A simple node flow controller

dev-master 2018-01-31 03:38 UTC

Requires

• php: >=5.4
• predis/predis: 1.1.*

Requires (Dev)

• phpunit/phpunit: ~4.8

MIT

• LI Mengxiang

• workflow
• state-machine

README

A simple flow controller with features

• A flow is defined by a graph.
• A graph is consisted of nodes and edges.
• Edges have direction.
• A graph can have one head node and one or multiple tail nodes.
• A middle node is a node who is neither head node nor tail node.
• A tail node can have one or multiple in nodes and have no out node.
• A head node can have one or multiple out nodes and have no in node.
• A middle node can have one or multiple in node and one or multiple out nodes.
• The edge between two adjacent nodes could be one way or two way.

Install

Recommend to install via composer.

composer require "limen/php-graflow"

Usage

see src/Examples and tests/

Concepts

In/Out node

When node A has way to node B, A is B's in node and B is A's out node.

Contract

Define a graph in PHP array

The first key must be the head node.

[
    'blank' => ['editing', 'canceled'],
    'editing' => ['draft', 'canceled'],
    'draft' => ['editing', 'published', 'canceled'],
    'published' => ['draft', 'printed', 'canceled'],
    'printed' => [],
    'canceled' => [],
]

The equivalent graph

The arrow shows the way direction.