CakePHP3でレコードを保存（追加、更新、Insert、Update）する複数の方法を紹介

CakePHP3でレコードを保存（追加（Insert）、更新（Update））する方法を紹介

レコードを追加、更新する方法の前提

　
CakePHP3でレコードを追加する方法、更新する方法について解説します。
　
レコードを追加（Insert）する方法も、更新（Update）する方法も 1つではありませんので、複数の方法を紹介しつつ、活用方法や特徴を解説します。
　
　
なお、この記事は、下記の記事である「CSVファイルを読み込んでテーブルを更新する」と言う処理の実験をベースに記事を書いています。
CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説

そのため、一般的な「画面から入力された情報を保存する」という処理とは「foreach」文などが若干異なります。
その辺りについては、解説を加えてはいますが。
　
　
今回のプログラムで更新対象としているテーブルは以下の内容です。
　

CREATE TABLE bookmarks2 (
    id INT AUTO_INCREMENT PRIMARY KEY,
    user_id INT NOT NULL,
    title VARCHAR(50),
    description TEXT,
    url TEXT,
    flag_code INT,
    flag INT,
    created DATETIME,
    modified DATETIME,
    FOREIGN KEY user_key (user_id) REFERENCES users(id)
);

　
https://book.cakephp.org/3/ja/tutorials-and-examples/bookmarks/intro.html
このテーブルは、上記の CookBookの「ブックマークチュートリアル」で利用したテーブルを流用したテーブルになります。
（記事の「bookmarks」テーブルを元に「flag_code」「flag」のカラムを追加した「bookmarks2」テーブルを作成しています。）
　
また、「ブックマークチュートリアル」に関連した記事としては以下の記事もあります。
CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装
　
　

CSVファイルを更新する Controllerの処理

　
CSVアップロードの処理全体は「CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説」を読んでいただくとして、そのうちの Controller（/src/Controller/HogesController.php）の処理の基本形は以下のものとなります。
　

<?php
namespace App\Controller;

use App\Controller\AppController;
use App\Form\HogeCsvForm; // モデルなしフォームロード
use Cake\Filesystem\Folder;  // Folderユーティリティロード

class HogesController extends AppController
{
    public function initialize()
    {
        parent::initialize();
        $this->loadComponent("Csv"); // CSVコンポートロード
    }
   public function csv()
    {
        $hogesCsv = new HogeCsvForm();
        if ($this->request->is(["patch", "post", "put"])) {
            if ($hogesCsv ->execute($this->request->getData())) {
                // ファイルコピー
                $path = ROOT . DS . "uploadfiles" . DS . "tmp";
                $folder = new Folder();
                $folder->create($path);
                $file = $path . DS . sha1(uniqid(mt_rand(), true)) . ".csv";
                if (move_uploaded_file($this->request->getData("csv.tmp_name"), $file)) {
                    chmod($file, 0644);

                    // CSVデータ取込
                    $csvData = $this->Csv->getCsv($file,"utf8",true);

                    // データ整形
                    $data = [];
                    foreach ($csvData as $vol) {
                        $data[] = [
                            "user_id"   => 1,
                            "title"     => $vol[1],
                            "flag"      => $vol[0],
                            "flag_code" => $vol[0],
                        ];
                    }

                    // データ登録
                    $this->loadModel("Bookmarks2");
                    $entities = $this->Bookmarks2->newEntities($data);
                    $result = $this->Bookmarks2->saveMany($entities);

                    unlink($file);
                    $this->Flash->success("登録しました。");
                }else{
                    $this->Flash->error("登録に失敗しました。");
                }
            } else {
                $this->Flash->error("登録に失敗しました。");
            }
        }
        $this->set("hogesCsv", $hogesCsv);
    }
}

　
　
この Controllerの処理の中で、
32～40行目で保存するレコードを整形し、
43～45行目で整形したレコードをテーブルに保存しています。
　
まず始めに、CSVとして取得したレコード全体で配列を作成し、「saveMany()」メソッドで一括して保存する処理となっています。
　
　
この記事では、このレコードを整形し、テーブルに保存する処理のバリエーションを解説します。
　
　
ちなみに、この処理では CSVファイルを一括して処理するため速い処理が期待できます。
　
ですが、カラム数にもよりますが、数百件程度であれば全く問題がなくても、万単位のレコードがある場合は、メモリオーバーや処理時間オーバーなどの不具合が発生する場合も考えられるため、CSVの件数が多くなる可能性がある場合は、件数をカウントして処理を分岐するなどの対応が必要だろうと思います。
　
　

