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

<?php

/**
 * preg_grepを使用して配列から特定のパターンの要素を抽出するサンプルです。
 *
 * この関数は、ファイル名の配列から正規表現を使い、
 * ログファイル（.logで終わるファイル）のみを抽出する例と、
 * ログファイル以外のファイルを抽出する例（PREG_GREP_INVERTフラグ使用）を示します。
 */
function demonstratePregGrep(): void
{
    // サンプルデータとして、様々なファイル名を含む配列を用意します。
    $fileList = [
        0 => 'access.log',
        1 => 'error.log',
        2 => 'index.php',
        3 => 'style.css',
        4 => 'debug.log.2023-10-26',
        5 => 'README.md',
    ];

    // '.log' で終わる文字列にマッチする正規表現パターンを定義します。
    // '$' は文字列の末尾を意味します。
    $pattern = '/\.log$/';

    // preg_grep() を使用して、配列からパターンにマッチする要素だけを抽出します。
    // マッチした要素のキーは元の配列から維持されます。
    $logFiles = preg_grep($pattern, $fileList);

    echo "■ '.log' で終わるファイル:\n";
    print_r($logFiles);
    echo "\n";

    // 第3引数に PREG_GREP_INVERT フラグを指定すると、
    // パターンに「マッチしなかった」要素を抽出できます。
    $nonLogFiles = preg_grep($pattern, $fileList, PREG_GREP_INVERT);

    echo "■ '.log' で終わらないファイル (PREG_GREP_INVERT を使用):\n";
    print_r($nonLogFiles);
}

// 関数を実行して結果を表示します。
demonstratePregGrep();

?>

PHPのpreg_grep関数は、配列の各要素に対して正規表現による検索を行い、パターンに一致した要素だけを抽出して新しい配列として返す関数です。

第1引数には、検索条件となる正規表現パターンを文字列で指定します。このサンプルでは「.logで終わる文字列」というパターンが使われています。第2引数には、検索対象となる配列を渡します。

関数の戻り値は、パターンに一致した要素を含む新しい配列です。このとき、元の配列のキー（添字）がそのまま維持される点が特徴です。処理中にエラーが発生した場合は、配列の代わりにfalseが返されます。

このサンプルコードでは、まずファイル名が格納された配列から、正規表現を使って.logで終わる要素（ログファイル）だけを抽出しています。次に、オプションである第3引数にPREG_GREP_INVERTフラグを指定しています。このフラグを使用すると結果が反転し、パターンに「一致しなかった」要素、つまりログファイル以外のファイルが抽出されます。このように、preg_grep関数は配列から特定の条件に合うデータを効率的に絞り込む際に役立ちます。

<?php

/**
 * 多次元配列から特定のキーの値を正規表現で検索し、
 * マッチした要素を含む配列全体を抽出します。
 *
 * preg_grepは一次元の配列しか扱えないため、多次元配列を直接検索できません。
 * このサンプルでは、以下の手順で多次元配列をフィルタリングします。
 * 1. array_column() を使い、検索対象のキーの値だけを一次元配列として取り出す。
 * 2. preg_grep() を使い、その一次元配列を正規表現でフィルタリングする。
 *    このとき、preg_grep() は元の配列のキーを保持します。
 * 3. array_intersect_key() を使い、preg_grep() の結果（キー）と
 *    元の多次元配列のキーを比較し、一致する要素だけを抽出します。
 *
 * @param string $pattern 検索する正規表現パターン
 * @param array $multidimensionalArray 検索対象の多次元配列
 * @param string $key 検索する値が含まれるキー
 * @return array フィルタリングされた多次元配列
 */
function filterArrayByPregGrep(string $pattern, array $multidimensionalArray, string $key): array
{
    // 1. 指定されたキーの値だけを一次元配列として抽出します。
    // 例: ['userA@example.com', 'userB@example.net', 'userC@example.com']
    // 第3引数に検索対象のキーを指定することで、元の配列のキーと紐付きます。
    $values = array_column($multidimensionalArray, $key, key($multidimensionalArray));

    // 2. 抽出した一次元配列を preg_grep でフィルタリングします。
    // 元の配列のキーは保持されます。
    // 例: [0 => 'userA@example.com', 2 => 'userC@example.com']
    $matchedValues = preg_grep($pattern, $values);

    // preg_grep が失敗した場合やマッチしなかった場合は空の配列を返します。
    if ($matchedValues === false || empty($matchedValues)) {
        return [];
    }

    // 3. マッチしたキーを使って、元の多次元配列から該当する要素を抽出します。
    return array_intersect_key($multidimensionalArray, $matchedValues);
}

// サンプルデータ: ユーザー情報の多次元配列
$users = [
    [
        'id' => 1,
        'name' => 'Alice',
        'email' => 'alice.wonderland@example.com',
    ],
    [
        'id' => 2,
        'name' => 'Bob',
        'email' => 'bob.builder@example.net',
    ],
    [
        'id' => 3,
        'name' => 'Charlie',
        'email' => 'charlie.chaplin@example.com',
    ],
    [
        'id' => 4,
        'name' => 'Diana',
        'email' => 'diana.prince@another-domain.org',
    ],
];

