Skip to content

[Workflow] Document Guards #11214

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pbowyer opened this issue Mar 23, 2019 · 4 comments
Closed

[Workflow] Document Guards #11214

pbowyer opened this issue Mar 23, 2019 · 4 comments
Labels

Comments

@pbowyer
Copy link
Contributor

pbowyer commented Mar 23, 2019

Needed to close #8499.

To include

  • What is a guard
  • Why you would use a guard
  • Guards as classes (event subscribers)
  • Guards as ExpressionLanguage expressions (guard: in YAML config)
  • Available parameters
    • subject etc

Existing online resources

https://codereviewvideos.com/course/symfony-workflow-component-tutorial/video/workflow-guards-part-1 has an excellent series (written for Symfony 3.3)

@noniagriconomie
Copy link
Contributor

noniagriconomie commented Apr 10, 2019

@pbowyer cc @xabbuh @javiereguiluz (from #8499) I can do a doc on this

should i create a new file or improve this sub section? https://symfony.com/doc/current/workflow/usage.html#guard-events

Thank you,

@pbowyer
Copy link
Contributor Author

pbowyer commented Apr 11, 2019

I have no strong feeling. The Workflow docs will need re-organising soon, so a separate file would be helpful.

@javiereguiluz
Copy link
Member

@noniagriconomie if the new contents are super long, then we could create a new article. Otherwise, please update the section of the existing article. We try to avoid creating small article because they break the reading flow too much and people end up with 5 open tabs in their browsers to read 5 small articles instead of reading just one.

javiereguiluz added a commit that referenced this issue Apr 16, 2019
This PR was squashed before being merged into the 3.4 branch (closes #11433).

Discussion
----------

[Workflow] Guard documentation

Hi,

Here is a PR for this issue #11214

See #11421

Commits
-------

07ada7f [Workflow] Guard documentation
@javiereguiluz
Copy link
Member

Fixed by #11433.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants