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

Copy
1<?php
2
3// chunk_split() function demonstrates how to split a string into smaller chunks.
4// This is useful for formatting data, like ensuring lines don't exceed a certain length
5// (e.g., in email headers, fixed-width text files, or data encoding).
6
7// Define an example string to be chunked.
8$longText = "This is a very long string that needs to be broken into smaller, manageable pieces. It could represent encoded data, a message body, or any text requiring length constraints for display or transmission.";
9
10// --- Example 1: Basic usage with default parameters ---
11// The string is split into chunks of 76 characters, with each chunk
12// followed by a carriage return and a newline character ("\r\n").
13echo "--- Output with default chunk_split (length 76, separator '\\r\\n') ---\n";
14echo chunk_split($longText);
15echo "\n"; // Add an extra newline for better separation in console output
16
17// --- Example 2: Custom chunk length ---
18// The string is split into chunks of 10 characters. The separator remains the default ("\r\n").
19echo "--- Output with custom chunk length (10 characters) ---\n";
20echo chunk_split($longText, 10);
21echo "\n";
22
23// --- Example 3: Custom chunk length and custom separator ---
24// The string is split into chunks of 5 characters, with each chunk
25// followed by a hyphen ("-").
26echo "--- Output with custom chunk length (5 characters) and custom separator ('-') ---\n";
27echo chunk_split($longText, 5, '-');
28echo "\n";
29
30// --- Example 4: Custom chunk length and a different custom separator ---
31// The string is split into chunks of 20 characters, with each chunk
32// followed by a pipe and space (" | ").
33echo "--- Output with custom chunk length (20 characters) and custom separator (' | ') ---\n";
34echo chunk_split($longText, 20, ' | ');
35echo "\n";
36
37?>

PHPのchunk_split関数は、長い文字列を指定された長さの「チャンク（塊）」に分割し、各チャンクの終わりに特定の区切り文字を挿入する際に利用される関数です。この関数は、特に文字列を特定のフォーマットに整形する必要がある場合や、行の長さに制限を設けたい場合に役立ちます。

引数には、まず分割したい元の文字列（$string）を指定します。次に、1つのチャンクの最大長さを整数値（$length）で指定でき、デフォルトでは76文字が設定されています。最後に、各チャンクの後に挿入される区切り文字（$separator）を指定します。この区切り文字のデフォルトは、改行コードである"\r\n"です。この関数を実行すると、分割され区切り文字が挿入された新しい文字列が戻り値として返されます。

サンプルコードでは、いくつかの使用例が示されています。最初の例では、chunk_split関数を引数なしで呼び出し、デフォルトの76文字で区切り、改行コードを挿入する挙動を確認できます。次の例では、$length引数に10を指定し、10文字ごとに文字列を分割しています。さらに、$lengthに5、$separatorにハイフン（-）を指定することで、5文字ごとにハイフンで区切るなど、カスタムの長さと区切り文字を設定できることを示しています。このように、メールヘッダの整形や固定幅のテキストデータ生成など、文字列の表示や伝送の要件に応じて柔軟に利用できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 画像ファイルの内容をBase64エンコードし、
7 * RFC 2045 (MIME) に準拠する形で76文字ごとに分割して出力します。
8 *
9 * `base64_encode` された長い文字列は、メールなどで安全に転送するために
10 * `chunk_split` で分割されることがよくあります。
11 */
12function createMimeCompliantBase64String(): void
13{
14    // ダミーの画像データを作成します (実際は file_get_contents('image.png') などで読み込みます)
15    // この文字列は "これはテスト用の画像データです。" を表します。
16    $imageData = hex2bin('e38193e3828ce381afe38386e382b9e38388e794a8e381aee794bbe5838fe38387e383bce382bfe381a7e38199e38082');
17
18    // データをBase64エンコードします
19    $base64Encoded = base64_encode($imageData);
20
21    // エンコードされた文字列を76文字ごとに "\r\n" で分割します
22    // 第2引数: 分割する文字数 (デフォルトは76)
23    // 第3引数: 区切り文字 (デフォルトは "\r\n")
24    $chunkedString = chunk_split($base64Encoded);
25
26    // 結果を出力します
27    echo "--- Base64エンコード後の文字列（分割前）---\n";
28    echo $base64Encoded . "\n\n";
29
30    echo "--- chunk_splitで76文字ごとに分割後の文字列 ---\n";
31    echo $chunkedString;
32}
33
34// 関数を実行
35createMimeCompliantBase64String();

