vendor/metamodels/core/src/Factory.php line 143

Open in your IDE?
  1. <?php
  3. /**
  4.  * This file is part of MetaModels/core.
  5.  *
  6.  * (c) 2012-2019 The MetaModels team.
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  *
  11.  * This project is provided in good faith and hope to be usable by anyone.
  12.  *
  13.  * @package    MetaModels/core
  14.  * @author     Christian Schiffler <c.schiffler@cyberspectrum.de>
  15.  * @author     David Maack <david.maack@arcor.de>
  16.  * @author     Sven Baumann <baumann.sv@gmail.com>
  17.  * @copyright  2012-2019 The MetaModels team.
  18.  * @license    https://github.com/MetaModels/core/blob/master/LICENSE LGPL-3.0-or-later
  19.  * @filesource
  20.  */
  22. namespace MetaModels;
  24. use MetaModels\Events\CollectMetaModelTableNamesEvent;
  25. use MetaModels\Events\CreateMetaModelEvent;
  26. use MetaModels\Events\GetMetaModelNameFromIdEvent;
  27. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  29. /**
  30.  * This is the MetaModel factory interface.
  31.  *
  32.  * To create a MetaModel instance, call @link{MetaModelFactory::getMetaModel()}
  33.  */
  34. class Factory implements IFactory
  35. {
  36.     /**
  37.      * The event dispatcher.
  38.      *
  39.      * @var EventDispatcherInterface
  40.      */
  41.     private $dispatcher;
  43.     /**
  44.      * The service container.
  45.      *
  46.      * @var IMetaModelsServiceContainer
  47.      */
  48.     private $serviceContainer;
  50.     /**
  51.      * The already translated MetaModel names.
  52.      *
  53.      * @var string[]
  54.      */
  55.     private $lookupMap = array();
  57.     /**
  58.      * Create a new instance.
  59.      *
  60.      * @param EventDispatcherInterface $dispatcher The event dispatcher.
  61.      */
  62.     public function __construct(EventDispatcherInterface $dispatcher)
  63.     {
  64.         $this->dispatcher = $dispatcher;
  65.     }
  67.     /**
  68.      * Set the service container.
  69.      *
  70.      * @param IMetaModelsServiceContainer $serviceContainer The service container to use.
  71.      *
  72.      * @return Factory
  73.      *
  74.      * @deprecated The service container will get removed, use the symfony service container instead.
  75.      */
  76.     public function setServiceContainer(IMetaModelsServiceContainer $serviceContainer, $deprecationNotice = true)
  77.     {
  78.         if ($deprecationNotice) {
  79.             // @codingStandardsIgnoreStart
  80.             @trigger_error(
  81.                 '"' .__METHOD__ . '" is deprecated and will get removed.',
  82.                 E_USER_DEPRECATED
  83.             );
  84.             // @codingStandardsIgnoreEnd
  85.         }
  87.         $this->serviceContainer = $serviceContainer;
  89.         return $this;
  90.     }
  92.     /**
  93.      * Retrieve the service container.
  94.      *
  95.      * @return IMetaModelsServiceContainer
  96.      *
  97.      * @deprecated The service container will get removed, use the symfony service container instead.
  98.      */
  99.     public function getServiceContainer()
  100.     {
  101.         // @codingStandardsIgnoreStart
  102.         @trigger_error(
  103.             '"' .__METHOD__ . '" is deprecated - use the services from the service container.',
  104.             E_USER_DEPRECATED
  105.         );
  106.         // @codingStandardsIgnoreEnd
  107.         return $this->serviceContainer;
  108.     }
  110.     /**
  111.      * {@inheritdoc}
  112.      */
  113.     public function translateIdToMetaModelName($metaModelId)
  114.     {
  115.         if (!isset($this->lookupMap[$metaModelId])) {
  116.             $event = new GetMetaModelNameFromIdEvent($metaModelId);
  118.             $this->dispatcher->dispatch($event::NAME, $event);
  120.             $this->lookupMap[$metaModelId] = $event->getMetaModelName();
  121.         }
  123.         return $this->lookupMap[$metaModelId];
  124.     }
  126.     /**
  127.      * {@inheritdoc}
  128.      */
  129.     public function getMetaModel($metaModelName)
  130.     {
  131.         $event = new CreateMetaModelEvent($this, $metaModelName);
  133.         $this->dispatcher->dispatch($event::NAME, $event);
  135.         $metaModel = $event->getMetaModel();
  137.         return $metaModel;
  138.     }
  140.     /**
  141.      * {@inheritdoc}
  142.      */
  143.     public function collectNames()
  144.     {
  145.         $event = new CollectMetaModelTableNamesEvent($this);
  147.         $this->dispatcher->dispatch($event::NAME, $event);
  149.         return $event->getMetaModelNames();
  150.     }
  151. }