CoreShop Transfomers

Transfomers, as the name say, transform Data from different formats. A transformer converts between Object Types. For example: Cart -> Order. Following implementation do exist right now:

• an Cart into an Order
• an Cart into an Quote
• an Order into an Invoice
• an Order into an Shipment

The base transformer interface for all "Proposals" is CoreShop\Component\Order\Transformer\ProposalTransformerInterface

Extending Transfomers

If you ever have the need to adapt the transfomer, eg. hook into it and store some custom data into the order, you can do so by decorating the default service. Following Services are used by CoreShop for all different Transfomers:

Example of extending

<?php

namespace AppBundle\CoreShop\Order\Transformer;

use CoreShop\Component\Core\Model\CartInterface;
use CoreShop\Component\Order\Model\ProposalInterface;
use CoreShop\Component\Order\Model\SaleInterface;
use CoreShop\Component\Order\Transformer\ProposalTransformerInterface;
use Webmozart\Assert\Assert;

final class CustomOrderTransfomer implements ProposalTransformerInterface
{
     /**
     * @var ProposalTransformerInterface
     */
    protected $innerCartToOrderTransformer;

    public function __construct(ProposalTransformerInterface $innerCartToOrderTransformer)
    {
        $this->innerCartToOrderTransformer = $innerCartToOrderTransformer;
    }

    public function transform(ProposalInterface $cart, ProposalInterface $sale)
    {
        Assert::isInstanceOf($cart, CartInterface::class);
        Assert::isInstanceOf($sale, SaleInterface::class);

        $sale = $this->innerCartToOrderTransformer->transform($cart, $sale);

        $cart->setCustomField($sale->getCustomField() * 100);
    }
}

Now we need to register our class the container set the decorator:

app.coreshop.order.transformer.cart_to_order:
    decorates: coreshop.order.transformer.cart_to_order
    class: AppBundle\CoreShop\Order\Transformer\CustomOrderTransformer
    arguments:
      - '@app.coreshop.order.transformer.cart_to_order.inner'

Everytime CoreShop now calls the Order Transformer, your CustomOrderTransfomer gets called as well.