IntlCalendar::getWeekendTransition
(PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1)
IntlCalendar::getWeekendTransition — Get time of the day at which weekend begins or ends
Description
Object-oriented style
$dayOfWeek): int|falseProcedural style
Returns the number of milliseconds after midnight at which the weekend begins or ends.
This is only applicable for days of the week for which
IntlCalendar::getDayOfWeekType() returns either
IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or
IntlCalendar::DOW_TYPE_WEEKEND_CEASE. Calling this
function for other days of the week is an error condition.
This function requires ICU 4.4 or later.
Parameters
-
calendar -
An IntlCalendar instance.
-
dayOfWeek -
One of the constants
IntlCalendar::DOW_SUNDAY,IntlCalendar::DOW_MONDAY, …,IntlCalendar::DOW_SATURDAY.
Return Values
The number of milliseconds into the day at which the weekend begins or
ends or false on failure.
Examples
See example on IntlCalendar::getDayOfWeekType().
