mirror of
https://github.com/macintoshplus/doc-en.git
synced 2026-03-24 08:52:18 +01:00
156 lines
3.8 KiB
XML
156 lines
3.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.array-replace" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>array_replace</refname>
|
|
<refpurpose>Replaces elements from passed arrays into the first array</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>array_replace</methodname>
|
|
<methodparam><type>array</type><parameter>array</parameter></methodparam>
|
|
<methodparam rep="repeat"><type>array</type><parameter>replacements</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>array_replace</function> creates a new array and assigns items into
|
|
it for each key in each of the provided arrays. If a key appears in multiple
|
|
input arrays, the value from the right-most input array will be used.
|
|
</para>
|
|
<para>
|
|
<function>array_replace</function> does not process elements items recursively,
|
|
it replaces the entire value for each key when it does a replacement.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>array</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The array in which elements are replaced.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>replacements</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Arrays from which elements will be extracted.
|
|
Values from later arrays overwrite the previous values.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an <type>array</type>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>array_replace</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$base = array("orange", "banana", "apple", "raspberry");
|
|
$replacements = array(0 => "pineapple", 4 => "cherry");
|
|
$replacements2 = array(0 => "grape");
|
|
|
|
$basket = array_replace($base, $replacements, $replacements2);
|
|
var_dump($basket);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen role="php">
|
|
<![CDATA[
|
|
array(5) {
|
|
[0]=>
|
|
string(5) "grape"
|
|
[1]=>
|
|
string(6) "banana"
|
|
[2]=>
|
|
string(5) "apple"
|
|
[3]=>
|
|
string(9) "raspberry"
|
|
[4]=>
|
|
string(6) "cherry"
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title>Example of how nested arrays are handled</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$base = [ 'citrus' => [ 'orange', 'lemon' ], 'pome' => [ 'apple' ] ];
|
|
$replacements = [ 'citrus' => [ 'grapefruit' ] ];
|
|
$replacements2 = [ 'citrus' => [ 'kumquat', 'citron' ], 'pome' => [ 'loquat' ] ];
|
|
|
|
$basket = array_replace($base, $replacements, $replacements2);
|
|
var_dump($basket);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen role="php">
|
|
<![CDATA[
|
|
array(2) {
|
|
["citrus"]=>
|
|
array(2) {
|
|
[0]=>
|
|
string(7) "kumquat"
|
|
[1]=>
|
|
string(6) "citron"
|
|
}
|
|
["pome"]=>
|
|
array(1) {
|
|
[0]=>
|
|
string(6) "loquat"
|
|
}
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>array_replace_recursive</function></member>
|
|
<member><function>array_merge</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
|
|
-->
|