vendor/pimcore/pimcore/lib/Analytics/AbstractTracker.php line 50

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 Enterprise License (PEL)
  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 PEL
  16.  */
  18. namespace Pimcore\Analytics;
  20. use Pimcore\Analytics\Code\CodeCollector;
  21. use Pimcore\Analytics\SiteId\SiteId;
  22. use Pimcore\Analytics\SiteId\SiteIdProvider;
  24. abstract class AbstractTracker implements TrackerInterface
  25. {
  26.     /**
  27.      * @var SiteIdProvider
  28.      */
  29.     private $siteIdProvider;
  31.     /**
  32.      * @var CodeCollector
  33.      */
  34.     private $codeCollector;
  36.     public function __construct(SiteIdProvider $siteIdProvider)
  37.     {
  38.         $this->siteIdProvider = $siteIdProvider;
  39.     }
  41.     /**
  42.      * @inheritdoc
  43.      */
  44.     public function generateCode(SiteId $siteId = null)
  45.     {
  46.         if (null === $siteId) {
  47.             $siteId = $this->siteIdProvider->getForRequest();
  48.         }
  50.         return $this->buildCode($siteId);
  51.     }
  53.     /**
  54.      * Generates code for a specific site config
  55.      *
  56.      * @param SiteId $siteId
  57.      *
  58.      * @return string|null
  59.      */
  60.     abstract protected function buildCode(SiteId $siteId);
  62.     /**
  63.      * @inheritdoc
  64.      */
  65.     public function addCodePart(string $code, string $block = null, bool $prepend = false, SiteId $siteId = null)
  66.     {
  67.         $action = $prepend ? CodeCollector::ACTION_PREPEND : CodeCollector::ACTION_APPEND;
  69.         $this->getCodeCollector()->addCodePart($code, $block, $action, $siteId);
  70.     }
  72.     /**
  73.      * Lazy initialize the code collector
  74.      *
  75.      * @return CodeCollector
  76.      */
  77.     protected function getCodeCollector(): CodeCollector
  78.     {
  79.         if (null === $this->codeCollector) {
  80.             $this->codeCollector = $this->buildCodeCollector();
  81.         }
  83.         return $this->codeCollector;
  84.     }
  86.     /**
  87.      * Builds the code collector which allows to add additional content to
  88.      * specific blocks.
  89.      *
  90.      * @return CodeCollector
  91.      */
  92.     abstract protected function buildCodeCollector(): CodeCollector;
  93. }