CakePHP4系、CakePHP5系のexists()でカラムを指定して値の有無をチェックする方法解説

2025/01/25 2025/03/23

CakePHP4系、CakePHP5系の exists()でカラムの値の有無チェック

　
CakePHP4系、CakePHP5系で、特定のカラムに値があるかどうかをチェックする際は「exists()」を使用します。
　
具体的な使い方は、下記となります。
　

if($this->"Model名"->exists(["カラム名"=>"値"])){
  echo "True";
} else {
  echo "False";
}

if($this->"Model名"->exists(["カラム名"=>"値"])){

echo "True";

} else {

echo "False";

}

　
値があれば「true」、値がなければ「false」となります。
　
　

CakePHP4系、CakePHP5系の exists()でカラムの値の有無チェックの使用例

public function view($id = null)
{
  $user = $this->Users->get($id, contain: []);
  $this->set(compact('user'));
}

public function view($id = null)

{

$user = $this->Users->get($id, contain: []);

$this->set(compact('user'));

}

　
上記は、Bakeで自動生成した Controllerの viewアクションのソースコードです。
　
この自動生成されたソースの処理で動作はするのですが、一般に公開して多くの方に使ってもらうシステムとしては、不具合が発生しないようにもう少し処理を加える必要があります。
　
　
具体的には、今回の記事の内容である引数として指定する「$id」に入る値のチェックです。
　
例えば、引数となる「$id」の値がない場合や、値はあっても存在しない IDが指定された場合などはエラー画面が表示されてしまいますので、これらが出ないようにする必要があります。
　
「$id」が指定されていなかった場合のエラー
「Record not found in table users with primary key [NULL]. Cake\Datasource\Exception\InvalidPrimaryKeyException」
　
「$id」に存在しない IDが指定された場合のエラー
「Record not found in table users. Cake\Datasource\Exception\RecordNotFoundException」
　
　

「exists()を使用して値をチェックするサンプルソース

　
上記の問題点を踏まえて、最低限の処置として、「$id」の値の有無と、存在チェックを追加したものが下記になります。
　

public function view($id = null)
{
  // 引数のチェック・$id の値の有無
  if(!$id){
    return $this->redirect(["action" => 'index']);
  }

  // 引数のチェック・$id の値の存在チェック
  if(!$this->Users->exists(["id"=>$id])){
    return $this->redirect(["action" => 'index']);
  }

  $user = $this->Users->get($id, contain: []);
  $this->set(compact('user'));
}

public function view($id = null)

{

// 引数のチェック・$id の値の有無

if(!$id){

return $this->redirect(["action" => 'index']);

}

// 引数のチェック・$id の値の存在チェック

if(!$this->Users->exists(["id"=>$id])){

return $this->redirect(["action" => 'index']);

}

$user = $this->Users->get($id, contain: []);

$this->set(compact('user'));

}

　
上記のように、「Users」テーブルの「id」というカラムに「$id」の変数に入っている値があるかどうか、をチェックする際に「exists()」を使用します。
　
値が存在しているときに「true」になりますので、それの否定形の「!」を使って、値がない時はリダイレクトをする処理にしています。
　
　

「exists()を使用して値が空の場合も含めてチェックするサンプルソース

　
ちなみに下記のように、引数がないときの値を nullではなく「$id = ""」にすることで、値の有無チェックをしないようにすることもできます。
　

public function view($id = "")
{
  // 引数のチェック・$id の値の存在チェック
  if(!$this->Users->exists(["id"=>$id])){
    return $this->redirect(["action" => 'index']);
  }

  $user = $this->Users->get($id, contain: []);
  $this->set(compact('user'));
}

public function view($id = "")

{

// 引数のチェック・$id の値の存在チェック

if(!$this->Users->exists(["id"=>$id])){

return $this->redirect(["action" => 'index']);

}

$user = $this->Users->get($id, contain: []);

$this->set(compact('user'));

}

　
ただ、下記のような条件が入ってきますので、あんまりメリットがないようにも思います。
※idのように「空」の値がないカラムをチェックすることが前提となります。
※「空」をチェックするため、nullがあっても該当なしとなります。
※「null」のチェックは「["id is"=>null]」とする必要があります。
　
　

exists()でカラムの値の有無チェックのバリエーション

　
上記の例は、値を探すカラムを「id」としていますが、カラム名を指定する事でテーブル内のどのカラムでも対応できます。
例えば、ログインする際のログイン IDとして使用する「login_name」というカラムがありその値を探す場合は、下記のように「カラム名」のところに「login_name」を指定する事になります。
　

if($this->Users->exists(["login_name"=>"sample03"])){
  echo "True";
} else {
  echo "False";
}

if($this->Users->exists(["login_name"=>"sample03"])){

echo "True";

} else {

echo "False";

}

　
　
値があるかどうかをチェックする機能ですので、例えば「department（部）」を条件にチェックする場合は、「1」に該当するレコードは複数ありますが、この時も 1件以上あれば「true」になります。
　

if($this->Users->exists(["department"=>1])){
  echo "True";
} else {
  echo "False";
}

if($this->Users->exists(["department"=>1])){

echo "True";

} else {

echo "False";

}

　
　
さらには、「$this->ContractSeos->find()->where([条件])」でレコードを探すときと同じように、「値の大小」や「like %値%」、複数の条件を組み合わせて「and条件」「or条件」も使用することができます。
　

