<!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>Set the pattern used by the formatter</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="messageformatter.parse.html">MessageFormatter::parse</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.intlcalendar.html">IntlCalendar</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.setpattern" class="refentry">
<div class="refnamediv">
<h1 class="refname">MessageFormatter::setPattern</h1>
<h1 class="refname">msgfmt_set_pattern</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">MessageFormatter::setPattern</span> -- <span class="refname">msgfmt_set_pattern</span> — <span class="dc-title">Set the pattern used by the formatter</span></p>
</div>
<div class="refsect1 description" id="refsect1-messageformatter.setpattern-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">bool</span>
<span class="methodname"><strong>MessageFormatter::setPattern</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$pattern</code></span>
)</div>
<p class="para rdfs-comment">
Procedural style
</p>
<div class="methodsynopsis dc-description">
<span class="type">bool</span>
<span class="methodname"><strong>msgfmt_set_pattern</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">string</span> <code class="parameter">$pattern</code></span>
)</div>
<p class="para rdfs-comment">
Set the pattern used by the formatter
</p>
</div>
<div class="refsect1 parameters" id="refsect1-messageformatter.setpattern-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">pattern</code></em></span>
<dd>
<p class="para">
The pattern <span class="type"><a href="language.types.string.html" class="type string">string</a></span> to use in this message formatter.
The pattern uses an 'apostrophe-friendly' syntax; it is run through
<a href="http://www.icu-project.org/apiref/icu4c/umsg_8h.html#9da796210146ff51d395affe4928f0b7" class="link external">» umsg_autoQuoteApostrophe</a>
before being interpreted.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-messageformatter.setpattern-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-messageformatter.setpattern-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2589">
<p><strong>Example #1 <span class="function"><strong>msgfmt_set_pattern()</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} monkeys on {1, number} trees" </span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"Default pattern: '" </span><span style="color: #007700">. </span><span style="color: #0000BB">msgfmt_get_pattern</span><span style="color: #007700">( </span><span style="color: #0000BB">$fmt </span><span style="color: #007700">) . </span><span style="color: #DD0000">"'\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"Formatting result: " </span><span style="color: #007700">. </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">123</span><span style="color: #007700">, </span><span style="color: #0000BB">456</span><span style="color: #007700">) ) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">msgfmt_set_pattern</span><span style="color: #007700">( </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, </span><span style="color: #DD0000">"{0, number} trees hosting {1, number} monkeys" </span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"New pattern: '" </span><span style="color: #007700">. </span><span style="color: #0000BB">msgfmt_get_pattern</span><span style="color: #007700">( </span><span style="color: #0000BB">$fmt </span><span style="color: #007700">) . </span><span style="color: #DD0000">"'\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"Formatted number: " </span><span style="color: #007700">. </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">123</span><span style="color: #007700">, </span><span style="color: #0000BB">456</span><span style="color: #007700">) ) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-2590">
<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} monkeys on {1, number} trees" </span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"Default pattern: '" </span><span style="color: #007700">. </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">getPattern</span><span style="color: #007700">() . </span><span style="color: #DD0000">"'\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"Formatting result: " </span><span style="color: #007700">. </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">123</span><span style="color: #007700">, </span><span style="color: #0000BB">456</span><span style="color: #007700">)) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">setPattern</span><span style="color: #007700">(</span><span style="color: #DD0000">"{0, number} trees hosting {1, number} monkeys" </span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"New pattern: '" </span><span style="color: #007700">. </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">getPattern</span><span style="color: #007700">() . </span><span style="color: #DD0000">"'\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"Formatted number: " </span><span style="color: #007700">. </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">123</span><span style="color: #007700">, </span><span style="color: #0000BB">456</span><span style="color: #007700">)) . </span><span style="color: #DD0000">"\n"</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>
Default pattern: '{0,number} monkeys on {1,number} trees'
Formatting result: 123 monkeys on 456 trees
New pattern: '{0,number} trees hosting {1,number} monkeys'
Formatted number: 123 trees hosting 456 monkeys
</pre></div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-messageformatter.setpattern-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.getpattern.html" class="function" rel="rdfs-seeAlso">msgfmt_get_pattern()</a> - Get the pattern used by the formatter</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.parse.html">MessageFormatter::parse</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.intlcalendar.html">IntlCalendar</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>
