242 lines
5.1 KiB
PHP
242 lines
5.1 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 = array();
|
||
|
|
||
|
/**
|
||
|
* @var float
|
||
|
*/
|
||
|
private $origin;
|
||
|
|
||
|
/**
|
||
|
* @var string
|
||
|
*/
|
||
|
private $category;
|
||
|
|
||
|
/**
|
||
|
* @var float[]
|
||
|
*/
|
||
|
private $started = array();
|
||
|
|
||
|
/**
|
||
|
* @param float $origin The origin time in milliseconds
|
||
|
* @param string|null $category The event category or null to use the default
|
||
|
*
|
||
|
* @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';
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Gets the category.
|
||
|
*
|
||
|
* @return string The category
|
||
|
*/
|
||
|
public function getCategory()
|
||
|
{
|
||
|
return $this->category;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Gets the origin.
|
||
|
*
|
||
|
* @return float The origin in milliseconds
|
||
|
*/
|
||
|
public function getOrigin()
|
||
|
{
|
||
|
return $this->origin;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Starts a new event period.
|
||
|
*
|
||
|
* @return $this
|
||
|
*/
|
||
|
public function start()
|
||
|
{
|
||
|
$this->started[] = $this->getNow();
|
||
|
|
||
|
return $this;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Stops the last started event period.
|
||
|
*
|
||
|
* @return $this
|
||
|
*
|
||
|
* @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;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Checks if the event was started.
|
||
|
*
|
||
|
* @return bool
|
||
|
*/
|
||
|
public function isStarted()
|
||
|
{
|
||
|
return !empty($this->started);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Stops the current period and then starts a new one.
|
||
|
*
|
||
|
* @return $this
|
||
|
*/
|
||
|
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 int 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 int The time (in milliseconds)
|
||
|
*/
|
||
|
public function getEndTime()
|
||
|
{
|
||
|
$count = count($this->periods);
|
||
|
|
||
|
return $count ? $this->periods[$count - 1]->getEndTime() : 0;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Gets the duration of the events (including all periods).
|
||
|
*
|
||
|
* @return int The duration (in milliseconds)
|
||
|
*/
|
||
|
public function getDuration()
|
||
|
{
|
||
|
$periods = $this->periods;
|
||
|
$stopped = count($periods);
|
||
|
$left = count($this->started) - $stopped;
|
||
|
|
||
|
for ($i = 0; $i < $left; ++$i) {
|
||
|
$index = $stopped + $i;
|
||
|
$periods[] = new StopwatchPeriod($this->started[$index], $this->getNow());
|
||
|
}
|
||
|
|
||
|
$total = 0;
|
||
|
foreach ($periods as $period) {
|
||
|
$total += $period->getDuration();
|
||
|
}
|
||
|
|
||
|
return $total;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Gets the max memory usage of all periods.
|
||
|
*
|
||
|
* @return int 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 int|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);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @return string
|
||
|
*/
|
||
|
public function __toString()
|
||
|
{
|
||
|
return sprintf('%s: %.2F MiB - %d ms', $this->getCategory(), $this->getMemory() / 1024 / 1024, $this->getDuration());
|
||
|
}
|
||
|
}
|