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

Breadcrumb

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

class Caster

Helper for filtering out properties in casters.

@author Nicolas Grekas <p@tchwork.com>

@final

Hierarchy

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

Expanded class hierarchy of Caster

4 files declare their use of Caster
AbstractCloner.php in vendor/symfony/var-dumper/Cloner/AbstractCloner.php
Data.php in vendor/symfony/var-dumper/Cloner/Data.php
FlattenException.php in vendor/symfony/error-handler/Exception/FlattenException.php
ValidatorDataCollector.php in vendor/symfony/validator/DataCollector/ValidatorDataCollector.php

File

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

Namespace

Symfony\Component\VarDumper\Caster
View source
class Caster {
    public const EXCLUDE_VERBOSE = 1;
    public const EXCLUDE_VIRTUAL = 2;
    public const EXCLUDE_DYNAMIC = 4;
    public const EXCLUDE_PUBLIC = 8;
    public const EXCLUDE_PROTECTED = 16;
    public const EXCLUDE_PRIVATE = 32;
    public const EXCLUDE_NULL = 64;
    public const EXCLUDE_EMPTY = 128;
    public const EXCLUDE_NOT_IMPORTANT = 256;
    public const EXCLUDE_STRICT = 512;
    public const EXCLUDE_UNINITIALIZED = 1024;
    public const PREFIX_VIRTUAL = "\x00~\x00";
    public const PREFIX_DYNAMIC = "\x00+\x00";
    public const PREFIX_PROTECTED = "\x00*\x00";
    // usage: sprintf(Caster::PATTERN_PRIVATE, $class, $property)
    public const PATTERN_PRIVATE = "\x00%s\x00%s";
    private static array $classProperties = [];
    
    /**
     * Casts objects to arrays and adds the dynamic property prefix.
     *
     * @param bool $hasDebugInfo Whether the __debugInfo method exists on $obj or not
     */
    public static function castObject(object $obj, string $class, bool $hasDebugInfo = false, ?string $debugClass = null) : array {
        if ($hasDebugInfo) {
            try {
                $debugInfo = $obj->__debugInfo();
            } catch (\Throwable) {
                // ignore failing __debugInfo()
                $hasDebugInfo = false;
            }
        }
        $a = $obj instanceof \Closure ? [] : (array) $obj;
        if ($obj instanceof \__PHP_Incomplete_Class) {
            return $a;
        }
        $classProperties = self::$classProperties[$class] ??= self::getClassProperties(new \ReflectionClass($class));
        $a = array_replace($classProperties, $a);
        if ($a) {
            $debugClass ??= get_debug_type($obj);
            $i = 0;
            $prefixedKeys = [];
            foreach ($a as $k => $v) {
                if ("\x00" !== ($k[0] ?? '')) {
                    if (!isset($classProperties[$k])) {
                        $prefixedKeys[$i] = self::PREFIX_DYNAMIC . $k;
                    }
                }
                elseif ($debugClass !== $class && 1 === strpos($k, $class)) {
                    $prefixedKeys[$i] = "\x00" . $debugClass . strrchr($k, "\x00");
                }
                ++$i;
            }
            if ($prefixedKeys) {
                $keys = array_keys($a);
                foreach ($prefixedKeys as $i => $k) {
                    $keys[$i] = $k;
                }
                $a = array_combine($keys, $a);
            }
        }
        if ($hasDebugInfo && \is_array($debugInfo)) {
            foreach ($debugInfo as $k => $v) {
                if (!isset($k[0]) || "\x00" !== $k[0]) {
                    if (\array_key_exists(self::PREFIX_DYNAMIC . $k, $a)) {
                        continue;
                    }
                    $k = self::PREFIX_VIRTUAL . $k;
                }
                unset($a[$k]);
                $a[$k] = $v;
            }
        }
        return $a;
    }
    
