vendor/shopware/storefront/Page/Product/Review/ProductReviewLoader.php line 47

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Page\Product\Review;
  5. use Shopware\Core\Content\Product\Aggregate\ProductReview\ProductReviewEntity;
  6. use Shopware\Core\Content\Product\SalesChannel\Review\AbstractProductReviewRoute;
  7. use Shopware\Core\Content\Product\SalesChannel\Review\RatingMatrix;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Exception\InconsistentCriteriaIdsException;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Search\Aggregation\Bucket\FilterAggregation;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Search\Aggregation\Bucket\TermsAggregation;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Search\AggregationResult\Bucket\TermsResult;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\MultiFilter;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\RangeFilter;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\Sorting\FieldSorting;
  17. use Shopware\Core\Framework\Log\Package;
  18. use Shopware\Core\Framework\Routing\Exception\MissingRequestParameterException;
  19. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  20. use Shopware\Storefront\Framework\Page\StorefrontSearchResult;
  21. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  22. use Symfony\Component\HttpFoundation\Request;
  24. #[Package('storefront')]
  25. class ProductReviewLoader
  26. {
  27.     private const LIMIT = 10;
  28.     private const DEFAULT_PAGE = 1;
  29.     private const FILTER_LANGUAGE = 'filter-language';
  31.     /**
  32.      * @internal
  33.      */
  34.     public function __construct(
  35.         private readonly AbstractProductReviewRoute $route,
  36.         private readonly EventDispatcherInterface $eventDispatcher
  37.     ) {
  38.     }
  40.     /**
  41.      * load reviews for one product. The request must contain the productId
  42.      * otherwise MissingRequestParameterException is thrown
  43.      *
  44.      * @throws MissingRequestParameterException
  45.      * @throws InconsistentCriteriaIdsException
  46.      */
  47.     public function load(Request $request, SalesChannelContext $context): ReviewLoaderResult
  48.     {
  49.         $productId = $request->get('parentId') ?? $request->get('productId');
  50.         if (!$productId) {
  51.             throw new MissingRequestParameterException('productId');
  52.         }
  54.         $criteria = $this->createCriteria($request, $context);
  56.         $reviews = $this->route
  57.             ->load($productId, $request, $context, $criteria)
  58.             ->getResult();
  60.         $reviews = StorefrontSearchResult::createFrom($reviews);
  62.         $this->eventDispatcher->dispatch(new ProductReviewsLoadedEvent($reviews, $context, $request));
  64.         $reviewResult = ReviewLoaderResult::createFrom($reviews);
  65.         $reviewResult->setProductId($request->get('productId'));
  66.         $reviewResult->setParentId($request->get('parentId'));
  68.         $aggregation = $reviews->getAggregations()->get('ratingMatrix');
  69.         $matrix = new RatingMatrix([]);
  71.         if ($aggregation instanceof TermsResult) {
  72.             $matrix = new RatingMatrix($aggregation->getBuckets());
  73.         }
  74.         $reviewResult->setMatrix($matrix);
  75.         $reviewResult->setCustomerReview($this->getCustomerReview($productId, $context));
  76.         $reviewResult->setTotalReviews($matrix->getTotalReviewCount());
  78.         return $reviewResult;
  79.     }
  81.     private function createCriteria(Request $request, SalesChannelContext $context): Criteria
  82.     {
  83.         $limit = (int) $request->get('limit', self::LIMIT);
  84.         $page = (int) $request->get('p', self::DEFAULT_PAGE);
  85.         $offset = $limit * ($page - 1);
  87.         $criteria = new Criteria();
  88.         $criteria->setLimit($limit);
  89.         $criteria->setOffset($offset);
  90.         $criteria->setTotalCountMode(Criteria::TOTAL_COUNT_MODE_EXACT);
  92.         $sorting = new FieldSorting('createdAt', 'DESC');
  93.         if ($request->get('sort', 'createdAt') === 'points') {
  94.             $sorting = new FieldSorting('points', 'DESC');
  95.         }
  97.         $criteria->addSorting($sorting);
  99.         if ($request->get('language') === self::FILTER_LANGUAGE) {
  100.             $criteria->addPostFilter(
  101.                 new EqualsFilter('languageId', $context->getContext()->getLanguageId())
  102.             );
  103.         }
  105.         $this->handlePointsAggregation($request, $criteria, $context);
  107.         return $criteria;
  108.     }
  110.     /**
  111.      * get review by productId and customer
  112.      * a customer should only create one review per product, so if there are more than one
  113.      * review we only take one
  114.      *
  115.      * @throws InconsistentCriteriaIdsException
  116.      */
  117.     private function getCustomerReview(string $productId, SalesChannelContext $context): ?ProductReviewEntity
  118.     {
  119.         $customer = $context->getCustomer();
  121.         if (!$customer) {
  122.             return null;
  123.         }
  125.         $criteria = new Criteria();
  126.         $criteria->setLimit(1);
  127.         $criteria->setOffset(0);
  128.         $criteria->addFilter(new EqualsFilter('customerId', $customer->getId()));
  130.         $customerReviews = $this->route
  131.             ->load($productId, new Request(), $context, $criteria)
  132.             ->getResult();
  134.         return $customerReviews->first();
  135.     }
  137.     private function handlePointsAggregation(Request $request, Criteria $criteria, SalesChannelContext $context): void
  138.     {
  139.         $reviewFilters = [];
  140.         $points = $request->get('points', []);
  142.         if (\is_array($points) && \count($points) > 0) {
  143.             $pointFilter = [];
  144.             foreach ($points as $point) {
  145.                 $pointFilter[] = new RangeFilter('points', [
  146.                     'gte' => $point - 0.5,
  147.                     'lt' => $point + 0.5,
  148.                 ]);
  149.             }
  151.             $criteria->addPostFilter(new MultiFilter(MultiFilter::CONNECTION_OR, $pointFilter));
  152.         }
  154.         $reviewFilters[] = new EqualsFilter('status', true);
  155.         if ($context->getCustomer() !== null) {
  156.             $reviewFilters[] = new EqualsFilter('customerId', $context->getCustomer()->getId());
  157.         }
  159.         $criteria->addAggregation(
  160.             new FilterAggregation(
  161.                 'customer-login-filter',
  162.                 new TermsAggregation('ratingMatrix', 'points'),
  163.                 [
  164.                     new MultiFilter(MultiFilter::CONNECTION_OR, $reviewFilters),
  165.                 ]
  166.             )
  167.         );
  168.     }
  169. }