Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
CRAP
100.00% covered (success)
100.00%
1 / 1
VarDumperTrait
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
2
100.00% covered (success)
100.00%
1 / 1
 varDump
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
2
1<?php
2
3/**
4 * Helper for dumping variables into string.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Moravian Library 2024.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  Error_Logging
25 * @author   Josef Moravec <josef.moravec@mzk.cz>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org Main Site
28 */
29
30namespace VuFind\Log;
31
32use Symfony\Component\VarDumper\Cloner\VarCloner;
33use Symfony\Component\VarDumper\Dumper\CliDumper;
34
35/**
36 * Helper for dumping variables into string.
37 *
38 * @category VuFind
39 * @package  Error_Logging
40 * @author   Josef Moravec <josef.moravec@mzk.cz>
41 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
42 * @link     https://vufind.org Main Site
43 */
44trait VarDumperTrait
45{
46    /**
47     * Dump variable into string
48     *
49     * @param mixed $var Variable to export
50     *
51     * @return string
52     */
53    protected function varDump(mixed $var): string
54    {
55        $cloner = new VarCloner();
56        $dumper = new CliDumper();
57        $output = '';
58        $callback = function (string $line, int $depth) use (&$output): void {
59            // A negative depth means "end of dump"
60            if ($depth >= 0) {
61                // Adds a two spaces indentation to the line
62                $output .= str_repeat('  ', $depth) . $line . "\n";
63            }
64        };
65        $dumper->dump($cloner->cloneVar($var), $callback);
66        return $output;
67    }
68}