vendor/symfony/symfony/src/Symfony/Component/VarDumper/Cloner/AbstractCloner.php line 304

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\VarDumper\Cloner;
  14. use Symfony\Component\VarDumper\Caster\Caster;
  15. use Symfony\Component\VarDumper\Exception\ThrowingCasterException;
  17. /**
  18.  * AbstractCloner implements a generic caster mechanism for objects and resources.
  19.  *
  20.  * @author Nicolas Grekas <p@tchwork.com>
  21.  */
  22. abstract class AbstractCloner implements ClonerInterface
  23. {
  24.     public static $defaultCasters = [
  25.         '__PHP_Incomplete_Class' => ['Symfony\Component\VarDumper\Caster\Caster', 'castPhpIncompleteClass'],
  27.         'Symfony\Component\VarDumper\Caster\CutStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castStub'],
  28.         'Symfony\Component\VarDumper\Caster\CutArrayStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castCutArray'],
  29.         'Symfony\Component\VarDumper\Caster\ConstStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castStub'],
  30.         'Symfony\Component\VarDumper\Caster\EnumStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castEnum'],
  32.         'Closure' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castClosure'],
  33.         'Generator' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castGenerator'],
  34.         'ReflectionType' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castType'],
  35.         'ReflectionGenerator' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castReflectionGenerator'],
  36.         'ReflectionClass' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castClass'],
  37.         'ReflectionFunctionAbstract' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castFunctionAbstract'],
  38.         'ReflectionMethod' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castMethod'],
  39.         'ReflectionParameter' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castParameter'],
  40.         'ReflectionProperty' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castProperty'],
  41.         'ReflectionExtension' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castExtension'],
  42.         'ReflectionZendExtension' => ['Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castZendExtension'],
  44.         'Doctrine\Common\Persistence\ObjectManager' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
  45.         'Doctrine\Common\Proxy\Proxy' => ['Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castCommonProxy'],
  46.         'Doctrine\ORM\Proxy\Proxy' => ['Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castOrmProxy'],
  47.         'Doctrine\ORM\PersistentCollection' => ['Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castPersistentCollection'],
  48.         'Doctrine\Persistence\ObjectManager' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
  50.         'DOMException' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castException'],
  51.         'DOMStringList' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'],
  52.         'DOMNameList' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'],
  53.         'DOMImplementation' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castImplementation'],
  54.         'DOMImplementationList' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'],
  55.         'DOMNode' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castNode'],
  56.         'DOMNameSpaceNode' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castNameSpaceNode'],
  57.         'DOMDocument' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castDocument'],
  58.         'DOMNodeList' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'],
  59.         'DOMNamedNodeMap' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'],
  60.         'DOMCharacterData' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castCharacterData'],
  61.         'DOMAttr' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castAttr'],
  62.         'DOMElement' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castElement'],
  63.         'DOMText' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castText'],
  64.         'DOMTypeinfo' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castTypeinfo'],
  65.         'DOMDomError' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castDomError'],
  66.         'DOMLocator' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castLocator'],
  67.         'DOMDocumentType' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castDocumentType'],
  68.         'DOMNotation' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castNotation'],
  69.         'DOMEntity' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castEntity'],
  70.         'DOMProcessingInstruction' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castProcessingInstruction'],
  71.         'DOMXPath' => ['Symfony\Component\VarDumper\Caster\DOMCaster', 'castXPath'],
  73.         'XmlReader' => ['Symfony\Component\VarDumper\Caster\XmlReaderCaster', 'castXmlReader'],
  75.         'ErrorException' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castErrorException'],
  76.         'Exception' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castException'],
  77.         'Error' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castError'],
  78.         'Symfony\Component\DependencyInjection\ContainerInterface' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
  79.         'Symfony\Component\HttpFoundation\Request' => ['Symfony\Component\VarDumper\Caster\SymfonyCaster', 'castRequest'],
  80.         'Symfony\Component\VarDumper\Exception\ThrowingCasterException' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castThrowingCasterException'],
  81.         'Symfony\Component\VarDumper\Caster\TraceStub' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castTraceStub'],
  82.         'Symfony\Component\VarDumper\Caster\FrameStub' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castFrameStub'],
  83.         'Symfony\Component\Debug\Exception\SilencedErrorContext' => ['Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castSilencedErrorContext'],
  85.         'PHPUnit_Framework_MockObject_MockObject' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
  86.         'PHPUnit\Framework\MockObject\MockObject' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
  87.         'PHPUnit\Framework\MockObject\Stub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
  88.         'Prophecy\Prophecy\ProphecySubjectInterface' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
  89.         'Mockery\MockInterface' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
  91.         'PDO' => ['Symfony\Component\VarDumper\Caster\PdoCaster', 'castPdo'],
  92.         'PDOStatement' => ['Symfony\Component\VarDumper\Caster\PdoCaster', 'castPdoStatement'],
  94.         'AMQPConnection' => ['Symfony\Component\VarDumper\Caster\AmqpCaster', 'castConnection'],
  95.         'AMQPChannel' => ['Symfony\Component\VarDumper\Caster\AmqpCaster', 'castChannel'],
  96.         'AMQPQueue' => ['Symfony\Component\VarDumper\Caster\AmqpCaster', 'castQueue'],
  97.         'AMQPExchange' => ['Symfony\Component\VarDumper\Caster\AmqpCaster', 'castExchange'],
  98.         'AMQPEnvelope' => ['Symfony\Component\VarDumper\Caster\AmqpCaster', 'castEnvelope'],
  100.         'ArrayObject' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castArrayObject'],
  101.         'ArrayIterator' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castArrayIterator'],
  102.         'SplDoublyLinkedList' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castDoublyLinkedList'],
  103.         'SplFileInfo' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castFileInfo'],
  104.         'SplFileObject' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castFileObject'],
  105.         'SplHeap' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castHeap'],
  106.         'SplObjectStorage' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castObjectStorage'],
  107.         'SplPriorityQueue' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castHeap'],
  108.         'OuterIterator' => ['Symfony\Component\VarDumper\Caster\SplCaster', 'castOuterIterator'],
  110.         'MongoCursorInterface' => ['Symfony\Component\VarDumper\Caster\MongoCaster', 'castCursor'],
  112.         'Redis' => ['Symfony\Component\VarDumper\Caster\RedisCaster', 'castRedis'],
  113.         'RedisArray' => ['Symfony\Component\VarDumper\Caster\RedisCaster', 'castRedisArray'],
  115.         'DateTimeInterface' => ['Symfony\Component\VarDumper\Caster\DateCaster', 'castDateTime'],
  116.         'DateInterval' => ['Symfony\Component\VarDumper\Caster\DateCaster', 'castInterval'],
  117.         'DateTimeZone' => ['Symfony\Component\VarDumper\Caster\DateCaster', 'castTimeZone'],
  118.         'DatePeriod' => ['Symfony\Component\VarDumper\Caster\DateCaster', 'castPeriod'],
  120.         'CurlHandle' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castCurl'],
  121.         ':curl' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castCurl'],
  123.         ':dba' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castDba'],
  124.         ':dba persistent' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castDba'],
  125.         ':gd' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castGd'],
  126.         ':mysql link' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castMysqlLink'],
  127.         ':pgsql large object' => ['Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLargeObject'],
  128.         ':pgsql link' => ['Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLink'],
  129.         ':pgsql link persistent' => ['Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLink'],
  130.         ':pgsql result' => ['Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castResult'],
  131.         ':process' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castProcess'],
  132.         ':stream' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStream'],
  133.         ':persistent stream' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStream'],
  134.         ':stream-context' => ['Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStreamContext'],
  135.         ':xml' => ['Symfony\Component\VarDumper\Caster\XmlResourceCaster', 'castXml'],
  136.     ];
  138.     protected $maxItems = 2500;
  139.     protected $maxString = -1;
  140.     protected $minDepth = 1;
  141.     protected $useExt;
  143.     private $casters = [];
  144.     private $prevErrorHandler;
  145.     private $classInfo = [];
  146.     private $filter = 0;
  148.     /**
  149.      * @param callable[]|null $casters A map of casters
  150.      *
  151.      * @see addCasters
  152.      */
  153.     public function __construct(array $casters = null)
  154.     {
  155.         if (null === $casters) {
  156.             $casters = static::$defaultCasters;
  157.         }
  158.         $this->addCasters($casters);
  159.         $this->useExt = \extension_loaded('symfony_debug');
  160.     }
  162.     /**
  163.      * Adds casters for resources and objects.
  164.      *
  165.      * Maps resources or objects types to a callback.
  166.      * Types are in the key, with a callable caster for value.
  167.      * Resource types are to be prefixed with a `:`,
  168.      * see e.g. static::$defaultCasters.
  169.      *
  170.      * @param callable[] $casters A map of casters
  171.      */
  172.     public function addCasters(array $casters)
  173.     {
  174.         foreach ($casters as $type => $callback) {
  175.             $this->casters[strtolower($type)][] = \is_string($callback) && false !== strpos($callback, '::') ? explode('::', $callback, 2) : $callback;
  176.         }
  177.     }
  179.     /**
  180.      * Sets the maximum number of items to clone past the minimum depth in nested structures.
  181.      *
  182.      * @param int $maxItems
  183.      */
  184.     public function setMaxItems($maxItems)
  185.     {
  186.         $this->maxItems = (int) $maxItems;
  187.     }
  189.     /**
  190.      * Sets the maximum cloned length for strings.
  191.      *
  192.      * @param int $maxString
  193.      */
  194.     public function setMaxString($maxString)
  195.     {
  196.         $this->maxString = (int) $maxString;
  197.     }
  199.     /**
  200.      * Sets the minimum tree depth where we are guaranteed to clone all the items.  After this
  201.      * depth is reached, only setMaxItems items will be cloned.
  202.      *
  203.      * @param int $minDepth
  204.      */
  205.     public function setMinDepth($minDepth)
  206.     {
  207.         $this->minDepth = (int) $minDepth;
  208.     }
  210.     /**
  211.      * Clones a PHP variable.
  212.      *
  213.      * @param mixed $var    Any PHP variable
  214.      * @param int   $filter A bit field of Caster::EXCLUDE_* constants
  215.      *
  216.      * @return Data The cloned variable represented by a Data object
  217.      */
  218.     public function cloneVar($var, $filter = 0)
  219.     {
  220.         $this->prevErrorHandler = set_error_handler(function ($type, $msg, $file, $line, $context = []) {
  221.             if (\E_RECOVERABLE_ERROR === $type || \E_USER_ERROR === $type) {
  222.                 // Cloner never dies
  223.                 throw new \ErrorException($msg, 0, $type, $file, $line);
  224.             }
  226.             if ($this->prevErrorHandler) {
  227.                 return \call_user_func($this->prevErrorHandler, $type, $msg, $file, $line, $context);
  228.             }
  230.             return false;
  231.         });
  232.         $this->filter = $filter;
  234.         if ($gc = gc_enabled()) {
  235.             gc_disable();
  236.         }
  237.         try {
  238.             return new Data($this->doClone($var));
  239.         } finally {
  240.             if ($gc) {
  241.                 gc_enable();
  242.             }
  243.             restore_error_handler();
  244.             $this->prevErrorHandler = null;
  245.         }
  246.     }
  248.     /**
  249.      * Effectively clones the PHP variable.
  250.      *
  251.      * @param mixed $var Any PHP variable
  252.      *
  253.      * @return array The cloned variable represented in an array
  254.      */
  255.     abstract protected function doClone($var);
  257.     /**
  258.      * Casts an object to an array representation.
  259.      *
  260.      * @param Stub $stub     The Stub for the casted object
  261.      * @param bool $isNested True if the object is nested in the dumped structure
  262.      *
  263.      * @return array The object casted as array
  264.      */
  265.     protected function castObject(Stub $stub, $isNested)
  266.     {
  267.         $obj = $stub->value;
  268.         $class = $stub->class;
  270.         if ((\PHP_VERSION_ID >= 80000 || (isset($class[15]) && "\0" === $class[15])) && false !== strpos($class, "@anonymous\0")) {
  271.             $stub->class = \PHP_VERSION_ID < 80000 ? (get_parent_class($class) ?: key(class_implements($class)) ?: 'class').'@anonymous' : get_debug_type($obj);
  272.         }
  273.         if (isset($this->classInfo[$class])) {
  274.             list($i, $parents, $hasDebugInfo) = $this->classInfo[$class];
  275.         } else {
  276.             $i = 2;
  277.             $parents = [strtolower($class)];
  278.             $hasDebugInfo = method_exists($class, '__debugInfo');
  280.             foreach (class_parents($class) as $p) {
  281.                 $parents[] = strtolower($p);
  282.                 ++$i;
  283.             }
  284.             foreach (class_implements($class) as $p) {
  285.                 $parents[] = strtolower($p);
  286.                 ++$i;
  287.             }
  288.             $parents[] = '*';
  290.             $this->classInfo[$class] = [$i, $parents, $hasDebugInfo];
  291.         }
  293.         $a = Caster::castObject($obj, $class, $hasDebugInfo, $stub->class);
  295.         try {
  296.             while ($i--) {
  297.                 if (!empty($this->casters[$p = $parents[$i]])) {
  298.                     foreach ($this->casters[$p] as $callback) {
  299.                         $a = $callback($obj, $a, $stub, $isNested, $this->filter);
  300.                     }
  301.                 }
  302.             }
  303.         } catch (\Exception $e) {
  304.             $a = [(Stub::TYPE_OBJECT === $stub->type ? Caster::PREFIX_VIRTUAL : '').'⚠' => new ThrowingCasterException($e)] + $a;
  305.         }
  307.         return $a;
  308.     }
  310.     /**
  311.      * Casts a resource to an array representation.
  312.      *
  313.      * @param Stub $stub     The Stub for the casted resource
  314.      * @param bool $isNested True if the object is nested in the dumped structure
  315.      *
  316.      * @return array The resource casted as array
  317.      */
  318.     protected function castResource(Stub $stub, $isNested)
  319.     {
  320.         $a = [];
  321.         $res = $stub->value;
  322.         $type = $stub->class;
  324.         try {
  325.             if (!empty($this->casters[':'.$type])) {
  326.                 foreach ($this->casters[':'.$type] as $callback) {
  327.                     $a = $callback($res, $a, $stub, $isNested, $this->filter);
  328.                 }
  329.             }
  330.         } catch (\Exception $e) {
  331.             $a = [(Stub::TYPE_OBJECT === $stub->type ? Caster::PREFIX_VIRTUAL : '').'⚠' => new ThrowingCasterException($e)] + $a;
  332.         }
  334.         return $a;
  335.     }
  336. }