hphp/runtime/ext/icu/ext_icu_uconverter.php

   1 <?hh
   2 // @generated by docskel.php
   3
   4 <<__NativeData("UConverter")>>
   5 class UConverter {
   6   /**
   7    * Create UConverter object
   8    *
   9    * @param string $destination_encoding -
  10    * @param string $source_encoding -
  11    *
  12    * @return  -
  13    */
  14   <<__Native>>
  15   public function __construct(string $destination_encoding = 'utf-8',
  16                               string $source_encoding = 'utf-8'): void;
  17
  18   /**
  19    * Convert string from one charset to another
  20    *
  21    * @param string $str -
  22    * @param bool $reverse -
  23    *
  24    * @return string -
  25    */
  26   <<__Native>>
  27   public function convert(string $str,
  28                           bool $reverse = false): mixed;
  29
  30   /**
  31    * Default "from" callback function
  32    *
  33    * @param int $reason -
  34    * @param string $source -
  35    * @param string $codePoint -
  36    * @param int $error -
  37    *
  38    * @return mixed -
  39    */
  40   public function fromUCallback(int $reason,
  41                                 array $source,
  42                                 int $codePoint,
  43                                 int &$error): mixed {
  44     switch ($reason) {
  45       case self::REASON_UNASSIGNED:
  46       case self::REASON_ILLEGAL:
  47       case self::REASON_IRREGULAR:
  48         $error = U_ZERO_ERROR;
  49         return $this->getDestinationSubstChars();
  50     }
  51     return null;
  52   }
  53
  54   /**
  55    * Get the aliases of the given name
  56    *
  57    * @param string $name -
  58    *
  59    * @return array -
  60    */
  61   <<__Native>>
  62   public static function getAliases(string $name): mixed;
  63
  64   /**
  65    * Get the available canonical converter names
  66    *
  67    * @return array -
  68    */
  69   <<__Native>>
  70   public static function getAvailable(): array;
  71
  72   /**
  73    * Get the destination encoding
  74    *
  75    * @return string -
  76    */
  77   <<__Native>>
  78   public function getDestinationEncoding(): string;
  79
  80   /**
  81    * Get the destination converter type
  82    *
  83    * @return int -
  84    */
  85   <<__Native>>
  86   public function getDestinationType(): int;
  87
  88   /**
  89    * Get last error code on the object
  90    *
  91    * @return int -
  92    */
  93   <<__Native>>
  94   public function getErrorCode(): int;
  95
  96   /**
  97    * Get last error message on the object
  98    *
  99    * @return string -
 100    */
 101   <<__Native>>
 102   public function getErrorMessage(): string;
 103
 104   /**
 105    * Get the source encoding
 106    *
 107    * @return string -
 108    */
 109   <<__Native>>
 110   public function getSourceEncoding(): string;
 111
 112   /**
 113    * Get the source convertor type
 114    *
 115    * @return int -
 116    */
 117   <<__Native>>
 118   public function getSourceType(): int;
 119
 120   /**
 121    * Get standard name
 122    *
 123    * @return string
 124    */
 125   <<__Native>>
 126   public static function getStandardName(string $name,
 127                                          string $standard): mixed;
 128
 129   /**
 130    * Get mime name
 131    *
 132    * @return string
 133    */
 134   public static function getMimeName(string $name): mixed {
 135     return self::getStandardName($name, "MIME");
 136   }
 137
 138   /**
 139    * Get standards associated to converter names
 140    *
 141    * @return array -
 142    */
 143   <<__Native>>
 144   public static function getStandards(): mixed;
 145
 146   /**
 147    * Get substitution chars
 148    *
 149    * @return string -
 150    */
 151   <<__Native>>
 152   public function getDestinationSubstChars(): mixed;
 153
 154   /**
 155    * Get substitution chars
 156    *
 157    * @return string -
 158    */
 159   <<__Native>>
 160   public function getSourceSubstChars(): mixed;
 161
 162   /**
 163    * Get substitution chars
 164    *
 165    * @return string -
 166    */
 167   public function getSubstChars(): mixed {
 168     // Ambiguous, but mostly PHP compat
 169     // since PHP version lacks distinct setters
 170     return $this->getSourceSubstChars();
 171   }
 172
 173   /**
 174    * Get string representation of the callback reason
 175    *
 176    * @param int $reason -
 177    *
 178    * @return string -
 179    */
 180   <<__Native>>
 181   public static function reasonText(int $reason): mixed;
 182
 183   /**
 184    * Set the destination encoding
 185    *
 186    * @param string $encoding -
 187    *
 188    * @return void -
 189    */
 190   <<__Native>>
 191   public function setDestinationEncoding(string $encoding): void;
 192
 193   /**
 194    * Set the source encoding
 195    *
 196    * @param string $encoding -
 197    *
 198    * @return void -
 199    */
 200   <<__Native>>
 201   public function setSourceEncoding(string $encoding): bool;
 202
 203   /**
 204    * Set the substitution chars
 205    *
 206    * @param string $chars -
 207    *
 208    * @return void -
 209    */
 210   <<__Native>>
 211   public function setDestinationSubstChars(string $chars): bool;
 212
 213   /**
 214    * Set the destination substitution chars
 215    *
 216    * @param string $chars -
 217    *
 218    * @return void -
 219    */
 220   <<__Native>>
 221   public function setSourceSubstChars(string $chars): bool;
 222
 223   /**
 224    * Set the substitution chars
 225    *
 226    * @param string $chars -
 227    *
 228    * @return void -
 229    */
 230   public function setSubstChars(string $chars): bool {
 231     return $this->setSourceSubstChars($chars) &&
 232            $this->setDestinationSubstChars($chars);
 233   }
 234
 235   /**
 236    * Default "to" callback function
 237    *
 238    * @param int $reason -
 239    * @param string $source -
 240    * @param string $codeUnits -
 241    * @param int $error -
 242    *
 243    * @return mixed -
 244    */
 245   public function toUCallback(int $reason,
 246                               ?string $source,
 247                               ?string $codeUnits,
 248                               int &$error): mixed {
 249     switch ($reason) {
 250       case self::REASON_UNASSIGNED:
 251       case self::REASON_ILLEGAL:
 252       case self::REASON_IRREGULAR:
 253         $error = U_ZERO_ERROR;
 254         return $this->getSourceSubstChars();
 255     }
 256     return null;
 257   }
 258
 259   /**
 260    * Convert string from one charset to another
 261    *
 262    * @param string $str -
 263    * @param string $toEncoding -
 264    * @param string $fromEncoding -
 265    * @param array $options -
 266    *
 267    * @return string -
 268    */
 269   public static function transcode(string $str,
 270                                    string $toEncoding,
 271                                    string $fromEncoding,
 272                                    array $options = null): ?string {
 273     $cnv = new UConverter($toEncoding, $fromEncoding);
 274     if ((isset($options['from_subst']) &&
 275          !$cnv->setSourceSubstChars($options['from_subst'])) ||
 276         (isset($options['to_subst']) &&
 277          !$cnv->setDestinationSubstChars($options['to_subst']))) {
 278       return null;
 279     }
 280     return $cnv->convert($str);
 281   }
 282 }