vendor/shopware/storefront/Page/Product/Review/RatingMatrix.php line 8

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Page\Product\Review;
  5. use Shopware\Core\Framework\DataAbstractionLayer\Search\AggregationResult\Bucket\Bucket;
  6. use Shopware\Core\Framework\Struct\Struct;
  8. class RatingMatrix extends Struct
  9. {
  10.     private const MAX_POINTS = 5;
  12.     /**
  13.      * @var MatrixElement[]
  14.      */
  15.     protected $matrix = [];
  17.     /**
  18.      * @var int
  19.      */
  20.     protected $totalReviewCount = 0;
  22.     /**
  23.      * @var int
  24.      *
  25.      * @deprecated tag:v6.4.0 use $pointSum instead
  26.      */
  27.     protected $totalPoints = 0;
  29.     /**
  30.      * @var float
  31.      */
  32.     protected $pointSum = 0;
  34.     /**
  35.      * we expect an array of CountResult elements
  36.      * we are doing all calculation in constructor
  37.      *
  38.      * @param Bucket[] $matrix
  39.      */
  40.     public function __construct(array $matrix)
  41.     {
  42.         for ($points = self::MAX_POINTS; $points > 0; --$points) {
  43.             foreach ($matrix as $rating) {
  44.                 $rawRatingKey = (float) $rating->getKey();
  46.                 if ($points === (int) round($rawRatingKey)) {
  47.                     $this->totalPoints += ($points * $rating->getCount());
  48.                     $this->pointSum += ($rawRatingKey * $rating->getCount());
  50.                     $this->totalReviewCount += $rating->getCount();
  52.                     $previousCount = isset($this->matrix[$points]) ? $this->matrix[$points]->getCount() : 0;
  53.                     $this->matrix[$points] = new MatrixElement($points, $rating->getCount() + $previousCount);
  54.                 }
  55.             }
  57.             if (!array_key_exists($points, $this->matrix)) {
  58.                 $this->matrix[$points] = new MatrixElement($points, 0);
  59.             }
  60.         }
  62.         array_walk($this->matrix, function (MatrixElement &$rating): void {
  63.             if ($this->totalReviewCount > 0) {
  64.                 $rating->setPercent($rating->getCount() / $this->totalReviewCount * 100);
  65.             } else {
  66.                 $rating->setPercent(0);
  67.             }
  68.         });
  69.     }
  71.     public function getMatrix(): array
  72.     {
  73.         return $this->matrix;
  74.     }
  76.     public function getTotalReviewCount(): int
  77.     {
  78.         return $this->totalReviewCount;
  79.     }
  81.     /**
  82.      * @deprecated tag:v6.4.0 use the getPointSum() method instead
  83.      */
  84.     public function getTotalPoints(): int
  85.     {
  86.         return $this->totalPoints;
  87.     }
  89.     public function getPointSum(): float
  90.     {
  91.         return $this->pointSum;
  92.     }
  94.     public function getMaxPoints(): int
  95.     {
  96.         return self::MAX_POINTS;
  97.     }
  99.     public function getAverageRating(): float
  100.     {
  101.         if ($this->getPointSum() > 0) {
  102.             return $this->getPointSum() / $this->getTotalReviewCount();
  103.         }
  105.         return 0;
  106.     }
  107. }