    /**
     * Filters out the specified properties.
     *
     * By default, a single match in the $filter bit field filters properties out, following an "or" logic.
     * When EXCLUDE_STRICT is set, an "and" logic is applied: all bits must match for a property to be removed.
     *
     * @param array    $a                The array containing the properties to filter
     * @param int      $filter           A bit field of Caster::EXCLUDE_* constants specifying which properties to filter out
     * @param string[] $listedProperties List of properties to exclude when Caster::EXCLUDE_VERBOSE is set, and to preserve when Caster::EXCLUDE_NOT_IMPORTANT is set
     * @param int|null &$count           Set to the number of removed properties
     */
    public static function filter(array $a, int $filter, array $listedProperties = [], ?int &$count = 0) : array {
        $count = 0;
        foreach ($a as $k => $v) {
            $type = self::EXCLUDE_STRICT & $filter;
            if (null === $v) {
                $type |= self::EXCLUDE_NULL & $filter;
                $type |= self::EXCLUDE_EMPTY & $filter;
            }
            elseif (false === $v || '' === $v || '0' === $v || 0 === $v || 0.0 === $v || [] === $v) {
                $type |= self::EXCLUDE_EMPTY & $filter;
            }
            elseif ($v instanceof UninitializedStub) {
                $type |= self::EXCLUDE_UNINITIALIZED & $filter;
            }
            if (self::EXCLUDE_NOT_IMPORTANT & $filter && !\in_array($k, $listedProperties, true)) {
                $type |= self::EXCLUDE_NOT_IMPORTANT;
            }
            if (self::EXCLUDE_VERBOSE & $filter && \in_array($k, $listedProperties, true)) {
                $type |= self::EXCLUDE_VERBOSE;
            }
            if (!isset($k[1]) || "\x00" !== $k[0]) {
                $type |= self::EXCLUDE_PUBLIC & $filter;
            }
            elseif ('~' === $k[1]) {
                $type |= self::EXCLUDE_VIRTUAL & $filter;
            }
            elseif ('+' === $k[1]) {
                $type |= self::EXCLUDE_DYNAMIC & $filter;
            }
            elseif ('*' === $k[1]) {
                $type |= self::EXCLUDE_PROTECTED & $filter;
            }
            else {
                $type |= self::EXCLUDE_PRIVATE & $filter;
            }
            if (self::EXCLUDE_STRICT & $filter ? $type === $filter : $type) {
                unset($a[$k]);
                ++$count;
            }
        }
        return $a;
    }
    public static function castPhpIncompleteClass(\__PHP_Incomplete_Class $c, array $a, Stub $stub, bool $isNested) : array {
        if (isset($a['__PHP_Incomplete_Class_Name'])) {
            $stub->class .= '(' . $a['__PHP_Incomplete_Class_Name'] . ')';
            unset($a['__PHP_Incomplete_Class_Name']);
        }
        return $a;
    }
    private static function getClassProperties(\ReflectionClass $class) : array {
        $classProperties = [];
        $className = $class->name;
        if ($parent = $class->getParentClass()) {
            $classProperties += self::$classProperties[$parent->name] ??= self::getClassProperties($parent);
        }
        foreach ($class->getProperties() as $p) {
            if ($p->isStatic()) {
                continue;
            }
            $classProperties[match (true) {    $p->isPublic() => $p->name,
                $p->isProtected() => self::PREFIX_PROTECTED . $p->name,
                default => "\x00" . $className . "\x00" . $p->name,
            
            }] = \PHP_VERSION_ID >= 80400 && $p->isVirtual() ? new VirtualStub($p) : new UninitializedStub($p);
        }
        return $classProperties;
    }

}

Members

Title Sort descending Modifiers Object type Summary
Caster::$classProperties private static property
Caster::castObject public static function Casts objects to arrays and adds the dynamic property prefix.
Caster::castPhpIncompleteClass public static function
Caster::EXCLUDE_DYNAMIC public constant
Caster::EXCLUDE_EMPTY public constant
Caster::EXCLUDE_NOT_IMPORTANT public constant
Caster::EXCLUDE_NULL public constant
Caster::EXCLUDE_PRIVATE public constant
Caster::EXCLUDE_PROTECTED public constant
Caster::EXCLUDE_PUBLIC public constant
Caster::EXCLUDE_STRICT public constant
Caster::EXCLUDE_UNINITIALIZED public constant
Caster::EXCLUDE_VERBOSE public constant
Caster::EXCLUDE_VIRTUAL public constant
Caster::filter public static function Filters out the specified properties.
Caster::getClassProperties private static function
Caster::PATTERN_PRIVATE public constant
Caster::PREFIX_DYNAMIC public constant
Caster::PREFIX_PROTECTED public constant
Caster::PREFIX_VIRTUAL public constant

API Navigation

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