Php/docs/collator.asort
Collator::asort
collator_asort
(PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0)
Collator::asort -- collator_asort — Sort array maintaining index association
Description
Object oriented style
public
Collator::asort
( array &$arr
[, int $sort_flag
] ) : bool
Procedural style
collator_asort
( Collator $coll
, array &$arr
[, int $sort_flag
] ) : bool
This function sorts an array such that array indices maintain their correlation with the array elements they are associated with. This is used mainly when sorting associative arrays where the actual element order is significant. Array elements will have sort order according to current locale rules.
Equivalent to standard PHP asort().
Parameters
coll
Collator object.
arr
Array of strings to sort.
sort_flag
Optional sorting type, one of the following:
Collator::SORT_REGULAR
- compare items normally (don't change types)Collator::SORT_NUMERIC
- compare items numericallyCollator::SORT_STRING
- compare items as strings
Default $sort_flag value 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_asort()example
<?php$coll = collator_create( 'en_US' );$arr = array( 'a' => '100', 'b' => '50', 'c' => '7');collator_asort( $coll, $arr, Collator::SORT_NUMERIC );var_export( $arr );collator_asort( $coll, $arr, Collator::SORT_STRING );var_export( $arr );?>
The above example will output:
array ( 'c' => '7', 'b' => '50', 'a' => '100', )array ( 'a' => '100', 'b' => '50', 'c' => '7', )
See Also
- [[Php/docs/class.collator#intl|]]Collator constants
- collator_sort() - Sort array using specified collator
- collator_sort_with_sort_keys() - Sort array using specified collator and sort keys