PHP Collator::sortWithSortKeys() Method: Usage and Examples

When you need to sort an array using ICU collation keys, it helps to understand both the normal result and what changes with different inputs. This guide focuses on practical examples rather than repeating PHP background material.

Collator::sortWithSortKeys provides the behavior described below. A Collator applies locale-dependent ICU collation rules rather than byte-by-byte ordering.

What Is Collator::sortWithSortKeys in PHP?

Sort an array using icu collation keys. A Collator applies locale-dependent ICU collation rules rather than byte-by-byte ordering.

Its syntax is:

$collator->sortWithSortKeys(...)

Parameters and return value: Read the argument names and optional values in the signature above. Methods use an existing object, while stand-alone functions take direct arguments. The examples demonstrate the relevant arguments and the value returned or the object modified.

Important: Sort keys are locale-dependent and affected by ICU rules; the method reorders the array itself.

Example 1: Basic Usage

This first example demonstrates how to sort an array using ICU collation keys with a small input.

<?php

$collator = new Collator("de_DE");
$words = ["zebra", "äpfel", "apfel"];
$collator->sortWithSortKeys($words);
print_r($words);

The example uses the simplest useful form. A Collator applies locale-dependent ICU collation rules rather than byte-by-byte ordering. The output may depend on the active ICU locale, PHP configuration, or input supplied to the function.

Example 2: Another Case

Here the input or option changes, making it easier to see where the behavior differs. Sort keys are locale-dependent and affected by ICU rules; the method reorders the array itself.

<?php

$collator = new Collator("de_DE");
$words = ["zebra", "äpfel", "apfel"];
$sampleWords = ["ångström", "apple", "zebra"];
$collator->sortWithSortKeys($sampleWords);
print_r($sampleWords);

Compare the result to the first example. strcmp() compares bytes; Collator::compare() and Collator sorting methods use locale collation.

Practical Example: Applying the Function

This standalone example shows how the same operation fits into a small application task. The intl extension is required for this example.

<?php

$collator = new Collator("de_DE");
$words = ["zebra", "äpfel", "apfel"];
$names = ["Émile", "Emma", "élise"];
if ($collator->sortWithSortKeys($names)) { print_r($names); }

The example keeps the operation visible and gives you a starting point for using it in an application. Sort keys are locale-dependent and affected by ICU rules; the method reorders the array itself.

Important Behavior and Edge Cases

• Core behavior: A Collator applies locale-dependent ICU collation rules rather than byte-by-byte ordering.
• Return value: Check the result separately from changes to passed-in arrays, iterators, or object state.
• Data constraints: Sort keys are locale-dependent and affected by ICU rules; the method reorders the array itself.
• Environment: The intl extension is required for this example.

Comparison With Related Functions

Common Beginner Mistakes

Key Takeaways

• Collator::sortWithSortKeys helps you sort an array using ICU collation keys.
• A Collator applies locale-dependent ICU collation rules rather than byte-by-byte ordering.
• Sort keys are locale-dependent and affected by ICU rules; the method reorders the array itself.
• strcmp() compares bytes; Collator::compare() and Collator sorting methods use locale collation.

Collator::sortWithSortKeys is useful when you need to sort an array using ICU collation keys. Start with the small examples, then adapt the practical example while respecting its input and environment requirements.