// id が 100より大きいものがあるかないか
if($this->Users->exists(["id >"=>100])){
  echo "True";
} else {
  echo "False";
}

// email に「example.com」が含まれるものがあるかないか
if($this->Users->exists(["email like"=>"%example.com%"])){
  echo "True";
} else {
  echo "False";
}

// email に「example.com」が含まれる、かつ、department が「1」のもの
if($this->Users->exists(["email like"=>"%example.com%","department"=>1])){
  echo "EmailTrue";
} else {
  echo "EmailFalse";
}

// email に「example.com」が含まれる、もしくは、department が「1」のもの
if($this->Users->exists(["or"=>["email like"=>"%example.com%","department"=>1]])){
  echo "EmailTrue";
} else {
  echo "EmailFalse";
}

// id が 100より大きいものがあるかないか

if($this->Users->exists(["id >"=>100])){

echo "True";

} else {

echo "False";

}

// email に「example.com」が含まれるものがあるかないか

if($this->Users->exists(["email like"=>"%example.com%"])){

echo "True";

} else {

echo "False";

}

// email に「example.com」が含まれる、かつ、department が「1」のもの

if($this->Users->exists(["email like"=>"%example.com%","department"=>1])){

echo "EmailTrue";

} else {

echo "EmailFalse";

}

// email に「example.com」が含まれる、もしくは、department が「1」のもの

if($this->Users->exists(["or"=>["email like"=>"%example.com%","department"=>1]])){

echo "EmailTrue";

} else {

echo "EmailFalse";

}

Containでアソシエーション先のテーブルを含めた状態では「exists()」は使えない

　
「exists()」は、一つのテーブル内のカラムと値を指定して、レコードが存在するか否かをチェックする関数です。
そのため、Contain句を使用してテーブルを連結して条件を指定するような使い方はできないようです。
　
そのため、テーブル連結をしてレコードの有無を調べる場合は、下記のように「first()」を使って 1件取得してみるか、「isEmpty()」を使って空なのかどうかを調べる方法があります。
　

$conditions = [ 条件 ];
$contain = [ テーブル連携 ];

if($this->Users->find()->where($conditions)->contain($contain)->first()){
  echo "レコードあり";
} else {
  echo "レコードなし";
}

if($this->Users->find()->where($conditions)->contain($contain)->all()->isEmpty()){
  echo "レコードなし";
} else {
  echo "レコードあり";
}


// 下記のような使い方は想定されておらずエラーになる
// if($this->Users->find()->where($conditions)->contain($contain)->exists()){

$conditions = [ 条件 ];

$contain = [ テーブル連携 ];

if($this->Users->find()->where($conditions)->contain($contain)->first()){

echo "レコードあり";

} else {

echo "レコードなし";

}

if($this->Users->find()->where($conditions)->contain($contain)->all()->isEmpty()){

echo "レコードなし";

} else {

echo "レコードあり";

}

// 下記のような使い方は想定されておらずエラーになる

// if($this->Users->find()->where($conditions)->contain($contain)->exists()){

　
「first()」の時は「true」は「レコードがある」時であり、「isEmpty()」の時は「true」は「レコードがない」時であるという点を注意して if文の分岐を構成する必要があります。
　
　

CakePHP 4.3 以降は「isEmpty()」の使い方が変更されている

　
CakePHP 4.3 以降では「isEmpty()」の使い方が変更されているようで、「isEmpty()」を使う際は「all()」が必須となったようです。
　

// CakePHP 4.3.0 からは非推奨
$query->isEmpty();

// CakePHP 4.3.0 以降は下記のように記述する
$results = $query->all();
$results->isEmpty();

// CakePHP 4.3.0 からは非推奨

$query->isEmpty();

// CakePHP 4.3.0 以降は下記のように記述する

$results = $query->all();

$results->isEmpty();

　
CakePHP4　Cookbook　データの取り出しと結果セット
https://book.cakephp.org/4/ja/orm/retrieving-data-and-resultsets.html#query-resultset
　
　

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

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

Message コメントをキャンセル

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

: CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつテンプレートファイルがどこにあるか、設定情報ファイルがどこにあるか、を説明しつつカスタマイズの方法を解説します。

: CakePHP 2.3 コマンドラインからPHPのシェル実行の方法解説

CakePHP 2.3でコマンドラインから CakePHPで記述した処理を実行する方法を解説します。

: CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。

: MySQL＋CakePHPのdate型、datetime型項目は「2999-12-31」までしか扱えない

CakePHPの日付、日時の型であるdate型、datetime型の最大値は2999-12-31となっている。MySQLは9999年までなので違いがあるので注意が必要だ。

: CakePHP4の定数定義ファイルを環境変数によって本番と開発を振り分ける方法解説

CakePHP4で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定しそれを読み込み判別する。

: CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得

URLやドメイン、フォルダへのパスの取得は、ビューではUrlHelperを使い、コントローラーではRouterクラスを使います。第2引数の指定でURLを取得することも可能。

: CakePHP 2.3　デバッグキット（DebugKit）超初心者向けフォロー講座

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

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

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

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

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

: CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法

CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングをする方法を解説。インストール方法、読み込み方法。および、具体的なスクレイピングを実行するサンプルソースも。