floatval.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./ja/functions/var.xml, last change in rev 1.1 -->
<!-- EN-Revision: fca3920773bcf7ea2aa2f7306103f6d3d0e6b901 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,mumumu -->
<refentry xml:id="function.floatval" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>floatval</refname>
  <refpurpose>変数の float 値を取得する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>float</type><methodname>floatval</methodname>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   <parameter>value</parameter> の <type>float</type> 値を返します。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       あらゆるスカラ型を指定できます。オブジェクトに
       <function>floatval</function> を使用することはできません。
       その場合は <constant>E_WARNING</constant> レベルのエラーを発して 1 を返します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   指定した変数の float 値を返します。
   空の配列の場合は 0、空でない配列の場合は 1 を返します。
  </para>
  <para>
   文字列の場合、ほとんどは 0 を返しますが、先頭の文字が何であるかによってこれは変わります。
   <link linkend="language.types.float.casting">float 型へのキャスト</link>
   と同じルールに従います。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       オブジェクトを指定して変換しようとした場合のエラーレベルが、
       <constant>E_NOTICE</constant> から <constant>E_WARNING</constant>
       に変更されました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>floatval</function> の例</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> で、先頭が非数値である場合の例</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">型の相互変換</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
-->