construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 71692b6f4cace8dca72a18ccd80d4cd7305e5d4e Maintainer: Marqitos Status: ready -->
<!-- Reviewed: no 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="DateInterval">
   <modifier>public</modifier> <methodname>DateInterval::__construct</methodname>
   <methodparam><type>string</type><parameter>duration</parameter></methodparam>
  </constructorsynopsis>
  <para>
   Crea un nuevo objeto DateInterval.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>duration</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>duration</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,
            Antes de PHP 8.0.0, 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>DateMalformedIntervalStringException</classname> cuando
   el <parameter>duration</parameter> no puede ser analizado como un intervalo.
   Antes de PHP 8.3, esto era <exceptionname>Exception</exceptionname>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.3.0</entry>
      <entry>
       Ahora lanza
       <exceptionname>DateMalformedIntervalStringException</exceptionname>
       en lugar de <exceptionname>Exception</exceptionname>.
      </entry>
     </row>
     <row>
      <entry>8.2.0</entry>
      <entry>
       Solo serán visibles las propiedades <literal>y</literal> a <literal>f</literal>,
       <literal>invert</literal> y <literal>days</literal>, incluyendo una nueva
       propiedad booleana <literal>from_string</literal>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <literal>W</literal> se puede combinar con <literal>D</literal>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Contruyendo y usando objetos <classname>DateInterval</classname></title>
    <programlisting role="php">
<![CDATA[
<?php
// Crea una fecha especifica
$someDate = \DateTime::createFromFormat("Y-m-d H:i", "2022-08-25 14:18");

// Crea un intervalo
$interval = new \DateInterval("P7D");

// Añade el intervalo
$someDate->add($interval);

// Convierte el intervalo a string
echo $interval->format("%d");
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
7
]]>
    </screen>
   </example>
  </para>

  <para>
   <example>
    <title>Ejemplo de <classname>DateInterval</classname></title>
    <programlisting role="php">
<![CDATA[
<?php

$interval = new DateInterval('P1W2D');
var_dump($interval);

?>
]]>
    </programlisting>
    &example.outputs.82;
    <screen role="php">
<![CDATA[
object(DateInterval)#1 (10) {
  ["y"]=>
  int(0)
  ["m"]=>
  int(0)
  ["d"]=>
  int(9)
  ["h"]=>
  int(0)
  ["i"]=>
  int(0)
  ["s"]=>
  int(0)
  ["f"]=>
  float(0)
  ["invert"]=>
  int(0)
  ["days"]=>
  bool(false)
  ["from_string"]=>
  bool(false)
}
]]>
    </screen>
    &example.outputs.8;
    <screen role="php">
<![CDATA[
object(DateInterval)#1 (16) {
  ["y"]=>
  int(0)
  ["m"]=>
  int(0)
  ["d"]=>
  int(9)
  ["h"]=>
  int(0)
  ["i"]=>
  int(0)
  ["s"]=>
  int(0)
  ["f"]=>
  float(0)
  ["weekday"]=>
  int(0)
  ["weekday_behavior"]=>
  int(0)
  ["first_last_day_of"]=>
  int(0)
  ["invert"]=>
  int(0)
  ["days"]=>
  bool(false)
  ["special_type"]=>
  int(0)
  ["special_amount"]=>
  int(0)
  ["have_weekday_relative"]=>
  int(0)
  ["have_special_relative"]=>
  int(0)
}
]]>
    </screen>
    &example.outputs.7;
    <screen role="php">
     <![CDATA[
object(DateInterval)#1 (16) {
  ["y"]=>
  int(0)
  ["m"]=>
  int(0)
  ["d"]=>
  int(2)
  ["h"]=>
  int(0)
  ["i"]=>
  int(0)
  ["s"]=>
  int(0)
  ["f"]=>
  float(0)
  ["weekday"]=>
  int(0)
  ["weekday_behavior"]=>
  int(0)
  ["first_last_day_of"]=>
  int(0)
  ["invert"]=>
  int(0)
  ["days"]=>
  bool(false)
  ["special_type"]=>
  int(0)
  ["special_amount"]=>
  int(0)
  ["have_weekday_relative"]=>
  int(0)
  ["have_special_relative"]=>
  int(0)
}
]]>
    </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
-->