getMembersOnlineStats
Description
This function retrieves a list and several other statistics of the users currently online.
Syntax
array getMembersOnlineStats (array $membersOnlineOptions)
Parameter $membersOnlineOptions
Expected type: Array
Description: An array of options for the list of members online.
| Array Elements of $membersOnlineOptions | |||
| Key | Optional | Expected type | Description |
| reverse_sort | yes | Boolean | Whether or not to sort the list in reverse (descending) order |
| show_hidden | yes | Boolean | Whether or not to show hidden users in the list |
| sort | yes | String | Which column to sort the results by. Can currently be 'log_time', 'show_online', 'online_color' or 'group_name' |
Return value
Expected type: Array
Description: $memberOnlineStats, an array of information about the users who are currently online
| Array Elements | |||
| Key | Optional | Expected type | Description |
| list_users_online | no | Array | An array of links to the profiles of users online (same key as users_online, italicized if they're hidden) |
| num_buddies | no | Integer | Total number of online users who are on your buddy list |
| num_guests | no | Integer | Total number of guests who are online |
| num_spiders | no | Integer | Total number of (recognized) search engine spiders that are online |
| num_users_hidden | no | Integer | Total number of online users who have chosen to hide their online status |
| num_users_online | no | Integer | Total number of all users (guests, members and spiders) who are online |
| online_groups | no | Array | An array of arrays with information about the usergroups that the online members are in. The key is the group ID, and each array contains id, name and color |
| users_online | no | Array | An array of info about a particular user. The key is the sort method with the username tacked onto the end (eg "log_timeoldiesmann"). Each array has id, username, name (display name), group, href (url to their profile), link (formatted HTML link to their profile), is_buddy (whether or not this user is on the current user's buddy list), hidden (whether or not they're hidden) and is_last (whether or not this is the last item in the array) |