src/EventSubscriber/SourceSubscriber.php line 68

Open in your IDE?
  1. <?php
  3. namespace App\EventSubscriber;
  5. use App\Entity\Source;
  6. use App\Entity\User;
  7. use App\Entity\UserInterface;
  8. use App\Event\ObjectEvent;
  9. use App\Events;
  10. use Doctrine\Persistence\ManagerRegistry;
  11. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  12. use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
  13. use Symfony\Component\HttpFoundation\RequestStack;
  14. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  15. use Symfony\Component\HttpKernel\Event\RequestEvent;
  16. use Symfony\Component\HttpKernel\KernelEvents;
  18. /**
  19.  * Listens for user registration events and attaches a source entity to the user
  20.  * based on referral or UTM parameters found in the request query string.
  21.  *
  22.  * This subscriber stores the source identifier in the session during the initial
  23.  * request, then associates the matching Source entity to the User entity when the
  24.  * user is created.
  25.  *
  26.  * Supported query parameters:
  27.  * - ?source=SOURCE_ID
  28.  * - ?utm_source=UTM_IDENTIFIER
  29.  *
  30.  * Session key used: self::SESSION_NAME
  31.  */
  32. class SourceSubscriber implements EventSubscriberInterface
  33. {
  34.     public const SESSION_NAME = 'app_source_data';
  35.     public const SOURCE_PARAMETER = 'source';
  36.     public const UTM_PARAMETER = 'utm_source';
  38.     /** @var RequestStack */
  39.     private $requestStack;
  41.     /** @var ManagerRegistry */
  42.     private $managerRegistry;
  44.     /**
  45.      * @param RequestStack    $requestStack
  46.      * @param ManagerRegistry $managerRegistry
  47.      */
  48.     public function __construct(RequestStack $requestStack, ManagerRegistry $managerRegistry)
  49.     {
  50.         $this->requestStack = $requestStack;
  51.         $this->managerRegistry = $managerRegistry;
  52.     }
  54.     /**
  55.      * {@inheritdoc}
  56.      */
  57.     public static function getSubscribedEvents(): array
  58.     {
  59.         return [
  60.             KernelEvents::REQUEST => 'onKernelRequest',
  61.             Events::USER_CREATED => 'onUserCreated',
  62.         ];
  63.     }
  65.     /**
  66.      * @param RequestEvent $event
  67.      */
  68.     public function onKernelRequest(RequestEvent $event): void
  69.     {
  70.         if (!$event->isMainRequest()) {
  71.             return;
  72.         }
  74.         $request = $event->getRequest();
  76.         if ($request->isXmlHttpRequest()) {
  77.             return;
  78.         }
  80.         if (!$request->query->has(self::SOURCE_PARAMETER)
  81.             && !$request->query->has(self::UTM_PARAMETER)
  82.         ) {
  83.             return;
  84.         }
  86.         $request->getSession()->set(
  87.             self::SESSION_NAME,
  88.             $request->query->get(self::SOURCE_PARAMETER) ?: $request->query->get(self::UTM_PARAMETER)
  89.         );
  90.     }
  92.     /**
  93.      * @param ObjectEvent $event
  94.      */
  95.     public function onUserCreated(ObjectEvent $event): void
  96.     {
  97.         try {
  98.             /** @var SessionInterface $session */
  99.             $session = $this->requestStack->getSession();
  100.         } catch (SessionNotFoundException $e) {
  101.             return;
  102.         }
  104.         if (!$session->has(self::SESSION_NAME)) {
  105.             return;
  106.         }
  108.         /** @var Source|null $source */
  109.         $source = null;
  111.         // Find via ID (ref)
  112.         try {
  113.             $source = $this->managerRegistry
  114.                 ->getRepository(Source::class)
  115.                 ->find($session->get(self::SESSION_NAME));
  116.         } catch (\Exception $e) {
  117.         }
  119.         // Find via UTM_SOURCE
  120.         if (!$source) {
  121.             $source = $this->managerRegistry
  122.                 ->getRepository(Source::class)
  123.                 ->findOneBy([
  124.                     'utmSource' => $session->get(self::SESSION_NAME),
  125.                 ]);
  126.         }
  128.         if (!$source) {
  129.             return;
  130.         }
  132.         $entity = $event->getObject();
  134.         if ($entity instanceof UserInterface) {
  135.             $entity->setSource($source);
  137.             $this->managerRegistry
  138.                 ->getRepository(User::class)
  139.                 ->update($entity);
  140.         }
  142.         $session->remove(self::SESSION_NAME);
  143.     }
  144. }