README

Workflow Manager for Yii2. Extends Yii2-Workflow to provide an interface to manage workflows.

Features

Create and manage workflows, statuses and transitions using a simple interface.
Manage metadata for each status to allow additional data such as colors and icons.
Displays the workflow transitions using Yii2 Workflow View

Installation

The preferred way to install this extension is through composer.

Either run

$ composer require cornernote/yii2-workflow-manager "*"

or add

"cornernote/yii2-workflow-manager": "*"

to the require section of your composer.json file.

Migrations

$ php yii migrate --migrationPath=@cornernote/workflow/manager/migrations

Configuration

$config = [
    'components' => [
        'workflowSource' => [
            'class' => 'cornernote\workflow\manager\components\WorkflowDbSource',
        ],
    ],
    'modules' => [
        'workflow' => [
            'class' => 'cornernote\workflow\manager\Module',
        ],
    ],
];

Usage

Simply visit ?r=workflow within your application to start managing workflows.

Once you have defined a workflow, you can attach it to a model as follows:

class Post extends \yii\db\ActiveRecord
{
    public function behaviors()
    {
        return [
            [
                'class' => \raoul2000\workflow\base\SimpleWorkflowBehavior::className(),
                'defaultWorkflowId' => 'post',
                'propagateErrorsToModel' => true,
            ],
        ];
    }
}

License

Author: Brett O'Donnell cornernote@gmail.com
Source Code: https://github.com/cornernote/yii2-workflow-manager
License: BSD-3-Clause https://raw.github.com/cornernote/yii2-workflow-manager/master/LICENSE

cornernote / yii2-workflow-manager

Maintainers

Details