Client.php

<?php

namespace Webburza\Sylius\GoogleEcommerceBundle;

use Sylius\Component\Core\Model\ChannelInterface as Channel;
use Sylius\Component\Core\Model\OrderInterface as Order;
use Sylius\Component\Core\Model\ProductInterface as Product;
use Sylius\Component\Core\Model\ProductVariantInterface as ProductVariant;
use Webburza\Sylius\GoogleEcommerceBundle\Model\Product as ProductModel;
use Webburza\Sylius\GoogleEcommerceBundle\Model\Transaction as TransactionModel;

/**
 * Class Client.
 */
class Client
{
    /** @var Channel */
    private $channel;

    /** @var string */
    private $key;

    /** @var ProductModel[] */
    private $impressions = [];

    /** @var ProductModel[] */
    private $products = [];

    /** @var string */
    private $action;

    /** @var string[] */
    private $actionOptions = [];

    /** @var string */
    private $currency;

    /**
     * @param Channel $channel
     * @param string  $key
     */
    public function __construct(Channel $channel, $key)
    {
        $this->channel = $channel;
        $this->key = $key;
    }

    /**
     * @param Order         $order
     * @param null|string[] $options
     *
     * @return $this
     */
    public function addCheckoutAction(Order $order, array $options = null)
    {
        $this->addProductsFromOrder($order);
        $this->action = 'checkout';
        $this->actionOptions = (array) $options;

        return $this;
    }

    /**
     * @param Order $order
     *
     * @return $this
     */
    public function addPurchaseAction(Order $order)
    {
        return $this->addTransactionAction($order, 'purchase');
    }

    /**
     * @param Order $order
     *
     * @return $this
     */
    public function addRefundAction(Order $order)
    {
        return $this->addTransactionAction($order, 'refund');
    }

    /**
     * @param ProductVariant $variant
     *
     * @return Client
     */
    public function addDetailsImpression(ProductVariant $variant)
    {
        $this->addProductVariant($variant);
        $this->action = 'detail';

        return $this;
    }

    /**
     * @param ProductVariant $variant
     * @param null|string[]  $options
     *
     * @return $this
     */
    public function addImpression(ProductVariant $variant, array $options = null)
    {
        $this->impressions[] = ProductModel::createFromProductVariant($this->channel, $variant, $options);

        return $this;
    }

    /**
     * @return string
     */
    public function render()
    {
        /** @noinspection CommaExpressionJS */
        $render = sprintf(
            '
        <script>
            (function(i,s,o,g,r,a,m){i["GoogleAnalyticsObject"]=r;i[r]=i[r]||function(){
                (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
                            m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
                    })(window,document,"script","//www.google-analytics.com/analytics.js", "ga");
            ga("create", "%1$s", "auto");
            ga("require", "ec");',
            $this->key
        );

        $blocks = (array) array_filter(
            array_merge(
                $this->renderBlock($this->impressions, 'Impression'),
                $this->renderBlock($this->products, 'Product'),
                $this->renderAction($this->action, $this->actionOptions),
                $this->renderVariable($this->currency, '&cu')
            )
        );
        foreach ($blocks as $block) {
            $render .= sprintf(
                '
            %1$s',
                $block
            );
        }

        $render .= '
            ga("send", "pageview");

            function wbGoogleEcommerceClick(a){
                var p = JSON.parse(a.dataset.geec);
                ga("ec:addProduct", p);
                ga("ec:setAction", "click", {list: p.list});
                ga("send", "event", "UX", "click", "Results", {hitCallback: function() {document.location = a.href}});
                return false;
            }

            function wbGoogleEcommerceCart(a,el,f){
                if (!(el&&window.ga&&ga.loaded)) return true;
                var c, p = JSON.parse(el.dataset.geec);
                if (f && typeof f === "function") p = f(p);
                ga("ec:addProduct", p);
                ga("ec:setAction", a);
                switch (el.nodeName.toLowerCase()) {
                    case "a": c = function() {document.location = el.href}; break;
                    case "form": c = function() {el.submit()}; break;
                    default: throw Error("Unsupported GEEC invocation");
                }
                ga("send", "event", "UX", "click", a, {hitCallback: c});
                return false;
            }
        </script>
';

        return $render;
    }

    /**
     * @param ProductVariant $variant
     * @param null|string[]  $options
     *
     * @return string
     */
    public function renderClickHandler(ProductVariant $variant, array $options = null)
    {
        $payload = htmlentities(
            json_encode(ProductModel::createFromProductVariant($this->channel, $variant, $options))
        );

        return sprintf(' data-geec="%1$s" onclick="wbGoogleEcommerceClick(this); return !ga.loaded;"', $payload);
    }

    /**
     * @param ProductVariant $variant
     * @param null|string[]  $options
     *
     * @return string
     */
    public function renderCartHandler(ProductVariant $variant, array $options = null)
    {
        $options = array_merge(
            [
                'action' => 'add',
                'event' => 'submit',
                'callable' => 'null',
            ],
            (array) $options
        );

        $payload = htmlentities(
            json_encode(ProductModel::createFromProductVariant($this->channel, $variant, $options))
        );

        return sprintf(
            ' data-geec="%1$s" on%2$s="return wbGoogleEcommerceCart(\'%3$s\', this, %4$s);"',
            $payload,
            $options['event'],
            $options['action'],
            $options['callable']
        );
    }

    /**
     * @param Product[] $collection
     * @param string    $type
     *
     * @return array
     */
    private function renderBlock(array $collection, $type)
    {
        if (0 === count($collection)) {
            return [];
        }

        $blocks = [];
        foreach ($collection as $item) {
            $blocks[] = sprintf('ga("ec:add%1$s", %2$s);', $type, json_encode($item));
        }

        return $blocks;
    }

    /**
     * @param string        $action
     * @param null|string[] $options
     *
     * @return array
     */
    private function renderAction($action, $options = null)
    {
        if (null === $action) {
            return [];
        }

        return [sprintf('ga("ec:setAction", %1$s, %2$s);', json_encode($action), json_encode($options))];
    }

    /**
     * @param mixed  $value
     * @param string $name
     *
     * @return array
     */
    private function renderVariable($value, $name)
    {
        if (null === $value) {
            return [];
        }

        return [sprintf('ga("set", %1$s, %2$s);', json_encode($name), json_encode($value))];
    }

    /**
     * @param ProductVariant $variant
     * @param null|string[]  $options
     *
     * @return $this
     */
    private function addProductVariant(ProductVariant $variant, array $options = null)
    {
        $this->products[] = ProductModel::createFromProductVariant($this->channel, $variant, $options);

        return $this;
    }

    /**
     * @param Order $order
     */
    private function addProductsFromOrder(Order $order)
    {
        foreach ($order->getItems() as $item) {
            /** @var \Sylius\Component\Core\Model\ProductVariant $variant */
            $variant = $item->getVariant();
            $this->addProductVariant(
                $variant,
                [
                    'variant' => $variant->__toString(),
                    'quantity' => $item->getQuantity(),
                ]
            );
        }
    }

    /**
     * @param Order  $order
     * @param string $action
     *
     * @return $this
     */
    private function addTransactionAction(Order $order, $action)
    {
        $this->addProductsFromOrder($order);
        $this->action = $action;
        $this->actionOptions = TransactionModel::createFromOrder($order)->jsonSerialize();
        $this->currency = $order->getCurrencyCode();

        return $this;
    }
}