【PHP8.x】STR_PAD_BOTH定数の使い方

Copy
1<?php
2
3/**
4 * 文字列を左側にパディングするサンプルコードです。
5 * `str_pad` 関数を使用し、指定された文字列を目的の長さに、
6 * 指定されたパディング文字で左側から埋めます。
7 * `STR_PAD_LEFT` 定数はこのパディングの方向を指定するために使われます。
8 *
9 * @return void
10 */
11function padStringLeftExample(): void
12{
13    $originalString = "PHP";
14    $targetLength = 8;
15    $padCharacter = "-";
16
17    // str_pad 関数を使用して文字列を左側にパディングします。
18    // 第一引数: パディング対象の文字列
19    // 第二引数: 最終的な文字列の長さ
20    // 第三引数: パディングに使う文字（省略するとスペース）
21    // 第四引数: パディングの方向（STR_PAD_LEFT、STR_PAD_RIGHT、STR_PAD_BOTH）
22    $paddedString = str_pad($originalString, $targetLength, $padCharacter, STR_PAD_LEFT);
23
24    echo "元の文字列: " . $originalString . PHP_EOL;
25    echo "左側にパディングした結果: " . $paddedString . PHP_EOL; // 出力: -----PHP
26
27    // 参考: STR_PAD_BOTH 定数を使用すると、文字列が両側にパディングされます。
28    // 例: str_pad("PHP", 9, "_", STR_PAD_BOTH) は "__PHP__" のようになります。
29}
30
31// 関数を実行します。
32padStringLeftExample();

このサンプルコードは、PHPで文字列を指定された長さになるように埋める（パディングする）方法を示しています。特に、str_pad関数と、パディングの方向を指定する定数の使い方を学ぶことができます。

str_pad関数は、第一引数に指定された元の文字列を、第二引数で指定された目標の長さになるまで、第三引数の文字（省略するとスペース）で埋めます。この関数は、パディングされた新しい文字列を返します。

パディングの方向は第四引数で指定し、いくつかの定数を使用します。サンプルコードで使用されているSTR_PAD_LEFT定数は、文字列の左側にパディング文字を埋めることを指示します。例えば、"PHP"という文字列を8文字の長さになるように"-"で左詰めすると、「-----PHP」という結果が得られます。

本リファレンス情報に関連するSTR_PAD_BOTH定数は、str_pad関数の第四引数として使用することで、文字列を中央に配置するように両側を均等にパディングすることを指示します。例えば、str_pad("PHP", 9, "_", STR_PAD_BOTH)を実行すると「PHP」のように、左右にパディング文字が追加されます。STR_PAD_BOTH定数自体は引数を取らず、戻り値もありませんが、str_pad関数の挙動を制御する重要な役割を果たします。

これらの定数を使いこなすことで、レポート作成やデータ表示など、様々な場面で文字列をきれいに整形し、視認性を高めることが可能になります。

Copy
1<?php
2
3/**
4 * STR_PAD_BOTH 定数を使用して文字列を左右からパディングする例。
5 *
6 * str_pad() 関数は、文字列を指定された長さまでパディング（埋める）ために使用されます。
7 * STR_PAD_BOTH 定数を指定すると、文字列の左右が均等になるようにパディングされます。
8 * もし左右に均等に分けられない場合（パディング文字の総数が奇数）、
9 * 右側が1文字多くパディングされます。
10 */
11function demonstrateStrPadBoth(): void
12{
13    // 元の文字列
14    $inputString = "Hello";
15    // 目標の文字列の長さ
16    $padLength = 10;
17    // パディングに使用する文字
18    $padChar = "-";
19
20    echo "元の文字列: '{$inputString}'\n";
21    echo "目標の長さ: {$padLength}\n";
22    echo "パディング文字: '{$padChar}'\n";
23
24    // STR_PAD_BOTH を使用して文字列を左右からパディング
25    // $inputString = "Hello" (5文字)
26    // 目標 $padLength = 10文字
27    // パディングが必要な文字数 = 10 - 5 = 5文字
28    // STR_PAD_BOTH は左右に均等に割り振ろうとしますが、5は均等に分かれないため、
29    // 左に2文字、右に3文字がパディングされます。
30    $paddedString = str_pad($inputString, $padLength, $padChar, STR_PAD_BOTH);
31    echo "パディング後の文字列 (STR_PAD_BOTH): '{$paddedString}'\n\n";
32
33    // 別の例：パディング文字の総数が偶数の場合
34    $inputString2 = "PHP"; // 3文字
35    $padLength2 = 9; // 目標の長さ
36    $padChar2 = "*";
37    echo "別の例:\n";
38    echo "元の文字列: '{$inputString2}'\n";
39    echo "目標の長さ: {$padLength2}\n";
40    echo "パディング文字: '{$padChar2}'\n";
41    // パディングが必要な文字数 = 9 - 3 = 6文字
42    // STR_PAD_BOTH は左右に3文字ずつパディングします。
43    $paddedString2 = str_pad($inputString2, $padLength2, $padChar2, STR_PAD_BOTH);
44    echo "パディング後の文字列 (STR_PAD_BOTH): '{$paddedString2}'\n";
45}
46
47// 関数を実行して動作を確認します
48demonstrateStrPadBoth();
49

PHPのSTR_PAD_BOTHは、文字列を指定された長さに整形するstr_pad()関数で使用される定数です。この定数を使うと、文字列の左右から均等にパディング（埋め合わせ）文字を追加することができます。

str_pad()関数は、第一引数に元の文字列、第二引数に最終的な目標の文字列の長さ、第三引数にパディングに使う文字、そして第四引数にパディングの方向を指定する定数を渡します。この関数は、パディングされた新しい文字列を戻り値として返しますが、元の文字列自体は変更しません。

STR_PAD_BOTH定数を指定した場合、必要なパディング文字が左右に均等に割り振られます。もし、追加が必要なパディング文字の総数が奇数で、左右に完全に均等に分けることができない場合は、右側に1文字多くパディング文字が追加されます。

例えば、サンプルコードの最初の例では、「Hello」という5文字の文字列を合計10文字にするため、「-」でパディングします。必要なパディング文字は5文字で奇数のため、左に2文字、右に3文字が追加され、「--Hello---」という結果になります。

別の例では、「PHP」という3文字の文字列を合計9文字にするため、「*」でパディングします。この場合、必要なパディング文字は6文字で偶数なので、左右に3文字ずつ均等に追加され、「PHP」という結果が得られます。このように、STR_PAD_BOTHを使用することで、文字列を中央に揃えるような形で簡単に整形できます。