php-doc-en/reference/intl/intltimezone/getoffset.xml
Christoph Michael Becker 60f5e69be3 Document procedural APIs of IntlTimeZone
While we're at it, we fix the return type of IntlTimeZone::getoffset().


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351641 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-25 13:28:01 +00:00

105 lines
2.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intltimezone.getoffset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlTimeZone::getOffset</refname>
<refname>intltz_get_offset</refname>
<refpurpose>Get the time zone raw and GMT offset for the given moment in time</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlTimeZone::getOffset</methodname>
<methodparam><type>float</type><parameter>date</parameter></methodparam>
<methodparam><type>bool</type><parameter>local</parameter></methodparam>
<methodparam><type>int</type><parameter role="reference">rawOffset</parameter></methodparam>
<methodparam><type>int</type><parameter role="reference">dstOffset</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis role="procedural">
<type>bool</type><methodname>intltz_get_offset</methodname>
<methodparam><type>IntlTimeZone</type><parameter>timezone</parameter></methodparam>
<methodparam><type>float</type><parameter>date</parameter></methodparam>
<methodparam><type>bool</type><parameter>local</parameter></methodparam>
<methodparam><type>int</type><parameter role="reference">rawOffset</parameter></methodparam>
<methodparam><type>int</type><parameter role="reference">dstOffset</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>date</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>local</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rawOffset</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dstOffset</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</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
-->