API16

JArrayHelper/sortObjects: Difference between revisions

From Joomla! Documentation

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...
 
m preparing for archive only
 
(3 intermediate revisions by 2 users not shown)
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>[</nowiki>[[Description:JArrayHelper/sortObjects|Edit Descripton]]<nowiki>]</nowiki>
</span>


{{Description:JArrayHelper/sortObjects}}
 
<! removed transcluded page call, red link never existed >


===Syntax===
===Syntax===
Line 17: Line 15:
!Description
!Description
|-
|-
|  
| &$a
|  
|  
|  $arr An array of objects  
|  $arr An array of objects  
Line 53: Line 51:
</source>
</source>


<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JArrayHelper/sortObjects|Edit See Also]]<nowiki>]</nowiki>
<! removed transcluded page call, red link never existed >
</span>
{{SeeAlso:JArrayHelper/sortObjects}}


===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=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>
[[Category:Archived pages API16]]

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