array-slice.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 68b263e63dc5916bf04122f4ec038d5285e4f0f2 Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xml:id="function.array-slice" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_slice</refname>
  <refpurpose>Extraer una parte de un array</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_slice</methodname>
   <methodparam><type>array</type><parameter>array</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>preserve_keys</parameter><initializer>false</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>array_slice</function> devuelve la secuencia de elementos
   del array <parameter>array</parameter> tal y como se especifica en
   los parámetros <parameter>offset</parameter> y
   <parameter>length</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       El array de entrada.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Si el índice dado por <parameter>offset</parameter> no es negativo, la secuencia
       empezará en esa posición del <parameter>array</parameter>. Si el
       <parameter>offset</parameter> es negativo, la secuencia 
       empezará en esa posición empezando por el final del <parameter>array</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Si la longitud dada por <parameter>length</parameter> es positiva,
       la secuencia tendrá hasta tantos elementos como indique el valor. Si el array
       es más corto que <parameter>length</parameter>, solamente estarán
       presentes los elementos disponibles del array. Si se proporciona
       <parameter>length</parameter> y es negativo, la
       secuencia finalizará en tantos elementos empezando por el final del
       array. Si se omite, entonces la secuencia contendrá todo el contenido
       desde <parameter>offset</parameter> hasta el final del
       <parameter>array</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>preserve_keys</parameter></term>
     <listitem>
      <para>
       Observe que <function>array_slice</function> reordenará y reinicializará los
       índices numéricos del array de forma predeterminada. Se puede cambiar esta comportamiento
       estableciendo el parámetro <parameter>preserve_keys</parameter> a &true;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve la parte del array. Si el índice es mayor que el tamaño del array, devuelve un array vacío.
  </para>
 </refsect1>
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.2.4</entry>
       <entry>
        El valor predeterminado del parámetro <parameter>length</parameter> se cambió a <literal>NULL</literal>. Una  <parameter>length</parameter> <literal>NULL</literal> ahora indica a la función que use la longitud de <parameter>array</parameter>. Antes de esta versión, una <parameter>length</parameter> <literal>NULL</literal>  se tomaba como de longitud cero (no se devolvía nada).
       </entry>
      </row>
      <row>
       <entry>5.0.2</entry>
       <entry>
        Se añadió el parámetro opcional <parameter>preserve_keys</parameter>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplos de <function>array_slice</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$entrada = array("a", "b", "c", "d", "e");

$salida = array_slice($entrada, 2);      // devuelve "c", "d", y "e"
$salida = array_slice($entrada, -2, 1);  // devuelve "d"
$salida = array_slice($entrada, 0, 3);   // devuelve "a", "b", y "c"

// observe las diferencias en las claves de los arrays
print_r(array_slice($entrada, 2, -1));
print_r(array_slice($entrada, 2, -1, true));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [0] => c
    [1] => d
)
Array
(
    [2] => c
    [3] => d
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>array_splice</function></member>
    <member><function>unset</function></member>
    <member><function>array_chunk</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
-->