archived-doc-pt-br/reference/array/functions/array-pad.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 2e60c5134e7a847c99f81eb3f7ecee1f5efeeace Maintainer: leonardolara Status: ready --><!-- CREDITS: lucasr,ae,lhsazevedo,leonardolara -->
<refentry xml:id="function.array-pad" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_pad</refname>
  <refpurpose>Expande um array para um certo comprimento utilizando um determinado 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>length</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>array_pad</function> retorna uma cópia de
   <parameter>array</parameter> expandido para o comprimento especificado por
   <parameter>length</parameter> com o valor
   <parameter>value</parameter>. Se
   <parameter>length</parameter> for positivo então o array é
   expandido pela direita, se for negativo, pela esquerda. Se o
   valor absoluto de <parameter>length</parameter> for menor ou igual
   ao comprimento de <parameter>array</parameter>, então ele permanece
   inalterado.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       Array inicial de valores para ser preenchido.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Nova tamanho do array.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Valor para preencher se <parameter>array</parameter> é menor que
       <parameter>length</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retorna uma cópia de <parameter>array</parameter> preenchido pela quantidade especificada
   por <parameter>length</parameter> com o valor
   <parameter>value</parameter>. Se <parameter>length</parameter> é
   positivo, então o array é preenchido na direita, se ele é negativo, então
   da esquerda. Se o valor absoluto de <parameter>length</parameter> é menor
   que ou igual ao comprimento de <parameter>array</parameter> então nenhum
   preenchimento ocorre.
  </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>8.3.0</entry>
       <entry>
        Antes do PHP 8.3.0, somente 1.048.576 elementos podiam ser adicionados de uma vez.
        Agora é limitado apenas pelo tamanho máximo de um array.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemplo de <function>array_pad</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$input = array(12, 10, 9);

$result = array_pad($input, 5, 0);
// $result é array(12, 10, 9, 0, 0)
echo join(', ', $result), PHP_EOL;

$result = array_pad($input, -7, -1);
// $result é array(-1, -1, -1, -1, 12, 10, 9)
echo join(', ', $result), PHP_EOL;

$result = array_pad($input, 2, "noop");
// Não será expandido
echo join(', ', $result), PHP_EOL;
?>
]]>
    </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
-->