sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document structure of result array

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344223 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2018-02-11 17:41:41 +00:00
parent 6250f7fb10
commit 0f43dbaec0
1 changed files with 84 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
reference/datetime/functions/date-sun-info.xml
View file

@ -51,6 +51,90 @@
&reftitle.returnvalues;
<para>
Returns array on success&return.falseforfailure;.
The structure of the array is detailed in the following list:
</para>
<para>
<variablelist>
<varlistentry>
<term><literal>sunrise</literal></term>
<listitem>
<simpara>
The time of the sunrise.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>sunset</literal></term>
<listitem>
<simpara>
The time of the sunset.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>transit</literal></term>
<listitem>
<simpara>
The time when the sun is at its zenith, i.e. has reached its topmost
point.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>civil_twilight_begin</literal></term>
<listitem>
<simpara>
The start of the civil dawn. It ends at <literal>sunrise</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>civil_twilight_end</literal></term>
<listitem>
<simpara>
The end of the civil dusk. It starts at <literal>sunset</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>nautical_twilight_begin</literal></term>
<listitem>
<simpara>
The start of the nautical dawn. It ends at
<literal>civil_twilight_begin</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>nautical_twilight_end</literal></term>
<listitem>
<simpara>
The end of the nautical dusk. It starts at
<literal>civil_twilight_end</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>astronomical_twilight_begin</literal></term>
<listitem>
<simpara>
The start of the astronomical dawn. It ends at
<literal>nautical_twilight_begin</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>astronomical_twilight_end</literal></term>
<listitem>
<simpara>
The end of the astronomical dusk. It starts at
<literal>nautical_twilight_end</literal>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The values of the array elements are either UNIX timestamps, &false; if the
sun is below the respective zenith for the whole day, or &true; if the sun is
above the respective zenith for the whole day.