mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
8cdc6621f9
- array functions - datetime functions - mbstring functions - strings functions - var functions - xml functions - json functions
113 lines
2.8 KiB
XML
113 lines
2.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
|
|
<refentry xml:id="function.key" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>key</refname>
|
|
<refpurpose>Fetch a key from an array</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> returns the index element of the current array
|
|
position.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>array</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The array.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The <function>key</function> function simply returns the
|
|
key of the array element that's currently being pointed to by the
|
|
internal pointer. It does not move the pointer in any way. If the
|
|
internal pointer points beyond the end of the elements list or the array is
|
|
empty, <function>key</function> returns &null;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>key</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$array = array(
|
|
'fruit1' => 'apple',
|
|
'fruit2' => 'orange',
|
|
'fruit3' => 'grape',
|
|
'fruit4' => 'apple',
|
|
'fruit5' => 'apple');
|
|
|
|
// this cycle echoes all associative array
|
|
// key where value equals "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
|
|
-->
|