php man page for collator_get_sort_key

COLLATOR_GET_SORT_KEY(3)						 1						  COLLATOR_GET_SORT_KEY(3)

Collator::getSortKey - Get sorting key for a string

	Object oriented style

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

DESCRIPTION
	Procedural style
       string collator_get_sort_key (Collator  $coll, string  $str)

	Return collation key for a string.

PARAMETERS
	      o $coll
		-Collator object.

	      o $str
		- The string to produce the key from.

RETURN VALUES
       Returns the collation key for the string. Collation keys can be compared directly instead of strings.

       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.

EXAMPLES
       Example #1

	      collator_get_sort_key(3)example

	      <?php
	      $s1 = 'Hello';

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

	      echo urlencode($res);
	      ?>

	      The above example will output:

SEE ALSO
       collator_sort(3), collator_sort_with_sort_keys(3).

PHP Documentation Group 												  COLLATOR_GET_SORT_KEY(3)