<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.array-intersect-ukey">

<refnamediv>

<refname>array_intersect_ukey</refname>

<refpurpose>Computes the intersection of arrays using a callback function on the keys for comparison</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>array</type><methodname>array_intersect_ukey</methodname>

<methodparam><type>array</type><parameter>array</parameter></methodparam>

<methodparam rep="repeat"><type>array</type><parameter>arrays</parameter></methodparam>

<methodparam><type>callable</type><parameter>key_compare_func</parameter></methodparam>

</methodsynopsis>

<para>

<function>array_intersect_ukey</function> returns an array

containing all the values of <parameter>array</parameter>

which have matching keys that are present in all the arguments.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>array</parameter></term>

<listitem>

<para>

Initial array for comparison of the arrays.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>arrays</parameter></term>

<listitem>

<para>

Arrays to compare keys against.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>key_compare_func</parameter></term>

<listitem>

&sort.callback.description;

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Returns the values of <parameter>array</parameter> whose keys exist

in all the arguments.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>array_intersect_ukey</function> example</title>

<programlisting role="php">

<![CDATA[

<?php

function key_compare_func($key1, $key2)

{

if ($key1 == $key2)

return 0;

else if ($key1 > $key2)

return 1;

else

return -1;

}

$array1 = array('blue' => 1, 'red' => 2, 'green' => 3, 'purple' => 4);

$array2 = array('green' => 5, 'blue' => 6, 'yellow' => 7, 'cyan' => 8);

var_dump(array_intersect_ukey($array1, $array2, 'key_compare_func'));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

array(2) {

["blue"]=>

int(1)

["green"]=>

int(3)

}

]]>

</screen>

</example>

</para>

<para>

In our example you see that only the keys <literal>'blue'</literal>

and <literal>'green'</literal> are present in both arrays and thus

returned. Also notice that the values for the keys

<literal>'blue'</literal> and <literal>'green'</literal> differ between

the two arrays. A match still occurs because only the keys are checked.

The values returned are those of <parameter>array</parameter>.

</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_key</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

-->