Skip to content

Reworded the explanation about flash messages #5808

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 2 commits into from
Nov 5, 2015
Merged

Reworded the explanation about flash messages #5808

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
747f10b
Reworded the explanation about flash messages
javiereguiluz Oct 19, 2015
e38b037
Fixed a RST syntax issue
javiereguiluz Oct 20, 2015
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
25 changes: 13 additions & 12 deletions book/controller.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,12 +604,13 @@ session.
Flash Messages
~~~~~~~~~~~~~~

You can also store small messages that will be stored on the user's session.
This is useful when processing a form:
you want to redirect and have a special message shown on the *next* page.
These types of messages are called "flash" messages.
You can also store special messages, called "flash" messages, on the user's
session. By design, flash messages are meant to be processed exactly once. This
means that they vanish from the session automatically as soon as they are
retrieved. This feature makes "flash" messages particularly suited for storing
user notifications.

For example, imagine you're processing a form submit::
Consider the following form processing example::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i would prefer the old text "For example, imagine you're processing a form submit" here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My question: is form submit correct? submit is a verb, not a noun. Should it be form submission?


use Symfony\Component\HttpFoundation\Request;

Expand All @@ -633,12 +634,12 @@ For example, imagine you're processing a form submit::
return $this->render(...);
}

After processing the request, the controller sets a ``notice`` flash message
in the session and then redirects. The name (``notice``) isn't significant -
it's just something you invent and reference next.
After processing the request, the controller sets a flash message in the session
and then redirects. The message key (``notice`` in this example) can be freely
chosen and is used to retrieve the message content.

In the template of the next page (or even better, in your base layout template),
the following code will render the ``notice`` message:
the following code will render the messages stored under the ``notice`` key:

.. configuration-block::

Expand All @@ -660,9 +661,9 @@ the following code will render the ``notice`` message:

.. note::

By design, flash messages are meant to be processed exactly once. This means
that they vanish from the session automatically when they are retrieved from
the flash bag by calling the ``get()`` method.
It's common to use ``notice``, ``warning`` and ``error`` as the keys of the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about success ?

different types of flash messages, but you can use any key that fits your
needs.

.. tip::

Expand Down