API16

JArrayHelper/sortObjects

From Joomla! Documentation

< API16:JArrayHelper

The "API16" 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]

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


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

Syntax[edit]

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[edit]

array The sorted array of objects

Defined in[edit]

libraries/joomla/utilities/arrayhelper.php

Importing[edit]

jimport( 'joomla.utilities.arrayhelper' );

Source Body[edit]

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[edit]

Code Examples[edit]