vendor/sulu/sulu/src/Sulu/Component/DocumentManager/ProxyFactory.php line 116

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Component\DocumentManager;
  14. use PHPCR\NodeInterface;
  15. use ProxyManager\Factory\LazyLoadingGhostFactory;
  16. use ProxyManager\Proxy\GhostObjectInterface;
  17. use ProxyManager\Proxy\LazyLoadingInterface;
  18. use Sulu\Component\DocumentManager\Collection\ChildrenCollection;
  19. use Sulu\Component\DocumentManager\Collection\ReferrerCollection;
  20. use Sulu\Component\DocumentManager\Event\HydrateEvent;
  21. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  23. /**
  24.  * Handle creation of proxies.
  25.  */
  26. class ProxyFactory
  27. {
  28.     /**
  29.      * @var LazyLoadingGhostFactory
  30.      */
  31.     private $proxyFactory;
  33.     /**
  34.      * @var EventDispatcherInterface
  35.      */
  36.     private $dispatcher;
  38.     /**
  39.      * @var DocumentRegistry
  40.      */
  41.     private $registry;
  43.     /**
  44.      * @var MetadataFactoryInterface
  45.      */
  46.     private $metadataFactory;
  48.     public function __construct(
  49.         LazyLoadingGhostFactory $proxyFactory,
  50.         EventDispatcherInterface $dispatcher,
  51.         DocumentRegistry $registry,
  52.         MetadataFactoryInterface $metadataFactory
  53.     ) {
  54.         $this->proxyFactory = $proxyFactory;
  55.         $this->dispatcher = $dispatcher;
  56.         $this->registry = $registry;
  57.         $this->metadataFactory = $metadataFactory;
  58.     }
  60.     /**
  61.      * Create a new proxy object from the given document for
  62.      * the given target node.
  63.      *
  64.      * TODO: We only pass the document here in order to correctly evaluate its locale
  65.      *       later. I wonder if it necessary.
  66.      *
  67.      * @param object $fromDocument
  68.      * @param array $options
  69.      *
  70.      * @return GhostObjectInterface
  71.      */
  72.     public function createProxyForNode($fromDocument, NodeInterface $targetNode, $options = [])
  73.     {
  74.         // if node is already registered then just return the registered document
  75.         $locale = $this->registry->getOriginalLocaleForDocument($fromDocument);
  76.         if ($this->registry->hasNode($targetNode, $locale)) {
  77.             $document = $this->registry->getDocumentForNode($targetNode, $locale);
  79.             // If the parent is not loaded in the correct locale, reload it in the correct locale.
  80.             if ($this->registry->getOriginalLocaleForDocument($document) !== $locale) {
  81.                 $hydrateEvent = new HydrateEvent($targetNode, $locale);
  82.                 $hydrateEvent->setDocument($document);
  83.                 $this->dispatcher->dispatch($hydrateEvent, Events::HYDRATE);
  84.             }
  86.             return $document;
  87.         }
  89.         $initializer = function(LazyLoadingInterface $document, $method, array $parameters, &$initializer) use (
  90.             $targetNode,
  91.             $options,
  92.             $locale
  93.         ) {
  94.             $hydrateEvent = new HydrateEvent($targetNode, $locale, $options);
  95.             $hydrateEvent->setDocument($document);
  96.             $this->dispatcher->dispatch($hydrateEvent, Events::HYDRATE);
  98.             $initializer = null;
  99.         };
  101.         $targetMetadata = $this->metadataFactory->getMetadataForPhpcrNode($targetNode);
  102.         $proxy = $this->proxyFactory->createProxy($targetMetadata->getClass(), $initializer);
  103.         $locale = $this->registry->getOriginalLocaleForDocument($fromDocument);
  104.         $this->registry->registerDocument($proxy, $targetNode, $locale);
  106.         return $proxy;
  107.     }
  109.     /**
  110.      * Create a new children collection for the given document.
  111.      *
  112.      * @param object $document
  113.      *
  114.      * @return ChildrenCollection
  115.      */
  116.     public function createChildrenCollection($document, array $options = [])
  117.     {
  118.         $node = $this->registry->getNodeForDocument($document);
  119.         $locale = $this->registry->getOriginalLocaleForDocument($document);
  121.         return new ChildrenCollection(
  122.             $node,
  123.             $this->dispatcher,
  124.             $locale,
  125.             $options
  126.         );
  127.     }
  129.     /**
  130.      * Create a new collection of referrers from a list of referencing items.
  131.      *
  132.      * @param object $document
  133.      *
  134.      * @return ReferrerCollection
  135.      */
  136.     public function createReferrerCollection($document)
  137.     {
  138.         $node = $this->registry->getNodeForDocument($document);
  139.         $locale = $this->registry->getOriginalLocaleForDocument($document);
  141.         return new ReferrerCollection(
  142.             $node,
  143.             $this->dispatcher,
  144.             $locale
  145.         );
  146.     }
  147. }