array-intersect-key.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c84024092aee02b51dd18b909af0f2ccbdd24f98 Maintainer: takagi Status: ready -->
<refentry xml:id="function.array-intersect-key" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_intersect_key</refname>
  <refpurpose>キーを基準にして配列の共通項を計算する</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> は、
   <parameter>array</parameter> のエントリのうち、
   その他のすべての引数の中に共通して存在するキーと一致するキーの値からなる配列を返します。
  </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>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>array</parameter> のエントリのうち、
   すべての引数に存在するキーのものを含む連想配列を返します。
  </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><function>array_intersect_key</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$array1 = array('blue'  => 1, 'red'  => 2, 'green'  => 3, 'purple' => 4);
$array2 = array('green' => 5, 'blue' => 6, 'yellow' => 7, 'cyan'   => 8);

var_dump(array_intersect_key($array1, $array2));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(2) {
  ["blue"]=>
  int(1)
  ["green"]=>
  int(3)
}
]]>
    </screen>
   </example>
  </para>
  <para>
   この例では、両方の配列に存在するキーが <literal>'blue'</literal>
   と <literal>'green'</literal> だけであり、それが返されていることが
   わかります。また、ふたつの配列の間で <literal>'blue'</literal> と
   <literal>'green'</literal> に対応する値が違うことにも注意しましょう。
   それでも一致していると判定されるのは、ただキーだけがチェックされているからです。
   返される値は <parameter>array</parameter> のものです。
  </para>
  <para>
   二つの要素は、
   <literal>(string) $elem1 === (string) $elem2</literal>
   の場合のみ等しいとみなされます。言い換えると、
   文字列表現が同じ場合となります。
  </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
-->