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 — Obtém a chave de ordenação de uma string

Descrição

Estilo orientado a objetos

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

Estilo procedural

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

Retorna a chave de agrupamento de uma string. Chaves de agrupamento podem ser comparadas diretamente ao invés de se comparar strings, mas são específicas de implementação e podem mudar entre versões de biblioteca ICU. Chaver de ordenação geralmente são úteis apenas em bancos de dados ou em outras circunstâncias onde chamadas a funções são extremamente custosas.

Parâmetros

object

Objeto de Collator.

string

A string a partir da qual a chave será produzida.

Valor Retornado

Retorna a chave de agrupamento para a string, ou false em caso de falha.

Warning

Esta função pode retornar o valor booleano false, mas também pode retornar um valor não booleano que pode ser avaliado como false. Leia a seção sobre Booleanos para mais informações. Use o operador === para testar o valor retornado por esta função.

Exemplos

Example #1 Exemplo de collator_get_sort_key()

<?php
$s1 = 'Hello';

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

echo bin2hex($res);
?>

O exemplo acima produzirá algo semelhante a:


3832404046010901dc08

Veja Também