Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

[Workflow] Guard documentation#11433

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.

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

Already on GitHub?Sign in to your account

Closed
Changes fromall commits
Commits
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
85 changes: 65 additions & 20 deletionsworkflow/usage.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,8 +14,8 @@ A set of places and transitions creates a **definition**. A workflow needs
a ``Definition`` and a way to write the states to the objects (i.e. an
instance of a :class:`Symfony\\Component\\Workflow\\MarkingStore\\MarkingStoreInterface`.)

Consider the following example for a blog post. A post can have places:
'draft', 'review', 'rejected', 'published'. You can define the workflow
Consider the following example for a blog post. A post can havetheseplaces:
``draft``, ``reviewed``, ``rejected``, ``published``. You can define the workflow
like this:

.. configuration-block::
Expand All@@ -38,18 +38,18 @@ like this:
initial_place: draft
places:
- draft
-review
-reviewed
- rejected
- published
transitions:
to_review:
from: draft
to:review
to:reviewed
publish:
from:review
from:reviewed
to: published
reject:
from:review
from:reviewed
to: rejected

.. code-block:: xml
Expand All@@ -74,24 +74,24 @@ like this:
<framework:support>AppBundle\Entity\BlogPost</framework:support>

<framework:place>draft</framework:place>
<framework:place>review</framework:place>
<framework:place>reviewed</framework:place>
<framework:place>rejected</framework:place>
<framework:place>published</framework:place>

<framework:transition name="to_review">
<framework:from>draft</framework:from>

<framework:to>review</framework:to>
<framework:to>reviewed</framework:to>
</framework:transition>

<framework:transition name="publish">
<framework:from>review</framework:from>
<framework:from>reviewed</framework:from>

<framework:to>published</framework:to>
</framework:transition>

<framework:transition name="reject">
<framework:from>review</framework:from>
<framework:from>reviewed</framework:from>

<framework:to>rejected</framework:to>
</framework:transition>
Expand DownExpand Up@@ -119,21 +119,21 @@ like this:
'supports' => ['AppBundle\Entity\BlogPost'],
'places' => [
'draft',
'review',
'reviewed',
'rejected',
'published',
],
'transitions' => [
'to_review' => [
'from' => 'draft',
'to' => 'review',
'to' => 'reviewed',
],
'publish' => [
'from' => 'review',
'from' => 'reviewed',
'to' => 'published',
],
'reject' => [
'from' => 'review',
'from' => 'reviewed',
'to' => 'rejected',
],
],
Expand DownExpand Up@@ -210,7 +210,7 @@ When a state transition is initiated, the events are dispatched in the following
order:

``workflow.guard``
Validate whether the transition isallowed at all (:ref:`see below <workflow-usage-guard-events>`).
Validate whether the transition isblocked or not (:ref:`see below <workflow-usage-guard-events>` and :ref:`using guards <workflow-usage-using-guards>`).

The three events being dispatched are:

Expand DownExpand Up@@ -322,14 +322,14 @@ Guard Events
There are a special kind of events called "Guard events". Their event listeners
are invoked every time a call to ``Workflow::can``, ``Workflow::apply`` or
``Workflow::getEnabledTransitions`` is executed. With the guard events you may
add custom logic to decidewhat transitionsare valid or not. Here is a list
add custom logic to decidewhich transitionsshould be blocked or not. Here is a list
of the guard event names.

* ``workflow.guard``
* ``workflow.[workflow name].guard``
* ``workflow.[workflow name].guard.[transition name]``

See exampleto make sure noblog postwithout title is movedto "review"::
This examplestops anyblog postbeing transitionedto "reviewed" if it is missing a title::

use Symfony\Component\Workflow\Event\GuardEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
Expand All@@ -343,8 +343,8 @@ See example to make sure no blog post without title is moved to "review"::
$title = $post->title;

if (empty($title)) {
//Posts without title are not allowed
//to performthetransition "to_review"
//Block the transition "to_review"
//ifthepost has no title
$event->setBlocked(true);
}
}
Expand DownExpand Up@@ -388,6 +388,51 @@ This class has two more methods:
:method:`Symfony\\Component\\Workflow\\Event\\GuardEvent::setBlocked`
Sets the blocked value.

.. _workflow-usage-using-guards:

Using Guards
------------

The component has a guard logic to control the execution of your workflow on top of your configuration.

It allows you to execute your custom logic to decide if the transition is blocked or not, before actually
applying this transition.

You have multiple optional ways to use guards in your workflow.

The first way is :ref:`with the guard event <workflow-usage-guard-events>`, which allows you to implement
any desired feature.

Another one is via the configuration and its specific entry ``guard`` on a transition.

This ``guard`` entry allows any expression that is valid for the Expression Language component:

.. configuration-block::

.. code-block:: yaml

# config/packages/workflow.yaml
framework:
workflows:
blog_publishing:
# previous configuration
transitions:
to_review:
# the transition is allowed only if the current user has the ROLE_REVIEWER role.
guard: "is_granted('ROLE_REVIEWER')"
from: draft
to: reviewed
publish:
# or "is_anonymous", "is_remember_me", "is_fully_authenticated", "is_granted"
guard: "is_authenticated"
from: reviewed
to: published
reject:
# or any valid expression language with "subject" refering to the post
guard: "has_role("ROLE_ADMIN") and subject.isStatusReviewed()"
from: reviewed
to: rejected

Usage in Twig
-------------

Expand DownExpand Up@@ -434,7 +479,7 @@ The following example shows these functions in action:
{% endfor %}

{# Check if the object is in some specific place #}
{% if workflow_has_marked_place(post, 'review') %}
{% if workflow_has_marked_place(post, 'reviewed') %}
<p>This post is ready for review.</p>
{% endif %}

Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp