is-scalar.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f3534a2ab0af4ed69c9a474e26210ef661324d39 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.is-scalar" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>is_scalar</refname>
  <refpurpose>
   変数がスカラかどうかを調べる
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>is_scalar</methodname>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   指定した変数がスカラかどうかを調べます。
  </para>
  <para>
   スカラ変数には <type>int</type>、<type>float</type>、<type>string</type>
   あるいは <type>bool</type> が含まれます。
   <type>array</type>、<type>object</type>、
   <type>resource</type>、<type>null</type>
   はスカラではありません。
  </para>
  <note>
   <para>
    リソース型は現在整数に基づく抽象型であるため、
    <function>is_scalar</function> は <type>resource</type> 型の値を
    スカラ値と判定しません。この実装の詳細は変更される可能性があるため、
    前堤にするべきではありません。
   </para>
  </note>
  <note>
   <para>
    <function>is_scalar</function> は、NULL をスカラとは見なしません。
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       評価する変数。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>value</parameter> がスカラの場合に &true;、
   それ以外の場合に &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>is_scalar</function> の例</title>
    <programlisting role="php">
<!-- TODO: better example, this one can be quite misleading for unexperienced
           programmers.  -->
<![CDATA[
<?php
function show_var($var) 
{
    if (is_scalar($var)) {
        echo $var;
    } else {
        var_dump($var);
    }
}
$pi = 3.1416;
$proteins = array("hemoglobin", "cytochrome c oxidase", "ferredoxin");

show_var($pi);
show_var($proteins)

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
3.1416
array(3) {
  [0]=>
  string(10) "hemoglobin"
  [1]=>
  string(20) "cytochrome c oxidase"
  [2]=>
  string(10) "ferredoxin"
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>is_float</function></member>
    <member><function>is_int</function></member>
    <member><function>is_numeric</function></member>
    <member><function>is_real</function></member>
    <member><function>is_string</function></member>
    <member><function>is_bool</function></member>
    <member><function>is_object</function></member>
    <member><function>is_array</function></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
-->