/core/DataArray.php
PHP | 396 lines | 271 code | 39 blank | 86 comment | 32 complexity | f7ea1c2efcdd0da77a6cf3003c28babc MD5 | raw file
Possible License(s): LGPL-3.0, JSON, MIT, GPL-3.0, LGPL-2.1, GPL-2.0, AGPL-1.0, BSD-2-Clause, BSD-3-Clause
- <?php
- /**
- * Piwik - free/libre analytics platform
- *
- * @link http://piwik.org
- * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
- *
- */
- namespace Piwik;
- use Exception;
- use Piwik\Tracker\GoalManager;
- /**
- * The DataArray is a data structure used to aggregate datasets,
- * ie. sum arrays made of rows made of columns,
- * data from the logs is stored in a DataArray before being converted in a DataTable
- *
- */
- class DataArray
- {
- protected $data = array();
- protected $dataTwoLevels = array();
- public function __construct($data = array(), $dataArrayByLabel = array())
- {
- $this->data = $data;
- $this->dataTwoLevels = $dataArrayByLabel;
- }
- /**
- * This returns the actual raw data array
- *
- * @return array
- */
- public function &getDataArray()
- {
- return $this->data;
- }
- public function getDataArrayWithTwoLevels()
- {
- return $this->dataTwoLevels;
- }
- public function sumMetricsVisits($label, $row)
- {
- if (!isset($this->data[$label])) {
- $this->data[$label] = self::makeEmptyRow();
- }
- $this->doSumVisitsMetrics($row, $this->data[$label]);
- }
- /**
- * Returns an empty row containing default metrics
- *
- * @return array
- */
- static public function makeEmptyRow()
- {
- return array(Metrics::INDEX_NB_UNIQ_VISITORS => 0,
- Metrics::INDEX_NB_VISITS => 0,
- Metrics::INDEX_NB_ACTIONS => 0,
- Metrics::INDEX_MAX_ACTIONS => 0,
- Metrics::INDEX_SUM_VISIT_LENGTH => 0,
- Metrics::INDEX_BOUNCE_COUNT => 0,
- Metrics::INDEX_NB_VISITS_CONVERTED => 0,
- );
- }
- /**
- * Adds the given row $newRowToAdd to the existing $oldRowToUpdate passed by reference
- * The rows are php arrays Name => value
- *
- * @param array $newRowToAdd
- * @param array $oldRowToUpdate
- * @param bool $onlyMetricsAvailableInActionsTable
- *
- * @return void
- */
- protected function doSumVisitsMetrics($newRowToAdd, &$oldRowToUpdate, $onlyMetricsAvailableInActionsTable = false)
- {
- // Pre 1.2 format: string indexed rows are returned from the DB
- // Left here for Backward compatibility with plugins doing custom SQL queries using these metrics as string
- if (!isset($newRowToAdd[Metrics::INDEX_NB_VISITS])) {
- $oldRowToUpdate[Metrics::INDEX_NB_VISITS] += $newRowToAdd['nb_visits'];
- $oldRowToUpdate[Metrics::INDEX_NB_ACTIONS] += $newRowToAdd['nb_actions'];
- $oldRowToUpdate[Metrics::INDEX_NB_UNIQ_VISITORS] += $newRowToAdd['nb_uniq_visitors'];
- if ($onlyMetricsAvailableInActionsTable) {
- return;
- }
- $oldRowToUpdate[Metrics::INDEX_MAX_ACTIONS] = (float)max($newRowToAdd['max_actions'], $oldRowToUpdate[Metrics::INDEX_MAX_ACTIONS]);
- $oldRowToUpdate[Metrics::INDEX_SUM_VISIT_LENGTH] += $newRowToAdd['sum_visit_length'];
- $oldRowToUpdate[Metrics::INDEX_BOUNCE_COUNT] += $newRowToAdd['bounce_count'];
- $oldRowToUpdate[Metrics::INDEX_NB_VISITS_CONVERTED] += $newRowToAdd['nb_visits_converted'];
- return;
- }
- $oldRowToUpdate[Metrics::INDEX_NB_VISITS] += $newRowToAdd[Metrics::INDEX_NB_VISITS];
- $oldRowToUpdate[Metrics::INDEX_NB_ACTIONS] += $newRowToAdd[Metrics::INDEX_NB_ACTIONS];
- $oldRowToUpdate[Metrics::INDEX_NB_UNIQ_VISITORS] += $newRowToAdd[Metrics::INDEX_NB_UNIQ_VISITORS];
- if ($onlyMetricsAvailableInActionsTable) {
- return;
- }
- // In case the existing Row had no action metrics (eg. Custom Variable XYZ with "visit" scope)
- // but the new Row has action metrics (eg. same Custom Variable XYZ this time with a "page" scope)
- if(!isset($oldRowToUpdate[Metrics::INDEX_MAX_ACTIONS])) {
- $toZero = array(Metrics::INDEX_MAX_ACTIONS,
- Metrics::INDEX_SUM_VISIT_LENGTH,
- Metrics::INDEX_BOUNCE_COUNT,
- Metrics::INDEX_NB_VISITS_CONVERTED);
- foreach($toZero as $metric) {
- $oldRowToUpdate[$metric] = 0;
- }
- }
- $oldRowToUpdate[Metrics::INDEX_MAX_ACTIONS] = (float)max($newRowToAdd[Metrics::INDEX_MAX_ACTIONS], $oldRowToUpdate[Metrics::INDEX_MAX_ACTIONS]);
- $oldRowToUpdate[Metrics::INDEX_SUM_VISIT_LENGTH] += $newRowToAdd[Metrics::INDEX_SUM_VISIT_LENGTH];
- $oldRowToUpdate[Metrics::INDEX_BOUNCE_COUNT] += $newRowToAdd[Metrics::INDEX_BOUNCE_COUNT];
- $oldRowToUpdate[Metrics::INDEX_NB_VISITS_CONVERTED] += $newRowToAdd[Metrics::INDEX_NB_VISITS_CONVERTED];
- }
- public function sumMetricsGoals($label, $row)
- {
- $idGoal = $row['idgoal'];
- if (!isset($this->data[$label][Metrics::INDEX_GOALS][$idGoal])) {
- $this->data[$label][Metrics::INDEX_GOALS][$idGoal] = self::makeEmptyGoalRow($idGoal);
- }
- $this->doSumGoalsMetrics($row, $this->data[$label][Metrics::INDEX_GOALS][$idGoal]);
- }
- /**
- * @param $idGoal
- * @return array
- */
- protected static function makeEmptyGoalRow($idGoal)
- {
- if ($idGoal > GoalManager::IDGOAL_ORDER) {
- return array(Metrics::INDEX_GOAL_NB_CONVERSIONS => 0,
- Metrics::INDEX_GOAL_NB_VISITS_CONVERTED => 0,
- Metrics::INDEX_GOAL_REVENUE => 0,
- );
- }
- if ($idGoal == GoalManager::IDGOAL_ORDER) {
- return array(Metrics::INDEX_GOAL_NB_CONVERSIONS => 0,
- Metrics::INDEX_GOAL_NB_VISITS_CONVERTED => 0,
- Metrics::INDEX_GOAL_REVENUE => 0,
- Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_SUBTOTAL => 0,
- Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_TAX => 0,
- Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_SHIPPING => 0,
- Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_DISCOUNT => 0,
- Metrics::INDEX_GOAL_ECOMMERCE_ITEMS => 0,
- );
- }
- // idGoal == GoalManager::IDGOAL_CART
- return array(Metrics::INDEX_GOAL_NB_CONVERSIONS => 0,
- Metrics::INDEX_GOAL_NB_VISITS_CONVERTED => 0,
- Metrics::INDEX_GOAL_REVENUE => 0,
- Metrics::INDEX_GOAL_ECOMMERCE_ITEMS => 0,
- );
- }
- /**
- *
- * @param $newRowToAdd
- * @param $oldRowToUpdate
- */
- protected function doSumGoalsMetrics($newRowToAdd, &$oldRowToUpdate)
- {
- $oldRowToUpdate[Metrics::INDEX_GOAL_NB_CONVERSIONS] += $newRowToAdd[Metrics::INDEX_GOAL_NB_CONVERSIONS];
- $oldRowToUpdate[Metrics::INDEX_GOAL_NB_VISITS_CONVERTED] += $newRowToAdd[Metrics::INDEX_GOAL_NB_VISITS_CONVERTED];
- $oldRowToUpdate[Metrics::INDEX_GOAL_REVENUE] += $newRowToAdd[Metrics::INDEX_GOAL_REVENUE];
- // Cart & Order
- if (isset($oldRowToUpdate[Metrics::INDEX_GOAL_ECOMMERCE_ITEMS])) {
- $oldRowToUpdate[Metrics::INDEX_GOAL_ECOMMERCE_ITEMS] += $newRowToAdd[Metrics::INDEX_GOAL_ECOMMERCE_ITEMS];
- // Order only
- if (isset($oldRowToUpdate[Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_SUBTOTAL])) {
- $oldRowToUpdate[Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_SUBTOTAL] += $newRowToAdd[Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_SUBTOTAL];
- $oldRowToUpdate[Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_TAX] += $newRowToAdd[Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_TAX];
- $oldRowToUpdate[Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_SHIPPING] += $newRowToAdd[Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_SHIPPING];
- $oldRowToUpdate[Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_DISCOUNT] += $newRowToAdd[Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_DISCOUNT];
- }
- }
- }
- public function sumMetricsActions($label, $row)
- {
- if (!isset($this->data[$label])) {
- $this->data[$label] = self::makeEmptyActionRow();
- }
- $this->doSumVisitsMetrics($row, $this->data[$label], $onlyMetricsAvailableInActionsTable = true);
- }
- static protected function makeEmptyActionRow()
- {
- return array(
- Metrics::INDEX_NB_UNIQ_VISITORS => 0,
- Metrics::INDEX_NB_VISITS => 0,
- Metrics::INDEX_NB_ACTIONS => 0,
- );
- }
- public function sumMetricsEvents($label, $row)
- {
- if (!isset($this->data[$label])) {
- $this->data[$label] = self::makeEmptyEventRow();
- }
- $this->doSumEventsMetrics($row, $this->data[$label], $onlyMetricsAvailableInActionsTable = true);
- }
- static protected function makeEmptyEventRow()
- {
- return array(
- Metrics::INDEX_NB_UNIQ_VISITORS => 0,
- Metrics::INDEX_NB_VISITS => 0,
- Metrics::INDEX_EVENT_NB_HITS => 0,
- Metrics::INDEX_EVENT_NB_HITS_WITH_VALUE => 0,
- Metrics::INDEX_EVENT_SUM_EVENT_VALUE => 0,
- Metrics::INDEX_EVENT_MIN_EVENT_VALUE => 0,
- Metrics::INDEX_EVENT_MAX_EVENT_VALUE => 0,
- );
- }
- const EVENT_VALUE_PRECISION = 2;
- /**
- * @param array $newRowToAdd
- * @param array $oldRowToUpdate
- * @return void
- */
- protected function doSumEventsMetrics($newRowToAdd, &$oldRowToUpdate)
- {
- $oldRowToUpdate[Metrics::INDEX_NB_VISITS] += $newRowToAdd[Metrics::INDEX_NB_VISITS];
- $oldRowToUpdate[Metrics::INDEX_NB_UNIQ_VISITORS] += $newRowToAdd[Metrics::INDEX_NB_UNIQ_VISITORS];
- $oldRowToUpdate[Metrics::INDEX_EVENT_NB_HITS] += $newRowToAdd[Metrics::INDEX_EVENT_NB_HITS];
- $oldRowToUpdate[Metrics::INDEX_EVENT_NB_HITS_WITH_VALUE] += $newRowToAdd[Metrics::INDEX_EVENT_NB_HITS_WITH_VALUE];
- $newRowToAdd[Metrics::INDEX_EVENT_SUM_EVENT_VALUE] = round($newRowToAdd[Metrics::INDEX_EVENT_SUM_EVENT_VALUE], self::EVENT_VALUE_PRECISION);
- $oldRowToUpdate[Metrics::INDEX_EVENT_SUM_EVENT_VALUE] += $newRowToAdd[Metrics::INDEX_EVENT_SUM_EVENT_VALUE];
- $oldRowToUpdate[Metrics::INDEX_EVENT_MAX_EVENT_VALUE] = round(max($newRowToAdd[Metrics::INDEX_EVENT_MAX_EVENT_VALUE], $oldRowToUpdate[Metrics::INDEX_EVENT_MAX_EVENT_VALUE]), self::EVENT_VALUE_PRECISION);
- // Update minimum only if it is set
- if($newRowToAdd[Metrics::INDEX_EVENT_MIN_EVENT_VALUE] !== false) {
- if($oldRowToUpdate[Metrics::INDEX_EVENT_MIN_EVENT_VALUE] === false) {
- $oldRowToUpdate[Metrics::INDEX_EVENT_MIN_EVENT_VALUE] = round($newRowToAdd[Metrics::INDEX_EVENT_MIN_EVENT_VALUE], self::EVENT_VALUE_PRECISION);
- } else {
- $oldRowToUpdate[Metrics::INDEX_EVENT_MIN_EVENT_VALUE] = round(min($newRowToAdd[Metrics::INDEX_EVENT_MIN_EVENT_VALUE], $oldRowToUpdate[Metrics::INDEX_EVENT_MIN_EVENT_VALUE]), self::EVENT_VALUE_PRECISION);
- }
- }
- }
- /**
- * Generic function that will sum all columns of the given row, at the specified label's row.
- *
- * @param $label
- * @param $row
- * @throws Exception if the the data row contains non numeric values
- */
- public function sumMetrics($label, $row)
- {
- foreach ($row as $columnName => $columnValue) {
- if (empty($columnValue)) {
- continue;
- }
- if (empty($this->data[$label][$columnName])) {
- $this->data[$label][$columnName] = 0;
- }
- if (!is_numeric($columnValue)) {
- throw new Exception("DataArray->sumMetricsPivot expects rows of numeric values, non numeric found: " . var_export($columnValue, true) . " for column $columnName");
- }
- $this->data[$label][$columnName] += $columnValue;
- }
- }
- public function sumMetricsVisitsPivot($parentLabel, $label, $row)
- {
- if (!isset($this->dataTwoLevels[$parentLabel][$label])) {
- $this->dataTwoLevels[$parentLabel][$label] = self::makeEmptyRow();
- }
- $this->doSumVisitsMetrics($row, $this->dataTwoLevels[$parentLabel][$label]);
- }
- public function sumMetricsGoalsPivot($parentLabel, $label, $row)
- {
- $idGoal = $row['idgoal'];
- if (!isset($this->dataTwoLevels[$parentLabel][$label][Metrics::INDEX_GOALS][$idGoal])) {
- $this->dataTwoLevels[$parentLabel][$label][Metrics::INDEX_GOALS][$idGoal] = self::makeEmptyGoalRow($idGoal);
- }
- $this->doSumGoalsMetrics($row, $this->dataTwoLevels[$parentLabel][$label][Metrics::INDEX_GOALS][$idGoal]);
- }
- public function sumMetricsActionsPivot($parentLabel, $label, $row)
- {
- if (!isset($this->dataTwoLevels[$parentLabel][$label])) {
- $this->dataTwoLevels[$parentLabel][$label] = $this->makeEmptyActionRow();
- }
- $this->doSumVisitsMetrics($row, $this->dataTwoLevels[$parentLabel][$label], $onlyMetricsAvailableInActionsTable = true);
- }
- public function sumMetricsEventsPivot($parentLabel, $label, $row)
- {
- if (!isset($this->dataTwoLevels[$parentLabel][$label])) {
- $this->dataTwoLevels[$parentLabel][$label] = $this->makeEmptyEventRow();
- }
- $this->doSumEventsMetrics($row, $this->dataTwoLevels[$parentLabel][$label]);
- }
- public function setRowColumnPivot($parentLabel, $label, $column, $value)
- {
- $this->dataTwoLevels[$parentLabel][$label][$column] = $value;
- }
- public function enrichMetricsWithConversions()
- {
- $this->enrichWithConversions($this->data);
- foreach ($this->dataTwoLevels as &$metricsBySubLabel) {
- $this->enrichWithConversions($metricsBySubLabel);
- }
- }
- /**
- * Given an array of stats, it will process the sum of goal conversions
- * and sum of revenue and add it in the stats array in two new fields.
- *
- * @param array $data Passed by reference, two new columns
- * will be added: total conversions, and total revenue, for all goals for this label/row
- */
- protected function enrichWithConversions(&$data)
- {
- foreach ($data as $label => &$values) {
- if (!isset($values[Metrics::INDEX_GOALS])) {
- continue;
- }
- // When per goal metrics are processed, general 'visits converted' is not meaningful because
- // it could differ from the sum of each goal conversions
- unset($values[Metrics::INDEX_NB_VISITS_CONVERTED]);
- $revenue = $conversions = 0;
- foreach ($values[Metrics::INDEX_GOALS] as $idgoal => $goalValues) {
- // Do not sum Cart revenue since it is a lost revenue
- if ($idgoal >= GoalManager::IDGOAL_ORDER) {
- $revenue += $goalValues[Metrics::INDEX_GOAL_REVENUE];
- $conversions += $goalValues[Metrics::INDEX_GOAL_NB_CONVERSIONS];
- }
- }
- $values[Metrics::INDEX_NB_CONVERSIONS] = $conversions;
- // 25.00 recorded as 25
- if (round($revenue) == $revenue) {
- $revenue = round($revenue);
- }
- $values[Metrics::INDEX_REVENUE] = $revenue;
- // if there are no "visit" column, we force one to prevent future complications
- // eg. This helps the setDefaultColumnsToDisplay() call
- if(!isset($values[Metrics::INDEX_NB_VISITS])) {
- $values[Metrics::INDEX_NB_VISITS] = 0;
- }
- }
- }
- /**
- * Returns true if the row looks like an Action metrics row
- *
- * @param $row
- * @return bool
- */
- static public function isRowActions($row)
- {
- return (count($row) == count(self::makeEmptyActionRow())) && isset($row[Metrics::INDEX_NB_ACTIONS]);
- }
- /**
- * Converts array to a datatable
- *
- * @return \Piwik\DataTable
- */
- public function asDataTable()
- {
- $dataArray = $this->getDataArray();
- $dataArrayTwoLevels = $this->getDataArrayWithTwoLevels();
- $subtableByLabel = null;
- if (!empty($dataArrayTwoLevels)) {
- $subtableByLabel = array();
- foreach ($dataArrayTwoLevels as $label => $subTable) {
- $subtableByLabel[$label] = DataTable::makeFromIndexedArray($subTable);
- }
- }
- return DataTable::makeFromIndexedArray($dataArray, $subtableByLabel);
- }
- }