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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- EN-Revision: 1.13 Maintainer: baoengb Status: ready -->
<!-- splitted from ./es/functions/array.xml, last change in rev 1.1 -->
  <refentry id="function.array-splice">
   <refnamediv>
    <refname>array_splice</refname>
    <refpurpose>
     Suprime una porci&oacute;n de la matriz y la sustituye por otra cosa
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>array</type><methodname>array_splice</methodname>
     <methodparam><type>array</type><parameter role="reference">entrada</parameter></methodparam>
     <methodparam><type>int</type><parameter>desplazamiento</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>tamano</parameter></methodparam>
     <methodparam choice="opt"><type>array</type><parameter>
       sustitucion
      </parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>array_splice</function> suprime los elementos designados por 
     el <parameter>desplazamiento</parameter> y el
     <parameter>tamano</parameter> de la matriz
     <parameter>entrada</parameter>, y los sustituye con los elementos
     de la matriz de <parameter>sustitucion</parameter> si se especifica.
    </para>
    <para>
     Si el <parameter>desplazamiento</parameter> es positivo, el comienzo de la 
     parte suprimida ser&iacute;a en esa posici&oacute;n desde el comienzo de la 
     matriz de <parameter>entrada</parameter>. Si el
     <parameter>desplazamiento</parameter> es negativo, se cuenta la posici&oacute;n
     desde el final de la matriz de <parameter>entrada</parameter>.
    </para>
    <para>
     Si se omite <parameter>tamano</parameter>, se suprime todo desde el
     <parameter>desplazamiento</parameter> hasta el final de la matriz. Si
     se especifica el <parameter>tamano</parameter> y es positivo, se suprimir&aacute;n
     tantos elementos como se especifica. Si fuera negativo, el final de la 
     porci&oacute;n eliminada estar&aacute; a tantos elementos del final de la matriz.
     Truco: para eliminar todo desde el <parameter>desplazamiento</parameter> 
     hasta el final de la matriz cuando tambi&eacute;n se especifica
     <parameter>sustitucion</parameter>, utilice <literal>count($entrada)</literal> 
     como <parameter>tamano</parameter>.
    </para>
    <para>
     Si se especifica la matriz de <parameter>sustitucion</parameter>, entonces
     los elementos suprimidos son reemplazados con los elementos de dicha
     matriz. Si los valores de <parameter>desplazamiento</parameter> y
     <parameter>tamano</parameter> son tales que nada es borrado, 
     los elementos de la matriz <parameter>sustitucion</parameter>
     se insertar&aacute;n en la posici&oacute;n indicada por el 
     <parameter>desplazamiento</parameter>. Truco: si s&oacute;lo se va a 
     sustituir algo por un elemento nada m&aacute;s, no hace falta
     poner <literal>array()</literal> alrededor del mismo, salvo que dicho 
     elemento sea una matriz en s&iacute; mismo.
    </para>
    <para>
     Las siguientes funciones son equivalentes:
     Las sentencias siguientes cambian los valores de 
     <varname>$entrada</varname> en la misma forma:
     <table>
      <title>Equivalencias <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 // Para matrices donde el &iacute;ndice equivale a la
          posici&oacute;n
         </entry>
         <entry>
          array_splice($input, $x, 1, $y)
         </entry>
        </row>
       </tbody>      
      </tgroup>
     </table>
    </para>
    <para>
     Devuelve una matriz que tiene los elementos eliminados
    </para>
    <para>
     <example>
      <title>Ejemplos de <function>array_splice</function></title>
      <programlisting role="php">
<![CDATA[
<?php
$entrada = array("rojo", "verde", "azul", "amarillo");

array_splice($entrada, 2);      // $entrada vale ahora array("rojo", "verde")
array_splice($entrada, 1, -1);  // $entrada vale ahora array("rojo", "amarillo")
array_splice($entrada, 1, count($entrada), "naranja");  
                              // $entrada vale ahora array("rojo", "naranja")
array_splice($entrada, -1, 1, array("negro", "marr&oacute;n")); 
                              // $entrada vale ahora array("rojo", "verde", 
                              //          "azul", "negro", "marr&oacute;n")
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     Vea tambi&eacute;n: <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
-->