<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<refentry xml:id="datetime.settimezone" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>DateTime::setTimezone</refname>

<refname>date_timezone_set</refname>

<refpurpose>Sets the time zone for the DateTime object</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<para>&style.oop;</para>

<methodsynopsis role="DateTime">

<modifier>public</modifier> <type>DateTime</type><methodname>DateTime::setTimezone</methodname>

<methodparam><type>DateTimeZone</type><parameter>timezone</parameter></methodparam>

</methodsynopsis>

<para>&style.procedural;</para>

<methodsynopsis>

<type>DateTime</type><methodname>date_timezone_set</methodname>

<methodparam><type>DateTime</type><parameter>object</parameter></methodparam>

<methodparam><type>DateTimeZone</type><parameter>timezone</parameter></methodparam>

</methodsynopsis>

<para>

Sets a new timezone for a <classname>DateTime</classname> <type>object</type>.

</para>

<para>

Like <methodname>DateTimeImmutable::setTimezone</methodname> but works with

<classname>DateTime</classname>.

</para>

<para>

The procedural version takes the <classname>DateTime</classname> object as

its first argument.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

&date.datetime.description.modified;

<varlistentry>

<term><parameter>timezone</parameter></term>

<listitem>

<para>

A <classname>DateTimeZone</classname> object representing the

desired time zone.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Returns the <classname>DateTime</classname> object for method chaining. The

underlaying point-in-time is not changed when calling this method.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<example>

<title><function>DateTime::setTimeZone</function> example</title>

<para>&style.oop;</para>

<programlisting role="php">

<![CDATA[

<?php

$date = new DateTime('2000-01-01', new DateTimeZone('Pacific/Nauru'));

echo $date->format('Y-m-d H:i:sP') . "\n";

$date->setTimezone(new DateTimeZone('Pacific/Chatham'));

echo $date->format('Y-m-d H:i:sP') . "\n";

?>

]]>

</programlisting>

<para>&style.procedural;</para>

<programlisting role="php">

<![CDATA[

<?php

$date = date_create('2000-01-01', timezone_open('Pacific/Nauru'));

echo date_format($date, 'Y-m-d H:i:sP') . "\n";

date_timezone_set($date, timezone_open('Pacific/Chatham'));

echo date_format($date, 'Y-m-d H:i:sP') . "\n";

?>

]]>

</programlisting>

&examples.outputs;

<screen>

<![CDATA[

2000-01-01 00:00:00+12:00

2000-01-01 01:45:00+13:45

]]>

</screen>

</example>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member><function>DateTimeImmutable::setTimezone</function></member>

<member><function>DateTime::getTimezone</function></member>

<member><function>DateTimeZone::__construct</function></member>

</simplelist>

</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

-->