php-doc-en/reference/array/functions/array-keys.xml
Heilig (Cece) Szabolcs 23396d4d4e applying PEAR coding standards on examples
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@138081 c90b9560-bf6c-de11-be94-00142212c4b1
2003-08-17 12:21:03 +00:00

96 lines
2.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<refentry id="function.array-keys">
<refnamediv>
<refname>array_keys</refname>
<refpurpose>Return all the keys of an array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>array_keys</methodname>
<methodparam><type>array</type><parameter>input</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>
search_value
</parameter></methodparam>
</methodsynopsis>
<para>
<function>array_keys</function> returns the keys, numeric and
string, from the <parameter>input</parameter> array.
</para>
<para>
If the optional <parameter>search_value</parameter> is specified,
then only the keys for that value are returned. Otherwise, all
the keys from the <parameter>input</parameter> are returned.
</para>
<para>
<example>
<title><function>array_keys</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$array = array(0 => 100, "color" => "red");
print_r(array_keys($array));
$array = array("blue", "red", "green", "blue", "blue");
print_r(array_keys($array, "blue"));
$array = array("color" => array("blue", "red", "green"),
"size" => array("small", "medium", "large"));
print_r(array_keys($array));
?>
]]>
</programlisting>
<para>
The printout of the program above will be:
</para>
<screen>
<![CDATA[
Array
(
[0] => 0
[1] => color
)
Array
(
[0] => 0
[1] => 3
[2] => 4
)
Array
(
[0] => color
[1] => size
)
]]>
</screen>
</example>
</para>
<para>
See also <function>array_values</function> and
<function>array_key_exists</function>.
</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:"../../../../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
-->