API16

JArrayHelper/sortObjects: Difference between revisions

From Joomla! Documentation

m removing red link to edit, no existant pages
m clean up
Line 2: Line 2:
Utility function to sort an array of objects on a given field
Utility function to sort an array of objects on a given field


<span class="editsection" style="font-size:76%;">
 
<nowiki>[<! removed edit link to red link >]</nowiki>
</span>


<! removed transcluded page call, red link never existed >
<! removed transcluded page call, red link never existed >
Line 53: Line 51:
</source>
</source>


<span class="editsection" style="font-size:76%;">
 
<nowiki>[<! removed edit link to red link >]</nowiki>
</span>
<! removed transcluded page call, red link never existed >
<! removed transcluded page call, red link never existed >



Revision as of 13:39, 24 March 2017

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 />