Caster.php 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  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 string $class The class of the object
  39. * @param bool $hasDebugInfo Whether the __debugInfo method exists on $obj or not
  40. *
  41. * @return array The array-cast of the object, with prefixed dynamic properties
  42. */
  43. public static function castObject($obj, $class, $hasDebugInfo = false)
  44. {
  45. $a = $obj instanceof \Closure ? [] : (array) $obj;
  46. if ($obj instanceof \__PHP_Incomplete_Class) {
  47. return $a;
  48. }
  49. if ($a) {
  50. static $publicProperties = [];
  51. $i = 0;
  52. $prefixedKeys = [];
  53. foreach ($a as $k => $v) {
  54. if (isset($k[0]) ? "\0" !== $k[0] : \PHP_VERSION_ID >= 70200) {
  55. if (!isset($publicProperties[$class])) {
  56. foreach ((new \ReflectionClass($class))->getProperties(\ReflectionProperty::IS_PUBLIC) as $prop) {
  57. $publicProperties[$class][$prop->name] = true;
  58. }
  59. }
  60. if (!isset($publicProperties[$class][$k])) {
  61. $prefixedKeys[$i] = self::PREFIX_DYNAMIC.$k;
  62. }
  63. } elseif (isset($k[16]) && "\0" === $k[16] && 0 === strpos($k, "\0class@anonymous\0")) {
  64. $prefixedKeys[$i] = "\0".get_parent_class($class).'@anonymous'.strrchr($k, "\0");
  65. }
  66. ++$i;
  67. }
  68. if ($prefixedKeys) {
  69. $keys = array_keys($a);
  70. foreach ($prefixedKeys as $i => $k) {
  71. $keys[$i] = $k;
  72. }
  73. $a = array_combine($keys, $a);
  74. }
  75. }
  76. if ($hasDebugInfo && \is_array($debugInfo = $obj->__debugInfo())) {
  77. foreach ($debugInfo as $k => $v) {
  78. if (!isset($k[0]) || "\0" !== $k[0]) {
  79. $k = self::PREFIX_VIRTUAL.$k;
  80. }
  81. unset($a[$k]);
  82. $a[$k] = $v;
  83. }
  84. }
  85. return $a;
  86. }
  87. /**
  88. * Filters out the specified properties.
  89. *
  90. * By default, a single match in the $filter bit field filters properties out, following an "or" logic.
  91. * When EXCLUDE_STRICT is set, an "and" logic is applied: all bits must match for a property to be removed.
  92. *
  93. * @param array $a The array containing the properties to filter
  94. * @param int $filter A bit field of Caster::EXCLUDE_* constants specifying which properties to filter out
  95. * @param string[] $listedProperties List of properties to exclude when Caster::EXCLUDE_VERBOSE is set, and to preserve when Caster::EXCLUDE_NOT_IMPORTANT is set
  96. * @param int &$count Set to the number of removed properties
  97. *
  98. * @return array The filtered array
  99. */
  100. public static function filter(array $a, $filter, array $listedProperties = [], &$count = 0)
  101. {
  102. $count = 0;
  103. foreach ($a as $k => $v) {
  104. $type = self::EXCLUDE_STRICT & $filter;
  105. if (null === $v) {
  106. $type |= self::EXCLUDE_NULL & $filter;
  107. $type |= self::EXCLUDE_EMPTY & $filter;
  108. } elseif (false === $v || '' === $v || '0' === $v || 0 === $v || 0.0 === $v || [] === $v) {
  109. $type |= self::EXCLUDE_EMPTY & $filter;
  110. }
  111. if ((self::EXCLUDE_NOT_IMPORTANT & $filter) && !\in_array($k, $listedProperties, true)) {
  112. $type |= self::EXCLUDE_NOT_IMPORTANT;
  113. }
  114. if ((self::EXCLUDE_VERBOSE & $filter) && \in_array($k, $listedProperties, true)) {
  115. $type |= self::EXCLUDE_VERBOSE;
  116. }
  117. if (!isset($k[1]) || "\0" !== $k[0]) {
  118. $type |= self::EXCLUDE_PUBLIC & $filter;
  119. } elseif ('~' === $k[1]) {
  120. $type |= self::EXCLUDE_VIRTUAL & $filter;
  121. } elseif ('+' === $k[1]) {
  122. $type |= self::EXCLUDE_DYNAMIC & $filter;
  123. } elseif ('*' === $k[1]) {
  124. $type |= self::EXCLUDE_PROTECTED & $filter;
  125. } else {
  126. $type |= self::EXCLUDE_PRIVATE & $filter;
  127. }
  128. if ((self::EXCLUDE_STRICT & $filter) ? $type === $filter : $type) {
  129. unset($a[$k]);
  130. ++$count;
  131. }
  132. }
  133. return $a;
  134. }
  135. public static function castPhpIncompleteClass(\__PHP_Incomplete_Class $c, array $a, Stub $stub, $isNested)
  136. {
  137. if (isset($a['__PHP_Incomplete_Class_Name'])) {
  138. $stub->class .= '('.$a['__PHP_Incomplete_Class_Name'].')';
  139. unset($a['__PHP_Incomplete_Class_Name']);
  140. }
  141. return $a;
  142. }
  143. }