DataCollector.php 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  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\HttpKernel\DataCollector;
  11. use Symfony\Component\VarDumper\Caster\CutStub;
  12. use Symfony\Component\VarDumper\Caster\ReflectionCaster;
  13. use Symfony\Component\VarDumper\Cloner\ClonerInterface;
  14. use Symfony\Component\VarDumper\Cloner\Data;
  15. use Symfony\Component\VarDumper\Cloner\Stub;
  16. use Symfony\Component\VarDumper\Cloner\VarCloner;
  17. /**
  18. * DataCollector.
  19. *
  20. * Children of this class must store the collected data in the data property.
  21. *
  22. * @author Fabien Potencier <fabien@symfony.com>
  23. * @author Bernhard Schussek <bschussek@symfony.com>
  24. */
  25. abstract class DataCollector implements DataCollectorInterface
  26. {
  27. /**
  28. * @var array|Data
  29. */
  30. protected $data = [];
  31. private ClonerInterface $cloner;
  32. /**
  33. * Converts the variable into a serializable Data instance.
  34. *
  35. * This array can be displayed in the template using
  36. * the VarDumper component.
  37. */
  38. protected function cloneVar(mixed $var): Data
  39. {
  40. if ($var instanceof Data) {
  41. return $var;
  42. }
  43. if (!isset($this->cloner)) {
  44. $this->cloner = new VarCloner();
  45. $this->cloner->setMaxItems(-1);
  46. $this->cloner->addCasters($this->getCasters());
  47. }
  48. return $this->cloner->cloneVar($var);
  49. }
  50. /**
  51. * @return callable[] The casters to add to the cloner
  52. */
  53. protected function getCasters()
  54. {
  55. $casters = [
  56. '*' => function ($v, array $a, Stub $s, $isNested) {
  57. if (!$v instanceof Stub) {
  58. $b = $a;
  59. foreach ($a as $k => $v) {
  60. if (!\is_object($v) || $v instanceof \DateTimeInterface || $v instanceof Stub) {
  61. continue;
  62. }
  63. try {
  64. $a[$k] = $s = new CutStub($v);
  65. if ($b[$k] === $s) {
  66. // we've hit a non-typed reference
  67. $a[$k] = $v;
  68. }
  69. } catch (\TypeError $e) {
  70. // we've hit a typed reference
  71. }
  72. }
  73. }
  74. return $a;
  75. },
  76. ] + ReflectionCaster::UNSET_CLOSURE_FILE_INFO;
  77. return $casters;
  78. }
  79. public function __sleep(): array
  80. {
  81. return ['data'];
  82. }
  83. /**
  84. * @return void
  85. */
  86. public function __wakeup()
  87. {
  88. }
  89. /**
  90. * @internal to prevent implementing \Serializable
  91. */
  92. final protected function serialize(): void
  93. {
  94. }
  95. /**
  96. * @internal to prevent implementing \Serializable
  97. */
  98. final protected function unserialize(string $data): void
  99. {
  100. }
  101. /**
  102. * @return void
  103. */
  104. public function reset()
  105. {
  106. $this->data = [];
  107. }
  108. }