CakePHP5系でDeprecatedを回避しfindListでキーと値のカラムを指定して取得する方法

2024/11/10 2025/01/31

`Deprecated (16384) : Since 5.0.0: Calling findList finder with options array is deprecated. Use named arguments instead.`を回避する方法

　
findListを利用して、キーと値のカラムを指定して配列を取得する方法ですが、CakePHP4系の記述方法が CakePHP5系では非推奨となっています。
そのため「Deprecated（非推奨）」が表示されます。
　
その対処方法を解説します。
　
　

CakePHP5で「Deprecated（非推奨）」を回避して findListで値を取得する方法

CakePHP4で findListを使用して値を取得する方法

　
CakePHP4系で findListを利用して、キーと値のカラムを指定して配列を取得する方法は、下記となります。
　

  public function getOptionsUsers()
  {
    // 取得するキーを指定
    $listArray = [
      "keyField"   => "id",
      "valueField" => "name"
    ];

    // 取得条件を設定
    $conditions["deleted"] = ;    // 削除フラグ

    return $this->find("list",$listArray)->where($conditions)->orderAsc("id")->toArray();
  }

public function getOptionsUsers()

{

// 取得するキーを指定

$listArray = [

"keyField" => "id",

"valueField" => "name"

];

// 取得条件を設定

$conditions["deleted"] = ; // 削除フラグ

return $this->find("list",$listArray)->where($conditions)->orderAsc("id")->toArray();

}

　
　
これをこのまま CakePHP5系にコピペして使用すると、下記の「Deprecated（非推奨）」メッセージが表示されます。
　
Deprecated (16384) : Since 5.0.0: Calling findList finder with options array is deprecated. Use named arguments instead. C:\xampp\htdocs\vendor\cakephp\cakephp\src\ORM\Table.php, line: 2649 You can disable all deprecation warnings by setting Error.errorLevel to E_ALL & ~E_USER_DEPRECATED. Adding vendor/cakephp/cakephp/src/ORM/Table.php to Error.ignoredDeprecationPaths in your config/app.php config will mute deprecations from that file only. [in C:\xampp\htdocs\vendor\cakephp\cakephp\src\Core\functions.php, line 384]
　
　

CakePHP5で推奨されている findListで値を取得する方法

　
上記の「Deprecated（非推奨）」を回避し、CakePHP5系で推奨される記述方法に変えたものが下記になります。
　

  public function getOptionsUsers()
  {
    // 取得条件を設定
    $conditions["deleted"] = ;    // 削除フラグ

    return $this->find("list",keyField:"id",valueField:"association_name")->where($conditions)->orderBy(["id"=>"ASC"])->toArray();
  }

public function getOptionsUsers()

{

// 取得条件を設定

$conditions["deleted"] = ; // 削除フラグ

return $this->find("list",keyField:"id",valueField:"association_name")->where($conditions)->orderBy(["id"=>"ASC"])->toArray();

}

　
　
CakePHP5　ChiffonBook　5.0 移行ガイド　非推奨　ORM
https://book.cakephp.org/5/ja/appendices/5-0-migration-guide.html#id7
　
上記に「Table::find() のオプションを配列で指定することは非推奨となりました。（Calling Table::find() with options array is deprecated. Use named arguments instead.）」と書いてありまして、これが上記の「Deprecated（非推奨）」の要因となっています。
そのため、推奨される記述方法に変更する必要があるようです。
　
　
ちなみに、下記の記述方法では「Deprecated（非推奨）」は出なくなりますが、「valueField」で指定したカラムとは異なるカラムの値が取得されることもあるようで、正しい処理ではないようです。
　

$listArray = ["keyField"   => "id","valueField" => "name"]
return $this->find("list",options:$listArray)->where($conditions)->orderBy(["id"=>"ASC"])->toArray();

1 2	$listArray = ["keyField" => "id","valueField" => "name"] return $this->find("list",options:$listArray)->where($conditions)->orderBy(["id"=>"ASC"])->toArray();

orderAsc、order、groupも非推奨になっている

　
CakePHP5　ChiffonBook　5.0 移行ガイド　非推奨　Database
https://book.cakephp.org/5/ja/appendices/5-0-migration-guide.html#id6
　
また、CakePHP4のコードでは「orderAsc()」を使用していますが、これも非推奨のようです。
「order(["id"=>"ASC"])」や「group()」も非推奨のようです。
　
それぞれ下記のように書き替える必要があります。
　
「orderAsc()」は「orderByAsc()」に。
「orderDesc()」は「orderByDesc()」に。
「order()」は「orderBy()」に。
「group()」は「groupBy()」に。
　
ちなみに、この「非推奨」は、使用していても「Deprecated（非推奨）」のメッセージは出ないようです。
　
　

- CakePHP 3.x 4.x 5.x CakePHP5

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法

CakePHPで「CakeDC/Users」などルーティングを行うプラグインを利用するときに、favicon.icoやapple-touch-icon-144-precomposed.pngがNotFoundエラーになることがある。その対処方法の解説。

: CakePHP4、CakePHP5の「warning: DebugKit is disabling．．．」の対処方法

CakePHPのデバッグ用のツールであるDebugKitは適切な設定をしないとエラーログにワーニングメッセージが出力される。それを解消する方法を解説。

: 国際化と地域化の翻訳機能「__()」を使って定数に変数を埋め込む方法

CakePHP4で定数に変数を埋め込み、翻訳機能「__()」で変数に値を入れる方法を紹介。定型の文章の一部だけを置換したい場合に利用すると便利。

: CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法

コントローラーからビューに送ったテーブルのオブジェクトを連想配列に変換し、ビューの中で自由に使えるようにするメソッド「toArray()」の解説。連想配列に変換できれば利用度アップ！

: CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説

CakePHP3でCSVファイルをアップロードしレコードを追加、更新する処理の作成方法の解説。モデルとは直接関連しないフォームからCSVファイルをアップロードするため汎用的に使用可能。

: CakePHP 2.3　Search Pluginで検索処理　その７queryを使って日付の範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で queryを使って日付の範囲検索の方法です。

: CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。

: CakePHP5系で認証機能のAuthenticationプラグインをインストール・エラー発生注意

CakePHPのユーザ認証に使用するオフィシャルなプラグインAuthenticationだが、CakePHP5系では Authentication Ver.3系を使う必要があるが、公式ChiffonBookが間違えている。

: CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する

CakePHP3のkeywordsとdescriptionを設定する方法の解説。CakePHP3にはmetaタグを編集するHTMLヘルパーが用意されているためそれを利用すればOK！ポイントはブロック化を有効にすること。