getname.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimezone.getname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DateTimeZone::getName</refname>
  <refname>timezone_name_get</refname>
  <refpurpose>Returns the name of the timezone</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop;</para>
  <methodsynopsis role="DateTimeZone">
   <modifier>public</modifier> <type>string</type><methodname>DateTimeZone::getName</methodname>
   <void/>
  </methodsynopsis>
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type>string</type><methodname>timezone_name_get</methodname>
   <methodparam><type>DateTimeZone</type><parameter>object</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns the name of the timezone.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>object</parameter></term>
    <listitem>
     <para>
      The <classname>DateTimeZone</classname> for which to get a name.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Depending on zone type, UTC offset (type 1), timezone abbreviation (type
   2), and timezone identifiers as published in the IANA timezone database
   (type 3), the descriptor string to create a new
   <classname>DateTimeZone</classname> object with the same offset and/or
   rules. For example <literal>02:00</literal>, <literal>CEST</literal>, or
   one of the timezone names in the <link linkend="timezones">list of
   timezones</link>.
  </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
-->