format-message.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: dacb2d9a9d924fd355af1abcff854571a5db4443 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="messageformatter.formatmessage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>MessageFormatter::formatMessage</refname>
  <refname>msgfmt_format_message</refname>
  <refpurpose>Formatea rápidamente un mensaje</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="MessageFormatter">
   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>MessageFormatter::formatMessage</methodname>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam><type>string</type><parameter>pattern</parameter></methodparam>
   <methodparam><type>array</type><parameter>values</parameter></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>msgfmt_format_message</methodname>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam><type>string</type><parameter>pattern</parameter></methodparam>
   <methodparam><type>array</type><parameter>values</parameter></methodparam>
  </methodsynopsis>
  <para>
   Función de formato rápido que formatea una cadena sin necesidad de
   crear explícitamente un objeto de formato. Utilice esta función
   cuando la operación de formato se realiza una sola vez y no es necesario
   conservar parámetros o estados, o cuando se desea personalizar la salida
   proporcionando directamente un contexto adicional a ICU.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>locale</parameter></term>
     <listitem>
      <para>
       La configuración local a utilizar para el formato
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pattern</parameter></term>
     <listitem>
      <para>
       El &string; en el cual se deben insertar los datos.
       El patrón utiliza una sintaxis que acepta comillas;
       Ver <link xlink:href="&url.icu.quoting;">Quoting/Escaping</link> para más detalles.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>values</parameter></term>
     <listitem>
      <para>
       El &array; de valores a insertar en la cadena de formato.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   La cadena formateada, o bien &false; si ocurre un error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Ejemplo con <function>msgfmt_format_message</function>, estilo procedimental</title>
   <programlisting role="php">
<![CDATA[
<?php
echo msgfmt_format_message("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree\n", array(4560, 123, 4560/123));
echo msgfmt_format_message("de", "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum\n", array(4560, 123, 4560/123));
echo msgfmt_format_message("en", 'You finished {place, selectordinal, one {#st} two {#nd} few {#rd} other {#th}}!', ['place' => 3]), "\n";
echo msgfmt_format_message("en",
        "There {apple, plural,
            =0 {are no apples}
            =1 {is one apple...}
            other {are # apples!}
        }",
    ['apple' => 0]
), "\n";
]]>
   </programlisting>
  </example>
  <example>
   <title>Ejemplo con <function>msgfmt_format_message</function>, estilo procedimental</title>
   <programlisting role="php">
<![CDATA[
<?php
echo MessageFormatter::formatMessage("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree\n", array(4560, 123, 4560/123));
echo MessageFormatter::formatMessage("de", "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum\n", array(4560, 123, 4560/123));
echo MessageFormatter::formatMessage("en", 'You finished {place, selectordinal, one {#st} two {#nd} few {#rd} other {#th}}!', ['place' => 3]), "\n";
echo MessageFormatter::formatMessage("en",
        "There {apple, plural,
            =0 {are no apples}
            =1 {is one apple...}
            other {are # apples!}
        }",
    ['apple' => 0]
), "\n";
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
4,560 monkeys on 123 trees make 37.073 monkeys per tree
4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum
You finished 3rd!
There are no apples
]]>
  </screen>
  <example>
   <title>Solicitar a ICU que formatee la moneda con el símbolo monetario común y con el símbolo monetario corto.</title>
   <simpara>Requiere ICU ≥ 67.</simpara>
   <programlisting role="php">
<![CDATA[
<?php
echo msgfmt_format_message("cs_CZ", "{0, number, :: currency/CAD}", array(123.45));
echo msgfmt_format_message("cs_CZ", "{0, number, :: currency/CAD unit-width-narrow}", array(123.45));
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
123,45 CA$
123,45 $
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>msgfmt_create</function></member>
    <member><function>msgfmt_parse</function></member>
    <member><function>msgfmt_get_error_code</function></member>
    <member><function>msgfmt_get_error_message</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
-->