// 検索パターン: '@example.com' で終わるメールアドレス
$pattern = '/@example\.com$/';

// 'email' キーを対象にフィルタリングを実行
$filteredUsers = filterArrayByPregGrep($pattern, $users, 'email');

// 結果を出力
print_r($filteredUsers);

PHPのpreg_grep関数は、配列の各要素を正規表現パターンで検索し、パターンに一致した要素だけを抽出して新しい配列として返す関数です。第一引数 $pattern に検索したい正規表現を、第二引数 $array に検索対象の配列を指定します。戻り値は、パターンに一致した要素を含む配列です。このとき、元の配列のキーは保持されるという特徴があります。

このサンプルコードは、preg_grepが本来一次元の配列しか扱えないという制約を回避し、多次元配列を対象に検索を行う方法を示しています。filterArrayByPregGrepという独自の関数を定義し、正規表現パターン、検索対象の多次元配列、そして検索したい値が含まれるキー名を引数として受け取ります。

関数内部では、まずarray_column関数を使って多次元配列から検索対象のキーの値だけを抜き出し、一時的な一次元配列を作成します。次に、その一次元配列に対してpreg_grepを実行し、パターンに一致した要素のキーを特定します。最後にarray_intersect_key関数を使い、特定したキーをもとにして、元の多次元配列から該当する要素全体を抽出します。この手順により、多次元配列の中から特定の条件に合うデータだけを効率的に絞り込むことが可能になります。

<?php

/**
 * 連想配列から指定された正規表現パターンにマッチする要素を抽出するサンプル関数。
 *
 * preg_grep 関数は、配列の「値」に対して正規表現マッチングを行います。
 * 連想配列の場合でも、キーではなく値が評価対象となります。
 * マッチした値は新しい配列として返され、元の連想キーは破棄され、数値添字が割り当てられます。
 */
function filterAssociativeArrayByRegex(): void
{
    // 検索対象となる連想配列を定義します。
    $associativeArray = [
        'id_001' => 'Apple Inc. is a tech company.',
        'id_002' => 'Google LLC is also a tech company.',
        'id_003' => 'Microsoft Corporation makes software.',
        'id_004' => 'Amazon.com is an e-commerce giant.',
        'id_005' => 'Facebook (Meta Platforms) focuses on social media.',
        'id_006' => 'Tesla, Inc. specializes in electric vehicles.',
    ];

    echo "元の連想配列:\n";
    print_r($associativeArray);

    // 正規表現パターンを定義します。
    // ここでは「Inc.」または「LLC」を含む文字列を検索します。
    $pattern = '/(Inc\.|LLC)/';

    echo "\n正規表現パターン: " . $pattern . "\n";

    // preg_grep 関数を使用して、パターンにマッチする値を抽出します。
    // 第1引数: 正規表現パターン
    // 第2引数: 検索対象の配列
    // 第3引数: フラグ (0はデフォルトで、特別な動作を指定しない)
    $filteredArray = preg_grep($pattern, $associativeArray);

    echo "\npreg_grep でフィルタリングされた結果 (Inc. または LLC を含む):\n";

    // フィルタリングされた結果を表示します。
    // 結果は数値添字配列として返されます。
    if (!empty($filteredArray)) {
        print_r($filteredArray);
    } else {
        echo "マッチする要素は見つかりませんでした。\n";
    }

    // 別のパターンで試します。
    // 例: 「tech company」を含む文字列を検索
    $anotherPattern = '/tech company/';
    echo "\n別の正規表現パターン: " . $anotherPattern . "\n";

    $anotherFilteredArray = preg_grep($anotherPattern, $associativeArray);

    echo "\npreg_grep でフィルタリングされた結果 (tech company を含む):\n";
    if (!empty($anotherFilteredArray)) {
        print_r($anotherFilteredArray);
    } else {
        echo "マッチする要素は見つかりませんでした。\n";
    }
}

// 関数を実行します。
filterAssociativeArrayByRegex();

?>

PHPのpreg_grep関数は、配列の要素を正規表現パターンに基づいてフィルタリングするために利用されます。この関数は、第一引数に正規表現パターン（$pattern）、第二引数に検索対象となる配列（$array）を受け取ります。第三引数の$flagsはオプションで、特別な動作を指定しない場合はデフォルト値の0を使用します。

preg_grep関数は、配列の「値」に対して正規表現マッチングを行います。検索対象が連想配列であっても、キーではなく値が評価の対象となります。マッチした要素は新しい配列として返されますが、元の連想キーは破棄され、結果は数値添字（ゼロから始まるインデックス）の配列となります。

サンプルコードでは、最初に企業情報を含む連想配列を用意しています。最初の例では「Inc.」または「LLC」という正規表現パターンを使用し、これらの文字列を含む要素を抽出しています。次に「tech company」という別のパターンで同様の抽出を行っています。preg_grepは指定されたパターンに合致する要素のみを選び出し、新しい数値添字配列として結果を返します。もしパターンにマッチする要素が見つからなかった場合は、空の配列が返されます。これにより、配列から特定の条件を満たすデータだけを効率的に抽出することができます。