<!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>Get float value of a variable</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.empty.html">empty</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.get-defined-vars.html">get_defined_vars</a></div>
<div class="up"><a href="ref.var.html">Variable handling Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.floatval" class="refentry">
<div class="refnamediv">
<h1 class="refname">floatval</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">floatval</span> — <span class="dc-title">Get float value of a variable</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.floatval-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">float</span> <span class="methodname"><strong>floatval</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$var</code></span>
)</div>
<p class="para rdfs-comment">
Gets the <span class="type"><a href="language.types.float.html" class="type float">float</a></span> value of <em><code class="parameter">var</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.floatval-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">var</code></em></span>
<dd>
<p class="para">
May be any scalar type. <span class="function"><strong>floatval()</strong></span> should not be used
on objects, as doing so will emit an <strong><code>E_NOTICE</code></strong> level
error and return 1.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.floatval-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The float value of the given variable. Empty arrays return 0, non-empty
arrays return 1.
</p>
<p class="para">
Strings will most likely return 0 although this depends on the
leftmost characters of the string. The common rules of
<a href="language.types.float.html#language.types.float.casting" class="link">float casting</a>
apply.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.floatval-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5249">
<p><strong>Example #1 <span class="function"><strong>floatval()</strong></span> Example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$var </span><span style="color: #007700">= </span><span style="color: #DD0000">'122.34343The'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$float_value_of_var </span><span style="color: #007700">= </span><span style="color: #0000BB">floatval</span><span style="color: #007700">(</span><span style="color: #0000BB">$var</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$float_value_of_var</span><span style="color: #007700">; </span><span style="color: #FF8000">// 122.34343<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-5250">
<p><strong>Example #2 <span class="function"><strong>floatval()</strong></span> non-numeric leftmost characters Example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$var </span><span style="color: #007700">= </span><span style="color: #DD0000">'The122.34343'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$float_value_of_var </span><span style="color: #007700">= </span><span style="color: #0000BB">floatval</span><span style="color: #007700">(</span><span style="color: #0000BB">$var</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$float_value_of_var</span><span style="color: #007700">; </span><span style="color: #FF8000">// 0<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.floatval-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.boolval.html" class="function" rel="rdfs-seeAlso">boolval()</a> - Get the boolean value of a variable</span></li>
<li class="member"> <span class="function"><a href="function.intval.html" class="function" rel="rdfs-seeAlso">intval()</a> - Get the integer value of a variable</span></li>
<li class="member"> <span class="function"><a href="function.strval.html" class="function" rel="rdfs-seeAlso">strval()</a> - Get string value of a variable</span></li>
<li class="member"> <span class="function"><a href="function.settype.html" class="function" rel="rdfs-seeAlso">settype()</a> - Set the type of a variable</span></li>
<li class="member"><a href="language.types.type-juggling.html" class="link">Type juggling</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.empty.html">empty</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.get-defined-vars.html">get_defined_vars</a></div>
<div class="up"><a href="ref.var.html">Variable handling Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
