php-doc-en/reference/datetime/datetimezone/getlocation.xml
Philip Olson 086dc12715 Added missing refnames
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@312463 c90b9560-bf6c-de11-be94-00142212c4b1
2011-06-25 19:38:40 +00:00

102 lines
2.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimezone.getlocation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeZone::getLocation</refname>
<refname>timezone_location_get</refname>
<refpurpose>Returns location information for a timezone</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>array</type><methodname>DateTimeZone::getLocation</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>array</type><methodname>timezone_location_get</methodname>
<methodparam><type>DateTimeZone</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
Returns location information for a timezone, including country code, latitude/longitude and comments.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&date.datetimezone.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Array containing location information about timezone.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>DateTimeZone::getLocation</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$tz = new DateTimeZone("Europe/Prague");
print_r($tz->getLocation());
print_r(timezone_location_get($tz));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[country_code] => CZ
[latitude] => 50.08333
[longitude] => 14.43333
[comments] =>
)
Array
(
[country_code] => CZ
[latitude] => 50.08333
[longitude] => 14.43333
[comments] =>
)
]]>
</screen>
</example>
</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
-->