Function __global->_get_next_leader_board_timeframe

Definitions

sources/leader_board.php

  • Determine the start and end times for the next result set that needs generating for a leader-board.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$row array No No required parameter N/A N/A The leader-board row
$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

  • A ?TIME duple containing start and end; both will be null if this leader-board should not generate a result set at this time
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Determine the start and end times for the next result set that needs generating for a leader-board.
 *
 * @param  array $row The leader-board row
 * @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 A ?TIME duple containing start and end; both will be null if this leader-board should not generate a result set at this time
 */
function _get_next_leader_board_timeframe(array $row, ?int $forced_time = null, ?int $forced_period_start = null) : array