format.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0545e305cf06937b14b3f0694d6e716c9881ffd7 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: DAnnebicque -->
<refentry xml:id="intldateformatter.format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlDateFormatter::format</refname>
  <refname>datefmt_format</refname>
  <refpurpose>Formatea la fecha y la hora como string</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="IntlDateFormatter">
   <modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>IntlDateFormatter::format</methodname>
   <methodparam><type class="union"><type>IntlCalendar</type><type>DateTimeInterface</type><type>array</type><type>string</type><type>int</type><type>float</type></type><parameter>datetime</parameter></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>datefmt_format</methodname>
   <methodparam><type>IntlDateFormatter</type><parameter>formatter</parameter></methodparam>
   <methodparam><type class="union"><type>IntlCalendar</type><type>DateTimeInterface</type><type>array</type><type>string</type><type>int</type><type>float</type></type><parameter>datetime</parameter></methodparam>
  </methodsynopsis>
  <para>
   Formatea la hora como string.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>formatter</parameter></term>
     <listitem>
      <para>
       El recurso de formateador <classname>IntlDateFormatter</classname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>datetime</parameter></term>
     <listitem>
      <para>
       El valor a formatear. Puede ser un objeto <classname>DateTimeInterface</classname>,
       un objeto <classname>IntlCalendar</classname>, un tipo <type>numeric</type>
       representando un (puede ser fraccionado) número de segundos desde
       la época o un <type>array</type> en el formato de salida de la función
       <function>localtime</function>.
      </para>
      <para>
       Si se pasa un objeto <classname>DateTime</classname> o un objeto
       <classname>IntlCalendar</classname>, su zona horaria
       no será considerada. El objeto deberá ser formateado utilizando la
       zona horaria configurada para este formateador. Si se desea
       utilizar la zona horaria del objeto a formatear, el método
       <function>IntlDateFormatter::setTimeZone</function> deberá ser
       llamado antes de la zona horaria del objeto. También puede
       utilizarse el método <function>IntlDateFormatter::formatObject</function>
       para obtener el mismo resultado.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   El string formateado, o, si ocurre un error, &false;.
  </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.1.5</entry>
       <entry>
        Se añadió el soporte para proporcionar un objeto genérico
        <classname>DateTimeInterface</classname> para el argumento
        <parameter>datetime</parameter>. Anteriormente, solo los objetos válidos
        <classname>DateTime</classname> eran soportados.
       </entry>
      </row>
      <row>
       <entry>PECL intl 3.0.0</entry>
       <entry>
        Ahora es posible pasar un objeto
        <classname>IntlCalendar</classname> como valor del argumento
        <parameter>datetime</parameter>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Ejemplo con <function>datefmt_format</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$fmt = datefmt_create(
    'en_US',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'America/Los_Angeles',
    IntlDateFormatter::GREGORIAN
);
echo 'El primer formato mostrado es ' . datefmt_format($fmt, 0);

$fmt = datefmt_create(
    'de-DE',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'America/Los_Angeles',
    IntlDateFormatter::GREGORIAN
);
echo 'El segundo formato mostrado es ' . datefmt_format($fmt, 0);

$fmt = datefmt_create(
    'en_US',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'America/Los_Angeles',
    IntlDateFormatter::GREGORIAN,
    'MM/dd/yyyy'
);
echo 'El primer formato es mostrado con el patrón ' . datefmt_format($fmt, 0);

$fmt = datefmt_create(
    'de-DE',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'America/Los_Angeles',
    IntlDateFormatter::GREGORIAN,
    'MM/dd/yyyy'
);
echo "El segundo formato es mostrado con el patrón " . datefmt_format($fmt, 0);
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Ejemplo orientado a objetos</title>
   <programlisting role="php">
<![CDATA[
<?php
$fmt = new IntlDateFormatter(
    'en_US',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'America/Los_Angeles',
    IntlDateFormatter::GREGORIAN
);
echo 'El primer formato mostrado es ' . $fmt->format(0);

$fmt = new IntlDateFormatter(
    'de-DE',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'America/Los_Angeles',
    IntlDateFormatter::GREGORIAN
);
echo 'El segundo formato mostrado es ' . $fmt->format(0);

$fmt = new IntlDateFormatter(
    'en_US',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'America/Los_Angeles',
    IntlDateFormatter::GREGORIAN,
    'MM/dd/yyyy'
);
echo 'El primer formato es mostrado con el patrón ' . $fmt->format(0);

$fmt = new IntlDateFormatter(
    'de-DE',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'America/Los_Angeles',
    IntlDateFormatter::GREGORIAN,
    'MM/dd/yyyy'
);
echo 'El segundo formato es mostrado con el patrón ' . $fmt->format(0);
?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
El primer formato mostrado es Wednesday, December 31, 1969 4:00:00 PM PT
El segundo formato mostrado es Mittwoch, 31. Dezember 1969 16:00 Uhr GMT-08:00
El primer formato es mostrado con el patrón : 12/31/1969
El segundo formato es mostrado con el patrón : 12/31/1969
]]>
  </screen>
  <example>
   <title>Ejemplo con un objeto <classname>IntlCalendar</classname></title>
   <programlisting role="php">
<![CDATA[
<?php
$tz = reset(iterator_to_array(IntlTimeZone::createEnumeration('FR')));
$formatter = IntlDateFormatter::create(
    'fr_FR',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    $tz,
    IntlDateFormatter::GREGORIAN
);

$cal = IntlCalendar::createInstance($tz, '@calendar=islamic-civil');
$cal->set(IntlCalendar::FIELD_MONTH, 8); //9º mes, Ramadán
$cal->set(IntlCalendar::FIELD_DAY_OF_MONTH, 1); //1º día
$cal->clear(IntlCalendar::FIELD_HOUR_OF_DAY);
$cal->clear(IntlCalendar::FIELD_MINUTE);
$cal->clear(IntlCalendar::FIELD_SECOND);
$cal->clear(IntlCalendar::FIELD_MILLISECOND);

echo "En el año Islámico, el Ramadán comienza el :\n\t",
        $formatter->format($cal), "\n";

//Es la zona horaria del formateador la que se utiliza aquí :
$formatter->setTimeZone('Asia/Tokyo');
echo "Después de modificar la zona horaria :\n\t",
        $formatter->format($cal), "\n";

]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
En el año Islámico, el Ramadán comienza el :
    martes 9 julio 2013 19:00:00 hora avanzada de Europa central
Después de modificar la zona horaria :
    miércoles 10 julio 2013 02:00:00 hora normal de Japón

]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>datefmt_create</function></member>
    <member><function>datefmt_parse</function></member>
    <member><function>datefmt_get_error_code</function></member>
    <member><function>datefmt_get_error_message</function></member>
    <member><function>datefmt_format_object</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
-->