archived-doc-ja/reference/array/functions/array-splice.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.8 $ -->
<!-- EN-Revision: 1.17 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,takagi -->
<refentry id="function.array-splice">
 <refnamediv>
  <refname>array_splice</refname>
  <refpurpose>配列の一部を削除し、他の要素で置換する</refpurpose>
 </refnamediv>
 <refsect1>
  <title>説明</title>
  <methodsynopsis>
   <type>array</type><methodname>array_splice</methodname>
   <methodparam><type>array</type><parameter role="reference">input</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>replacement</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>array_splice</function> は、配列 <parameter>input</parameter>
   から <parameter>offset</parameter> および <parameter>length</parameter>
   で指定された要素を削除し、配列 <parameter>replacement</parameter>
   でそれを置換します。この関数は、抽出された要素を含む配列を返します。
   <parameter>input</parameter> の配列の添字は保存されないことに注意しましょう。
  </para>
  <para>
   <parameter>offset</parameter> が正の場合、削除される部分は
   配列 <parameter>input</parameter> の最初から指定オフセットの
   ぶんだけ進んだ位置からとなります。
   <parameter>offset</parameter> が負の場合、削除される部分は、
   <parameter>input</parameter> の末尾から数えた位置からとなります。
  </para>
  <para>
   <parameter>length</parameter> が省略された場合、
   <parameter>offset</parameter> から配列の最後までが全て削除されます。
   <parameter>length</parameter> が指定され、正の場合、複数の要素が削除されます。
   <parameter>length</parameter> が指定され、負の場合、
   削除される部分は配列の末尾から複数の要素となります。
   ヒント: <parameter>replacement</parameter> も指定した場合に
   <parameter>offset</parameter> から配列の最後まで全てを削除するには、
   <parameter>length</parameter> を求めるために <literal>count($input)
   </literal> を使用してください。
  </para>
  <para>
   配列 <parameter>replacement</parameter> が指定された場合、
   削除された要素は、この配列の要素で置換されます。
   <parameter>offset</parameter> および <parameter>length</parameter>
   で何も削除しないと指定した場合、配列 <parameter>replacement</parameter>
   の要素は <parameter>offset</parameter> で指定された位置に挿入されます。
   置換される配列のキーは保存されないことに注意してください。
   もし <parameter>replacement</parameter> に一つしか要素がない場合、
   要素そのものが配列でない限り、<literal>array()</literal>
   で括る必要はありません。
  </para>
  <para>
   以下の文は、同様に <varname>$input</varname> の値を変更します。
   <table>
    <title><function>array_splice</function> と同等なもの</title>
    <tgroup cols="2">
     <tbody>
      <row>
       <entry>
        array_push($input, $x, $y)
       </entry>
       <entry>
        array_splice($input, count($input), 0, array($x, $y))
       </entry>
      </row>
      <row>
       <entry>
        array_pop($input)
       </entry>
       <entry>
        array_splice($input, -1)
       </entry>
      </row>
      <row>
       <entry>
        array_shift($input)
       </entry>
       <entry>
        array_splice($input, 0, 1)
       </entry>
      </row>
      <row>
       <entry>
        array_unshift($input, $x, $y)
       </entry>
       <entry>
        array_splice($input, 0, 0, array($x, $y))
       </entry>
      </row>
      <row>
       <entry>
        $input[$x] = $y // キーがオフセットと等価な配列に対して
       </entry>
       <entry>
        array_splice($input, $x, 1, $y)
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
  <para>
   削除された要素で構成される配列が返されます。
  </para>
  <para>
   <example>
    <title><function>array_splice</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$input = array("red", "green", "blue", "yellow");
array_splice($input, 2);
// ここでは $input は array("red", "green") となる

$input = array("red", "green", "blue", "yellow");
array_splice($input, 1, -1);
// ここでは $input は array("red", "yellow") となる

$input = array("red", "green", "blue", "yellow");
array_splice($input, 1, count($input), "orange");
// ここでは $input は array("red", "orange") となる

$input = array("red", "green", "blue", "yellow");
array_splice($input, -1, 1, array("black", "maroon"));
// ここでは $input は array("red", "green",
//          "blue", "black", "maroon") となる

$input = array("red", "green", "blue", "yellow");
array_splice($input, 3, 0, "purple");
// ここでは $input は array("red", "green",
//          "blue", "purple", "yellow"); となる
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <function>array_slice</function>、
   <function>unset</function> および
   <function>array_merge</function> も参照ください。
  </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:"../../../../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
-->