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

Open in your IDE?
  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\LazyLoadingInterface;
  17. use Sulu\Component\DocumentManager\Collection\ChildrenCollection;
  18. use Sulu\Component\DocumentManager\Collection\ReferrerCollection;
  19. use Sulu\Component\DocumentManager\Event\HydrateEvent;
  20. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  22. /**
  23.  * Handle creation of proxies.
  24.  */
  25. class ProxyFactory
  26. {
  27.     /**
  28.      * @var LazyLoadingGhostFactory
  29.      */
  30.     private $proxyFactory;
  32.     /**
  33.      * @var EventDispatcherInterface
  34.      */
  35.     private $dispatcher;
  37.     /**
  38.      * @var DocumentRegistry
  39.      */
  40.     private $registry;
  42.     /**
  43.      * @var MetadataFactoryInterface
  44.      */
  45.     private $metadataFactory;
  47.     public function __construct(
  48.         LazyLoadingGhostFactory $proxyFactory,
  49.         EventDispatcherInterface $dispatcher,
  50.         DocumentRegistry $registry,
  51.         MetadataFactoryInterface $metadataFactory
  52.     ) {
  53.         $this->proxyFactory = $proxyFactory;
  54.         $this->dispatcher = $dispatcher;
  55.         $this->registry = $registry;
  56.         $this->metadataFactory = $metadataFactory;
  57.     }
  59.     /**
  60.      * Create a new proxy object from the given document for
  61.      * the given target node.
  62.      *
  63.      * TODO: We only pass the document here in order to correctly evaluate its locale
  64.      *       later. I wonder if it necessary.
  65.      *
  66.      * @param object $fromDocument
  67.      * @param array $options
  68.      *
  69.      * @return \ProxyManager\Proxy\GhostObjectInterface
  70.      */
  71.     public function createProxyForNode($fromDocument, NodeInterface $targetNode, $options = [])
  72.     {
  73.         // if node is already registered then just return the registered document
  74.         $locale = $this->registry->getOriginalLocaleForDocument($fromDocument);
  75.         if ($this->registry->hasNode($targetNode, $locale)) {
  76.             $document = $this->registry->getDocumentForNode($targetNode, $locale);
  78.             // If the parent is not loaded in the correct locale, reload it in the correct locale.
  79.             if ($this->registry->getOriginalLocaleForDocument($document) !== $locale) {
  80.                 $hydrateEvent = new HydrateEvent($targetNode, $locale);
  81.                 $hydrateEvent->setDocument($document);
  82.                 $this->dispatcher->dispatch($hydrateEvent, Events::HYDRATE);
  83.             }
  85.             return $document;
  86.         }
  88.         $initializer = function(LazyLoadingInterface $document, $method, array $parameters, &$initializer) use (
  89.             $targetNode,
  90.             $options,
  91.             $locale
  92.         ) {
  93.             $hydrateEvent = new HydrateEvent($targetNode, $locale, $options);
  94.             $hydrateEvent->setDocument($document);
  95.             $this->dispatcher->dispatch($hydrateEvent, Events::HYDRATE);
  97.             $initializer = null;
  98.         };
  100.         $targetMetadata = $this->metadataFactory->getMetadataForPhpcrNode($targetNode);
  101.         $proxy = $this->proxyFactory->createProxy($targetMetadata->getClass(), $initializer);
  102.         $locale = $this->registry->getOriginalLocaleForDocument($fromDocument);
  103.         $this->registry->registerDocument($proxy, $targetNode, $locale);
  105.         return $proxy;
  106.     }
  108.     /**
  109.      * Create a new children collection for the given document.
  110.      *
  111.      * @param object $document
  112.      *
  113.      * @return ChildrenCollection
  114.      */
  115.     public function createChildrenCollection($document, array $options = [])
  116.     {
  117.         $node = $this->registry->getNodeForDocument($document);
  118.         $locale = $this->registry->getOriginalLocaleForDocument($document);
  120.         return new ChildrenCollection(
  121.             $node,
  122.             $this->dispatcher,
  123.             $locale,
  124.             $options
  125.         );
  126.     }
  128.     /**
  129.      * Create a new collection of referrers from a list of referencing items.
  130.      *
  131.      * @param object $document
  132.      *
  133.      * @return ReferrerCollection
  134.      */
  135.     public function createReferrerCollection($document)
  136.     {
  137.         $node = $this->registry->getNodeForDocument($document);
  138.         $locale = $this->registry->getOriginalLocaleForDocument($document);
  140.         return new ReferrerCollection(
  141.             $node,
  142.             $this->dispatcher,
  143.             $locale
  144.         );
  145.     }
  146. }