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 2.3　デバッグキット（DebugKit）超初心者向けフォロー講座

CakePHP初心者に向けてデバッグキット（DebugKit）のインストール方法、はまりポイントを解説。

: CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定

CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。

: Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説

CakePHP3で Google Analytics APIからレポートデータを取得する処理の解説。PHPのサンプルソースをCakePHP3で動くように改造。加えて、ディメンションやメトリックスを条件に設定する方法なども。

: CakePHP4、5でSELECT telephone as tel FROM usersの様にasでカラムに別名を付ける方法

CakePHP4、CakePHP5でクリエビルダーを利用してテーブルからレコードを取得する際、asを使用してカラムの別名で値を取得したい場合の対応方法を解説。また、別名にはハイフンやアスタリスクなど使用できない文字がある点も解説。

: CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合の詳細ページの注意点

ID以外のカラムでアソシエーション（連携）させて詳細ページを表示させる際の考え方と注意点をサンプルソースを用いて解説しています。

: CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法

CakePHP4でcontrollerで実行したバリデーションの結果をModelのバリデーション結果に追加するメソッド「setError()」「setErrors()」の使い方の解説。

: CakePHP3で画像・ファイルのアップロード処理を自作・解説付き・その２

ファイルのアップロード機能の自作サンプルコードとその解説のその２。アップロード機能に関連するファイルの更新や削除の処理や画像、フォルダのパスの指定方法などを含めて解説。

: CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その１

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。