UtfNormalUtil.php File Reference

Some of these functions are adapted from places in MediaWiki. More...

Go to the source code of this file.

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

Detailed Description

Some of these functions are adapted from places in MediaWiki.

Should probably merge them for consistency.

Copyright © 2004 Brion Vibber brion.nosp@m.@pob.nosp@m.ox.co.nosp@m.m https://www.mediawiki.org/

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Definition in file UtfNormalUtil.php.

Function Documentation

codepointToUtf8()

codepointToUtf8

(

$codepoint

)

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

Parameters

int

$codepoint

Returns

string

Exceptions

InvalidArgumentException

if fed out of range data.

Access:\n public

Deprecated

since 1.25, use UtfNormal\Utils directly

Definition at line 39 of file UtfNormalUtil.php.

References wfDeprecated().

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.

Access:\n public

Deprecated

since 1.25, use UtfNormal\Utils directly

Definition at line 101 of file UtfNormalUtil.php.

References wfDeprecated().

hexSequenceToUtf8()

hexSequenceToUtf8

(

$sequence

)

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

string

$sequence

Returns

string

Exceptions

InvalidArgumentException

if fed out of range data.

Access:\n private

Deprecated

since 1.25, use UtfNormal\Utils directly

Definition at line 55 of file UtfNormalUtil.php.

References wfDeprecated().

utf8ToCodepoint()

utf8ToCodepoint

(

$char

)

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

Does not check for invalid input data.

Parameters

string

$char

Returns

int

Access:\n public

Deprecated

since 1.25, use UtfNormal\Utils directly

Definition at line 88 of file UtfNormalUtil.php.

References wfDeprecated().

utf8ToHexSequence()

utf8ToHexSequence

(

$str

)

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

For debugging.

@fixme this is private but extensions + maint scripts are using it

Parameters

string

$str

UTF-8 string.

Returns

string

Access:\n private

Definition at line 69 of file UtfNormalUtil.php.

References wfDeprecated().