Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. SplCaster.php

class SplCaster

Casts SPL related classes to array representation.

@author Nicolas Grekas <p@tchwork.com>

@final

Hierarchy

  • class \Symfony\Component\VarDumper\Caster\SplCaster

Expanded class hierarchy of SplCaster

File

vendor/symfony/var-dumper/Caster/SplCaster.php, line 23

Namespace

Symfony\Component\VarDumper\Caster
View source
class SplCaster {
    private const SPL_FILE_OBJECT_FLAGS = [
        \SplFileObject::DROP_NEW_LINE => 'DROP_NEW_LINE',
        \SplFileObject::READ_AHEAD => 'READ_AHEAD',
        \SplFileObject::SKIP_EMPTY => 'SKIP_EMPTY',
        \SplFileObject::READ_CSV => 'READ_CSV',
    ];
    public static function castArrayObject(\ArrayObject $c, array $a, Stub $stub, bool $isNested) : array {
        return self::castSplArray($c, $a, $stub, $isNested);
    }
    public static function castArrayIterator(\ArrayIterator $c, array $a, Stub $stub, bool $isNested) : array {
        return self::castSplArray($c, $a, $stub, $isNested);
    }
    public static function castHeap(\Iterator $c, array $a, Stub $stub, bool $isNested) : array {
        $a += [
            Caster::PREFIX_VIRTUAL . 'heap' => iterator_to_array(clone $c),
        ];
        return $a;
    }
    public static function castDoublyLinkedList(\SplDoublyLinkedList $c, array $a, Stub $stub, bool $isNested) : array {
        $prefix = Caster::PREFIX_VIRTUAL;
        $mode = $c->getIteratorMode();
        $c->setIteratorMode(\SplDoublyLinkedList::IT_MODE_KEEP | $mode & ~\SplDoublyLinkedList::IT_MODE_DELETE);
        $a += [
            $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),
            $prefix . 'dllist' => iterator_to_array($c),
        ];
        $c->setIteratorMode($mode);
        return $a;
    }
    public static function castFileInfo(\SplFileInfo $c, array $a, Stub $stub, bool $isNested) : array {
        static $map = [
            'path' => 'getPath',
            'filename' => 'getFilename',
            'basename' => 'getBasename',
            'pathname' => 'getPathname',
            'extension' => 'getExtension',
            'realPath' => 'getRealPath',
            'aTime' => 'getATime',
            'mTime' => 'getMTime',
            'cTime' => 'getCTime',
            'inode' => 'getInode',
            'size' => 'getSize',
            'perms' => 'getPerms',
            'owner' => 'getOwner',
            'group' => 'getGroup',
            'type' => 'getType',
            'writable' => 'isWritable',
            'readable' => 'isReadable',
            'executable' => 'isExecutable',
            'file' => 'isFile',
            'dir' => 'isDir',
            'link' => 'isLink',
            'linkTarget' => 'getLinkTarget',
        ];
        $prefix = Caster::PREFIX_VIRTUAL;
        unset($a["\x00SplFileInfo\x00fileName"]);
        unset($a["\x00SplFileInfo\x00pathName"]);
        try {
            $c->isReadable();
        } catch (\RuntimeException $e) {
            if ('Object not initialized' !== $e->getMessage()) {
                throw $e;
            }
            $a[$prefix . '⚠'] = 'The parent constructor was not called: the object is in an invalid state';
            return $a;
        } catch (\Error $e) {
            if ('Object not initialized' !== $e->getMessage()) {
                throw $e;
            }
            $a[$prefix . '⚠'] = 'The parent constructor was not called: the object is in an invalid state';
            return $a;
        }
        foreach ($map as $key => $accessor) {
            try {
                $a[$prefix . $key] = $c->{$accessor}();
            } catch (\Exception) {
            }
        }
        if ($a[$prefix . 'realPath'] ?? false) {
            $a[$prefix . 'realPath'] = new LinkStub($a[$prefix . 'realPath']);
        }
        if (isset($a[$prefix . 'perms'])) {
            $a[$prefix . 'perms'] = new ConstStub(\sprintf('0%o', $a[$prefix . 'perms']), $a[$prefix . 'perms']);
        }
        static $mapDate = [
            'aTime',
            'mTime',
            'cTime',
        ];
        foreach ($mapDate as $key) {
            if (isset($a[$prefix . $key])) {
                $a[$prefix . $key] = new ConstStub(date('Y-m-d H:i:s', $a[$prefix . $key]), $a[$prefix . $key]);
            }
        }
        return $a;
    }
    public static function castFileObject(\SplFileObject $c, array $a, Stub $stub, bool $isNested) : array {
        static $map = [
            'csvControl' => 'getCsvControl',
            'flags' => 'getFlags',
            'maxLineLen' => 'getMaxLineLen',
            'fstat' => 'fstat',
            'eof' => 'eof',
            'key' => 'key',
        ];
        $prefix = Caster::PREFIX_VIRTUAL;
        foreach ($map as $key => $accessor) {
            try {
                $a[$prefix . $key] = $c->{$accessor}();
            } catch (\Exception) {
            }
        }
        if (isset($a[$prefix . 'flags'])) {
            $flagsArray = [];
            foreach (self::SPL_FILE_OBJECT_FLAGS as $value => $name) {
                if ($a[$prefix . 'flags'] & $value) {
                    $flagsArray[] = $name;
                }
            }
            $a[$prefix . 'flags'] = new ConstStub(implode('|', $flagsArray), $a[$prefix . 'flags']);
        }
        if (isset($a[$prefix . 'fstat'])) {
            $a[$prefix . 'fstat'] = new CutArrayStub($a[$prefix . 'fstat'], [
                'dev',
                'ino',
                'nlink',
                'rdev',
                'blksize',
                'blocks',
            ]);
        }
        return $a;
    }
    public static function castObjectStorage(\SplObjectStorage $c, array $a, Stub $stub, bool $isNested) : array {
        $storage = [];
        unset($a[Caster::PREFIX_DYNAMIC . "\x00gcdata"]);
        // Don't hit https://bugs.php.net/65967
        unset($a["\x00SplObjectStorage\x00storage"]);
        $clone = clone $c;
        foreach ($clone as $obj) {
            $storage[] = new EnumStub([
                'object' => $obj,
                'info' => $clone->getInfo(),
            ]);
        }
        $a += [
            Caster::PREFIX_VIRTUAL . 'storage' => $storage,
        ];
        return $a;
    }
    public static function castOuterIterator(\OuterIterator $c, array $a, Stub $stub, bool $isNested) : array {
        $a[Caster::PREFIX_VIRTUAL . 'innerIterator'] = $c->getInnerIterator();
        return $a;
    }
    public static function castWeakReference(\WeakReference $c, array $a, Stub $stub, bool $isNested) : array {
        $a[Caster::PREFIX_VIRTUAL . 'object'] = $c->get();
        return $a;
    }
    public static function castWeakMap(\WeakMap $c, array $a, Stub $stub, bool $isNested) : array {
        $map = [];
        foreach (clone $c as $obj => $data) {
            $map[] = new EnumStub([
                'object' => $obj,
                'data' => $data,
            ]);
        }
        $a += [
            Caster::PREFIX_VIRTUAL . 'map' => $map,
        ];
        return $a;
    }
    private static function castSplArray(\ArrayObject|\ArrayIterator $c, array $a, Stub $stub, bool $isNested) : array {
        $prefix = Caster::PREFIX_VIRTUAL;
        $flags = $c->getFlags();
        if (!($flags & \ArrayObject::STD_PROP_LIST)) {
            $c->setFlags(\ArrayObject::STD_PROP_LIST);
            $a = Caster::castObject($c, $c::class, method_exists($c, '__debugInfo'), $stub->class);
            $c->setFlags($flags);
        }
        unset($a["\x00ArrayObject\x00storage"], $a["\x00ArrayIterator\x00storage"]);
        $a += [
            $prefix . 'storage' => $c->getArrayCopy(),
            $prefix . 'flag::STD_PROP_LIST' => (bool) ($flags & \ArrayObject::STD_PROP_LIST),
            $prefix . 'flag::ARRAY_AS_PROPS' => (bool) ($flags & \ArrayObject::ARRAY_AS_PROPS),
        ];
        if ($c instanceof \ArrayObject) {
            $a[$prefix . 'iteratorClass'] = new ClassStub($c->getIteratorClass());
        }
        return $a;
    }

}

Members

Title Sort descending Modifiers Object type Summary
SplCaster::castArrayIterator public static function
SplCaster::castArrayObject public static function
SplCaster::castDoublyLinkedList public static function
SplCaster::castFileInfo public static function
SplCaster::castFileObject public static function
SplCaster::castHeap public static function
SplCaster::castObjectStorage public static function
SplCaster::castOuterIterator public static function
SplCaster::castSplArray private static function
SplCaster::castWeakMap public static function
SplCaster::castWeakReference public static function
SplCaster::SPL_FILE_OBJECT_FLAGS private constant

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal