API16:JArrayHelper/sortObjects

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.

Description

Utility function to sort an array of objects on a given field

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

Syntax

sortObjects(&$a, $k, $direction=1)

Parameter Name	Default Value	Description
&$a		$arr An array of objects
$k		$k The key to sort on
$direction	1	$direction Direction to sort in [1 = Ascending] [-1 = Descending]

Returns

array The sorted array of objects

Defined in

libraries/joomla/utilities/arrayhelper.php

Importing

jimport( 'joomla.utilities.arrayhelper' );

Source Body

function sortObjects(&$a, $k, $direction=1)
{
        $GLOBALS['JAH_so'] = array(
                'key'           => $k,
                'direction'     => $direction
        );
        usort($a, array('JArrayHelper', '_sortObjects'));
        unset($GLOBALS['JAH_so']);
 
        return $a;
}

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

Examples

<CodeExamplesForm />