The UConverter class

Introduction

(PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1)

Class synopsis

UConverter {

/* Constants */

const int REASON_UNASSIGNED = 0 ;

const int REASON_ILLEGAL = 1 ;

const int REASON_IRREGULAR = 2 ;

const int REASON_RESET = 3 ;

const int REASON_CLOSE = 4 ;

const int REASON_CLONE = 5 ;

const int UNSUPPORTED_CONVERTER = -1 ;

const int SBCS = 0 ;

const int DBCS = 1 ;

const int MBCS = 2 ;

const int LATIN_1 = 3 ;

const int UTF8 = 4 ;

const int UTF16_BigEndian = 5 ;

const int UTF16_LittleEndian = 6 ;

const int UTF32_BigEndian = 7 ;

const int UTF32_LittleEndian = 8 ;

const int EBCDIC_STATEFUL = 9 ;

const int ISO_2022 = 10 ;

const int LMBCS_1 = 11 ;

const int LMBCS_2 = 12 ;

const int LMBCS_3 = 13 ;

const int LMBCS_4 = 14 ;

const int LMBCS_5 = 15 ;

const int LMBCS_6 = 16 ;

const int LMBCS_8 = 17 ;

const int LMBCS_11 = 18 ;

const int LMBCS_16 = 19 ;

const int LMBCS_17 = 20 ;

const int LMBCS_18 = 21 ;

const int LMBCS_19 = 22 ;

const int LMBCS_LAST = 22 ;

const int HZ = 23 ;

const int SCSU = 24 ;

const int ISCII = 25 ;

const int US_ASCII = 26 ;

const int UTF7 = 27 ;

const int BOCU1 = 28 ;

const int UTF16 = 29 ;

const int UTF32 = 30 ;

const int CESU8 = 31 ;

const int IMAP_MAILBOX = 32 ;

/* Methods */

public __construct ([ string $destination_encoding [, string $source_encoding ]] )

public convert ( string $str [, bool $reverse ] ) : string

public fromUCallback ( int $reason , string $source , string $codePoint , int &$error ) : mixed

public static getAliases ( string $name ) : array

public static getAvailable ( ) : array

public getDestinationEncoding ( ) : string

public getDestinationType ( ) : int

public getErrorCode ( ) : int

public getErrorMessage ( ) : string

public getSourceEncoding ( ) : string

public getSourceType ( ) : int

public static getStandards ( ) : array

public getSubstChars ( ) : string

public static reasonText ([ int $reason ] ) : string

public setDestinationEncoding ( string $encoding ) : void

public setSourceEncoding ( string $encoding ) : void

public setSubstChars ( string $chars ) : void

public toUCallback ( int $reason , string $source , string $codeUnits , int &$error ) : mixed

public static transcode ( string $str , string $toEncoding , string $fromEncoding [, array $options ] ) : string

}

Predefined Constants

UConverter::REASON_UNASSIGNED
UConverter::REASON_ILLEGAL
UConverter::REASON_IRREGULAR
UConverter::REASON_RESET
UConverter::REASON_CLOSE
UConverter::REASON_CLONE
UConverter::UNSUPPORTED_CONVERTER
UConverter::SBCS
UConverter::DBCS
UConverter::MBCS
UConverter::LATIN_1
UConverter::UTF8
UConverter::UTF16_BigEndian
UConverter::UTF16_LittleEndian
UConverter::UTF32_BigEndian
UConverter::UTF32_LittleEndian
UConverter::EBCDIC_STATEFUL
UConverter::ISO_2022
UConverter::LMBCS_1
UConverter::LMBCS_2
UConverter::LMBCS_3
UConverter::LMBCS_4
UConverter::LMBCS_5
UConverter::LMBCS_6
UConverter::LMBCS_8
UConverter::LMBCS_11
UConverter::LMBCS_16
UConverter::LMBCS_17
UConverter::LMBCS_18
UConverter::LMBCS_19
UConverter::LMBCS_LAST
UConverter::HZ
UConverter::SCSU
UConverter::ISCII
UConverter::US_ASCII
UConverter::UTF7
UConverter::BOCU1
UConverter::UTF16
UConverter::UTF32
UConverter::CESU8
UConverter::IMAP_MAILBOX

UConverter::__construct — Create UConverter object
UConverter::convert — Convert string from one charset to another
UConverter::fromUCallback — Default "from" callback function
UConverter::getAliases — Get the aliases of the given name
UConverter::getAvailable — Get the available canonical converter names
UConverter::getDestinationEncoding — Get the destination encoding
UConverter::getDestinationType — Get the destination converter type
UConverter::getErrorCode — Get last error code on the object
UConverter::getErrorMessage — Get last error message on the object
UConverter::getSourceEncoding — Get the source encoding
UConverter::getSourceType — Get the source converter type
UConverter::getStandards — Get standards associated to converter names
UConverter::getSubstChars — Get substitution chars
UConverter::reasonText — Get string representation of the callback reason
UConverter::setDestinationEncoding — Set the destination encoding
UConverter::setSourceEncoding — Set the source encoding
UConverter::setSubstChars — Set the substitution chars
UConverter::toUCallback — Default "to" callback function
UConverter::transcode — Convert string from one charset to another

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.uconverter.php

The UConverter class

Introduction

Class synopsis

Predefined Constants

Table of Contents