brettt89/silverstripe-workflow

Adds configurable workflow support to the ORM

0.2.0 2020-07-19 12:48 UTC

This package is auto-updated.

Last update: 2024-12-20 19:59:09 UTC


README

PHPUnit Tests codecov

Overview

This Workflow module uses a static interface for interacting with the WorkflowService. You can call Workflow actions from anywhere needed.

Provides symfony/workflow functionality to SilverStripe Framework.

Requirements

  • SilverStripe Framework 4.x
  • Symfony Workflow 5.x

Installation

composer require brettt89/silverstripe-workflow

Introduction

The WorkflowService class is your primary engagement point for all Workflow related activies. It holds a static registry of all Workflows created for your application.

The registry returned by WorkflowService is a Symfony Workflow Registry class.

You can interact with the Workflow Registry by calling the registry() command on the WorkflowService class.

$registry = WorkflowService::registry();

Documentation \ How to

For SilverStripe documentation, see SilverStripe Workflow Documentation.

For further information on usage of Workflows and other functionality such as Events, etc. See the Symfony Workflow documentation.

Contributing

Please submit all contributions to this repository as pull requests to the master branch.