Caster.php 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\VarDumper\Caster;
  11. use Symfony\Component\VarDumper\Cloner\Stub;
  12. /**
  13. * Helper for filtering out properties in casters.
  14. *
  15. * @author Nicolas Grekas <p@tchwork.com>
  16. *
  17. * @final
  18. */
  19. class Caster
  20. {
  21. const EXCLUDE_VERBOSE = 1;
  22. const EXCLUDE_VIRTUAL = 2;
  23. const EXCLUDE_DYNAMIC = 4;
  24. const EXCLUDE_PUBLIC = 8;
  25. const EXCLUDE_PROTECTED = 16;
  26. const EXCLUDE_PRIVATE = 32;
  27. const EXCLUDE_NULL = 64;
  28. const EXCLUDE_EMPTY = 128;
  29. const EXCLUDE_NOT_IMPORTANT = 256;
  30. const EXCLUDE_STRICT = 512;
  31. const PREFIX_VIRTUAL = "\0~\0";
  32. const PREFIX_DYNAMIC = "\0+\0";
  33. const PREFIX_PROTECTED = "\0*\0";
  34. /**
  35. * Casts objects to arrays and adds the dynamic property prefix.
  36. *
  37. * @param object $obj The object to cast
  38. * @param bool $hasDebugInfo Whether the __debugInfo method exists on $obj or not
  39. *
  40. * @return array The array-cast of the object, with prefixed dynamic properties
  41. */
  42. public static function castObject($obj, string $class, bool $hasDebugInfo = false): array
  43. {
  44. if ($hasDebugInfo) {
  45. try {
  46. $debugInfo = $obj->__debugInfo();
  47. } catch (\Exception $e) {
  48. // ignore failing __debugInfo()
  49. $hasDebugInfo = false;
  50. }
  51. }
  52. $a = $obj instanceof \Closure ? [] : (array) $obj;
  53. if ($obj instanceof \__PHP_Incomplete_Class) {
  54. return $a;
  55. }
  56. if ($a) {
  57. static $publicProperties = [];
  58. $i = 0;
  59. $prefixedKeys = [];
  60. foreach ($a as $k => $v) {
  61. if (isset($k[0]) ? "\0" !== $k[0] : \PHP_VERSION_ID >= 70200) {
  62. if (!isset($publicProperties[$class])) {
  63. foreach ((new \ReflectionClass($class))->getProperties(\ReflectionProperty::IS_PUBLIC) as $prop) {
  64. $publicProperties[$class][$prop->name] = true;
  65. }
  66. }
  67. if (!isset($publicProperties[$class][$k])) {
  68. $prefixedKeys[$i] = self::PREFIX_DYNAMIC.$k;
  69. }
  70. } elseif (isset($k[16]) && "\0" === $k[16] && 0 === strpos($k, "\0class@anonymous\0")) {
  71. $prefixedKeys[$i] = "\0".get_parent_class($class).'@anonymous'.strrchr($k, "\0");
  72. }
  73. ++$i;
  74. }
  75. if ($prefixedKeys) {
  76. $keys = array_keys($a);
  77. foreach ($prefixedKeys as $i => $k) {
  78. $keys[$i] = $k;
  79. }
  80. $a = array_combine($keys, $a);
  81. }
  82. }
  83. if ($hasDebugInfo && \is_array($debugInfo)) {
  84. foreach ($debugInfo as $k => $v) {
  85. if (!isset($k[0]) || "\0" !== $k[0]) {
  86. $k = self::PREFIX_VIRTUAL.$k;
  87. }
  88. unset($a[$k]);
  89. $a[$k] = $v;
  90. }
  91. }
  92. return $a;
  93. }
  94. /**
  95. * Filters out the specified properties.
  96. *
  97. * By default, a single match in the $filter bit field filters properties out, following an "or" logic.
  98. * When EXCLUDE_STRICT is set, an "and" logic is applied: all bits must match for a property to be removed.
  99. *
  100. * @param array $a The array containing the properties to filter
  101. * @param int $filter A bit field of Caster::EXCLUDE_* constants specifying which properties to filter out
  102. * @param string[] $listedProperties List of properties to exclude when Caster::EXCLUDE_VERBOSE is set, and to preserve when Caster::EXCLUDE_NOT_IMPORTANT is set
  103. * @param int &$count Set to the number of removed properties
  104. *
  105. * @return array The filtered array
  106. */
  107. public static function filter(array $a, int $filter, array $listedProperties = [], ?int &$count = 0): array
  108. {
  109. $count = 0;
  110. foreach ($a as $k => $v) {
  111. $type = self::EXCLUDE_STRICT & $filter;
  112. if (null === $v) {
  113. $type |= self::EXCLUDE_NULL & $filter;
  114. $type |= self::EXCLUDE_EMPTY & $filter;
  115. } elseif (false === $v || '' === $v || '0' === $v || 0 === $v || 0.0 === $v || [] === $v) {
  116. $type |= self::EXCLUDE_EMPTY & $filter;
  117. }
  118. if ((self::EXCLUDE_NOT_IMPORTANT & $filter) && !\in_array($k, $listedProperties, true)) {
  119. $type |= self::EXCLUDE_NOT_IMPORTANT;
  120. }
  121. if ((self::EXCLUDE_VERBOSE & $filter) && \in_array($k, $listedProperties, true)) {
  122. $type |= self::EXCLUDE_VERBOSE;
  123. }
  124. if (!isset($k[1]) || "\0" !== $k[0]) {
  125. $type |= self::EXCLUDE_PUBLIC & $filter;
  126. } elseif ('~' === $k[1]) {
  127. $type |= self::EXCLUDE_VIRTUAL & $filter;
  128. } elseif ('+' === $k[1]) {
  129. $type |= self::EXCLUDE_DYNAMIC & $filter;
  130. } elseif ('*' === $k[1]) {
  131. $type |= self::EXCLUDE_PROTECTED & $filter;
  132. } else {
  133. $type |= self::EXCLUDE_PRIVATE & $filter;
  134. }
  135. if ((self::EXCLUDE_STRICT & $filter) ? $type === $filter : $type) {
  136. unset($a[$k]);
  137. ++$count;
  138. }
  139. }
  140. return $a;
  141. }
  142. public static function castPhpIncompleteClass(\__PHP_Incomplete_Class $c, array $a, Stub $stub, bool $isNested): array
  143. {
  144. if (isset($a['__PHP_Incomplete_Class_Name'])) {
  145. $stub->class .= '('.$a['__PHP_Incomplete_Class_Name'].')';
  146. unset($a['__PHP_Incomplete_Class_Name']);
  147. }
  148. return $a;
  149. }
  150. }