Piwik\Plugin\Report::getMetricsRequiredForReport PHP Method

Report Class Documentation Show file Open project: piwik/piwik

getMetricsRequiredForReport() public method

This will return all the metrics requested (or all the metrics in the report if nothing is requested) **plus** the metrics required to calculate the requested processed metrics. This method should be used in **Plugin.get** API methods.

public getMetricsRequiredForReport ( string[] \| null $allMetrics = null, string[] \| null $restrictToColumns = null ) : string[]
$allMetrics	string[] \| null	The list of all available unprocessed metrics. Defaults to this report's metrics.
$restrictToColumns	string[] \| null	The requested columns.
return	string[]

    public function getMetricsRequiredForReport($allMetrics = null, $restrictToColumns = null)
    {
        if (empty($allMetrics)) {
            $allMetrics = $this->metrics;
        }
        if (empty($restrictToColumns)) {
            $restrictToColumns = array_merge($allMetrics, array_keys($this->getProcessedMetrics()));
        }
        $processedMetricsById = $this->getProcessedMetricsById();
        $metricsSet = array_flip($allMetrics);
        $metrics = array();
        foreach ($restrictToColumns as $column) {
            if (isset($processedMetricsById[$column])) {
                $metrics = array_merge($metrics, $processedMetricsById[$column]->getDependentMetrics());
            } elseif (isset($metricsSet[$column])) {
                $metrics[] = $column;
            }
        }
        return array_unique($metrics);
    }

Report

__construct

alwaysUseDefaultViewDataTable

buildReportMetadata

checkIsEnabled

configureReportMetadata

configureView

configureWidgets

fetch

fetchSubtable

getAction

getActionToLoadSubTables