vendor/pimcore/pimcore/bundles/EcommerceFrameworkBundle/Tracking/Tracker.php line 106

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Enterprise License (PEL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  12.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  13.  */
  15. namespace Pimcore\Bundle\EcommerceFrameworkBundle\Tracking;
  17. use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
  18. use Symfony\Component\OptionsResolver\OptionsResolver;
  20. abstract class Tracker implements TrackerInterface
  21. {
  22.     /**
  23.      * @var TrackingItemBuilderInterface
  24.      */
  25.     protected $trackingItemBuilder;
  27.     /**
  28.      * @var EngineInterface
  29.      */
  30.     protected $templatingEngine;
  32.     /**
  33.      * @var string
  34.      */
  35.     protected $templatePrefix;
  37.     /**
  38.      * @var string
  39.      */
  40.     protected $templateExtension;
  42.     /**
  43.      * @var array
  44.      */
  45.     protected $assortmentTenants;
  47.     /**
  48.      * @var array
  49.      */
  50.     protected $checkoutTenants;
  52.     /**
  53.      * Tracker constructor.
  54.      *
  55.      * @param TrackingItemBuilderInterface $trackingItemBuilder
  56.      * @param EngineInterface $templatingEngine
  57.      * @param array $options
  58.      * @param array $assortmentTenants
  59.      * @param array $checkoutTenants
  60.      */
  61.     public function __construct(
  62.         TrackingItemBuilderInterface $trackingItemBuilder,
  63.         EngineInterface $templatingEngine,
  64.         array $options = [],
  65.         $assortmentTenants = [],
  66.         $checkoutTenants = []
  67.     ) {
  68.         $this->trackingItemBuilder = $trackingItemBuilder;
  69.         $this->templatingEngine = $templatingEngine;
  71.         $resolver = new OptionsResolver();
  72.         $this->configureOptions($resolver);
  73.         $this->processOptions($resolver->resolve($options));
  75.         $this->assortmentTenants = $assortmentTenants;
  76.         $this->checkoutTenants = $checkoutTenants;
  77.     }
  79.     protected function processOptions(array $options)
  80.     {
  81.         $this->templatePrefix = $options['template_prefix'];
  82.         $this->templateExtension = $options['template_extension'];
  83.     }
  85.     protected function configureOptions(OptionsResolver $resolver)
  86.     {
  87.         $resolver->setRequired(['template_prefix', 'template_extension']);
  88.         $resolver->setDefaults([
  89.             'template_extension' => 'php',
  90.         ]);
  92.         $resolver->setAllowedTypes('template_prefix', 'string');
  93.         $resolver->setAllowedTypes('template_extension', 'string');
  94.     }
  96.     protected function getTemplatePath(string $name)
  97.     {
  98.         return sprintf(
  99.             '%s:%s.js.%s',
  100.             $this->templatePrefix,
  101.             $name,
  102.             $this->templateExtension
  103.         );
  104.     }
  106.     protected function renderTemplate(string $name, array $parameters): string
  107.     {
  108.         return $this->templatingEngine->render(
  109.             $this->getTemplatePath($name),
  110.             $parameters
  111.         );
  112.     }
  114.     /**
  115.      * Remove null values from an object, keep protected keys in any case
  116.      *
  117.      * @param array $data
  118.      * @param array $protectedKeys
  119.      *
  120.      * @return array
  121.      */
  122.     protected function filterNullValues(array $data, array $protectedKeys = [])
  123.     {
  124.         $result = [];
  125.         foreach ($data as $key => $value) {
  126.             $isProtected = in_array($key, $protectedKeys);
  127.             if (null !== $value || $isProtected) {
  128.                 $result[$key] = $value;
  129.             }
  130.         }
  132.         return $result;
  133.     }
  135.     /**
  136.      * @inheritdoc
  137.      */
  138.     public function getAssortmentTenants(): array
  139.     {
  140.         return $this->assortmentTenants;
  141.     }
  143.     /**
  144.      * @inheritdoc
  145.      */
  146.     public function getCheckoutTenants(): array
  147.     {
  148.         return $this->checkoutTenants;
  149.     }
  150. }