php-doc-en/reference/datetime/functions/date-default-timezone-set.xml
Hannes Magnusson c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00

118 lines
3.1 KiB
XML
Executable file

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<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_STRICT</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="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<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>
</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:"../../../../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
-->