mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 23:38:56 +00:00
b95d28e6ec
Functions which return false on failure should state that in their signature as well. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351135 c90b9560-bf6c-de11-be94-00142212c4b1
104 lines
3 KiB
XML
104 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="intlcalendar.getweekendtransition" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>IntlCalendar::getWeekendTransition</refname>
|
|
<refpurpose>Get time of the day at which weekend begins or ends</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<para>
|
|
&style.oop;
|
|
</para>
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>IntlCalendar::getWeekendTransition</methodname>
|
|
<methodparam><type>string</type><parameter>dayOfWeek</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
&style.procedural;
|
|
</para>
|
|
<methodsynopsis>
|
|
<type class="union"><type>int</type><type>false</type></type><methodname>intlcal_get_weekend_transition</methodname>
|
|
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>dayOfWeek</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns the number of milliseconds after midnight at which the weekend
|
|
begins or ends.
|
|
</para>
|
|
<para>
|
|
This is only applicable for days of the week for which
|
|
<function>IntlCalendar::getDayOfWeekType</function> returns either
|
|
<constant>IntlCalendar::DOW_TYPE_WEEKEND_OFFSET</constant> or
|
|
<constant>IntlCalendar::DOW_TYPE_WEEKEND_CEASE</constant>. Calling this
|
|
function for other days of the week is an error condition.
|
|
</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>dayOfWeek</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One of the constants <constant>IntlCalendar::DOW_SUNDAY</constant>,
|
|
<constant>IntlCalendar::DOW_MONDAY</constant>, …,
|
|
<constant>IntlCalendar::DOW_SATURDAY</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The number of milliseconds into the day at which the weekend begins or
|
|
ends&return.falseforfailure;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
See example on <function>IntlCalendar::getDayOfWeekType</function>.
|
|
</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
|
|
-->
|