|
static | doGarbageCollect () |
|
static | add ($user_ids, $url, $text, $html_id=null, $avatar=null, $dialog=false) |
|
static | getMyNotifications ($only_unread=true, $user_id=null, $limit=15) |
|
static | markAsRead ($notification_id, $user_id=null) |
|
static | markAllAsRead ($user_id=null) |
|
static | markAsReadByHTML ($html_id, $user_id=null) |
|
static | activate ($user_id=null) |
|
static | deactivate ($user_id=null) |
|
static | activateAudioFeedback ($user_id=null) |
|
static | deactivateAudioFeedback ($user_id=null) |
|
static | isGloballyActivated () |
|
static | isActivated ($user_id=null) |
|
static | isAudioActivated ($user_id=null) |
|
static | tableScheme ($db_table) |
|
static | expireTableScheme () |
|
static | exists ($id) |
|
static | countBySql ($sql= '1', $params=[]) |
|
static | create ($data) |
|
static | buildExisting ($data) |
|
static | import ($data) |
|
static | findBySQL ($sql, $params=[]) |
|
static | findOneBySQL ($where, $params=[]) |
|
static | findThru ($foreign_key_value, $options) |
|
static | findEachBySQL ($callable, $sql, $params=[]) |
|
static | findMany ($pks=[], $order= '', $order_params=[]) |
|
static | findEachMany ($callable, $pks=[], $order= '', $order_params=[]) |
|
static | findAndMapBySQL ($callable, $where, $params=[]) |
|
static | findAndMapMany ($callable, $pks=[], $order= '', $order_params=[]) |
|
static | deleteBySQL ($where, $params=[]) |
|
static | toObject ($id_or_object) |
|
static | __callStatic ($name, $arguments) |
|
static activate |
( |
|
$user_id = null | ) |
|
|
static |
Activates personal notifications for a given user.
- Parameters
-
string | null | $user_id | : ID of special user the notification should belong to or (default:) null for current user |
static activateAudioFeedback |
( |
|
$user_id = null | ) |
|
|
static |
Activates audio plopp for new personal notifications for a given user.
- Parameters
-
string | null | $user_id | : ID of special user the notification should belong to or (default:) null for current user |
static add |
( |
|
$user_ids, |
|
|
|
$url, |
|
|
|
$text, |
|
|
|
$html_id = null , |
|
|
|
$avatar = null , |
|
|
|
$dialog = false |
|
) |
| |
|
static |
Central function to add a personal notification to the user. This could be anything that needs to catch the attention of the user. The notification will be displayed in realtime to the user and he/she can get to the url.
- Parameters
-
array | string | $user_ids | : array of user_ids or a single md5-user_id |
string | $url | : URL of the point of interest of the notification |
string | $text | : a displayed text that describes the notification |
null | string | $html_id | : id in the html-document. If user reaches this html-element the notification will be marked as read, so the user does not need to handle the information twice. Optional. Default: null |
Icon | string | $avatar | : either an Icon or a URL of an image for the notification. Best size: 40px x 40px |
- Returns
- boolean : true on success
static configure |
( |
|
$config = [] | ) |
|
|
staticprotected |
static deactivate |
( |
|
$user_id = null | ) |
|
|
static |
Deactivates personal notifications for a given user.
- Parameters
-
string | null | $user_id | : ID of special user the notification should belong to or (default:) null for current user |
static deactivateAudioFeedback |
( |
|
$user_id = null | ) |
|
|
static |
Deactivates audio plopp for new personal notifications for a given user.
- Parameters
-
string | null | $user_id | : ID of special user the notification should belong to or (default:) null for current user |
static doGarbageCollect |
( |
| ) |
|
|
static |
Garbage collector the personal notifications. Removes all notifications older than 30 days.
static expireCache |
( |
|
$user_id | ) |
|
|
staticprotected |
Removes the cached entries for a specific user.
- Parameters
-
String | $user_id | Id of the user |
static getCache |
( |
|
$user_id | ) |
|
|
staticprotected |
Returns the cached values for a specific user.
- Parameters
-
String | $user_id | Id of the user |
- Returns
- mixed Array of item data (may be empty) or false if no data is cached
static getCacheHash |
( |
|
$user_id | ) |
|
|
staticprotected |
Returns the cache hash to use for a specific user.
- Parameters
-
String | $user_id | Id of the user |
- Returns
- String Cache hash to use for the user
Returns HTML-represantation of the notification which is a list-element.
- Returns
- string : html-output;
Returns (or retrieves) the number of "more unseen" notifications.
- Returns
- int Number of "more unseen" notifications
static getMyNotifications |
( |
|
$only_unread = true , |
|
|
|
$user_id = null , |
|
|
|
$limit = 15 |
|
) |
| |
|
static |
Returns all notifications fitting to the parameters.
- Parameters
-
boolean | $only_unread | : true for getting only unread notifications, false for all. |
null | string | $user_id | : ID of special user the notification should belong to or (default:) null for current user |
- Returns
- array of in ascending order of mkdate
static isActivated |
( |
|
$user_id = null | ) |
|
|
static |
Checks if a given user should see the personal notification. Either the Stud.IP or the user could deactivate personal notification. If neither is the case, this function returns true.
- Parameters
-
string | null | $user_id | : ID of special user the notification should belong to or (default:) null for current user |
- Returns
- boolean : true if activated else false
static isAudioActivated |
( |
|
$user_id = null | ) |
|
|
static |
Checks if a given user should hear audio plopp for new personal notification. Either the Stud.IP or the user could deactivate personal notification or audio feedback. If neither is the case, this function returns true.
- Parameters
-
string | null | $user_id | : ID of special user the notification should belong to or (default:) null for current user |
- Returns
- boolean : true if activated else false
static isGloballyActivated |
( |
| ) |
|
|
static |
Checks if personal notifications are activated for the whole Stud.IP. This could be false for performance issues.
- Returns
- boolean : true if activated else false
link |
( |
|
$user_id_or_object | ) |
|
Links this notification to user.
- Parameters
-
User | string | $user_id_or_object | User object or id of user |
- Returns
- PersonalNotificationsUser|false
static markAllAsRead |
( |
|
$user_id = null | ) |
|
|
static |
Marks all notifications as read by the user. It won't appear anymore in the notification-list on top of its site.
- Parameters
-
string | null | $user_id | : ID of special user the notification should belong to or (default:) null for current user |
- Returns
- boolean : true on success, false if it failed.
static markAsRead |
( |
|
$notification_id, |
|
|
|
$user_id = null |
|
) |
| |
|
static |
Mark a notification as read by the user. It won't appear anymore in the notification-list on top of its site.
- Parameters
-
string | $notification_id | : ID of the notification |
string | null | $user_id | : ID of special user the notification should belong to or (default:) null for current user |
static markAsReadByHTML |
( |
|
$html_id, |
|
|
|
$user_id = null |
|
) |
| |
|
static |
Mark a notification as read for the user by the given HTML-ID. It won't appear anymore in the notification-list on top of its site.
- Parameters
-
string | $html_id | : HTML ID attribute of the notification |
string | null | $user_id | : ID of special user the notification should belong to or (default:) null for current user |
static setCache |
( |
|
$user_id, |
|
|
|
$items |
|
) |
| |
|
staticprotected |
Stored the provided item data in cache for a specific user.
- Parameters
-
String | $user_id | Id of the user |
Array | $items | Raw db data of the items |
setmore_unseen |
( |
|
$unseen | ) |
|
Sets the value of the "more unseen" notifications (notification with same url but a different id).
- Parameters
-
int | $unseen | Number of more unseen notifications |
const CACHE_DURATION = 86400 |
The documentation for this class was generated from the following file: