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

<!-- $Revision$ -->

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

<!-- Credits: mumumu -->

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

成功した場合にタイムゾーンのオフセット秒数を返します。

</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 オブジェクトに含まれる 日付/時刻 の GMT オフセットを計算します。

// しかし、タイムゾーンの規則は東京のもの ($dateTimeZoneJapan)

// を使用します。

$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

-->