123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\VarDumper\Cloner;
- use Symfony\Component\VarDumper\Caster\Caster;
- use Symfony\Component\VarDumper\Exception\ThrowingCasterException;
- /**
- * AbstractCloner implements a generic caster mechanism for objects and resources.
- *
- * @author Nicolas Grekas <p@tchwork.com>
- */
- abstract class AbstractCloner implements ClonerInterface
- {
- public static $defaultCasters = array(
- '__PHP_Incomplete_Class' => array('Symfony\Component\VarDumper\Caster\Caster', 'castPhpIncompleteClass'),
- 'Symfony\Component\VarDumper\Caster\CutStub' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'castStub'),
- 'Symfony\Component\VarDumper\Caster\CutArrayStub' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'castCutArray'),
- 'Symfony\Component\VarDumper\Caster\ConstStub' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'castStub'),
- 'Symfony\Component\VarDumper\Caster\EnumStub' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'castEnum'),
- 'Closure' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castClosure'),
- 'Generator' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castGenerator'),
- 'ReflectionType' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castType'),
- 'ReflectionGenerator' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castReflectionGenerator'),
- 'ReflectionClass' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castClass'),
- 'ReflectionFunctionAbstract' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castFunctionAbstract'),
- 'ReflectionMethod' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castMethod'),
- 'ReflectionParameter' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castParameter'),
- 'ReflectionProperty' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castProperty'),
- 'ReflectionExtension' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castExtension'),
- 'ReflectionZendExtension' => array('Symfony\Component\VarDumper\Caster\ReflectionCaster', 'castZendExtension'),
- 'Doctrine\Common\Persistence\ObjectManager' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'),
- 'Doctrine\Common\Proxy\Proxy' => array('Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castCommonProxy'),
- 'Doctrine\ORM\Proxy\Proxy' => array('Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castOrmProxy'),
- 'Doctrine\ORM\PersistentCollection' => array('Symfony\Component\VarDumper\Caster\DoctrineCaster', 'castPersistentCollection'),
- 'DOMException' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castException'),
- 'DOMStringList' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'),
- 'DOMNameList' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'),
- 'DOMImplementation' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castImplementation'),
- 'DOMImplementationList' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'),
- 'DOMNode' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castNode'),
- 'DOMNameSpaceNode' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castNameSpaceNode'),
- 'DOMDocument' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castDocument'),
- 'DOMNodeList' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'),
- 'DOMNamedNodeMap' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLength'),
- 'DOMCharacterData' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castCharacterData'),
- 'DOMAttr' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castAttr'),
- 'DOMElement' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castElement'),
- 'DOMText' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castText'),
- 'DOMTypeinfo' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castTypeinfo'),
- 'DOMDomError' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castDomError'),
- 'DOMLocator' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castLocator'),
- 'DOMDocumentType' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castDocumentType'),
- 'DOMNotation' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castNotation'),
- 'DOMEntity' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castEntity'),
- 'DOMProcessingInstruction' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castProcessingInstruction'),
- 'DOMXPath' => array('Symfony\Component\VarDumper\Caster\DOMCaster', 'castXPath'),
- 'XmlReader' => array('Symfony\Component\VarDumper\Caster\XmlReaderCaster', 'castXmlReader'),
- 'ErrorException' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castErrorException'),
- 'Exception' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castException'),
- 'Error' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castError'),
- 'Symfony\Component\DependencyInjection\ContainerInterface' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'),
- 'Symfony\Component\HttpFoundation\Request' => array('Symfony\Component\VarDumper\Caster\SymfonyCaster', 'castRequest'),
- 'Symfony\Component\VarDumper\Exception\ThrowingCasterException' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castThrowingCasterException'),
- 'Symfony\Component\VarDumper\Caster\TraceStub' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castTraceStub'),
- 'Symfony\Component\VarDumper\Caster\FrameStub' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castFrameStub'),
- 'Symfony\Component\Debug\Exception\SilencedErrorContext' => array('Symfony\Component\VarDumper\Caster\ExceptionCaster', 'castSilencedErrorContext'),
- 'PHPUnit_Framework_MockObject_MockObject' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'),
- 'Prophecy\Prophecy\ProphecySubjectInterface' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'),
- 'Mockery\MockInterface' => array('Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'),
- 'PDO' => array('Symfony\Component\VarDumper\Caster\PdoCaster', 'castPdo'),
- 'PDOStatement' => array('Symfony\Component\VarDumper\Caster\PdoCaster', 'castPdoStatement'),
- 'AMQPConnection' => array('Symfony\Component\VarDumper\Caster\AmqpCaster', 'castConnection'),
- 'AMQPChannel' => array('Symfony\Component\VarDumper\Caster\AmqpCaster', 'castChannel'),
- 'AMQPQueue' => array('Symfony\Component\VarDumper\Caster\AmqpCaster', 'castQueue'),
- 'AMQPExchange' => array('Symfony\Component\VarDumper\Caster\AmqpCaster', 'castExchange'),
- 'AMQPEnvelope' => array('Symfony\Component\VarDumper\Caster\AmqpCaster', 'castEnvelope'),
- 'ArrayObject' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castArrayObject'),
- 'SplDoublyLinkedList' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castDoublyLinkedList'),
- 'SplFileInfo' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castFileInfo'),
- 'SplFileObject' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castFileObject'),
- 'SplFixedArray' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castFixedArray'),
- 'SplHeap' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castHeap'),
- 'SplObjectStorage' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castObjectStorage'),
- 'SplPriorityQueue' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castHeap'),
- 'OuterIterator' => array('Symfony\Component\VarDumper\Caster\SplCaster', 'castOuterIterator'),
- 'MongoCursorInterface' => array('Symfony\Component\VarDumper\Caster\MongoCaster', 'castCursor'),
- 'Redis' => array('Symfony\Component\VarDumper\Caster\RedisCaster', 'castRedis'),
- 'RedisArray' => array('Symfony\Component\VarDumper\Caster\RedisCaster', 'castRedisArray'),
- ':curl' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castCurl'),
- ':dba' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castDba'),
- ':dba persistent' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castDba'),
- ':gd' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castGd'),
- ':mysql link' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castMysqlLink'),
- ':pgsql large object' => array('Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLargeObject'),
- ':pgsql link' => array('Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLink'),
- ':pgsql link persistent' => array('Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castLink'),
- ':pgsql result' => array('Symfony\Component\VarDumper\Caster\PgSqlCaster', 'castResult'),
- ':process' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castProcess'),
- ':stream' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStream'),
- ':persistent stream' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStream'),
- ':stream-context' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castStreamContext'),
- ':xml' => array('Symfony\Component\VarDumper\Caster\XmlResourceCaster', 'castXml'),
- );
- protected $maxItems = 2500;
- protected $maxString = -1;
- protected $useExt;
- private $casters = array();
- private $prevErrorHandler;
- private $classInfo = array();
- private $filter = 0;
- /**
- * @param callable[]|null $casters A map of casters
- *
- * @see addCasters
- */
- public function __construct(array $casters = null)
- {
- if (null === $casters) {
- $casters = static::$defaultCasters;
- }
- $this->addCasters($casters);
- $this->useExt = extension_loaded('symfony_debug');
- }
- /**
- * Adds casters for resources and objects.
- *
- * Maps resources or objects types to a callback.
- * Types are in the key, with a callable caster for value.
- * Resource types are to be prefixed with a `:`,
- * see e.g. static::$defaultCasters.
- *
- * @param callable[] $casters A map of casters
- */
- public function addCasters(array $casters)
- {
- foreach ($casters as $type => $callback) {
- $this->casters[strtolower($type)][] = is_string($callback) && false !== strpos($callback, '::') ? explode('::', $callback, 2) : $callback;
- }
- }
- /**
- * Sets the maximum number of items to clone past the first level in nested structures.
- *
- * @param int $maxItems
- */
- public function setMaxItems($maxItems)
- {
- $this->maxItems = (int) $maxItems;
- }
- /**
- * Sets the maximum cloned length for strings.
- *
- * @param int $maxString
- */
- public function setMaxString($maxString)
- {
- $this->maxString = (int) $maxString;
- }
- /**
- * Clones a PHP variable.
- *
- * @param mixed $var Any PHP variable
- * @param int $filter A bit field of Caster::EXCLUDE_* constants
- *
- * @return Data The cloned variable represented by a Data object
- */
- public function cloneVar($var, $filter = 0)
- {
- $this->prevErrorHandler = set_error_handler(function ($type, $msg, $file, $line, $context) {
- if (E_RECOVERABLE_ERROR === $type || E_USER_ERROR === $type) {
- // Cloner never dies
- throw new \ErrorException($msg, 0, $type, $file, $line);
- }
- if ($this->prevErrorHandler) {
- return call_user_func($this->prevErrorHandler, $type, $msg, $file, $line, $context);
- }
- return false;
- });
- $this->filter = $filter;
- try {
- $data = $this->doClone($var);
- } catch (\Exception $e) {
- }
- restore_error_handler();
- $this->prevErrorHandler = null;
- if (isset($e)) {
- throw $e;
- }
- return new Data($data);
- }
- /**
- * Effectively clones the PHP variable.
- *
- * @param mixed $var Any PHP variable
- *
- * @return array The cloned variable represented in an array
- */
- abstract protected function doClone($var);
- /**
- * Casts an object to an array representation.
- *
- * @param Stub $stub The Stub for the casted object
- * @param bool $isNested True if the object is nested in the dumped structure
- *
- * @return array The object casted as array
- */
- protected function castObject(Stub $stub, $isNested)
- {
- $obj = $stub->value;
- $class = $stub->class;
- if (isset($class[15]) && "\0" === $class[15] && 0 === strpos($class, "class@anonymous\x00")) {
- $stub->class = get_parent_class($class).'@anonymous';
- }
- if (isset($this->classInfo[$class])) {
- list($i, $parents, $hasDebugInfo) = $this->classInfo[$class];
- } else {
- $i = 2;
- $parents = array(strtolower($class));
- $hasDebugInfo = method_exists($class, '__debugInfo');
- foreach (class_parents($class) as $p) {
- $parents[] = strtolower($p);
- ++$i;
- }
- foreach (class_implements($class) as $p) {
- $parents[] = strtolower($p);
- ++$i;
- }
- $parents[] = '*';
- $this->classInfo[$class] = array($i, $parents, $hasDebugInfo);
- }
- $a = Caster::castObject($obj, $class, $hasDebugInfo);
- try {
- while ($i--) {
- if (!empty($this->casters[$p = $parents[$i]])) {
- foreach ($this->casters[$p] as $callback) {
- $a = $callback($obj, $a, $stub, $isNested, $this->filter);
- }
- }
- }
- } catch (\Exception $e) {
- $a = array((Stub::TYPE_OBJECT === $stub->type ? Caster::PREFIX_VIRTUAL : '').'⚠' => new ThrowingCasterException($e)) + $a;
- }
- return $a;
- }
- /**
- * Casts a resource to an array representation.
- *
- * @param Stub $stub The Stub for the casted resource
- * @param bool $isNested True if the object is nested in the dumped structure
- *
- * @return array The resource casted as array
- */
- protected function castResource(Stub $stub, $isNested)
- {
- $a = array();
- $res = $stub->value;
- $type = $stub->class;
- try {
- if (!empty($this->casters[':'.$type])) {
- foreach ($this->casters[':'.$type] as $callback) {
- $a = $callback($res, $a, $stub, $isNested, $this->filter);
- }
- }
- } catch (\Exception $e) {
- $a = array((Stub::TYPE_OBJECT === $stub->type ? Caster::PREFIX_VIRTUAL : '').'⚠' => new ThrowingCasterException($e)) + $a;
- }
- return $a;
- }
- }
|