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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 文字列に含まれる各文字の出現回数を数えて表示します。
7 *
8 * この関数は、PHPの `count_chars()` を使用して、
9 * 指定された文字列内に各文字が何回出現するかを計算し、
10 * その結果をコンソールに出力します。
11 *
12 * @param string $text 解析対象の文字列。
13 */
14function displayCharacterFrequency(string $text): void
15{
16    echo "解析する文字列: \"{$text}\"" . PHP_EOL;
17    echo "-------------------------" . PHP_EOL;
18
19    // count_chars() をモード1で使用します。
20    // モード1は、キーに文字のASCIIコード、値に出現回数を持つ連想配列を返します。
21    // このモードでは、一度も出現しなかった文字は結果に含まれません。
22    $charCounts = count_chars($text, 1);
23
24    // 連想配列をループ処理し、結果を分かりやすく表示します。
25    foreach ($charCounts as $asciiCode => $count) {
26        // chr()関数でASCIIコードを実際の文字に変換します。
27        $character = chr($asciiCode);
28        echo "'{$character}' は {$count} 回出現しました。" . PHP_EOL;
29    }
30}
31
32// 解析したい文字列を定義します。
33$sampleString = "Hello, world of PHP 8!";
34
35// 関数を呼び出して、文字列の文字出現回数を表示します。
36displayCharacterFrequency($sampleString);
37
38?>

このサンプルコードは、PHPのcount_chars関数を使用して、指定した文字列に含まれる各文字の出現回数を数える方法を示しています。count_chars関数は、第一引数に解析したい文字列を、第二引数に処理の挙動を決定するモード番号を受け取ります。

コード内のdisplayCharacterFrequency関数では、count_chars関数の第二引数にモード1を指定しています。モード1を指定すると、戻り値として「キーが文字のASCIIコード、値がその文字の出現回数」となる連想配列が返されます。この際、文字列中に一度も出現しなかった文字は、結果の配列に含まれません。

関数が返す連想配列は$charCounts変数に格納された後、foreachループで処理されます。ループ内では、キーであるASCIIコードをchr関数によって人間が読める文字に変換し、値である出現回数と組み合わせて画面に出力しています。この処理により、「'H' は 1 回出現しました。」のように、どの文字が何回使われているかの一覧が分かりやすく表示されます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 文字列内に含まれる各文字の出現回数を数えます。
7 *
8 * この関数は、PHPの組み込み関数 `count_chars` を使用して、
9 * 指定された文字列中の各文字（バイト）が何回出現するかを計算し、
10 * 文字をキー、出現回数を値とする連想配列として返します。
11 *
12 * @param string $text 解析対象の文字列。
13 * @return array<string, int> 文字とその出現回数を格納した連想配列。
14 */
15function getCharacterFrequencies(string $text): array
16{
17    // count_chars($text, 1) は、文字列に出現する文字の出現回数を返します。
18    // キーは文字のASCII値、値は出現回数です。
19    // 例: 'a' が1回出現 -> [97 => 1]
20    $byteValueCounts = count_chars($text, 1);
21
22    $charCounts = [];
23    // 連想配列をループし、ASCII値のキーを実際の文字に変換します。
24    foreach ($byteValueCounts as $byteValue => $count) {
25        // chr() 関数はASCII値を文字に変換します。
26        $char = chr($byteValue);
27        $charCounts[$char] = $count;
28    }
29
30    return $charCounts;
31}
32
33// --- 実行コード ---
34
35// 解析したい文字列を定義します。
36$sampleString = 'Hello, World! This is a test.';
37
38// 関数を呼び出して文字の出現回数を取得します。
39$frequencies = getCharacterFrequencies($sampleString);
40
41// 結果を画面に出力します。
42echo "文字列: \"{$sampleString}\"\n";
43echo "----------------------------------\n";
44echo "各文字の出現回数:\n";
45
46foreach ($frequencies as $character => $count) {
47    // スペース文字は分かりにくいので、明示的に表示します。
48    $displayChar = ($character === ' ') ? "' ' (スペース)" : "'{$character}'";
49    echo "{$displayChar}: {$count}回\n";
50}
51
52?>

このPHPサンプルコードは、count_chars関数を利用して、文字列内に含まれる各文字の出現回数を数える方法を示しています。

count_chars関数は、第1引数に解析対象の文字列を、第2引数に処理の形式を指定する$modeを受け取ります。このコードでは$modeに1を指定しています。これにより、文字列中に出現した文字のバイト値（文字コード）をキーとし、その出現回数を値とする連想配列が返されます。例えば、'a'が1回出現した場合、キーが97（'a'の文字コード）、値が1となります。

しかし、キーが数値のままでは直感的に分かりにくいため、getCharacterFrequenciesという独自の関数内でひと手間加えています。foreachループでcount_chars関数の結果を一つずつ処理し、chr関数を使ってキーであるバイト値を実際の文字に変換しています。そして、文字をキー、出現回数を値とする、より人間が理解しやすい新しい連想配列を再構築して返します。

最後に、この関数を使って得られた結果を画面に分かりやすく表示しています。