php-doc-en/reference/intl/intlcalendar/setrepeatedwalltimeoption.xml
Gustavo André dos Santos Lopes 4a738f5ed6 Update IntlCalendar documentation
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330743 c90b9560-bf6c-de11-be94-00142212c4b1
2013-07-03 03:26:13 +00:00

88 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlcalendar.setrepeatedwalltimeoption" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlCalendar::setRepeatedWallTimeOption</refname>
<refpurpose>Set behavior for handling repeating wall times at negative timezone offset transitions</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::setRepeatedWallTimeOption</methodname>
<methodparam><type>int</type><parameter>wallTimeOption</parameter></methodparam>
</methodsynopsis>
<para>
Sets the current strategy for dealing with wall times that are repeated
whenever the clock is set back during dailight saving time end transitions.
The default value is <constant>IntlCalendar::WALLTIME_LAST</constant> (take
the post-DST instant). The other possible value is
<constant>IntlCalendar::WALLTIME_FIRST</constant> (take the instant that
occurs during DST).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>wallTimeOption</parameter></term>
<listitem>
<para>
One of the constants <constant>IntlCalendar::WALLTIME_FIRST</constant> or
<constant>IntlCalendar::WALLTIME_LAST</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; on success. Failure can only happen due to invalid parameters.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
See the example on
<function>IntlCalendar::getRepeatedWallTimeOption</function>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>intlCalendar::getRepeatedWallTimeOption</methodname></member>
<member><methodname>intlCalendar::setSkippedWallTimeOption</methodname></member>
<member><methodname>intlCalendar::getSkippedWallTimeOption</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
-->