X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FUtil%2FProfiler.php;h=a98e728928765fe6a61fd30d493ec5abecf20293;hb=b5ad8c3e153976cf3e63753597377f09852d98d7;hp=24289678c266a41450b751fff3b6132ff8355cd7;hpb=322b7c856ca9ba53bd9c7da50dd5c1e3c9197d56;p=friendica.git diff --git a/src/Util/Profiler.php b/src/Util/Profiler.php index 24289678c2..a98e728928 100644 --- a/src/Util/Profiler.php +++ b/src/Util/Profiler.php @@ -61,7 +61,7 @@ class Profiler implements ContainerInterface * * @return bool */ - public function isRendertime() + public function isRendertime(): bool { return $this->rendertime; } @@ -69,21 +69,27 @@ class Profiler implements ContainerInterface /** * Updates the enabling of the current profiler * + * Note: The reason there are two different ways of updating the configuration of this class is because it can + * be used even with no available database connection which IManageConfigValues doesn't ensure. + * * @param IManageConfigValues $config */ public function update(IManageConfigValues $config) { - $this->enabled = $config->get('system', 'profiler'); - $this->rendertime = $config->get('rendertime', 'callstack'); + $this->enabled = (bool) $config->get('system', 'profiler') ?? false; + $this->rendertime = (bool) $config->get('rendertime', 'callstack') ?? false; } /** + * Note: The reason we are using a Config Cache object to initialize this class is to ensure it'll work even with no + * available database connection. + * * @param \Friendica\Core\Config\ValueObject\Cache $configCache The configuration cache */ public function __construct(Cache $configCache) { - $this->enabled = $configCache->get('system', 'profiler'); - $this->rendertime = $configCache->get('rendertime', 'callstack'); + $this->enabled = (bool) $configCache->get('system', 'profiler') ?? false; + $this->rendertime = (bool) $configCache->get('rendertime', 'callstack') ?? false; $this->reset(); } @@ -91,6 +97,7 @@ class Profiler implements ContainerInterface * Start a profiler recording * * @param string $value + * * @return void */ public function startRecording(string $value) @@ -106,6 +113,7 @@ class Profiler implements ContainerInterface * Stop a profiler recording * * @param string $callstack + * * @return void */ public function stopRecording(string $callstack = '') @@ -144,11 +152,13 @@ class Profiler implements ContainerInterface * Saves a timestamp for a value - f.e. a call * Necessary for profiling Friendica * - * @param int $timestamp the Timestamp + * @param float $timestamp the Timestamp * @param string $value A value to profile * @param string $callstack A callstack string, generated if absent + * + * @return void */ - public function saveTimestamp($timestamp, $value, $callstack = '') + public function saveTimestamp(float $timestamp, string $value, string $callstack = '') { if (!$this->enabled) { return; @@ -176,6 +186,8 @@ class Profiler implements ContainerInterface /** * Resets the performance and callstack profiling + * + * @return void */ public function reset() { @@ -185,6 +197,8 @@ class Profiler implements ContainerInterface /** * Resets the performance profiling data + * + * @return void */ public function resetPerformance() { @@ -209,6 +223,8 @@ class Profiler implements ContainerInterface /** * Resets the callstack profiling data + * + * @return void */ public function resetCallstack() { @@ -229,7 +245,7 @@ class Profiler implements ContainerInterface * * @return string the rendertime */ - public function getRendertimeString(float $limit = 0) + public function getRendertimeString(float $limit = 0): string { $output = ''; @@ -237,58 +253,62 @@ class Profiler implements ContainerInterface return $output; } - if (isset($this->callstack["database"])) { + if (isset($this->callstack['database'])) { $output .= "\nDatabase Read:\n"; - foreach ($this->callstack["database"] as $func => $time) { + foreach ($this->callstack['database'] as $func => $time) { $time = round($time, 3); if ($time > $limit) { - $output .= $func . ": " . $time . "\n"; + $output .= $func . ': ' . $time . "\n"; } } } - if (isset($this->callstack["database_write"])) { + + if (isset($this->callstack['database_write'])) { $output .= "\nDatabase Write:\n"; - foreach ($this->callstack["database_write"] as $func => $time) { + foreach ($this->callstack['database_write'] as $func => $time) { $time = round($time, 3); if ($time > $limit) { - $output .= $func . ": " . $time . "\n"; + $output .= $func . ': ' . $time . "\n"; } } } - if (isset($this->callstack["cache"])) { + + if (isset($this->callstack['cache'])) { $output .= "\nCache Read:\n"; - foreach ($this->callstack["cache"] as $func => $time) { + foreach ($this->callstack['cache'] as $func => $time) { $time = round($time, 3); if ($time > $limit) { - $output .= $func . ": " . $time . "\n"; + $output .= $func . ': ' . $time . "\n"; } } } - if (isset($this->callstack["cache_write"])) { + + if (isset($this->callstack['cache_write'])) { $output .= "\nCache Write:\n"; - foreach ($this->callstack["cache_write"] as $func => $time) { + foreach ($this->callstack['cache_write'] as $func => $time) { $time = round($time, 3); if ($time > $limit) { - $output .= $func . ": " . $time . "\n"; + $output .= $func . ': ' . $time . "\n"; } } } - if (isset($this->callstack["network"])) { + + if (isset($this->callstack['network'])) { $output .= "\nNetwork:\n"; - foreach ($this->callstack["network"] as $func => $time) { + foreach ($this->callstack['network'] as $func => $time) { $time = round($time, 3); if ($time > $limit) { - $output .= $func . ": " . $time . "\n"; + $output .= $func . ': ' . $time . "\n"; } } } - if (isset($this->callstack["rendering"])) { + if (isset($this->callstack['rendering'])) { $output .= "\nRendering:\n"; - foreach ($this->callstack["rendering"] as $func => $time) { + foreach ($this->callstack['rendering'] as $func => $time) { $time = round($time, 3); if ($time > $limit) { - $output .= $func . ": " . $time . "\n"; + $output .= $func . ': ' . $time . "\n"; } } } @@ -301,8 +321,10 @@ class Profiler implements ContainerInterface * * @param LoggerInterface $logger The logger to save the current log * @param string $message Additional message for the log + * + * @return void */ - public function saveLog(LoggerInterface $logger, $message = '') + public function saveLog(LoggerInterface $logger, string $message = '') { $duration = microtime(true) - $this->get('start'); $logger->info( @@ -336,9 +358,9 @@ class Profiler implements ContainerInterface * @throws NotFoundExceptionInterface No entry was found for **this** identifier. * @throws ContainerExceptionInterface Error while retrieving the entry. * - * @return int Entry. + * @return float Entry. */ - public function get($id) + public function get(string $id): float { if (!$this->has($id)) { return 0; @@ -347,7 +369,7 @@ class Profiler implements ContainerInterface } } - public function set($timestamp, $id) + public function set($timestamp, string $id) { $this->performance[$id] = $timestamp; } @@ -363,7 +385,7 @@ class Profiler implements ContainerInterface * * @return bool */ - public function has($id) + public function has(string $id): bool { return isset($this->performance[$id]); }