<?php

declare(strict_types=1);

/**

* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)

* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)

*

* Licensed under The MIT License

* Redistributions of files must retain the above copyright notice.

*

* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)

* @link https://cakephp.org CakePHP(tm) Project

* @since DebugKit 0.1

* @license https://www.opensource.org/licenses/mit-license.php MIT License

*/

namespace DebugKit;

use Cake\Error\Debugger;

use function Cake\Core\env;

/**

* Contains methods for Profiling and creating timers.

*/

class DebugTimer

{

/**

* Internal timers array

*/

protected static array $timers = [];

/**

* Start an benchmarking timer.

*

* @param string $name The name of the timer to start.

* @param string $message A message for your timer

* @return bool Always true

*/

public static function start(?string $name = null, ?string $message = null): bool

{

$start = microtime(true);

if (!$name) {

$named = false;

$calledFrom = debug_backtrace();

$file = $calledFrom[0]['file'] ?? 'unknown file';

$line = $calledFrom[0]['line'] ?? 'n/a';

$name = Debugger::trimPath($file) . ' line ' . $line;

} else {

$named = true;

}

if (!$message) {

$message = $name;

}

$_name = $name;

$i = 1;

while (isset(self::$timers[$name])) {

$i++;

$name = $_name . ' #' . $i;

}

if ($i > 1) {

$message .= ' #' . $i;

}

self::$timers[$name] = [

'start' => $start,

'message' => $message,

'named' => $named,

];

return true;

}

/**

* Stop a benchmarking timer.

*

* $name should be the same as the $name used in startTimer().

*

* @param string $name The name of the timer to end.

* @return bool true if timer was ended, false if timer was not started.

*/

public static function stop(?string $name = null): bool

{

$end = microtime(true);

if (!$name) {

$names = array_reverse(array_keys(self::$timers));

foreach ($names as $name) {

if (!empty(self::$timers[$name]['end'])) {

continue;

}

if (empty(self::$timers[$name]['named'])) {

break;

}

}

} else {

$i = 1;

$_name = $name;

while (isset(self::$timers[$name])) {

if (empty(self::$timers[$name]['end'])) {

break;

}

$i++;

$name = $_name . ' #' . $i;

}

}

if (!isset(self::$timers[$name])) {

return false;

}

self::$timers[$name]['end'] = $end;

return true;

}

/**

* Get all timers that have been started and stopped.

* Calculates elapsed time for each timer. If clear is true, will delete existing timers

*

* @param bool $clear false

* @return array

*/

public static function getAll(bool $clear = false): array

{

$start = self::requestStartTime();

$now = microtime(true);

$times = [];

if (self::$timers !== []) {

$firstTimer = reset(self::$timers);

$_end = $firstTimer['start'];

} else {

$_end = $now;

}

$times['Core Processing (Derived from $_SERVER["REQUEST_TIME"])'] = [

'message' => 'Core Processing (Derived from $_SERVER["REQUEST_TIME"])',

'start' => 0,

'end' => $_end - $start,

'time' => round($_end - $start, 6),

'named' => null,

];

foreach (self::$timers as $name => $timer) {

$timer['end'] ??= $now;

$times[$name] = array_merge($timer, [

'start' => $timer['start'] - $start,

'end' => $timer['end'] - $start,

'time' => self::elapsedTime($name),

]);

}

if ($clear) {

self::$timers = [];

}

return $times;

}

/**

* Clear all existing timers

*

* @return bool true

*/

public static function clear(): bool

{

self::$timers = [];

return true;

}

/**

* Get the difference in time between the timer start and timer end.

*

* @param string $name the name of the timer you want elapsed time for.

* @param int $precision the number of decimal places to return, defaults to 5.

* @return float number of seconds elapsed for timer name, 0 on missing key

*/

public static function elapsedTime(string $name = 'default', int $precision = 5): float

{

if (!isset(self::$timers[$name]['start']) || !isset(self::$timers[$name]['end'])) {

return 0;

}

return round(self::$timers[$name]['end'] - self::$timers[$name]['start'], $precision);

}

/**

* Get the total execution time until this point

*

* @return float elapsed time in seconds since script start.

*/

public static function requestTime(): float

{

$start = self::requestStartTime();

$now = microtime(true);

return $now - $start;

}

/**

* get the time the current request started.

*

* @return float time of request start

*/

public static function requestStartTime(): float

{

if (defined('TIME_START')) {

$startTime = TIME_START;

} elseif (isset($GLOBALS['TIME_START'])) {

$startTime = $GLOBALS['TIME_START'];

} else {

$startTime = env('REQUEST_TIME');

}

return (float)$startTime;

}

}