doc-fr/reference/datetime/functions/date-sunset.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5c951013ca04161992efed8b86fb40f55669958e Maintainer: victor-prdh Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.date-sunset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>date_sunset</refname>
  <refpurpose>
   Retourne l'heure de coucher du soleil pour un jour et un endroit donnés
  </refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   <para>
    Cette fonction est <emphasis>OBSOLÈTE</emphasis> depuis PHP 8.1.0.
    Dépendre de cette fonction est fortement déconseillé. L'utilisation
    de <function>date_sun_info</function> est encouragé à la place.
   </para>
  </warning>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>int</type><type>float</type><type>false</type></type><methodname>date_sunset</methodname>
   <methodparam><type>int</type><parameter>timestamp</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>returnFormat</parameter><initializer><constant>SUNFUNCS_RET_STRING</constant></initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>float</type><type>null</type></type><parameter>latitude</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>float</type><type>null</type></type><parameter>longitude</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>float</type><type>null</type></type><parameter>zenith</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>float</type><type>null</type></type><parameter>utcOffset</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   La fonction <function>date_sunset</function> retourne l'heure de coucher
   du soleil pour un jour (spécifié en tant que <parameter>timestamp</parameter>
   Unix) et un endroit donnés.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>timestamp</parameter></term>
     <listitem>
      <para>
       Le <parameter>timestamp</parameter> Unix du jour pour lequel l'heure du
       coucher du soleil est donnée.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>returnFormat</parameter></term>
     <listitem>
      <para>
       <table>
        <title>Constantes pour le paramètre <parameter>returnFormat</parameter></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Constante</entry>
           <entry>Description</entry>
           <entry>Exemple</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>SUNFUNCS_RET_STRING</entry>
           <entry>Retourne le résultat sous la forme d'une &string;</entry>
           <entry>16:46</entry>
          </row>
          <row>
           <entry>SUNFUNCS_RET_DOUBLE</entry>
           <entry>Retourne le résultat sous la forme d'un &float;</entry>
           <entry>16.78243132</entry>
          </row>
          <row>
           <entry>SUNFUNCS_RET_TIMESTAMP</entry>
           <entry>Retourne le résultat sous la forme d'un &integer; (timestamp)</entry>
           <entry>1095034606</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>latitude</parameter></term>
     <listitem>
      <para>
       Par défaut, c'est le Nord. Passez une valeur négative pour le Sud.
       Voir aussi <link linkend="ini.date.default-latitude">date.default_latitude</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>longitude</parameter></term>
     <listitem>
      <para>
       Par défaut, c'est l'Est. Passez une valeur négative pour l'Ouest.
       Voir aussi <link linkend="ini.date.default-longitude">date.default_longitude</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>zenith</parameter></term>
     <listitem>
      <para>
       <parameter>zenith</parameter> est l'angle entre le
       centre du soleil et la ligne perpendiculaire à la surface de la terre. 
       Par défaut
       <link linkend="ini.date.sunset-zenith">date.sunset_zenith</link>
       <table>
        <title>Valeurs communes d'angle <parameter>zenith</parameter></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Angle</entry>
           <entry>Description</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>90°50'</entry>
           <entry>Coucher du soleil: Le point où le soleil devient invisible.</entry>
          </row>
          <row>
           <entry>96°</entry>
           <entry>Crépuscule civil: conventionnellement utilisé pour signifier la fin du crépuscule.</entry>
          </row>
          <row>
           <entry>102°</entry>
           <entry>Crépuscule nautique: le point de fin de l'horizon étant visible en mer.</entry>
          </row>
          <row>
           <entry>108°</entry>
           <entry>Crépuscule astronomique: le point où le soleil finit d'être la source de toute illumination.</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>utcOffset</parameter></term>
     <listitem>
      <para>
       Spécifié en heures.
       Le <parameter>utcOffset</parameter> est ignoré, si
       <parameter>returnFormat</parameter> est
       <constant>SUNFUNCS_RET_TIMESTAMP</constant>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne l'heure de coucher du soleil dans le <parameter>returnFormat</parameter>
   spécifié&return.falseforfailure;. Une raison possible de l'échec est que le
   le soleil ne se couche pas, ce qui se passe à l'intérieur des cercles
   polaires pour une partie de l'année.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  &date.timezone.errors.description;
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.1.0</entry>
       <entry>
        Cette fonction a été rendue obsolète en faveur de <function>date_sun_info</function>.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <parameter>latitude</parameter>, <parameter>longitude</parameter>,
        <parameter>zenith</parameter> et <parameter>utcOffset</parameter> sont désormais nullable.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>date_sunset</function></title>
    <programlisting role="php">
<![CDATA[
<?php

     /* Calcul l'heure du coucher du soleil pour Lisbonne, 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>
   <example>
    <title>Pas de coucher du soleil</title>
    <programlisting role="php">
<![CDATA[
<?php
$solstice = strtotime('2017-12-21');
var_dump(date_sunset($solstice, SUNFUNCS_RET_STRING, 69.245833, -53.537222));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
bool(false)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>date_sun_info</function></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->