テーブルの接続方法のバリエーション

　
まず始めに、テーブルに接続する方法のバリエーションです。
　
先の例では下記の記述で「Bookmarks2」のモデルをロードしています。
　

$this->loadModel("Bookmarks2");

　
ロードしたモデルを下記のように使用します。
　

$this->Bookmarks2->newEntities($data);

　
　
モデルを呼び出すほかの方法としては、下記の記述方法もあります。
まず、Controllerの use句を書いている箇所に下記を追記します。
　

use Cake\ORM\TableRegistry;

　
また、先の「$this->loadModel("Bookmarks2");」の記述を、下記の記述に変更します。
　

$this->Bookmarks2 = TableRegistry::getTableLocator()->get('Bookmarks2');

「save()」メソッドで 1件ずつ追加（Insert処理・その２）

　
最初のサンプルでは「saveMany()」メソッドを使用して、一括保存する処理でした。
　
その２では「save()」メソッドを使用して 1件ずつ保存する処理を紹介します。
　

      // レコードを新規登録するとき・その２
      $this->loadModel("Bookmarks2");

      foreach ($csvData as $vol) {
          $bookmarks2 = $this->Bookmarks2->newEntity();
          $bookmarks2->user_id   = 1;
          $bookmarks2->title     = $vol[1];
          $bookmarks2->flag      = $vol[0];
          $bookmarks2->flag_code = $vol[0];

          $this->Bookmarks2->save($bookmarks2);

//        if($this->Bookmarks2->save($bookmarks2)){
//            $id = $bookmarks2->id;
//        } else {
//            エラー処理
//        }
      }

　
この処理が、Bakeを実行して自動的に作成される処理に一番近い処理になります。
foreach文で配列から 1件ずつレコードを取り出して、saveメソッドで保存しています。
　
また、コメントにしていますが、11行目を 13～17行目と置き換えることで、正常に保存できた場合は保存したレコードの IDを取得することや、エラーが発生した場合はそのエラーの対処することなど、1件ずつ細かな管理をすることを容易にすることができます。
　
CSVの件数が少ない場合はこのような処理方法も使用できるでしょう。
　
　
基本的な処理が CSVファイルを取得することを想定していますので、配列「$csvData」を foreach文で処理しています。

ですが、入力フォームから取得した値 1件を受け取って保存する場合は以下の記述になります。
　

      $this->loadModel("Bookmarks2");
      $data = $this->request->getData();
      $bookmarks2 = $this->Bookmarks2->newEntity($data);
      $this->Bookmarks2->save($bookmarks2);

　
より Bakeされた際に作成される処理に近づけるならば下記の記述になります。
　

      $this->loadModel("Bookmarks2");
      $bookmarks2 = $this->Bookmarks2->newEntity();
      $data = $this->request->getData()
      $bookmarks2 = $this->Bookmarks2->patchEntity($bookmarks2,$data);
      $this->Bookmarks2->save($bookmarks2)

「save()」メソッドで 1件ずつ更新（Update処理・その１）

　
ここからは、レコードを更新する（Update）処理について解説します。
　
　

「get()」メソッドを使い IDからレコードを取得（その１－１）

　
CSVから取得する項目に IDが含まれ、IDを利用してレコードを更新する場合は下記のように記述することが出来ます。
　

    // レコードを更新するとき・その1-1
    $this->loadModel("Bookmarks2");

    foreach ($csvData as $vol) {
        if( $this->Bookmarks2->exists(["id"=>$vol[0]]) ){
            $bookmarks2 = $this->Bookmarks2->get($vol[0]);
            $bookmarks2->flag  = 4;
            $bookmarks2->title = $vol[1];
            $result = $this->Bookmarks2->save($bookmarks2);
        }
    }

　
