Skip to content

Commit 4fd5fc1

Browse files
committedMar 26, 2014
feature symfony#3539 [Stopwatch] Describe retrieval of StopwatchEvent (jochenvdv)
This PR was merged into the master branch. Discussion ---------- [Stopwatch] Describe retrieval of StopwatchEvent See [symfony/symfony#10198](symfony/symfony#10198) | Q | A | |----------------|------| | Doc fix | no | | New docs | yes | | Applies to | master | | Fixed tickets | - | Commits ------- 0ee15d3 Fix versionadded 295f109 Add reason for getEvent() ac484f4 Made suggested tweaks 2ca9bd5 Describe retrieval of StopwatchEvent
2 parents c703549 + 0ee15d3 commit 4fd5fc1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed
 

‎components/stopwatch.rst

+10
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,16 @@ microtime by yourself. Instead, use the simple
3131
// ... some code goes here
3232
$event = $stopwatch->stop('eventName');
3333

34+
.. versionadded:: 2.5
35+
The ``getEvent()`` method was introduced in Symfony 2.5
36+
37+
The :class:`Symfony\\Component\\Stopwatch\StopwatchEvent` object can be retrieved from the
38+
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::start`,
39+
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::stop`,
40+
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::lap` and
41+
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::getEvent` methods.
42+
The latter should be used when you need to retrieve the duration of an event while it is still running.
43+
3444
You can also provide a category name to an event::
3545

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

0 commit comments

Comments
 (0)
Please sign in to comment.