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のバリデーションを入力値・項目の条件によって変える方法を解説

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

: CakePHP 2.x系　Viewでのコメントの記述方法など

CakePHPにおいて View、ctpファイルでコメントを記述する方法を解説。

: CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説

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

: CakePHPで Auto Incrementを外すと Duplicate entry ‘0’ for keyのエラーが出るかも

CakePHPでAuto Incrementの設定を変更したときに「Duplicate entry ‘0’ for key」のエラーが出た。原因はModel内で IDを編集する処理の追加を忘れていたからだった。

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

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

: CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。

: CakePHP3ログファイルへの出力・$this->log()、独自ログへの出力方法の解説

コントロール、モデルの変数の中身を見るときはログに出力する方法が有効です。$this->log()を利用すると変数だけじゃなく、連想配列、オブジェクトも簡単にログ出力ができます。

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

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