vendor/symfony/var-dumper/Cloner/AbstractCloner.php line 272

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