diff --git a/plugins/API/ProcessedReport.php b/plugins/API/ProcessedReport.php index b30a3d79018394b80a4adb76121074ad4e4fd168..80a31b83f9ac53f9d797f46499d4b93e78b321be 100644 --- a/plugins/API/ProcessedReport.php +++ b/plugins/API/ProcessedReport.php @@ -318,7 +318,7 @@ class Piwik_API_ProcessedReport * - translate metric names to a separate array : $columns * * @param int $idSite enables monetary value formatting based on site currency - * @param \Piwik\DataTable\Set $dataTable + * @param \Piwik\DataTable\Map $dataTable * @param array $reportMetadata * @param bool $showRawMetrics * @return array Simple|Set $newReport with human readable format & array $columns list of translated column names & Simple|Set $rowsMetadata diff --git a/plugins/API/RowEvolution.php b/plugins/API/RowEvolution.php index 21ab108c8d5262736682d74e18bd40fad0c25a4c..f8ff5e2235da1e494a8646854c1d3ab233ec4b9d 100644 --- a/plugins/API/RowEvolution.php +++ b/plugins/API/RowEvolution.php @@ -91,6 +91,11 @@ class Piwik_API_RowEvolution return $dataTable; } + /** + * @param DataTable\Map $dataTable + * @param array $labels + * @return array + */ protected function getLabelsFromDataTable($dataTable, $labels) { // if no labels specified, use all possible labels as list @@ -112,7 +117,7 @@ class Piwik_API_RowEvolution /** * Get row evolution for a single label - * @param DataTable $dataTable + * @param DataTable\Map $dataTable * @param array $metadata * @param string $apiModule * @param string $apiAction @@ -173,6 +178,13 @@ class Piwik_API_RowEvolution return $return; } + /** + * @param Row $row + * @param string $apiModule + * @param string $apiAction + * @param bool $labelUseAbsoluteUrl + * @return bool|string + */ private function getRowUrlForEvolutionLabel($row, $apiModule, $apiAction, $labelUseAbsoluteUrl) { $url = $row->getMetadata('url'); diff --git a/plugins/Actions/API.php b/plugins/Actions/API.php index 263e3e4a6b63219d7c5bf15076778ea0a16d326b..768389f8c00f8d64c78b017829eb788bd9c665b3 100644 --- a/plugins/Actions/API.php +++ b/plugins/Actions/API.php @@ -288,7 +288,12 @@ class Piwik_Actions_API return $dataTable; } - //Visitors can search, and then click "next" to view more results. This is the average number of search results pages viewed for this keyword. + /** + * Visitors can search, and then click "next" to view more results. This is the average number of search results pages viewed for this keyword. + * + * @param DataTable|DataTable\Simple|DataTable\Map $dataTable + * @param string $columnToRead + */ protected function addPagesPerSearchColumn($dataTable, $columnToRead = 'nb_hits') { $dataTable->filter('ColumnCallbackAddColumnQuotient', array('nb_pages_per_search', $columnToRead, 'nb_visits', $precision = 1)); @@ -463,6 +468,8 @@ class Piwik_Actions_API /** * Common filters for Page URLs and Page Titles + * + * @param DataTable|DataTable\Simple|DataTable\Map $dataTable */ protected function filterPageDatatable($dataTable) { @@ -507,7 +514,10 @@ class Piwik_Actions_API } /** - * Common filters for all Actions API getters + * Common filters for all Actions API + * + * @param DataTable|DataTable\Simple|DataTable\Map $dataTable + * @param bool $expanded */ protected function filterActionsDataTable($dataTable, $expanded = false) { diff --git a/plugins/Actions/Actions.php b/plugins/Actions/Actions.php index fdd116c671626acb1577568cdfdd7669200bd767..2d78cf995910043301ed4c9a8f45f463ca15bd70 100644 --- a/plugins/Actions/Actions.php +++ b/plugins/Actions/Actions.php @@ -669,7 +669,11 @@ class Piwik_Actions extends Plugin return $result; } - + + /** + * @param \Piwik\DataTable $dataTable + * @param int $level + */ public static function setDataTableRowLevels($dataTable, $level = 0) { foreach ($dataTable->getRows() as $row) { diff --git a/plugins/Annotations/API.php b/plugins/Annotations/API.php index e0c62e839098e0b8eda9f1644086fd8dc767b71c..b1abd3c480707a1a6ead0a48897b549d8c4a4c5a 100755 --- a/plugins/Annotations/API.php +++ b/plugins/Annotations/API.php @@ -305,7 +305,7 @@ class Piwik_Annotations_API * @param bool|int $lastN Whether to include the last N periods in the range or not. * Ignored if period == range. * - * @return array + * @return Date[] array of Date objects or array(false, false) * @ignore */ public static function getDateRangeForPeriod($date, $period, $lastN = false) diff --git a/plugins/ExampleRssWidget/Controller.php b/plugins/ExampleRssWidget/Controller.php index aaa53a7ef16129d49cd7028be095fb966ac68e0a..ce1806b632ce2511116e50e3833beac4e47daf7c 100644 --- a/plugins/ExampleRssWidget/Controller.php +++ b/plugins/ExampleRssWidget/Controller.php @@ -40,6 +40,9 @@ class Piwik_ExampleRssWidget_Controller extends Controller } } + /** + * @param \Exception $e + */ protected function error($e) { echo '<div class="pk-emptyDataTable">' diff --git a/plugins/Installation/FormDatabaseSetup.php b/plugins/Installation/FormDatabaseSetup.php index f4d1f9924789eebe9ff090b4a7e1b1dff9609856..cd55df856a87c7b27e7746f2d5a9c3cb186683e6 100644 --- a/plugins/Installation/FormDatabaseSetup.php +++ b/plugins/Installation/FormDatabaseSetup.php @@ -283,7 +283,7 @@ class Piwik_Installation_FormDatabaseSetup_Rule_checkUserPrivileges extends HTML /** * Drops the tables created by the privilege checking queries, if they exist. * - * @param $db The database object to use. + * @param \Piwik\Db $db The database object to use. */ private function dropExtraTables($db) { diff --git a/plugins/MultiSites/API.php b/plugins/MultiSites/API.php index 6e4feeba76c821b16a2f857e86f3d2f159168f2a..dbaf64e0a45324000da8f31ccc3357c52db7ae0a 100755 --- a/plugins/MultiSites/API.php +++ b/plugins/MultiSites/API.php @@ -396,8 +396,8 @@ class Piwik_MultiSites_API * Sets the total evolution metadata for a datatable returned by $this->buildDataTable * given data for the last period. * - * @param DataTable $dataTable - * @param DataTable $pastData + * @param DataTable|DataTable\Map $dataTable + * @param DataTable|DataTable\Map $pastData * @param array $apiMetrics Metrics info. */ private function setPastDataMetadata($dataTable, $pastData, $apiMetrics) diff --git a/plugins/UserCountry/LocationProvider.php b/plugins/UserCountry/LocationProvider.php index 40751b72475e08b8abcd0bd89192bbe2b8c48fd2..bb82ebc9f5c925fde557b4ab3a9e0cdd58f89b8f 100755 --- a/plugins/UserCountry/LocationProvider.php +++ b/plugins/UserCountry/LocationProvider.php @@ -132,7 +132,7 @@ abstract class Piwik_UserCountry_LocationProvider /** * Returns every available provider instance. * - * @return array + * @return Piwik_UserCountry_LocationProvider[] */ public static function getAllProviders() { diff --git a/plugins/UserCountry/LocationProvider/Default.php b/plugins/UserCountry/LocationProvider/Default.php index a7798a5ca0f2322e58d9814c8378c12fc4e146fc..f5956076b66663c8dfda60a3e73e4062316f5ca2 100755 --- a/plugins/UserCountry/LocationProvider/Default.php +++ b/plugins/UserCountry/LocationProvider/Default.php @@ -48,7 +48,7 @@ class Piwik_UserCountry_LocationProvider_Default extends Piwik_UserCountry_Locat * * This implementation is always available. * - * @return true + * @return bool always true */ public function isAvailable() { @@ -60,7 +60,7 @@ class Piwik_UserCountry_LocationProvider_Default extends Piwik_UserCountry_Locat * * This implementation is always working correctly. * - * @return true + * @return bool always true */ public function isWorking() { diff --git a/plugins/UsersManager/API.php b/plugins/UsersManager/API.php index 9c9c1a776eb656c314183cdc4d7fde8ea9af6ca9..104961c951a40e9a9db921d8e44424771d214694 100644 --- a/plugins/UsersManager/API.php +++ b/plugins/UsersManager/API.php @@ -201,7 +201,7 @@ class Piwik_UsersManager_API * If a user doesn't have any access to the $idSite ('noaccess'), * the user will not be in the returned array. * - * @param int website ID + * @param int $idSite website ID * * @return array The returned array has the format * array(