mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
b475cd8b50
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@194940 c90b9560-bf6c-de11-be94-00142212c4b1
120 lines
3.5 KiB
XML
120 lines
3.5 KiB
XML
<?xml version='1.0' encoding='iso-8859-1'?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<refentry id="function.date-sunset">
|
|
<refnamediv>
|
|
<refname>date_sunset</refname>
|
|
<refpurpose>
|
|
Returns time of sunset for a given day and location
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>date_sunset</methodname>
|
|
<methodparam><type>int</type><parameter>timestamp</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>format</parameter></methodparam>
|
|
<methodparam choice="opt"><type>float</type><parameter>latitude</parameter></methodparam>
|
|
<methodparam choice="opt"><type>float</type><parameter>longitude</parameter></methodparam>
|
|
<methodparam choice="opt"><type>float</type><parameter>zenith</parameter></methodparam>
|
|
<methodparam choice="opt"><type>float</type><parameter>gmt_offset</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>date_sunset</function> returns the sunset time for a given day
|
|
(specified as a <parameter>timestamp</parameter>) and location. The
|
|
<parameter>latitude</parameter>, <parameter>longitude</parameter> and
|
|
<parameter>zenith</parameter> parameters default to the
|
|
<literal>date.default_latitude</literal>,
|
|
<literal>date.default_longitude</literal> and
|
|
<literal>date.sunset_zenith</literal> configuration options,
|
|
respectively.
|
|
</para>
|
|
<para>
|
|
The <parameter>latitude</parameter> defaults to North. So, if you want to
|
|
specify a South value, you must pass a negative value. The same note
|
|
applies to <parameter>longitude</parameter>, which defaults to East.
|
|
</para>
|
|
<para>
|
|
The <parameter>gmt_offset</parameter> parameter is specified in hours.
|
|
</para>
|
|
<table>
|
|
<title><parameter>format</parameter> constants</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>constant</entry>
|
|
<entry>description</entry>
|
|
<entry>example</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>SUNFUNCS_RET_STRING</entry>
|
|
<entry>returns the result as <type>string</type></entry>
|
|
<entry>16:46</entry>
|
|
</row>
|
|
<row>
|
|
<entry>SUNFUNCS_RET_DOUBLE</entry>
|
|
<entry>returns the result as <type>float</type></entry>
|
|
<entry>16.78243132</entry>
|
|
</row>
|
|
<row>
|
|
<entry>SUNFUNCS_RET_TIMESTAMP</entry>
|
|
<entry>returns the result as <type>integer</type> (timestamp)</entry>
|
|
<entry>1095034606</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
<para>
|
|
<example>
|
|
<title><function>date_sunset</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
/* calculate the sunset time for Lisbon, Portugal
|
|
Latitude: 38.4 North
|
|
Longitude: 9 West
|
|
Zenith ~= 90
|
|
offset: +1 GMT
|
|
*/
|
|
|
|
echo date("D M d Y"). ', sunset time : ' .date_sunset(time(), SUNFUNCS_RET_STRING, 38.4, -9, 90, 1);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Mon Dec 20 2004, sunset time : 18:13
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
See also <function>date_sunrise</function>.
|
|
</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:"../../../../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
|
|
-->
|