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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.array-pad">
<refnamediv>
<refname>array_pad</refname>
<refpurpose>Pad array to the specified length with a value</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>array_pad</methodname>
<methodparam><type>array</type><parameter>input</parameter></methodparam>
<methodparam><type>int</type><parameter>pad_size</parameter></methodparam>
<methodparam><type>mixed</type><parameter>pad_value</parameter></methodparam>
</methodsynopsis>
<para>
<function>array_pad</function> returns a copy of the
<parameter>input</parameter> padded to size specified by
<parameter>pad_size</parameter> with value
<parameter>pad_value</parameter>. If
<parameter>pad_size</parameter> is positive then the array is
padded on the right, if it's negative then on the left. If the
absolute value of <parameter>pad_size</parameter> is less than or
equal to the length of the <parameter>input</parameter> then no
padding takes place.
It is possible to add most 1048576 elements at a time.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<para>
Initial array of values to pad.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pad_size</parameter></term>
<listitem>
<para>
New size of the array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pad_value</parameter></term>
<listitem>
<para>
Value to pad if <parameter>input</parameter> is less than
<parameter>pad_size</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a copy of the <parameter>input</parameter> padded to size specified
by <parameter>pad_size</parameter> with value
<parameter>pad_value</parameter>. If <parameter>pad_size</parameter> is
positive then the array is padded on the right, if it's negative then
on the left. If the absolute value of pad_size is less than or equal to
the length of the input then no padding takes place.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>array_pad</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$input = array(12, 10, 9);
$result = array_pad($input, 5, 0);
// result is array(12, 10, 9, 0, 0)
$result = array_pad($input, -7, -1);
// result is array(-1, -1, -1, -1, 12, 10, 9)
$result = array_pad($input, 2, "noop");
// not padded
?>
]]>
</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
-->
|
