Collator::getSortKey

collator_get_sort_key

(PHP 5 >= 5.3.2, PHP 7, PHP 8, PECL intl >= 1.0.3)

Collator::getSortKey -- collator_get_sort_key — Получает ключ сортировки строки

Описание

Объектно-ориентированный стиль

public Collator::getSortKey(string $string): string|false

Процедурный стиль

collator_get_sort_key(Collator $object, string $string): string|false

Возвращает ключ сопоставления для строки. Ключи сопоставления можно сравнивать напрямую, а не строки, хотя они зависят от реализации и могут меняться в зависимости от версии библиотеки ICU. Ключи сортировки обычно полезны только в базах данных или в других случаях, когда вызовы функций чрезвычайно дороги.

Список параметров

object

Объект Collator.

string

Строка, из которой создаётся ключ.

Возвращаемые значения

Возвращает ключ сопоставления для строки или false в случае возникновения ошибки.

Внимание

Эта функция может возвращать как логическое значение false, так и значение не типа boolean, которое приводится к false. За более подробной информацией обратитесь к разделу Булев тип. Используйте оператор === для проверки значения, возвращаемого этой функцией.

Примеры

Пример #1 Пример использования collator_get_sort_key()

<?php
$s1 = 'Hello';

$coll = collator_create('en_US');
$res = collator_get_sort_key($coll, $s1);

echo bin2hex($res);
?>

Результатом выполнения данного примера будет что-то подобное:


3832404046010901dc08

Смотрите также

  • collator_sort() - Сортирует массив с использованием указанного средства сортировки
  • collator_sort_with_sort_keys() - Сортирует массив с использованием указанного Collator и ключей сортировки