array-pad.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2ed209827b7652deaf6d37293938a91196dcd91a Maintainer: zhoumengkang Status: ready -->
<!-- CREDITS: Luffy -->
<refentry xml:id="function.array-pad" xmlns="http://docbook.org/ns/docbook">
   <refnamediv>
    <refname>array_pad</refname>
    <refpurpose>
     以指定长度将一个值填充进数组
    </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> 返回
     <parameter>array</parameter> 的一个拷贝，并用
     <parameter>value</parameter> 将其填补到
     <parameter>length</parameter> 指定的长度。如果
     <parameter>length</parameter> 为正，则填补到数组的右侧，如果为负则从左侧开始填补。如果
     <parameter>length</parameter> 的绝对值小于或等于
     <parameter>array</parameter> 数组的长度则没有任何填补。
    </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       需要被填充的原始数组。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
        新数组的长度。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       将被填充的值，只有在 <parameter>array</parameter> 的现有长度小于
       <parameter>length</parameter> 的长度时才有效。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   返回 <parameter>array</parameter> 用  <parameter>value</parameter> 填充到 <parameter>length</parameter>
   指定的长度之后的一个副本。如果 <parameter>length</parameter> 为正，则填补到数组的右侧，如果为负则从左侧开始填补。如果
   <parameter>length</parameter> 的绝对值小于或等于 <parameter>array</parameter> 数组的长度则没有任何填补。
  </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>
        在 8.3 版本之前，一次只能添加 1048576 个元素。
        现在，它只受数组最大大小的限制。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><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)

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

$result = array_pad($input, 2, "noop");
// 没有填充
?>
]]>
    </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
-->