Function __global->get_users_online

Definitions

sources/users2.php

  • Get database rows of all the online members.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$longer_time boolean No No required parameter N/A N/A Whether to use a longer online-time -- the session expiry-time
$filter ?MEMBER No No required parameter N/A N/A We really only need to make sure we get the status for this user, although at this functions discretion more may be returned and the row won't be there if the user is not online (null: no filter). May not be the guest ID
&$count integer Yes No required parameter N/A N/A The total online members, returned by reference

Returns

  • Database rows (null: too many)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get database rows of all the online members.
 *
 * @param  boolean $longer_time Whether to use a longer online-time -- the session expiry-time
 * @param  ?MEMBER $filter We really only need to make sure we get the status for this user, although at this functions discretion more may be returned and the row won't be there if the user is not online (null: no filter). May not be the guest ID
 * @param  integer $count The total online members, returned by reference
 * @return ?array Database rows (null: too many)
 */
function get_users_online(bool $longer_time, ?int $filter, int &$count) : ?array