UtfNormalUtil.php File Reference

Go to the source code of this file.

Functions
	codepointToUtf8 ($codepoint)
	Return UTF-8 sequence for a given Unicode code point. More...
	hexSequenceToUtf8 ($sequence)
	Take a series of space-separated hexadecimal numbers representing Unicode code points and return a UTF-8 string composed of those characters. More...
	utf8ToHexSequence ($str)
	Take a UTF-8 string and return a space-separated series of hex numbers representing Unicode code points. More...
	utf8ToCodepoint ($char)
	Determine the Unicode codepoint of a single-character UTF-8 sequence. More...
	escapeSingleString ($string)
	Escape a string for inclusion in a PHP single-quoted string literal. More...

Function Documentation

codepointToUtf8()

codepointToUtf8

(

$codepoint

)

Return UTF-8 sequence for a given Unicode code point.

May die if fed out of range data.

Parameters

$codepoint

Integer:

Returns

String

Definition at line 38 of file UtfNormalUtil.php.

Referenced by ilCharSelectorConfig\getItemParsedCallback(), Sanitizer\hexCharReference(), hexSequenceToUtf8(), and CleanUpTest\XtestAllChars().

{
    if ($codepoint < 0x80) {
        return chr($codepoint);
    }
    if ($codepoint < 0x800) {
        return chr($codepoint >> 6 & 0x3f | 0xc0) .
                                     chr($codepoint & 0x3f | 0x80);
    }
    if ($codepoint < 0x10000) {
        return chr($codepoint >> 12 & 0x0f | 0xe0) .
                                     chr($codepoint >> 6 & 0x3f | 0x80) .
                                     chr($codepoint & 0x3f | 0x80);
    }
    if ($codepoint < 0x110000) {
        return chr($codepoint >> 18 & 0x07 | 0xf0) .
                                     chr($codepoint >> 12 & 0x3f | 0x80) .
                                     chr($codepoint >> 6 & 0x3f | 0x80) .
                                     chr($codepoint & 0x3f | 0x80);
    }

    echo "Asked for code outside of range ($codepoint)\n";
    die(-1);
}

Here is the caller graph for this function:

escapeSingleString()

escapeSingleString

(

$string

)

Escape a string for inclusion in a PHP single-quoted string literal.

Parameters

$string

String: string to be escaped.

Returns

String: escaped string.

Definition at line 150 of file UtfNormalUtil.php.

{
    return strtr(
        $string,
        array(
            '\\' => '\\\\',
            '\'' => '\\\''
        )
    );
}

hexSequenceToUtf8()

hexSequenceToUtf8 (   $sequence )

private

Take a series of space-separated hexadecimal numbers representing Unicode code points and return a UTF-8 string composed of those characters.

Used by UTF-8 data generation and testing routines.

Parameters

$sequence

String

Returns

String

Definition at line 72 of file UtfNormalUtil.php.

References $n, and codepointToUtf8().

{
    $utf = '';
    foreach (explode(' ', $sequence) as $hex) {
        $n = hexdec($hex);
        $utf .= codepointToUtf8($n);
    }
    return $utf;
}

Here is the call graph for this function:

utf8ToCodepoint()

utf8ToCodepoint

(

$char

)

Determine the Unicode codepoint of a single-character UTF-8 sequence.

Does not check for invalid input data.

Parameters

$char

String

Returns

Integer

Definition at line 109 of file UtfNormalUtil.php.

References $i.

Referenced by ilCharSelectorConfig\getItemCodepoint(), and utf8ToHexSequence().

{
    # Find the length
    $z = ord($char[0]);
    if ($z & 0x80) {
        $length = 0;
        while ($z & 0x80) {
            $length++;
            $z <<= 1;
        }
    } else {
        $length = 1;
    }

    if ($length != strlen($char)) {
        return false;
    }
    if ($length == 1) {
        return ord($char);
    }

    # Mask off the length-determining bits and shift back to the original location
    $z &= 0xff;
    $z >>= $length;

    # Add in the free bits from subsequent bytes
    for ($i = 1; $i < $length; $i++) {
        $z <<= 6;
        $z |= ord($char[$i]) & 0x3f;
    }

    return $z;
}

Here is the caller graph for this function:

utf8ToHexSequence()

utf8ToHexSequence (   $str )

private

Take a UTF-8 string and return a space-separated series of hex numbers representing Unicode code points.

For debugging.

Parameters

$str	String: UTF-8 string.

Returns

string

Definition at line 90 of file UtfNormalUtil.php.

References utf8ToCodepoint().

{
    return rtrim(preg_replace_callback(
        '/(.)/uS',
        function ($hit) {
            return sprintf("%04x ", utf8ToCodepoint($hit[1]));
        },
        $str
    ));
}

Here is the call graph for this function: