Collator::getSortKey

collator_get_sort_key

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

Collator::getSortKey -- collator_get_sort_key — Get sorting key for a string

Beschreibung

Objektorientierter Stil

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

Prozeduraler Stil

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.

Parameter-Liste

coll

Collator object.

str

The string to produce the key from.

Rückgabewerte

Returns the collation key for the string, Im Fehlerfall wird FALSE zurückgegeben..

Warnung

Diese Funktion kann sowohl das boolsche FALSE zurückliefern, als auch einen nicht-boolschen Wert, welcher zu FALSE ausgewertet wird. Weitere Informationen entnehmen Sie bitte dem Abschnitt über die boolschen Typen. Benutzen Sie deshalb den === Operator, um den Rückgabewert dieser Funktion zu überprüfen.

Changelog

Version Beschreibung
5.3.15, 5.4.5 Sort keys do no longer contain any NUL bytes.

Beispiele

Beispiel #1 collator_get_sort_key()example

<?php
$s1 = 'Hello';

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

echo bin2hex($res);
?>

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:


3832404046010901dc08

Siehe auch