Classes List

Symfony\Component\Stopwatch\Section

 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 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
<?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 section. * * @author Fabien Potencier <fabien@symfony.com> */
class Section
{
    /** * @var StopwatchEvent[] */
    private $events = array();

    /** * @var null|float */
    private $origin;

    /** * @var bool */
    private $morePrecision;

    /** * @var string */
    private $id;

    /** * @var Section[] */
    private $children = array();

    /** * @param float|null $origin Set the origin of the events in this section, use null to set their origin to their start time * @param bool $morePrecision If true, time is stored as float to keep the original microsecond precision */
    public function __construct($origin = null$morePrecision = false)
    {
        $this->origin = is_numeric($origin) ? $origin : null;
        $this->morePrecision = $morePrecision;
    }

    /** * Returns the child section. * * @param string $id The child section identifier * * @return self|null The child section or null when none found */
    public function get($id)
    {
        foreach ($this->children as $child) {
            if ($id === $child->getId()) {
                return $child;
            }
        }
    }

    /** * 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 self */
    public function open($id)
    {
        if (null === $session = $this->get($id)) {
            $session = $this->children[] = new self(microtime(true) * 1000$this->morePrecision);
        }

        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 $this */
    public function setId($id)
    {
        $this->id = $id;

        return $this;
    }

    /** * Starts an event. * * @param string $name The event name * @param string $category The event category * * @return StopwatchEvent The event */
    public function startEvent($name$category)
    {
        if (!isset($this->events[$name])) {
            $this->events[$name] = new StopwatchEvent($this->origin ?: microtime(true) * 1000$category$this->morePrecision);
        }

        return $this->events[$name]->start();
    }

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

    /** * Stops an event. * * @param string $name The event name * * @return StopwatchEvent The event * * @throws \LogicException When the event has not been started */
    public function stopEvent($name)
    {
        if (!isset($this->events[$name])) {
            throw new \LogicException(sprintf('Event "%s" is not started.'$name));
        }

        return $this->events[$name]->stop();
    }

    /** * Stops then restarts an event. * * @param string $name The event name * * @return StopwatchEvent The event * * @throws \LogicException When the event has not been started */
    public function lap($name)
    {
        return $this->stopEvent($name)->start();
    }

    /** * Returns a specific event by name. * * @param string $name The event name * * @return StopwatchEvent The event * * @throws \LogicException When the event is not known */
    public function getEvent($name)
    {
        if (!isset($this->events[$name])) {
            throw new \LogicException(sprintf('Event "%s" is not known.'$name));
        }

        return $this->events[$name];
    }

    /** * Returns the events from this section. * * @return StopwatchEvent[] An array of StopwatchEvent instances */
    public function getEvents()
    {
        return $this->events;
    }
}