vendor/ezsystems/ezpublish-kernel/eZ/Publish/Core/Repository/Values/GeneratorProxyTrait.php line 74

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. namespace eZ\Publish\Core\Repository\Values;
  9. use Generator;
  11. /**
  12.  * Trait for proxies, covers all relevant magic methods and exposes private method to load object.
  13.  *
  14.  * Uses generator internally to be able to cleanly execute object load async on-demand.
  15.  *
  16.  * @internal Meant for internal use by Repository!
  17.  */
  18. trait GeneratorProxyTrait
  19. {
  20.     /**
  21.      * Overload this for correct type hint on object type.
  22.      *
  23.      * @var object|null
  24.      */
  25.     protected $object;
  27.     /**
  28.      * Needs to be protected as value objects often define this as well.
  29.      *
  30.      * @var mixed
  31.      */
  32.     protected $id;
  34.     /** @var Generator|null */
  35.     private $generator;
  37.     /**
  38.      * GeneratorProxyTrait constructor.
  39.      *
  40.      * @param Generator $generator
  41.      * @param mixed $id Object id to use for loading the object on demand.
  42.      */
  43.     public function __construct(Generator $generator, $id)
  44.     {
  45.         $this->generator = $generator;
  46.         $this->id = $id;
  47.     }
  49.     public function __call($name, $arguments)
  50.     {
  51.         if ($this->object === null) {
  52.             $this->loadObject();
  53.         }
  55.         return $this->object->$name(...$arguments);
  56.     }
  58.     public function __invoke(...$args)
  59.     {
  60.         if ($this->object === null) {
  61.             $this->loadObject();
  62.         }
  64.         return ($this->object)(...$args);
  65.     }
  67.     public function __get($name)
  68.     {
  69.         if ($name === 'id') {
  70.             return $this->id;
  71.         }
  73.         if ($this->object === null) {
  74.             $this->loadObject();
  75.         }
  77.         return $this->object->$name;
  78.     }
  80.     public function __isset($name)
  81.     {
  82.         if ($name === 'id') {
  83.             return true;
  84.         }
  86.         if ($this->object === null) {
  87.             $this->loadObject();
  88.         }
  90.         return isset($this->object->$name);
  91.     }
  93.     public function __unset($name)
  94.     {
  95.         if ($this->object === null) {
  96.             $this->loadObject();
  97.         }
  99.         unset($this->object->$name);
  100.     }
  102.     public function __set($name, $value)
  103.     {
  104.         if ($this->object === null) {
  105.             $this->loadObject();
  106.         }
  108.         $this->object->$name = $value;
  109.     }
  111.     public function __toString()
  112.     {
  113.         if ($this->object === null) {
  114.             $this->loadObject();
  115.         }
  117.         return (string)$this->object;
  118.     }
  120.     public function __sleep()
  121.     {
  122.         if ($this->object === null) {
  123.             $this->loadObject();
  124.         }
  126.         return ['object', 'id'];
  127.     }
  129.     public function __debugInfo()
  130.     {
  131.         if ($this->object === null) {
  132.             $this->loadObject();
  133.         }
  135.         return [
  136.             'object' => $this->object,
  137.             'id' => $this->id,
  138.         ];
  139.     }
  141.     /**
  142.      * Loads the generator to object value and unset's generator.
  143.      *
  144.      * Can only be called once, so check presence of $this->object before using it.
  145.      *
  146.      * This assumes generator is made to support bulk loading of several objects, and thus takes object id as input
  147.      * in order to return right object at a time, and thus performs two yields per item.
  148.      * -> See PR that came with this trait for example generators.
  149.      */
  150.     protected function loadObject()
  151.     {
  152.         $this->object = $this->generator->send($this->id);
  153.         $this->generator->next();
  154.         unset($this->generator);
  155.     }
  156. }