getメソッドは、レコードの IDを指定してレコードを取得する処理ですが、指定した IDがない場合はエラーとなります。
　
テーブルに保存されていない IDが入力される可能性がある場合は、取得できない場合に例外処理（エラー処理）とする方法もありますが、ここではまず始めに existsメソッドでレコードの存在チェックをする方法を採用しています。
　
　

「find()」メソッドを使い条件に合致するレコードを取得する（その１－２）

　
IDがない可能性を考慮する場合や、取得する CSVに IDが含まれない、もしくは、プライマリーキーとなる ID以外をキーとしてレコードを更新したい場合は下記のように findメソッドを使用する方法が有効です。
　

    // レコードを更新するとき・その1-2
    $this->loadModel("Bookmarks2");

    foreach ($csvData as $vol) {
        $bookmarks2 = $this->Bookmarks2->find()->where(["flag_code"=>$vol[0]])->first();

        if($bookmarks2){
            $bookmarks2->flag = 1;
            $bookmarks2->title = $vol[1];
            $result = $this->Bookmarks2->save($bookmarks2);
        }
    }

「find()」メソッドを使い条件に合致するレコードを取得（その１－３）

　
基本的には「その１－２」と変わりませんが、5行目と 7行目を 1行にまとめて下記のように記述することも出来ます。
　

    // レコードを更新するとき・その1-3
    // 「その1-2」の処理を作るくらいならこちらのほうがマシ
    $this->loadModel("Bookmarks2");

    foreach ($csvData as $vol) {
        if($bookmarks2 = $this->Bookmarks2->find()->where(["flag_code"=>$vol[0]])->first()){
            $bookmarks2->flag = 1;
            $bookmarks2->title = $vol[1];
            $result = $this->Bookmarks2->save($bookmarks2);
        }
    }

「save()」メソッドで 1件ずつ更新（Update処理・その２）

　
あまり代わり映えはしませんが、保存するレコードを配列で整形する方法もあります。
　

    // レコードを更新するとき・その2
    $this->loadModel("Bookmarks2");

    foreach ($csvData as $vol) {
        $bookmarks2 = $this->Bookmarks2->find()->where(["flag_code"=>$vol[0]])->first();

        if($bookmarks2){
            $data = [
                "flag"  => 4,
                "title" => $vol[1],
            ];

            $entity = $this->Bookmarks2->patchEntity($bookmarks2, $data); 
            $this->Bookmarks2->save($entity);
        }
    }

「Query()」メソッドで複数件のレコードを更新（Update処理・その３）

　
続いて、複数のレコードをまとめて更新する方法です。
　
更新のその1、その2は、CSVの 1行でテーブルの 1レコードを更新する更新方法です。
　
「その1-1」は IDをキーに更新を行いますので 1レコードしかありませんが、「その1-2」「その1-3」「その2」に関しては、「["flag_code"=>$vol[0]]」の条件に該当するレコードが複数件ある場合も存在します。
処理上は、firstメソッドを用いていますので、そのうちの最初の 1件のみ更新する処理になっていますが。
　
　
このように、条件に該当するレコードが複数ある場合は、複数件まとめて更新する方法が以下の処理になります。
　
Queryメソッドを使って Update文を生成する方法です。
　

    // レコードを更新するとき・その3
    $this->loadModel("Bookmarks2");

    foreach ($csvData as $vol) {
        $data = [
            "flag"  => 4,
            "title" => $vol[1],
        ];

        $query = $this->Bookmarks2->query();
        $query->update()
              ->set($data)
              ->where(["flag_code" => $vol[0]])
              ->execute();
    }

「UpdateAll()」メソッドで複数件のレコードを更新（Update処理・その４）

　
前項と同じく、条件に該当するレコードが複数件ある場合は、下記のように UpdateAllメソッドを使う方法もあります。
　

    // レコードを更新するとき・その4
    $this->loadModel("Bookmarks2");

    foreach ($csvData as $vol) {
        $data = [
            "flag"  => 4,
            "title" => $vol[1],
        ];
        $condition = [ "flag_code" => $vol[0] ];

        $this->Bookmarks2->updateAll($data,$condition);
    }

CakePHP3の関連記事