mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 03:18:55 +00:00
03083e6a66
--- Provided by Mark T (mxtracks@gmail.com) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332352 c90b9560-bf6c-de11-be94-00142212c4b1
112 lines
2.9 KiB
XML
112 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.floatval" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>floatval</refname>
|
|
<refpurpose>Get float value of a variable</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>float</type><methodname>floatval</methodname>
|
|
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets the <type>float</type> value of <parameter>var</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>var</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
May be any scalar type. <function>floatval</function> should not be used
|
|
on objects, as doing so will emit an <constant>E_NOTICE</constant> level
|
|
error and return 1.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The float value of the given variable. Empty arrays return 0, non-empty
|
|
arrays return 1.
|
|
</para>
|
|
<para>
|
|
Strings will most likely return 0 although this depends on the
|
|
leftmost characters of the string. The common rules of
|
|
<link linkend="language.types.float.casting">float casting</link>
|
|
apply.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>floatval</function> Example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$var = '122.34343The';
|
|
$float_value_of_var = floatval($var);
|
|
echo $float_value_of_var; // 122.34343
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>floatval</function> non-numeric leftmost characters Example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$var = 'The122.34343';
|
|
$float_value_of_var = floatval($var);
|
|
echo $float_value_of_var; // 0
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>boolval</function></member>
|
|
<member><function>intval</function></member>
|
|
<member><function>strval</function></member>
|
|
<member><function>settype</function></member>
|
|
<member><link linkend="language.types.type-juggling">Type juggling</link></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|