2011-10-17 09:25:52 +01:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
2012-03-31 22:00:32 +01:00
|
|
|
* This file is part of the Symfony package.
|
2011-10-17 09:25:52 +01:00
|
|
|
*
|
|
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
|
|
*
|
2012-03-31 22:00:32 +01:00
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
2011-10-17 09:25:52 +01:00
|
|
|
*/
|
|
|
|
|
2012-11-09 06:47:23 +00:00
|
|
|
namespace Symfony\Component\Stopwatch;
|
2011-10-17 09:25:52 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Stopwatch provides a way to profile code.
|
|
|
|
*
|
|
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
|
|
*/
|
|
|
|
class Stopwatch
|
|
|
|
{
|
2012-11-09 20:03:11 +00:00
|
|
|
/**
|
|
|
|
* @var Section[]
|
|
|
|
*/
|
2011-10-17 09:25:52 +01:00
|
|
|
private $sections;
|
2012-11-09 20:03:11 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var array
|
|
|
|
*/
|
2012-02-06 14:51:54 +00:00
|
|
|
private $activeSections;
|
|
|
|
|
|
|
|
public function __construct()
|
|
|
|
{
|
|
|
|
$this->sections = $this->activeSections = array('__root__' => new Section('__root__'));
|
|
|
|
}
|
2011-10-17 09:25:52 +01:00
|
|
|
|
|
|
|
/**
|
2012-02-06 14:51:54 +00:00
|
|
|
* Creates a new section or re-opens an existing section.
|
|
|
|
*
|
|
|
|
* @param string|null $id The id of the session to re-open, null to create a new one
|
|
|
|
*
|
|
|
|
* @throws \LogicException When the section to re-open is not reachable
|
2011-10-17 09:25:52 +01:00
|
|
|
*/
|
2012-02-06 14:51:54 +00:00
|
|
|
public function openSection($id = null)
|
2011-10-17 09:25:52 +01:00
|
|
|
{
|
2012-02-06 14:51:54 +00:00
|
|
|
$current = end($this->activeSections);
|
2011-10-17 09:25:52 +01:00
|
|
|
|
2012-02-06 19:51:05 +00:00
|
|
|
if (null !== $id && null === $current->get($id)) {
|
|
|
|
throw new \LogicException(sprintf('The section "%s" has been started at an other level and can not be opened.', $id));
|
2012-02-06 14:51:54 +00:00
|
|
|
}
|
2011-10-17 09:25:52 +01:00
|
|
|
|
2012-02-06 14:51:54 +00:00
|
|
|
$this->start('__section__.child', 'section');
|
|
|
|
$this->activeSections[] = $current->open($id);
|
2012-01-31 06:48:19 +00:00
|
|
|
$this->start('__section__');
|
2011-10-17 09:25:52 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Stops the last started section.
|
|
|
|
*
|
2012-01-10 21:23:16 +00:00
|
|
|
* The id parameter is used to retrieve the events from this section.
|
|
|
|
*
|
|
|
|
* @see getSectionEvents
|
|
|
|
*
|
2011-10-17 09:25:52 +01:00
|
|
|
* @param string $id The identifier of the section
|
2012-11-09 20:03:11 +00:00
|
|
|
*
|
|
|
|
* @throws \LogicException When there's no started section to be stopped
|
2011-10-17 09:25:52 +01:00
|
|
|
*/
|
|
|
|
public function stopSection($id)
|
|
|
|
{
|
2012-01-31 06:48:19 +00:00
|
|
|
$this->stop('__section__');
|
2011-10-17 09:25:52 +01:00
|
|
|
|
2012-02-06 14:51:54 +00:00
|
|
|
if (1 == count($this->activeSections)) {
|
|
|
|
throw new \LogicException('There is no started section to stop.');
|
2011-10-17 09:25:52 +01:00
|
|
|
}
|
|
|
|
|
2012-02-06 14:51:54 +00:00
|
|
|
$this->sections[$id] = array_pop($this->activeSections)->setId($id);
|
|
|
|
$this->stop('__section__.child');
|
2011-10-17 09:25:52 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Starts an event.
|
|
|
|
*
|
|
|
|
* @param string $name The event name
|
|
|
|
* @param string $category The event category
|
|
|
|
*
|
|
|
|
* @return StopwatchEvent A StopwatchEvent instance
|
|
|
|
*/
|
|
|
|
public function start($name, $category = null)
|
2012-02-06 14:51:54 +00:00
|
|
|
{
|
|
|
|
return end($this->activeSections)->startEvent($name, $category);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Stops an event.
|
|
|
|
*
|
|
|
|
* @param string $name The event name
|
|
|
|
*
|
|
|
|
* @return StopwatchEvent A StopwatchEvent instance
|
|
|
|
*/
|
|
|
|
public function stop($name)
|
|
|
|
{
|
|
|
|
return end($this->activeSections)->stopEvent($name);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Stops then restarts an event.
|
|
|
|
*
|
|
|
|
* @param string $name The event name
|
|
|
|
*
|
2012-02-06 19:51:05 +00:00
|
|
|
* @return StopwatchEvent A StopwatchEvent instance
|
2012-02-06 14:51:54 +00:00
|
|
|
*/
|
|
|
|
public function lap($name)
|
|
|
|
{
|
|
|
|
return end($this->activeSections)->stopEvent($name)->start();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets all events for a given section.
|
|
|
|
*
|
|
|
|
* @param string $id A section identifier
|
|
|
|
*
|
2012-02-06 19:51:05 +00:00
|
|
|
* @return StopwatchEvent[] An array of StopwatchEvent instances
|
2012-02-06 14:51:54 +00:00
|
|
|
*/
|
|
|
|
public function getSectionEvents($id)
|
|
|
|
{
|
|
|
|
return isset($this->sections[$id]) ? $this->sections[$id]->getEvents() : array();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-11-09 20:03:11 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal This class is for internal usage only
|
|
|
|
*
|
|
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
|
|
*/
|
2012-02-06 14:51:54 +00:00
|
|
|
class Section
|
|
|
|
{
|
2012-11-09 20:03:11 +00:00
|
|
|
/**
|
|
|
|
* @var StopwatchEvent[]
|
|
|
|
*/
|
2012-02-06 14:51:54 +00:00
|
|
|
private $events = array();
|
2012-11-09 20:03:11 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var null|float
|
|
|
|
*/
|
2012-02-06 14:51:54 +00:00
|
|
|
private $origin;
|
2012-11-09 20:03:11 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*/
|
2012-02-06 14:51:54 +00:00
|
|
|
private $id;
|
2012-11-09 20:03:11 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var Section[]
|
|
|
|
*/
|
2012-02-06 14:51:54 +00:00
|
|
|
private $children = array();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*
|
|
|
|
* @param float|null $origin Set the origin of the events in this section, use null to set their origin to their start time
|
|
|
|
*/
|
|
|
|
public function __construct($origin = null)
|
|
|
|
{
|
|
|
|
$this->origin = is_numeric($origin) ? $origin : null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the child section.
|
|
|
|
*
|
|
|
|
* @param string $id The child section identifier
|
|
|
|
*
|
2012-02-06 19:51:05 +00:00
|
|
|
* @return Section|null The child section or null when none found
|
2012-02-06 14:51:54 +00:00
|
|
|
*/
|
|
|
|
public function get($id)
|
|
|
|
{
|
|
|
|
foreach ($this->children as $child) {
|
|
|
|
if ($id === $child->getId()) {
|
|
|
|
return $child;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-02-06 19:51:05 +00:00
|
|
|
return null;
|
2012-02-06 14:51:54 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates or re-opens a child section.
|
|
|
|
*
|
|
|
|
* @param string|null $id null to create a new section, the identifier to re-open an existing one.
|
|
|
|
*
|
|
|
|
* @return Section A child section
|
|
|
|
*/
|
|
|
|
public function open($id)
|
|
|
|
{
|
2012-02-06 19:51:05 +00:00
|
|
|
if (null === $session = $this->get($id)) {
|
2012-02-06 14:51:54 +00:00
|
|
|
$session = $this->children[] = new self(microtime(true) * 1000);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $session;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string The identifier of the section
|
|
|
|
*/
|
|
|
|
public function getId()
|
|
|
|
{
|
|
|
|
return $this->id;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the session identifier.
|
|
|
|
*
|
|
|
|
* @param string $id The session identifier
|
|
|
|
*
|
|
|
|
* @return Section The current section
|
|
|
|
*/
|
|
|
|
public function setId($id)
|
|
|
|
{
|
|
|
|
$this->id = $id;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Starts an event.
|
|
|
|
*
|
|
|
|
* @param string $name The event name
|
|
|
|
* @param string $category The event category
|
|
|
|
*
|
2012-02-06 19:51:05 +00:00
|
|
|
* @return StopwatchEvent The event
|
2012-02-06 14:51:54 +00:00
|
|
|
*/
|
|
|
|
public function startEvent($name, $category)
|
2011-10-17 09:25:52 +01:00
|
|
|
{
|
|
|
|
if (!isset($this->events[$name])) {
|
2012-01-25 13:27:59 +00:00
|
|
|
$this->events[$name] = new StopwatchEvent($this->origin ?: microtime(true) * 1000, $category);
|
2011-10-17 09:25:52 +01:00
|
|
|
}
|
|
|
|
|
2012-01-10 21:23:16 +00:00
|
|
|
return $this->events[$name]->start();
|
2011-10-17 09:25:52 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Stops an event.
|
|
|
|
*
|
|
|
|
* @param string $name The event name
|
|
|
|
*
|
2012-02-06 19:51:05 +00:00
|
|
|
* @return StopwatchEvent The event
|
2012-02-06 14:51:54 +00:00
|
|
|
*
|
|
|
|
* @throws \LogicException When the event has not been started
|
2011-10-17 09:25:52 +01:00
|
|
|
*/
|
2012-02-06 14:51:54 +00:00
|
|
|
public function stopEvent($name)
|
2011-10-17 09:25:52 +01:00
|
|
|
{
|
|
|
|
if (!isset($this->events[$name])) {
|
|
|
|
throw new \LogicException(sprintf('Event "%s" is not started.', $name));
|
|
|
|
}
|
|
|
|
|
2012-01-10 21:23:16 +00:00
|
|
|
return $this->events[$name]->stop();
|
2011-10-17 09:25:52 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-02-06 14:51:54 +00:00
|
|
|
* Stops then restarts an event.
|
2011-10-17 09:25:52 +01:00
|
|
|
*
|
|
|
|
* @param string $name The event name
|
|
|
|
*
|
2012-02-06 19:51:05 +00:00
|
|
|
* @return StopwatchEvent The event
|
2012-02-06 14:51:54 +00:00
|
|
|
*
|
|
|
|
* @throws \LogicException When the event has not been started
|
2011-10-17 09:25:52 +01:00
|
|
|
*/
|
|
|
|
public function lap($name)
|
|
|
|
{
|
2012-11-09 20:03:11 +00:00
|
|
|
return $this->stopEvent($name)->start();
|
2011-10-17 09:25:52 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-02-06 14:51:54 +00:00
|
|
|
* Returns the events from this section.
|
2011-10-17 09:25:52 +01:00
|
|
|
*
|
2012-02-06 19:51:05 +00:00
|
|
|
* @return StopwatchEvent[] An array of StopwatchEvent instances
|
2011-10-17 09:25:52 +01:00
|
|
|
*/
|
2012-02-06 14:51:54 +00:00
|
|
|
public function getEvents()
|
2011-10-17 09:25:52 +01:00
|
|
|
{
|
2012-02-06 14:51:54 +00:00
|
|
|
return $this->events;
|
2011-10-17 09:25:52 +01:00
|
|
|
}
|
2012-02-22 18:03:34 +00:00
|
|
|
}
|