current.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0a192fcd9cc43c0007de795063b4494974058992 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.current" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>current</refname>
  <refpurpose>配列内の現在の要素を返す</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>current</methodname>
   <methodparam><type class="union"><type>array</type><type>object</type></type><parameter>array</parameter></methodparam>
  </methodsynopsis>
  <para>
   各配列は、"カレント"の要素へのポインタを有しています。
   このポインタは、配列に挿入された最初の要素を指すように初期化されます。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       配列。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>current</function> 関数は、
   単に内部ポインタが現在指している配列要素の値を返します。
   この関数は、ポインタを全く移動しません。
   内部ポインタが最終要素の次を指していたり
   配列が空だったりした場合、
   <function>current</function> は &false; を返します。
  </para>
  &return.falseproblem;
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &standard.changelog.calling-on-objects;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>current</function> と類似関数の使用例</title>
    <programlisting role="php">
<![CDATA[
<?php
$transport = array('foot', 'bike', 'car', 'plane');
$mode = current($transport); // $mode = 'foot';
$mode = next($transport);    // $mode = 'bike';
$mode = current($transport); // $mode = 'bike';
$mode = prev($transport);    // $mode = 'foot';
$mode = end($transport);     // $mode = 'plane';
$mode = current($transport); // $mode = 'plane';

$arr = array();
var_dump(current($arr)); // bool(false)

$arr = array(array());
var_dump(current($arr)); // array(0) { }
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <simpara>
    配列の最終要素の次を指していた場合や、
    空の配列に対して、<function>current</function> 
    を呼び出した時の結果は、
    <type>bool</type> &false; 要素を指していた場合と区別できません。
    &false; 要素を含む配列を順に処理するには、制御構文 &foreach;
    を参照ください。
   </simpara>
   <simpara>
    それでも <function>current</function> を使い、
    値が本当に配列の要素であることを適切にチェックするには、
    <function>current</function> が指す要素の
    <function>key</function> の値が、
    厳密に &null; ではないことをチェックすべきです。
   </simpara>
  </note>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>end</function></member>
    <member><function>key</function></member>
    <member><function>each</function></member>
    <member><function>prev</function></member>
    <member><function>reset</function></member>
    <member><function>next</function></member>
    <member>&foreach;</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
-->