Actions

API15

JArrayHelper/getColumn

From Joomla! Documentation

< API15:JArrayHelper
Revision as of 08:43, 12 May 2013 by JoomlaWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Extracts a column from an array of arrays or objects

[<! removed edit link to red link >]

<! 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 edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />