vendor/pimcore/pimcore/lib/Targeting/DataLoader.php line 42

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Commercial License (PCL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  16.  */
  18. namespace Pimcore\Targeting;
  20. use Pimcore\Debug\Traits\StopwatchTrait;
  21. use Pimcore\Targeting\DataProvider\DataProviderInterface;
  22. use Pimcore\Targeting\Model\VisitorInfo;
  23. use Psr\Container\ContainerInterface;
  25. class DataLoader implements DataLoaderInterface
  26. {
  27.     use StopwatchTrait;
  29.     /**
  30.      * @var ContainerInterface
  31.      */
  32.     private $dataProviders;
  34.     public function __construct(ContainerInterface $dataProviders)
  35.     {
  36.         $this->dataProviders = $dataProviders;
  37.     }
  39.     /**
  40.      * {@inheritdoc}
  41.      */
  42.     public function loadDataFromProviders(VisitorInfo $visitorInfo, $providerKeys)
  43.     {
  44.         if (!is_array($providerKeys)) {
  45.             $providerKeys = [(string)$providerKeys];
  46.         }
  48.         foreach ($providerKeys as $providerKey) {
  49.             $loadedProviders = $visitorInfo->get('_data_providers', []);
  51.             // skip already loaded providers to avoid circular reference loops
  52.             if (in_array($providerKey, $loadedProviders)) {
  53.                 continue;
  54.             }
  56.             $loadedProviders[] = $providerKey;
  57.             $visitorInfo->set('_data_providers', $loadedProviders);
  59.             $dataProvider = $this->dataProviders->get($providerKey);
  61.             // load data from required providers
  62.             if ($dataProvider instanceof DataProviderDependentInterface) {
  63.                 $this->loadDataFromProviders(
  64.                     $visitorInfo,
  65.                     $dataProvider->getDataProviderKeys()
  66.                 );
  67.             }
  69.             $this->startStopwatch('Targeting:load:' . $providerKey, 'targeting');
  71.             $dataProvider->load($visitorInfo);
  73.             $this->stopStopwatch('Targeting:load:' . $providerKey);
  74.         }
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      */
  80.     public function hasDataProvider(string $type): bool
  81.     {
  82.         return $this->dataProviders->has($type);
  83.     }
  85.     /**
  86.      * {@inheritdoc}
  87.      */
  88.     public function getDataProvider(string $type): DataProviderInterface
  89.     {
  90.         if (!$this->dataProviders->has($type)) {
  91.             throw new \InvalidArgumentException(sprintf(
  92.                 'There is no data provider registered for type "%s"',
  93.                 $type
  94.             ));
  95.         }
  97.         return $this->dataProviders->get($type);
  98.     }
  99. }