<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Returns the timezone offset from GMT</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="datetimezone.getname.html">DateTimeZone::getName</a></div>
<div class="next" style="text-align: right; float: right;"><a href="datetimezone.gettransitions.html">DateTimeZone::getTransitions</a></div>
<div class="up"><a href="class.datetimezone.html">DateTimeZone</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="datetimezone.getoffset" class="refentry">
<div class="refnamediv">
<h1 class="refname">DateTimeZone::getOffset</h1>
<h1 class="refname">timezone_offset_get</h1>
<p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">DateTimeZone::getOffset</span> -- <span class="refname">timezone_offset_get</span> — <span class="dc-title">Returns the timezone offset from GMT</span></p>
</div>
<div class="refsect1 description" id="refsect1-datetimezone.getoffset-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>DateTimeZone::getOffset</strong></span>
( <span class="methodparam"><span class="type"><a href="class.datetime.html" class="type DateTime">DateTime</a></span> <code class="parameter">$datetime</code></span>
)</div>
<p class="para rdfs-comment">Procedural style</p>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><a href="function.timezone-offset-get.html" class="methodname">timezone_offset_get</a></span>
( <span class="methodparam"><span class="type"><a href="class.datetimezone.html" class="type DateTimeZone">DateTimeZone</a></span> <code class="parameter">$object</code></span>
, <span class="methodparam"><span class="type"><a href="class.datetime.html" class="type DateTime">DateTime</a></span> <code class="parameter">$datetime</code></span>
)</div>
<p class="para rdfs-comment">
This function returns the offset to GMT for the date/time specified in the
<em><code class="parameter">datetime</code></em> parameter. The GMT offset is calculated
with the timezone information contained in the DateTimeZone object being used.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-datetimezone.getoffset-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
object</code></em></span><dd>
<p class="para">Procedural style only: A <a href="class.datetimezone.html" class="classname">DateTimeZone</a> object
returned by <span class="function"><a href="function.timezone-open.html" class="function">timezone_open()</a></span></p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">datetime</code></em></span>
<dd>
<p class="para">
DateTime that contains the date/time to compute the offset from.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-datetimezone.getoffset-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns time zone offset in seconds on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-datetimezone.getoffset-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2281">
<p><strong>Example #1 <span class="function"><strong>DateTimeZone::getOffset()</strong></span> examples</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Create two timezone objects, one for Taipei (Taiwan) and one for<br />// Tokyo (Japan)<br /></span><span style="color: #0000BB">$dateTimeZoneTaipei </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTimeZone</span><span style="color: #007700">(</span><span style="color: #DD0000">"Asia/Taipei"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$dateTimeZoneJapan </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTimeZone</span><span style="color: #007700">(</span><span style="color: #DD0000">"Asia/Tokyo"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Create two DateTime objects that will contain the same Unix timestamp, but<br />// have different timezones attached to them.<br /></span><span style="color: #0000BB">$dateTimeTaipei </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTime</span><span style="color: #007700">(</span><span style="color: #DD0000">"now"</span><span style="color: #007700">, </span><span style="color: #0000BB">$dateTimeZoneTaipei</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$dateTimeJapan </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTime</span><span style="color: #007700">(</span><span style="color: #DD0000">"now"</span><span style="color: #007700">, </span><span style="color: #0000BB">$dateTimeZoneJapan</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Calculate the GMT offset for the date/time contained in the $dateTimeTaipei<br />// object, but using the timezone rules as defined for Tokyo<br />// ($dateTimeZoneJapan).<br /></span><span style="color: #0000BB">$timeOffset </span><span style="color: #007700">= </span><span style="color: #0000BB">$dateTimeZoneJapan</span><span style="color: #007700">-></span><span style="color: #0000BB">getOffset</span><span style="color: #007700">(</span><span style="color: #0000BB">$dateTimeTaipei</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Should show int(32400) (for dates after Sat Sep 8 01:00:00 1951 JST).<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$timeOffset</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="datetimezone.getname.html">DateTimeZone::getName</a></div>
<div class="next" style="text-align: right; float: right;"><a href="datetimezone.gettransitions.html">DateTimeZone::getTransitions</a></div>
<div class="up"><a href="class.datetimezone.html">DateTimeZone</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
