PHP 配列の変数の初期化のタイミングについて

Question

はじめに

PHPのコードレビューをしていて、配列の変数の初期化のタイミングを指摘したいのですが、
言語化ができていないので、指摘できない状態にいます。
言語化の手助けをお願いします。

元のコード（サンプルのため変数名などは簡略化してます）

$ids = getIds();
$datas = getDatas();

// $datasが空でforeachに入らないケースがあります
foreach ($datas as $key => $val) {
  $dataIds[] = $val['id'];
}

if(empty($dataIds))$dataIds = array();
$mergeIds = array_merge($ids, $dataIds);

指摘して以下のように直すべきと考えているコード

$ids = getIds();
$datas = getDatas();

// ※指摘点 foreachの前に配列の初期化をしておきたい
$dataIds = array();
// $datasが空でforeachに入らないケースがあります
foreach ($datas as $key => $val) {
  $dataIds[] = $val['id'];
}

$mergeIds = array_merge($ids, $dataIds);

求めていること

「foreachの前に配列の初期化をしておきたい」と伝えたいのですが、
なぜforeachの前なのかの説明が言語化できていないので、ここの言語化をお願いしたいです。
メソッドの冒頭や、変数を使う直前で初期化を当たり前にしてきてしまったという背景があります。
よろしくお願いいたします。

Answer 1

「利用する前に初期化をしておく癖をつけましょう」でいいのではないでしょうか。
既に「$datasが空でforeachに入らないケースがあります」と述べられていますし、それ以上の理由はないかと思います。
配列を初期化せずにいきなり利用した場合のエラーを伝えても良いですし。

細かいですが、配列初期化・定義は下記のほうが今は良いです。

$dataIds = [];

• PHPマニュアル：配列

Comments

[Heidi]

ご回答ありがとうございます。
「利用する前に初期化」という単純明快な言葉を使わさせていただきレビュー指摘をしました。
また合わせて、
if(empty($dataIds))$dataIds = array();
というロジックが入ることで可読性が悪くなるという面も伝えることにしました。

[m.ts10806]

解決されたようで何よりです。
根拠資料であればPHPマニュアル以上に最適なものはないので別の回答とあわせてレビュー結果すると良いです。

Answer 2

こういうのはarray_mapなどで取るのがラクでは？

$datas=[
  ["id"=>1,"data"=>"data1","other"=>"other1",],
  ["id"=>2,"data"=>"data2","other"=>"other2",],
  ["id"=>3,"data"=>"data3","other"=>"other3",],
  ];
$dataIds=array_map(function($x){
  return $x["id"];
},(array) $datas);
  
print_r($dataIds);

かりに$datasが空配列でも、配列以外のなにかでも$dataIdsには
空配列が返ります

Answer 3

なぜforeachの前なのかの説明が言語化できていないので、ここの言語化をお願いしたいです。

PHPマニュアルにもその旨が明記してあります。

$arr がまだ存在しない場合は、新しく作成します。 つまり、これは配列を作成する方法のひとつでもあります。 とはいえ、この方法を使うことはおすすめしません。なぜなら、既に $arr に何らかの値 (リクエスト変数からの文字列など) が入っている場合にはその値がそのまま残り、 [] が実際には 文字列アクセス演算子 を表してしまうからです。 変数を初期化するときには、直接代入するほうがよいでしょう。

Comments

[Heidi]

ご回答ありがとうございます。
PHPマニュアルを読むという初歩的なことを忘れておりました。
また、記述部分を抜粋していただきありがとうございます。

レビュー指摘は、
・変数を利用する前に初期化してほしい
・if(empty($dataIds))$dataIds = array(); というロジックが入ることで可読性が悪くなる
という言葉で伝えることにしました。

Answer 4

その直しは、質問者様のチームにおけるコーディング規約ではないでしょうか。規約を明確化なさったほうがいいと思います。

私が直すべきと思うのは、

$ids = getIds();
$datas = getDatas();

$mergeIds = array_merge($ids, array_column($datas, 'id'));

です。

なお、こういうコードができあがる背景には私は、

$ids = getIds();
$datas = getDatas();

// $datasが空でforeachに入らないケースがあります
foreach ($datas as $key => $val) {
  $dataIds[] = $val['id'];
}
$mergeIds = array_merge($ids, $dataIds);

があり、undefined variable: dataIdsが発生したのではないかと推測しています。その解決としては$dataIds ?? []ではないかと思います。