archived-doc-es/reference/datetime/dateinterval/construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 41f1e8e0de702594b60d3aef233f3935929c22ef Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->

<refentry xml:id="dateinterval.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DateInterval::__construct</refname>
  <refpurpose>Crea un nuevo objeto DateInterval</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis role="oop">
   <modifier>public</modifier> <methodname>DateInterval::__construct</methodname>
   <methodparam><type>string</type><parameter>interval_spec</parameter></methodparam>
  </constructorsynopsis>
  <para>
   Crea un nuevo objeto DateInterval.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>interval_spec</parameter></term>
     <listitem>
      <para>
       Una especificación de intervalo.
      </para>
      <para>
       El formato empieza con la letra <literal>P</literal>,
       de <quote>periodo.</quote>
       Cada periodo de duración está representado por un valor de tipo integer
       seguido de un indicador de periodo.
       Si la duración contiene elementos de hora, esa parte
       de la especificación estará precedida por una letra
       <literal>T</literal>.
      </para>
      <para>
       <table>
        <title>
         Indicadores de periodo de <parameter>interval_spec</parameter>
        </title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Indicador de periodo</entry>
           <entry>Descripción</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>Y</literal></entry>
           <entry>años</entry>
          </row>
          <row>
           <entry><literal>M</literal></entry>
           <entry>meses</entry>
          </row>
          <row>
           <entry><literal>D</literal></entry>
           <entry>días</entry>
          </row>
          <row>
           <entry><literal>W</literal></entry>
           <entry>
            semanas; estas se convierten a días,
            por lo que no se puede combinar con <literal>D</literal>.
           </entry>
          </row>
          <row>
           <entry><literal>H</literal></entry>
           <entry>horas</entry>
          </row>
          <row>
           <entry><literal>M</literal></entry>
           <entry>minutos</entry>
          </row>
          <row>
           <entry><literal>S</literal></entry>
           <entry>segundos</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
      <para>
       Algunos ejemplos sencillos:
       Dos días es <literal>P2D</literal>.
       Dos segundos es <literal>PT2S</literal>.
       Seis años y cinco minutos es <literal>P6YT5M</literal>.
      </para>
      <note>
       <para>
        Los tipos de unidades deben ser escritos desde la unidad de
        escala más grande a la izquierda a la unidad de escala más pequeña
        a la derecha.
        Así los años van antes que los meses, meses antes que días,
        días antes que minutos, etc.
        Así un año y cuatro días debe representarse como
        <literal>P1Y4D</literal>, y no como <literal>P4D1Y</literal>.
       </para>
      </note>
      <para>
       La especificación también puede ser representada como una fecha/hora.
       Un ejemplo de un año y cuatro días sería
       <literal>P0001-00-04T00:00:00</literal>.
       Pero los valores en este formato no pueden exceder el punto de desbordamiento
       de un periodo (p.ej. <literal>25</literal> horas no es válido).
      </para>
      <para>
       Estos formatos están basados en la <link
       xlink:href="&url.iso-8601.duration;">especificación de duración
       ISO 8601</link>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Lanza una <classname>Exception</classname> cuando el <parameter>interval_spec</parameter>
   no puede ser analizado como un intervalo.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <classname>DateInterval</classname></title>
    <programlisting role="php">
<![CDATA[
<?php

$intervalo = new DateInterval('P2Y4DT6H8M');
var_dump($intervalo);

?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
object(DateInterval)#1 (8) {
  ["y"]=>
  int(2)
  ["m"]=>
  int(0)
  ["d"]=>
  int(4)
  ["h"]=>
  int(6)
  ["i"]=>
  int(8)
  ["s"]=>
  int(0)
  ["invert"]=>
  int(0)
  ["days"]=>
  bool(false)
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>DateInterval::format</function></member>
    <member><function>DateTime::add</function></member>
    <member><function>DateTime::sub</function></member>
    <member><function>DateTime::diff</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
-->