array-intersect-key.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c84024092aee02b51dd18b909af0f2ccbdd24f98 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.array-intersect-key">
 <refnamediv>
  <refname>array_intersect_key</refname>
  <refpurpose>Calcula la intersección de dos arrays utilizando las claves para la comparación</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_intersect_key</methodname>
   <methodparam><type>array</type><parameter>array</parameter></methodparam>
   <methodparam rep="repeat"><type>array</type><parameter>arrays</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>array_intersect_key</function> devuelve un array que contiene
   todas las entradas del array <parameter>array</parameter>
   que contienen claves presentes en todos los arrays pasados como argumentos.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       El array que contiene las claves maestras a verificar.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>arrays</parameter></term>
     <listitem>
      <para>
       Arrays a comparar.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un array asociativo que contiene todas las entradas del
   array <parameter>array</parameter> cuyas claves están presentes
   en todos los argumentos.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      &array.changelog.require-only-one;
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo con <function>array_intersect_key</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$array1 = array('azul'  => 1, 'rojo'  => 2, 'verde'  => 3, 'violeta' => 4);
$array2 = array('verde' => 5, 'azul' => 6, 'amarillo' => 7, 'cian'   => 8);

var_dump(array_intersect_key($array1, $array2));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(2) {
  ["azul"]=>
  int(1)
  ["verde"]=>
  int(3)
}
]]>
    </screen>
   </example>
  </para>
  <para>
   En este ejemplo, se puede ver que solo las claves <literal>'azul'</literal>
   y <literal>'verde'</literal> están presentes en ambos arrays y por lo tanto,
   son devueltas. Note también que los valores para las claves
   <literal>'azul'</literal> y <literal>'verde'</literal> difieren
   entre los dos arrays. No obstante, aún corresponden porque
   solo las claves son verificadas.
   Los valores devueltos son los del array <parameter>array1</parameter>.
  </para>
  <para>
   Las dos claves desde los pares <literal>clave =&gt; valor</literal>
   son consideradas iguales solo si
   <literal>(string) $clave1 === (string) $clave2 </literal>. En otras palabras,
   se realiza un análisis estricto del tipo, por lo que la representación en forma de
   string debe ser exactamente la misma.
  </para>
 </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_key</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_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
-->