Classes List

Symfony\Component\Stopwatch\StopwatchEvent

 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 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
 236 
 237 
 238 
 239 
 240 
 241 
 242 
 243 
 244 
 245 
 246 
 247 
 248 
 249 
<?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 bool */
    private $morePrecision;

    /** * @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 * @param bool $morePrecision If true, time is stored as float to keep the original microsecond precision * * @throws \InvalidArgumentException When the raw time is not valid */
    public function __construct($origin$category = null$morePrecision = false)
    {
        $this->origin = $this->formatTime($origin);
        $this->category = is_string($category) ? $category : 'default';
        $this->morePrecision = $morePrecision;
    }

    /** * 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(), $this->morePrecision);

        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|float 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|float 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|float 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(), $this->morePrecision);
        }

        $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($time1);
    }

    /** * @return string */
    public function __toString()
    {
        return sprintf('%s: %.2F MiB - %d ms'$this->getCategory(), $this->getMemory() / 1024 / 1024$this->getDuration());
    }
}