API16

JArrayHelper/sortObjects: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 55: Line 55:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=sortObjects
  category=sortObjects
  category=JArrayHelper
  category=JArrayHelper
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 01:19, 25 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

Code Examples