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

2017/02/24 2017/10/28

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

CakePHP3のアソシエーション機能による削除処理の解説

　
「CakePHP3でassociatedを使って関連データをまとめて保存する方法（hasOne、hasMany、belongsTo）」の記事で、アソシエーション機能を使って関連するレコードをまとめて保存する処理の解説をしました。
　
今回は、そのまとめて保存したレコードを、まとめて削除する処理を解説します。
テーブルの構造などは、「CakePHP3でassociatedを使って関連データをまとめて保存する方法（hasOne、hasMany、belongsTo）」を参照してください。
　
　

コントローラーの修正はありません

　
下記のソースは、Bakeで作成したソースですが、コントローラーの修正は全くありません。
　

public function delete($id = null)
{
    $this->request->allowMethod(['post', 'delete']);
    $entryData = $this->EntryDatas->get($id);
    if ($this->EntryDatas->delete($entryData)) {
        $this->Flash->success(__('The site name has been deleted.'));
    } else {
        $this->Flash->error(__('The site name could not be deleted. Please, try again.'));
    }

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

public function delete($id = null)

{

$this->request->allowMethod(['post', 'delete']);

$entryData = $this->EntryDatas->get($id);

if ($this->EntryDatas->delete($entryData)) {

$this->Flash->success(__('The site name has been deleted.'));

} else {

$this->Flash->error(__('The site name could not be deleted. Please, try again.'));

}

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

}

Tableファイルに「`'dependent' => true`」を追加

　
処理を追加する対象のファイルは「EntryDatasTable.php」です。
「EntryDatasTable.php」にある「hasMany」に「’dependent’ => true」を追加することで、関連テーブルの情報がまとめて削除されます。
　

    public function initialize(array $config)
    {
          ：
          ：
        $this->hasMany('JobDatas', [
            'foreignKey' => 'entry_datas_id'
            'dependent' => true
        ]);
    }

public function initialize(array $config)

{

：

$this->hasMany('JobDatas', [

'foreignKey' => 'entry_datas_id'

'dependent' => true

]);

}

　
たったこれだけのコードを追加するだけで、「EntryDatas」テーブルのレコードを削除する際に、関連する「JobDatas」テーブルのレコードもすべて削除してくれます。
　
　
アソシエーション機能を使って関連データを保存する際にも感じましたが、削除する場合も簡単に関連データを削除でき、まさにフレームワークを使うメリットを存分に発揮する箇所ですね。
　
　
詳細については、CakePHP3のマニュアルを参照してください。
https://book.cakephp.org/3.0/ja/orm/deleting-data.html
　
　

- CakePHP 3.x 4.x 5.x CakePHP3

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

Message コメントをキャンセル

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

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

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

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。CakePHP4で使う場合のUsersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。

: CakePHP 2.3　テーブルの項目を演算した結果を条件として抽出する方法

アソシエーション（連携）している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。

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

ID以外のカラムでアソシエーション（連携）させるための考え方とサンプルソースを用いての説明を行っています。

: CakePHP4の規約外のカラムをキーにアソシエーション（テーブル連結）する方法

CakePHPで規定外のカラム名のキーを指定してアソシエーション（テーブル連結）をする方法を解説。アソシエーション名によってはミスが発生しやすい点もあるので注意も必要。

: CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。