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

<!-- $Revision$ -->

<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: duanxiaoqiang Status: ready -->

<!-- CREDITS: mowangjuanzi, Luffy -->

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

<refnamediv>

<refname>DateTimeZone::getOffset</refname>

<refname>timezone_offset_get</refname>

<refpurpose>返回相对于 GMT 的时差</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

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

<methodsynopsis role="DateTimeZone">

<modifier>public</modifier> <type>int</type><methodname>DateTimeZone::getOffset</methodname>

<methodparam><type>DateTimeInterface</type><parameter>datetime</parameter></methodparam>

</methodsynopsis>

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

<methodsynopsis>

<type>int</type><methodname>timezone_offset_get</methodname>

<methodparam><type>DateTimeZone</type><parameter>object</parameter></methodparam>

<methodparam><type>DateTimeInterface</type><parameter>datetime</parameter></methodparam>

</methodsynopsis>

<para>

该函数返回参数 <parameter>datetime</parameter> 中指定的日期/时间相对于 GMT

的时差。GMT 时差是通过 DateTimeZone 对象的时区信息计算出来的。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

&date.datetimezone.description;

<varlistentry>

<term><parameter>datetime</parameter></term>

<listitem>

<para>

用来计算时差的 DateTime，其包含日期/时间。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

成功时返回精确到秒的时差，&return.falseforfailure;。

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>DateTimeZone::getOffset</function> 示例</title>

<programlisting role="php">

<![CDATA[

<?php

// 创建两个时区对象，分别是台北（台湾）和东京（日本）

$dateTimeZoneTaipei = new DateTimeZone("Asia/Taipei");

$dateTimeZoneJapan = new DateTimeZone("Asia/Tokyo");

// 创建两个包含相同 Unix 时间戳的 DateTime 对象。区别是对应的时区不同。

$dateTimeTaipei = new DateTime("now", $dateTimeZoneTaipei);

$dateTimeJapan = new DateTime("now", $dateTimeZoneJapan);

// 计算包含日期/时间的 $dateTimeTaipei 对象与时区规则定义为东京的 $dateTimeZoneJapan 对象的 GMT 时差

$timeOffset = $dateTimeZoneJapan->getOffset($dateTimeTaipei);

// 应该展示 int(32400)（Sat Sep 8 01:00:00 1951 JST 之后的日期）。

var_dump($timeOffset);

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

int(32400)

]]>

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

-->