PHP Class PMA\libraries\Encoding

Show file Open project: phpmyadmin/phpmyadmin Class Usage Examples

Public Methods

Method Description
canConvertKanji ( ) : boolean Detects whether Kanji encoding is available
convertString ( string $src_charset, string $dest_charset, string $what ) : string Converts encoding of text according to parameters with detected conversion function.
getKanjiEncodings ( ) : string Setter for Kanji encodings. Use with caution, mostly useful for testing.
initEngine ( ) : void Initializes encoding engine detecting available backends.
isSupported ( ) : boolean Checks whether there is any charset conversion supported
kanjiChangeOrder ( ) : void Reverses SJIS & EUC-JP position in the encoding codes list
kanjiEncodingForm ( ) : string Defines radio form fields to switch between encoding modes
kanjiFileConv ( string $file, string $enc, string $kana ) : string Kanji file encoding convert
kanjiStrConv ( string $str, string $enc, string $kana ) : string Kanji string encoding convert
setEngine ( $engine ) : void Setter for engine. Use with caution, mostly useful for testing.
setKanjiEncodings ( $value ) : void Setter for Kanji encodings. Use with caution, mostly useful for testing.

Method Details

canConvertKanji() public static method

Detects whether Kanji encoding is available
public static canConvertKanji ( ) : boolean
return boolean

convertString() public static method

Converts encoding of text according to parameters with detected conversion function.
public static convertString ( string $src_charset, string $dest_charset, string $what ) : string
$src_charset string source charset
$dest_charset string target charset
$what string what to convert
return string converted text

getKanjiEncodings() public static method

Setter for Kanji encodings. Use with caution, mostly useful for testing.
public static getKanjiEncodings ( ) : string
return string

initEngine() public static method

Initializes encoding engine detecting available backends.
public static initEngine ( ) : void
return void

isSupported() public static method

Checks whether there is any charset conversion supported
public static isSupported ( ) : boolean
return boolean

kanjiChangeOrder() public static method

Reverses SJIS & EUC-JP position in the encoding codes list
public static kanjiChangeOrder ( ) : void
return void

kanjiEncodingForm() public static method

Defines radio form fields to switch between encoding modes
public static kanjiEncodingForm ( ) : string
return string xhtml code for the radio controls

kanjiFileConv() public static method

Kanji file encoding convert
public static kanjiFileConv ( string $file, string $enc, string $kana ) : string
$file string the name of the file to convert
$enc string the destination encoding code
$kana string set 'kana' convert to JIS-X208-kana
return string the name of the converted file

kanjiStrConv() public static method

Kanji string encoding convert
public static kanjiStrConv ( string $str, string $enc, string $kana ) : string
$str string the string to convert
$enc string the destination encoding code
$kana string set 'kana' convert to JIS-X208-kana
return string the converted string

setEngine() public static method

Setter for engine. Use with caution, mostly useful for testing.
public static setEngine ( $engine ) : void
return void

setKanjiEncodings() public static method

Setter for Kanji encodings. Use with caution, mostly useful for testing.
public static setKanjiEncodings ( $value ) : void
return void