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
|
|
|
|
|
|
|
/**
|
2014-05-02 18:35:41 +01:00
|
|
|
* @var Section[]
|
2012-11-09 20:03:11 +00:00
|
|
|
*/
|
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
|
|
|
|
2014-06-06 11:36:27 +01:00
|
|
|
/**
|
|
|
|
* @return Section[]
|
|
|
|
*/
|
2014-05-02 18:35:41 +01:00
|
|
|
public function getSections()
|
|
|
|
{
|
|
|
|
return $this->sections;
|
|
|
|
}
|
|
|
|
|
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.
|
|
|
|
*
|
2014-12-21 16:36:15 +00:00
|
|
|
* @see getSectionEvents()
|
2012-01-10 21:23:16 +00:00
|
|
|
*
|
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);
|
|
|
|
}
|
|
|
|
|
2013-04-12 15:28:00 +01:00
|
|
|
/**
|
2014-12-21 17:00:50 +00:00
|
|
|
* Checks if the event was started.
|
2013-04-12 15:28:00 +01:00
|
|
|
*
|
|
|
|
* @param string $name The event name
|
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function isStarted($name)
|
|
|
|
{
|
|
|
|
return end($this->activeSections)->isEventStarted($name);
|
|
|
|
}
|
|
|
|
|
2012-02-06 14:51:54 +00:00
|
|
|
/**
|
|
|
|
* 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();
|
|
|
|
}
|
|
|
|
|
2014-02-04 11:05:45 +00:00
|
|
|
/**
|
2015-08-24 07:53:33 +01:00
|
|
|
* Returns a specific event by name.
|
2014-02-04 11:05:45 +00:00
|
|
|
*
|
|
|
|
* @param string $name The event name
|
|
|
|
*
|
|
|
|
* @return StopwatchEvent A StopwatchEvent instance
|
|
|
|
*/
|
|
|
|
public function getEvent($name)
|
|
|
|
{
|
|
|
|
return end($this->activeSections)->getEvent($name);
|
|
|
|
}
|
|
|
|
|
2012-02-06 14:51:54 +00:00
|
|
|
/**
|
|
|
|
* 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();
|
|
|
|
}
|
|
|
|
}
|