Files
archived-doc-pt-br/reference/datetime/functions/date-sunset.xml
Leonardo Lara Rodrigues 452d861bfb sync with en rev
2025-11-04 18:29:39 -03:00

286 lines
8.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: leonardolara Status: ready --><!-- CREDITS: fabioluciano, leonardolara -->
<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>
Retorna a hora do pôr do sol para um dia e uma localização informados.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<warning>
<para>
Esta função foi <emphasis>DESCONTINUADA</emphasis> desde o PHP 8.1.0.
Confiar nesta função é altamente desencorajado. Use
<function>date_sun_info</function> no lugar.
</para>
</warning>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier role="attribute">#[\Deprecated]</modifier>
<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>
A função <function>date_sunset</function> retorna o horário do pôr do sol para um
dia (especificado como um <parameter>timestamp</parameter>) e uma localização informados.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>timestamp</parameter></term>
<listitem>
<para>
O <parameter>timestamp</parameter> do dia do pôr do sol
desejado.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>returnFormat</parameter></term>
<listitem>
<para>
<table>
<title>Constantes de <parameter>returnFormat</parameter></title>
<tgroup cols="2">
<thead>
<row>
<entry>Constante</entry>
<entry>Descrição</entry>
<entry>Exemplo</entry>
</row>
</thead>
<tbody>
<row>
<entry>SUNFUNCS_RET_STRING</entry>
<entry>Retorna o resultado como uma <type>string</type></entry>
<entry>16:46</entry>
</row>
<row>
<entry>SUNFUNCS_RET_DOUBLE</entry>
<entry>Retorna o resultado como um <type>float</type></entry>
<entry>16.78243132</entry>
</row>
<row>
<entry>SUNFUNCS_RET_TIMESTAMP</entry>
<entry>Retorna o resultado como um <type>int</type> (timestamp)</entry>
<entry>1095034606</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>latitude</parameter></term>
<listitem>
<para>
Padronizado para o leste, passe um valor negativado para o oeste.
Veja também: <link linkend="ini.date.default-latitude">date.default_latitude</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>longitude</parameter></term>
<listitem>
<para>
Padronizado para o leste, passe um valor negativado para o oeste.
Veja também: <link linkend="ini.date.default-longitude">date.default_longitude</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>zenith</parameter></term>
<listitem>
<para>
<parameter>zenith</parameter> é o ângulo entre o centro do sol
e uma linha perpendicular à superfície da Terra. É padronizado para
<link linkend="ini.date.sunset-zenith">date.sunset_zenith</link>
<table>
<title>Ângulos comuns em relação ao <parameter>zenith</parameter></title>
<tgroup cols="2">
<thead>
<row>
<entry>Ângulo</entry>
<entry>Descrição</entry>
</row>
</thead>
<tbody>
<row>
<entry>90°50'</entry>
<entry>Pôr do sol: o ponto onde o sol se torna invisível.</entry>
</row>
<row>
<entry>96°</entry>
<entry>Crepúsculo civil: convencionado para significar o final do crepúsculo.</entry>
</row>
<row>
<entry>102°</entry>
<entry>Crepúsculo náutico: o ponto no qual o horizonte termina de ficar visível no mar.</entry>
</row>
<row>
<entry>108°</entry>
<entry>Crepúsculo astronômico: o ponto no qual o sol termina se tornar fonte de iluminação.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>utcOffset</parameter></term>
<listitem>
<para>
Especificado em horas.
O parâmetro <parameter>utcOffset</parameter> é ignorado se
<parameter>returnFormat</parameter> for
<constant>SUNFUNCS_RET_TIMESTAMP</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna o horário do pôr do sol no <parameter>returnFormat</parameter> especificado
em caso de sucesso&return.falseforfailure;. Um potencial motivo para falha é quando o
sol não se põe, o que acontece dentro dos círculos polares durante parte
do ano.
</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>
Esta função foi descontinuada em favor de <function>date_sun_info</function>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>latitude</parameter>, <parameter>longitude</parameter>,
<parameter>zenith</parameter> e <parameter>utcOffset</parameter> agora podem ser nulos.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemplo da função <function>date_sunset</function></title>
<programlisting role="php">
<![CDATA[
<?php
/* Calcula o horário do pôr do sol para Lisboa, Portugal
Latitude: 38.4 norte
Longitude: 9 oeste
Zênite ~= 90
deslocamento UTC: +01:00 GMT
*/
echo date("D M d Y"). ', horário do pôr do sol : ' .date_sunset(time(), SUNFUNCS_RET_STRING, 38.4, -9, 90, 1);
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Deprecated: Constant SUNFUNCS_RET_STRING is deprecated in script on line 10
Deprecated: Function date_sunset() is deprecated since 8.1, use date_sun_info() instead in script on line 10
Mon Dec 20 2004, horário do pôr do sol : 18:13
]]>
</screen>
</example>
<example>
<title>Sem pôr do sol</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[
Deprecated: Constant SUNFUNCS_RET_STRING is deprecated in script on line 3
Deprecated: Function date_sunset() is deprecated since 8.1, use date_sun_info() instead in script on line 3
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
-->