<!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 a number</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="numberformatter.parsecurrency.html">NumberFormatter::parseCurrency</a></div>
<div class="next" style="text-align: right; float: right;"><a href="numberformatter.setattribute.html">NumberFormatter::setAttribute</a></div>
<div class="up"><a href="class.numberformatter.html">NumberFormatter</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="numberformatter.parse" class="refentry">
<div class="refnamediv">
<h1 class="refname">NumberFormatter::parse</h1>
<h1 class="refname">numfmt_parse</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">NumberFormatter::parse</span> -- <span class="refname">numfmt_parse</span> — <span class="dc-title">Parse a number</span></p>
</div>
<div class="refsect1 description" id="refsect1-numberformatter.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"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
<span class="methodname"><strong>NumberFormatter::parse</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$position</code></span>
]] )</div>
<p class="para rdfs-comment">
Procedural style
</p>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
<span class="methodname"><strong>numfmt_parse</strong></span>
( <span class="methodparam"><span class="type"><a href="class.numberformatter.html" class="type NumberFormatter">NumberFormatter</a></span> <code class="parameter">$fmt</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$position</code></span>
]] )</div>
<p class="para rdfs-comment">
Parse a string into a number using the current formatter rules.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-numberformatter.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">
<a href="class.numberformatter.html" class="classname">NumberFormatter</a> object.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<p class="para">
The
<a href="class.numberformatter.html#intl.numberformatter-constants.types" class="link">
formatting type</a> to use. By default,
<strong><code>NumberFormatter::TYPE_DOUBLE</code></strong> is used.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">position</code></em></span>
<dd>
<p class="para">
Offset in the string at which to begin parsing. On return, this value
will hold the offset at which parsing ended.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-numberformatter.parse-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The value of the parsed number or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-numberformatter.parse-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2523">
<p><strong>Example #1 <span class="function"><strong>numfmt_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">numfmt_create</span><span style="color: #007700">( </span><span style="color: #DD0000">'de_DE'</span><span style="color: #007700">, </span><span style="color: #0000BB">NumberFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">DECIMAL </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$num </span><span style="color: #007700">= </span><span style="color: #DD0000">"1.234.567,891"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">numfmt_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, </span><span style="color: #0000BB">$num</span><span style="color: #007700">).</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">numfmt_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, </span><span style="color: #0000BB">$num</span><span style="color: #007700">, </span><span style="color: #0000BB">NumberFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">TYPE_INT32</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-2524">
<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">NumberFormatter</span><span style="color: #007700">( </span><span style="color: #DD0000">'de_DE'</span><span style="color: #007700">, </span><span style="color: #0000BB">NumberFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">DECIMAL </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$num </span><span style="color: #007700">= </span><span style="color: #DD0000">"1.234.567,891"</span><span style="color: #007700">;<br />echo </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: #0000BB">$num</span><span style="color: #007700">).</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </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: #0000BB">$num</span><span style="color: #007700">, </span><span style="color: #0000BB">NumberFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">TYPE_INT32</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>
1234567.891
1234567
</pre></div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-numberformatter.parse-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="numberformatter.geterrorcode.html" class="function" rel="rdfs-seeAlso">numfmt_get_error_code()</a> - Get formatter's last error code.</span></li>
<li class="member"> <span class="function"><a href="numberformatter.format.html" class="function" rel="rdfs-seeAlso">numfmt_format()</a> - Format a number</span></li>
<li class="member"> <span class="function"><a href="numberformatter.parsecurrency.html" class="function" rel="rdfs-seeAlso">numfmt_parse_currency()</a> - Parse a currency number</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="numberformatter.parsecurrency.html">NumberFormatter::parseCurrency</a></div>
<div class="next" style="text-align: right; float: right;"><a href="numberformatter.setattribute.html">NumberFormatter::setAttribute</a></div>
<div class="up"><a href="class.numberformatter.html">NumberFormatter</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
