Classes List

Symfony\Component\Stopwatch\Stopwatch

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
<?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;

/** * Stopwatch provides a way to profile code. * * @author Fabien Potencier <fabien@symfony.com> */
class Stopwatch
{
    /** * @var bool */
    private $morePrecision;

    /** * @var Section[] */
    private $sections;

    /** * @var Section[] */
    private $activeSections;

    /** * @param bool $morePrecision If true, time is stored as float to keep the original microsecond precision */
    public function __construct($morePrecision = false)
    {
        $this->morePrecision = $morePrecision;
        $this->reset();
    }

    /** * @return Section[] */
    public function getSections()
    {
        return $this->sections;
    }

    /** * 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 */
    public function openSection($id = null)
    {
        $current = end($this->activeSections);

        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));
        }

        $this->start('__section__.child''section');
        $this->activeSections[] = $current->open($id);
        $this->start('__section__');
    }

    /** * Stops the last started section. * * The id parameter is used to retrieve the events from this section. * * @see getSectionEvents() * * @param string $id The identifier of the section * * @throws \LogicException When there's no started section to be stopped */
    public function stopSection($id)
    {
        $this->stop('__section__');

        if (1 == count($this->activeSections)) {
            throw new \LogicException('There is no started section to stop.');
        }

        $this->sections[$id] = array_pop($this->activeSections)->setId($id);
        $this->stop('__section__.child');
    }

    /** * Starts an event. * * @param string $name The event name * @param string $category The event category * * @return StopwatchEvent */
    public function start($name$category = null)
    {
        return end($this->activeSections)->startEvent($name$category);
    }

    /** * Checks if the event was started. * * @param string $name The event name * * @return bool */
    public function isStarted($name)
    {
        return end($this->activeSections)->isEventStarted($name);
    }

    /** * Stops an event. * * @param string $name The event name * * @return StopwatchEvent */
    public function stop($name)
    {
        return end($this->activeSections)->stopEvent($name);
    }

    /** * Stops then restarts an event. * * @param string $name The event name * * @return StopwatchEvent */
    public function lap($name)
    {
        return end($this->activeSections)->stopEvent($name)->start();
    }

    /** * Returns a specific event by name. * * @param string $name The event name * * @return StopwatchEvent */
    public function getEvent($name)
    {
        return end($this->activeSections)->getEvent($name);
    }

    /** * Gets all events for a given section. * * @param string $id A section identifier * * @return StopwatchEvent[] */
    public function getSectionEvents($id)
    {
        return isset($this->sections[$id]) ? $this->sections[$id]->getEvents() : array();
    }

    /** * Resets the stopwatch to its original state. */
    public function reset()
    {
        $this->sections = $this->activeSections = array('__root__' => new Section(null$this->morePrecision));
    }
}