1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-29 10:32:17 +02:00
Files
archived-doc-ja/reference/spl/multipleiterator/key.xml
TAKAGI Masahiro 963a60dad7 Sync with en
git-svn-id: https://svn.php.net/repository/phpdoc/ja/trunk@328299 c90b9560-bf6c-de11-be94-00142212c4b1
2012-11-10 15:52:47 +00:00

82 lines
2.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e3b9788fa77cd885d77ed22a0f69073b2cab62d4 Maintainer: takagi Status: ready -->
<refentry xml:id="multipleiterator.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MultipleIterator::key</refname>
<refpurpose>登録されているイテレータインスタンスを取得する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>MultipleIterator::key</methodname>
<void />
</methodsynopsis>
<para>
登録されているイテレータインスタンスの key() の結果を取得します。
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
登録されているイテレータインスタンスを取得しますの配列を返します。
サブイテレータがアタッチされていない場合は &false; を返します。
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
モード <constant>MIT_NEED_ALL</constant> が設定されているときは、
アタッチされているイテレータの中にひとつでも無効なものがあれば
<classname>LogicException</classname> が発生します。
</para>
<para>
このメソッドを <xref linkend="control-structures.foreach"/> から呼ぶと、
警告 "Illegal type returned" が発生します。
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>MultipleIterator::current</methodname></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
-->