diff options
Diffstat (limited to 'plugins/CustomDimensions/GetCustomDimension.php')
| m--------- | plugins/CustomDimensions | 0 | ||||
| -rw-r--r-- | plugins/CustomDimensions/GetCustomDimension.php | 257 |
2 files changed, 257 insertions, 0 deletions
diff --git a/plugins/CustomDimensions b/plugins/CustomDimensions deleted file mode 160000 -Subproject 318661a2fb1ef3b3e5d6d999ae8b9628cb5a113 diff --git a/plugins/CustomDimensions/GetCustomDimension.php b/plugins/CustomDimensions/GetCustomDimension.php new file mode 100644 index 0000000000..709cb3848d --- /dev/null +++ b/plugins/CustomDimensions/GetCustomDimension.php @@ -0,0 +1,257 @@ +<?php +/** + * Matomo - free/libre analytics platform + * + * @link https://matomo.org + * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later + */ + +namespace Piwik\Plugins\CustomDimensions; + +use Piwik\API\Request; +use Piwik\Common; +use Piwik\DataTable; +use Piwik\Metrics; +use Piwik\Piwik; +use Piwik\Plugin\Report; +use Piwik\Plugin\ViewDataTable; +use Piwik\Plugins\Actions\Columns\Metrics\AveragePageGenerationTime; +use Piwik\Plugins\Actions\Columns\Metrics\ExitRate; +use Piwik\Plugins\CoreHome\Columns\Metrics\ActionsPerVisit; +use Piwik\Plugins\CoreHome\Columns\Metrics\AverageTimeOnSite; +use Piwik\Plugins\CoreHome\Columns\Metrics\BounceRate; +use Piwik\Plugins\CoreHome\Columns\UserId; +use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable; +use Piwik\Plugins\CustomDimensions\Columns\Metrics\AverageTimeOnDimension; +use Piwik\Plugins\CustomDimensions\Dimension\CustomActionDimension; +use Piwik\Plugins\CustomDimensions\Dimension\CustomVisitDimension; +use Piwik\Plugins\CustomDimensions\Tracker\CustomDimensionsRequestProcessor; + +/** + * This class defines a new report. + * + * See {@link http://developer.piwik.org/api-reference/Piwik/Plugin/Report} for more information. + */ +class GetCustomDimension extends Report +{ + private $dimensionCache = array(); + + private $scopeOfDimension = null; + + protected function init() + { + parent::init(); + + $this->module = 'CustomDimensions'; + $this->action = 'getCustomDimension'; + $this->categoryId = 'CustomDimensions_CustomDimensions'; + $this->name = Piwik::translate($this->categoryId); + $this->order = 100; + $this->actionToLoadSubTables = $this->action; + + $idSite = Common::getRequestVar('idSite', 0, 'int'); + $idDimension = Common::getRequestVar('idDimension', 0, 'int'); + + if ($idDimension > 0 && $idSite > 0) { + $dimensions = $this->getActiveDimensionsForSite($idSite); + foreach ($dimensions as $dimension) { + if (((int) $dimension['idcustomdimension']) === $idDimension) { + $this->initThisReportFromDimension($dimension); + } + } + } + } + + /** + * Here you can configure how your report should be displayed. For instance whether your report supports a search + * etc. You can also change the default request config. For instance change how many rows are displayed by default. + * + * @param ViewDataTable $view + */ + public function configureView(ViewDataTable $view) + { + $idDimension = Common::getRequestVar('idDimension', 0, 'int'); + if ($idDimension < 1) { + return; + } + + $isWidget = Common::getRequestVar('widget', 0, 'int'); + $module = Common::getRequestVar('module', '', 'string'); + if ($isWidget && $module !== 'Widgetize' && $view->isViewDataTableId(HtmlTable::ID)) { + // we disable row evolution as it would not forward the idDimension when requesting the row evolution + // this is a limitation in row evolution + $view->config->disable_row_evolution = true; + } + + $module = $view->requestConfig->getApiModuleToRequest(); + $method = $view->requestConfig->getApiMethodToRequest(); + $idReport = sprintf('%s_%s_idDimension--%d', $module, $method, $idDimension); + + if ($view->requestConfig->idSubtable) { + $view->config->addTranslation('label', Piwik::translate('Actions_ColumnActionURL')); + } elseif (!empty($this->dimension)) { + $view->config->addTranslation('label', $this->dimension->getName()); + } + + $view->requestConfig->request_parameters_to_modify['idDimension'] = $idDimension; + $view->requestConfig->request_parameters_to_modify['reportUniqueId'] = $idReport; + $view->config->custom_parameters['scopeOfDimension'] = $this->scopeOfDimension; + + if ($this->scopeOfDimension === CustomDimensions::SCOPE_VISIT) { + + // Goal metrics for each custom dimension of 'visit' scope is processed in Archiver via aggregateFromConversions + $view->config->show_goals = true; + + $view->config->columns_to_display = array( + 'label', 'nb_visits', 'nb_uniq_visitors', 'nb_users', 'nb_actions', 'nb_actions_per_visit', 'avg_time_on_site', 'bounce_rate' + ); + + if ($view->isViewDataTableId(HtmlTable::ID)) { + $view->config->filters[] = function (DataTable $table) use ($view) { + $userId = new UserId(); + if (!$userId->hasDataTableUsers($table)) { + $view->config->removeColumnToDisplay('nb_users'); + } + + if ($table->getRowsCount() > 0 && !$table->getFirstRow()->hasColumn('nb_uniq_visitors')) { + $view->config->removeColumnToDisplay('nb_uniq_visitors'); + } + }; + } + } elseif ($this->scopeOfDimension === CustomDimensions::SCOPE_ACTION) { + $view->config->columns_to_display = array( + 'label', 'nb_hits', 'nb_visits', 'bounce_rate', 'avg_time_on_dimension', 'exit_rate', 'avg_time_generation' + ); + + $formatter = new Metrics\Formatter(); + + // add avg_generation_time tooltip + $tooltipCallback = function ($hits, $min, $max) use ($formatter) { + if (!$hits) { + return false; + } + + return Piwik::translate("Actions_AvgGenerationTimeTooltip", array( + $hits, + "<br />", + $formatter->getPrettyTimeFromSeconds($min, true), + $formatter->getPrettyTimeFromSeconds($max, true) + )); + }; + $view->config->filters[] = array('ColumnCallbackAddMetadata', + array( + array('nb_hits_with_time_generation', 'min_time_generation', 'max_time_generation'), + 'avg_time_generation_tooltip', + $tooltipCallback + ) + ); + } + + $view->config->show_table_all_columns = false; + } + + public function getMetrics() + { + $metrics = parent::getMetrics(); + + if ($this->scopeOfDimension === CustomDimensions::SCOPE_ACTION) { + $metrics['nb_visits'] = Piwik::translate('CustomDimensions_ColumnUniqueActions'); + } + + if (array_key_exists('nb_hits', $metrics)) { + $metrics['nb_hits'] = Piwik::translate('General_ColumnNbActions'); + } + + return $metrics; + } + + public function configureReportMetadata(&$availableReports, $infos) + { + if (!$this->isEnabled()) { + return; + } + + $idSite = $this->getIdSiteFromInfos($infos); + + if (isset($idSite)) { + $availableReports[] = $this->buildReportMetadata(); + } + } + + private function getActiveDimensionsForSite($idSite) + { + if (empty($this->dimensionCache[$idSite])) { + $this->dimensionCache[$idSite] = array(); + + $dimensions = Request::processRequest('CustomDimensions.getConfiguredCustomDimensions', ['idSite' => $idSite], []); + + foreach ($dimensions as $index => $dimension) { + if ($dimension['active']) { + $this->dimensionCache[$idSite][] = $dimension; + } + } + } + + return $this->dimensionCache[$idSite]; + } + + public function initThisReportFromDimension($dimension) + { + $this->name = $dimension['name']; + $this->menuTitle = $this->name; + $this->widgetTitle = $this->name; + $this->scopeOfDimension = $dimension['scope']; + $this->subcategoryId = 'customdimension' . $dimension['idcustomdimension']; + $dimensionField = CustomDimensionsRequestProcessor::buildCustomDimensionTrackingApiName($dimension); + + if ($this->scopeOfDimension === CustomDimensions::SCOPE_ACTION) { + $this->categoryId = 'General_Actions'; + $this->dimension = new CustomActionDimension($dimensionField, $this->name, $dimension['idcustomdimension']); + $this->metrics = array('nb_hits', 'nb_visits'); + $this->processedMetrics = array( + new AverageTimeOnDimension(), + new BounceRate(), + new ExitRate(), + new AveragePageGenerationTime() + ); + } elseif ($this->scopeOfDimension === CustomDimensions::SCOPE_VISIT) { + $this->categoryId = 'General_Visitors'; + $this->dimension = new CustomVisitDimension($dimensionField, $this->name, $dimension['idcustomdimension']); + $this->metrics = array('nb_visits', 'nb_actions'); + $this->processedMetrics = array( + new AverageTimeOnSite(), + new BounceRate(), + new ActionsPerVisit() + ); + } else { + return false; + } + + $this->parameters = array('idDimension' => $dimension['idcustomdimension']); + $this->order = 100 + $dimension['idcustomdimension']; + + return true; + } + + protected function getIdSiteFromInfos($infos) + { + if (!empty($infos['idSite'])) { + return $infos['idSite']; + } + + if (empty($infos['idSites'])) { + return; + } + + $idSites = $infos['idSites']; + + if (count($idSites) != 1) { + return null; + } + + $idSite = reset($idSites); + + return $idSite; + } + +} |