Files
archived-doc-pt-br/reference/array/functions/array-keys.xml
2023-08-07 10:42:05 -03:00

149 lines
3.9 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 5414f72979796d241b9c0b5dc1a9943e707699f2 Maintainer: lhsazevedo Status: ready --><!-- CREDITS: lucasr,marcosvpj,lhsazevedo,ABDALAZARD -->
<refentry xml:id="function.array-keys" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_keys</refname>
<refpurpose>Retorna todas as chaves ou uma parte das chaves de um array</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="procedural">
<type>array</type><methodname>array_keys</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
</methodsynopsis>
<methodsynopsis role="procedural">
<type>array</type><methodname>array_keys</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
<methodparam><type>mixed</type><parameter>filter_value</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>strict</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
<function>array_keys</function> retorna as chaves, numéricas e
string, do array <parameter>array</parameter>.
</para>
<para>
Se um parâmetro <parameter>filter_value</parameter> for especificado,
então apenas as chaves para esse valor serão retornadas. Do contrário, todas
as chaves de <parameter>array</parameter> serão retornadas.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
Um array contendo chaves a serem retornadas.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filter_value</parameter></term>
<listitem>
<para>
Se especificado, somente chaves contendo este valor são retornadas.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>strict</parameter></term>
<listitem>
<para>
Determina se a comparação é rígida (===) deve ser utilizada durante a busca.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna um array de todas as chaves em <parameter>array</parameter>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemplo de <function>array_keys</function></title>
<programlisting role="php">
<![CDATA[
<?php
$array = array(0 => 100, "cor" => "vermelho");
print_r(array_keys($array));
$array = array("azul", "vermelho", "verde", "azul", "azul");
print_r(array_keys($array, "azul"));
$array = array("cor" => array("azul", "vermelho", "verde"),
"tamanho" => array("pequeno", "medio", "grande"));
print_r(array_keys($array));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[0] => 0
[1] => cor
)
Array
(
[0] => 0
[1] => 3
[2] => 4
)
Array
(
[0] => cor
[1] => tamanho
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>array_values</function></member>
<member><function>array_combine</function></member>
<member><function>array_key_exists</function></member>
<member><function>array_search</function></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
-->