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

Copy
1<?php
2
3// str_repeat関数の基本的な使い方を示すサンプルコード
4
5/**
6 * str_repeat関数は、指定した文字列を複数回繰り返して新しい文字列を生成します。
7 *
8 * str_repeat(string $string, int $times): string
9 * $string: 繰り返したい文字列
10 * $times: 文字列を繰り返す回数（非負の整数）
11 */
12
13// 例1: 簡単な文字列を繰り返す
14$originalString1 = "Hello";
15$repeatCount1 = 3;
16$repeatedString1 = str_repeat($originalString1, $repeatCount1);
17echo "例1: \"{$originalString1}\" を {$repeatCount1} 回繰り返すと: {$repeatedString1}\n"; // 出力: HelloHelloHello
18
19// 例2: スペースを含む文字列を繰り返す
20$originalString2 = "PHP ";
21$repeatCount2 = 5;
22$repeatedString2 = str_repeat($originalString2, $repeatCount2);
23echo "例2: \"{$originalString2}\" を {$repeatCount2} 回繰り返すと: {$repeatedString2}\n"; // 出力: PHP PHP PHP PHP PHP 
24
25// 例3: 区切り線のような短い文字列を多く繰り返す
26$originalString3 = "-";
27$repeatCount3 = 20;
28$repeatedString3 = str_repeat($originalString3, $repeatCount3);
29echo "例3: \"{$originalString3}\" を {$repeatCount3} 回繰り返すと: {$repeatedString3}\n"; // 出力: --------------------
30
31// 例4: 繰り返し回数が0の場合、空の文字列が返されます
32$originalString4 = "Test";
33$repeatCount4 = 0;
34$repeatedString4 = str_repeat($originalString4, $repeatCount4);
35echo "例4: \"{$originalString4}\" を {$repeatCount4} 回繰り返すと: \"{$repeatedString4}\" (空文字列)\n"; // 出力: "" (空文字列)
36
37?>

str_repeat関数は、指定した文字列を、指定した回数だけ繰り返して連結し、新しい文字列を生成するためのPHP関数です。この関数は2つの引数を取ります。第一引数には繰り返しの元となる文字列を指定し、第二引数にはその文字列を何回繰り返すかを0以上の整数で指定します。関数の戻り値は、指定回数分繰り返された結果の文字列です。

サンプルコードでは、いくつかの具体的な使用例が示されています。例1では「Hello」を3回繰り返し、「HelloHelloHello」という文字列を得ています。例2のようにスペースを含む文字列を繰り返すこともできます。また、例3ではハイフン「-」を多数繰り返して区切り線を作成しており、テキストの整形などに役立ちます。

特に注意すべき点として、例4のように繰り返し回数に0を指定した場合は、何も繰り返されないため、結果として空の文字列が返されます。このようにstr_repeat関数は、決まったパターンの文字列をプログラムで簡単に生成したい場合に非常に便利な関数です。

Copy
1<?php
2
3/**
4 * 指定された回数だけ半角スペースを繰り返し、テキストの前にインデントとして追加します。
5 *
6 * この関数は、リストやコードブロックのような階層構造を持つテキストを
7 * 整形して表示する際に便利です。
8 *
9 * @param string $text   インデントを付けたいテキスト。
10 * @param int    $level  インデントの深さ（スペースの数）。
11 * @return string インデントが追加されたテキスト。
12 */
13function createIndentedText(string $text, int $level): string
14{
15    // str_repeat() を使用して、半角スペース(' ')を $level 回繰り返す。
16    // 繰り返す回数として0を指定した場合、空文字列が返されます。
17    $indentation = str_repeat(' ', $level);
18
19    // 生成されたインデント（スペース文字列）と元のテキストを連結して返す。
20    return $indentation . $text;
21}
22
23// --- 関数の使用例 ---
24
25// インデントレベルが異なるテキストを生成して表示します。
26echo createIndentedText('Top level item.', 0) . PHP_EOL;
27echo createIndentedText('Second level item.', 4) . PHP_EOL;
28echo createIndentedText('Third level item.', 8) . PHP_EOL;
29
30/*
31--- 実行結果 ---
32
33Top level item.
34    Second level item.
35        Third level item.
36
37*/
38

PHPのstr_repeat関数は、指定した文字列を、指定した回数だけ繰り返した新しい文字列を生成する関数です。

この関数は2つの引数を取ります。第1引数には、繰り返したい文字列を指定します。サンプルコードでは、インデントを作成するために半角スペース（' '）が指定されています。第2引数には、その文字列を何回繰り返すかを整数で指定します。もし、この繰り返す回数として0を指定した場合は、何も繰り返されないため、空の文字列が返されます。関数の戻り値は、第1引数の文字列が第2引数の回数分だけ連結された新しい文字列です。

サンプルコードのcreateIndentedText関数では、このstr_repeat関数を利用して、インデント（字下げ）を実現しています。第2引数で受け取った$levelの数だけ半角スペースを繰り返し、それを元のテキストの前に連結することで、階層構造を持つテキストを整形しています。実行結果からも、$levelの数値が大きくなるにつれて、行頭のスペースが増えていることが確認できます。このようにstr_repeatは、テキストのフォーマットを整える際などに非常に便利な関数です。