【PHP8.x】strrchr()関数の使い方

Copy
1<?php
2
3/**
4 * PHPのmb_strrchr関数を用いた、マルチバイト文字列の検索と抽出のサンプルコードです。
5 * 指定された文字列が最後に現れる位置に基づき、文字列の一部を返します。
6 * システムエンジニアを目指す初心者向けに、基本的な使い方を示します。
7 */
8
9// mb_strrchr関数がマルチバイト文字（例: 日本語）を正しく処理できるよう、
10// 内部エンコーディングをUTF-8に設定します。
11mb_internal_encoding('UTF-8');
12
13/**
14 * mb_strrchr関数の使用例を示します。
15 * 検索対象の文字列 ($haystack) から、検索文字列 ($needle) が最後に現れる場所を検索し、
16 * その結果を標準出力に出力します。
17 *
18 * @param string $haystack 検索対象の文字列。
19 * @param string $needle 検索する文字列。
20 * @param bool $beforeNeedle trueの場合、$needleが見つかるまでの部分を返します。
21 *                           falseの場合、$needleが見つかった場所から文字列の最後までを返します。
22 * @return void
23 */
24function showMbStrrchrExample(string $haystack, string $needle, bool $beforeNeedle = false): void
25{
26    echo "--- 検索実行 ---" . PHP_EOL;
27    echo "  対象文字列: '" . $haystack . "'" . PHP_EOL;
28    echo "  検索文字列: '" . $needle . "'" . PHP_EOL;
29    echo "  before_needle: " . ($beforeNeedle ? "true (見つかるまで)" : "false (見つかったところから)") . PHP_EOL;
30
31    $result = mb_strrchr($haystack, $needle, $beforeNeedle);
32
33    if ($result === false) {
34        echo "  結果: 見つかりませんでした。" . PHP_EOL;
35    } else {
36        echo "  結果: '" . $result . "'" . PHP_EOL;
37    }
38    echo PHP_EOL; // 各例の間に空行を追加
39}
40
41// --- サンプルコードの実行 ---
42
43// 1. 基本的な使用例: 最後の「PHP」から文字列の終わりまでを抽出
44showMbStrrchrExample(
45    haystack: "こんにちは、PHPの世界！PHPは素晴らしい。",
46    needle: "PHP"
47);
48
49// 2. before_needle = true の使用例: 最後の「りんご」が見つかるまでの部分を抽出
50showMbStrrchrExample(
51    haystack: "りんご、みかん、ぶどう、りんご",
52    needle: "りんご",
53    beforeNeedle: true
54);
55
56// 3. 検索文字列が部分的に一致するマルチバイト文字を含む例
57showMbStrrchrExample(
58    haystack: "データ処理、データ分析、ビッグデータ",
59    needle: "データ"
60);
61
62// 4. 検索文字列が見つからない場合
63showMbStrrchrExample(
64    haystack: "Hello World",
65    needle: "Java"
66);
67
68// 5. 空の検索文字列の場合: $haystack全体が返されます (strrchr/mb_strrchrの挙動)
69showMbStrrchrExample(
70    haystack: "これはテストです。",
71    needle: ""
72);
73
74// 6. パス文字列からディレクトリ部分を抽出するような応用例
75showMbStrrchrExample(
76    haystack: "/var/www/html/index.php",
77    needle: "/",
78    beforeNeedle: true
79);

PHPのmb_strrchr関数は、指定されたマルチバイト文字列（日本語のような複数バイトで構成される文字）の中で、特定の文字列が最後に現れる場所を検索し、その位置から文字列の一部を抽出する際に使用されます。この関数は、mb_internal_encoding関数で内部エンコーディングを適切に設定することで、マルチバイト文字を正確に扱えます。

引数$haystackには検索対象の文字列、$needleには検索する文字列を指定します。オプションの引数$before_needleは、trueに設定すると$needleが見つかるまでの部分を返します。false（デフォルト）の場合は$needleが見つかった場所から文字列の最後までを返します。$needleが見つからない場合、この関数はfalseを返します。また、$needleが空文字列の場合、$haystack全体が返されます。

サンプルコードでは、様々なパターンでmb_strrchrの動作を確認できます。例えば、「PHPは素晴らしい。」という文字列から最後の「PHP」を見つけたり、ファイルのパスからディレクトリ部分を抽出したりする応用例も示しています。これにより、文字列処理におけるこの関数の基本的な使い方とその応用を理解できるようになっています。

Copy
1<?php
2
3/**
4 * 文字列の中で、指定された文字が最後に現れる位置から文字列の末尾までを返します。
5 *
6 * @param string $haystack 検索対象の文字列。
7 * @param string $needle   検索する文字。
8 * @return string|false    needle が見つかった場合は、needle が最後に現れる位置から haystack の末尾までの文字列を返します。
9 *                         needle が見つからなかった場合は、false を返します。
10 */
11function example_strrchr(string $haystack, string $needle): string|false
12{
13    $result = strrchr($haystack, $needle);
14
15    return $result;
16}
17
18// 使用例
19$haystack = "This is a simple example.";
20$needle = "i";
21
22$result = example_strrchr($haystack, $needle);
23
24if ($result !== false) {
25    echo "文字列 '$needle' が最後に現れる位置から末尾までの文字列: " . $result . PHP_EOL;
26} else {
27    echo "文字列 '$needle' は見つかりませんでした。" . PHP_EOL;
28}
29
30
31// before_needle = true の使用例
32function example_strrchr_before(string $haystack, string $needle): string|false
33{
34    $result = strrchr($haystack, $needle, true);
35
36    return $result;
37}
38
39$haystack = "This is a simple/example.php";
40$needle = "/";
41$result = example_strrchr_before($haystack, $needle);
42
43if ($result !== false) {
44    echo "文字列 '$needle' が最後に現れる位置の手前までの文字列: " . $result . PHP_EOL;
45} else {
46    echo "文字列 '$needle' は見つかりませんでした。" . PHP_EOL;
47}

