array-pad.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3ce14fde5cd5f15171a7ed2b64fdc7bd652c3842 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.array-pad">
 <refnamediv>
  <refname>array_pad</refname>
  <refpurpose>Rellena un array a la longitud especificada con un valor</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_pad</methodname>
   <methodparam><type>array</type><parameter>array</parameter></methodparam>
   <methodparam><type>int</type><parameter>size</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>array_pad</function> devuelve una copia de
   <parameter>array</parameter> rellenada al tamaño especificado por
   <parameter>size</parameter> con el valor
   <parameter>value</parameter>. Si
   <parameter>size</parameter> es positivo, el array se
   rellena hacia la derecha, si es negativo hacia la izquierda. Si el
   valor absoluto de <parameter>size</parameter> es menor o
   igual a la longitud de <parameter>array</parameter>, no se lleva
   a cabo el relleno.
   Es posible añadir como máximo 1048576 elementos de una sola vez.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       Array inicial de valores a rellenar.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>size</parameter></term>
     <listitem>
      <para>
       Nuevo tamaño del array.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Valor a rellenar si <parameter>array</parameter> es menor que
       <parameter>size</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve una copia de <parameter>array</parameter> rellenada al espacio especificado
   por <parameter>size</parameter> con el valor
   <parameter>value</parameter>. Si <parameter>size</parameter> es 
   positivo el array es relleno hacia la derecha, si es negativo
   hacia la izquierda. Si el valor absoluto de <parameter>size</parameter> es
   menor o igual que la longitud de <parameter>array</parameter>, no se lleva a cabo
   el relleno.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>array_pad</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$input = array(12, 10, 9);

$result = array_pad($input, 5, 0);
// el resultado es array(12, 10, 9, 0, 0)

$result = array_pad($input, -7, -1);
// el resultado es array(-1, -1, -1, -1, 12, 10, 9)

$result = array_pad($input, 2, "noop");
// sin relleno
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>array_fill</function></member>
    <member><function>range</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
-->