Collator::getSortKey

collator_get_sort_key

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

Collator::getSortKey -- collator_get_sort_keyGet sorting key for a string

Описание

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

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

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

collator_get_sort_key ( Collator $coll , string $str ) : string|false

Return collation key for a string. Collation keys can be compared directly instead of strings, though are implementation specific and may change between ICU library versions. Sort keys are generally only useful in databases or other circumstances where function calls are extremely expensive.

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

coll

Collator object.

str

The string to produce the key from.

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

Returns the collation key for the string, или false в случае возникновения ошибки.

Внимание

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

Список изменений

Версия Описание
5.3.15, 5.4.5 Sort keys do no longer contain any NUL bytes.

Примеры

Пример #1 collator_get_sort_key()example

<?php
$s1 
'Hello';

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

echo 
bin2hex($res);
?>

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


3832404046010901dc08

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