Files
André L F S Bacci b6d67fdd54 "Remove @ from revtag."
2022-11-15 14:02:25 -03:00

142 lines
3.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 8a7836bf884a89125227e59be5ece70dca724567 Maintainer: lhsazevedo Status: ready --><!-- CREDITS: felipe,lucasr,fabioluciano,lhsazevedo -->
<refentry xml:id="function.array-flip" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_flip</refname>
<refpurpose>Permuta todas as chaves e seus valores associados em um array</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>array_flip</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
</methodsynopsis>
<para>
<function>array_flip</function> retorna um <type>array</type> com suas relações trocadas,
ou seja, as chaves de <parameter>array</parameter> passam a ser os valores e os valores
de <parameter>array</parameter> passam a ser as chaves.
</para>
<para>
Note que os valores de <parameter>array</parameter> devem ser chaves
válidas, ou seja, eles precisam ser <type>int</type>
ou <type>string</type>. Um aviso será mostrado se um valor é de um tipo inválido para chaves,
e o par chave/valor em questão
<emphasis>não será invertido</emphasis>.
</para>
<para>
Se um valor tem várias ocorrências, a última chave será usada
como valor, e todos os outros serão perdidos.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
Um array de pares chave/valor para inverter.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna o array trocado.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemplo da função <function>array_flip</function></title>
<programlisting role="php">
<![CDATA[
<?php
$input = array("oranges", "apples", "pears");
$flipped = array_flip($input);
print_r($flipped);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[oranges] => 0
[apples] => 1
[pears] => 2
)
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Exemplo da função <function>array_flip</function>: colisão</title>
<programlisting role="php">
<![CDATA[
<?php
$trans = array("a" => 1, "b" => 1, "c" => 2);
$trans = array_flip($trans);
print_r($trans);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[1] => b
[2] => c
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>array_values</function></member>
<member><function>array_keys</function></member>
<member><function>array_reverse</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
-->