From 6f4184081e0c4219f25c8c2869fc201ef2d6c118 Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 4 Apr 2013 15:10:48 +1300 Subject: Cleaning up the API output by removing some functions from display with @ignore tag --- plugins/API/API.php | 3 ++- plugins/Actions/API.php | 2 +- plugins/MobileMessaging/API.php | 2 +- plugins/Overlay/API.php | 1 + plugins/Transitions/API.php | 3 +++ 5 files changed, 8 insertions(+), 3 deletions(-) diff --git a/plugins/API/API.php b/plugins/API/API.php index a928068258..8ee2a44d8f 100644 --- a/plugins/API/API.php +++ b/plugins/API/API.php @@ -477,6 +477,7 @@ class Piwik_API_API /** * Returns the URL to application SVG Logo * + * @ignore * @param bool $pathOnly If true, returns path relative to doc root. Otherwise, returns a URL. * @return string */ @@ -496,7 +497,7 @@ class Piwik_API_API /** * Returns whether there is an SVG Logo available. - * + * @ignore * @return bool */ public function hasSVGLogo() diff --git a/plugins/Actions/API.php b/plugins/Actions/API.php index 33cb200b32..1904b3b72a 100644 --- a/plugins/Actions/API.php +++ b/plugins/Actions/API.php @@ -309,7 +309,7 @@ class Piwik_Actions_API } //Visitors can search, and then click "next" to view more results. This is the average number of search results pages viewed for this keyword. - public function addPagesPerSearchColumn($dataTable, $columnToRead = 'nb_hits') + protected function addPagesPerSearchColumn($dataTable, $columnToRead = 'nb_hits') { $dataTable->filter('ColumnCallbackAddColumnQuotient', array('nb_pages_per_search', $columnToRead, 'nb_visits', $precision = 1)); } diff --git a/plugins/MobileMessaging/API.php b/plugins/MobileMessaging/API.php index ae80979245..1d1c591bbf 100644 --- a/plugins/MobileMessaging/API.php +++ b/plugins/MobileMessaging/API.php @@ -145,8 +145,8 @@ class Piwik_MobileMessaging_API /** * sanitize phone number * + * @ignore * @param string $phoneNumber - * * @return string sanitized phone number */ public static function sanitizePhoneNumber($phoneNumber) diff --git a/plugins/Overlay/API.php b/plugins/Overlay/API.php index 413406fe43..1b9d943f26 100644 --- a/plugins/Overlay/API.php +++ b/plugins/Overlay/API.php @@ -28,6 +28,7 @@ class Piwik_Overlay_API /** * Get translation strings + * @ignore */ public function getTranslations($idSite) { diff --git a/plugins/Transitions/API.php b/plugins/Transitions/API.php index 67e4735dbd..80afa16d94 100644 --- a/plugins/Transitions/API.php +++ b/plugins/Transitions/API.php @@ -289,6 +289,9 @@ class Piwik_Transitions_API } } + /** + * @ignore + */ public function getTranslations() { $controller = new Piwik_Transitions_Controller(); -- cgit v1.2.3