array-diff-uassoc.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6b64170daac5587bee4bb63c0020cb2fbf7f1253 Maintainer: takagi Status: ready -->
<refentry xml:id="function.array-diff-uassoc" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_diff_uassoc</refname>
  <refpurpose>
   ユーザーが指定したコールバック関数を利用し、
   追加された添字の確認を含めて配列の差を計算する
  </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>
   <parameter>array</parameter> のキーを
   <parameter>arrays</parameter> のキーと比較し、その差を返します。
   この関数は <function>array_diff</function> に似ていますが、
   配列のキーを用いて比較するという点が異なります。
  </para>
  <para>
   <function>array_diff_assoc</function> とは異なり、
   内部関数ではなくユーザーが指定したコールバック関数を用いて添字を比較します。
  </para>
 </refsect1>

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

    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       比較元の配列。
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>arrays</parameter></term>
     <listitem>
      <para>
       比較する対象となる配列。
      </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>
   <parameter>array</parameter> の要素のうち、
   その他の配列のいずれにも含まれないものだけを残した配列を返します。
  </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> の例</title>
    <para>
     この例では、<literal>"a" =&gt; "green"</literal>
     の組み合わせが両方の配列に存在し、
     関数の出力には存在しないことが確認できます。
     これとは異なり、<literal>0 =&gt; "red"</literal> は出力されています。
     これは、最初の配列の <literal>"red"</literal> のキーには自動的に
     <literal>0</literal> が割り当てられる一方で、
     二番目の配列では <literal>0</literal>
     には既に <literal>yellow</literal> というキーがあるため、
     <literal>"red"</literal> には <literal>1</literal> が割り当てられるためです。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
function key_compare_func($a, $b)
{
    if ($a === $b) {
        return 0;
    }
    return ($a > $b)? 1:-1;
}

$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>
     2 つのインデックスが等しいかどうかは、
     ユーザーが指定したコールバック関数で調べます。
    </simpara>
   </example>
  </para>
 </refsect1> 

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    この関数は n 次元配列の一つの次元しかチェックしません。
    <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
-->