IntlCalendar::isWeekend
Whether a certain date/time is in the weekend
Description
Object-oriented style
public bool IntlCalendar::isWeekend(floatnull $timestamp = null)
bool intlcal_is_weekend(IntlCalendar $calendar, floatnull $timestamp = null)
This function requires ICU 4.4 or later.
Parameters
-
calendar
-
An IntlCalendar instance.
-
timestamp
-
An optional timestamp representing the number of milliseconds since the
epoch, excluding leap seconds. If null, this objectʼs current time is
used instead.
Return Values
A bool indicating whether the given or this objectʼs time occurs
in a weekend.
On failure false is also returned. To detect error conditions use intl_get_error_code, or set up Intl to throw exceptions.
Examples
Example #1 IntlCalendar::isWeekend
<?php
ini_set('date.timezone', 'Europe/Lisbon');
$cal = new IntlGregorianCalendar(NULL, 'en_US');
$cal->set(2013, 6 /* July */, 7); // a Sunday
var_dump($cal->isWeekend()); // true
var_dump($cal->isWeekend(strtotime('2013-07-01 00:00:00'))); // false, Monday
$cal = new IntlGregorianCalendar(NULL, 'ar_SA');
$cal->set(2013, 6 /* July */, 7); // a Sunday
var_dump($cal->isWeekend()); // false, Sunday not in weekend in this calendar
See Also
- IntlCalendar::getDayOfWeekType
- IntlCalendar::getWeekendTransition