array-pad.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2ed209827b7652deaf6d37293938a91196dcd91a Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<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>length</parameter>
   で指定した長さになるように値 <parameter>value</parameter> で埋めて
   <parameter>array</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>length</parameter>
   で指定した長さになるように値 <parameter>value</parameter> で埋めて
   <parameter>array</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>
        PHP 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);
// 結果は、array(12, 10, 9, 0, 0) です。

$result = array_pad($input, -7, -1);
// 結果は、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
-->