diff --git a/core/Archive.php b/core/Archive.php index 082c4fa00acb30cdb676446da37575cde1bc7328..63251f84878f35159942f5017d9b9a245d4aa8d3 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 831b03ba429d275d4eff33d6dfeee223fb53cbd3..90bbbb456e7f3a7a2e0e1f88c65fa47f84ecdeed 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 317140f16423f30210ee4d8c2243a0206efe216a..82f63d3d2c64e07f0f400a379873c690e1cee2e1 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);