Collator::sortWithSortKeys

collator_sort_with_sort_keys

Sort array using specified collator and sort keys

Description

Object-oriented style

public bool Collator::sortWithSortKeys(array &$array)

Procedural style

bool collator_sort_with_sort_keys(Collator $object, array &$array)

Similar to collator_sort but uses ICU sorting keys produced by ucol_getSortKey() to gain more speed on large arrays.

Parameters

object

Collator object.

array

Array of strings to sort

Return Values

Returns true on success or false on failure.

Examples

Example #1 collator_sort_with_sort_keys example

<?php
$arr  = array( 'Köpfe', 'Kypper', 'Kopfe' );
$coll = collator_create( 'sv' );

collator_sort_with_sort_keys( $coll, $arr );
var_export( $arr );
?>

The above example will output:

array (
  0 => 'Kopfe',
  1 => 'Kypper',
  2 => 'Köpfe',
)

See Also