mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 07:42:10 +01:00
125 lines
2.8 KiB
XML
125 lines
2.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="simplexmlelement.key" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>SimpleXMLElement::key</refname>
|
|
<refpurpose>Return current key</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="SimpleXMLElement">
|
|
<modifier>public</modifier> <type>string</type><methodname>SimpleXMLElement::key</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
|
|
<warning>
|
|
<simpara>
|
|
Prior to PHP 8.0, <methodname>SimpleXMLElement::key</methodname> was only
|
|
declared on the subclass <classname>SimpleXMLIterator</classname>.
|
|
</simpara>
|
|
</warning>
|
|
|
|
<para>
|
|
This method gets the XML tag name of the current element.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the XML tag name of the element referenced by the current <classname>SimpleXMLElement</classname> object.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Throws an <classname>Error</classname> on failure.
|
|
</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>
|
|
An <classname>Error</classname> is now thrown if
|
|
<methodname>SimpleXMLElement::key</methodname> is called on an
|
|
invalid iterator. Previously, &false; was returned.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Get the current XML tag key</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(); // rewind to the first element
|
|
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
|
|
-->
|