【PHP8.x】mb_convert_variables関数の使い方

Copy
1<?php
2
3/**
4 * mb_convert_variables を使用して、複数の変数の文字エンコーディングを変換するサンプル.
5 *
6 * @param string $toEncoding 変換先の文字エンコーディング.
7 * @param string|array $fromEncoding 変換元の文字エンコーディング (配列で複数指定可能).
8 * @param mixed ...$vars 変換対象の変数 (参照渡し).
9 * @return mixed 変換に成功した場合は変換後の変数、失敗した場合は false.
10 */
11function convertVariables(string $toEncoding, string|array $fromEncoding, mixed &...$vars): mixed
12{
13    $result = mb_convert_variables($toEncoding, $fromEncoding, ...$vars);
14
15    if ($result === false) {
16        error_log('文字エンコーディングの変換に失敗しました。');
17        return false;
18    }
19
20    return $vars; // 変換後の変数を返す
21}
22
23// 例:
24$encoding = 'UTF-8';
25$name = '山田太郎（やまだたろう）';
26$comment = 'こんにちは。文字化け対策のテストです。';
27
28// 変数のエンコーディングを SJIS-win から UTF-8 に変換
29$result = convertVariables($encoding, 'SJIS-win', $name, $comment);
30
31if ($result !== false) {
32    echo "名前: " . $name . PHP_EOL;
33    echo "コメント: " . $comment . PHP_EOL;
34} else {
35    echo "変換に失敗しました。" . PHP_EOL;
36}
37

mb_convert_variables関数は、複数の変数の文字エンコーディングを一括で変換する際に使用します。この関数を利用することで、個々の変数に対して変換処理を行う手間を省き、コードを簡潔に保つことができます。

引数 $to_encoding には、変換先の文字エンコーディングを指定します。例えば、'UTF-8'や'EUC-JP'などを指定します。引数 $from_encoding には、変換元の文字エンコーディングを指定します。これは文字列または文字列の配列で指定可能です。複数のエンコーディングが考えられる場合に有効です。引数 $vars には、変換対象となる変数を可変長引数として指定します。重要な点として、これらの変数は参照渡しであるため、関数内で値が直接変更されます。

サンプルコードでは、convertVariables関数を作成し、mb_convert_variables関数をラップしています。convertVariables関数は、指定されたエンコーディングに基づいて、引数として渡された $name と $comment 変数のエンコーディングを SJIS-win から UTF-8 に変換します。変換に成功した場合、変換後の変数の値が出力されます。変換に失敗した場合は、エラーメッセージが表示されます。

mb_convert_variables関数は、戻り値として変換後の変数を返しません。変換が成功した場合は変換対象の変数が直接変更され、失敗した場合は false を返します。サンプルコードでは、この戻り値を確認し、変換の成否を判断しています。