COLLATOR_SORT(3) 1 COLLATOR_SORT(3)
Collator::sort - Sort array using specified collator
Object oriented style
SYNOPSIS
public bool Collator::sort (array &$arr, [int $sort_flag])
DESCRIPTION
Procedural style
bool collator_sort (Collator $coll, array &$arr, [int $sort_flag])
This function sorts an array according to current locale rules.
Equivalent to standard PHP sort(3) .
PARAMETERS
o $coll
-Collator object.
o $arr
- Array of strings to sort.
o $sort_flag
- Optional sorting type, one of the following:
o Collator::SORT_REGULAR - compare items normally (don't change types)
o Collator::SORT_NUMERIC - compare items numerically
o Collator::SORT_STRING - compare items as strings
Default sorting type is Collator::SORT_REGULAR. It is also used if an invalid $sort_flag value has been specified.
RETURN VALUES
Returns TRUE on success or FALSE on failure.
EXAMPLES
Example #1
collator_sort(3) example
<?php
$coll = collator_create( 'en_US' );
$arr = array( 'at', 'as', 'as' );
var_export( $arr );
collator_sort( $coll, $arr );
var_export( $arr );
?>
The above example will output:
array (
0 => 'at',
1 => 'as',
2 => 'as',
)array (
0 => 'as',
1 => 'as',
2 => 'at',
)
SEE ALSO
Collator constants, collator_asort(3), collator_sort_with_sort_keys(3).
PHP Documentation Group COLLATOR_SORT(3)
