vendor/symfony/var-exporter/LazyGhostTrait.php line 174

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\VarExporter;
  14. use Symfony\Component\VarExporter\Internal\Hydrator;
  15. use Symfony\Component\VarExporter\Internal\LazyObjectRegistry as Registry;
  16. use Symfony\Component\VarExporter\Internal\LazyObjectState;
  18. trait LazyGhostTrait
  19. {
  20.     private LazyObjectState $lazyObjectState;
  22.     /**
  23.      * Creates a lazy-loading ghost instance.
  24.      *
  25.      * When the initializer is a closure, it should initialize all properties at
  26.      * once and is given the instance to initialize as argument.
  27.      *
  28.      * When the initializer is an array of closures, it should be indexed by
  29.      * properties and closures should accept 4 arguments: the instance to
  30.      * initialize, the property to initialize, its write-scope, and its default
  31.      * value. Each closure should return the value of the corresponding property.
  32.      * The special "\0" key can be used to define a closure that returns all
  33.      * properties at once when full-initialization is needed; it takes the
  34.      * instance and its default properties as arguments.
  35.      *
  36.      * Properties should be indexed by their array-cast name, see
  37.      * https://php.net/manual/language.types.array#language.types.array.casting
  38.      *
  39.      * @param (\Closure(static):void
  40.      *        |array<string, \Closure(static, string, ?string, mixed):mixed>
  41.      *        |array{"\0": \Closure(static, array<string, mixed>):array<string, mixed>}) $initializer
  42.      * @param array<string, true>|null $skippedProperties An array indexed by the properties to skip, aka the ones
  43.      *                                                    that the initializer doesn't set when its a closure
  44.      */
  45.     public static function createLazyGhost(\Closure|array $initializer, array $skippedProperties = null, self $instance = null): static
  46.     {
  47.         $onlyProperties = null === $skippedProperties && \is_array($initializer) ? $initializer : null;
  49.         if (self::class !== $class = $instance ? $instance::class : static::class) {
  50.             $skippedProperties["\0".self::class."\0lazyObjectState"] = true;
  51.         } elseif (\defined($class.'::LAZY_OBJECT_PROPERTY_SCOPES')) {
  52.             Hydrator::$propertyScopes[$class] ??= $class::LAZY_OBJECT_PROPERTY_SCOPES;
  53.         }
  55.         $instance ??= (Registry::$classReflectors[$class] ??= new \ReflectionClass($class))->newInstanceWithoutConstructor();
  56.         Registry::$defaultProperties[$class] ??= (array) $instance;
  57.         $instance->lazyObjectState = new LazyObjectState($initializer, $skippedProperties ??= []);
  59.         foreach (Registry::$classResetters[$class] ??= Registry::getClassResetters($class) as $reset) {
  60.             $reset($instance, $skippedProperties, $onlyProperties);
  61.         }
  63.         return $instance;
  64.     }
  66.     /**
  67.      * Returns whether the object is initialized.
  68.      *
  69.      * @param $partial Whether partially initialized objects should be considered as initialized
  70.      */
  71.     public function isLazyObjectInitialized(bool $partial = false): bool
  72.     {
  73.         if (!$state = $this->lazyObjectState ?? null) {
  74.             return true;
  75.         }
  77.         if (!\is_array($state->initializer)) {
  78.             return LazyObjectState::STATUS_INITIALIZED_FULL === $state->status;
  79.         }
  81.         $class = $this::class;
  82.         $properties = (array) $this;
  84.         if ($partial) {
  85.             return (bool) array_intersect_key($state->initializer, $properties);
  86.         }
  88.         $propertyScopes = Hydrator::$propertyScopes[$class] ??= Hydrator::getPropertyScopes($class);
  89.         foreach ($state->initializer as $key => $initializer) {
  90.             if (!\array_key_exists($key, $properties) && isset($propertyScopes[$key])) {
  91.                 return false;
  92.             }
  93.         }
  95.         return true;
  96.     }
  98.     /**
  99.      * Forces initialization of a lazy object and returns it.
  100.      */
  101.     public function initializeLazyObject(): static
  102.     {
  103.         if (!$state = $this->lazyObjectState ?? null) {
  104.             return $this;
  105.         }
  107.         if (!\is_array($state->initializer)) {
  108.             if (LazyObjectState::STATUS_UNINITIALIZED_FULL === $state->status) {
  109.                 $state->initialize($this, '', null);
  110.             }
  112.             return $this;
  113.         }
  115.         $values = isset($state->initializer["\0"]) ? null : [];
  117.         $class = $this::class;
  118.         $properties = (array) $this;
  119.         $propertyScopes = Hydrator::$propertyScopes[$class] ??= Hydrator::getPropertyScopes($class);
  120.         foreach ($state->initializer as $key => $initializer) {
  121.             if (\array_key_exists($key, $properties) || ![$scope, $name, $readonlyScope] = $propertyScopes[$key] ?? null) {
  122.                 continue;
  123.             }
  124.             $scope = $readonlyScope ?? ('*' !== $scope ? $scope : $class);
  126.             if (null === $values) {
  127.                 if (!\is_array($values = ($state->initializer["\0"])($this, Registry::$defaultProperties[$class]))) {
  128.                     throw new \TypeError(sprintf('The lazy-initializer defined for instance of "%s" must return an array, got "%s".', $class, get_debug_type($values)));
  129.                 }
  131.                 if (\array_key_exists($key, $properties = (array) $this)) {
  132.                     continue;
  133.                 }
  134.             }
  136.             if (\array_key_exists($key, $values)) {
  137.                 $accessor = Registry::$classAccessors[$scope] ??= Registry::getClassAccessors($scope);
  138.                 $accessor['set']($this, $name, $properties[$key] = $values[$key]);
  139.             } else {
  140.                 $state->initialize($this, $name, $scope);
  141.                 $properties = (array) $this;
  142.             }
  143.         }
  145.         return $this;
  146.     }
  148.     /**
  149.      * @return bool Returns false when the object cannot be reset, ie when it's not a lazy object
  150.      */
  151.     public function resetLazyObject(): bool
  152.     {
  153.         if (!$state = $this->lazyObjectState ?? null) {
  154.             return false;
  155.         }
  157.         if (LazyObjectState::STATUS_UNINITIALIZED_FULL !== $state->status) {
  158.             $state->reset($this);
  159.         }
  161.         return true;
  162.     }
  164.     public function &__get($name): mixed
  165.     {
  166.         $propertyScopes = Hydrator::$propertyScopes[$this::class] ??= Hydrator::getPropertyScopes($this::class);
  167.         $scope = null;
  169.         if ([$class, , $readonlyScope] = $propertyScopes[$name] ?? null) {
  170.             $scope = Registry::getScope($propertyScopes, $class, $name);
  171.             $state = $this->lazyObjectState ?? null;
  173.             if ($state && (null === $scope || isset($propertyScopes["\0$scope\0$name"]))
  174.                 && LazyObjectState::STATUS_UNINITIALIZED_PARTIAL !== $state->initialize($this, $name, $readonlyScope ?? $scope)
  175.             ) {
  176.                 goto get_in_scope;
  177.             }
  178.         }
  180.         if ($parent = (Registry::$parentMethods[self::class] ??= Registry::getParentMethods(self::class))['get']) {
  181.             if (2 === $parent) {
  182.                 return parent::__get($name);
  183.             }
  184.             $value = parent::__get($name);
  186.             return $value;
  187.         }
  189.         if (null === $class) {
  190.             $frame = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 1)[0];
  191.             trigger_error(sprintf('Undefined property: %s::$%s in %s on line %s', $this::class, $name, $frame['file'], $frame['line']), \E_USER_NOTICE);
  192.         }
  194.         get_in_scope:
  196.         try {
  197.             if (null === $scope) {
  198.                 if (null === $readonlyScope) {
  199.                     return $this->$name;
  200.                 }
  201.                 $value = $this->$name;
  203.                 return $value;
  204.             }
  205.             $accessor = Registry::$classAccessors[$scope] ??= Registry::getClassAccessors($scope);
  207.             return $accessor['get']($this, $name, null !== $readonlyScope);
  208.         } catch (\Error $e) {
  209.             if (\Error::class !== $e::class || !str_starts_with($e->getMessage(), 'Cannot access uninitialized non-nullable property')) {
  210.                 throw $e;
  211.             }
  213.             try {
  214.                 if (null === $scope) {
  215.                     $this->$name = [];
  217.                     return $this->$name;
  218.                 }
  220.                 $accessor['set']($this, $name, []);
  222.                 return $accessor['get']($this, $name, null !== $readonlyScope);
  223.             } catch (\Error) {
  224.                 throw $e;
  225.             }
  226.         }
  227.     }
  229.     public function __set($name, $value): void
  230.     {
  231.         $propertyScopes = Hydrator::$propertyScopes[$this::class] ??= Hydrator::getPropertyScopes($this::class);
  232.         $scope = null;
  233.         $state = null;
  235.         if ([$class, , $readonlyScope] = $propertyScopes[$name] ?? null) {
  236.             $scope = Registry::getScope($propertyScopes, $class, $name, $readonlyScope);
  237.             $state = $this->lazyObjectState ?? null;
  239.             if ($state && ($readonlyScope === $scope || isset($propertyScopes["\0$scope\0$name"]))) {
  240.                 if (LazyObjectState::STATUS_UNINITIALIZED_FULL === $state->status) {
  241.                     $state->initialize($this, $name, $readonlyScope ?? $scope);
  242.                 }
  243.                 goto set_in_scope;
  244.             }
  245.         }
  247.         if ((Registry::$parentMethods[self::class] ??= Registry::getParentMethods(self::class))['set']) {
  248.             parent::__set($name, $value);
  250.             return;
  251.         }
  253.         set_in_scope:
  255.         if (null === $scope) {
  256.             $this->$name = $value;
  257.         } else {
  258.             $accessor = Registry::$classAccessors[$scope] ??= Registry::getClassAccessors($scope);
  259.             $accessor['set']($this, $name, $value);
  260.         }
  261.     }
  263.     public function __isset($name): bool
  264.     {
  265.         $propertyScopes = Hydrator::$propertyScopes[$this::class] ??= Hydrator::getPropertyScopes($this::class);
  266.         $scope = null;
  268.         if ([$class, , $readonlyScope] = $propertyScopes[$name] ?? null) {
  269.             $scope = Registry::getScope($propertyScopes, $class, $name);
  270.             $state = $this->lazyObjectState ?? null;
  272.             if ($state && (null === $scope || isset($propertyScopes["\0$scope\0$name"]))
  273.                 && LazyObjectState::STATUS_UNINITIALIZED_PARTIAL !== $state->initialize($this, $name, $readonlyScope ?? $scope)
  274.             ) {
  275.                 goto isset_in_scope;
  276.             }
  277.         }
  279.         if ((Registry::$parentMethods[self::class] ??= Registry::getParentMethods(self::class))['isset']) {
  280.             return parent::__isset($name);
  281.         }
  283.         isset_in_scope:
  285.         if (null === $scope) {
  286.             return isset($this->$name);
  287.         }
  288.         $accessor = Registry::$classAccessors[$scope] ??= Registry::getClassAccessors($scope);
  290.         return $accessor['isset']($this, $name);
  291.     }
  293.     public function __unset($name): void
  294.     {
  295.         $propertyScopes = Hydrator::$propertyScopes[$this::class] ??= Hydrator::getPropertyScopes($this::class);
  296.         $scope = null;
  298.         if ([$class, , $readonlyScope] = $propertyScopes[$name] ?? null) {
  299.             $scope = Registry::getScope($propertyScopes, $class, $name, $readonlyScope);
  300.             $state = $this->lazyObjectState ?? null;
  302.             if ($state && ($readonlyScope === $scope || isset($propertyScopes["\0$scope\0$name"]))) {
  303.                 if (LazyObjectState::STATUS_UNINITIALIZED_FULL === $state->status) {
  304.                     $state->initialize($this, $name, $readonlyScope ?? $scope);
  305.                 }
  306.                 goto unset_in_scope;
  307.             }
  308.         }
  310.         if ((Registry::$parentMethods[self::class] ??= Registry::getParentMethods(self::class))['unset']) {
  311.             parent::__unset($name);
  313.             return;
  314.         }
  316.         unset_in_scope:
  318.         if (null === $scope) {
  319.             unset($this->$name);
  320.         } else {
  321.             $accessor = Registry::$classAccessors[$scope] ??= Registry::getClassAccessors($scope);
  322.             $accessor['unset']($this, $name);
  323.         }
  324.     }
  326.     public function __clone(): void
  327.     {
  328.         if ($state = $this->lazyObjectState ?? null) {
  329.             $this->lazyObjectState = clone $state;
  330.         }
  332.         if ((Registry::$parentMethods[self::class] ??= Registry::getParentMethods(self::class))['clone']) {
  333.             parent::__clone();
  334.         }
  335.     }
  337.     public function __serialize(): array
  338.     {
  339.         $class = self::class;
  341.         if ((Registry::$parentMethods[$class] ??= Registry::getParentMethods($class))['serialize']) {
  342.             $properties = parent::__serialize();
  343.         } else {
  344.             $this->initializeLazyObject();
  345.             $properties = (array) $this;
  346.         }
  347.         unset($properties["\0$class\0lazyObjectState"]);
  349.         if (Registry::$parentMethods[$class]['serialize'] || !Registry::$parentMethods[$class]['sleep']) {
  350.             return $properties;
  351.         }
  353.         $scope = get_parent_class($class);
  354.         $data = [];
  356.         foreach (parent::__sleep() as $name) {
  357.             $value = $properties[$k = $name] ?? $properties[$k = "\0*\0$name"] ?? $properties[$k = "\0$scope\0$name"] ?? $k = null;
  359.             if (null === $k) {
  360.                 trigger_error(sprintf('serialize(): "%s" returned as member variable from __sleep() but does not exist', $name), \E_USER_NOTICE);
  361.             } else {
  362.                 $data[$k] = $value;
  363.             }
  364.         }
  366.         return $data;
  367.     }
  369.     public function __destruct()
  370.     {
  371.         $state = $this->lazyObjectState ?? null;
  373.         if ($state && \in_array($state->status, [LazyObjectState::STATUS_UNINITIALIZED_FULL, LazyObjectState::STATUS_UNINITIALIZED_PARTIAL], true)) {
  374.             return;
  375.         }
  377.         if ((Registry::$parentMethods[self::class] ??= Registry::getParentMethods(self::class))['destruct']) {
  378.             parent::__destruct();
  379.         }
  380.     }
  382.     private function setLazyObjectAsInitialized(bool $initialized): void
  383.     {
  384.         $state = $this->lazyObjectState ?? null;
  386.         if ($state && !\is_array($state->initializer)) {
  387.             $state->status = $initialized ? LazyObjectState::STATUS_INITIALIZED_FULL : LazyObjectState::STATUS_UNINITIALIZED_FULL;
  388.         }
  389.     }
  390. }