Function __global->add_leader_board
Definitions
sources/leader_board2.php
- Create a new leader-board.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: int
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $title | SHORT_TEXT | required parameter | N/A | N/A | The leader-board title |
| $board_type | SHORT_TEXT | required parameter | N/A | N/A | The type of leader-board |
| $member_count | integer | required parameter | N/A | N/A | The number of top members to use for this leader-board |
| $timeframe | SHORT_TEXT | required parameter | N/A | N/A | The frequency which to re-calculate the leader-board |
| $rolling | BINARY | required parameter | N/A | N/A | Whether or not re-calculation should be relative to the creation time of the leader-board |
| $include_staff | BINARY | required parameter | N/A | N/A | Whether or not to include staff in the leader-board |
| $usergroups | ?array | [] | N/A | N/A | Only allow members in one or more of the defined usergroup IDs to be in the leader-board (null: do nothing) (empty array: no usergroup filtering) |
| $calculate_voting_power | BINARY | 0 | N/A | N/A | Whether this leader-board should also calculate voting power and control percentages for leaders to display |
| $creation_time | ?TIME | Null | N/A | N/A | The forced creation time of the leader-board (null: do not force / use current time) |
Return
- The ID of the new leader-board
- Type: AUTO_LINK
- Set: N/A
- Range: N/A