PHPのchunk_split関数は、指定した文字列を一定の文字数ごとに区切り、その間に特定の文字列（区切り文字）を挿入するための関数です。戻り値として、区切り文字が挿入された新しい文字列を返します。

このサンプルコードでは、まずbase64_encode関数を使ってバイナリデータ（ここではダミーの画像データ）を、メールなどで安全に転送可能なテキスト形式の長い文字列に変換しています。しかし、エンコードされた文字列は改行を含まないため、そのままでは非常に長い一行の文字列になってしまいます。

そこでchunk_split関数を使用し、この長い文字列を整形します。第1引数に分割したい文字列（$base64Encoded）を指定します。第2引数（分割する文字数）と第3引数（区切り文字）は省略されているため、デフォルト値が適用されます。具体的には、76文字ごとに"\r\n"という改行コードが挿入されます。この「76文字で改行」というルールは、MIME（マイム）というメールの仕様で定められた標準的な形式に準拠するためのものです。

この処理により、元の長い一行の文字列が、メールなどで正しく扱える複数行のテキストに変換されます。

Copy
1<?php
2
3/**
4 * PHPのchunk_split関数の使用例。
5 * この関数は、長い文字列を特定の長さごとに分割し、
6 * 各チャンクの終わりに指定された区切り文字を挿入します。
7 * システムエンジニアを目指す初心者向けに、基本的な使い方を示します。
8 */
9
10// 処理対象となる長い文字列を定義します。
11$originalString = "PHPのchunk_split関数は、特に固定長のデータブロックを処理する場合や、表示のために文字列を整形する場合に非常に役立ちます。例えば、Base64エンコードされた文字列をRFCで推奨されている76文字ごとに改行で区切る、といった用途で使われることがあります。";
12
13echo "--- 元の文字列 ---\n";
14echo $originalString . "\n\n";
15
16// chunk_split関数を使用して文字列を分割します。
17// 引数:
18// 1. $originalString: 分割対象の文字列
19// 2. 15: 各チャンクの最大文字数
20// 3. " | ": 各チャンクの終わりに挿入する区切り文字
21$chunkedStringWithCustomSeparator = chunk_split($originalString, 15, " | ");
22
23echo "--- 15文字ごとに ' | ' で区切った文字列 ---\n";
24echo $chunkedStringWithCustomSeparator . "\n\n";
25
26// 引数の一部を省略した場合の例。
27// length (チャンクの最大文字数) のみを指定し、separator (区切り文字) はデフォルト値(\r\n、つまり改行)を使用します。
28$chunkedStringWithDefaultSeparator = chunk_split($originalString, 25);
29
30echo "--- 25文字ごとにデフォルトの改行で区切った文字列 ---\n";
31echo $chunkedStringWithDefaultSeparator . "\n";
32
33?>

PHPのchunk_split関数は、長い文字列を指定した文字数ごとの塊（チャンク）に分割し、それぞれの塊の間に特定の区切り文字を挿入するための関数です。

第一引数の$stringには、処理対象となる文字列を渡します。第二引数の$lengthには、分割する文字数を整数で指定します。この引数は省略可能で、その場合のデフォルト値は76です。第三引数の$separatorには、各チャンクの末尾に挿入する文字列を指定します。こちらも省略可能で、デフォルトでは改行コード（\r\n）が使用されます。処理が完了すると、分割されて区切り文字が挿入された新しい文字列が戻り値として返されます。

サンプルコードでは、2つの使用例を示しています。最初の例では、元の文字列を15文字ごとに分割し、区切り文字として「 | 」を挿入しています。2つ目の例では、第三引数を省略しているため、25文字ごとにデフォルトの区切り文字である改行コードが挿入されています。このように、chunk_split関数は、可読性のために文字列を整形したり、特定のフォーマットに合わせてデータを分割したりする際に役立ちます。