Collator::sort
PHP function
Edit on GitHub ✎
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)
Sort array using specified collator
Description
Oop
Collator::sort(array $array, int $flags = Collator::SORT_REGULAR): bool
Procedural
collator_sort(Collator $object, array $array, int $flags = Collator::SORT_REGULAR): bool
This function sorts an array according to current locale rules.
Equivalent to standard PHP sort() .
Parameters
objectCollatorobject.arrayArray of strings to sort.
flagsOptional 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 sorting type is
Collator::SORT_REGULAR. It is also used if an invalidflagsvalue has been specified.
Return Values
Success
Examples
collator_sort() example
php
<?php
$coll = collator_create( 'en_US' );
$arr = array( 'at', 'às', 'as' );
var_export( $arr );
collator_sort( $coll, $arr );
var_export( $arr );
?>The above example will output:
output
array (
0 => 'at',
1 => 'às',
2 => 'as',
)array (
0 => 'as',
1 => 'às',
2 => 'at',
)