Symfony Profiler

<?php
declare(strict_types=1);
/**
* Pimcore
*
* This source file is available under two different licenses:
* - GNU General Public License version 3 (GPLv3)
* - Pimcore Enterprise License (PEL)
* Full copyright and license information is available in
* LICENSE.md which is distributed with this source code.
*
* @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
* @license http://www.pimcore.org/license GPLv3 and PEL
*/
namespace Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\Tracker;
use Pimcore\Analytics\Piwik\Tracker as PiwikTracker;
use Pimcore\Bundle\EcommerceFrameworkBundle\CartManager\CartInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\Model\AbstractOrder;
use Pimcore\Bundle\EcommerceFrameworkBundle\Model\ProductInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\CartProductActionAddInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\CartProductActionRemoveInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\CartUpdateInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\CategoryPageViewInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\CheckoutCompleteInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\ProductAction;
use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\ProductViewInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\Tracker;
use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\TrackEventInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\TrackingCodeAwareInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\TrackingItemBuilderInterface;
use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
class Piwik extends Tracker implements
ProductViewInterface,
CategoryPageViewInterface,
CartUpdateInterface,
CartProductActionAddInterface,
CartProductActionRemoveInterface,
CheckoutCompleteInterface,
TrackEventInterface,
TrackingCodeAwareInterface
{
/**
* @var PiwikTracker
*/
private $tracker;
/**
* @var bool
*/
private $handleCartAdd = true;
/**
* @var bool
*/
private $handleCartRemove = true;
/**
* @var string[]
*/
protected $trackedCodes = [];
public function __construct(
PiwikTracker $tracker,
TrackingItemBuilderInterface $trackingItemBuilder,
EngineInterface $templatingEngine,
array $options = []
) {
$this->tracker = $tracker;
parent::__construct($trackingItemBuilder, $templatingEngine, $options);
}
protected function configureOptions(OptionsResolver $resolver)
{
parent::configureOptions($resolver);
$resolver->setDefaults([
'template_prefix' => 'PimcoreEcommerceFrameworkBundle:Tracking/piwik',
// by default, a cart add/remove delegates to cart update
// if you manually trigger cart update on every change you can
// can set this to false to avoid handling of add/remove
'handle_cart_add' => true,
'handle_cart_remove' => true,
]);
$resolver->setAllowedTypes('handle_cart_add', 'bool');
$resolver->setAllowedTypes('handle_cart_remove', 'bool');
}
protected function processOptions(array $options)
{
parent::processOptions($options);
$this->handleCartAdd = $options['handle_cart_add'];
$this->handleCartRemove = $options['handle_cart_remove'];
}
/**
* @inheritDoc
*/
public function trackProductView(ProductInterface $product)
{
$item = $this->trackingItemBuilder->buildProductViewItem($product);
$call = [
'setEcommerceView',
$item->getId(),
$item->getName(),
];
$call[] = $this->filterCategories($item->getCategories());
$price = $item->getPrice();
if (!empty($price)) {
$call[] = $price;
}
$result = $this->renderCalls([$call]);
$this->trackCode($result);
}
/**
* @inheritDoc
*/
public function trackCategoryPageView($category, $page = null)
{
$category = $this->filterCategories($category);
$result = $this->renderCalls([
[
'setEcommerceView',
false,
false,
$category,
],
]);
$this->trackCode($result);
}
/**
* @inheritDoc
*/
public function trackCartProductActionAdd(CartInterface $cart, ProductInterface $product, $quantity = 1)
{
if ($this->handleCartAdd) {
$this->trackCartUpdate($cart);
}
}
/**
* @inheritDoc
*/
public function trackCartProductActionRemove(CartInterface $cart, ProductInterface $product, $quantity = 1)
{
if ($this->handleCartRemove) {
$this->trackCartUpdate($cart);
}
}
/**
* @inheritDoc
*/
public function trackCartUpdate(CartInterface $cart)
{
$items = $this->trackingItemBuilder->buildCheckoutItemsByCart($cart);
$calls = $this->buildItemCalls($items);
$calls[] = [
'trackEcommerceCartUpdate',
$cart->getPriceCalculator()->getGrandTotal()->getAmount()->asNumeric(),
];
$result = $this->renderCalls($calls);
$this->trackCode($result);
}
/**
* @inheritDoc
*/
public function trackCheckoutComplete(AbstractOrder $order)
{
$items = $this->trackingItemBuilder->buildCheckoutItems($order);
$transaction = $this->trackingItemBuilder->buildCheckoutTransaction($order);
$calls = $this->buildItemCalls($items);
$calls[] = [
'trackEcommerceOrder',
$transaction->getId(),
$transaction->getTotal(),
$transaction->getSubTotal(),
$transaction->getTax(),
$transaction->getShipping(),
];
$result = $this->renderCalls($calls);
$this->trackCode($result);
}
public function trackEvent(
string $eventCategory,
string $eventAction,
string $eventLabel = null,
int $eventValue = null
) {
$result = $this->renderCalls([
[
'trackEvent',
$eventCategory,
$eventAction,
$eventLabel,
$eventValue,
],
]);
$this->trackCode($result);
}
public function getTrackedCodes(): array
{
return $this->trackedCodes;
}
public function trackCode(string $code)
{
$this->trackedCodes[] = $code;
$this->tracker->addCodePart($code, PiwikTracker::BLOCK_BEFORE_TRACK);
}
private function renderCalls(array $calls): string
{
return $this->renderTemplate('calls', [
'calls' => $calls,
]);
}
/**
* @param ProductAction[] $items
*
* @return array
*/
private function buildItemCalls(array $items): array
{
$calls = [];
foreach ($items as $item) {
$calls[] = [
'addEcommerceItem',
$item->getId(),
$item->getName(),
$item->getCategories(),
$item->getPrice(),
$item->getQuantity(),
];
}
return $calls;
}
private function filterCategories($categories, int $limit = 5)
{
if (null === $categories) {
return $categories;
}
$result = null;
if (is_array($categories)) {
// add max 5 categories
$categories = array_slice($categories, 0, 5);
$result = [];
foreach ($categories as $category) {
$category = trim((string)$category);
if (!empty($category)) {
$result[] = $category;
}
}
$result = array_slice($result, 0, $limit);
} else {
$result = trim((string)$categories);
}
if (!empty($result)) {
return $result;
}
}
}

vendor/pimcore/pimcore/bundles/EcommerceFrameworkBundle/Tracking/Tracker/Piwik.php line 243