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 コメントをキャンセル

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

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

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

: Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法

CakePHP4のコマンド（シェル）に対して、環境変数を指定して実行する方法を解説。LinuxとWindows上のXAMPPとでは記述方法が異なるため、Windowsのsetコマンドについても詳細解説。

: CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ

CakeDC謹製Usersプラグインの紹介。UserHelperを利用し、ログアウトのリンクや権限があるときのみ表示されるリンク、プロフィールページへのリンク、reCAPTCHAの設置方法などを解説。

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

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