1
0
قرینه از https://github.com/matomo-org/matomo.git synced 2025-08-21 22:47:43 +00:00
Files
matomo/plugins/UserId/Reports/GetUsers.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

87 خطوط
3.0 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\UserId\Reports;
use Piwik\Piwik;
use Piwik\Plugin\ViewDataTable;
use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable;
use Piwik\Plugins\UserId\Columns\UserId;
use Piwik\Url;
/**
* A report showing all unique user IDs and some aggregated information about them. It also allows
* to open a popover with visitor details
*/
class GetUsers extends Base
{
protected function init()
{
parent::init();
$this->name = Piwik::translate('UserId_UserReportTitle');
$this->subcategoryId = 'UserId_UserReportTitle';
$this->documentation = Piwik::translate('UserId_UserReportDocumentation');
$this->dimension = new UserId();
$this->metrics = ['label', 'nb_visits', 'nb_actions', 'nb_visits_converted'];
$this->supportsFlatten = false;
// This defines in which order your report appears in the mobile app, in the menu and in the list of widgets
$this->order = 9;
}
/**
* @return array
*/
public static function getColumnsToDisplay()
{
return array();
}
/**
* @param ViewDataTable $view
*/
public function configureView(ViewDataTable $view)
{
$view->config->addTranslation('label', Piwik::translate('General_UserId'));
$view->config->addTranslation('nb_visits_converted', Piwik::translate('General_VisitConvertedGoal'));
/*
* Hide most of the table footer actions, leaving only export icons and pagination
*/
$view->config->columns_to_display = $this->metrics;
$view->config->show_all_views_icons = false;
$view->config->show_related_reports = false;
$view->config->show_insights = false;
$view->config->show_pivot_by_subtable = false;
$view->config->no_data_message = Piwik::translate('CoreHome_ThereIsNoDataForThisReport') . '<br><br>'
. sprintf(
Piwik::translate('UserId_ThereIsNoDataForThisReportHelp'),
"<a target='_blank' rel='noreferrer noopener' href='" . Url::addCampaignParametersToMatomoLink('https://matomo.org/docs/user-id/') . "'>",
"</a>"
);
if ($view->isViewDataTableId(HtmlTable::ID)) {
$view->config->disable_row_evolution = false;
}
if ($view->isViewDataTableId(HtmlTable\AllColumns::ID)) {
$view->config->filters[] = function () use ($view) {
// unique visitors and user metrics doesn't make sense here as they would be always showing a value of 1
$columnsToRemove = ['nb_uniq_visitors', 'nb_users'];
$view->config->columns_to_display = array_diff($view->config->columns_to_display, $columnsToRemove);
};
}
// exclude users with less then 2 visits, when low population filter is active
$view->requestConfig->filter_excludelowpop_value = 2;
}
}