API16

API16:JArrayHelper/sortObjects

From Joomla! Documentation

Revision as of 22:55, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Utility function to sort an array of objects on a given field <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>[[Description:JArrayHelper/sortObje...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

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

[Edit Descripton]

Template:Description:JArrayHelper/sortObjects

Syntax

sortObjects(&$a, $k, $direction=1)
Parameter Name Default Value Description
$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;
}

[Edit See Also] Template:SeeAlso:JArrayHelper/sortObjects

Examples

<CodeExamplesForm />