vendor/shopware/core/Checkout/Cart/Tax/Struct/CalculatedTaxCollection.php line 14

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Cart\Tax\Struct;
  5. use Shopware\Core\Checkout\Cart\Price\CashRounding;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Pricing\CashRoundingConfig;
  7. use Shopware\Core\Framework\Feature;
  8. use Shopware\Core\Framework\Struct\Collection;
  9. use Shopware\Core\Framework\Util\FloatComparator;
  11. /**
  12.  * @extends Collection<CalculatedTax>
  13.  */
  14. class CalculatedTaxCollection extends Collection
  15. {
  16.     /**
  17.      * @param CalculatedTax $calculatedTax
  18.      */
  19.     public function add($calculatedTax): void
  20.     {
  21.         $this->set($this->getKey($calculatedTax), $calculatedTax);
  22.     }
  24.     /**
  25.      * @param string|int    $key
  26.      * @param CalculatedTax $calculatedTax
  27.      */
  28.     public function set($key, $calculatedTax): void
  29.     {
  30.         parent::set($this->getKey($calculatedTax), $calculatedTax);
  31.     }
  33.     public function removeElement(CalculatedTax $calculatedTax): void
  34.     {
  35.         $this->remove($this->getKey($calculatedTax));
  36.     }
  38.     public function exists(CalculatedTax $calculatedTax): bool
  39.     {
  40.         return $this->has($this->getKey($calculatedTax));
  41.     }
  43.     public function sortByTax(): CalculatedTaxCollection
  44.     {
  45.         $this->sort(function (CalculatedTax $a, CalculatedTax $b) {
  46.             return $a->getTaxRate() <=> $b->getTaxRate();
  47.         });
  49.         return $this;
  50.     }
  52.     /**
  53.      * Returns the total calculated tax for this item
  54.      */
  55.     public function getAmount(): float
  56.     {
  57.         $amounts = $this->map(
  58.             function (CalculatedTax $calculatedTax) {
  59.                 return $calculatedTax->getTax();
  60.             }
  61.         );
  63.         return FloatComparator::cast(array_sum($amounts));
  64.     }
  66.     /**
  67.      * @deprecated tag:v6.5.0 - keep parameter will be removed. Additionally the function always keeps the existing collection
  68.      */
  69.     public function merge(self $taxCollection, bool $keep = false): self
  70.     {
  71.         $new = $this;
  73.         //@deprecated tag:v6.5.0 remove complete if $new should be always $this
  74.         if (!$keep) {
  75.             Feature::triggerDeprecationOrThrow(
  76.                 'v6.5.0.0',
  77.                 \sprintf(
  78.                     'Passing second parameter `$keep` to method "%s" of class "%s" is deprecated, the parameter will be removed in v6.5.0.0. and the behaviour for $keep=true will be the default behaviour.',
  79.                     __METHOD__,
  80.                     __CLASS__
  81.                 )
  82.             );
  84.             $new = new self($this->elements);
  85.         }
  87.         foreach ($taxCollection as $calculatedTax) {
  88.             $exists = $new->get($this->getKey($calculatedTax));
  89.             if (!$exists) {
  90.                 $new->add(clone $calculatedTax);
  92.                 continue;
  93.             }
  95.             $exists->increment($calculatedTax);
  96.         }
  98.         return $new;
  99.     }
  101.     public function round(CashRounding $rounding, CashRoundingConfig $config): void
  102.     {
  103.         foreach ($this->elements as $tax) {
  104.             $tax->setTax(
  105.                 $rounding->mathRound($tax->getTax(), $config)
  106.             );
  107.         }
  108.     }
  110.     public function getApiAlias(): string
  111.     {
  112.         return 'cart_tax_calculated_collection';
  113.     }
  115.     protected function getExpectedClass(): ?string
  116.     {
  117.         return CalculatedTax::class;
  118.     }
  120.     protected function getKey(CalculatedTax $element): string
  121.     {
  122.         return (string) $element->getTaxRate();
  123.     }
  124. }