1
0
mirror of https://github.com/php/doc-es.git synced 2026-03-24 07:22:16 +01:00
Files
2025-11-03 11:50:15 +01:00

299 lines
9.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: Marqitos Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="dateinterval.format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateInterval::format</refname>
<refpurpose>Formatea el intervalo</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DateInterval">
<modifier>public</modifier> <type>string</type><methodname>DateInterval::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>
Formatea el intervalo.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
<table>
<title>
Los siguientes caracteres están reconocidos en el
parámetro de cadena <parameter>format</parameter>.
Cada carácter de formato debe ser prefijado con un signo de porcentaje
(<literal>%</literal>).
</title>
<tgroup cols="3">
<thead>
<row>
<entry>Carácter <parameter>format</parameter></entry>
<entry>Descripción</entry>
<entry>Valores de ejemplo</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>%</literal></entry>
<entry>Literal <literal>%</literal></entry>
<entry><literal>%</literal></entry>
</row>
<row>
<entry><literal>Y</literal></entry>
<entry>Años, numérico, al menos 2 dígitos con 0 a la izquierda</entry>
<entry><literal>01</literal>, <literal>03</literal></entry>
</row>
<row>
<entry><literal>y</literal></entry>
<entry>Años, numérico</entry>
<entry><literal>1</literal>, <literal>3</literal></entry>
</row>
<row>
<entry><literal>M</literal></entry>
<entry>Meses, numérico, al menos 2 dígitos con 0 a la izquierda</entry>
<entry><literal>01</literal>, <literal>03</literal>, <literal>12</literal></entry>
</row>
<row>
<entry><literal>m</literal></entry>
<entry>Meses, numérico</entry>
<entry><literal>1</literal>, <literal>3</literal>, <literal>12</literal></entry>
</row>
<row>
<entry><literal>D</literal></entry>
<entry>Días, numérico, al menos 2 dígitos con 0 a la izquierda</entry>
<entry><literal>01</literal>, <literal>03</literal>, <literal>31</literal></entry>
</row>
<row>
<entry><literal>d</literal></entry>
<entry>Días, numérico</entry>
<entry><literal>1</literal>, <literal>3</literal>, <literal>31</literal></entry>
</row>
<row>
<entry><literal>a</literal></entry>
<entry>Número total de días como resultado de una operación con <methodname>DateTime::diff</methodname>, o de lo contrario <literal>(unknown)</literal></entry>
<entry><literal>4</literal>, <literal>18</literal>, <literal>8123</literal></entry>
</row>
<row>
<entry><literal>H</literal></entry>
<entry>Horas, numérico, al menos 2 dígitos con 0 a la izquierda</entry>
<entry><literal>01</literal>, <literal>03</literal>, <literal>23</literal></entry>
</row>
<row>
<entry><literal>h</literal></entry>
<entry>Horas, numérico</entry>
<entry><literal>1</literal>, <literal>3</literal>, <literal>23</literal></entry>
</row>
<row>
<entry><literal>I</literal></entry>
<entry>Minutos, numérico, al menos 2 dígitos con 0 a la izquierda</entry>
<entry><literal>01</literal>, <literal>03</literal>, <literal>59</literal></entry>
</row>
<row>
<entry><literal>i</literal></entry>
<entry>Minutos, numérico</entry>
<entry><literal>1</literal>, <literal>3</literal>, <literal>59</literal></entry>
</row>
<row>
<entry><literal>S</literal></entry>
<entry>Segundos, numérico, al menos 2 dígitos con 0 a la izquierda</entry>
<entry><literal>01</literal>, <literal>03</literal>, <literal>57</literal></entry>
</row>
<row>
<entry><literal>s</literal></entry>
<entry>Segundos, numérico</entry>
<entry><literal>1</literal>, <literal>3</literal>, <literal>57</literal></entry>
</row>
<row>
<entry><literal>F</literal></entry>
<entry>Microsegundos, numérico, al menos 6 dígitos con 0 a la izquierda
0</entry>
<entry><literal>007701</literal>, <literal>052738</literal>, <literal>428291</literal></entry>
</row>
<row>
<entry><literal>f</literal></entry>
<entry>Microsegundos, numérico</entry>
<entry><literal>7701</literal>, <literal>52738</literal>, <literal>428291</literal></entry>
</row>
<row>
<entry><literal>R</literal></entry>
<entry>Signo "<literal>-</literal>" cuando es negativo, "<literal>+</literal>" cuando es positivo</entry>
<entry><literal>-</literal>, <literal>+</literal></entry>
</row>
<row>
<entry><literal>r</literal></entry>
<entry>Signo "<literal>-</literal>" cuando es negativo, vacío cuando es positivo</entry>
<entry><literal>-</literal>, <literal/></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Devuelve el intervalo formateado.
</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>7.2.12</entry>
<entry>
Los caracteres de formato <literal>F</literal> y <literal>f</literal>
ahora siempre serán positivos.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
Se han añadido los caracteres de formato
<literal>F</literal> y <literal>f</literal>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Ejemplo de <classname>DateInterval</classname></title>
<programlisting role="php">
<![CDATA[
<?php
$interval = new DateInterval('P2Y4DT6H8M');
echo $interval->format('%d days');
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
4 days
]]>
</screen>
</example>
</para>
<para>
<example>
<title><classname>DateInterval</classname> y excesos</title>
<programlisting role="php">
<![CDATA[
<?php
$interval = new DateInterval('P32D');
echo $interval->format('%d days');
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
32 days
]]>
</screen>
</example>
</para>
<para>
<example>
<title>
<classname>DateInterval</classname> y
<methodname>DateTime::diff</methodname> con los modificadores %a y %d
</title>
<programlisting role="php">
<![CDATA[
<?php
$january = new DateTime('2010-01-01');
$february = new DateTime('2010-02-01');
$interval = $february->diff($january);
// %a imprimirá el múmero total de días.
echo $interval->format('%a total days')."\n";
// Mientras que %d sólo imprimirá el múmero total de días no cubiertos por el
// mes.
echo $interval->format('%m month, %d days');
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
31 total days
1 month, 0 days
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
El método <methodname>DateInterval::format</methodname> no
recalcula los desbordamientos en los strings de tiempo ni en los segmentos de fecha. Esto
se espera porque no es posible desbordar valores como <literal>"32 días"</literal>
que podrían interpretarse en algo como, desde <literal>"1 mes y 4 días"</literal>
hasta <literal>"1 mes y 1 día"</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DateTime::diff</methodname></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
-->