From 66f8fc3e0a2c97a22491bfaae3a16950f01425ed Mon Sep 17 00:00:00 2001
From: sgiehl <stefangiehl@gmail.com>
Date: Mon, 10 Dec 2012 21:26:41 +0000
Subject: [PATCH] fixed some docblocks
git-svn-id: http://dev.piwik.org/svn/trunk@7593 59fd770c-687e-43c8-a1e3-f5a4ff64c105
---
core/Archive.php | 2 +-
plugins/Actions/API.php | 55 ++++++++++++++++++++++++++++-----
plugins/CustomVariables/API.php | 39 +++++++++++++++++------
3 files changed, 79 insertions(+), 17 deletions(-)
diff --git a/core/Archive.php b/core/Archive.php
index 082c4fa00a..63251f8487 100644
--- a/core/Archive.php
+++ b/core/Archive.php
@@ -361,7 +361,7 @@ abstract class Piwik_Archive
* @param string $segment
* @param bool $expanded
* @param null $idSubtable
- * @return Piwik_DataTable
+ * @return Piwik_DataTable|Piwik_DataTable_Array
*/
static public function getDataTableFromArchive($name, $idSite, $period, $date, $segment, $expanded, $idSubtable = null )
{
diff --git a/plugins/Actions/API.php b/plugins/Actions/API.php
index 831b03ba42..90bbbb456e 100644
--- a/plugins/Actions/API.php
+++ b/plugins/Actions/API.php
@@ -52,7 +52,7 @@ class Piwik_Actions_API
* @param bool $segment
* @param bool $expanded
* @param bool|int $idSubtable
- * @return Piwik_DataTable
+ * @return Piwik_DataTable|Piwik_DataTable_Array
*/
public function getActions( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )
{
@@ -114,8 +114,18 @@ class Piwik_Actions_API
return $table;
}
-
- public function getPageUrls( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )
+
+ /**
+ * @param int $idSite
+ * @param string $period
+ * @param Piwik_Date $date
+ * @param bool $segment
+ * @param bool $expanded
+ * @param bool $idSubtable
+ *
+ * @return Piwik_DataTable|Piwik_DataTable_Array
+ */
+ public function getPageUrls( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )
{
$dataTable = Piwik_Archive::getDataTableFromArchive('Actions_actions_url', $idSite, $period, $date, $segment, $expanded, $idSubtable );
$this->filterPageDatatable($dataTable);
@@ -123,21 +133,44 @@ class Piwik_Actions_API
return $dataTable;
}
- public function getPageUrlsFollowingSiteSearch( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )
+ /**
+ * @param int $idSite
+ * @param string $period
+ * @param Piwik_Date $date
+ * @param bool $segment
+ * @param bool $expanded
+ * @param bool $idSubtable
+ *
+ * @return Piwik_DataTable|Piwik_DataTable_Array
+ */
+ public function getPageUrlsFollowingSiteSearch( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )
{
$dataTable = $this->getPageUrls($idSite, $period, $date, $segment, $expanded, $idSubtable);
$this->keepPagesFollowingSearch($dataTable);
return $dataTable;
}
- public function getPageTitlesFollowingSiteSearch( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )
+ /**
+ * @param int $idSite
+ * @param string $period
+ * @param Piwik_Date $date
+ * @param bool $segment
+ * @param bool $expanded
+ * @param bool $idSubtable
+ *
+ * @return Piwik_DataTable|Piwik_DataTable_Array
+ */
+ public function getPageTitlesFollowingSiteSearch( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )
{
$dataTable = $this->getPageTitles($idSite, $period, $date, $segment, $expanded, $idSubtable);
$this->keepPagesFollowingSearch($dataTable);
return $dataTable;
}
- protected function keepPagesFollowingSearch($dataTable)
+ /**
+ * @param Piwik_DataTable $dataTable
+ */
+ protected function keepPagesFollowingSearch($dataTable)
{
// Keep only pages which are following site search
$dataTable->filter('ColumnCallbackDeleteRow', array(
@@ -286,7 +319,15 @@ class Piwik_Actions_API
return $dataTable;
}
- public function getSiteSearchCategories( $idSite, $period, $date, $segment = false )
+ /**
+ * @param int $idSite
+ * @param string $period
+ * @param Piwik_Date $date
+ * @param bool $segment
+ *
+ * @return Piwik_DataTable|Piwik_DataTable_Array
+ */
+ public function getSiteSearchCategories( $idSite, $period, $date, $segment = false )
{
Piwik_Actions::checkCustomVariablesPluginEnabled();
$customVariables = Piwik_CustomVariables_API::getInstance()->getCustomVariables($idSite, $period, $date, $segment, $expanded = false, $_leavePiwikCoreVariables = true);
diff --git a/plugins/CustomVariables/API.php b/plugins/CustomVariables/API.php
index 317140f164..82f63d3d2c 100644
--- a/plugins/CustomVariables/API.php
+++ b/plugins/CustomVariables/API.php
@@ -31,9 +31,16 @@ class Piwik_CustomVariables_API
return self::$instance;
}
- /**
- * @return Piwik_DataTable
- */
+ /**
+ * @param int $idSite
+ * @param string $period
+ * @param Piwik_Date $date
+ * @param string $segment
+ * @param bool $expanded
+ * @param int $idSubtable
+ *
+ * @return Piwik_DataTable|Piwik_DataTable_Array
+ */
protected function getDataTable($idSite, $period, $date, $segment, $expanded, $idSubtable)
{
$dataTable = Piwik_Archive::getDataTableFromArchive('CustomVariables_valueByName', $idSite, $period, $date, $segment, $expanded, $idSubtable);
@@ -42,9 +49,16 @@ class Piwik_CustomVariables_API
return $dataTable;
}
- /**
- * @return Piwik_DataTable
- */
+ /**
+ * @param int $idSite
+ * @param string $period
+ * @param Piwik_Date $date
+ * @param string|bool $segment
+ * @param bool $expanded
+ * @param bool $_leavePiwikCoreVariables
+ *
+ * @return Piwik_DataTable|Piwik_DataTable_Array
+ */
public function getCustomVariables($idSite, $period, $date, $segment = false, $expanded = false, $_leavePiwikCoreVariables = false)
{
$dataTable = $this->getDataTable($idSite, $period, $date, $segment, $expanded, $idSubtable = null);
@@ -65,9 +79,16 @@ class Piwik_CustomVariables_API
return $dataTable;
}
- /**
- * @return Piwik_DataTable
- */
+ /**
+ * @param int $idSite
+ * @param string $period
+ * @param Piwik_Date $date
+ * @param int $idSubtable
+ * @param string|bool $segment
+ * @param bool $_leavePriceViewedColumn
+ *
+ * @return Piwik_DataTable|Piwik_DataTable_Array
+ */
public function getCustomVariablesValuesFromNameId($idSite, $period, $date, $idSubtable, $segment = false, $_leavePriceViewedColumn = false)
{
$dataTable = $this->getDataTable($idSite, $period, $date, $segment, $expanded = false, $idSubtable);
--
GitLab