Function __global->get_leader_board
Definitions
sources/leader_board.php
- Get a result set for a given leader-board.This ignores dummy guest entries as they only serve to indicate an empty leader-board was generated.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the leader-board |
| $timestamp | ?TIME | No | No | Null | N/A | N/A | The timestamp of the result set to fetch (null: fetch the latest result set) |
Returns
- The result set, or empty if not found
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get a result set for a given leader-board.This ignores dummy guest entries as they only serve to indicate an empty leader-board was generated.
*
* @param AUTO_LINK $id The ID of the leader-board
* @param ?TIME $timestamp The timestamp of the result set to fetch (null: fetch the latest result set)
* @return array The result set, or empty if not found
*/
function get_leader_board(int $id, ?int $timestamp = null) : array
* Get a result set for a given leader-board.This ignores dummy guest entries as they only serve to indicate an empty leader-board was generated.
*
* @param AUTO_LINK $id The ID of the leader-board
* @param ?TIME $timestamp The timestamp of the result set to fetch (null: fetch the latest result set)
* @return array The result set, or empty if not found
*/
function get_leader_board(int $id, ?int $timestamp = null) : array
