CodeIgniter4/tests/_support/Log/Handlers/TestHandler.php at 15fc6753b29b23aed8e8d8b5fd2d509c507507be · michalsn/CodeIgniter4 · GitHub

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
<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <[email protected]>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace Tests\Support\Log\Handlers;

use CodeIgniter\I18n\Time;
use CodeIgniter\Log\Handlers\FileHandler;

/**
 * Class TestHandler
 *
 * A simple LogHandler that stores the logs in memory.
 * Only used for testing purposes.
 */
class TestHandler extends FileHandler
{
    /**
     * Local storage for logs.
     *
     * @var array
     */
    protected static $logs = [];

    /**
     * Local storage for log contexts.
     *
     * @var array<int, array<string, mixed>>
     */
    protected static array $contexts = [];

    protected string $destination;

    /**
     * Where would the log be written?
     *
     * @param array<string, mixed> $config
     */
    public function __construct(array $config)
    {
        parent::__construct($config);

        $this->handles     = $config['handles'] ?? [];
        $this->destination = $this->path . 'log-' . Time::now()->format('Y-m-d') . '.' . $this->fileExtension;

        self::$logs     = [];
        self::$contexts = [];
    }

    /**
     * Handles logging the message.
     * If the handler returns false, then execution of handlers
     * will stop. Any handlers that have not run, yet, will not
     * be run.
     *
     * @param string               $level
     * @param string               $message
     * @param array<string, mixed> $context
     */
    public function handle($level, $message, array $context = []): bool
    {
        $date = Time::now()->format($this->dateFormat);

        self::$logs[]     = strtoupper($level) . ' - ' . $date . ' --> ' . $message;
        self::$contexts[] = $context;

        return true;
    }

    public static function getLogs()
    {
        return self::$logs;
    }

    /**
     * @return array<int, array<string, mixed>>
     */
    public static function getContexts(): array
    {
        return self::$contexts;
    }
}