mirror of
https://github.com/php/doc-zh.git
synced 2026-03-24 07:02:15 +01:00
129 lines
3.2 KiB
XML
Executable File
129 lines
3.2 KiB
XML
Executable File
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- $Revision$ -->
|
||
<!-- EN-Revision: 0a192fcd9cc43c0007de795063b4494974058992 Maintainer: daijie Status: ready -->
|
||
<!-- CREDITS: Luffy,mowangjuanzi -->
|
||
<refentry xml:id="function.key" xmlns="http://docbook.org/ns/docbook">
|
||
<refnamediv>
|
||
<refname>key</refname>
|
||
<refpurpose>从关联数组中取得键名</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> 返回数组中当前单元的键名。
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>array</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
该数组。
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
<function>key</function> 函数返回数组中内部指针指向的当前单元的键名。
|
||
但它不会移动指针。如果内部指针超过了元素列表尾部，或者数组是空的，<function>key</function> 会返回 &null;。
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="changelog">
|
||
&reftitle.changelog;
|
||
<informaltable>
|
||
<tgroup cols="2">
|
||
<thead>
|
||
<row>
|
||
<entry>&Version;</entry>
|
||
<entry>&Description;</entry>
|
||
</row>
|
||
</thead>
|
||
<tbody>
|
||
&standard.changelog.calling-on-objects;
|
||
</tbody>
|
||
</tgroup>
|
||
</informaltable>
|
||
</refsect1>
|
||
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<para>
|
||
<example>
|
||
<title><function>key</function> 例子</title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$array = array(
|
||
'fruit1' => 'apple',
|
||
'fruit2' => 'orange',
|
||
'fruit3' => 'grape',
|
||
'fruit4' => 'apple',
|
||
'fruit5' => 'apple');
|
||
|
||
// 此循环将会输出数组中所有值等于 “apple” 的键（key）
|
||
while ($fruit_name = current($array)) {
|
||
if ($fruit_name == 'apple') {
|
||
echo key($array), "\n";
|
||
}
|
||
next($array);
|
||
}
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs;
|
||
<screen>
|
||
<![CDATA[
|
||
fruit1
|
||
fruit4
|
||
fruit5
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="seealso">
|
||
&reftitle.seealso;
|
||
<para>
|
||
<simplelist>
|
||
<member><function>current</function></member>
|
||
<member><function>next</function></member>
|
||
<member><function>array_key_first</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
|
||
-->
|