CakePHP 2.3で saveの便利な使い方・サンプルソース付き

2014/04/04 2016/04/27

CakePHPで Save関数で保存する

CakePHPでレコードを更新する方法・概要

　
CakePHPは非常に便利で、主キーをもとにレコードを更新する場合は、下記の記述方法で簡単に処理できます。

$this->テーブル名->save($this->request->data)

1	$this->テーブル名->save($this->request->data)

　
ただ、この処理では、入力された値をそのまま保存する処理になりますので、入力された値を何倍かにするとか、値と値を足して編集するとか、そんな保存方法を調べて見ましたので説明します。
　
上記の saveの処理を下記の記述方法に変更することで更新処理が行えるようになります。
　

$this->テーブル名->save(
       array ( 'id' => idの値 ),
               '更新するカラム'   => 更新するの値 )

$this->テーブル名->save(

array ( 'id' => idの値 ),

'更新するカラム' => 更新するの値 )

※2016.04.27　間違いを修正しました。
　
　

CakePHP2 実践入門 (WEB+DB PRESS plus)

CakePHPでレコードを更新する方法・具体例

　
ここで説明するサンプルプログラムは、「CakePHP 2.3 主キー（ID）以外のキーで更新方法 updateAll」で説明したテーブルと、Controller、Model、Viewをもとに処理を追加して作成しています。
　
そのため、実際にサンプルプログラムを動かしてみようと思う方は、上記記事も併せて試してみてください。
　
また、ここで説明する処理は、主キー（ID）を指定して保存する処理になりますので、主キー（ID）以外のキーを条件に更新をしたい場合は上記の記事を参考にしてください。
　
　
今回も修正するファイルは、Controllerです。
　
/app/Controller/CommentsController.php
———————————

  public function edit($id = null) {
    if (!$this->Comment->exists($id)) {
      throw new NotFoundException(__('Invalid comment'));
    }
    if ($this->request->is('post') || $this->request->is('put')) {
      if ($this->Comment->save($this->request->data)) {
        $this->Session->setFlash(__('The comment has been saved'));
        $this->redirect(array('action' => 'index'));
      } else {
        $this->Session->setFlash(__('The comment could not be saved. Please, try again.'));
      }
    } else {
      $options = array('conditions' => array('Comment.' . $this->Comment->primaryKey => $id));
      $this->request->data = $this->Comment->find('first', $options);
    }
  }

