1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.array-fill" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_fill</refname>
<refpurpose>Fill an array with values</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>
Fills an array with
<parameter>count</parameter> entries of the value of the
<parameter>value</parameter> parameter, keys starting at the
<parameter>start_index</parameter> parameter.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>start_index</parameter></term>
<listitem>
<para>
The first index of the returned array.
</para>
<para>
If <parameter>start_index</parameter> is negative,
the first index of the returned array will be
<parameter>start_index</parameter> and the following
indices will start from zero prior to PHP 8.0.0;
as of PHP 8.0.0, negative keys are incremented normally
(see <link linkend="function.array-fill.example.negative-start-index">example</link>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>count</parameter></term>
<listitem>
<para>
Number of elements to insert.
Must be greater than or equal to zero, and less than or equal to <literal>2147483647</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
Value to use for filling
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the filled array
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws a <classname>ValueError</classname> if <parameter>count</parameter> is
out of range.
</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>
<function>array_fill</function> now throws a <classname>ValueError</classname>
if <parameter>count</parameter> is out of range; previously <constant>E_WARNING</constant>
was raised, and the function returned &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> example</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> example with a negative start index</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>
Note that index <literal>-1</literal> is not present prior to PHP 8.0.0.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<para>
See also the <link linkend="language.types.array">Arrays</link>
section of manual for a detailed explanation of negative keys.
</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
-->
|