annotate vendor/symfony/var-dumper/Cloner/AbstractCloner.php @ 19:fa3358dc1485 tip

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