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

Copy
1<?php
2
3/**
4 * preg_split() 関数と PREG_SPLIT_NO_EMPTY 定数の使用例を示します。
5 *
6 * PREG_SPLIT_NO_EMPTY 定数は、preg_split() 関数の結果配列から空の要素を自動的に除去するために使用されます。
7 * これにより、複数の区切り文字が連続する場合や、文字列の先頭・末尾に区切り文字がある場合に
8 * 発生しがちな不要な空文字列の要素を取り除くことができます。
9 */
10function demonstratePregSplitNoEmpty(): void
11{
12    // 例1: 連続する区切り文字がある文字列
13    // "apple,,banana, orange" のように、カンマが連続している部分があります。
14    $text1 = "apple,,banana, orange";
15    // カンマまたはスペースが1回以上続くパターンを区切り文字とします。
16    $pattern1 = '/[, ]+/';
17
18    echo "--- 例1: 連続する区切り文字 --- \n";
19    echo "元の文字列: '" . $text1 . "'\n";
20    echo "使用するパターン: '" . $pattern1 . "'\n\n";
21
22    // PREG_SPLIT_NO_EMPTY なしの場合
23    // デフォルトでは、連続する区切り文字によって空の要素が生成される可能性があります。
24    echo "--- PREG_SPLIT_NO_EMPTY なしの場合 ---\n";
25    $resultWithoutFlag1 = preg_split($pattern1, $text1);
26    echo "分割結果:\n";
27    print_r($resultWithoutFlag1);
28    echo "\n";
29
30    // PREG_SPLIT_NO_EMPTY ありの場合
31    // 空の要素が自動的に除去され、意味のある部分文字列のみが残ります。
32    echo "--- PREG_SPLIT_NO_EMPTY ありの場合 ---\n";
33    // preg_split() の第3引数 (limit) は -1 (制限なし) を指定し、第4引数 (flags) に定数を渡します。
34    $resultWithFlag1 = preg_split($pattern1, $text1, -1, PREG_SPLIT_NO_EMPTY);
35    echo "分割結果:\n";
36    print_r($resultWithFlag1);
37    echo "\n";
38
39    echo "-------------------------------------\n\n";
40
41    // 例2: 文字列の先頭や末尾、または連続した区切り文字がある文字列
42    // ",red,green,,blue," のように、先頭、末尾、連続するカンマがあります。
43    $text2 = ",red,green,,blue,";
44    // カンマ1つを区切り文字とします。
45    $pattern2 = '/,/';
46
47    echo "--- 例2: 先頭、末尾、連続する区切り文字 --- \n";
48    echo "元の文字列: '" . $text2 . "'\n";
49    echo "使用するパターン: '" . $pattern2 . "'\n\n";
50
51    // PREG_SPLIT_NO_EMPTY なしの場合
52    // 先頭や末尾の区切り文字、または連続する区切り文字によって空の要素が生成されます。
53    echo "--- PREG_SPLIT_NO_EMPTY なしの場合 ---\n";
54    $resultWithoutFlag2 = preg_split($pattern2, $text2);
55    echo "分割結果:\n";
56    print_r($resultWithoutFlag2);
57    echo "\n";
58
59    // PREG_SPLIT_NO_EMPTY ありの場合
60    // これらの空の要素も全て除去され、データ部分のみが抽出されます。
61    echo "--- PREG_SPLIT_NO_EMPTY ありの場合 ---\n";
62    $resultWithFlag2 = preg_split($pattern2, $text2, -1, PREG_SPLIT_NO_EMPTY);
63    echo "分割結果:\n";
64    print_r($resultWithFlag2);
65    echo "\n";
66}
67
68// 関数を実行して、preg_split() と PREG_SPLIT_NO_EMPTY の動作を確認します。
69demonstratePregSplitNoEmpty();

PHPのPREG_SPLIT_NO_EMPTY定数は、preg_split()関数で文字列を正規表現に基づいて分割する際に、結果として生じる空の要素を自動的に除去するために使用されます。preg_split()関数は、第一引数に正規表現パターン、第二引数に分割対象の文字列を指定し、分割された部分文字列の配列を返します。通常、連続する区切り文字や文字列の先頭・末尾に区切り文字がある場合、空の要素が結果配列に含まれることがあります。

この定数をpreg_split()関数の第4引数（フラグ）として指定すると、これらの不要な空文字列がすべて取り除かれます。例えば、サンプルコードの例1では、文字列「apple,,banana, orange」を複数のカンマやスペースで分割する際、PREG_SPLIT_NO_EMPTYなしでは空の要素が含まれますが、定数を使用すると「apple」「banana」「 orange」のように意味のある要素だけが抽出されます。同様に、例2の文字列「,red,green,,blue,」のような先頭・末尾・連続する区切り文字がある場合でも、余分な空要素が除去され、データ処理が容易になります。この定数自体は引数を持たず、戻り値もありませんが、preg_split()関数の挙動を制御する重要な役割を果たし、意図しない空文字列の発生を防ぐことで、配列の扱いやすさを向上させます。

Copy
1<?php
2
3// 対象となる文字列を定義します。
4// 複数のスペースや先頭、末尾のスペースが含まれる場合に、
5// PREG_SPLIT_NO_EMPTY の効果が分かりやすくなります。
6$text = "  Hello   PHP world! This is a test.  ";
7
8// preg_split() 関数を使用して、空白文字で文字列を分割します。
9//
10// 第一引数: 分割の区切りとなる正規表現。ここでは '\s+' が1つ以上の空白文字にマッチします。
11// 第二引数: 分割する対象の文字列。
12// 第三引数: limit。-1は制限なしを意味します。
13// 第四引数: flags。ここに PREG_SPLIT_NO_EMPTY を指定することで、
14//           分割結果の配列から空の文字列要素を除外します。
15//           例えば、"a  b" をスペースで分割すると通常 ["a", "", "b"] となりますが、
16//           このフラグを使用すると ["a", "b"] となります。
17$words = preg_split('/\s+/', $text, -1, PREG_SPLIT_NO_EMPTY);
18
19// 分割された結果を表示します。
20echo "元の文字列: " . $text . "\n";
21echo "PREG_SPLIT_NO_EMPTY を使用して空白文字で分割した結果:\n";
22print_r($words);
23
24?>

PREG_SPLIT_NO_EMPTYは、PHP 8で利用可能な正規表現関連の定数です。これは、主に文字列を正規表現で分割するpreg_split()関数と組み合わせて使用されます。

この定数の主な役割は、preg_split()関数で文字列を分割した際に、結果として生じる空の文字列要素を配列から除外することです。例えば、複数の区切り文字が連続する場合や、文字列の先頭や末尾に区切り文字がある場合、通常は空の文字列が結果配列に含まれることがあります。PREG_SPLIT_NO_EMPTYを指定することで、これらの不要な空要素が自動的に取り除かれ、より整理された分割結果が得られます。

サンプルコードでは、$text変数に定義された「 Hello PHP world! This is a test. 」という文字列を対象にしています。preg_split()関数の第四引数（flags）にPREG_SPLIT_NO_EMPTYを指定することで、連続するスペースや文字列の先頭・末尾のスペースによって発生するはずの空の文字列要素が、分割後の配列$wordsには含まれていません。結果として、意味のある単語のみが格納された配列が生成され、表示されています。

PREG_SPLIT_NO_EMPTY自体は定数であるため、引数を取らず、特定の値を直接返すこともありません。これはpreg_split()関数の動作を制御する「フラグ」として機能し、関数の挙動に影響を与えるものです。