mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 04:48:55 +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
122 lines
3.5 KiB
XML
122 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.timezone-name-from-abbr" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>timezone_name_from_abbr</refname>
|
|
<refpurpose>Returns the timezone name from abbreviation</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>string</type><type>false</type></type><methodname>timezone_name_from_abbr</methodname>
|
|
<methodparam><type>string</type><parameter>abbr</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>utcOffset</parameter><initializer>-1</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>isDST</parameter><initializer>-1</initializer></methodparam>
|
|
</methodsynopsis>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>abbr</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Time zone abbreviation.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>utcOffset</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Offset from GMT in seconds. Defaults to -1 which means that first found
|
|
time zone corresponding to <parameter>abbr</parameter> is returned.
|
|
Otherwise exact offset is searched and only if not found then the first
|
|
time zone with any offset is returned.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>isDST</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Daylight saving time indicator. Defaults to -1, which means that
|
|
whether the time zone has daylight saving or not is not taken into
|
|
consideration when searching. If this is set to 1, then the
|
|
<parameter>utcOffset</parameter> is assumed to be an offset with
|
|
daylight saving in effect; if 0, then <parameter>utcOffset</parameter>
|
|
is assumed to be an offset without daylight saving in effect. If
|
|
<parameter>abbr</parameter> doesn't exist then the time zone is
|
|
searched solely by the <parameter>utcOffset</parameter> and
|
|
<parameter>isDST</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns time zone name on success&return.falseforfailure;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>timezone_name_from_abbr</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo timezone_name_from_abbr("CET") . "\n";
|
|
echo timezone_name_from_abbr("", 3600, 0) . "\n";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Europe/Berlin
|
|
Europe/Paris
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>timezone_abbreviations_list</function></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
|
|
-->
|