API16:JArrayHelper/getColumn

Description

Extracts a column from an array of arrays or objects

<! removed transcluded page call, red link never existed >

Syntax

getColumn(&$array, $index)

Parameter Name	Default Value	Description
&$array		$array The source array
$index		$index The index of the column or name of object property

Returns

array Column of values from the source array

Defined in

libraries/joomla/utilities/arrayhelper.php

Importing

jimport( 'joomla.utilities.arrayhelper' );

Source Body

function getColumn(&$array, $index)
{
        $result = array ();

        if (is_array($array))
        {
                $n = count($array);
                for ($i = 0; $i < $n; $i++)
                {
                        $item = & $array[$i];
                        if (is_array($item) && isset ($item[$index])) {
                                $result[] = $item[$index];
                        } elseif (is_object($item) && isset ($item-> $index)) {
                                $result[] = $item-> $index;
                        }
                        // else ignore the entry
                }
        }
        return $result;
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />