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

<?php

/**
 * 日本語の文字列変換 (全角半角、ひらがなカタカナ) を mb_convert_kana で行うサンプルコード。
 * mbstring 拡張が有効でない場合に備え、function_exists でチェックを行い、初心者にも
 * 「mb_convert_kana が使えない」場合の対処法がわかるようにします。
 */
function demonstrateMbConvertKana(): void
{
    // mbstring 拡張がPHP環境で有効になっているかチェック
    // このチェックは、「mb_convert_kana が使えない」という問題の主な原因に対処します。
    if (!function_exists('mb_convert_kana')) {
        echo "エラー: mb_convert_kana 関数が利用できません。\n";
        echo "PHPの mbstring 拡張が有効になっていない可能性があります。\n";
        echo "php.ini ファイルで 'extension=mbstring' の行がコメントアウトされていないか確認し、\n";
        echo "必要であればコメントを解除してWebサーバーまたはPHP-FPMを再起動してください。\n";
        return;
    }

    // 変換対象のサンプル文字列
    $originalString = "ﾃｽﾄ 文字列１２３ａｂｃ、あいうえお、アイウエオ";
    echo "元文字列: " . $originalString . "\n\n";

    // モード 'KVna': 全角カタカナ・濁点付きカナ・全角数字・全角英字を半角に変換
    // 'K': 全角カタカナを半角カタカナに
    // 'V': 濁点付き全角カナを半角カナに (例: ガ -> ｶﾞ)
    // 'n': 全角数字を半角数字に
    // 'a': 全角英字を半角英字に
    $converted1 = mb_convert_kana($originalString, 'KVna', 'UTF-8');
    echo "モード 'KVna' (全角カナ・数字・英字を半角に): " . $converted1 . "\n";

    // モード 'H': 半角カタカナを全角カタカナに変換
    $halfWidthKana = "ﾊﾝｶｸ ﾃｽﾄ";
    $converted2 = mb_convert_kana($halfWidthKana, 'H', 'UTF-8');
    echo "モード 'H' (半角カタカナを全角に): " . $converted2 . "\n";

    // モード 'r': 全角ひらがなを全角カタカナに変換
    $hiraganaString = "ひらがな";
    $converted3 = mb_convert_kana($hiraganaString, 'r', 'UTF-8');
    echo "モード 'r' (ひらがなをカタカナに): " . $converted3 . "\n";

    // モード 'R': 全角カタカナを全角ひらがなに変換
    $katakanaString = "カタカナ";
    $converted4 = mb_convert_kana($katakanaString, 'R', 'UTF-8');
    echo "モード 'R' (カタカナをひらがなに): " . $converted4 . "\n";

    // モード 'AS': 半角英字・半角スペースを全角に変換
    // 'A': 半角英字を全角英字に
    // 'S': 半角スペースを全角スペースに
    $mixedString = "ABC 123 test";
    $converted5 = mb_convert_kana($mixedString, 'AS', 'UTF-8');
    echo "モード 'AS' (半角英字・スペースを全角に): " . $converted5 . "\n";
}

// 関数の実行
demonstrateMbConvertKana();

?>

mb_convert_kana関数は、文字列を指定されたルールに従って変換する関数です。第一引数$stringに変換したい文字列を、第二引数$modeに変換モードを文字列で指定します。第三引数$encodingは、文字列のエンコーディングを指定します。省略した場合は、内部エンコーディングが使用されます。

このサンプルコードでは、まずfunction_exists('mb_convert_kana')を使ってmb_convert_kana関数が利用可能かどうかを確認しています。これは、mbstring拡張モジュールが有効になっていない場合に、プログラムがエラーで停止するのを防ぐためです。もし関数が存在しない場合は、エラーメッセージを表示し、mbstring拡張モジュールを有効にする方法を案内します。

次に、いくつかの変換例を示しています。'KVna'モードでは、全角カタカナ、濁点付きのカナ、全角数字、全角英字を半角に変換します。'H'モードでは、半角カタカナを全角カタカナに変換します。'r'モードでは、全角ひらがなを全角カタカナに変換します。'R'モードでは、全角カタカナを全角ひらがなに変換します。'AS'モードでは、半角英字と半角スペースを全角に変換します。各変換結果は、echo文によって画面に出力されます。これらの例を通して、mb_convert_kana関数の様々な使用方法を理解することができます。戻り値は変換後の文字列です。

<?php

/**
 * mb_convert_kana を使用して文字列中の記号を変換するサンプル
 */
function convertSymbols(string $input, string $encoding = 'UTF-8'): string
{
    // 's' オプションは半角スペースを全角スペースに変換します。
    // 'k' オプションは半角カタカナを全角カタカナに変換します。
    // 'v' オプションは濁点付きの文字を1文字に変換します。
    // 'K' オプションは全角カタカナを半角カタカナに変換します。
    // 'V' オプションは濁点付きの文字を2文字に変換します。
    // 'h' オプションは全角ひらがなを半角カタカナに変換します。
    // 'H' オプションは半角カタカナを全角ひらがなに変換します。
    // 'c' オプションは全角カタカナを全角ひらがなに変換します。
    // 'C' オプションは全角ひらがなを全角カタカナに変換します。
    // 'n' オプションは全角数字を半角数字に変換します。
    // 'N' オプションは半角数字を全角数字に変換します。
    // 'a' オプションは全角英字を半角英字に変換します。
    // 'A' オプションは半角英字を全角英字に変換します。
    // 'S' オプションは半角記号を全角記号に変換します。

    $mode = 's'; // 半角スペースを全角スペースに変換
    $converted = mb_convert_kana($input, $mode, $encoding);
    return $converted;
}

// 使用例
$string = "半角ｽﾍﾟｰｽのある文。!@#$%^&*()_+=-`";
$convertedString = convertSymbols($string);

echo "変換前: " . $string . PHP_EOL;
echo "変換後: " . $convertedString . PHP_EOL;

PHPのmb_convert_kana関数は、文字列中の文字種を変換するために使用されます。この関数は、例えば半角カタカナを全角カタカナに、全角英数字を半角英数字に、あるいは全角スペースを半角スペースに変換するなど、多様なニーズに応えます。

関数は3つの引数を取ります。最初の引数は変換したい文字列を指定します。2番目の引数はモードを指定する文字列で、どのような変換を行うかを制御します。例えば、's'を指定すると半角スペースを全角スペースに、'S'を指定すると半角記号を全角記号に変換します。3番目の引数はオプションで、文字エンコーディングを指定します。通常は'UTF-8'を使用することが一般的です。関数は変換された文字列を戻り値として返します。

提示されたサンプルコードでは、convertSymbolsという関数がmb_convert_kanaを利用しています。この例では、's'モードが指定されているため、入力された文字列中の半角スペースが全角スペースに変換されます。たとえば、「半角ｽﾍﾟｰｽのある文。!@#$%^&*()_+=-」という文字列を渡すと、半角だったスペースが全角に変換された「半角　ｽﾍﾟｰｽのある文。!@#$%^&*()_+=-」のような出力が得られます。もし文字列に含まれる半角記号を全角記号に変換したい場合は、モードを'S'に変更することで対応できます。このように、mb_convert_kanaは引数で指定するモードによって、柔軟な文字列変換を実現します。