dcef601ad4
This PR was merged into the master branch.
Commits
-------
bdf0334
Fixed the lap method. Added upgrade notes. Some CS fixes
Discussion
----------
Fixed the lap method. Added upgrade notes. Some CS fixes
Bug fix: yes
Feature addition: no
Backwards compatibility break: no
Symfony2 tests pass: yes
Fixes the following tickets: ~
Todo: ~
License of the code: MIT
Documentation PR: ~
This adds some type-hinting to the Stopwatch components.
I've also split the Section class to its own file, I know it's not a must as per coding standards used by Symfony but it complies with most of the other classes in the framework.
I've updated the UPGRADE-2.2.md file as well.
There's a bug fix which I'm not sure it if should have been done in this branch or not.
Let me know if I should make this PR against an older version of the framework.
Thanks.
219 lines
4.7 KiB
PHP
219 lines
4.7 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\Stopwatch;
|
|
|
|
/**
|
|
* Represents an Event managed by Stopwatch.
|
|
*
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
*/
|
|
class StopwatchEvent
|
|
{
|
|
/**
|
|
* @var StopwatchPeriod[]
|
|
*/
|
|
private $periods;
|
|
|
|
/**
|
|
* @var float
|
|
*/
|
|
private $origin;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $category;
|
|
|
|
/**
|
|
* @var float[]
|
|
*/
|
|
private $started;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param float $origin The origin time in milliseconds
|
|
* @param string $category The event category
|
|
*
|
|
* @throws \InvalidArgumentException When the raw time is not valid
|
|
*/
|
|
public function __construct($origin, $category = null)
|
|
{
|
|
$this->origin = $this->formatTime($origin);
|
|
$this->category = is_string($category) ? $category : 'default';
|
|
$this->started = array();
|
|
$this->periods = array();
|
|
}
|
|
|
|
/**
|
|
* Gets the category.
|
|
*
|
|
* @return string The category
|
|
*/
|
|
public function getCategory()
|
|
{
|
|
return $this->category;
|
|
}
|
|
|
|
/**
|
|
* Gets the origin.
|
|
*
|
|
* @return integer The origin in milliseconds
|
|
*/
|
|
public function getOrigin()
|
|
{
|
|
return $this->origin;
|
|
}
|
|
|
|
/**
|
|
* Starts a new event period.
|
|
*
|
|
* @return StopwatchEvent The event
|
|
*/
|
|
public function start()
|
|
{
|
|
$this->started[] = $this->getNow();
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Stops the last started event period.
|
|
*
|
|
* @throws \LogicException When start wasn't called before stopping
|
|
*
|
|
* @return StopwatchEvent The event
|
|
*
|
|
* @throws \LogicException When stop() is called without a matching call to start()
|
|
*/
|
|
public function stop()
|
|
{
|
|
if (!count($this->started)) {
|
|
throw new \LogicException('stop() called but start() has not been called before.');
|
|
}
|
|
|
|
$this->periods[] = new StopwatchPeriod(array_pop($this->started), $this->getNow());
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Stops the current period and then starts a new one.
|
|
*
|
|
* @return StopwatchEvent The event
|
|
*/
|
|
public function lap()
|
|
{
|
|
return $this->stop()->start();
|
|
}
|
|
|
|
/**
|
|
* Stops all non already stopped periods.
|
|
*/
|
|
public function ensureStopped()
|
|
{
|
|
while (count($this->started)) {
|
|
$this->stop();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets all event periods.
|
|
*
|
|
* @return StopwatchPeriod[] An array of StopwatchPeriod instances
|
|
*/
|
|
public function getPeriods()
|
|
{
|
|
return $this->periods;
|
|
}
|
|
|
|
/**
|
|
* Gets the relative time of the start of the first period.
|
|
*
|
|
* @return integer The time (in milliseconds)
|
|
*/
|
|
public function getStartTime()
|
|
{
|
|
return isset($this->periods[0]) ? $this->periods[0]->getStartTime() : 0;
|
|
}
|
|
|
|
/**
|
|
* Gets the relative time of the end of the last period.
|
|
*
|
|
* @return integer The time (in milliseconds)
|
|
*/
|
|
public function getEndTime()
|
|
{
|
|
return ($count = count($this->periods)) ? $this->periods[$count - 1]->getEndTime() : 0;
|
|
}
|
|
|
|
/**
|
|
* Gets the duration of the events (including all periods).
|
|
*
|
|
* @return integer The duration (in milliseconds)
|
|
*/
|
|
public function getDuration()
|
|
{
|
|
$total = 0;
|
|
foreach ($this->periods as $period) {
|
|
$total += $period->getDuration();
|
|
}
|
|
|
|
return $this->formatTime($total);
|
|
}
|
|
|
|
/**
|
|
* Gets the max memory usage of all periods.
|
|
*
|
|
* @return integer The memory usage (in bytes)
|
|
*/
|
|
public function getMemory()
|
|
{
|
|
$memory = 0;
|
|
foreach ($this->periods as $period) {
|
|
if ($period->getMemory() > $memory) {
|
|
$memory = $period->getMemory();
|
|
}
|
|
}
|
|
|
|
return $memory;
|
|
}
|
|
|
|
/**
|
|
* Return the current time relative to origin.
|
|
*
|
|
* @return float Time in ms
|
|
*/
|
|
protected function getNow()
|
|
{
|
|
return $this->formatTime(microtime(true) * 1000 - $this->origin);
|
|
}
|
|
|
|
/**
|
|
* Formats a time.
|
|
*
|
|
* @param integer|float $time A raw time
|
|
*
|
|
* @return float The formatted time
|
|
*
|
|
* @throws \InvalidArgumentException When the raw time is not valid
|
|
*/
|
|
private function formatTime($time)
|
|
{
|
|
if (!is_numeric($time)) {
|
|
throw new \InvalidArgumentException('The time must be a numerical value');
|
|
}
|
|
|
|
return round($time, 1);
|
|
}
|
|
}
|