From 053da4b224cd7a872a31abb6acd29151153a6d06 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 27 Jul 2018 11:36:23 +0200 Subject: [PATCH] Mentioned the audit_trail workflow option --- workflow/usage.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/workflow/usage.rst b/workflow/usage.rst index 9f016f94d85..416bc32e402 100644 --- a/workflow/usage.rst +++ b/workflow/usage.rst @@ -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: @@ -62,7 +63,7 @@ like this: > - + currentPlace @@ -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') @@ -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:: @@ -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``