Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\VarDumper\Caster;
Chris@0: 
Chris@0: use Symfony\Component\VarDumper\Cloner\Stub;
Chris@0: 
Chris@0: /**
Chris@0:  * Casts SPL related classes to array representation.
Chris@0:  *
Chris@0:  * @author Nicolas Grekas <p@tchwork.com>
Chris@0:  */
Chris@0: class SplCaster
Chris@0: {
Chris@17:     private static $splFileObjectFlags = [
Chris@0:         \SplFileObject::DROP_NEW_LINE => 'DROP_NEW_LINE',
Chris@0:         \SplFileObject::READ_AHEAD => 'READ_AHEAD',
Chris@0:         \SplFileObject::SKIP_EMPTY => 'SKIP_EMPTY',
Chris@0:         \SplFileObject::READ_CSV => 'READ_CSV',
Chris@17:     ];
Chris@0: 
Chris@0:     public static function castArrayObject(\ArrayObject $c, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@16:         return self::castSplArray($c, $a, $stub, $isNested);
Chris@16:     }
Chris@0: 
Chris@16:     public static function castArrayIterator(\ArrayIterator $c, array $a, Stub $stub, $isNested)
Chris@16:     {
Chris@16:         return self::castSplArray($c, $a, $stub, $isNested);
Chris@0:     }
Chris@0: 
Chris@0:     public static function castHeap(\Iterator $c, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@17:         $a += [
Chris@0:             Caster::PREFIX_VIRTUAL.'heap' => iterator_to_array(clone $c),
Chris@17:         ];
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     public static function castDoublyLinkedList(\SplDoublyLinkedList $c, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@0:         $prefix = Caster::PREFIX_VIRTUAL;
Chris@0:         $mode = $c->getIteratorMode();
Chris@0:         $c->setIteratorMode(\SplDoublyLinkedList::IT_MODE_KEEP | $mode & ~\SplDoublyLinkedList::IT_MODE_DELETE);
Chris@0: 
Chris@17:         $a += [
Chris@0:             $prefix.'mode' => new ConstStub((($mode & \SplDoublyLinkedList::IT_MODE_LIFO) ? 'IT_MODE_LIFO' : 'IT_MODE_FIFO').' | '.(($mode & \SplDoublyLinkedList::IT_MODE_DELETE) ? 'IT_MODE_DELETE' : 'IT_MODE_KEEP'), $mode),
Chris@0:             $prefix.'dllist' => iterator_to_array($c),
Chris@17:         ];
Chris@0:         $c->setIteratorMode($mode);
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     public static function castFileInfo(\SplFileInfo $c, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@17:         static $map = [
Chris@0:             'path' => 'getPath',
Chris@0:             'filename' => 'getFilename',
Chris@0:             'basename' => 'getBasename',
Chris@0:             'pathname' => 'getPathname',
Chris@0:             'extension' => 'getExtension',
Chris@0:             'realPath' => 'getRealPath',
Chris@0:             'aTime' => 'getATime',
Chris@0:             'mTime' => 'getMTime',
Chris@0:             'cTime' => 'getCTime',
Chris@0:             'inode' => 'getInode',
Chris@0:             'size' => 'getSize',
Chris@0:             'perms' => 'getPerms',
Chris@0:             'owner' => 'getOwner',
Chris@0:             'group' => 'getGroup',
Chris@0:             'type' => 'getType',
Chris@0:             'writable' => 'isWritable',
Chris@0:             'readable' => 'isReadable',
Chris@0:             'executable' => 'isExecutable',
Chris@0:             'file' => 'isFile',
Chris@0:             'dir' => 'isDir',
Chris@0:             'link' => 'isLink',
Chris@0:             'linkTarget' => 'getLinkTarget',
Chris@17:         ];
Chris@0: 
Chris@0:         $prefix = Caster::PREFIX_VIRTUAL;
Chris@0: 
Chris@0:         foreach ($map as $key => $accessor) {
Chris@0:             try {
Chris@0:                 $a[$prefix.$key] = $c->$accessor();
Chris@0:             } catch (\Exception $e) {
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($a[$prefix.'realPath'])) {
Chris@0:             $a[$prefix.'realPath'] = new LinkStub($a[$prefix.'realPath']);
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($a[$prefix.'perms'])) {
Chris@0:             $a[$prefix.'perms'] = new ConstStub(sprintf('0%o', $a[$prefix.'perms']), $a[$prefix.'perms']);
Chris@0:         }
Chris@0: 
Chris@17:         static $mapDate = ['aTime', 'mTime', 'cTime'];
Chris@0:         foreach ($mapDate as $key) {
Chris@0:             if (isset($a[$prefix.$key])) {
Chris@0:                 $a[$prefix.$key] = new ConstStub(date('Y-m-d H:i:s', $a[$prefix.$key]), $a[$prefix.$key]);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     public static function castFileObject(\SplFileObject $c, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@17:         static $map = [
Chris@0:             'csvControl' => 'getCsvControl',
Chris@0:             'flags' => 'getFlags',
Chris@0:             'maxLineLen' => 'getMaxLineLen',
Chris@0:             'fstat' => 'fstat',
Chris@0:             'eof' => 'eof',
Chris@0:             'key' => 'key',
Chris@17:         ];
Chris@0: 
Chris@0:         $prefix = Caster::PREFIX_VIRTUAL;
Chris@0: 
Chris@0:         foreach ($map as $key => $accessor) {
Chris@0:             try {
Chris@0:                 $a[$prefix.$key] = $c->$accessor();
Chris@0:             } catch (\Exception $e) {
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($a[$prefix.'flags'])) {
Chris@17:             $flagsArray = [];
Chris@0:             foreach (self::$splFileObjectFlags as $value => $name) {
Chris@0:                 if ($a[$prefix.'flags'] & $value) {
Chris@0:                     $flagsArray[] = $name;
Chris@0:                 }
Chris@0:             }
Chris@0:             $a[$prefix.'flags'] = new ConstStub(implode('|', $flagsArray), $a[$prefix.'flags']);
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($a[$prefix.'fstat'])) {
Chris@17:             $a[$prefix.'fstat'] = new CutArrayStub($a[$prefix.'fstat'], ['dev', 'ino', 'nlink', 'rdev', 'blksize', 'blocks']);
Chris@0:         }
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     public static function castFixedArray(\SplFixedArray $c, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@17:         $a += [
Chris@0:             Caster::PREFIX_VIRTUAL.'storage' => $c->toArray(),
Chris@17:         ];
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     public static function castObjectStorage(\SplObjectStorage $c, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@17:         $storage = [];
Chris@0:         unset($a[Caster::PREFIX_DYNAMIC."\0gcdata"]); // Don't hit https://bugs.php.net/65967
Chris@0: 
Chris@16:         $clone = clone $c;
Chris@16:         foreach ($clone as $obj) {
Chris@17:             $storage[] = [
Chris@0:                 'object' => $obj,
Chris@16:                 'info' => $clone->getInfo(),
Chris@17:              ];
Chris@0:         }
Chris@0: 
Chris@17:         $a += [
Chris@0:             Caster::PREFIX_VIRTUAL.'storage' => $storage,
Chris@17:         ];
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     public static function castOuterIterator(\OuterIterator $c, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@0:         $a[Caster::PREFIX_VIRTUAL.'innerIterator'] = $c->getInnerIterator();
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@16: 
Chris@16:     private static function castSplArray($c, array $a, Stub $stub, $isNested)
Chris@16:     {
Chris@16:         $prefix = Caster::PREFIX_VIRTUAL;
Chris@16:         $class = $stub->class;
Chris@16:         $flags = $c->getFlags();
Chris@16: 
Chris@16:         if (!($flags & \ArrayObject::STD_PROP_LIST)) {
Chris@16:             $c->setFlags(\ArrayObject::STD_PROP_LIST);
Chris@16:             $a = Caster::castObject($c, $class);
Chris@16:             $c->setFlags($flags);
Chris@16:         }
Chris@17:         $a += [
Chris@16:             $prefix.'flag::STD_PROP_LIST' => (bool) ($flags & \ArrayObject::STD_PROP_LIST),
Chris@16:             $prefix.'flag::ARRAY_AS_PROPS' => (bool) ($flags & \ArrayObject::ARRAY_AS_PROPS),
Chris@17:         ];
Chris@16:         if ($c instanceof \ArrayObject) {
Chris@16:             $a[$prefix.'iteratorClass'] = new ClassStub($c->getIteratorClass());
Chris@16:         }
Chris@16:         $a[$prefix.'storage'] = $c->getArrayCopy();
Chris@16: 
Chris@16:         return $a;
Chris@16:     }
Chris@0: }