Edit Report a Bug

    Collator::sortWithSortKeys

    collator_sort_with_sort_keys

    (PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)

    Collator::sortWithSortKeys -- collator_sort_with_sort_keys — Sort array using specified collator and sort keys

    Description

    Object-oriented style

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

    Procedural style

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

    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

    add a note add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top