Files
doc-fr/reference/array/functions/key.xml
George Peter Banyard 8d4b599b13 Sync Array section with EN
2021-05-19 13:08:14 +01:00

117 lines
3.0 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8cdc6621f9826d04abc3e50438c010804d7e8683 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: DavidA. -->
<refentry xml:id="function.key" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>key</refname>
<refpurpose>Retourne une clé d'un tableau associatif</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>string</type><type>null</type></type><methodname>key</methodname>
<methodparam><type class="union"><type>array</type><type>object</type></type><parameter>array</parameter></methodparam>
</methodsynopsis>
<para>
<function>key</function> retourne la clé courante dans le
tableau <parameter>array</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
Le tableau.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
La fonction <function>key</function> retourne simplement la clé
de l'élément du tableau qui est actuellement pointée par le pointeur
interne. Cette fonction ne modifie en aucun cas la position de ce pointeur.
Si le pointeur interne pointe un élément se situant après la fin de la liste
des éléments, ou bien si le tableau est vide, la fonction
<function>key</function> retournera &null;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>key</function></title>
<programlisting role="php">
<![CDATA[
<?php
$array = array(
'fruit1' => 'apple',
'fruit2' => 'orange',
'fruit3' => 'grape',
'fruit4' => 'apple',
'fruit5' => 'apple');
// Cette boucle affiche toutes les clés
// dont la valeur vaut "apple"
while ($fruit_name = current($array)) {
if ($fruit_name == 'apple') {
echo key($array), "\n";
}
next($array);
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
fruit1<br />
fruit4<br />
fruit5<br />
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>current</function></member>
<member><function>next</function></member>
<member><link linkend="control-structures.foreach">foreach</link></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
-->