vendor/pimcore/pimcore/bundles/EcommerceFrameworkBundle/PriceSystem/AbstractPriceSystem.php line 59

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Commercial License (PCL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  16.  */
  18. namespace Pimcore\Bundle\EcommerceFrameworkBundle\PriceSystem;
  20. use Pimcore\Bundle\EcommerceFrameworkBundle\CartManager\CartPriceModificator\CartPriceModificatorInterface;
  21. use Pimcore\Bundle\EcommerceFrameworkBundle\Model\CheckoutableInterface;
  22. use Pimcore\Bundle\EcommerceFrameworkBundle\PriceSystem\TaxManagement\TaxCalculationService;
  23. use Pimcore\Bundle\EcommerceFrameworkBundle\PriceSystem\TaxManagement\TaxEntry;
  24. use Pimcore\Bundle\EcommerceFrameworkBundle\PricingManager\PricingManagerInterface;
  25. use Pimcore\Bundle\EcommerceFrameworkBundle\PricingManager\PricingManagerLocatorInterface;
  26. use Pimcore\Model\DataObject\OnlineShopTaxClass;
  27. use Pimcore\Model\WebsiteSetting;
  29. abstract class AbstractPriceSystem implements PriceSystemInterface
  30. {
  31.     /**
  32.      * @var PricingManagerLocatorInterface
  33.      */
  34.     protected $pricingManagers;
  36.     public function __construct(PricingManagerLocatorInterface $pricingManagers)
  37.     {
  38.         $this->pricingManagers = $pricingManagers;
  39.     }
  41.     /**
  42.      * {@inheritdoc}
  43.      */
  44.     public function getPriceInfo(CheckoutableInterface $product, $quantityScale = null, $products = null): PriceInfoInterface
  45.     {
  46.         return $this->initPriceInfoInstance($quantityScale, $product, $products);
  47.     }
  49.     /**
  50.      * Returns shop-instance specific implementation of priceInfo, override this method in your own price system to
  51.      * set any price values
  52.      *
  53.      * @param null|int|string $quantityScale Numeric or string (allowed values: PriceInfoInterface::MIN_PRICE)
  54.      * @param CheckoutableInterface $product
  55.      * @param CheckoutableInterface[] $products
  56.      *
  57.      * @return PriceInfoInterface
  58.      */
  59.     protected function initPriceInfoInstance($quantityScale, CheckoutableInterface $product, $products)
  60.     {
  61.         $priceInfo = $this->createPriceInfoInstance($quantityScale, $product, $products);
  63.         if ($quantityScale !== PriceInfoInterface::MIN_PRICE) {
  64.             $priceInfo->setQuantity($quantityScale);
  65.         }
  67.         $priceInfo->setProduct($product);
  68.         $priceInfo->setProducts($products);
  69.         $priceInfo->setPriceSystem($this);
  71.         // apply pricing rules
  72.         $priceInfoWithRules = $this->getPricingManager()->applyProductRules($priceInfo);
  74.         return $priceInfoWithRules;
  75.     }
  77.     protected function getPricingManager(): PricingManagerInterface
  78.     {
  79.         return $this->pricingManagers->getPricingManager();
  80.     }
  82.     /**
  83.      * @param null|int|string $quantityScale Numeric or string (allowed values: PriceInfoInterface::MIN_PRICE)
  84.      * @param CheckoutableInterface $product
  85.      * @param CheckoutableInterface[] $products
  86.      *
  87.      * @return AbstractPriceInfo
  88.      */
  89.     abstract public function createPriceInfoInstance($quantityScale, CheckoutableInterface $product, $products);
  91.     /**
  92.      * Sample implementation for getting the correct OnlineShopTaxClass. In this case Tax Class is retrieved from
  93.      * Website Setting and if no Website Setting is set it creates an empty new Tax Class.
  94.      *
  95.      * Should be overwritten in custom price systems with suitable implementation.
  96.      *
  97.      * @return OnlineShopTaxClass
  98.      */
  99.     protected function getDefaultTaxClass()
  100.     {
  101.         $taxClass = WebsiteSetting::getByName('defaultTaxClass');
  103.         if ($taxClass) {
  104.             $taxClass = $taxClass->getData();
  105.         }
  107.         if (empty($taxClass)) {
  108.             $taxClass = new OnlineShopTaxClass();
  109.             $taxClass->setTaxEntryCombinationType(TaxEntry::CALCULATION_MODE_COMBINE);
  110.         }
  112.         return $taxClass;
  113.     }
  115.     /**
  116.      * Returns OnlineShopTaxClass for given CheckoutableInterface.
  117.      *
  118.      * @param CheckoutableInterface $product
  119.      *
  120.      * @return OnlineShopTaxClass
  121.      */
  122.     public function getTaxClassForProduct(CheckoutableInterface $product)
  123.     {
  124.         return $this->getDefaultTaxClass();
  125.     }
  127.     /**
  128.      * Returns OnlineShopTaxClass for given CartPriceModificatorInterface
  129.      *
  130.      * @param CartPriceModificatorInterface $modificator
  131.      *
  132.      * @return OnlineShopTaxClass
  133.      */
  134.     public function getTaxClassForPriceModification(CartPriceModificatorInterface $modificator)
  135.     {
  136.         return $this->getDefaultTaxClass();
  137.     }
  139.     /**
  140.      * @return TaxCalculationService
  141.      */
  142.     protected function getTaxCalculationService()
  143.     {
  144.         return new TaxCalculationService();
  145.     }
  146. }