src/Twig/TrackingExtension.php line 102

Open in your IDE?
  1. <?php
  3. namespace App\Twig;
  5. use App\Entity\Main\Tracking;
  6. use App\Entity\Main\TrackingHasABTest;
  7. use App\EventListener\Main\DebugListener;
  8. use App\Services\TrackingManager;
  9. use Twig\Extension\AbstractExtension;
  10. use Symfony\Component\HttpFoundation\RequestStack;
  11. use Twig\TwigFunction;
  13. /**
  14.  * Class TrackingExtension
  15.  * @package App\Twig
  16.  */
  17. class TrackingExtension extends AbstractExtension
  18. {
  19.     protected $session;
  21.     /**
  22.      * @var RequestStack
  23.      */
  24.     protected $requestStack;
  26.     protected $trackingManager;
  28.     protected $trackingFactory;
  30.     protected $allowedDebugIp;
  32.     protected $environment;
  34.     /**
  35.      * TrackingExtension constructor.
  36.      * @param RequestStack $requestStack
  37.      * @param TrackingManager $trackingFactory
  38.      * @param array $allowedDebugIp
  39.      * @param string $environment
  40.      */
  41.     public function __construct(RequestStack $requestStack, TrackingManager $trackingFactory, $allowedDebugIp = [], $environment = 'prod')
  42.     {
  43.         if ($requestStack->getCurrentRequest()) {
  44.             $this->session = $requestStack->getCurrentRequest()->getSession();
  45.         }
  46.         $this->requestStack = $requestStack;
  47.         $this->trackingFactory = $trackingFactory;
  48.         $this->allowedDebugIp = $allowedDebugIp;
  49.         $this->environment = $environment;
  50.     }
  51.     
  52.     /**
  53.      * @return array
  54.      */
  55.     public function getFunctions(): array
  56.     {
  57.         return array(
  58.             new TwigFunction('getTrackingDebug', array($this, 'getTrackingDebug')),
  59.             new TwigFunction('getTrackingComment', array($this, 'getTrackingComment')),
  60.         );
  61.     }
  63.     /**
  64.      * Used to display tracking to the autorised Ips
  65.      * @return string
  66.      */
  67.     public function getTrackingDebug(Tracking $tracking = null, $class = null)
  68.     {
  69.         if (!$this->isAllowedToSeeDebug()) {
  70.             return;
  71.         }
  73.         $debug = $this->getTrackingString($tracking);
  75.         return "<div class=\"topnav {$class}\" style='background-color: darkgrey;overflow: hidden; position: fixed; left: 0; bottom: 40px'>debug : {$debug}</div>";
  76.     }
  78.     /**
  79.      * Used to inject tracking data in the html
  80.      * @return string
  81.      */
  82.     public function getTrackingComment(Tracking $tracking = null)
  83.     {
  84.         if (!$this->isAllowedToSeeDebug()) {
  85.             return;
  86.         }
  88.         $comment = $this->getTrackingString($tracking);
  90.         return "<!-- {$comment} -->";
  91.     }
  93.     /**
  94.      * @return bool|string
  95.      */
  96.     private function getTrackingString(Tracking $tracking)
  97.     {
  98.         // put the debug in there :)
  99.         $debug = "Aff : " . $this->trackingFactory->resolveAffiliate($tracking)->getAffiliateId();
  100.         $debug .= ", trid : " . $tracking->getTrackingId();
  101.         $debug .= ", Device : " . $tracking->getDevice();
  102.         $debug .= ", dcode: " . $this->session->get('dcode');
  104.         if (count($tracking->getAbTests())) {
  105.             $debug .= ", AB Tests = ";
  106.             /** @var TrackingHasABTest $trackingHasAbtest */
  107.             foreach ($tracking->getAbTests() as $trackingHasAbtest) {
  108.                 $debug .= $trackingHasAbtest->getVersion() . " - ";
  109.             }
  110.         }
  112.         $forcedABTests = $this->session->get(DebugListener::DEBUG_DATA_SESSION)[DebugListener::DEBUG_FORCED_ABTESTS] ?? [];
  114.         if (count($forcedABTests)) {
  115.             $debug .= ", Forced AB Tests = ";
  116.             /** @var TrackingHasABTest $trackingHasAbtest */
  117.             foreach ($forcedABTests as $forcedABTest) {
  118.                 $debug .= $forcedABTest . " - ";
  119.             }
  120.         }
  122.         // check for 3ds.
  123.         if ($this->session->get('force_3ds')) {
  124.             $debug .= ", Forced 3DS = true";
  125.         } else {
  126.             $debug .= ", Forced 3DS = false";
  127.         }
  129.         return $debug;
  130.     }
  132.     /**
  133.      * @return bool
  134.      */
  135.     private function isAllowedToSeeDebug()
  136.     {
  137.         $debugAllowed = false;
  139.         if (in_array($this->requestStack->getCurrentRequest()->getClientIp(), $this->allowedDebugIp) || in_array($this->environment, ['test', 'dev'])) {
  140.             $debugAllowed = true;
  141.         }
  143.         return $debugAllowed;
  144.     }
  146.     public function getName()
  147.     {
  148.         return 'tracking_extension';
  149.     }
  150. }