PHPのin_array関数で配列内で値の存在を確認する

はじめに

PHPのin_array関数とは

PHPのin_array関数は、配列の中に特定の値が存在するかどうかを調べるための関数です。この関数は指定した値が配列内に存在する場合はtrueを、存在しない場合はfalseを返します。

例えばある商品の名称が格納された配列があり、特定の商品がその配列内にあるかどうかを調べたい場合にin_array関数を使用できます。この関数を使用すると指定した商品の有無を検索して結果を返してくれます。

基本的な使用方法は次の通りです：

if (in_array("探したい値", $配列)) {
    echo "配列の中に探したい値が存在します。";
} else {
    echo "配列の中に探したい値は存在しません。";
}

このように、in_array関数はPHPで配列に関わる実装をする際に非常に便利な関数です。

in_array関数の用途

PHPのin_array関数は以下のようなさまざまなシナリオで使用されます。真偽値が返されることから、条件分岐に使用されることが多いでしょう。

要素の存在チェック：配列内に特定の値が存在するかどうかを確認するために使用します。例えば、ユーザーが入力した値が許可された値のリスト内にあるかどうかを確認する際などに使用します。

条件分岐：in_array関数の結果（trueまたはfalse）を使用して、プログラムの流れを制御します。例えば、特定の値が配列内に存在する場合と存在しない場合で、異なるアクションを実行することができます。

データフィルタリング：in_array関数を使用して、配列から特定の値を含む要素を検索し、それらの要素を新しい配列に格納することができます。これにより、大量のデータから特定の情報を抽出することが可能になります。

in_array関数の基本的な使い方

PHPのin_array関数の具体的な使用方法について説明します。ここでは関数の構文と、配列内に特定の値が存在するかどうかを確認するための基本的なコード例を提供します。

in_array関数の構文

PHPのin_array関数の基本的な構文は次の通りです：

in_array(検索したい値, 検索対象の配列[array], 型も比較するかどうか[bool])

この関数は3つの引数を受け取ることができます。

第1引数　検索したい値：これは配列内で検索したい値です。これは任意の型（文字列、数値、オブジェクトなど）を使用できます。

第2引数　検索対象の配列：これは検索したい値を探す対象となる配列です。

第3引数　型も比較するかどうか：これはオプションの引数で、デフォルトはfalseです。これをtrueに設定すると、in_array関数は値だけでなく、型も比較します。つまり、"10"（文字列）と10（数値）は異なると見なされます。

in_array関数は指定した値が配列内に存在する場合はtrueを、存在しない場合はfalseを返します。

in_array関数の基本的な使用例

PHPのin_array関数の基本的な使用例を以下に示します。

$fruits = array("apple", "banana", "cherry");

if (in_array("banana", $fruits)) {
    echo "バナナが配列に存在します！";
} else {
    echo "バナナは配列に存在しません。";
}

このコードは、"banana"が$fruits配列に存在するかどうかをチェックします。存在する場合、"バナナが配列に存在します！"と出力されます。存在しない場合、"バナナは配列に存在しません。"と出力されます。

また、in_array関数の第3引数を使用して型も比較することができます。以下にその例を示します。

$numbers = array(1, 2, "3", 4, "5");

if (in_array("3", $numbers, true)) {
    echo "文字列の3が配列に存在します！";
} else {
    echo "文字列の3は配列に存在しません。";
}

このコードは、文字列の"3"が$numbers配列に存在するかどうかをチェックします。この例では存在するので、"文字列の3が配列に存在します！"と出力されます。もし3（数値）で登録されていた場合は型が違うので"文字列の3は配列に存在しません。"と出力されます。

in_array関数の応用例

PHPのin_array関数をもう少し応用してみましょう。

配列内から複数の要素を検索する

in_array関数は一度に1つの値しか検索できませんが、この関数をループ内で使用することで複数の要素を検索することができます。

例えば果物の名称が格納された配列内に特定の複数の果物が存在するかどうかを確認したい場合、次のようにin_array関数を使用することができます：

$fruits = array("apple", "banana", "cherry", "orange", "grape");
$search = array("banana", "grape", "kiwi");

foreach ($search as $fruit) {
    if (in_array($fruit, $fruits)) {
        echo $fruit . "が配列に存在します！\n";
    } else {
        echo $fruit . "は配列に存在しません。\n";
    }
}

/* 結果
bananaが配列に存在します！
grapeが配列に存在します！
kiwiは配列に存在しません。
*/

