Function __global->calculate_all_leader_boards

Definitions

sources/leader_board.php

  • Check all leader-boards and generate new result sets when applicable.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$forced_time ?TIME No No Null N/A N/A Pretend the current time is the provided timestamp (null: use the current time in the site's timezone)
$forced_period_start ?TIME No No Null N/A N/A Pretend the most recent result set was generated on the provided timestamp (null: use the actual most recent timestamp)

Returns

  • Map of leader_board IDs to their new result set timestamp
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Check all leader-boards and generate new result sets when applicable.
 *
 * @param  ?TIME $forced_time Pretend the current time is the provided timestamp (null: use the current time in the site's timezone)
 * @param  ?TIME $forced_period_start Pretend the most recent result set was generated on the provided timestamp (null: use the actual most recent timestamp)
 * @return array Map of leader_board IDs to their new result set timestamp
 */
function calculate_all_leader_boards(?int $forced_time = null, ?int $forced_period_start = null) : array