vendor/ibexa/personalization/src/lib/Event/Subscriber/CustomizableDashboard/TopClickedItemsBlockSubscriber.php line 66

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. declare(strict_types=1);
  9. namespace Ibexa\Personalization\Event\Subscriber\CustomizableDashboard;
  11. use Ibexa\Contracts\Core\Exception\InvalidArgumentException;
  12. use Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException;
  13. use Ibexa\Contracts\FieldTypePage\FieldType\LandingPage\Model\BlockValue;
  14. use Ibexa\FieldTypePage\FieldType\Page\Block\Renderer\BlockRenderEvents;
  15. use Ibexa\FieldTypePage\FieldType\Page\Block\Renderer\Event\PreRenderEvent;
  16. use Ibexa\Personalization\Client\Consumer\Performance\PopularityDataFetcher;
  17. use Ibexa\Personalization\Form\Data\DashboardData;
  18. use Ibexa\Personalization\Form\Data\PopularityDurationChoiceData;
  19. use Ibexa\Personalization\Form\Type\Block\TopClickedItemsType;
  20. use Ibexa\Personalization\Security\Service\SecurityServiceInterface;
  21. use Ibexa\Personalization\Service\Performance\RecommendationPerformanceServiceInterface;
  22. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  23. use Symfony\Component\Form\FormFactoryInterface;
  24. use Symfony\Component\Form\FormInterface;
  25. use Symfony\Component\HttpFoundation\Request;
  26. use Symfony\Component\HttpFoundation\RequestStack;
  28. /**
  29.  * @internal
  30.  */
  31. final class TopClickedItemsBlockSubscriber implements EventSubscriberInterface
  32. {
  33.     private const BLOCK_IDENTIFIER = 'top_clicked_items';
  35.     private RecommendationPerformanceServiceInterface $recommendationPerformanceService;
  37.     private FormFactoryInterface $formFactory;
  39.     private RequestStack $requestStack;
  41.     private SecurityServiceInterface $securityService;
  43.     public function __construct(
  44.         RecommendationPerformanceServiceInterface $recommendationPerformanceService,
  45.         FormFactoryInterface $formFactory,
  46.         RequestStack $requestStack,
  47.         SecurityServiceInterface $securityService
  48.     ) {
  49.         $this->formFactory = $formFactory;
  50.         $this->recommendationPerformanceService = $recommendationPerformanceService;
  51.         $this->requestStack = $requestStack;
  52.         $this->securityService = $securityService;
  53.     }
  55.     public static function getSubscribedEvents(): array
  56.     {
  57.         return [
  58.             BlockRenderEvents::getBlockPreRenderEventName(self::BLOCK_IDENTIFIER) => ['onBlockPreRender', -100],
  59.         ];
  60.     }
  62.     /**
  63.      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
  64.      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
  65.      */
  66.     public function onBlockPreRender(PreRenderEvent $event): void
  67.     {
  68.         $blockValue = $event->getBlockValue();
  69.         $customerId = $this->getCustomerId($blockValue);
  71.         try {
  72.             $this->securityService->checkAcceptanceStatus();
  73.         } catch (UnauthorizedException $exception) {
  74.             $this->handleNoPermissionException($event);
  76.             return;
  77.         }
  79.         $form = $this->buildDurationSelectorForm($blockValue->getId());
  80.         // current request is a block-rendering sub-request - we expect form submission data on the main request
  81.         $form->handleRequest($this->requestStack->getMainRequest());
  83.         $dashboardFormData = $form->getData();
  84.         $popularityDuration = $dashboardFormData->getPopularity()->getDuration();
  86.         /** @var \Ibexa\FieldTypePage\FieldType\Page\Block\Renderer\Twig\TwigRenderRequest $twigRenderRequest */
  87.         $twigRenderRequest = $event->getRenderRequest();
  88.         $twigRenderRequest->addParameter('form', $form->createView());
  89.         $twigRenderRequest->addParameter(
  90.             'popularity_list',
  91.             $this->recommendationPerformanceService->getPopularityList(
  92.                 $customerId,
  93.                 $popularityDuration
  94.             ),
  95.         );
  96.     }
  98.     private function buildDurationSelectorForm(string $blockId): FormInterface
  99.     {
  100.         $dashboardTimePeriodData = new DashboardData();
  101.         $dashboardTimePeriodData->setPopularity(
  102.             (new PopularityDurationChoiceData())->setDuration(PopularityDataFetcher::DURATION_24H)
  103.         );
  105.         return $this->formFactory->createNamed(
  106.             "top-clicked-items-$blockId",
  107.             TopClickedItemsType::class,
  108.             $dashboardTimePeriodData,
  109.             [
  110.                 'method' => Request::METHOD_GET,
  111.             ]
  112.         );
  113.     }
  115.     /**
  116.      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
  117.      */
  118.     private function getCustomerId(BlockValue $blockValue): int
  119.     {
  120.         $attribute = $blockValue->getAttribute('customer_id');
  121.         if (null === $attribute || $attribute->getValue() === null) {
  122.             throw new InvalidArgumentException('$blockValue', 'Personalization Customer ID has not been configured');
  123.         }
  125.         return (int)$attribute->getValue();
  126.     }
  128.     private function handleNoPermissionException(PreRenderEvent $event): void
  129.     {
  130.         /** @var \Ibexa\FieldTypePage\FieldType\Page\Block\Renderer\Twig\TwigRenderRequest $twigRenderRequest */
  131.         $twigRenderRequest = $event->getRenderRequest();
  132.         $twigRenderRequest->addParameter('block_name', $event->getBlockValue()->getName());
  133.         $twigRenderRequest->setTemplate(
  134.             '@ibexadesign/personalization/dashboard/blocks/errors/no_permission.html.twig'
  135.         );
  136.     }
  137. }