Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

array_slice(3) [php man page]

ARRAY_SLICE(3)								 1							    ARRAY_SLICE(3)

array_slice - Extract a slice of the array

SYNOPSIS
array array_slice NULL (array $array, int $offset, [int $length], [bool $preserve_keys = false]) DESCRIPTION
array_slice(3) returns the sequence of elements from the array $array as specified by the $offset and $length parameters. PARAMETERS
o $array - The input array. o $offset - If $offset is non-negative, the sequence will start at that offset in the $array. If $offset is negative, the sequence will start that far from the end of the $array. o $length - If $length is given and is positive, then the sequence will have up to that many elements in it. If the array is shorter than the $length, then only the available array elements will be present. If $length is given and is negative then the sequence will stop that many elements from the end of the array. If it is omitted, then the sequence will have everything from $offset up until the end of the $array. o $preserve_keys - Note that array_slice(3) will reorder and reset the numeric array indices by default. You can change this behaviour by setting $preserve_keys to TRUE. RETURN VALUES
Returns the slice. CHANGELOG
+--------+---------------------------------------------------+ |Version | | | | | | | Description | | | | +--------+---------------------------------------------------+ | 5.2.4 | | | | | | | The default value of the $length parameter was | | | changed to NULL. A NULL$length now tells the | | | function to use the length of $array. Prior to | | | this version, a NULL$length was taken to mean a | | | zero length (nothing will be returned). | | | | | 5.0.2 | | | | | | | The optional $preserve_keys parameter was added. | | | | +--------+---------------------------------------------------+ EXAMPLES
Example #1 array_slice(3) examples <?php $input = array("a", "b", "c", "d", "e"); $output = array_slice($input, 2); // returns "c", "d", and "e" $output = array_slice($input, -2, 1); // returns "d" $output = array_slice($input, 0, 3); // returns "a", "b", and "c" // note the differences in the array keys print_r(array_slice($input, 2, -1)); print_r(array_slice($input, 2, -1, true)); ?> The above example will output: Array ( [0] => c [1] => d ) Array ( [2] => c [3] => d ) SEE ALSO
array_splice(3), unset(3), array_chunk(3). PHP Documentation Group ARRAY_SLICE(3)

Check Out this Related Man Page

ARRAY_SPLICE(3) 							 1							   ARRAY_SPLICE(3)

array_splice - Remove a portion of the array and replace it with something else

SYNOPSIS
array array_splice (array &$input, int $offset, [int $length], [mixed $replacement = array()]) DESCRIPTION
Removes the elements designated by $offset and $length from the $input array, and replaces them with the elements of the $replacement array, if supplied. Note that numeric keys in $input are not preserved. Note If $replacement is not an array, it will be typecast to one (i.e. (array) $parameter). This may result in unexpected behavior when using an object or NULL$replacement. PARAMETERS
o $input - The input array. o $offset - If $offset is positive then the start of removed portion is at that offset from the beginning of the $input array. If $offset is negative then it starts that far from the end of the $input array. o $length - If $length is omitted, removes everything from $offset to the end of the array. If $length is specified and is positive, then that many elements will be removed. If $length is specified and is negative then the end of the removed portion will be that many elements from the end of the array. If $length is specified and is zero, no elements will be removed. Tip: to remove everything from $offset to the end of the array when $replacement is also specified, use count($input) for $length. o $replacement - If $replacement array is specified, then the removed elements are replaced with elements from this array. If $offset and $length are such that nothing is removed, then the elements from the $replacement array are inserted in the place specified by the $offset. Note that keys in replacement array are not preserved. If $replacement is just one element it is not necessary to put array() around it, unless the element is an array itself, an object or NULL. RETURN VALUES
Returns the array consisting of the extracted elements. EXAMPLES
Example #1 array_splice(3) examples <?php $input = array("red", "green", "blue", "yellow"); array_splice($input, 2); // $input is now array("red", "green") $input = array("red", "green", "blue", "yellow"); array_splice($input, 1, -1); // $input is now array("red", "yellow") $input = array("red", "green", "blue", "yellow"); array_splice($input, 1, count($input), "orange"); // $input is now array("red", "orange") $input = array("red", "green", "blue", "yellow"); array_splice($input, -1, 1, array("black", "maroon")); // $input is now array("red", "green", // "blue", "black", "maroon") $input = array("red", "green", "blue", "yellow"); array_splice($input, 3, 0, "purple"); // $input is now array("red", "green", // "blue", "purple", "yellow"); ?> Example #2 array_splice(3) examples The following statements change the values of $input the same way: <?php 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)); $input[$x] = $y; // for arrays where key equals offset array_splice($input, $x, 1, $y); ?> SEE ALSO
array_slice(3), unset(3), array_merge(3). PHP Documentation Group ARRAY_SPLICE(3)
Man Page