IntlCalendar::getWeekendTransition
IntlCalendar::getWeekendTransition
(PHP 5.5.0, PHP 7, PECL >= 3.0.0a1)
IntlCalendar::getWeekendTransition — Get time of the day at which weekend begins or ends
Description
Object oriented style
public int IntlCalendar::getWeekendTransition ( string $dayOfWeek )
Procedural style
int intlcal_get_weekend_transition ( IntlCalendar $cal , string $dayOfWeek )
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
-
cal -
The IntlCalendar resource.
-
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().
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/intlcalendar.getweekendtransition.php
