array-splice.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: cd943f94a013b74df8765ab8e1a620a916a64a85 Maintainer: daijie Status: ready -->
  <refentry xml:id="function.array-splice" xmlns="http://docbook.org/ns/docbook">
   <refnamediv>
    <refname>array_splice</refname>
    <refpurpose>
     去掉数组中的某一部分并用其它值取代
    </refpurpose>
   </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_splice</methodname>
   <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>replacement</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
    <para>
     把 <parameter>array</parameter> 数组中由
     <parameter>offset</parameter> 和 <parameter>length</parameter>
     指定的单元去掉，如果提供了 <parameter>replacement</parameter> 参数，则用其中的单元取代。
  </para>
  <note>
    <para>
       <parameter>array</parameter> 中的数字键名不被保留。
    </para>
  </note>
  <note>
   <simpara>
    如果 <parameter>replacement</parameter> 不是数组，会被
    <link linkend="language.types.array.casting">类型转换</link>
   成数组 (例如： <code>(array) $replacement</code>)。
    当传入的 <parameter>replacement</parameter> 是个对象或者 &null;，会导致未知的行为出现。
    </simpara>
  </note>
  </refsect1>
  <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       输入的数组。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       如果 <parameter>offset</parameter> 为正，则从 <parameter>array</parameter>
     数组中该值指定的偏移量开始移除。
      </para>
      <para>
       如果 <parameter>offset</parameter>
     为负，则从 <parameter>array</parameter> 末尾倒数该值指定的偏移量开始移除。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       如果省略 <parameter>length</parameter>，则移除数组中从 <parameter>offset</parameter>
     到结尾的所有部分。
      </para>
      <para>
       如果指定了 <parameter>length</parameter>
     并且为正值，则移除这么多单元。
      </para>
      <para>
       如果指定了 <parameter>length</parameter>
     并且为负值，则移除部分停止于数组末尾该数量的单元。
      </para>
      <para>
      如果设置了 <parameter>length</parameter> 为零，不会移除单元。
      </para>
      <tip>
       <para>
        当给出了
      <parameter>replacement</parameter> 时要移除从 <parameter>offset</parameter>
      到数组末尾所有单元时，用 <literal>count($input)</literal> 作为 <parameter>length</parameter>。
       </para>
      </tip>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>replacement</parameter></term>
     <listitem>
      <para>
       如果给出了 <parameter>replacement</parameter> 数组，则被移除的单元被此数组中的单元替代。
      </para>
      <para>
       如果
        <parameter>offset</parameter> 和 <parameter>length</parameter>
        的组合结果是不会移除任何值，则 <parameter>replacement</parameter>
        数组中的单元将被插入到 <parameter>offset</parameter>
        指定的位置。
      </para>
      <note>
       <para>
        不保留替换数组 <parameter>replacement</parameter> 中的键名。
        </para>
      </note>
      <para>
       如果用来替换 <parameter>replacement</parameter> 只有一个单元，那么不需要给它加上
        <literal>array()</literal> 或方括号，除非该单元本身就是一个数组、一个对象或者 &null;。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
    返回一个包含有被移除单元的数组。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>length</parameter> 现在可为空（nullable）。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>array_splice</function> 例子</title>
    <programlisting role="php">
<![CDATA[
<?php
$input = array("red", "green", "blue", "yellow");
array_splice($input, 2);
var_dump($input);

$input = array("red", "green", "blue", "yellow");
array_splice($input, 1, -1);
var_dump($input);

$input = array("red", "green", "blue", "yellow");
array_splice($input, 1, count($input), "orange");
var_dump($input);

$input = array("red", "green", "blue", "yellow");
array_splice($input, -1, 1, array("black", "maroon"));
var_dump($input);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(2) {
  [0]=>
  string(3) "red"
  [1]=>
  string(5) "green"
}
array(2) {
  [0]=>
  string(3) "red"
  [1]=>
  string(6) "yellow"
}
array(2) {
  [0]=>
  string(3) "red"
  [1]=>
  string(6) "orange"
}
array(5) {
  [0]=>
  string(3) "red"
  [1]=>
  string(5) "green"
  [2]=>
  string(4) "blue"
  [3]=>
  string(5) "black"
  [4]=>
  string(6) "maroon"
}
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>几个以不同表达式实现相同效果的 <function>array_splice</function> 例子</title>
    <para>
     以下表达式是相同的：
    </para>
    <programlisting role="php">
<![CDATA[
<?php

// 添加两个新元素到 $input
array_push($input, $x, $y);
array_splice($input, count($input), 0, array($x, $y));

// 移除 $input 中的最后一个元素
array_pop($input);
array_splice($input, -1);

// 移除 $input 中第一个元素
array_shift($input);
array_splice($input, 0, 1);

// 在 $input 的开头插入一个元素
array_unshift($input, $x, $y);
array_splice($input, 0, 0, array($x, $y));

// 在 $input 的索引 $x 处替换值
$input[$x] = $y; // 对于键名和偏移量等值的数组
array_splice($input, $x, 1, $y);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>array_merge</function></member>
    <member><function>array_slice</function></member>
    <member><function>unset</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
-->