transliterator.transliterate(3) php man page | unix.com

TRANSLITERATOR.TRANSLITERATE(3) 					 1					   TRANSLITERATOR.TRANSLITERATE(3)

Transliterator::transliterate - Transliterate a string

       Object oriented style

SYNOPSIS
       public string Transliterator::transliterate (string  $subject, [int  $start], [int  $end])

DESCRIPTION
       Procedural style
       transliterator_transliterate (mixed  $transliterator, string  $subject, [int  $start], [int  $end])

	Transforms a string or part thereof using an ICU transliterator.

PARAMETERS
	      o $transliterator
		- In the procedural version, either a Transliterator or a string from which a Transliterator can be built.

	      o $subject
		- The string to be transformed.

	      o $start
		-  The start index (in UTF-16 code units) from which the string will start to be transformed, inclusive. Indexing starts at 0. The
		text before will be left as is.

	      o $end
		- The end index (in UTF-16 code units) until which the string will be transformed, exclusive. Indexing starts at 0. The text after
		will be left as is.

RETURN VALUES
	The transfomed string on success, or FALSE on failure.

EXAMPLES
       Example #1

	      Converting escaped UTF-16 code units

	      <?php
	      $s = "u304Au65E9u3046u3054u3056u3044u307Eu3059";
	      echo transliterator_transliterate("Hex-Any/Java", $s), "
";

	      //now the reverse operation with a supplementary character
	      $supplChar = html_entity_decode('&#x1D11E;');
	      echo mb_strlen($supplChar, "UTF-8"), "
";
	      $encSupplChar = transliterator_transliterate("Any-Hex/Java", $supplChar);
	      //echoes two encoded UTF-16 code units
	      echo $encSupplChar, "
";
	      //and back
	      echo transliterator_transliterate("Hex-Any/Java", $encSupplChar), "
";
	      ?>

	      The above example will output something similar to:

	      1
	      uD834uDD1E

SEE ALSO
       Transliterator::getErrorMessage, Transliterator::__construct.

PHP Documentation Group 											   TRANSLITERATOR.TRANSLITERATE(3)