Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Documented the workflow metadata [redux] #11209

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 17 commits into from
Apr 17, 2019
Merged

Documented the workflow metadata [redux] #11209

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
d68cc99
Documented the workflow metadata
javiereguiluz Mar 23, 2018
17eae8c
Add missing metadata key, fixing comment by @noniagriconomie on https…
pbowyer Mar 23, 2019
663639b
Incorporate the code examples in https://github.com/symfony/symfony-d…
pbowyer Mar 23, 2019
c595c47
First set of tidy-ups for @HeahDude's feedback.
pbowyer Mar 23, 2019
c9ef262
Incorporate @OskarStark's feedback
pbowyer Mar 23, 2019
ca66356
Document how to see all configuration options (see https://github.com…
pbowyer Mar 23, 2019
af71c14
Add an introduction as suggested in https://github.com/symfony/symfon…
pbowyer Mar 23, 2019
ea64992
Incorporate further excellent feedback from @HeahDude
pbowyer Mar 23, 2019
40fbaf3
Update arrays to use short syntax
pbowyer Mar 23, 2019
94d17de
Simplify the English and turn it into a tip
pbowyer Mar 25, 2019
f716e81
Incorporate @OskarStark's feedback
pbowyer Mar 25, 2019
225c2fe
Apply suggestions from code review
OskarStark Mar 29, 2019
55c9199
Indent PHP block by an additional 4 spaces
pbowyer Mar 29, 2019
3765ddb
Change code formatting of PHP snippet per https://github.com/symfony/…
pbowyer Mar 29, 2019
6080aa8
Remove the word 'simple'
pbowyer Apr 7, 2019
a4c23c1
Add blank line between code block and sentence above. Code block was …
pbowyer Apr 7, 2019
7f3a0fd
Oskar's feedback
pbowyer Apr 7, 2019
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
Next Next commit
Documented the workflow metadata
  • Loading branch information
@javiereguiluz @pbowyer
javiereguiluz authored and pbowyer committed Apr 7, 2019
commit d68cc99f23e97114e8dc2236f8d6fcc8003cdeca
142 changes: 142 additions & 0 deletions workflow/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,3 +533,145 @@ You can access the message from a Twig template as follows:
Don't need a human-readable message? You can still use::

$event->setBlocked('true');

Storing Metadata
----------------

.. versionadded:: 4.1
The feature to store metadata in workflows was introduced in Symfony 4.1.

In case you need it, you can store arbitrary metadata in workflows, their
places, and their transitions using the ``metadata`` option. This metadata can
be as simple as the title of the workflow or as complex as your own application
requires:

.. configuration-block::

.. code-block:: yaml

# config/packages/workflow.yaml
framework:
workflows:
blog_publishing:
metadata: 'Blog Publishing Workflow'
# ...
places:
draft:
metadata:
max_num_of_words: 500
# ...
transitions:
to_review:
from: draft
to: review
metadata:
priority: 0.5
# ...

.. code-block:: xml

<!-- config/packages/workflow.xml -->
<?xml version="1.0" encoding="utf-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:framework="http://symfony.com/schema/dic/symfony"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd"
>

<framework:config>
<framework:workflow name="blog_publishing" type="workflow">
<framework:metadata>
<framework:title>Blog Publishing Workflow</framework:title>
</framework:metadata>
<!-- ... -->

<framework:place name="draft">
<framework:metadata>
<framework:max-num-of-words>500</framework:max-num-of-words>
</framework:metadata>
</framework:place>
<!-- ... -->

<framework:transition name="to_review">
<framework:from>draft</framework:from>
<framework:to>review</framework:to>
<framework:metadata>
<framework:priority>0.5</framework:priority>
</framework:metadata>
</framework:transition>
<!-- ... -->
</framework:workflow>
</framework:config>
</container>

.. code-block:: php

// config/packages/workflow.php

$container->loadFromExtension('framework', array(
// ...
'workflows' => array(
'blog_publishing' => array(
'metadata' => array(
'title' => 'Blog Publishing Workflow',
),
// ...
'places' => array(
'draft' => array(
'max_num_of_words' => 500,
),
// ...
),
'transitions' => array(
'to_review' => array(
'from' => 'draft',
'to' => 'review',
'metadata' => array(
'priority' => 0.5,
),
),
),
),
),
));

Then, you can access this metadata in your PHP code as follows::

// MISSING EXAMPLE HERE...
//
//
//
//

In Twig templates, metadata is available via the ``workflow_metadata()`` function:

.. code-block:: twig

<h2>Metadata</h2>
<p>
<strong>Workflow</strong>:<br >
<code>{{ workflow_metadata(article, 'title') }}</code>
</p>
<p>
<strong>Current place(s)</strong>
<ul>
{% for place in workflow_marked_places(article) %}
<li>
{{ place }}:
<code>{{ workflow_metadata(article, 'max_num_of_words', place) ?: 'Unlimited'}}</code>
</li>
{% endfor %}
</ul>
</p>
<p>
<strong>Enabled transition(s)</strong>
<ul>
{% for transition in workflow_transitions(article) %}
<li>
{{ transition.name }}:
<code>{{ workflow_metadata(article, 'priority', transition) ?: '0' }}</code>
</li>
{% endfor %}
</ul>
</p>