DateTimeZone::getOffset

timezone_offset_get

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

DateTimeZone::getOffset -- timezone_offset_get — GMT からのタイムゾーンのオフセットを返す

説明

オブジェクト指向型

public DateTimeZone::getOffset(DateTimeInterface $datetime): int

手続き型

timezone_offset_get(DateTimeZone $object, DateTimeInterface $datetime): int

この関数は、datetime パラメータで指定した日付/時刻についての GMT へのオフセットを返します。GMT オフセットの計算の際には、使用する DateTimeZone オブジェクトに含まれるタイムゾーン情報を使用します。

パラメータ

object: 手続き型のみ: timezone_open() が返す DateTimeZone オブジェクト
datetime: オフセットを計算する日付/時刻を含む DateTime。

戻り値

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

例

例1 DateTimeZone::getOffset() の例

<?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);

上の例の出力は以下となります。

int(32400)