-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
DebugContext.php
110 lines (98 loc) · 2.53 KB
/
DebugContext.php
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<?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
* For full copyright and license information, please see the LICENSE.txt
* 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 4.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Error\Debug;
use SplObjectStorage;
/**
* Context tracking for Debugger::exportVar()
*
* This class is used by Debugger to track element depth, and
* prevent cyclic references from being traversed multiple times.
*
* @internal
*/
class DebugContext
{
/**
* @var int
*/
private int $maxDepth = 0;
/**
* @var int
*/
private int $depth = 0;
/**
* @var \SplObjectStorage<object, int>
*/
private SplObjectStorage $refs;
/**
* Constructor
*
* @param int $maxDepth The desired depth of dump output.
*/
public function __construct(int $maxDepth)
{
$this->maxDepth = $maxDepth;
$this->refs = new SplObjectStorage();
}
/**
* Return a clone with increased depth.
*
* @return static
*/
public function withAddedDepth(): static
{
$new = clone $this;
$new->depth += 1;
return $new;
}
/**
* Get the remaining depth levels
*
* @return int
*/
public function remainingDepth(): int
{
return $this->maxDepth - $this->depth;
}
/**
* Get the reference ID for an object.
*
* If this object does not exist in the reference storage,
* it will be added and the id will be returned.
*
* @param object $object The object to get a reference for.
* @return int
*/
public function getReferenceId(object $object): int
{
if ($this->refs->contains($object)) {
return $this->refs[$object];
}
$refId = $this->refs->count();
$this->refs->attach($object, $refId);
return $refId;
}
/**
* Check whether an object has been seen before.
*
* @param object $object The object to get a reference for.
* @return bool
*/
public function hasReference(object $object): bool
{
return $this->refs->contains($object);
}
}