Function __global->cns_find_birthdays

Definitions

sources/cns_general.php

  • Find all the birthdays in a certain day.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$time ?TIME No No Null N/A N/A A timestamps that exists in the certain day (null: now)
$ignore_upper_limit boolean No No False N/A N/A Whether we should ignore the configured upper limit
$timezone ?string No No Null N/A N/A Use the specified timezone when determining who has a birthday (null: use the timezone of the current member)

Returns

  • List of maps describing the members whose birthday it is on the certain day
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find all the birthdays in a certain day.
 *
 * @param  ?TIME $time A timestamps that exists in the certain day (null: now)
 * @param  boolean $ignore_upper_limit Whether we should ignore the configured upper limit
 * @param  ?string $timezone Use the specified timezone when determining who has a birthday (null: use the timezone of the current member)
 * @return array List of maps describing the members whose birthday it is on the certain day
 */
function cns_find_birthdays(?int $time = null, bool $ignore_upper_limit = false, ?string $timezone = null) : array