v2.8.4

app/Ubench.php

@@ -0,0 +1,199 @@
+<?php
+
+/*
+ * https://github.com/devster/ubench
+ * 
+ * Copyright (c) 2012 Jeremy Perret
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is furnished
+ * to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+class Ubench
+{
+    protected $start_time;
+
+    protected $end_time;
+
+    protected $memory_usage;
+
+    /**
+     * Sets start microtime
+     *
+     * @return void
+     */
+    public function start()
+    {
+        $this->start_time = microtime(true);
+    }
+
+    /**
+     * Sets end microtime
+     *
+     * @return $this
+     * @throws Exception
+     */
+    public function end()
+    {
+        if (!$this->hasStarted())
+        {
+            throw new LogicException("You must call start()");
+        }
+
+        $this->end_time = microtime(true);
+        $this->memory_usage = memory_get_usage(true);
+        return $this;
+    }
+
+    /**
+     * Returns the elapsed time, readable or not
+     *
+     * @param bool $raw
+     * @param  string $format The format to display (printf format)
+     * @return float|string
+     * @throws Exception
+     */
+    public function getTime($raw = false, $format = null)
+    {
+        if (!$this->hasStarted())
+        {
+            throw new LogicException("You must call start()");
+        }
+
+        if (!$this->hasEnded())
+        {
+            throw new LogicException("You must call end()");
+        }
+
+        $elapsed = $this->end_time - $this->start_time;
+
+        return $raw ? $elapsed : self::readableElapsedTime($elapsed, $format);
+    }
+
+    /**
+     * Returns the memory usage at the end checkpoint
+     *
+     * @param  boolean $readable Whether the result must be human readable
+     * @param  string  $format   The format to display (printf format)
+     * @return string|float
+     */
+    public function getMemoryUsage($raw = false, $format = null)
+    {
+        return $raw ? $this->memory_usage : self::readableSize($this->memory_usage, $format);
+    }
+
+    /**
+     * Returns the memory peak, readable or not
+     *
+     * @param  boolean $readable Whether the result must be human readable
+     * @param  string  $format   The format to display (printf format)
+     * @return string|float
+     */
+    public function getMemoryPeak($raw = false, $format = null)
+    {
+        $memory = memory_get_peak_usage(true);
+
+        return $raw ? $memory : self::readableSize($memory, $format);
+    }
+
+    /**
+     * Wraps a callable with start() and end() calls
+     *
+     * Additional arguments passed to this method will be passed to
+     * the callable.
+     *
+     * @param callable $callable
+     * @return mixed
+     */
+    public function run(callable $callable)
+    {
+        $arguments = func_get_args();
+        array_shift($arguments);
+
+        $this->start();
+        $result = call_user_func_array($callable, $arguments);
+        $this->end();
+
+        return $result;
+    }
+
+    /**
+     * Returns a human readable memory size
+     *
+     * @param   int    $size
+     * @param   string $format   The format to display (printf format)
+     * @param   int    $round
+     * @return  string
+     */
+    public static function readableSize($size, $format = null, $round = 3)
+    {
+        $mod = 1024;
+
+        if (is_null($format)) {
+            $format = '%.2f%s';
+        }
+
+        $units = explode(' ','B Kb Mb Gb Tb');
+
+        for ($i = 0; $size > $mod; $i++) {
+            $size /= $mod;
+        }
+
+        if (0 === $i) {
+            $format = preg_replace('/(%.[\d]+f)/', '%d', $format);
+        }
+
+        return sprintf($format, round($size, $round), $units[$i]);
+    }
+
+    /**
+     * Returns a human readable elapsed time
+     *
+     * @param  float $microtime
+     * @param  string  $format   The format to display (printf format)
+     * @return string
+     */
+    public static function readableElapsedTime($microtime, $format = null, $round = 3)
+    {
+        if (is_null($format)) {
+            $format = '%.3f%s';
+        }
+
+        if ($microtime >= 1) {
+            $unit = 's';
+            $time = round($microtime, $round);
+        } else {
+            $unit = 'ms';
+            $time = round($microtime*1000);
+
+            $format = preg_replace('/(%.[\d]+f)/', '%d', $format);
+        }
+
+        return sprintf($format, $time, $unit);
+    }
+
+    public function hasEnded()
+    {
+        return isset($this->end_time);
+    }
+
+    public function hasStarted()
+    {
+        return isset($this->start_time);
+    }
+}