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

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 1.15  Maintainer: sveta Status: ready -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.14 -->
  <refentry xml:id="function.array-splice" xmlns="http://docbook.org/ns/docbook">
   <refnamediv>
    <refname>array_splice</refname>
    <refpurpose>
     Удалить последовательность элементов массива и заменить её другой последовательностью
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Оисание</title>
     <methodsynopsis>
      <type>array</type><methodname>array_splice</methodname>
      <methodparam><type>array</type><parameter>&amp;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>length</parameter> элементов,
     расположенных на растоянии <parameter>offset</parameter> от начала 
     массива <parameter>input</parameter>, и заменяет их элементами
     массива <parameter>replacement</parameter>, если он передан в качестве параметра.
     Возвращает массив выбранных элементов.
    </para>
    <para>
     Если параметр <parameter>offset</parameter> положителен, будут удалены элементы,
     находящиеся на расстоянии offset от начала <parameter>array</parameter>.  Если
     <parameter>offset</parameter> отрицателен, будут удалены элементы,
     находящиеся на расстоянии offset от конца <parameter>array</parameter>.
    </para>
    <para>
     Если параметр <parameter>length</parameter> опущен, будут удалены все элементы
     начиная с позиции <parameter>offset</parameter> и до конца массива.
     Если передан положительный параметр <parameter>length</parameter>,
     будет удалено length элементов.
     Если передан отрицательный параметр <parameter>length</parameter>,
     будут удалены элементы исходного массива, начиная с позиции <parameter>offset</parameter>
     и заканчивая позицией, отстоящей на <parameter>length</parameter> элементов от конца <parameter>array</parameter>.
     Совет: для того, чтобы удалить все элементы массива, начиная с позиции
     <parameter>offset</parameter> в то время как указан параметр
     <parameter>replacement</parameter>, используйте
     <literal>count($input)</literal> в качестве параметра
     <parameter>length</parameter>.
    </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 // в случае, если key равен offset
       </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 is now array("red", "green")

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

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

$input = array("red", "green", "blue", "yellow");
array_splice($input, -1, 1, array("black", "maroon"));
// $input is now array("red", "green",
//          "blue", "black", "maroon")

$input = array("red", "green", "blue", "yellow");
array_splice($input, 3, 0, "purple");
// $input is now 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
-->