Files
Leonardo Lara Rodrigues 0d70ce9606 sync with en rev
2025-10-31 10:29:48 -03:00

317 lines
10 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: leonardolara Status: ready --><!-- CREDITS: felipe, surfmax, thiago, fabioluciano, leonardolara -->
<refentry xml:id="function.mktime" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mktime</refname>
<refpurpose>Obtém um timestamp Unix de uma data</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>mktime</methodname>
<methodparam><type>int</type><parameter>hour</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>minute</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>second</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>month</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>day</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>year</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Retorna o timestamp Unix correspondente aos argumentos informados.
Este timestamp é um inteiro longo contendo o número de segundos
entre a Época Unix (January 1 1970 00:00:00 GMT), e o horário
especificado.
</para>
<para>
Quaisquer argumentos opcionais
omitidos ou &null; serão definidos para os valores correntes de acordo
com a data e horário locais.
</para>
<warning>
<para>
Favor notar que os argumentos estão em uma ordem não usual:
<parameter>month</parameter>, <parameter>day</parameter>,
<parameter>year</parameter>, e não na ordem mais razoável
<parameter>year</parameter>, <parameter>month</parameter>,
<parameter>day</parameter>.
</para>
</warning>
<simpara>
Chamar <function>mktime</function> sem argumentos não é suportado,
e irá resultar em um <classname>ArgumentCountError</classname>.
<function>time</function> pode ser usada para obter o timestamp atual.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hour</parameter></term>
<listitem>
<para>
O número da hora relativa ao início de determinado dia do
<parameter>month</parameter>, <parameter>day</parameter> e <parameter>year</parameter>.
Valores negativos referenciam a hora anterior a meia noite do dia em questão.
Valores maiores que 23 referenciam a hora correspondente no(s) próximo(s) dia(s).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>minute</parameter></term>
<listitem>
<para>
O número de minutos relativos ao início da <parameter>hour</parameter>.
Valores negativos referenciam minutos da hora anterior.
Valores maiores que 23 referenciam os minutos correspondentes a(s) próxima(s) horas(s).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>second</parameter></term>
<listitem>
<para>
O número de segundos relativos ao início do <parameter>minute</parameter>.
Valores negativos referenciam segundos do minuto anterior.
Valores maiores que 23 referenciam os segundos correspondentes ao(s) próximo(s) minuto(s).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>month</parameter></term>
<listitem>
<para>
O número do mês relativo ao fim do anterior.
Valores de 1 a 12 referenciam o calendário normal de meses do ano em questão.
Valores menores que 1 (valores negativos, inclusos) referenciam meses do ano anterior em ordem reversa, então 0 é Dezembro, -1 Novembro, e etc.
Valores maiores que 12 referenciam meses correspondentes ao(s) próximo(s) ano(s).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>day</parameter></term>
<listitem>
<para>
O número do dia relativo ao final do mês anterior.
Valores de 1 a 28, 29, 30 e 31 (dependendo do mês) corresponde a dias normais no mês.
Valores menores que 1 (valores negativos, inclusos) corresponde a dias no mês anterior, então 0 é o último dia do mês anterior, -1 é o dia anterior a este, e etc.
Valores maiores que o número de dias do mês, referenciam dias correspondentes ao(s) próximo(s) mês(es).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
O número do ano. Pode conter dois ou quatro dígitos, com os valores
entre 0-69 significando 2000-2069 e 70-100 para 1970-2000. Em
sistemas aonde o time_t é um inteiro assinado de 32 bit, como é mais
comum, o faixa de valores para <parameter>year</parameter>
é algo entre 1901 e 2038.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A função <function>mktime</function> retorna o timestamp Unix dos argumentos
informados ou &false; se o timestamp não couber em um inteiro do PHP.
</para>
</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.0.0</entry>
<entry>
O parâmetro <parameter>hour</parameter> não é mais opcional. Se for necessário um timestamp
Unix, use a função <function>time</function>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>minute</parameter>, <parameter>second</parameter>, <parameter>month</parameter>,
<parameter>day</parameter> e <parameter>year</parameter> agora podem ser nulos.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemplo básico da função <function>mktime</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Configura o fuso horário padrão a ser utilizado.
date_default_timezone_set('UTC');
// Imprime: July 1, 2000 is on a Saturday
echo "July 1, 2000 is on a " . date("l", mktime(0, 0, 0, 7, 1, 2000)) . "\n";
// Imprime algo como: 2006-04-05T01:02:03+00:00
echo date('c', mktime(1, 2, 3, 4, 5, 2006)) . "\n";
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
July 1, 2000 is on a Saturday
2006-04-05T01:02:03+00:00
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Exemplo da <function>mktime</function></title>
<para>
<function>mktime</function> é útil para a aritmética e validação de data,
já que calculará automaticamente o valor correto para a entrada fora
do intervalo. Por exemplo, cada uma das seguintes linhas produzirá a string
"Jan-01-1998".
</para>
<programlisting role="php">
<![CDATA[
<?php
date_default_timezone_set('America/New_York');
echo date("c", mktime(0, 0, 0, 12, 32, 1997)) . "\n";
echo date("c", mktime(0, 0, 0, 13, 1, 1997)) . "\n";
echo date("c", mktime(0, 0, 0, 1, 1, 1998)) . "\n";
echo date("c", mktime(0, 0, 0, 1, 1, 98)) . "\n";
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
1998-01-01T00:00:00-05:00
1998-01-01T00:00:00-05:00
1998-01-01T00:00:00-05:00
1998-01-01T00:00:00-05:00
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Usando mktime para encontrar datas relativas</title>
<programlisting role="php">
<![CDATA[
<?php
date_default_timezone_set('Asia/Tokyo');
$tomorrow = mktime(0, 0, 0, date("m") , date("d")+1, date("Y"));
print date('c', $tomorrow) . "\n";
$lastmonth = mktime(0, 0, 0, date("m")-1, date("d"), date("Y"));
print date('c', $lastmonth) . "\n";
$nextyear = mktime(0, 0, 0, date("m"), date("d"), date("Y")+1) . "\n";
print date('c', $nextyear) . "\n";
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
2025-09-30T00:00:00+09:00
2025-08-29T00:00:00+09:00
2026-09-29T00:00:00+09:00
]]>
</screen>
</example>
<note>
<para>
Isto pode ser mais confiável que simplesmente adicionar ou substrair o número
de segundos em um dia ou mês de um timestamp por causa do fuso
horário.
</para>
</note>
</para>
<para>
<example>
<title>Último dia do próximo mês</title>
<para>
O último dia de um mês informado pode ser expressado como o dia "0" do mês
seguinte, não o dia -1. Os dois exemplos seguintes produzirão a string
"The last day in Feb 2000 is: 29".
</para>
<programlisting role="php">
<![CDATA[
<?php
$lastday = mktime(0, 0, 0, 3, 0, 2000);
echo 'Last day in Feb 2000 is: ', date('d', $lastday) . "\n";
$lastday = mktime(0, 0, 0, 4, -31, 2000);
echo 'Last day in Feb 2000 is: ', date('d', $lastday) . "\n";
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Last day in Feb 2000 is: 29
Last day in Feb 2000 is: 29
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>A classe <classname>DateTimeImmutable</classname></member>
<member><function>checkdate</function></member>
<member><function>gmmktime</function></member>
<member><function>date</function></member>
<member><function>time</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
-->