DataCollector.php 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  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. protected array|Data $data = [];
  28. private ClonerInterface $cloner;
  29. /**
  30. * Converts the variable into a serializable Data instance.
  31. *
  32. * This array can be displayed in the template using
  33. * the VarDumper component.
  34. */
  35. protected function cloneVar(mixed $var): Data
  36. {
  37. if ($var instanceof Data) {
  38. return $var;
  39. }
  40. if (!isset($this->cloner)) {
  41. $this->cloner = new VarCloner();
  42. $this->cloner->setMaxItems(-1);
  43. $this->cloner->addCasters($this->getCasters());
  44. }
  45. return $this->cloner->cloneVar($var);
  46. }
  47. /**
  48. * @return callable[] The casters to add to the cloner
  49. */
  50. protected function getCasters(): array
  51. {
  52. return [
  53. '*' => function ($v, array $a, Stub $s, $isNested) {
  54. if (!$v instanceof Stub) {
  55. $b = $a;
  56. foreach ($a as $k => $v) {
  57. if (!\is_object($v) || $v instanceof \DateTimeInterface || $v instanceof Stub) {
  58. continue;
  59. }
  60. try {
  61. $a[$k] = $s = new CutStub($v);
  62. if ($b[$k] === $s) {
  63. // we've hit a non-typed reference
  64. $a[$k] = $v;
  65. }
  66. } catch (\TypeError $e) {
  67. // we've hit a typed reference
  68. }
  69. }
  70. }
  71. return $a;
  72. },
  73. ] + ReflectionCaster::UNSET_CLOSURE_FILE_INFO;
  74. }
  75. public function __sleep(): array
  76. {
  77. return ['data'];
  78. }
  79. public function __wakeup(): void
  80. {
  81. }
  82. /**
  83. * @internal to prevent implementing \Serializable
  84. */
  85. final protected function serialize(): void
  86. {
  87. }
  88. /**
  89. * @internal to prevent implementing \Serializable
  90. */
  91. final protected function unserialize(string $data): void
  92. {
  93. }
  94. /**
  95. * @return void
  96. */
  97. public function reset()
  98. {
  99. $this->data = [];
  100. }
  101. }