php-doc-en/reference/array/functions/array-intersect-assoc.xml
Christoph Michael Becker da0818b8a5 clarified difference to array_intersect()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338914 c90b9560-bf6c-de11-be94-00142212c4b1
2016-04-04 16:51:21 +00:00

142 lines
4.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.array-intersect-assoc">
<refnamediv>
<refname>array_intersect_assoc</refname>
<refpurpose>Computes the intersection of arrays with additional index check</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>array_intersect_assoc</methodname>
<methodparam><type>array</type><parameter>array1</parameter></methodparam>
<methodparam><type>array</type><parameter>array2</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>array_intersect_assoc</function> returns an array
containing all the values of <parameter>array1</parameter>
that are present in all the arguments. Note that the keys are also used in
the comparison unlike in <function>array_intersect</function>.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array1</parameter></term>
<listitem>
<para>
The array with master values to check.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>array2</parameter></term>
<listitem>
<para>
An array to compare values against.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter></term>
<listitem>
<para>
A variable list of arrays to compare.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array containing all the values in
<parameter>array1</parameter> that are present in all of the arguments.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>array_intersect_assoc</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$array1 = array("a" => "green", "b" => "brown", "c" => "blue", "red");
$array2 = array("a" => "green", "b" => "yellow", "blue", "red");
$result_array = array_intersect_assoc($array1, $array2);
print_r($result_array);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[a] => green
)
]]>
</screen>
</example>
</para>
<simpara>
In our example you see that only the pair <literal>"a" =&gt;
"green"</literal> is present in both arrays and thus is returned.
The value <literal>"red"</literal> is not returned because in
<varname>$array1</varname> its key is <literal>0</literal> while
the key of "red" in <varname>$array2</varname> is
<literal>1</literal>, and the key <literal>"b"</literal> is not returned
because its values are different in each array.
</simpara>
<simpara>
The two values from the <literal>key =&gt; value</literal> pairs are
considered equal only if
<literal>(string) $elem1 === (string) $elem2 </literal>. In other words
a strict type check is executed so the string representation must be
the same.
<!-- TODO: example of it... -->
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>array_intersect</function></member>
<member><function>array_uintersect_assoc</function></member>
<member><function>array_intersect_uassoc</function></member>
<member><function>array_uintersect_uassoc</function></member>
<member><function>array_diff</function></member>
<member><function>array_diff_assoc</function></member>
</simplelist>
</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
-->