PHPackages                             spec-gen/state-workflow-spec-gen-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. spec-gen/state-workflow-spec-gen-bundle

ActiveLibrary[Utility & Helpers](/categories/utility)

spec-gen/state-workflow-spec-gen-bundle
=======================================

Specification generator for StateWorkflowBundle: https://github.com/gmorel/StateWorkflowBundle

1.1.0(11y ago)130MITPHPPHP >=5.3.3

Since May 3Pushed 10y ago2 watchersCompare

[ Source](https://github.com/spec-gen/state-workflow-spec-gen-bundle)[ Packagist](https://packagist.org/packages/spec-gen/state-workflow-spec-gen-bundle)[ RSS](/packages/spec-gen-state-workflow-spec-gen-bundle/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (7)Versions (4)Used By (0)

SpecGen - State Workflow Bundle
===============================

[](#specgen---state-workflow-bundle)

[![Build Status](https://camo.githubusercontent.com/f6dab5a79e16dcec9ec313d6e6317dacacf3902b3c558ac3cffa2866d1439907/68747470733a2f2f7472617669732d63692e6f72672f737065632d67656e2f73746174652d776f726b666c6f772d737065632d67656e2d62756e646c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/spec-gen/state-workflow-spec-gen-bundle)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/7b8281aae09d698d80c5a1a1bc6e6d6355e86f7cd70d57a69800ce752c00dc36/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f737065632d67656e2f73746174652d776f726b666c6f772d737065632d67656e2d62756e646c652f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/spec-gen/state-workflow-spec-gen-bundle/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/a5c48d5630f3950c02cbbf028d3b0a58177a717cc6c759144ee389b045361471/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f737065632d67656e2f73746174652d776f726b666c6f772d737065632d67656e2d62756e646c652f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/spec-gen/state-workflow-spec-gen-bundle/?branch=master)[![Dependency Status](https://camo.githubusercontent.com/87fa758820cc63677f979d9552080a45f9f0597a3b3e2b96b8736db556642179/68747470733a2f2f7777772e76657273696f6e6579652e636f6d2f757365722f70726f6a656374732f3535343630646539323430353439306431663030303030322f62616467652e7376673f7374796c653d666c6174)](https://www.versioneye.com/user/projects/55460de92405490d1f000002)[![Latest Stable Version](https://camo.githubusercontent.com/373d0bc033fcfa87f09c0fb353f4c37147c34e2d2b055accff54942ff832f6d1/68747470733a2f2f706f7365722e707567782e6f72672f737065632d67656e2f73746174652d776f726b666c6f772d737065632d67656e2d62756e646c652f762f737461626c652e737667)](https://packagist.org/packages/spec-gen/state-workflow-spec-gen-bundle)[![License](https://camo.githubusercontent.com/39ea3c2e105fd30d0f05a4da4abf69a38247255b2642c8276bf0142030d47ed2/68747470733a2f2f706f7365722e707567782e6f72672f676d6f72656c2f73746174652d776f726b666c6f772d62756e646c652f6c6963656e7365)](https://packagist.org/packages/gmorel/state-workflow-bundle)[![Spec Gen logo](https://avatars3.githubusercontent.com/u/12191789?v=3&s=200)](https://avatars3.githubusercontent.com/u/12191789?v=3&s=200)

Ease complex workflow readability by generating its specification from your code base
-------------------------------------------------------------------------------------

[](#ease-complex-workflow-readability-by-generating-its-specification-from-your-code-base)

Keywords : Workflow, Finite State Machine, Symfony2, Specification Generation

**Specification Generator** for [StateWorkflowBundle](https://github.com/gmorel/StateWorkflowBundle).

> The worst specifications are **not updated** specifications..

[![Symfony 2](https://raw.githubusercontent.com/spec-gen/state-workflow-spec-gen-bundle/master/doc/symfony.png)](https://raw.githubusercontent.com/spec-gen/state-workflow-spec-gen-bundle/master/doc/symfony.png)

Aim is to have your `Workflow Specification` (Available states and transitions) always up to date in order to ease your Domain readability. Hence \*\*avoiding misunderstandings\*\* and allow new comers to assist you \*\*quicker\*\* in your project. \*\*Saving you valuable time\*\* since you no more have to make sure your specs are up to date. Generated specification for simple workflow [![Demo Booking Workflow simple](https://raw.githubusercontent.com/spec-gen/state-workflow-spec-gen-bundle/master/doc/demo-booking-workflow.png "Demo Booking Workflow simple")](https://raw.githubusercontent.com/spec-gen/state-workflow-spec-gen-bundle/master/doc/demo-booking-workflow.png)

Generated specification for more complex workflow [![Demo Quote Workflow complex](https://raw.githubusercontent.com/spec-gen/state-workflow-spec-gen-bundle/master/doc/demo-quote-workflow-complex.png "Demo Quote Workflow complex")](https://raw.githubusercontent.com/spec-gen/state-workflow-spec-gen-bundle/master/doc/demo-quote-workflow-complex.png)

Usage
=====

[](#usage)

From a Symfony2 project

```
php app/console.php spec-gen:state-workflow:generate-specifications

```

Workflow specification files will be generated in `{PROJECT ROOT}/specification/workflow/`

Example : {PROJECT ROOT}/specification/workflow/demo.booking\_engine.state\_workflow.html

Installation
============

[](#installation)

Step 1: Download the Bundle
---------------------------

[](#step-1-download-the-bundle)

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

```
$ composer require spec-gen/state-workflow-spec-gen-bundle "~1"
```

This command requires you to have Composer installed globally, as explained in the [installation chapter](https://getcomposer.org/doc/00-intro.md)of the Composer documentation.

Step 2: Enable the Bundle
-------------------------

[](#step-2-enable-the-bundle)

Then, enable the bundle by adding the following line in the `app/AppKernel.php`file of your project:

```