【PHP8.x】DOMNotation::contains()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定された値が配列内に存在するかどうかを確認します。
7 *
8 * この関数は、PHPの組み込み関数 in_array() のラッパーとして機能し、
9 * 配列内に特定の要素が含まれているか（contains）をチェックする一般的な方法を示します。
10 *
11 * @param array<int|string, mixed> $haystack 検索対象の配列。
12 * @param mixed $needle 検索する値。
13 * @return bool 値が配列内に見つかった場合は true、それ以外は false を返します。
14 */
15function doesArrayContainValue(array $haystack, mixed $needle): bool
16{
17    // in_array()関数は、配列に値が存在するかどうかをチェックします。
18    // 第3引数に true を指定すると、型も比較する厳密なチェック (===) を行います。
19    // PHP 8以降では、この厳密なチェックが推奨されます。
20    return in_array($needle, $haystack, true);
21}
22
23// チェック対象の配列を定義します。
24$fruits = ['apple', 'banana', 'orange'];
25
26// --- ケース1: 配列に存在する値を確認 ---
27$value1 = 'banana';
28if (doesArrayContainValue($fruits, $value1)) {
29    echo "'{$value1}' は配列に含まれています。" . PHP_EOL;
30} else {
31    echo "'{$value1}' は配列に含まれていません。" . PHP_EOL;
32}
33
34// --- ケース2: 配列に存在しない値を確認 ---
35$value2 = 'grape';
36if (doesArrayContainValue($fruits, $value2)) {
37    echo "'{$value2}' は配列に含まれています。" . PHP_EOL;
38} else {
39    echo "'{$value2}' は配列に含まれていません。" . PHP_EOL;
40}
41
42// --- ケース3: 型が異なる値を確認（厳密なチェック） ---
43$numbers = [10, 20, '30'];
44$value3 = 30; // データ型は integer
45if (doesArrayContainValue($numbers, $value3)) {
46    echo "数値の {$value3} は配列に含まれています。" . PHP_EOL;
47} else {
48    // 配列内の '30' は文字列型なので、厳密な比較では false となります。
49    echo "数値の {$value3} は配列に含まれていません。（文字列の '30' は存在します）" . PHP_EOL;
50}
51
52?>

このPHPサンプルコードは、配列の中に特定のデータが含まれているかどうかを確認する方法を解説しています。そのために doesArrayContainValue という独自の関数を定義し、具体的な使用例を示しています。

この関数は2つの引数を取ります。第1引数の $haystack は検索対象となる配列で、第2引数の $needle はその配列の中から探したい値です。関数の内部では、PHPに標準で用意されている in_array() 関数を呼び出しています。このコードの重要な点は、in_array() の第3引数に true を指定していることです。これにより、値が一致するかに加えて、データ型（例えば数値と文字列の違い）まで一致するかどうかを厳密に比較します。

関数の戻り値は bool 型（ブール型）であり、$needle で指定した値が配列内に見つかった場合は true を、見つからなかった場合は false を返します。サンプルコードの最後の例では、数値の 30 と文字列の '30' が厳密に区別されるため、検索結果が false となることを示しており、正確なデータ検索におけるこの手法の有効性がわかります。