Difference between revisions of "JArrayHelper/getColumn"
From Joomla! Documentation
< API15:JArrayHelper
(New page: ===Description===
Extracts a column from an array of arrays or objects
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JArrayHelper/getColumn|Edit De...) |
|||
Line 17: | Line 17: | ||
!Description | !Description | ||
|- | |- | ||
− | | | + | | &$array |
| | | | ||
| $array The source array | | $array The source array |
Revision as of 12:40, 25 March 2010
The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
Description[edit]
Extracts a column from an array of arrays or objects
Template:Description:JArrayHelper/getColumn
Syntax[edit]
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[edit]
array Column of values from the source array
Defined in[edit]
libraries/joomla/utilities/arrayhelper.php
Importing[edit]
jimport( 'joomla.utilities.arrayhelper' );
Source Body[edit]
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;
}
[Edit See Also] Template:SeeAlso:JArrayHelper/getColumn
Examples[edit]
<CodeExamplesForm />