1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 316651 $ -->
<refentry xml:id="function.date-default-timezone-get" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>date_default_timezone_get</refname>
<refpurpose>
Gets the default timezone used by all date/time functions in a script
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>date_default_timezone_get</methodname>
<void/>
</methodsynopsis>
<para>
In order of preference, this function returns the default timezone by:
<itemizedlist>
<listitem>
<para>
Reading the timezone set using the
<function>date_default_timezone_set</function> function (if any)
</para>
</listitem>
<listitem>
<para>
Prior to PHP 5.4.0 <emphasis>only</emphasis>: Reading the <varname>TZ</varname>
environment variable (if non empty)
</para>
</listitem>
<listitem>
<para>
Reading the value of the <link linkend="ini.date.timezone">date.timezone</link> ini option
(if set)
</para>
</listitem>
<listitem>
<para>
Prior to PHP 5.4.0 <emphasis>only</emphasis>: Querying the host operating system (if supported
and allowed by the OS). This uses an algorithm
that has to <emphasis>guess</emphasis> the timezone. This is by no means going to work correctly for
every situation. A warning is shown when this stage is reached. Do not rely on it to be guessed
correctly, and set <link linkend="ini.date.timezone">date.timezone</link> to the correct timezone
instead.
</para>
</listitem>
</itemizedlist>
</para>
<para>
If none of the above succeed, <methodname>date_default_timezone_get</methodname>
will return a default timezone of <literal>UTC</literal>.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a <type>string</type>.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.4.0</entry>
<entry>
The <literal>TZ</literal> environment variable is no longer used to
guess the timezone.
</entry>
</row>
<row>
<entry>5.4.0</entry>
<entry>
The timezone is no longer guessed from information available through the
operating system as the guessed timezone can not be relied on.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Getting the default timezone</title>
<programlisting role="php">
<![CDATA[
<?php
date_default_timezone_set('Europe/London');
if (date_default_timezone_get()) {
echo 'date_default_timezone_set: ' . date_default_timezone_get() . '<br />';
}
if (ini_get('date.timezone')) {
echo 'date.timezone: ' . ini_get('date.timezone');
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
date_default_timezone_set: Europe/London
date.timezone: Europe/London
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Getting the abbreviation of a timezone</title>
<programlisting role="php">
<![CDATA[
<?php
date_default_timezone_set('America/Los_Angeles');
echo date_default_timezone_get() . ' => ' . date('e') . ' => ' . date('T');
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
America/Los_Angeles => America/Los_Angeles => PST
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>date_default_timezone_set</function></member>
<member><xref linkend="timezones" /></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
-->
|