IntlCalendar::isWeekend

(PHP 5.5.0, PECL >= 3.0.0a1)

IntlCalendar::isWeekend — Whether a certain date/time is in the weekend

说明

面向对象风格

public bool IntlCalendar::isWeekend ([ float $date = NULL ] )

过程化风格

bool intlcal_is_weekend ( IntlCalendar $cal [, float $date = NULL ] )

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.

参数

cal: The IntlCalendar resource.
date: An optional timestamp representing the number of milliseconds since the epoch, excluding leap seconds. If NULL , this object?s current time is used instead.

返回值

A bool indicating whether the given or this object?s time occurs in a weekend.

The value FALSE may also be returned on failure, for instance after giving a date out of bounds on non-lenient mode; use exceptions or query intl_get_error_code() to disambiguate.

范例

Example #1 IntlCalendar::isWeekend()

  <?php
ini_set ( 'date.timezone' ,  'Europe/Lisbon' );

 $cal  = new  IntlGregorianCalendar ( NULL ,  'en_US' );
 $cal -> set ( 2013 ,  6   ,  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   ,  7 );  // a Sunday 
 var_dump ( $cal -> isWeekend ());  // false, Sunday not in weekend in this calendar

参见

IntlCalendar::getDayOfWeekType() - Tell whether a day is a weekday, weekend or a day that has a transition between the two
IntlCalendar::getWeekendTransition() - Get time of the day at which weekend begins or ends