Skip to content

[Workflow] Allow to define arbitrary data for states/transitions #23257

@ostrolucky

Description

@ostrolucky
Q A
Bug report? no
Feature request? yes
BC Break report? no
RFC? no
Symfony version 3.3.*

I wanted to switch over to Symfony Workflow component from FSM library we use, but I found out Symfony one doesn't support to easily specify descriptions for states/transitions, which is pretty vital for us, because it allows us to generate documentation for user like this:

screenshot from 2017-06-22 00-33-16

Maybe configuration for that could look something like this:

framework:
    workflows:
        blog_publishing:
            type: 'workflow' # or 'state_machine'
            marking_store:
                type: 'multiple_state' # or 'single_state'
                arguments:
                    - 'currentPlace'
            supports:
                - AppBundle\Entity\BlogPost
            places:
                draft: blabla
                review: blabla
                rejected: blabla
                published: blabla
            transitions:
                to_review:
                    from: draft
                    to:   review
                    description: blabla
                publish:
                    from: review
                    to:   published
                    description: blabla
                reject:
                    from: review
                    to:   rejected
                    description: blabla

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions