<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Format the message</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="messageformatter.formatmessage.html">MessageFormatter::formatMessage</a></div> <div class="next" style="text-align: right; float: right;"><a href="messageformatter.geterrorcode.html">MessageFormatter::getErrorCode</a></div> <div class="up"><a href="class.messageformatter.html">MessageFormatter</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="messageformatter.format" class="refentry"> <div class="refnamediv"> <h1 class="refname">MessageFormatter::format</h1> <h1 class="refname">msgfmt_format</h1> <p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">MessageFormatter::format</span> -- <span class="refname">msgfmt_format</span> — <span class="dc-title">Format the message</span></p> </div> <div class="refsect1 description" id="refsect1-messageformatter.format-description"> <h3 class="title">Description</h3> <p class="para"> Object oriented style </p> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>MessageFormatter::format</strong></span> ( <span class="methodparam"><span class="type">array</span> <code class="parameter">$args</code></span> )</div> <p class="para rdfs-comment"> Procedural style </p> <div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><strong>msgfmt_format</strong></span> ( <span class="methodparam"><span class="type"><a href="class.messageformatter.html" class="type MessageFormatter">MessageFormatter</a></span> <code class="parameter">$fmt</code></span> , <span class="methodparam"><span class="type">array</span> <code class="parameter">$args</code></span> )</div> <p class="para rdfs-comment"> Format the message by substituting the data into the format string according to the locale rules </p> </div> <div class="refsect1 parameters" id="refsect1-messageformatter.format-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">fmt</code></em></span> <dd> <p class="para"> The message formatter </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">args</code></em></span> <dd> <p class="para"> Arguments to insert into the format string </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-messageformatter.format-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> The formatted string, or <strong><code>FALSE</code></strong> if an error occurred </p> </div> <div class="refsect1 examples" id="refsect1-messageformatter.format-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-2575"> <p><strong>Example #1 <span class="function"><strong>msgfmt_format()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$fmt </span><span style="color: #007700">= </span><span style="color: #0000BB">msgfmt_create</span><span style="color: #007700">(</span><span style="color: #DD0000">"en_US"</span><span style="color: #007700">, </span><span style="color: #DD0000">"{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">msgfmt_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, array(</span><span style="color: #0000BB">4560</span><span style="color: #007700">, </span><span style="color: #0000BB">123</span><span style="color: #007700">, </span><span style="color: #0000BB">4560</span><span style="color: #007700">/</span><span style="color: #0000BB">123</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$fmt </span><span style="color: #007700">= </span><span style="color: #0000BB">msgfmt_create</span><span style="color: #007700">(</span><span style="color: #DD0000">"de"</span><span style="color: #007700">, </span><span style="color: #DD0000">"{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">msgfmt_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, array(</span><span style="color: #0000BB">4560</span><span style="color: #007700">, </span><span style="color: #0000BB">123</span><span style="color: #007700">, </span><span style="color: #0000BB">4560</span><span style="color: #007700">/</span><span style="color: #0000BB">123</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> <div class="example" id="example-2576"> <p><strong>Example #2 OO example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$fmt </span><span style="color: #007700">= new </span><span style="color: #0000BB">MessageFormatter</span><span style="color: #007700">(</span><span style="color: #DD0000">"en_US"</span><span style="color: #007700">, </span><span style="color: #DD0000">"{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(array(</span><span style="color: #0000BB">4560</span><span style="color: #007700">, </span><span style="color: #0000BB">123</span><span style="color: #007700">, </span><span style="color: #0000BB">4560</span><span style="color: #007700">/</span><span style="color: #0000BB">123</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$fmt </span><span style="color: #007700">= new </span><span style="color: #0000BB">MessageFormatter</span><span style="color: #007700">(</span><span style="color: #DD0000">"de"</span><span style="color: #007700">, </span><span style="color: #DD0000">"{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(array(</span><span style="color: #0000BB">4560</span><span style="color: #007700">, </span><span style="color: #0000BB">123</span><span style="color: #007700">, </span><span style="color: #0000BB">4560</span><span style="color: #007700">/</span><span style="color: #0000BB">123</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> <p class="para">The above example will output:</p> <div class="example-contents screen"> <div class="cdata"><pre> 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 </pre></div> </div> </div> <div class="refsect1 seealso" id="refsect1-messageformatter.format-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="messageformatter.create.html" class="function" rel="rdfs-seeAlso">msgfmt_create()</a> - Constructs a new Message Formatter</span></li> <li class="member"> <span class="function"><a href="messageformatter.parse.html" class="function" rel="rdfs-seeAlso">msgfmt_parse()</a> - Parse input string according to pattern</span></li> <li class="member"> <span class="function"><a href="messageformatter.formatmessage.html" class="function" rel="rdfs-seeAlso">msgfmt_format_message()</a> - Quick format message</span></li> <li class="member"> <span class="function"><a href="messageformatter.geterrorcode.html" class="function" rel="rdfs-seeAlso">msgfmt_get_error_code()</a> - Get the error code from last operation</span></li> <li class="member"> <span class="function"><a href="messageformatter.geterrormessage.html" class="function" rel="rdfs-seeAlso">msgfmt_get_error_message()</a> - Get the error text from the last operation</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="messageformatter.formatmessage.html">MessageFormatter::formatMessage</a></div> <div class="next" style="text-align: right; float: right;"><a href="messageformatter.geterrorcode.html">MessageFormatter::getErrorCode</a></div> <div class="up"><a href="class.messageformatter.html">MessageFormatter</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>