このコードは$search配列の各要素が$fruits配列に存在するかどうかをチェックします。存在する場合、その果物が配列に存在すると出力されます。存在しない場合、その果物は配列に存在しませんと出力されます。

このように、in_array関数をループ内で使用することで、複数の要素を効率的に検索することができます。

配列内の特定の型の値を検索する

in_array関数の第3引数をtrueに設定すると、値だけでなく型も比較します。これにより配列内の特定の型の値を検索することが可能になります。

例えば、次のような配列があるとします：

$values = array(1, "1", 2, "2", 3, "3");

この配列内には数値の1と文字列の"1"が混在しています。in_array関数を使用して、文字列の"1"が存在するかどうかを確認するには、次のようにします：

if (in_array("1", $values, true)) {
    echo "文字列の1が配列に存在します！";
} else {
    echo "文字列の1は配列に存在しません。";
}

このコードは文字列の"1"が配列に存在する場合、"文字列の1が配列に存在します！"と出力します。存在しない場合、"文字列の1は配列に存在しません。"と出力します。

このように、in_array関数の第3引数を使用することで、配列内の特定の型の値を効率的に検索することができます。

多次元配列内の検索

PHPのin_array関数を使用すると、多次元配列内に特定の配列が存在するかどうかを確認することができます。

例えば、次のような配列があるとします：

$array = array(array(1, 2), array(3, 4), array(5, 6));

この配列では各要素自体が配列です。in_array関数を使用して特定の配列が存在するかどうかを確認するには、次のようにします：

if (in_array(array(3, 4), $array)) {
    echo "配列[3, 4]が配列に存在します！";
} else {
    echo "配列[3, 4]は配列に存在しません。";
}

このコードは、配列[3, 4]が$array配列に存在する場合、"配列[3, 4]が配列に存在します！"と出力します。存在しない場合、"配列[3, 4]は配列に存在しません。"と出力します。

このように、in_array関数を使用することで多次元配列内の配列を検索することもできます。

in_array関数でよく発生するエラー

in_array関数は非常に便利ですが、正しく使用しないとエラーが発生することがあります。以下に、in_array関数を使用する際の一般的なエラーとその解決方法を示します。

配列ではないものを検索対象にする：in_array関数の第2引数は配列でなければなりません。配列ではない値を検索対象にすると、エラーが発生します。この問題を解決するには、検索対象が配列であることを確認してください。

PHP Fatal error:  Uncaught TypeError: in_array(): Argument #2 ($haystack) must be of type array, string given in …

存在しない変数を使用する：存在しない変数をin_array関数に渡すと、エラーが発生します。この問題を解決するには、変数が存在し、適切な値が設定されていることを確認してください。

PHP Warning:  Undefined variable $values in …

型の不一致：これは使用方法のところで説明しましたが、in_array関数の第3引数をtrueに設定すると、値だけでなく型も比較します。つまり、文字列の"10"と数値の10は異なると見なされます。これが意図した動作でない場合は、第3引数をfalseに設定するか、省略してください。

これらのエラーは、in_array関数の使用方法を理解し、適切な引数を渡すことで防ぐことができます。

array_searchについて

in_arrayとよく似た関数として、array_searchという関数があります。

array_search関数の基本的な構文は次の通りです。

array_search(検索したい値, 検索対象の配列[array], 型も比較するかどうか[bool])

よく見て頂くと気がつくかと思いますが、引数はin_arrayと同じです。

では実際に使用例を見てみましょう。

例えば、次のような配列があるとします：

$values = array('1', '2', '3');

この配列をarray_searchにかけて実行すると、

$result = array_search('2', $values, true);

検索する値（'2'）が、検索対象の配列($values)の中のインデックスキー0から数えて1番目にあるので、「1」が返されました。

var_dump($result); // 1

このように、in_arrayの場合はbool値（true/false）が返却されるのに対して、array_searchはインデックスキーが返却されます。

まとめ

PHPのin_array関数は配列内に特定の値が存在するかどうかをチェックするのに便利です。この関数を使用することで、ループ処理などで値を探すよりはコードの可読性が向上し、開発時間が短縮されます。注意点として、in_array関数は第3引数を省略すると型チェックを行わないため、意図しない結果を返すことがあります。例えばデフォルトでは文字列の"1"と整数の1は等しいと判断されるのです。これを避けるためには、in_array関数の第3引数にtrueを設定し、型チェックを有効にする必要があります。