【PHP】リスト（純粋な配列）かどうかを確認できるarray_is_list関数を解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在5社経験している、13年目エンジニアです。

この記事では、 PHPでリスト（純粋な配列）かどうかを確認できるarray_is_list関数について

array_is_list関数とは
array_is_list関数を使ったサンプルプログラム

と、丁寧に解説していきます。

前提条件：実行環境について
array_is_list関数とは
array_is_list関数を解説するプログラムの概要
PHPサンプルプログラム
実行結果
まとめ：array_is_list関数を使ってみよう！

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows11
PHPのバージョン	8.2.4
XAMPPのバージョン	8.2.4

PHPを動かすためにXAMPPを使っています。
XAMPPのインストールは、下の記事をご参考ください。

【XAMPP】インストールするやり方を解説します（Windows11向け）

array_is_list関数とは

array_is_list関数とは、引数に指定された配列がリスト（純粋な配列）かどうかを判定してbool値を返す関数です。
リストであればtrue、そうでなければfalseを返します。
「リスト（純粋な配列）」とはキーが

「0」から始まっていること
連番であること
終わりが「要素数-1」であること

をすべて満たしていることがリストである、と判定されます。

使い方サンプルは以下になります。

$sample = [1, 2, 3, 4];
$result = array_is_list($sample);

1 2	$sample = [1, 2, 3, 4]; $result = array_is_list($sample);

上記の例だとresultにはtrueが返されます。

では、次の章で実際に使ってみます。

array_is_list関数を解説するプログラムの概要

array_is_list関数を解説するプログラムでは、引数に

リスト（純粋な配列）
すべてキーを指定している連想配列
キーに数と文字が混ざっている連想配列
空の配列

4パターンを与えて、結果を表示させて確認します。

phpプログラムは

C:\xampp\htdocs

配下に、【sample.php】というファイル名で格納しています。
PHPのarray_shift関数を解説

PHPサンプルプログラム

<?php
	print('■array_is_list関数確認<br >');

	print('①リスト（純粋な配列）の場合<br >');
	$fruits = array('apple', 'orange', 'banana');
	print_r('<pre>');
	print_r($fruits);
	print_r('</pre>');
	if (array_is_list($fruits)) {
		print('純粋な配列です<br>');
	} else {
		print('純粋な配列ではないです<br>');
	}
	
	print('②すべてキーを指定している連想配列の場合<br >');
	$animals = array('dog' => 'イヌ', 'cat' => 'ネコ', 'parakeet' => 'インコ');
	print_r('<pre>');
	print_r($animals);
	print_r('</pre>');
	if (array_is_list($animals)) {
		print('純粋な配列です<br>');
	} else {
		print('純粋な配列ではないです<br>');
	}

	print('③キーに数と文字が混ざっている連想配列の場合<br >');
	$numbers = array(0 => 'ゼロ', 'one' => 'イチ', 2 => 'ニ');
	print_r('<pre>');
	print_r($numbers);
	print_r('</pre>');
	if (array_is_list($numbers)) {
		print('純粋な配列です<br>');
	} else {
		print('純粋な配列ではないです<br>');
	}

	print('④空の配列の場合<br >');
	$emp = array();
	print_r('<pre>');
	print_r($emp);
	print_r('</pre>');
	if (array_is_list($emp)) {
		print('純粋な配列です<br>');
	} else {
		print('純粋な配列ではないです<br>');
	}
?>

<?php

print('■array_is_list関数確認 ');

print('①リスト（純粋な配列）の場合 ');

$fruits = array('apple', 'orange', 'banana');

print_r('<pre>');

print_r($fruits);

print_r('</pre>');

if (array_is_list($fruits)) {

print('純粋な配列です ');

} else {

print('純粋な配列ではないです ');

}

print('②すべてキーを指定している連想配列の場合 ');

$animals = array('dog' => 'イヌ', 'cat' => 'ネコ', 'parakeet' => 'インコ');

print_r('<pre>');

print_r($animals);

print_r('</pre>');

if (array_is_list($animals)) {

print('純粋な配列です ');

} else {

print('純粋な配列ではないです ');

}

print('③キーに数と文字が混ざっている連想配列の場合 ');

$numbers = array(0 => 'ゼロ', 'one' => 'イチ', 2 => 'ニ');

print_r('<pre>');

print_r($numbers);

print_r('</pre>');

if (array_is_list($numbers)) {

print('純粋な配列です ');

} else {

print('純粋な配列ではないです ');

}

print('④空の配列の場合 ');

$emp = array();

print_r('<pre>');

print_r($emp);

print_r('</pre>');

if (array_is_list($emp)) {

print('純粋な配列です ');

} else {

print('純粋な配列ではないです ');

}

実行結果

XAMPPを起動して、【http://localhost/sample.php】のURLにアクセスします。

XAMPPでPHPの動かし方については、こちらの記事をご参考ください。

XAMPPでApacheの動かし方を解説します（Windows11向け）

PHPのarray_is_list関数を解説
リストのみtrueが返されていることを確認できました。
また空配列の場合、リストであると判断されていることも確認できました。

まとめ：array_is_list関数を使ってみよう！

以上がarray_is_list関数についての解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