array-udiff-uassoc.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 56509d07ae636f076057f55bbb2572ab7b7a39eb Maintainer: takagi Status: ready -->
<refentry xml:id="function.array-udiff-uassoc" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_udiff_uassoc</refname>
  <refpurpose>データと添字の比較にコールバック関数を用い、
  追加された添字の確認を含めて配列の差を計算する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_udiff_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>value_compare_func</parameter></methodparam>
   <methodparam><type>callable</type><parameter>key_compare_func</parameter></methodparam>
  </methodsynopsis>
  <para>
   データと添字の比較にコールバック関数を用い、
   追加された添字の確認を含めて配列の差を計算します。
  </para>
  <para>
   <function>array_diff</function> や <function>array_udiff</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>value_compare_func</parameter></term>
     <listitem>
      &sort.callback.description;
      &sort.callback.description.presort;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>key_compare_func</parameter></term>
     <listitem>
      <para>
       キー（添字）の比較は、コールバック関数
       <parameter>key_compare_func</parameter> で行われます。
       <function>array_udiff_assoc</function> では後者の比較が内部関数で
       行われるという点で、この関数とは異なります。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>array</parameter> から他の引数の配列の中に現れない全ての
   値を含む<type>array</type> を返します。
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>array_udiff_uassoc</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
class cr {
    private $priv_member;
    function __construct($val)
    {
        $this->priv_member = $val;
    }

    static function comp_func_cr($a, $b)
    {
        if ($a->priv_member === $b->priv_member) return 0;
        return ($a->priv_member > $b->priv_member)? 1:-1;
    }

    static function comp_func_key($a, $b)
    {
        if ($a === $b) return 0;
        return ($a > $b)? 1:-1;
    }
}
$a = array("0.1" => new cr(9), "0.5" => new cr(12), 0 => new cr(23), 1=> new cr(4), 2 => new cr(-15),);
$b = array("0.2" => new cr(9), "0.5" => new cr(22), 0 => new cr(3), 1=> new cr(4), 2 => new cr(-15),);

$result = array_udiff_uassoc($a, $b, array("cr", "comp_func_cr"), array("cr", "comp_func_key"));
print_r($result);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [0.1] => cr Object
        (
            [priv_member:private] => 9
        )

    [0.5] => cr Object
        (
            [priv_member:private] => 12
        )

    [0] => cr Object
        (
            [priv_member:private] => 23
        )
)
]]>
    </screen>
   </example>
  </para>
  <simpara>
   上の例で、<literal>"1" =&gt; new cr(4)</literal> の組み合わせが両方の配列にあること、
   そしてそれが関数の出力に含まれていないことが確認できます。
   コールバック関数を 2 つ指定しなければならないことに注意してください。
  </simpara>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <simpara>
    この関数は n 次元配列の一つの次元しかチェックしないことに注意してください。
    もちろん、<literal>array_udiff_uassoc($array1[0], $array2[0], "data_compare_func",
    "key_compare_func");</literal>
    のようにすることでより深い次元でのチェックもできます。
   </simpara>
  </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_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
-->