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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace Wikimedia\Reflection;
/**
* Trait for accessing "ghost fields".
*
* Ghost fields are fields that have been created in an object instance
* by PHP's unserialize() mechanism, though they no longer exist
* in the current version of the corresponding class.
*
* Accessing non-public ghost fields offers some challenges due to
* how they are handled by PHP internally.
*
* @see https://www.php.net/manual/en/language.types.array.php#language.types.array.casting
* @since 1.36
*/
trait GhostFieldAccessTrait {
/**
* Get the value of the ghost field named $name,
* or null if the field does not exist.
*
* @param string $name
* @param class-string ...$aliases
* @return mixed|null
*/
private function getGhostFieldValue( string $name, string ...$aliases ) {
if ( isset( $this->$name ) ) {
return $this->$name;
}
$data = (array)$this;
// Protected variables have a '*' prepended to the variable name.
// These prepended values have null bytes on either side.
$protectedName = "\x00*\x00{$name}";
if ( isset( $data[$protectedName] ) ) {
return $data[$protectedName];
}
// Private variables have the class name prepended to the variable name.
// These prepended values have null bytes on either side.
$thisClass = get_class( $this );
$privateName = "\x00{$thisClass}\x00{$name}";
if ( isset( $data[$privateName] ) ) {
return $data[$privateName];
}
// Check old aliased class names as well.
foreach ( $aliases as $thisClass ) {
$privateName = "\x00{$thisClass}\x00{$name}";
if ( isset( $data[$privateName] ) ) {
return $data[$privateName];
}
}
return null;
}
/**
* In PHP <= 8.1, private fields of a class are not properly restored
* when the class is aliased to a new name, since the private fields are
* prefixed with the *old* name of the class. This method can be used
* to restore them if present after deserialization.
*
* @param string $name
* @param class-string ...$aliases
*/
private function restoreAliasedGhostField( string $name, string ...$aliases ): void {
$data = (array)$this;
foreach ( $aliases as $thisClass ) {
$privateName = "\x00{$thisClass}\x00{$name}";
if ( isset( $data[$privateName] ) ) {
$this->$name = $data[$privateName];
unset( $data[$privateName] );
return;
}
}
}
}
|
