Skip to content

WDT following AJAX requests #9692

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

Closed
wants to merge 3 commits into from
Closed

WDT following AJAX requests #9692

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
acce179
First attempt at documenting the WDT following AJAX requests
jeffreymb Apr 27, 2018
b022371
Misc typo fixes and improvements from PR.
jeffreymb Apr 30, 2018
34bc797
Additional improvments from review
jeffreymb Apr 30, 2018
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
Prev Previous commit
Next Next commit
Misc typo fixes and improvements from PR.
  • Loading branch information
@jeffreymb
jeffreymb authored Apr 30, 2018
commit b022371ba3b64fbb9776c110d92b5bfcdb131774
20 changes: 10 additions & 10 deletions profiler/wdt_follow_ajax.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
.. index::
single: Profiling: WDT Auto-update after AJAX Request

How to make the Web Debug Toolbar Auto-upate after AJAX Requests
How to make the Web Debug Toolbar Auto-update after AJAX Requests
================================================================

For single page applications it is often inconvenient to find the profiler
information for the most recent request. It would be much more convient if it
the toolbar would show the information from the most recent AJAX request
instead of your initial page load.
For single page applications it would be more convenient if the toolbar
showed the information for the most recent AJAX request instead of the
initial page load.

By setting the `Symfony-Debug-Toolbar-Replace` to a value of `1` in the
By setting the `Symfony-Debug-Toolbar-Replace` header to a value of `1` in the
Copy link
Member

Choose a reason for hiding this comment

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

The syntax used in Symfony Docs is similar to Markdown, but different in some cases. One of those cases is the use of double backticks for code. This:

`Symfony-Debug-Toolbar-Replace`

should be written like this:

``Symfony-Debug-Toolbar-Replace``

Same for the 1 code used in the same phrase.

AJAX request, the toolbar will be automatically reloaded for the request. The
header can be set on the response object::

$response->headers->set('Symfony-Debug-Toolbar-Replace', 1);

Only setting the header durring development
Only setting the header during development
Copy link
Member

Choose a reason for hiding this comment

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

For titles we use a special "title case" where the first letter of most, but not all, words is uppercased. So, this title should be:

Only Setting the Header During Development
------------------------------------------

-------------------------------------------

Ideally this header should only be set durring development and not for
Ideally this header should only be set during development and not for
production. This can be accomplished by setting the header in a
:ref:`kernel.response <component-http-kernel-kernel-response>` event listener::

Expand All @@ -33,8 +32,9 @@ production. This can be accomplished by setting the header in a

Read more Symfony events :ref:`/reference/events`.

If you are using Symfony Flex, you should define your event listener service in the ``config/services_dev.yml`` file so that it only exists in the ``dev`` environment.
If you are using Symfony Flex, you should define your event listener service in the
``config/services_dev.yml`` file so that it only exists in the ``dev`` environment.

.. seealso::

Read more on creating dev only services :ref:`/configuration/configuration_organization`.
Read more on creating dev only services :ref:`/configuration/configuration_organization`.