1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 07:02:08 +01:00
Files
2025-09-02 19:24:13 +09:00

130 lines
3.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d6f54016d62904cfd8200604aadd5e3f0d9bad97 Maintainer: mumumu Status: ready -->
<refentry xml:id="simplexmlelement.key" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::key</refname>
<refpurpose>現在のキーを返す</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SimpleXMLElement">
<modifier>public</modifier> <type>string</type><methodname>SimpleXMLElement::key</methodname>
<void/>
</methodsynopsis>
<warning>
<simpara>
PHP 8.0 より前のバージョンでは、
<methodname>SimpleXMLElement::key</methodname>
はサブクラスの <classname>SimpleXMLIterator</classname>
でのみ宣言されていました。
</simpara>
</warning>
<para>
このメソッドは、現在の要素の XML タグ名を取得します。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
現在の <classname>SimpleXMLElement</classname>
オブジェクトが参照する要素の XML タグ名を返します。
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
失敗した場合に<classname>Error</classname> をスローします。
</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>SimpleXMLElement::key</methodname>
を不正なイテレータを渡してコールすると、
<classname>Error</classname> をスローするようになりました。
これより前のバージョンでは、&false; を返していました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>現在の XML タグキーの取得</title>
<programlisting role="php">
<![CDATA[
<?php
$xmlElement = new SimpleXMLElement('<books><book>PHP basics</book><book>XML basics</book></books>');
try {
echo var_dump($xmlElement->key());
} catch (Error $e) {
echo $e->getMessage(), "\n";
}
$xmlElement->rewind(); // 最初の要素に巻き戻します
echo var_dump($xmlElement->key());
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Iterator not initialized or already consumed
string(4) "book"
]]>
</screen>
</example>
</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
-->