array-diff-uassoc.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.array-diff-uassoc" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_diff_uassoc</refname>
  <refpurpose>Computes the difference of arrays with additional index check which is performed by a user supplied callback function</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_diff_uassoc</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>
   Compares <parameter>array</parameter> against <parameter>arrays</parameter> and
   returns the difference. Unlike <function>array_diff</function> the array
   keys are used in the comparison.
  </para>
  <para>
   Unlike <function>array_diff_assoc</function> a user supplied callback
   function is used for the indices comparison, not internal function.
  </para>
 </refsect1>

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

    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       The array to compare from
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>arrays</parameter></term>
     <listitem>
      <para>
       Arrays to compare 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 an <type>array</type> containing all the entries from
   <parameter>array</parameter> that are not present in any of the other arrays.
  </para>
 </refsect1>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>array_diff_uassoc</function> example</title>
    <para>
     In this example the <literal>"a" =&gt; "green"</literal>
     pair is present in both arrays and thus it is not in the output from the
     function. Unlike this, the pair <literal>0 =&gt; "red"</literal>
     is in the output because the key of <literal>"red"</literal> is
     automatically assigned to <literal>0</literal> in the first array,
     whereas it is assigned to <literal>1</literal> in the second array as the
     key <literal>0</literal> is already taken by <literal>yellow</literal>.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
function key_compare_func($a, $b)
{
    return $a <=> $b;
}

$array1 = array("a" => "green", "b" => "brown", "c" => "blue", "red");
$array2 = array("a" => "green", "yellow", "red");
$result = array_diff_uassoc($array1, $array2, "key_compare_func");
print_r($result);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [b] => brown
    [c] => blue
    [0] => red
)
]]>
    </screen>
    <simpara>
     The equality of 2 indices is checked by the user supplied callback function.
    </simpara>
   </example>
  </para>
 </refsect1> 

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    This function only checks one dimension of an n-dimensional
    array. It is possible to check deeper dimensions by using, for example,
    <literal>array_diff_uassoc($array1[0], $array2[0], "key_compare_func");</literal>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>array_diff</function></member>
    <member><function>array_diff_assoc</function></member>
    <member><function>array_udiff</function></member>
    <member><function>array_udiff_assoc</function></member>
    <member><function>array_udiff_uassoc</function></member>
    <member><function>array_intersect</function></member>
    <member><function>array_intersect_assoc</function></member>
    <member><function>array_uintersect</function></member>
    <member><function>array_uintersect_assoc</function></member>
    <member><function>array_uintersect_uassoc</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
-->