debug_kit/src/DebugStatements.php at fd19da0c30b5e44bacddfb0481831dd084df9eab · cakephp/debug_kit · 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
<?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 5.1
 * @license       https://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace DebugKit;

use Cake\Core\Configure;

/**
 * Contains methods for dumping well formatted SQL queries.
 */
class DebugStatements
{
    /**
     * @var array<string>
     */
    protected static $statements = [];

    /**
     * @return array<string>
     */
    public static function all(): array
    {
        return static::$statements;
    }

    /**
     * Template used for HTML output.
     *
     * @var string
     */
    private static string $templateHtml = <<<HTML
<div class="cake-debug-output">
%s
<pre class="cake-debug">
%s
</pre>
</div>
HTML;

    /**
     * Template used for CLI and text output.
     *
     * @var string
     */
    private static string $templateText = <<<TEXT
%s
########## DEBUG ##########
%s
###########################

TEXT;

    /**
     * Prints out the SQL statements generated by a Query object.
     *
     * This function returns the same variable that was passed.
     * Only runs if debug mode is enabled.
     *
     * @param mixed $var
     * @param bool|null $showHtml
     * @param array $location
     * @return string Empty string.
     */
    public static function add(mixed $var, ?bool $showHtml = null, array $location = []): string
    {
        if (!Configure::read('debug')) {
            return '';
        }

        static::$statements[] = [
            'var' => $var,
            'showHtml' => $showHtml,
            'location' => $location,
        ];

        return '';
    }
}