PHPのmb_encoding_aliases()関数で既知のエンコーディングのエイリアス(別名)を取得する方法

PHPには、既知のエンコーディングタイプが持つエイリアス(別名)を取得するためのmb_encoding_aliases()関数が用意されています。この関数は、PHP 5以降のバージョンで利用可能です。

たとえば「ASCII」というエンコーディングには「US-ASCII」「ISO646-US」「cp367」など、複数の別名が存在します。mb_encoding_aliases()を使えば、こうした別名を一括して配列として取得できます。

構文

array mb_encoding_aliases(str $encoding)

パラメータ

この関数が受け取るパラメータは1つだけです。

• $encoding: エイリアスを調べたいエンコーディングタイプの名前を指定します。

戻り値

成功した場合は、エンコーディングのエイリアスを格納した数値インデックスの配列を返します。失敗した場合はFalseを返します。

エラーと例外

指定したエンコーディングが不明(存在しない)な場合、E_WARNINGレベルのエラーが発生します。そのため、実行前にmb_list_encodings()で有効なエンコーディング一覧を取得し、存在チェックを行うのが安全です。

使用例1: 存在チェックをしてからエイリアスを取得

次の例では、まずmb_list_encodings()で既知のエンコーディング一覧を取得し、指定したエンコーディングが存在するかどうかを確認してから、エイリアスを取得しています。

<?php
   $encoding = 'ASCII';
   $known_encodings = mb_list_encodings();

   if (in_array($encoding, $known_encodings))
   {
      $aliases = mb_encoding_aliases($encoding);
      print_r($aliases);
   }
   else
   {
      echo "Unknown ($encoding) encoding.\n";
   }
?>

出力結果

Array
(
   [0] => ANSI_X3.4-1968
   [1] => iso-ir-6
   [2] => ANSI_X3.4-1986
   [3] => ISO_646.irv:1991
   [4] => US-ASCII
   [5] => ISO646-US
   [6] => us
   [7] => IBM367
   [8] => IBM-367
   [9] => cp367
   [10] => csASCII
)

このように、「ASCII」に対して11個のエイリアスが配列として返されていることがわかります。

使用例2: var_dump()で結果を確認

var_dump()を使うと、各要素のデータ型や文字列の長さまで詳細に確認できます。

<?php
   $array = mb_encoding_aliases("ASCII");
   var_dump($array);
?>

出力結果

array(11) {
   [0]=>
   string(14) "ANSI_X3.4-1968"
   [1]=>
   string(8) "iso-ir-6"
   [2]=>
   string(14) "ANSI_X3.4-1986"
   [3]=>
   string(16) "ISO_646.irv:1991"
   [4]=>
   string(8) "US-ASCII"
   [5]=>
   string(9) "ISO646-US"
   [6]=>
   string(2) "us"
   [7]=>
   string(6) "IBM367"
   [8]=>
   string(7) "IBM-367"
   [9]=>
   string(5) "cp367"
   [10]=>
   string(7) "csASCII"
}

まとめ

mb_encoding_aliases()は、マルチバイト文字列処理(mbstring)拡張モジュールの一部として提供される関数で、エンコーディング名の別名を簡単に取得できます。ユーザー入力されたエンコーディング名を正規化したい場合や、対応エンコーディングの一覧を表示したい場合などに活用すると便利です。