array-fill.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ce882c196dce81bf6bd4d94af4fa4110ddc49ef4 Maintainer: hirokawa Status: ready -->
<refentry xml:id="function.array-fill" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_fill</refname>
  <refpurpose>配列を指定した値で埋める</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>array_fill</methodname>
   <methodparam><type>int</type><parameter>start_index</parameter></methodparam>
   <methodparam><type>int</type><parameter>count</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   パラメータ <parameter>value</parameter> を値とする
   <parameter>count</parameter> 個のエントリからなる配列を埋めます。
   この際、キーは、<parameter>start_index</parameter>
   パラメータから開始します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>

    <varlistentry>
     <term><parameter>start_index</parameter></term>
     <listitem>
      <para>
       返される配列の最初のインデックス。
      </para>
      <para>
       PHP 8.0.0 より前のバージョンでは、
       <parameter>start_index</parameter> が負の場合、
       返される配列の最初のインデックスが
       <parameter>start_index</parameter>
       となり、それ以降のインデックスはゼロから始まっていました。
       PHP 8.0.0 以降のバージョンでは、
       <parameter>start_index</parameter> が負の場合でも、
       インデックスの値が通常通りインクリメントされるようになっています。
       (<link linkend="function.array-fill.example.basic">例</link>を参照ください)。
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>count</parameter></term>
     <listitem>
      <para>
       挿入する要素数。
       ゼロ以上の数でなければなりません。
       かつ、<literal>2147483647</literal> 以下である必要があります。
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       要素に使用する値。
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   値を埋めた配列を返します。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <parameter>count</parameter> が範囲外の値の場合に、
   <classname>ValueError</classname> がスローされます。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>count</parameter> が範囲外の値の場合に、
       <classname>ValueError</classname> がスローされるようになりました。
       これより前のバージョンでは、
       <constant>E_WARNING</constant> が発生し、&false; を返していました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example xml:id="function.array-fill.example.basic">
    <title><function>array_fill</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$a = array_fill(5, 6, 'banana');
print_r($a);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [5]  => banana
    [6]  => banana
    [7]  => banana
    [8]  => banana
    [9]  => banana
    [10] => banana
)
]]>
    </screen>
   </example>
  </para>
  <para>
   <example xml:id="function.array-fill.example.negative-start-index">
    <title>最初のインデックスが負の場合の、<function>array_fill</function>
    の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$a = array_fill(-2, 4, 'pear');
print_r($a);
?>
]]>
    </programlisting>
    &example.outputs.7;
    <screen>
<![CDATA[
Array
(
    [-2] => pear
    [0] => pear
    [1] => pear
    [2] => pear
)
]]>
    </screen>
    &example.outputs.8;
    <screen>
<![CDATA[
Array
(
    [-2] => pear
    [-1] => pear
    [0] => pear
    [1] => pear
)
]]>
    </screen>
   </example>
  </para>
  <para>
   PHP 8.0.0 より前のバージョンでは、
   <literal>-1</literal> が存在していないことに注意しましょう。
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <para>
   負の値をキーに指定した場合についての詳細な説明は、マニュアルの
   <link linkend="language.types.array">配列</link>
   のセクションを参照ください。
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>array_fill_keys</function></member>
    <member><function>str_repeat</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
-->