IntlCalendar::isWeekend
PHP function
Edit on GitHub ✎
(PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1)
Whether a certain date/time is in the weekend
Description
Oop
IntlCalendar::isWeekend(float|null $timestamp = null): bool
Procedural
intlcal_is_weekend(IntlCalendar $calendar, float|null $timestamp = null): bool
Returns whether either the obejctʼs current time or the provided timestamp occur during a weekend in this objectʼs calendar system.
This function requires ICU 4.4 or later.
Parameters
calendarIntl-calendar
timestampAn 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.
Intl-calendar
Examples
php
<?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 calendarSee Also
IntlCalendar::getDayOfWeekTypeIntlCalendar::getWeekendTransition