Skip to content

Mentioned the audit_trail workflow option #10124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 30, 2018
Merged

Mentioned the audit_trail workflow option #10124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions workflow/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ like this:
workflows:
blog_publishing:
type: 'workflow' # or 'state_machine'
audit_trail: 'enabled'
marking_store:
type: 'multiple_state' # or 'single_state'
arguments:
Expand Down Expand Up @@ -62,7 +63,7 @@ like this:
>

<framework:config>
<framework:workflow name="blog_publishing" type="workflow">
<framework:workflow name="blog_publishing" type="workflow" audit_trail="enabled">
<framework:marking-store type="single_state">
<framework:argument>currentPlace</framework:argument>
</framework:marking-store>
Expand Down Expand Up @@ -106,6 +107,7 @@ like this:
'workflows' => array(
'blog_publishing' => array(
'type' => 'workflow', // or 'state_machine'
'audit_trail' => 'enabled',
'marking_store' => array(
'type' => 'multiple_state', // or 'single_state'
'arguments' => array('currentPlace')
Expand Down Expand Up @@ -157,6 +159,14 @@ like this:
attributes of the ``marking_store`` option are optional. If omitted, their default values
will be used.

.. tip::

Setting the ``audit_trail`` option to ``enabled`` makes the application
generate detailed log messages for the workflow activity.

.. versionadded:: 3.3
The ``audit_trail`` option was introduced in Symfony 3.3.

With this workflow named ``blog_publishing``, you can get help to decide
what actions are allowed on a blog post::

Expand Down Expand Up @@ -241,10 +251,10 @@ order:
* ``workflow.entered``
* ``workflow.[workflow name].entered``
* ``workflow.[workflow name].entered.[place name]``

``workflow.completed``
The object has completed this transition.

The three events being dispatched are:

* ``workflow.completed``
Expand Down