-
Notifications
You must be signed in to change notification settings - Fork 0
/
function.array-splice.html
404 lines (403 loc) · 6.01 KB
/
function.array-splice.html
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
<HTML
><HEAD
><TITLE
>array_splice</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="Array Functions"
HREF="ref.array.html"><LINK
REL="PREVIOUS"
TITLE="array_slice"
HREF="function.array-slice.html"><LINK
REL="NEXT"
TITLE="array_unique"
HREF="function.array-unique.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.array-slice.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.array-unique.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.array-splice"
>array_splice</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN4918"
></A
><P
> (PHP4 )</P
>array_splice --
Remove a portion of the array and replace it with something
else
</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN4921"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN4923"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>array <B
CLASS="function"
>array_splice</B
></CODE
> (array input, int offset [, int
length [, array
replacement]])</CODE
></P
><P
></P
></DIV
><P
> <B
CLASS="function"
>Array_splice()</B
> removes the elements designated
by <TT
CLASS="parameter"
><I
>offset</I
></TT
> and
<TT
CLASS="parameter"
><I
>length</I
></TT
> from the
<TT
CLASS="parameter"
><I
>input</I
></TT
> array, and replaces them with the
elements of the <TT
CLASS="parameter"
><I
>replacement</I
></TT
> array, if
supplied.
</P
><P
> If <TT
CLASS="parameter"
><I
>offset</I
></TT
> is positive then the start of
removed portion is at that offset from the beginning of the
<TT
CLASS="parameter"
><I
>input</I
></TT
> array. If
<TT
CLASS="parameter"
><I
>offset</I
></TT
> is negative then it starts that far
from the end of the <TT
CLASS="parameter"
><I
>input</I
></TT
> array.
</P
><P
> If <TT
CLASS="parameter"
><I
>length</I
></TT
> is omitted, removes everything
from <TT
CLASS="parameter"
><I
>offset</I
></TT
> to the end of the array. If
<TT
CLASS="parameter"
><I
>length</I
></TT
> is specified and is positive, then
that many elements will be removed. If
<TT
CLASS="parameter"
><I
>length</I
></TT
> is specified and is negative then
the end of the removed portion will be that many elements from
the end of the array. Tip: to remove everything from
<TT
CLASS="parameter"
><I
>offset</I
></TT
> to the end of the array when
<TT
CLASS="parameter"
><I
>replacement</I
></TT
> is also specified, use
<TT
CLASS="literal"
>count($input)</TT
> for
<TT
CLASS="parameter"
><I
>length</I
></TT
>.
</P
><P
> If <TT
CLASS="parameter"
><I
>replacement</I
></TT
> array is specified, then
the removed elements are replaced with elements from this array.
If <TT
CLASS="parameter"
><I
>offset</I
></TT
> and
<TT
CLASS="parameter"
><I
>length</I
></TT
> are such that nothing is removed,
then the elements from the <TT
CLASS="parameter"
><I
>replacement</I
></TT
>
array are inserted in the place specified by the
<TT
CLASS="parameter"
><I
>offset</I
></TT
>. Tip: if the replacement is just
one element it is not necessary to put <TT
CLASS="literal"
>array()</TT
>
around it, unless the element is an array itself.
</P
><P
> The following equivalences hold:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
> array_push ($input, $x, $y) array_splice ($input, count ($input), 0,
array ($x, $y))
array_pop ($input) array_splice ($input, -1)
array_shift ($input) array_splice ($input, 0, 1)
array_unshift ($input, $x, $y) array_splice ($input, 0, 0, array ($x, $y))
$a[$x] = $y array_splice ($input, $x, 1, $y)
</PRE
></TD
></TR
></TABLE
>
</P
><P
> Returns the array consisting of removed elements.
</P
><P
> <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN4968"
></A
><P
><B
>Example 1. <B
CLASS="function"
>Array_splice()</B
> examples</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
> $input = array ("red", "green", "blue", "yellow");
array_splice ($input, 2); // $input is now array ("red", "green")
array_splice ($input, 1, -1); // $input is now array ("red", "yellow")
array_splice ($input, 1, count($input), "orange");
// $input is now array ("red", "orange")
array_splice ($input, -1, 1, array("black", "maroon"));
// $input is now array ("red", "green",
// "blue", "black", "maroon")
</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
</P
><P
> See also <A
HREF="function.array-slice.html"
><B
CLASS="function"
>array_slice()</B
></A
>.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.array-slice.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.array-unique.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>array_slice</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.array.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>array_unique</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>