W3cubDocs

/PHP

The UConverter class

Introduction

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

Class synopsis

class UConverter {
/* Constants */
public const int REASON_UNASSIGNED;
public const int REASON_ILLEGAL;
public const int REASON_IRREGULAR;
public const int REASON_RESET;
public const int REASON_CLOSE;
public const int REASON_CLONE;
public const int UNSUPPORTED_CONVERTER;
public const int SBCS;
public const int DBCS;
public const int MBCS;
public const int LATIN_1;
public const int UTF8;
public const int UTF16_BigEndian;
public const int UTF16_LittleEndian;
public const int UTF32_BigEndian;
public const int UTF32_LittleEndian;
public const int EBCDIC_STATEFUL;
public const int ISO_2022;
public const int LMBCS_1;
public const int LMBCS_2;
public const int LMBCS_3;
public const int LMBCS_4;
public const int LMBCS_5;
public const int LMBCS_6;
public const int LMBCS_8;
public const int LMBCS_11;
public const int LMBCS_16;
public const int LMBCS_17;
public const int LMBCS_18;
public const int LMBCS_19;
public const int LMBCS_LAST;
public const int HZ;
public const int SCSU;
public const int ISCII;
public const int US_ASCII;
public const int UTF7;
public const int BOCU1;
public const int UTF16;
public const int UTF32;
public const int CESU8;
public const int IMAP_MAILBOX;
/* Methods */
public __construct(?string $destination_encoding = null, ?string $source_encoding = null)
public convert(string $str, bool $reverse = false): string|false
public fromUCallback(
 int $reason,
 array $source,
 int $codePoint,
 int &$error
): string|int|array|null
public static getAliases(string $name): array|false|null
public static getAvailable(): array
public getDestinationEncoding(): string|false|null
public getDestinationType(): int|false|null
public getErrorCode(): int
public getErrorMessage(): ?string
public getSourceEncoding(): string|false|null
public getSourceType(): int|false|null
public static getStandards(): ?array
public getSubstChars(): string|false|null
public static reasonText(int $reason): string
public setDestinationEncoding(string $encoding): bool
public setSourceEncoding(string $encoding): bool
public setSubstChars(string $chars): bool
public toUCallback(
 int $reason,
 string $source,
 string $codeUnits,
 int &$error
): string|int|array|null
public static transcode(
 string $str,
 string $toEncoding,
 string $fromEncoding,
 ?array $options = null
): string|false
}

Predefined Constants

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

Changelog

Version Description
8.4.0 The class constants are now typed.

Table of Contents

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