Yiisoft\Profiler\FileTarget

Complexity

Total Complexity

10

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setFilename()	0	3	1
A	__construct()	0	3	1
A	resolveFilename()	0	18	4
A	export()	0	23	3
A	formatMessage()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Profiler;

use Yiisoft\Aliases\Aliases;
use Yiisoft\Files\FileHelper;

/**
 * FileTarget records profiling messages in a file specified via {@see filename}.
 *
 * Application configuration example:
 *
 * ```php
 * return [
 *     'profiler' => [
 *         'targets' => [
 *             [
 *                 '__class' => Yiisoft\Profile\FileTarget::class,
 *                 //'filename' => '@runtime/profiling/{date}-{time}.txt',
 *             ],
 *         ],
 *         // ...
 *     ],
 *     // ...
 * ];
 * ```
 */
final class FileTarget extends Target
{
    /**
     * @var string file path or [path alias](guide:concept-aliases). File name may contain the placeholders,
     * which will be replaced by computed values. The supported placeholders are:
     *
     * - '{ts}' - profiling completion timestamp.
     * - '{date}' - profiling completion date in format 'ymd'.
     * - '{time}' - profiling completion time in format 'His'.
     *
     * The directory containing the file will be automatically created if not existing.
     * If target file is already exist it will be overridden.
     */
    private string $filename = '@runtime/profiling/{date}-{time}.txt';

    /**
     * @var int the permission to be set for newly created directories.
     * This value will be used by PHP chmod() function. No umask will be applied.
     * Defaults to 0775, meaning the directory is read-writable by owner and group,
     * but read-only for other users.
     */
    private int $dirMode = 0775;
    private Aliases $aliases;

    public function __construct(Aliases $aliases)
    {
        $this->aliases = $aliases;
    }

    public function export(array $messages): void
    {
        $memoryPeakUsage = memory_get_peak_usage();

        // TODO: make sure it works with RoadRunner and alike servers
        $totalTime = microtime(true) - $_SERVER['REQUEST_TIME_FLOAT'];
        $text = "Total processing time: {$totalTime} ms; Peak memory: {$memoryPeakUsage} B. \n\n";

        $text .= implode("\n", array_map([$this, 'formatMessage'], $messages));

        $filename = $this->resolveFilename();

        if (file_exists($filename)) {
            FileHelper::unlink($filename);
        } else {
            $filePath = dirname($filename);

            if (!is_dir($filePath)) {
                FileHelper::createDirectory($filePath, $this->dirMode);
            }
        }

        file_put_contents($filename, $text);
    }

    /**
     * Set profiles filename
     *
     * @param string $value
     */
    public function setFilename(string $value): void
    {
        $this->filename = $value;
    }

    /**
     * Resolves value of {@see filename} processing path alias and placeholders.
     *
     * @return string actual target filename.
     */
    protected function resolveFilename(): string
    {
        $filename = $this->aliases->get($this->filename);

        return preg_replace_callback(
            '/{\\w+}/',
            static function ($matches) {
                switch ($matches[0]) {
                    case '{ts}':
                        return time();
                    case '{date}':
                        return gmdate('ymd');
                    case '{time}':
                        return gmdate('His');
                }
                return $matches[0];
            },
            $filename
        );
    }

    /**
     * Formats a profiling message for display as a string.
     *
     * @param Message $message the profiling message to be formatted.
     * The message structure follows that in {@see Profiler::$messages}.
     *
     * @return string the formatted message.
     */
    private function formatMessage(Message $message): string
    {
        return date('Y-m-d H:i:s', (int)$message->context('beginTime'))
            . " [{$message->context('duration')} ms][{$message->context('memoryDiff')} B][{$message->level()}] {$message->message()}"
            . __METHOD__;
    }
}