mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 15:12:22 +01:00
106 lines
3.0 KiB
XML
106 lines
3.0 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 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 role="MultipleIterator">
|
|
<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>
|
|
登録されているイテレータインスタンスの配列を返します。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
イテレータが無効な場合には、<classname>RuntimeException</classname>
|
|
をスローします (PHP 8.1.0 以降)。
|
|
また、モード <constant>MIT_NEED_ALL</constant> が設定されているときに、
|
|
アタッチされているイテレータの中にひとつでも無効なものがあった場合にも
|
|
<classname>RuntimeException</classname> が発生します。
|
|
</para>
|
|
<para>
|
|
このメソッドを <xref linkend="control-structures.foreach"/> から呼ぶと、
|
|
警告 "Illegal type returned" が発生します。
|
|
</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.1.0</entry>
|
|
<entry>
|
|
<methodname>MultipleIterator::key</methodname>
|
|
が無効なイテレータを使って呼び出された場合に、
|
|
<classname>RuntimeException</classname> をスローするようになりました。
|
|
これより前のバージョンでは、&false; を返していました。
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</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
|
|
-->
|