Source of: /manual/en/function.date-sunrise.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.datetime.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.date-sunrise.php',
1 => 'date_sunrise',
),
'up' =>
array (
0 => 'ref.datetime.php',
1 => 'Date/Time Functions',
),
'prev' =>
array (
0 => 'function.date-sun-info.php',
1 => 'date_sun_info',
),
'next' =>
array (
0 => 'function.date-sunset.php',
1 => 'date_sunset',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.date-sunrise" class="refentry">
<div class="refnamediv">
<h1 class="refname">date_sunrise</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">date_sunrise</span> — <span class="dc-title">Returns time of sunrise for a given day and location</span></p>
</div>
<a name="function.date-sunrise.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><b>date_sunrise</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$timestamp</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$format</tt><span class="initializer"> = SUNFUNCS_RET_STRING</span></span>
[, <span class="methodparam"><span class="type">float</span> <tt class="parameter">$latitude</tt><span class="initializer"> = ini_get("date.default_latitude")</span></span>
[, <span class="methodparam"><span class="type">float</span> <tt class="parameter">$longitude</tt><span class="initializer"> = ini_get("date.default_longitude")</span></span>
[, <span class="methodparam"><span class="type">float</span> <tt class="parameter">$zenith</tt><span class="initializer"> = ini_get("date.sunrise_zenith")</span></span>
[, <span class="methodparam"><span class="type">float</span> <tt class="parameter">$gmt_offset</tt><span class="initializer"> = 0</span></span>
]]]]] )</div>
<p class="para rdfs-comment">
<b>date_sunrise()</b> returns the sunrise time for a given
day (specified as a <i><tt class="parameter">timestamp</tt></i>
) and location.
</p>
</div>
<a name="function.date-sunrise.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">timestamp</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The <i><tt class="parameter">timestamp</tt></i>
of the day from which the sunrise
time is taken.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">format</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
</p><table class="doctable table">
<caption><b><i><tt class="parameter">format</tt></i>
constants</b></caption>
<thead valign="middle">
<tr valign="middle">
<th>constant</th>
<th>description</th>
<th>example</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">SUNFUNCS_RET_STRING</td>
<td align="left">returns the result as <a href="language.types.string.php" class="type string">string</a></td>
<td align="left">16:46</td>
</tr>
<tr valign="middle">
<td align="left">SUNFUNCS_RET_DOUBLE</td>
<td align="left">returns the result as <a href="language.types.float.php" class="type float">float</a></td>
<td align="left">16.78243132</td>
</tr>
<tr valign="middle">
<td align="left">SUNFUNCS_RET_TIMESTAMP</td>
<td align="left">returns the result as <a href="language.types.integer.php" class="type integer">integer</a> (timestamp)</td>
<td align="left">1095034606</td>
</tr>
</tbody>
</table>
<p>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">latitude</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Defaults to North, pass in a negative value for South.
See also: <i>date.default_latitude</i>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">longitude</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Defaults to East, pass in a negative value for West.
See also: <i>date.default_longitude</i>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">zenith</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Default: <i>date.sunrise_zenith</i>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">gmtoffset</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Specified in hours.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.date-sunrise.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the sunrise time in a specified <i><tt class="parameter">format</tt></i>
on
success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.date-sunrise.errors"></a><div class="refsect1 errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Every call to a date/time function will generate a <b><tt class="constant">E_NOTICE</tt></b>
if the time zone is not valid, and/or a <b><tt class="constant">E_STRICT</tt></b>
or <b><tt class="constant">E_WARNING</tt></b> message
if using the system settings or the <var class="varname">TZ</var> environment
variable. See also <a href="function.date-default-timezone-set.php" class="function">date_default_timezone_set()</a></p>
</div>
<a name="function.date-sunrise.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle"><td align="left">5.1.0</td><td align="left"><p class="para">
Now issues the <b><tt class="constant">E_STRICT</tt></b> and <b><tt class="constant">E_NOTICE</tt></b>
time zone errors.</p></td></tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.date-sunrise.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>date_sunrise()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* calculate the sunrise time for Lisbon, Portugal<br />Latitude: 38.4 North<br />Longitude: 9 West<br />Zenith ~= 90<br />offset: +1 GMT<br />*/<br /><br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">date</span><span style="color: #007700">(</span><span style="color: #DD0000">"D M d Y"</span><span style="color: #007700">). </span><span style="color: #DD0000">', sunrise time : ' </span><span style="color: #007700">.</span><span style="color: #0000BB">date_sunrise</span><span style="color: #007700">(</span><span style="color: #0000BB">time</span><span style="color: #007700">(), </span><span style="color: #0000BB">SUNFUNCS_RET_STRING</span><span style="color: #007700">, </span><span style="color: #0000BB">38.4</span><span style="color: #007700">, -</span><span style="color: #0000BB">9</span><span style="color: #007700">, </span><span style="color: #0000BB">90</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Mon Dec 20 2004, sunrise time : 08:54
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.date-sunrise.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.date-sunset.php" class="function" rel="rdfs-seeAlso">date_sunset()</a> - Returns time of sunset for a given day and location</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
