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

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\Log\Package;
  9. use Shopware\Core\Framework\Struct\Collection;
  10. use Shopware\Core\Framework\Util\FloatComparator;
  12. /**
  13.  * @extends Collection<CalculatedTax>
  14.  */
  15. #[Package('checkout')]
  16. class CalculatedTaxCollection extends Collection
  17. {
  18.     /**
  19.      * @param CalculatedTax $calculatedTax
  20.      */
  21.     public function add($calculatedTax): void
  22.     {
  23.         $this->set($this->getKey($calculatedTax), $calculatedTax);
  24.     }
  26.     /**
  27.      * @param string|int    $key
  28.      * @param CalculatedTax $calculatedTax
  29.      */
  30.     public function set($key, $calculatedTax): void
  31.     {
  32.         parent::set($this->getKey($calculatedTax), $calculatedTax);
  33.     }
  35.     public function removeElement(CalculatedTax $calculatedTax): void
  36.     {
  37.         $this->remove($this->getKey($calculatedTax));
  38.     }
  40.     public function exists(CalculatedTax $calculatedTax): bool
  41.     {
  42.         return $this->has($this->getKey($calculatedTax));
  43.     }
  45.     public function sortByTax(): CalculatedTaxCollection
  46.     {
  47.         $this->sort(function (CalculatedTax $a, CalculatedTax $b) {
  48.             return $a->getTaxRate() <=> $b->getTaxRate();
  49.         });
  51.         return $this;
  52.     }
  54.     /**
  55.      * Returns the total calculated tax for this item
  56.      */
  57.     public function getAmount(): float
  58.     {
  59.         $amounts = $this->map(
  60.             function (CalculatedTax $calculatedTax) {
  61.                 return $calculatedTax->getTax();
  62.             }
  63.         );
  65.         return FloatComparator::cast(array_sum($amounts));
  66.     }
  68.     /**
  69.      * @deprecated tag:v6.5.0 - keep parameter will be removed. Additionally the function always keeps the existing collection
  70.      */
  71.     public function merge(self $taxCollection, bool $keep = false): self
  72.     {
  73.         $new = $this;
  75.         //@deprecated tag:v6.5.0 remove complete if $new should be always $this
  76.         if (!$keep) {
  77.             Feature::triggerDeprecationOrThrow(
  78.                 'v6.5.0.0',
  79.                 \sprintf(
  80.                     '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.',
  81.                     __METHOD__,
  82.                     __CLASS__
  83.                 )
  84.             );
  86.             $new = new self($this->elements);
  87.         }
  89.         foreach ($taxCollection as $calculatedTax) {
  90.             $exists = $new->get($this->getKey($calculatedTax));
  91.             if (!$exists) {
  92.                 $new->add(clone $calculatedTax);
  94.                 continue;
  95.             }
  97.             $exists->increment($calculatedTax);
  98.         }
  100.         return $new;
  101.     }
  103.     public function round(CashRounding $rounding, CashRoundingConfig $config): void
  104.     {
  105.         foreach ($this->elements as $tax) {
  106.             $tax->setTax(
  107.                 $rounding->mathRound($tax->getTax(), $config)
  108.             );
  109.         }
  110.     }
  112.     public function getApiAlias(): string
  113.     {
  114.         return 'cart_tax_calculated_collection';
  115.     }
  117.     protected function getExpectedClass(): ?string
  118.     {
  119.         return CalculatedTax::class;
  120.     }
  122.     protected function getKey(CalculatedTax $element): string
  123.     {
  124.         return (string) $element->getTaxRate();
  125.     }
  126. }