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\Caster\ReflectionCaster;
  16. use Symfony\Component\VarDumper\Cloner\ClonerInterface;
  17. use Symfony\Component\VarDumper\Cloner\Data;
  18. use Symfony\Component\VarDumper\Cloner\Stub;
  19. use Symfony\Component\VarDumper\Cloner\VarCloner;
  21. /**
  22.  * DataCollector.
  23.  *
  24.  * Children of this class must store the collected data in the data property.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  * @author Bernhard Schussek <bschussek@symfony.com>
  28.  */
  29. abstract class DataCollector implements DataCollectorInterface
  30. {
  31.     /**
  32.      * @var array|Data
  33.      */
  34.     protected $data = [];
  36.     /**
  37.      * @var ClonerInterface
  38.      */
  39.     private $cloner;
  41.     /**
  42.      * @deprecated since Symfony 4.3, store all the serialized state in the data property instead
  43.      */
  44.     public function serialize()
  45.     {
  46.         @trigger_error(sprintf('The "%s" method is deprecated since Symfony 4.3, store all the serialized state in the data property instead.', __METHOD__), \E_USER_DEPRECATED);
  48.         $trace = debug_backtrace(\DEBUG_BACKTRACE_PROVIDE_OBJECT, 2);
  49.         $isCalledFromOverridingMethod = isset($trace[1]['function'], $trace[1]['object']) && 'serialize' === $trace[1]['function'] && $this === $trace[1]['object'];
  51.         return $isCalledFromOverridingMethod ? $this->data : serialize($this->data);
  52.     }
  54.     /**
  55.      * @deprecated since Symfony 4.3, store all the serialized state in the data property instead
  56.      */
  57.     public function unserialize($data)
  58.     {
  59.         @trigger_error(sprintf('The "%s" method is deprecated since Symfony 4.3, store all the serialized state in the data property instead.', __METHOD__), \E_USER_DEPRECATED);
  61.         $this->data = \is_array($data) ? $data : unserialize($data);
  62.     }
  64.     /**
  65.      * Converts the variable into a serializable Data instance.
  66.      *
  67.      * This array can be displayed in the template using
  68.      * the VarDumper component.
  69.      *
  70.      * @param mixed $var
  71.      *
  72.      * @return Data
  73.      */
  74.     protected function cloneVar($var)
  75.     {
  76.         if ($var instanceof Data) {
  77.             return $var;
  78.         }
  79.         if (null === $this->cloner) {
  80.             $this->cloner = new VarCloner();
  81.             $this->cloner->setMaxItems(-1);
  82.             $this->cloner->addCasters($this->getCasters());
  83.         }
  85.         return $this->cloner->cloneVar($var);
  86.     }
  88.     /**
  89.      * @return callable[] The casters to add to the cloner
  90.      */
  91.     protected function getCasters()
  92.     {
  93.         $casters = [
  94.             '*' => function ($v, array $a, Stub $s, $isNested) {
  95.                 if (!$v instanceof Stub) {
  96.                     foreach ($a as $k => $v) {
  97.                         if (\is_object($v) && !$v instanceof \DateTimeInterface && !$v instanceof Stub) {
  98.                             $a[$k] = new CutStub($v);
  99.                         }
  100.                     }
  101.                 }
  103.                 return $a;
  104.             },
  105.         ] + ReflectionCaster::UNSET_CLOSURE_FILE_INFO;
  107.         return $casters;
  108.     }
  110.     /**
  111.      * @return array
  112.      */
  113.     public function __sleep()
  114.     {
  115.         if (__CLASS__ !== $c = (new \ReflectionMethod($this, 'serialize'))->getDeclaringClass()->name) {
  116.             @trigger_error(sprintf('Implementing the "%s::serialize()" method is deprecated since Symfony 4.3, store all the serialized state in the "data" property instead.', $c), \E_USER_DEPRECATED);
  117.             $this->data = $this->serialize();
  118.         }
  120.         return ['data'];
  121.     }
  123.     public function __wakeup()
  124.     {
  125.         if (__CLASS__ !== $c = (new \ReflectionMethod($this, 'unserialize'))->getDeclaringClass()->name) {
  126.             if (\is_object($this->data)) {
  127.                 throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
  128.             }
  130.             @trigger_error(sprintf('Implementing the "%s::unserialize()" method is deprecated since Symfony 4.3, store all the serialized state in the "data" property instead.', $c), \E_USER_DEPRECATED);
  131.             $this->unserialize($this->data);
  132.         }
  133.     }
  134. }