PHPのiconv_get_encoding()関数でiconv拡張機能の内部設定変数を取得する方法

PHPでは、iconv_get_encoding()関数を使うことで、iconv拡張機能の内部設定変数の現在値を取得できます。この関数はPHPの組み込み関数であり、PHP 4以降のバージョンで利用可能です。文字エンコーディングの変換処理を行う際に、現在の設定を確認したい場合に便利な関数です。

構文

mixed iconv_get_encoding($type = "all")

パラメータ

iconv_get_encoding()関数は、オプションのパラメータ$typeを1つだけ受け取ります。

$type − 指定できる値は以下の4種類です。

• all − すべての設定変数を配列で取得
• input_encoding − 入力エンコーディングを取得
• output_encoding − 出力エンコーディングを取得
• internal_encoding − 内部エンコーディングを取得

戻り値

iconv_get_encoding()関数は、成功した場合は内部設定変数の現在値を返し、失敗した場合はFalseを返します。$typeが指定されていない場合、またはallが設定されている場合は、すべての設定変数を格納した配列を返します。

例1: すべての設定変数を取得する

<pre>
   <?php
      iconv_set_encoding("internal_encoding", "UTF-8");
      iconv_set_encoding("output_encoding", "ISO-8859-1");
      var_dump(iconv_get_encoding('all'));
   ?>
</pre>

出力結果

array(3) {
   ["input_encoding"]=>
   string(5) "UTF-8"
   ["output_encoding"]=>
   string(10) "ISO-8859-1"
   ["internal_encoding"]=>
   string(5) "UTF-8"
}

解説 − 上記のPHPプログラムでは、iconv_get_encoding()の引数にallを指定しているため、入力エンコーディング、出力エンコーディング、内部エンコーディングの3つの設定値がすべて配列として出力されます。

例2: internal_encodingのみを取得する

<?php
   // 内部エンコーディングのみを取得
   iconv_set_encoding("internal_encoding", "UTF-8");
   var_dump(iconv_get_encoding('internal_encoding'));
?>

出力結果

string(5) "UTF-8"

解説 − この例では、引数にinternal_encodingのみを指定しているため、配列ではなく単一の文字列として内部エンコーディングの値「UTF-8」が返されます。特定の設定値だけを確認したい場合に有効な使い方です。

まとめ

iconv_get_encoding()関数は、iconv拡張機能の文字エンコーディング設定を簡単に確認できる便利な関数です。引数を省略するか「all」を指定すると全設定を配列で取得でき、個別の設定名を指定すればその値のみを取得できます。マルチバイト文字を扱うアプリケーションのデバッグや、エンコーディング設定の検証にぜひ活用してください。