strrchr関数は、文字列$haystackの中で、指定された文字$needleが最後に現れる位置から文字列の末尾までを抽出する関数です。システムエンジニアを目指す上で、ファイル名から拡張子を抽出したり、パスから特定のディレクトリ名を取得したりする際に役立ちます。

第一引数には検索対象となる文字列$haystackを指定します。第二引数には検索する文字$needleを文字列として指定します。PHP 8以降では、$needleに文字列全体を指定できるようになりました。オプションの第三引数$before_needleにtrueを指定すると、$needleが最後に現れる位置の手前までの文字列を返します。

関数は、$needleが$haystackの中で見つかった場合、$needleが最後に現れる位置から$haystackの末尾までの文字列を返します。$before_needleがtrueの場合は、$needleの手前までを返します。もし$needleが$haystackの中で見つからなかった場合は、falseを返します。

上記のサンプルコードでは、まずexample_strrchr関数で、文字列"This is a simple example."の中から、文字"i"が最後に現れる位置以降の文字列を抽出しています。次に、example_strrchr_before関数で、文字列"This is a simple/example.php"の中から、"/"が最後に現れる位置の手前までの文字列を抽出しています。抽出された文字列、または"見つかりませんでした"というメッセージが画面に出力されます。strrchr関数は、文字列操作において非常に便利なツールです。

Copy
1<?php
2
3/**
4 * PHPのstrrchr関数を使用して文字列を操作するサンプルコードです。
5 * strrchr関数は、指定した文字列（$haystack）内で、特定の文字または部分文字列（$needle）が
6 * 最後に出現する場所から、その位置を含む残りの文字列を返します。
7 * 第3引数にtrueを渡すと、$needleより前の部分を返します。
8 * $needleが見つからない場合はfalseを返します。
9 */
10
11// 元になる文字列を定義します。
12$fullString = "Hello world, this is a test string. Hello PHP!";
13echo "元の文字列: '{$fullString}'" . PHP_EOL . PHP_EOL;
14
15// --- 例1: 基本的な使い方 ---
16// 'Hello' が最後に出現する場所から文字列の最後までを取得します。
17$needle1 = "Hello";
18$result1 = strrchr($fullString, $needle1);
19
20echo "1. 検索文字 '{$needle1}' が最後に出現する場所から最後まで:" . PHP_EOL;
21if ($result1 !== false) {
22    echo "   結果: '{$result1}'" . PHP_EOL; // 出力: 'Hello PHP!'
23} else {
24    echo "   検索文字 '{$needle1}' は見つかりませんでした。" . PHP_EOL;
25}
26echo PHP_EOL;
27
28// --- 例2: 特定の文字で検索 ---
29// 's' が最後に出現する場所から文字列の最後までを取得します。
30$needle2 = "s";
31$result2 = strrchr($fullString, $needle2);
32
33echo "2. 検索文字 '{$needle2}' が最後に出現する場所から最後まで:" . PHP_EOL;
34if ($result2 !== false) {
35    echo "   結果: '{$result2}'" . PHP_EOL; // 出力: 'string. Hello PHP!'
36} else {
37    echo "   検索文字 '{$needle2}' は見つかりませんでした。" . PHP_EOL;
38}
39echo PHP_EOL;
40
41// --- 例3: 第3引数 $before_needle を true に設定 ---
42// 'is' が最後に出現する場所の「前」の部分を取得します。
43$needle3 = "is";
44$beforeNeedle = true; // trueに設定すると、$needleより前の部分を返します
45
46$result3 = strrchr($fullString, $needle3, $beforeNeedle);
47
48echo "3. 検索文字 '{$needle3}' が最後に出現する場所の「前」の部分 (before_needle = true):" . PHP_EOL;
49if ($result3 !== false) {
50    echo "   結果: '{$result3}'" . PHP_EOL; // 出力: 'Hello world, th'
51} else {
52    echo "   検索文字 '{$needle3}' は見つかりませんでした。" . PHP_EOL;
53}
54echo PHP_EOL;
55
56// --- 例4: 検索文字が見つからない場合 ---
57// 'xyz' は元の文字列に存在しないため、falseが返されます。
58$needle4 = "xyz";
59$result4 = strrchr($fullString, $needle4);
60
61echo "4. 検索文字 '{$needle4}' が見つからない場合:" . PHP_EOL;
62if ($result4 !== false) {
63    echo "   結果: '{$result4}'" . PHP_EOL;
64} else {
65    echo "   検索文字 '{$needle4}' は見つかりませんでした。" . PHP_EOL; // 出力される
66}
67
68?>

PHPのstrrchr関数は、指定した文字列（$haystack）内で、特定の文字または部分文字列（$needle）が最後に出現する位置を検索し、その位置から文字列の最後までを抽出する関数です。

第一引数$haystackには検索対象の元の文字列を、第二引数$needleには検索したい文字または部分文字列を指定します。第三引数$before_needleはオプションで、trueに設定すると$needleが見つかった位置の「前」の部分を返します。$needleが見つかった場合はその部分文字列が返され、見つからない場合はfalseが返されます。

サンプルコードでは、まず例1と例2で$needleが最後に出現する位置から文字列の末尾までを取得する基本的な使い方を示しています。例3では、$before_needleをtrueに設定し、$needleが見つかる「前」の部分を抽出する挙動を確認できます。例4では、$needleが見つからなかった場合にfalseが返されることを示しています。