<!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>Parse input string according to pattern</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="messageformatter.parsemessage.html">MessageFormatter::parseMessage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="messageformatter.setpattern.html">MessageFormatter::setPattern</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.parse" class="refentry">
<div class="refnamediv">
<h1 class="refname">MessageFormatter::parse</h1>
<h1 class="refname">msgfmt_parse</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">MessageFormatter::parse</span> -- <span class="refname">msgfmt_parse</span> — <span class="dc-title">Parse input string according to pattern</span></p>
</div>
<div class="refsect1 description" id="refsect1-messageformatter.parse-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">array</span>
<span class="methodname"><strong>MessageFormatter::parse</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
)</div>
<p class="para rdfs-comment">
Procedural style
</p>
<div class="methodsynopsis dc-description">
<span class="type">array</span>
<span class="methodname"><strong>msgfmt_parse</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">$value</code></span>
)</div>
<p class="para rdfs-comment">
Parses input <span class="type"><a href="language.types.string.html" class="type string">string</a></span> and return any extracted items as an <span class="type"><a href="language.types.array.html" class="type array">array</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-messageformatter.parse-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">value</code></em></span>
<dd>
<p class="para">
The <span class="type"><a href="language.types.string.html" class="type string">string</a></span> to parse
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-messageformatter.parse-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An <span class="type"><a href="language.types.array.html" class="type array">array</a></span> containing the items extracted, or <strong><code>FALSE</code></strong> on error
</p>
</div>
<div class="refsect1 examples" id="refsect1-messageformatter.parse-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2587">
<p><strong>Example #1 <span class="function"><strong>msgfmt_parse()</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 /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">msgfmt_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, </span><span style="color: #DD0000">"4,560 monkeys on 123 trees make 37.073 monkeys per tree"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_export</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">);<br /><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 /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">msgfmt_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, </span><span style="color: #DD0000">"4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_export</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-2588">
<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 /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">parse</span><span style="color: #007700">(</span><span style="color: #DD0000">"4,560 monkeys on 123 trees make 37.073 monkeys per tree"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_export</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">);<br /><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 /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">parse</span><span style="color: #007700">(</span><span style="color: #DD0000">"4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_export</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</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>
array (
0 => 4560,
1 => 123,
2 => 37.073,
)
array (
0 => 4560,
1 => 123,
2 => 37.073,
)
</pre></div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-messageformatter.parse-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.format.html" class="function" rel="rdfs-seeAlso">msgfmt_format()</a> - Format the message</span></li>
<li class="member"> <span class="function"><a href="messageformatter.parsemessage.html" class="function" rel="rdfs-seeAlso">msgfmt_parse_message()</a> - Quick parse input string</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.parsemessage.html">MessageFormatter::parseMessage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="messageformatter.setpattern.html">MessageFormatter::setPattern</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>