public function edit($id = null) {

if (!$this->Comment->exists($id)) {

throw new NotFoundException(__('Invalid comment'));

}

if ($this->request->is('post') || $this->request->is('put')) {

if ($this->Comment->save($this->request->data)) {

$this->Session->setFlash(__('The comment has been saved'));

$this->redirect(array('action' => 'index'));

} else {

$this->Session->setFlash(__('The comment could not be saved. Please, try again.'));

}

} else {

$options = array('conditions' => array('Comment.' . $this->Comment->primaryKey => $id));

$this->request->data = $this->Comment->find('first', $options);

}

———————————
　
上記が Bakeで作成される「edit」関数の部分です。
その部分をコピーして作成したものが下記の edit3の関数です。
上記の 6行目を 6行目～8行目に変更しています。
今回も、変更する部分はここだけです。
　
/app/Controller/CommentsController.php
———————————

  public function edit3($id = null) {
    if (!$this->Comment->exists($id)) {
      throw new NotFoundException(__('Invalid comment'));
    }
    if ($this->request->is('post') || $this->request->is('put')) {
      $save_array = array ( 'id'      => $this->request->data['Comment']['id'],
                            'post_id' => $this->request->data['Comment']['post_id'] );
      if ($this->Comment->save($save_array)) {
        $this->Session->setFlash(__('The comment has been saved'));
        $this->redirect(array('action' => 'index'));
      } else {
        $this->Session->setFlash(__('The comment could not be saved. Please, try again.'));
      }
    } else {
      $options = array('conditions' => array('Comment.' . $this->Comment->primaryKey => $id));
      $this->request->data = $this->Comment->find('first', $options);
    }
  }

public function edit3($id = null) {

if (!$this->Comment->exists($id)) {

throw new NotFoundException(__('Invalid comment'));

}

if ($this->request->is('post') || $this->request->is('put')) {

$save_array = array ( 'id' => $this->request->data['Comment']['id'],

'post_id' => $this->request->data['Comment']['post_id'] );

if ($this->Comment->save($save_array)) {

$this->Session->setFlash(__('The comment has been saved'));

$this->redirect(array('action' => 'index'));

} else {

$this->Session->setFlash(__('The comment could not be saved. Please, try again.'));

}

} else {

$options = array('conditions' => array('Comment.' . $this->Comment->primaryKey => $id));

$this->request->data = $this->Comment->find('first', $options);

}

———————————
　
この saveの関数は、主キーである IDを指定することで更新処理を行います。
そのため、上記の 6行目の様に「’id’ => $this->request->data[‘Comment’][‘id’]」を指定することでその IDのレコードの情報を更新します。
　
もともとこの記事は、主キー（ID）以外のキーで更新することを確認するために書き始めた記事ということもあって、6行目、7行目を下記の様に 1つ目の項目を主キー（ID）以外のものを設定すると、もしかするとその項目をキーに値の更新ができるんじゃないか、と淡い期待を抱いてみましたが、違う動きになりました。
Save関数は、主キー（ID）が指定されている場合は、そのキーの値を UPDATE処理を行い、主キーがない場合は、INSERT処理を行う仕様になっていますので、IDを指定しないと単なる Insertになりました。
　
———————————

      $save_array = array ( 'post_id'  => $this->request->data['Comment']['post_id'], 
                            'sec_code' => $this->request->data['Comment']['sec_code'] );

1 2	$save_array = array ( 'post_id' => $this->request->data['Comment']['post_id'], 'sec_code' => $this->request->data['Comment']['sec_code'] );

———————————
　
ちなみに、IDは配列の中に指定してあれば問題なく、順番は特に指定はないようです。
そのため、下記の様に IDが最後でも何の問題もなく更新処理が行われます。
　
———————————

      $save_array = array ( 'post_id' => $this->request->data['Comment']['post_id'], 
                            'id'      => $this->request->data['Comment']['id'] );

1 2	$save_array = array ( 'post_id' => $this->request->data['Comment']['post_id'], 'id' => $this->request->data['Comment']['id'] );

———————————
　
また、下記の様に更新する項目を複数指定すれば指定しただけの項目を更新することができまs。
　
———————————

      $save_array = array ( 'id'      => $this->request->data['Comment']['id'],
                            'post_id'  => $this->request->data['Comment']['post_id'], 
                            'sec_code' => $this->request->data['Comment']['sec_code'] );

$save_array = array ( 'id' => $this->request->data['Comment']['id'],

'post_id' => $this->request->data['Comment']['post_id'],

'sec_code' => $this->request->data['Comment']['sec_code'] );

———————————
　
また、post_idの値を 5倍にして保存するような場合は、下記の様に値を編集することで処理できます。
　
———————————

      $save_array = array ( 'id'      => $this->request->data['Comment']['id'],
                            'post_id'  => $this->request->data['Comment']['post_id'] * 5, 
                            'sec_code' => $this->request->data['Comment']['sec_code'] );

$save_array = array ( 'id' => $this->request->data['Comment']['id'],

'post_id' => $this->request->data['Comment']['post_id'] * 5,

'sec_code' => $this->request->data['Comment']['sec_code'] );

———————————
　
また、listのような varcharの項目ですが、updateAllであったような不具合はありませんでしたので、下記の様にシングルクォートで囲む必要はありません。
逆に、Save関数の場合は、シングルクォートで囲むとシングルクォートが付いたまま保存されますので注意が必要です。
　
———————————

      $save_array = array ( 'id'      => $this->request->data['Comment']['id'],
                            'post_id'  => $this->request->data['Comment']['post_id'], 
                            'list' => "'" . $this->request->data['Comment']['list'] . "'" );

$save_array = array ( 'id' => $this->request->data['Comment']['id'],

'post_id' => $this->request->data['Comment']['post_id'],

'list' => "'" . $this->request->data['Comment']['list'] . "'" );

———————————

- CakePHP 3.x 4.x 5.x

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

Comment

sira より:

2016年4月24日 7:41 PM

以下についてですが，

$this->テーブル名->save(
array ( ‘id’ => idの値 ),
array ( ‘更新するカラム’ => 更新するの値 ) )

正しくは，

$this->テーブル名->save(
array (
‘id’ => idの値,
‘更新するカラム’ => 更新するの値
)
)

返信
- エス技研より:
  
  2016年4月27日 8:36 AM
  
  siraさん、コメントありがとうございます。
  ご指摘の件、間違っていましたね。
  確認させていただき、本文の方も修正させていただきました。ありがとうございます！
  他にも間違いがあるかもしれませんが．．．
  
  返信

Message コメントをキャンセル

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

: CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する

CakePHP3のkeywordsとdescriptionを設定する方法の解説。CakePHP3にはmetaタグを編集するHTMLヘルパーが用意されているためそれを利用すればOK！ポイントはブロック化を有効にすること。

: CakePHP5でヘルパーから他のヘルパーを読み込む方法・CakePHP4からの変更点

CakePHP5のヘルパーで他のヘルパーを読み込む方法を解説。公式の日本語CookbookはCakePHP4のソースのままで間違っているため注意が必要。CakePHP4からの移行の際も同じ点に注意が必要。

: CakePHP 2.3でファイルのアップロード処理を作る

CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。

: CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法

CakePHPには「FrozenDate」の日付を扱う関数が用意されている。これを利用して、1ヶ月後、月末日、月初日、5日後などを指定して日付を取得できる。それを解説。

: Windows環境の XAMPPを利用して CakePHPの開発する際の注意点

WindowsベースにXAMPPで環境を構築しCakePHP4を利用したWebシステムを構築する際は、大文字と小文字の違いを意識する必要がある。LinuxベースのWebサーバに移動させたときに不具合で動作しないこともある。