Function __global->find_concrete_day_of_month
Definitions
sources/calendar.php
- Given a specially encoded day of month, work out the real day of the month.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: int
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $year | integer | No | No | required parameter | N/A | N/A | The concrete year |
| $month | integer | No | No | required parameter | N/A | N/A | The concrete month |
| $day | integer | No | No | required parameter | N/A | N/A | The encoded day of month |
| $monthly_spec_type | ID_TEXT | No | No | required parameter | day_of_month day_of_month_backwards dow_of_month dow_of_month_backwards | N/A | In-month specification type |
| $hour | ?integer | No | No | required parameter | N/A | N/A | The concrete hour (null: arbitrary) |
| $minute | ?integer | No | No | required parameter | N/A | N/A | The concrete minute (null: arbitrary) |
| $timezone | ID_TEXT | No | No | required parameter | N/A | N/A | The timezone of the event |
| $show_in_users_timezone | boolean | No | No | required parameter | N/A | N/A | Whether to do a timezone conversion (NB: unused, as this is before conversion to what dates users see - we are only using timezones here to push the nth weekday appropriately to the correct timezone, due to alignment problems) |
Returns
- Concrete day
- Type: integer
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Given a specially encoded day of month, work out the real day of the month.
*
* @param integer $year The concrete year
* @param integer $month The concrete month
* @param integer $day The encoded day of month
* @param ID_TEXT $monthly_spec_type In-month specification type
* @set day_of_month day_of_month_backwards dow_of_month dow_of_month_backwards
* @param ?integer $hour The concrete hour (null: arbitrary)
* @param ?integer $minute The concrete minute (null: arbitrary)
* @param ID_TEXT $timezone The timezone of the event
* @param boolean $show_in_users_timezone Whether to do a timezone conversion (NB: unused, as this is before conversion to what dates users see - we are only using timezones here to push the nth weekday appropriately to the correct timezone, due to alignment problems)
* @return integer Concrete day
*/
function find_concrete_day_of_month(int $year, int $month, int $day, string $monthly_spec_type, ?int $hour, ?int $minute, string $timezone, bool $show_in_users_timezone) : int
* Given a specially encoded day of month, work out the real day of the month.
*
* @param integer $year The concrete year
* @param integer $month The concrete month
* @param integer $day The encoded day of month
* @param ID_TEXT $monthly_spec_type In-month specification type
* @set day_of_month day_of_month_backwards dow_of_month dow_of_month_backwards
* @param ?integer $hour The concrete hour (null: arbitrary)
* @param ?integer $minute The concrete minute (null: arbitrary)
* @param ID_TEXT $timezone The timezone of the event
* @param boolean $show_in_users_timezone Whether to do a timezone conversion (NB: unused, as this is before conversion to what dates users see - we are only using timezones here to push the nth weekday appropriately to the correct timezone, due to alignment problems)
* @return integer Concrete day
*/
function find_concrete_day_of_month(int $year, int $month, int $day, string $monthly_spec_type, ?int $hour, ?int $minute, string $timezone, bool $show_in_users_timezone) : int
