Skip to content

Added a tip about the support of microseconds in Stopwatch #8146

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
javiereguiluz wants to merge 2 commits into from
Closed

Added a tip about the support of microseconds in Stopwatch #8146

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45679bb
Added a tip about the support of microseconds in Stopwatch
javiereguiluz Jul 12, 2017
24e93f5
Fixed a grammar issue
javiereguiluz Jul 13, 2017
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
19 changes: 15 additions & 4 deletions components/stopwatch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,24 @@ microtime by yourself. Instead, use the simple
$event = $stopwatch->stop('eventName');

The :class:`Symfony\\Component\\Stopwatch\\StopwatchEvent` object can be retrieved
from the :method:`Symfony\\Component\\Stopwatch\\Stopwatch::start`,
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::stop`,
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::lap` and
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::getEvent` methods.
from the :method:`Symfony\\Component\\Stopwatch\\Stopwatch::start`,
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::stop`,
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::lap` and
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::getEvent` methods.
The latter should be used when you need to retrieve the duration of an event
while it is still running.

.. tip::

By default, the stopwatch truncates any sub-millisecond time measure to ``0``,
so you can't measure microseconds or nanoseconds. If you need more precision,
pass ``true`` to the ``Stopwatch`` class constructor to enable full precision::

$stopwatch = new Stopwatch(true);

.. versionadded:: 3.4
The full precision feature was introduced in Symfony 3.4.

You can also provide a category name to an event::

$stopwatch->start('eventName', 'categoryName');
Expand Down