archived-doc-ja/reference/array/functions/count.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c746fb679febdb6a175c33a794d1dd0b6443c3f3 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xml:id="function.count" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>count</refname>
  <refpurpose>変数に含まれるすべての要素、
  あるいはオブジェクトに含まれる何かの数を数える</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>count</methodname>
   <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>COUNT_NORMAL</initializer></methodparam>
  </methodsynopsis>
  <para>
   変数に含まれるすべての要素、
   あるいはオブジェクトに含まれる何かの数を数えます。
  </para>
  <para>
   オブジェクトに対して、もし <link linkend="ref.spl">SPL</link>
   がインストールされている場合、インターフェイス
   <classname>Countable</classname> を実装することで <function>count</function>
   にフックすることができます。このインターフェイスには 1 つのメソッド
   <methodname>Countable::count</methodname> があり、<function>count</function>
   関数に対する値を返します。
  </para>
  <para>
   配列の実装やPHPでの使用法に関する詳細な説明については、マニュアルの
   <link linkend="language.types.array">配列</link>のセクションを参照ください。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>var</parameter></term>
     <listitem>
      <para>
       配列あるいはオブジェクト。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       オプションの<parameter>mode</parameter> 引数が <constant>COUNT_RECURSIVE</constant>
       (または 1) にセットされた場合、<function>count</function>
       は再帰的に配列をカウントします。
       これは多次元配列の全ての要素をカウントするといった場合に特に有効です。
      </para>
      <caution>
       <para>
        <function>count</function> は、再帰を検出して無限ループを回避するようになっています。
        しかしその場合 (配列の中に自分自身が複数回登場する場合) は毎回 <constant>E_WARNING</constant>
        を発行し、期待する結果より大きい数を返します。
       </para>
      </caution>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>var</parameter>に含まれる要素の数を返します。
   もし <parameter>var</parameter> が配列もしくは
   <classname>Countable</classname> インターフェイスを実装したオブジェクトではない場合、
   <literal>1</literal> が返されます。
   ひとつ例外があり、<parameter>var</parameter> が &null; の場合、
   <literal>0</literal> が返されます。
  </para>
  <caution>
   <para>
    <function>count</function> は、セットされていない変数に関して 0
    を返しますが、変数が空の配列として初期化されている場合にも 0 を返します。
    ある変数がセットされているかどうかを調べるには、
    <function>isset</function> を使用してください。
   </para>
  </caution>
 </refsect1>
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>4.2.0</entry>
       <entry>
        オプションのパラメータ <parameter>mode</parameter> が追加されました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>count</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$a[0] = 1;
$a[1] = 3;
$a[2] = 5;
$result = count($a);
// $result == 3

$b[0]  = 7;
$b[5]  = 9;
$b[10] = 11;
$result = count($b);
// $result == 3

$result = count(null);
// $result == 0

$result = count(false);
// $result == 1
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>再帰的な <function>count</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$food = array('fruits' => array('orange', 'banana', 'apple'),
              'veggie' => array('carrot', 'collard', 'pea'));

// 再帰的なカウント
echo count($food, COUNT_RECURSIVE); // output 8

// 通常のカウント
echo count($food); // output 2

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>is_array</function></member>
    <member><function>isset</function></member>
    <member><function>strlen</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
-->