This chapter is from the book
This chapter is from the book
This chapter is from the book
Other Array Manipulations
So far, we have only covered about half the array processing functions. Many others will be useful from time to time.
Navigating Within an Array: each(), current(), reset(), end(), next(), pos(), and prev()
We mentioned previously that every array has an internal pointer that points to the current element in the array. We indirectly used this pointer earlier when using the each() function, but we can directly use and manipulate this pointer.
If we create a new array, the current pointer is initialized to point to the first element in the array. Calling current( $array_name ) returns the first element.
Calling either next() or each() advances the pointer forward one element. Calling each( $array_name ) returns the current element before advancing the pointer. The function next() behaves slightly differently—calling next( $array_name ) advances the pointer and then returns the new current element.
We have already seen that reset() returns the pointer to the first element in the array. Similarly, calling end( $array_name ) sends the pointer to the end of the array. The first and last element in the array are returned by reset() and end(), respectively.
To move through an array in reverse order, we could use end() and prev(). The prev() function is the opposite of next(). It moves the current pointer back one and then returns the new current element.
For example, the following code displays an array in reverse order:
$value = end ($array);
while ($value)
{
echo "$value<br />";
$value = prev($array);
}
If $array was declared like this:
$array = array(1, 2, 3);
The output would appear in a browser as:
3 2 1
Using each(), current(), reset(), end(), next(), pos(), and prev(), you can write your own code to navigate through an array in any order.
Applying Any Function to Each Element in an Array: array_walk()
Sometimes you might want to work with or modify every element in an array in the same way. The function array_walk() allows you to do this.
The prototype of array_walk() is as follows:
int array_walk(array arr, string func, [mixed userdata])
Similar to the way we called usort() earlier, array_walk() expects you to declare a function of your own.
As you can see, array_walk() takes three parameters. The first, arr, is the array to be processed. The second, func, is the name of a user-defined function that will be applied to each element in the array. The third parameter, userdata, is optional. If you use it, it will be passed through to your function as a parameter. You'll see how this works in a minute.
A handy user-defined function might be one that displays each element with some specified formatting.
The following code displays each element on a new line by calling the user-defined function myPrint() with each element of $array:
function myPrint($value)
{
echo "$value<br />";
}
array_walk($array, 'myPrint');
The function you write needs to have a particular signature. For each element in the array, array_walk takes the key and value stored in the array, and anything you passed as userdata, and calls your function like this:
Yourfunction(value, key, userdata)
For most uses, your function will only be using the values in the array. For some, you might also need to pass a parameter to your function using the parameter userdata. Occasionally, you might be interested in the key of each element as well as the value. Your function can, as with MyPrint(), choose to ignore the key and userdata parameter.
For a slightly more complicated example, we will write a function that modifies the values in the array and requires a parameter. Note that although we are not interested in the key, we need to accept it in order to accept the third parameter.
function myMultiply(&$value, $key, $factor)
{
$value *= $factor;
}
array_walk(&$array, 'myMultiply', 3);
Here we are defining a function, myMultiply(), that will multiply each element in the array by a supplied factor. We need to use the optional third parameter to array_walk() to take a parameter to pass to our function and use it as the factor to multiply by. Because we need this parameter, we must define our function, myMultiply(), to take three parameters—an array element's value ($value), an array element's key ($key), and our parameter ($factor). We are choosing to ignore the key.
A subtle point to note is the way we pass $value. The ampersand (&) before the variable name in the definition of myMultiply() means that $value will be passed by reference. Passing by reference allows the function to alter the contents of the array.
We will address passing by reference in more detail in Chapter 5. If you are not familiar with the term, for now just note that to pass by reference, we place an ampersand before the variable name.
Counting Elements in an Array: count(), sizeof(), and array_count_values()
We used the function count() in an earlier example to count the number of elements in an array of orders. The function sizeof() has exactly the same purpose. Both these functions return the number of elements in an array passed to them. You will get a count of one for the number of elements in a normal scalar variable and 0 if you pass either an empty array or a variable that has not been set.
The array_count_values() function is more complex. If you call array_count_values($array), this function counts how many times each unique value occurs in the array $array. (This is the set cardinality of the array.) The function returns an associative array containing a frequency table. This array contains all the unique values from $array as keys. Each key has a numeric value that tells you how many times the corresponding key occurs in $array.
For example, the following code
$array = array(4, 5, 1, 2, 3, 1, 2, 1); $ac = array_count_values($array);
creates an array called $ac that contains
|
key |
value |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This indicates that 4, 5, and 3 occurred once in $array, 1 occurred three times, and 2 occurred twice.
Converting Arrays to Scalar Variables: extract()
If we have an associative array with a number of key value pairs, we can turn them into a set of scalar variables using the function extract(). The prototype for extract() is as follows:
extract(array var_array [, int extract_type] [, string prefix] );
The purpose of extract() is to take an array and create scalar variables with the names of the keys in the array. The values of these variables are set to the values in the array.
Here is a simple example:
$array = array( 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'); extract($array); echo "$key1 $key2 $key3";
This code produces the following output:
value1 value2 value3
The array had three elements with keys: key1, key2, and key3. Using extract(), we created three scalar variables, $key1, $key2, and $key3. You can see from the output that the values of $key1, $key2, and $key3 are 'value1', 'value2', and 'value3', respectively. These values came from the original array.
There are two optional parameters to extract(): extract_type and prefix. The variable extract_type tells extract() how to handle collisions. These are cases in which a variable already exists with the same name as a key. The default response is to overwrite the existing variable. Four allowable values for extract_type are shown in Table 3.1.
Table 3.1 Allowed extract_types for extract()
|
Type |
Meaning |
|
EXTR_OVERWRITE |
Overwrites the existing variable when a collision occurs. |
|
EXTR_SKIP |
Skips an element when a collision occurs. |
|
EXTR_PREFIX_SAME |
Creates a variable named $prefix_key when a collision occurs. You must supply prefix. |
|
EXTR_PREFIX_ALL |
Prefixes all variable names with prefix. You must supply prefix. |
|
EXTR_IF_EXISTS |
Only extract variables that already exist (that is, fill existing variables with values from the array). This was added at version 4.2.0 and is useful for converting, for example, $_REQUEST to a set of valid variables. |
|
EXTR_PREFIX_IF_EXISTS |
Only create a prefixed version if the non-prefixed version already exists. This was added at version 4.2.0. |
|
EXTR_REFS |
Extract variables as references. This was added at version 4.3.0. |
The two most useful options are the default (EXTR_OVERWRITE) and EXTR_PREFIX_ALL. The other two options might be useful occasionally when you know that a particular collision will occur and want that key skipped or prefixed. A simple example using EXTR_PREFIX_ALL follows. You can see that the variables created are called prefix-underscore-keyname.
$array = array( 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'); extract($array, EXTR_PREFIX_ALL, 'myPrefix'); echo "$myPrefix_key1 $myPrefix_key2 $myPrefix_key3";
This code will again produce the output: value1 value2 value3.
Note that for extract() to extract an element, that element's key must be a valid variable name, which means that keys starting with numbers or including spaces will be skipped.