Please wait while we load your page...

PasswordSentry

Latest Version [8.00202205221] Last Updated [May-22-2022]

Tools

PHP Manual [Collator

Protect Your Website Today


PHP Manual || Collator

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

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

Description

Object oriented style

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

Procedural style

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

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.

Parameters

coll

Collator object.

str

The string to produce the key from.

Return Values

Returns the collation key for the string, or FALSE on failure.

Warning

This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. Please read the section on Booleans for more information. Use the === operator for testing the return value of this function.

Changelog

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

Examples

Example #1 collator_get_sort_key()example

<?php
$s1 
'Hello';

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

echo 
bin2hex($res);
?>

The above example will output something similar to:


3832404046010901dc08

See Also



PHP Manual || Collator