Tutorial: Calculator plugin

Last updated:
Edit on GitHub

This tutorial explains how to add a new calculation plugin to the calculator stack.

Requirement: display the tax amount per item.

You can get the tax amount from grandTotal. For this, add a new calculator to the existing stack for the module:

  1. First, there are some data structure changes that you need to make. Modify the ItemTransfer object by adding two new properties:
  • unitTaxAmount—for a single item.
  • sumTaxAmount—tax amount for the sum of items.
  1. As this is tax-related, you have to add it on a project level in the Tax module.

Modify the tax.transfer.xml transfer object to reflect the new data model. Add the following changes to the Pyz/Shared/Tax/Transfer/tax.transfer.xml file:

<transfer name="Item">
     <property name="unitTaxAmount" type="int" />
     <property name="sumTaxAmount" type="int" />
 </transfer>
  1. Run the following console command:
vendor/bin/console transfer:generate

Two new properties appear in the ItemTransfer.

  1. Create a new calculator plugin and register it to the calculator plugin stack.

In the Pyz/Zed/Tax namespace, create a new module if it does not exist. Then, under Pyz/Zed/Tax/Communication/Plugin/ItemTaxAmountCalculatorPlugin, create a new plugin class, as you see in the following example:

<?php
namespace Pyz\Zed\Tax\Communication\Plugin;

use Generated\Shared\Transfer\CalculableObjectTransfer;
use Spryker\Zed\Kernel\Communication\AbstractPlugin;
use Spryker\Zed\CalculationExtension\Dependency\Plugin\CalculationPluginInterface;

/**
 * @method \Spryker\Zed\Tax\Business\TaxFacade getFacade()
 */
class ItemTaxAmountCalculatorPlugin extends AbstractPlugin implements CalculationPluginInterface
{
    /**
     * @param \Generated\Shared\Transfer\CalculableObjectTransfer $calculableObjectTransfer
     *
     * @return void
     */
    public function recalculate(CalculableObjectTransfer $calculableObjectTransfer)
    {
        $this->getFacade()->calculateItemTax($calculableObjectTransfer);
    }
}
  1. Add a new plugin to the calculator stack Pyz\Zed\Calculation\CalculationDependencyProvider::getQuoteCalculatorPluginStack():
<?php
   protected function getQuoteCalculatorPluginStack(Container $container)
   {
       return [
           // ... other plugins add this to place where required amounts are already calculated, for example after ItemCalculator.
           new ItemTaxAmountCalculatorPlugin(),
       ];
   }
  1. Add a new facade method: Pyz\Zed\Tax\TaxFacade::calculateItemTax() and create the TaxFacade class extending Spryker Core TaxFacade if it is not present.
<?php
    /**
      * @param \Generated\Shared\Transfer\CalculableObjectTransfer $calculableObjectTransfer
      *
      * @return void
      */
   public function calculateItemTax(CalculableObjectTransfer $calculableObjectTransfer)
   {
       $this->getFactory()->createItemTaxCalculator()->recalculate($calculableObjectTransfer);
   }
  1. Create the ItemTaxCalculator that implements the tax calculation business logic. Place this class under \Pyz\Zed\Calculation\Business\Model\ItemTaxCalculator.
<?php
namespace Pyz\Zed\Tax\Business\Model;

use Generated\Shared\Transfer\CalculableObjectTransfer;

class ItemTaxCalculator
{
    /**
     * @param \Generated\Shared\Transfer\CalculableObjectTransfer $calculableObjectTransfer
     *
     * @return void
     */
    public function recalculate(CalculableObjectTransfer $calculableObjectTransfer)
    {
        //tax calculator business logic
    }
}
  1. Add a new factory method for the new calculator to Pyz\Zed\Tax\Business\TaxBusinessFactory. Create the factory class if it does not exist, extending the Spryker Core factory.
<?php
/**
    * @return \Pyz\Zed\Tax\Business\Model\ItemTaxCalculator
    */
   protected function createItemTaxCalculator()
   {
       return new ItemTaxCalculator();
   }

That’s it! The new calculator plugin is added to the calculator stack.