first commit

modules/ps_metrics/src/Kpi/TotalKpi.php

@@ -0,0 +1,81 @@
+<?php
+
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License version 3.0
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
+ */
+
+namespace PrestaShop\Module\Ps_metrics\Kpi;
+
+use PrestaShop\Module\Ps_metrics\Kpi\Configuration\KpiConfiguration;
+
+class TotalKpi extends Kpi implements KpiStrategyInterface
+{
+    /**
+     * @var VisitsKpi
+     */
+    private $visitsKpi;
+
+    /**
+     * @var OrdersKpi
+     */
+    private $ordersKpi;
+
+    /**
+     * @var RevenuesKpi
+     */
+    private $revenuesKpi;
+
+    /**
+     * TotalKpi constructor.
+     *
+     * @param KpiConfiguration $kpiConfiguration
+     * @param VisitsKpi $visitsKpi
+     * @param OrdersKpi $ordersKpi
+     * @param RevenuesKpi $revenuesKpi
+     */
+    public function __construct(
+        KpiConfiguration $kpiConfiguration,
+        VisitsKpi $visitsKpi,
+        OrdersKpi $ordersKpi,
+        RevenuesKpi $revenuesKpi
+    ) {
+        parent::__construct($kpiConfiguration);
+        $this->visitsKpi = $visitsKpi;
+        $this->ordersKpi = $ordersKpi;
+        $this->revenuesKpi = $revenuesKpi;
+    }
+
+    /**
+     * Return all revenues data
+     *
+     * @return array
+     */
+    public function present()
+    {
+        $this->revenuesKpi->setConfiguration($this->getConfiguration());
+        $this->ordersKpi->setConfiguration($this->getConfiguration());
+        $this->visitsKpi->setConfiguration($this->getConfiguration());
+
+        return [
+            'revenuesTotal' => $this->revenuesKpi->getTotal(),
+            'ordersTotal' => $this->ordersKpi->getTotal(),
+            'ordersTotalForConversion' => $this->ordersKpi->getTotalForConversion(),
+            'visits' => $this->visitsKpi->getTotal(),
+        ];
+    }
+}