-
Notifications
You must be signed in to change notification settings - Fork 58
/
array-unshift.xml
234 lines (229 loc) · 5.28 KB
/
array-unshift.xml
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: caf779183ee9860b48c74c8994fb944039b6b56f Maintainer: hirokawa Status: ready -->
<refentry xml:id="function.array-unshift" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_unshift</refname>
<refpurpose>一つ以上の要素を配列の最初に加える</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>array_unshift</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
<methodparam rep="repeat"><type>mixed</type><parameter>values</parameter></methodparam>
</methodsynopsis>
<para>
<function>array_unshift</function> は、<parameter>array</parameter>
の先頭に指定された要素を加えます。リストの要素は全体として加えられるため、
加えられた要素の順番は変わらないことに注意してください。
配列の数値添字はすべて新たにゼロから振りなおされます。
リテラルのキーについては変更されません。
</para>
¬e.reset-index;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
入力の配列。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>values</parameter></term>
<listitem>
<para>
加える値。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
処理後の <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>7.3.0</entry>
<entry>
この関数は、1 つのパラメータでのみ呼び出すことができるようになりました。
前は、少なくとも 2 つのパラメータが必要でした。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>array_unshift</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
$queue = [
"orange",
"banana"
];
array_unshift($queue, "apple", "raspberry");
var_dump($queue);
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
array(4) {
[0] =>
string(5) "apple"
[1] =>
string(9) "raspberry"
[2] =>
string(6) "orange"
[3] =>
string(6) "banana"
}
]]>
</screen>
</example>
</para>
<para>
<example>
<title>連想配列と一緒に使う例</title>
<para>
連想配列を別の連想配列の前に加える場合、
追加される配列は、もともとある配列の整数のインデックスに追加されます。
</para>
<programlisting role="php">
<![CDATA[
<?php
$foods = [
'apples' => [
'McIntosh' => 'red',
'Granny Smith' => 'green',
],
'oranges' => [
'Navel' => 'orange',
'Valencia' => 'orange',
],
];
$vegetables = [
'lettuce' => [
'Iceberg' => 'green',
'Butterhead' => 'green',
],
'carrots' => [
'Deep Purple Hybrid' => 'purple',
'Imperator' => 'orange',
],
'cucumber' => [
'Kirby' => 'green',
'Gherkin' => 'green',
],
];
array_unshift($foods, $vegetables);
var_dump($foods);
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
array(3) {
[0] =>
array(3) {
'lettuce' =>
array(2) {
'Iceberg' =>
string(5) "green"
'Butterhead' =>
string(5) "green"
}
'carrots' =>
array(2) {
'Deep Purple Hybrid' =>
string(6) "purple"
'Imperator' =>
string(6) "orange"
}
'cucumber' =>
array(2) {
'Kirby' =>
string(5) "green"
'Gherkin' =>
string(5) "green"
}
}
'apples' =>
array(2) {
'McIntosh' =>
string(3) "red"
'Granny Smith' =>
string(5) "green"
}
'oranges' =>
array(2) {
'Navel' =>
string(6) "orange"
'Valencia' =>
string(6) "orange"
}
}
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>array_merge</function></member>
<member><function>array_shift</function></member>
<member><function>array_push</function></member>
<member><function>array_pop</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
-->