1
0
قرینه از https://github.com/matomo-org/matomo.git synced 2025-08-22 23:17:46 +00:00
Files
matomo/plugins/Goals/Columns/Metrics/GoalSpecific/RevenuePerVisit.php
Stefan Giehl cc1f0be832 Add missing metric documentions (#23105)
* Add missing metric tooltips to real time report

* Add documentation for revenue per visit column

* Correctly set available metrics for user location reports

* Add metric documentation for nb_visits_converted

* Adds metric documentation for nb_visits_percentage

* Add missing metric documentations for custom dimensions

* Fix bounce rate metric documentation for entry page urls report

* Fix visits / unique visitors metric documentation in event reports

* Fix visits percentage metric documentation

* Adds documentation for conversions metric

* Adjust metric documentation for ecommerce product reports

* updates expected test files

tests

* prefer using default documentation for glossary

* Change how documentation in metric glossary are computed

* use unique ids for xss test metrics

* updates expected UI test files

* Add metric documentation for conversions in pages reports

* Improve conversion metric documentation

* updates expected test files

* Apply suggestions from code review

Co-authored-by: Michal Kleiner <michal@innocraft.com>

* updates expected test files

* fix cs

---------

Co-authored-by: Michal Kleiner <michal@innocraft.com>
2025-03-27 13:44:39 +01:00

86 خطوط
2.6 KiB
PHP

<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\Goals\Columns\Metrics\GoalSpecific;
use Piwik\Archive\DataTableFactory;
use Piwik\Columns\Dimension;
use Piwik\DataTable;
use Piwik\DataTable\Row;
use Piwik\Metrics;
use Piwik\Metrics\Formatter;
use Piwik\Piwik;
use Piwik\Plugins\Goals\Columns\Metrics\GoalSpecificProcessedMetric;
use Piwik\Plugins\Goals\Goals;
use Piwik\Tracker\GoalManager;
/**
* Revenue per visit for a specific goal. Calculated as:
*
* goal's revenue / (nb_visits or goal's nb_conversions depending on what is present in data)
*
* Goal revenue & nb_conversion are calculated by the Goals archiver.
*/
class RevenuePerVisit extends GoalSpecificProcessedMetric
{
public function getName()
{
return Goals::makeGoalColumn($this->idGoal, 'revenue_per_visit', false);
}
public function getTranslatedName()
{
return $this->getGoalName() . ' ' . Piwik::translate('General_ColumnValuePerVisit');
}
public function getDocumentation()
{
if ($this->idGoal === Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER) {
return Piwik::translate('Goals_ColumnRevenuePerVisitDocumentation', $this->getGoalNameForDocs());
}
return Piwik::translate('Goals_ColumnRevenuePerVisitDocumentation', Piwik::translate('Goals_EcommerceAndGoalsMenu'));
}
public function getDependentMetrics()
{
return ['goals', 'nb_visits'];
}
public function compute(Row $row)
{
$mappingFromNameToIdGoal = Metrics::getMappingFromNameToIdGoal();
$goalMetrics = $this->getGoalMetrics($row);
$nbVisits = $this->getMetric($row, 'nb_visits');
$conversions = $this->getMetric($goalMetrics, 'nb_conversions', $mappingFromNameToIdGoal);
$goalRevenue = (float) $this->getMetric($goalMetrics, 'revenue', $mappingFromNameToIdGoal);
return Piwik::getQuotientSafe($goalRevenue, $nbVisits == 0 ? $conversions : $nbVisits, GoalManager::REVENUE_PRECISION);
}
public function format($value, Formatter $formatter)
{
return $formatter->getPrettyMoney($value, $this->idSite);
}
public function beforeFormat($report, DataTable $table)
{
$this->idSite = DataTableFactory::getSiteIdFromMetadata($table);
return !empty($this->idSite); // skip formatting if there is no site to get currency info from
}
public function getSemanticType(): ?string
{
return Dimension::TYPE_MONEY;
}
}