Files
2023-06-24 09:21:36 -04:00

124 lines
2.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: dcb657b7e9e4f7622ce3394ae1fa3c14538721e1 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="simplexmlelement.key" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::key</refname>
<refpurpose>Retourne la clé courante</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SimpleXMLElement">
<modifier>public</modifier> <type>string</type><methodname>SimpleXMLElement::key</methodname>
<void/>
</methodsynopsis>
<warning>
<simpara>
Antérieur à PHP 8.0, <methodname>SimpleXMLElement::key</methodname> n'était déclarée
que sur la sous-classe <classname>SimpleXMLIterator</classname>.
</simpara>
</warning>
<para>
Cette méthode lit le nom de la balise XML courante.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne le nom de la balise XML dans l'objet courant de
l'itéraeur <classname>SimpleXMLElement</classname>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Lance une <classname>Error</classname> en cas d'échec.
</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>
Une <classname>Error</classname> est maintenant lancée si
<methodname>SimpleXMLElement::key</methodname> est appelé sur un
itérateur invalide. Auparavant, &false; était retourné.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Le nom de la balise XML courante</title>
<programlisting role="php">
<![CDATA[
<?php
$xmlElement = new SimpleXMLElement('<books><book>PHP basics</book><book>XML basics</book></books>');
echo var_dump($xmlElement->key());
$xmlElement->rewind(); // retour au premier élément
echo var_dump($xmlElement->key());
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(false)
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
-->