Skip to content

write how to use the stopwatch in symfony profiler #9320

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
wants to merge 2 commits into from
Closed
Changes from 1 commit
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
12 changes: 12 additions & 0 deletions components/stopwatch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,18 @@ You can also provide a category name to an event::
You can consider categories as a way of tagging events. For example, the
Symfony Profiler tool uses categories to nicely color-code different events.

Usage in symfony
----------------

In a Controller, do:
Copy link
Member

Choose a reason for hiding this comment

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

This should be a double colon (::) in order to mark the next block as PHP code block.


$stopwatch = $this->get('debug.stopwatch');
$stopwatch->start('anEvent');

Or inject `Symfony\Component\Stopwatch\Stopwatch` by autowiring.
Copy link
Member

Choose a reason for hiding this comment

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

Please use :class:`Symfony\\Component\\Stopwatch\\Stopwatch` to (a) render it correctly and (b) directly reference it's API documentation.

I think the line below may also be added directly to this paragraph.


Thereafter this timing can be seen in the profiler.

Periods
-------

Expand Down