mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 23:38:56 +00:00
fc1383edb3
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332615 c90b9560-bf6c-de11-be94-00142212c4b1
131 lines
3.6 KiB
XML
131 lines
3.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- $Revision$ -->
|
||
|
||
<refentry xml:id="intlcalendar.isweekend" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||
<refnamediv>
|
||
<refname>IntlCalendar::isWeekend</refname>
|
||
<refpurpose>Whether a certain date/time is in the weekend</refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsect1 role="description">
|
||
&reftitle.description;
|
||
<para>
|
||
&style.oop;
|
||
</para>
|
||
<methodsynopsis>
|
||
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::isWeekend</methodname>
|
||
<methodparam choice="opt"><type>float</type><parameter>date</parameter><initializer>NULL</initializer></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
&style.procedural;
|
||
</para>
|
||
<methodsynopsis>
|
||
<type>bool</type><methodname>intlcal_is_weekend</methodname>
|
||
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
|
||
<methodparam choice="opt"><type>float</type><parameter>date</parameter><initializer>NULL</initializer></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
Returns whether either the obejctʼs current time or the provided timestamp
|
||
occur during a weekend in this objectʼs calendar system.
|
||
</para>
|
||
<para>
|
||
This function requires ICU 4.4 or later.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>cal</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
The IntlCalendar resource.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>date</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
An optional timestamp representing the number of milliseconds since the
|
||
epoch, excluding leap seconds. If &null;, this objectʼs current time is
|
||
used instead.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</refsect1>
|
||
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
A <type>bool</type> indicating whether the given or this objectʼs time occurs
|
||
in a weekend.
|
||
</para>
|
||
<para>
|
||
The value &false; may also be returned on failure, for instance after giving
|
||
a date out of bounds on non-lenient mode; use <link
|
||
linkend="ini.intl.use-exceptions">exceptions</link> or query
|
||
<function>intl_get_error_code</function> to disambiguate.
|
||
</para>
|
||
</refsect1>
|
||
|
||
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<para>
|
||
<example>
|
||
<title><function>IntlCalendar::isWeekend</function></title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?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
|
||
]]>
|
||
</programlisting>
|
||
</example>
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="seealso">
|
||
&reftitle.seealso;
|
||
<para>
|
||
<simplelist>
|
||
<member><methodname>IntlCalendar::getDayOfWeekType</methodname></member>
|
||
<member><methodname>IntlCalendar::getWeekendTransition</methodname></member>
|
||
</simplelist>
|
||
</para>
|
||
</refsect1>
|
||
|
||
</refentry>
|
||
|
||
<!-- Keep this comment at the end of the file
|
||
Local variables:
|
||
mode: sgml
|
||
sgml-omittag:t
|
||
sgml-shorttag:t
|
||
sgml-minimize-attributes:nil
|
||
sgml-always-quote-attributes:t
|
||
sgml-indent-step:1
|
||
sgml-indent-data:t
|
||
indent-tabs-mode:nil
|
||
sgml-parent-document:nil
|
||
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
||
sgml-exposed-tags:nil
|
||
sgml-local-catalogs:nil
|
||
sgml-local-ecat-files:nil
|
||
End:
|
||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||
vim: et tw=78 syn=sgml
|
||
vi: ts=1 sw=1
|
||
-->
|