vendor/symfony/http-kernel/DataCollector/DataCollector.php line 74

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpKernel\DataCollector;
  14. use Symfony\Component\VarDumper\Caster\CutStub;
  15. use Symfony\Component\VarDumper\Cloner\ClonerInterface;
  16. use Symfony\Component\VarDumper\Cloner\Data;
  17. use Symfony\Component\VarDumper\Cloner\Stub;
  18. use Symfony\Component\VarDumper\Cloner\VarCloner;
  20. /**
  21.  * DataCollector.
  22.  *
  23.  * Children of this class must store the collected data in the data property.
  24.  *
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  * @author Bernhard Schussek <bschussek@symfony.com>
  27.  */
  28. abstract class DataCollector implements DataCollectorInterface, \Serializable
  29. {
  30.     protected $data = [];
  32.     /**
  33.      * @var ClonerInterface
  34.      */
  35.     private $cloner;
  37.     public function serialize()
  38.     {
  39.         $trace = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, 2);
  40.         $isCalledFromOverridingMethod = isset($trace[1]['function'], $trace[1]['object']) && 'serialize' === $trace[1]['function'] && $this === $trace[1]['object'];
  42.         return $isCalledFromOverridingMethod ? $this->data : serialize($this->data);
  43.     }
  45.     public function unserialize($data)
  46.     {
  47.         $this->data = \is_array($data) ? $data : unserialize($data);
  48.     }
  50.     /**
  51.      * Converts the variable into a serializable Data instance.
  52.      *
  53.      * This array can be displayed in the template using
  54.      * the VarDumper component.
  55.      *
  56.      * @param mixed $var
  57.      *
  58.      * @return Data
  59.      */
  60.     protected function cloneVar($var)
  61.     {
  62.         if ($var instanceof Data) {
  63.             return $var;
  64.         }
  65.         if (null === $this->cloner) {
  66.             if (!class_exists(CutStub::class)) {
  67.                 throw new \LogicException(sprintf('The VarDumper component is needed for the %s() method. Install symfony/var-dumper version 3.4 or above.', __METHOD__));
  68.             }
  69.             $this->cloner = new VarCloner();
  70.             $this->cloner->setMaxItems(-1);
  71.             $this->cloner->addCasters($this->getCasters());
  72.         }
  74.         return $this->cloner->cloneVar($var);
  75.     }
  77.     /**
  78.      * @return callable[] The casters to add to the cloner
  79.      */
  80.     protected function getCasters()
  81.     {
  82.         return [
  83.             '*' => function ($v, array $a, Stub $s, $isNested) {
  84.                 if (!$v instanceof Stub) {
  85.                     foreach ($a as $k => $v) {
  86.                         if (\is_object($v) && !$v instanceof \DateTimeInterface && !$v instanceof Stub) {
  87.                             $a[$k] = new CutStub($v);
  88.                         }
  89.                     }
  90.                 }
  92.                 return $a;
  93.             },
  94.         ];
  95.     }
  96. }