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 CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3のタイムゾーンを協定世界時UTCから日本標準時間JSTにずれを変更する方法

CakePHP3の標準設定のタイムゾーンは「UTC（協定世界時）」に設定されている。これを日本標準時に変更する方法（app.php、bootstrap.phpの変更方法）の解説。

: CakePHP3のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）

CakePHP3の英語のメッセージを日本語化（多言語化）する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。

: CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説

入力された値によってバリデーション（入力チェック）の内容を切り替える。その処理をCakePHPで実装する方法を解説。条件ごとに unset関数を使ってバリデーションを削除する、という方法を採る。

: CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順

CakePHP3で「1対多」の連携を中間テーブルを利用した「多対多」の連携に変更するときの手順のまとめ。中間テーブルの設定やModelの変更などを間違いやすい箇所を指摘しながらの解説。

: CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。