Function __global->cal_get_end_utctime_for_event
Definitions
sources/calendar.php
- Get the UTC end time for a specified UTC time event.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: int
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $timezone | ID_TEXT | No | No | required parameter | N/A | N/A | The timezone of the event |
| $year | integer | No | No | required parameter | N/A | N/A | Year |
| $month | integer | No | No | required parameter | N/A | N/A | Month |
| $day | integer | No | No | required parameter | N/A | N/A | Day |
| $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 | Hour (null: end hour of day in the timezone expressed as UTC, for whatever day the given midnight day/month/year shifts to after timezone conversion) |
| $minute | ?integer | No | No | required parameter | N/A | N/A | Minute (null: end minute of day in the timezone expressed as UTC, for whatever day the given midnight day/month/year shifts to after timezone conversion) |
| $show_in_users_timezone | boolean | No | No | required parameter | N/A | N/A | Whether the time will be converted to the $timezone instead of UTC *later*. If not then the "UTC time" returned is actually gauged for $timezone, as that's how it was opted to be displayed. |
Returns
- Timestamp
- Type: TIME
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get the UTC end time for a specified UTC time event.
*
* @param ID_TEXT $timezone The timezone of the event
* @param integer $year Year
* @param integer $month Month
* @param integer $day Day
* @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 Hour (null: end hour of day in the timezone expressed as UTC, for whatever day the given midnight day/month/year shifts to after timezone conversion)
* @param ?integer $minute Minute (null: end minute of day in the timezone expressed as UTC, for whatever day the given midnight day/month/year shifts to after timezone conversion)
* @param boolean $show_in_users_timezone Whether the time will be converted to the $timezone instead of UTC *later*. If not then the "UTC time" returned is actually gauged for $timezone, as that's how it was opted to be displayed.
* @return TIME Timestamp
*/
function cal_get_end_utctime_for_event(string $timezone, int $year, int $month, int $day, string $monthly_spec_type, ?int $hour, ?int $minute, bool $show_in_users_timezone) : int
* Get the UTC end time for a specified UTC time event.
*
* @param ID_TEXT $timezone The timezone of the event
* @param integer $year Year
* @param integer $month Month
* @param integer $day Day
* @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 Hour (null: end hour of day in the timezone expressed as UTC, for whatever day the given midnight day/month/year shifts to after timezone conversion)
* @param ?integer $minute Minute (null: end minute of day in the timezone expressed as UTC, for whatever day the given midnight day/month/year shifts to after timezone conversion)
* @param boolean $show_in_users_timezone Whether the time will be converted to the $timezone instead of UTC *later*. If not then the "UTC time" returned is actually gauged for $timezone, as that's how it was opted to be displayed.
* @return TIME Timestamp
*/
function cal_get_end_utctime_for_event(string $timezone, int $year, int $month, int $day, string $monthly_spec_type, ?int $hour, ?int $minute, bool $show_in_users_timezone) : int
