Printing an Array with Commas (PHP Cookbook)

4.10.1. Problem

You want to print out an array with commas separating the elements and with an "and" before the last element if there are more than two elements in the array.

4.10.2. Solution

Use the pc_array_to_comma_string( ) function shown in Example 4-1, which returns the correct string.

Example 4-1. pc_array_to_comma_string( )

function pc_array_to_comma_string($array) {

    switch (count($array)) {
    case 0:
        return '';

    case 1:
        return reset($array);
    
    case 2:
        return join(' and ', $array);

    default:
        $last = array_pop($array);
        return join(', ', $array) . ", and $last";
    }
}

4.10.3. Discussion

If you have a list of items to print, it's useful to print them in a grammatically correct fashion. It looks awkward to display text like this:

$thundercats = array('Lion-O', 'Panthro', 'Tygra', 'Cheetara', 'Snarf');
print 'ThunderCat good guys include ' . join(', ', $thundercats) . '.';
ThunderCat good guys include Lion-O, Panthro, Tygra, Cheetara, Snarf.

This implementation of this function isn't completely straightforward, since we want pc_array_to_comma_string( ) to work with all arrays, not just numeric ones beginning at 0. If restricted only to that subset, for an array of size one, you return $array[0]. But, if the array doesn't begin at 0, $array[0] is empty. So, you can use the fact that reset( ), which resets an array's internal pointer, also returns the value of the first array element.

Also note that the code for case 2 actually also works correctly for case 1. And, the default code works (though inefficiently) for case 2; however, the transitive property doesn't apply, so you can't use the default code on elements of size 1.

4.10.4. See Also

Recipe 4.9 for turning an array into a string; documentation on join( ) at http://www.php.net/join, array_pop( ) at http://www.php.net/array-pop, and reset( ) at http://www.php.net/reset.


4.9. Turning an Array into a String		4.11. Checking if a Key Is in an Array

4.10. Printing an Array with Commas

4.10.1. Problem

4.10.2. Solution

Example 4-1. pc_array_to_comma_string( )

4.10.3. Discussion

4.10.4. See Also