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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.date-default-timezone-set" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>date_default_timezone_set</refname>
<refpurpose>
Sets the default timezone used by all date/time functions in a script
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>date_default_timezone_set</methodname>
<methodparam><type>string</type><parameter>timezone_identifier</parameter></methodparam>
</methodsynopsis>
<para>
<function>date_default_timezone_set</function> sets the default timezone
used by all date/time functions.
</para>
<note>
<para>
Since PHP 5.1.0 (when the date/time functions were rewritten), every call
to a date/time function will generate a <constant>E_NOTICE</constant> if
the timezone isn't valid, and/or a <constant>E_WARNING</constant> message
if using the system settings or the <varname>TZ</varname> environment
variable.
</para>
</note>
<para>
Instead of using this function to set the default timezone in your script,
you can also use the INI setting <link
linkend="ini.date.timezone">date.timezone</link> to set the default
timezone.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>timezone_identifier</parameter></term>
<listitem>
<para>
The timezone identifier, like <literal>UTC</literal> or
<literal>Europe/Lisbon</literal>. The list of valid identifiers is
available in the <xref linkend="timezones"/>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function returns &false; if the
<parameter>timezone_identifier</parameter> isn't valid, or &true;
otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Getting the default timezone</title>
<programlisting role="php">
<![CDATA[
<?php
date_default_timezone_set('America/Los_Angeles');
$script_tz = date_default_timezone_get();
if (strcmp($script_tz, ini_get('date.timezone'))){
echo 'Script timezone differs from ini-set timezone.';
} else {
echo 'Script timezone and ini-set timezone match.';
}
?>
]]>
</programlisting>
</example>
</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.3.0</entry>
<entry>
Now throws <constant>E_WARNING</constant> rather then
<constant>E_STRICT</constant>.
</entry>
</row>
<row>
<entry>5.1.2</entry>
<entry>
The function started to validate the
<parameter>timezone_identifier</parameter> parameter.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>date_default_timezone_get</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
-->
|