API17:JArrayHelper::sortObjects
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JArrayHelper::sortObjects|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JArrayHelper::sortObjects|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public static | + | public static function sortObjects ( |
| + | &$a | ||
| + | $k | ||
| + | $direction=1 | ||
| + | $casesensitive=true | ||
| + | $locale=false | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 39: | Line 42: | ||
|bool|array | |bool|array | ||
|true | |true | ||
| − | |Let sort occur | + | |Let sort occur case sensitive or insensitive |
|- | |- | ||
|$locale | |$locale | ||
| Line 47: | Line 50: | ||
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' array The sorted array of objects | |
| − | array The sorted array of objects | + | * '''Defined''' on line 294 of libraries/joomla/utilities/arrayhelper.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/utilities/arrayhelper.php | + | |
| − | * | + | |
| − | + | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JArrayHelper::sortObjects source code''' on [[jplatform:utilities/arrayhelper.php#cl-286|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JArrayHelper/11.1|JArrayHelper]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Utilities/11.1|Utilities]] | ||
| + | * [[JArrayHelper::sortObjects|Other versions of JArrayHelper::sortObjects]] | ||
| + | {{SeeAlso:JArrayHelper::sortObjects}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JArrayHelper::sortObjects|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JArrayHelper::sortObjects|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 68: | Line 70: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JArrayHelper]][[Category:JArrayHelper::sortObjects]]</noinclude> | <noinclude>[[Category:JArrayHelper]][[Category:JArrayHelper::sortObjects]]</noinclude> | ||
Revision as of 20:10, 27 April 2011
JArrayHelper::sortObjects
Description
Utility function to sort an array of objects on a given field.
Description:JArrayHelper::sortObjects [Edit Descripton]
public static function sortObjects ( &$a $k $direction=1 $casesensitive=true $locale=false )
| Parameter | Type | Default | Description |
|---|---|---|---|
| &$a | array | $arr An array of objects | |
| $k | array | The key or a array of key to sort on | |
| $direction | array | 1 | Direction or an array of direction to sort in [1 = Ascending] [-1 = Descending] |
| $casesensitive | array | true | Let sort occur case sensitive or insensitive |
| $locale | array | false | Let sort occur using the locale language or not |
- Returns array The sorted array of objects
- Defined on line 294 of libraries/joomla/utilities/arrayhelper.php
- Since
See also
- JArrayHelper::sortObjects source code on BitBucket
- Class JArrayHelper
- Subpackage Utilities
- Other versions of JArrayHelper::sortObjects
SeeAlso:JArrayHelper::sortObjects [Edit See Also]
User contributed notes
<CodeExamplesForm />
