Returns metadata information about each report (category, name, dimension, metrics, etc.)
public getReportMetadata ( integer $idSite, boolean | string $period = false, boolean | |
||
$idSite | integer | |
$period | boolean | string | |
$date | boolean | |
|
$hideMetricsDoc | boolean | |
$showSubtableReports | boolean | |
Результат | array |
/** * Triggers a hook to ask plugins for available Reports. * Returns metadata information about each report (category, name, dimension, metrics, etc.) * * @param string $idSites THIS PARAMETER IS DEPRECATED AND WILL BE REMOVED IN PIWIK 4 * @param bool|string $period * @param bool|Date $date * @param bool $hideMetricsDoc * @param bool $showSubtableReports * @param int $idSite * @return array */ public function getReportMetadata($idSites = '', $period = false, $date = false, $hideMetricsDoc = false, $showSubtableReports = false, $idSite = false) { if (empty($idSite) && !empty($idSites)) { if (is_array($idSites)) { $idSite = array_shift($idSites); } else { $idSite = $idSites; } } elseif (empty($idSite) && empty($idSites)) { throw new \Exception('Calling API.getReportMetadata without any idSite is no longer supported since Piwik 3.0.0. Please specifiy at least one idSite via the "idSite" parameter.'); } Piwik::checkUserHasViewAccess($idSite); $metadata = $this->processedReport->getReportMetadata($idSite, $period, $date, $hideMetricsDoc, $showSubtableReports); return $metadata; }
/** * Triggers a hook to ask plugins for available Reports. * Returns metadata information about each report (category, name, dimension, metrics, etc.) * * @param string $idSites Comma separated list of website Ids * @param bool|string $period * @param bool|Date $date * @param bool $hideMetricsDoc * @param bool $showSubtableReports * @return array */ public function getReportMetadata($idSites = '', $period = false, $date = false, $hideMetricsDoc = false, $showSubtableReports = false) { Piwik::checkUserHasViewAccess($idSites); $reporter = new ProcessedReport(); $metadata = $reporter->getReportMetadata($idSites, $period, $date, $hideMetricsDoc, $showSubtableReports); return $metadata; }