archived-doc-pt-br/reference/array/functions/array-diff-key.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: af4410a7e15898c3dbe83d6ea38246745ed9c6fb Maintainer: amandavale Status: ready-->
<refentry xml:id="function.array-diff-key" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_diff_key</refname>
  <refpurpose>Registra a diferença entre arrays usando chaves para comparação</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_diff_key</methodname>
   <methodparam><type>array</type><parameter>array1</parameter></methodparam>
   <methodparam><type>array</type><parameter>array2</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>...</parameter></methodparam>
  </methodsynopsis>
  <para>
   Compara as chaves do <parameter>array1</parameter> com as chaves
   do <parameter>array2</parameter> e retorna a diferença.
   Esta função é como <function>array_diff</function>, exceto que a
   comparação é feita com as chaves, ao invés dos valores.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>

    <varlistentry>
     <term><parameter>array1</parameter></term>
     <listitem>
      <para>
       O array a comparar
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>array2</parameter></term>
     <listitem>
      <para>
       Um array a ser comparado
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>...</parameter></term>
     <listitem>
      <para>
       Mais arrays a serem comparados
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retorna um <type>array</type> contendo todas as entradas de
   <parameter>array1</parameter> que não estão presentes em qualquer dos
   outros arrays.
  </para>
 </refsect1>

<!--
 <refsect1 role="errors">
  &reftitle.errors;
  &errors.no.unusual.errors;
 </refsect1>
-->

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemplo de <function>array_diff_key</function></title>
    <para>
     As duas chaves dos pares <literal>chave =&gt; valor</literal> são
     consideradas iguais somente se <literal>(string) $key1 === (string) $key2 </literal>. 
     Em outras palavras, uma checagem de tipo estrita é feita para que
     representações de string sejam as mesmas.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$array1 = array('azul'  => 1, 'vermelho'  => 2, 'verde'  => 3, 'roxo' => 4);
$array2 = array('verde' => 5, 'azul' => 6, 'amarelo' => 7, 'rosa'   => 8);

var_dump(array_diff_key($array1, $array2));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(2) {
  ["vermelho"]=>
  int(2)
  ["roxo"]=>
  int(4)
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Essa função checa somente uma dimensão de um array n-dimensional. É claro
    que você pode checar dimensões mais profundas usando
    <literal>array_diff_key($array1[0], $array2[0]);</literal>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>array_diff</function></member>
    <member><function>array_udiff</function></member>
    <member><function>array_diff_assoc</function></member>
    <member><function>array_diff_uassoc</function></member>
    <member><function>array_udiff_assoc</function></member>
    <member><function>array_udiff_uassoc</function></member>
    <member><function>array_diff_ukey</function></member>
    <member><function>array_intersect</function></member>
    <member><function>array_intersect_assoc</function></member>
    <member><function>array_intersect_uassoc</function></member>
    <member><function>array_intersect_key</function></member>
    <member><function>array_intersect_ukey</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
-->