Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsgiehl <stefan@piwik.org>2013-07-06 20:00:00 +0400
committersgiehl <stefan@piwik.org>2013-07-06 20:00:00 +0400
commitbfd7e1fa5d0df717d7e715a99cd741d76229f7d4 (patch)
tree88bb71abcb142612013781d0f3915734cb2dce7e /plugins/API
parent1f787b2c435d7e5b2e33d2aeffa821eccb546bf7 (diff)
fixed several doc blocks
Diffstat (limited to 'plugins/API')
-rw-r--r--plugins/API/API.php18
-rw-r--r--plugins/API/ProcessedReport.php8
-rw-r--r--plugins/API/RowEvolution.php6
3 files changed, 30 insertions, 2 deletions
diff --git a/plugins/API/API.php b/plugins/API/API.php
index e7fdca482b..8348724cc4 100644
--- a/plugins/API/API.php
+++ b/plugins/API/API.php
@@ -398,6 +398,10 @@ class Piwik_API_API
* 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|Piwik_Date $date
+ * @param bool $hideMetricsDoc
+ * @param bool $showSubtableReports
* @return array
*/
public function getReportMetadata($idSites = '', $period = false, $date = false, $hideMetricsDoc = false,
@@ -521,6 +525,18 @@ class Piwik_API_API
* this function will query the API for the previous days/weeks/etc. and will return
* a ready to use data structure containing the metrics for the requested Label, along with enriched information (min/max values, etc.)
*
+ * @param int $idSite
+ * @param string $period
+ * @param Piwik_Date $date
+ * @param string $apiModule
+ * @param string $apiAction
+ * @param bool|string $label
+ * @param bool|string $segment
+ * @param bool|string $column
+ * @param bool|string $language
+ * @param bool|int $idGoal
+ * @param bool|string $legendAppendMetric
+ * @param bool|string $labelUseAbsoluteUrl
* @return array
*/
public function getRowEvolution($idSite, $period, $date, $apiModule, $apiAction, $label = false, $segment = false, $column = false, $language = false, $idGoal = false, $legendAppendMetric = true, $labelUseAbsoluteUrl = true)
@@ -534,6 +550,7 @@ class Piwik_API_API
* Performs multiple API requests at once and returns every result.
*
* @param array $urls The array of API requests.
+ * @return array
*/
public function getBulkRequest($urls)
{
@@ -556,6 +573,7 @@ class Piwik_API_API
* Given a segment, will return a list of the most used values for this particular segment.
* @param $segmentName
* @param $idSite
+ * @return array
* @throws Exception
*/
public function getSuggestedValuesForSegment($segmentName, $idSite)
diff --git a/plugins/API/ProcessedReport.php b/plugins/API/ProcessedReport.php
index 63cc65bde3..a2a550b056 100644
--- a/plugins/API/ProcessedReport.php
+++ b/plugins/API/ProcessedReport.php
@@ -53,6 +53,10 @@ class Piwik_API_ProcessedReport
* 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|Piwik_Date $date
+ * @param bool $hideMetricsDoc
+ * @param bool $showSubtableReports
* @return array
*/
public function getReportMetadata($idSites, $period = false, $date = false, $hideMetricsDoc = false, $showSubtableReports = false)
@@ -303,9 +307,9 @@ class Piwik_API_ProcessedReport
* @param int $idSite enables monetary value formatting based on site currency
* @param Piwik_DataTable|Piwik_DataTable_Array $dataTable
* @param array $reportMetadata
- * @param boolean $hasDimension
+ * @param bool $showRawMetrics
* @return array Piwik_DataTable_Simple|Piwik_DataTable_Array $newReport with human readable format & array $columns list of translated column names & Piwik_DataTable_Simple|Piwik_DataTable_Array $rowsMetadata
- **/
+ */
private function handleTableReport($idSite, $dataTable, &$reportMetadata, $showRawMetrics = false)
{
$hasDimension = isset($reportMetadata['dimension']);
diff --git a/plugins/API/RowEvolution.php b/plugins/API/RowEvolution.php
index 2daac7083b..99e62a21b8 100644
--- a/plugins/API/RowEvolution.php
+++ b/plugins/API/RowEvolution.php
@@ -101,6 +101,12 @@ class Piwik_API_RowEvolution
/**
* Get row evolution for a single label
+ * @param Piwik_DataTable $dataTable
+ * @param array $metadata
+ * @param string $apiModule
+ * @param string $apiAction
+ * @param string $label
+ * @param bool $labelUseAbsoluteUrl
* @return array containing report data, metadata, label, logo
*/
private function getSingleRowEvolution($dataTable, $metadata, $apiModule, $apiAction, $label, $labelUseAbsoluteUrl = true)