array-diff-key.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a9b5252986b66600d55a52252f09dabfec218e6d Maintainer: seros Status: ready -->
<!-- Reviewed: no Maintainer: seros -->
<refentry xml:id="function.array-diff-key" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_diff_key</refname>
  <refpurpose>Calcula la diferencia entre arrays empleando las claves para la comparación</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 las claves de <parameter>array1</parameter> con las claves
   de <parameter>array2</parameter> y devuelve la diferencia.
   Esta función es como <function>array_diff</function> excepto que
   la comparación se hace con las claves en lugar de con los valores.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    
    <varlistentry>
     <term><parameter>array1</parameter></term>
     <listitem>
      <para>
       El array a comparar
      </para>
     </listitem>
    </varlistentry>
    
    <varlistentry>
     <term><parameter>array2</parameter></term>
     <listitem>
      <para>
       Un array con el que comparar
      </para>
     </listitem>
    </varlistentry>
    
    <varlistentry>
     <term><parameter>...</parameter></term>
     <listitem>
      <para>
       Más arrays con los que comparar
      </para>
     </listitem>
    </varlistentry>
    
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un <type>array</type> que contiene todas las entradas de
   <parameter>array1</parameter> cuyas claves están ausente en
   ninguno de los otros arrays.
  </para>
 </refsect1>
 
 <!--
 <refsect1 role="errors">
  &reftitle.errors;
  &errors.no.unusual.errors;
 </refsect1>
-->
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>array_diff_key</function></title>
    <para>
     Las dos claves de los de pares <literal>clave =&gt; valor</literal> son
     consideradas iguales solo si
     <literal>(string) $clave1 === (string) $clave2 </literal>. En otras palabras,
     se ejecuta una comprobación de tipos estricta de tal forma que las representaciones
     de tipo string deben ser las mismas.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$array1 = array('blue' => 1, 'red' => 2, 'green' => 3, 'purple' => 4);
$array2 = array('green' => 5, 'yellow' => 7, 'cyan' => 8);

var_dump(array_diff_key($array1, $array2));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(3) {
  ["blue"]=>
  int(1)
  ["red"]=>
  int(2)
  ["purple"]=>
  int(4)
}
]]>
    </screen>
    <programlisting role="php">
<![CDATA[
<?php
$array1 = array('blue' => 1, 'red'  => 2, 'green' => 3, 'purple' => 4);
$array2 = array('green' => 5, 'yellow' => 7, 'cyan' => 8);
$array3 = array('blue' => 6, 'yellow' => 7, 'mauve' => 8);

var_dump(array_diff_key($array1, $array2, $array3));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(2) {
  ["red"]=>
  int(2)
  ["purple"]=>
  int(4)
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Esta función solamente comprueba una dimensión de un array
    n-dimensional. Se pueden comprobar dimensiones más profundas mediante
    <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
-->