1
0
قرینه از https://github.com/matomo-org/matomo.git synced 2025-08-22 15:07:44 +00:00
Files
matomo/plugins/Events/Reports/Base.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

90 خطوط
2.9 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\Events\Reports;
use Piwik\DataTable;
use Piwik\EventDispatcher;
use Piwik\Common;
use Piwik\Piwik;
use Piwik\Plugin\ViewDataTable;
use Piwik\Plugins\Events\API;
use Piwik\Plugins\Events\Columns\Metrics\AverageEventValue;
use Piwik\Report\ReportWidgetFactory;
use Piwik\Url;
use Piwik\Widget\WidgetsList;
abstract class Base extends \Piwik\Plugin\Report
{
protected function init()
{
$this->categoryId = 'General_Actions';
$this->subcategoryId = 'Events_Events';
$this->onlineGuideUrl = Url::addCampaignParametersToMatomoLink('https://matomo.org/docs/event-tracking/');
$this->processedMetrics = array(
new AverageEventValue()
);
}
public function getMetricsDocumentation()
{
$documentation = parent::getMetricsDocumentation();
$documentation['nb_visits'] = Piwik::translate('Events_ColumnNbVisitsDocumentation');
$documentation['nb_uniq_visitors'] = Piwik::translate('Events_ColumnNbUniqVisitorsDocumentation');
return $documentation;
}
public function configureWidgets(WidgetsList $widgetsList, ReportWidgetFactory $factory)
{
if (!$this->isSubtableReport) {
$widget = $factory->createWidget()->setParameters(array(
'secondaryDimension' => API::getInstance()->getDefaultSecondaryDimension($this->action)
));
$widgetsList->addToContainerWidget('Events', $widget);
}
}
public function configureView(ViewDataTable $view)
{
if (Common::getRequestVar('secondaryDimension', '', 'string')) {
foreach (['pivotBy', 'pivotByColumn'] as $property) {
$index = array_search($property, $view->requestConfig->overridableProperties);
if ($index) {
unset($view->requestConfig->overridableProperties[$index]);
}
}
$view->requestConfig->overridableProperties = array_values($view->requestConfig->overridableProperties);
}
if (property_exists($view->config, 'selectable_columns')) {
$view->config->selectable_columns = ['nb_events', 'nb_visits', 'sum_event_value', 'nb_events_with_value'];
}
$this->configureFooterMessage($view);
}
protected function configureFooterMessage(ViewDataTable $view)
{
if ($this->isSubtableReport) {
// no footer message for subtables
return;
}
$view->config->filters[] = function (DataTable $dataTable) use ($view) {
$out = '';
EventDispatcher::getInstance()->postEvent('Template.afterEventsReport', [&$out, $dataTable]);
$view->config->show_footer_message = $out;
};
}
}