diff options
| author | diosmosis <benakamoorthi@fastmail.fm> | 2013-12-08 22:12:48 +0400 |
|---|---|---|
| committer | diosmosis <benakamoorthi@fastmail.fm> | 2013-12-08 22:13:07 +0400 |
| commit | 13297a804c38999aa790af93f1d599e3c809dc7d (patch) | |
| tree | cdf7cb0b4df018853852a1af675041cd23944293 /core/Notification | |
| parent | 54bb5200d2567e51ff5a77dcd4dfa89195c169d9 (diff) | |
Fixes #4200, revised rest of @api classes/methods, closing ticket.
Diffstat (limited to 'core/Notification')
| -rw-r--r-- | core/Notification/Manager.php | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/core/Notification/Manager.php b/core/Notification/Manager.php index 879227ce5a..42452937fa 100644 --- a/core/Notification/Manager.php +++ b/core/Notification/Manager.php @@ -27,7 +27,7 @@ class Manager private static $session = null; /** - * Posts a notification that will be shown in Piwik's status bar. If a notification with the same id + * Posts a notification that will be shown in Piwik's status bar. If a notification with the same ID * has been posted and has not been closed/removed, it will be replaced with `$notification`. * * @param string $id A unique identifier for this notification. The ID must be a valid HTML @@ -44,8 +44,9 @@ class Manager } /** - * Cancel a previously registered (or persistent) notification. - * @param $id + * Removes a posted notification by ID. + * + * @param $id The notification ID, see {@link notify()}. */ public static function cancel($id) { @@ -55,8 +56,10 @@ class Manager } /** - * Cancels all previously registered non-persist notification. Call this method after the notifications have been - * displayed to make sure all non-persistent notifications won't be displayed multiple times. + * Removes all temporary notifications. + * + * Call this method after the notifications have been + * displayed to make sure temporary notifications won't be displayed twice. */ public static function cancelAllNonPersistent() { |