データを保存する¶

CakePHPはモデルのデータを簡単に保存できます。保存するデータは、モデルの save() メソッドに、以下の形式の配列で渡されます。

Array
(
    [ModelName] => Array
    (
        [fieldname1] => 'value'
        [fieldname2] => 'value'
    )
)

ほとんどの場合、このような形式を意識することはありません。CakePHPの FormHelper やモデルのfindメソッドは全てこの形式に従っています。FormHelperを使っていれば、 $this->request->data で簡単にこの形式のデータにアクセスできるようになっています。

データベースのテーブルにデータを保存するためにCakePHPのモデルを使った簡単なサンプルを以下に示します。

public function edit($id) {
    // フォームからポストされたデータがあるかどうか
    if ($this->request->is('post')) {
        // フォームのデータを検証して保存する...
        if ($this->Recipe->save($this->request->data)) {
            // メッセージをセットしてリダイレクトする
            $this->Session->setFlash('Recipe Saved!');
            return $this->redirect('/recipes');
        }
    }

    // フォームからのデータがなければレシピデータを取得して
    // ビューへ渡す
    $this->set('recipe', $this->Recipe->findById($id));
}

saveが呼び出されると、最初に引数に渡されたデータは、CakePHPのバリデーション機構によって検証されます(より詳しくは /models/data-validation を参照してください)。何かしらの理由でデータが保存されなかった場合は、バリデーションルールがおかしくないかどうか確認してみてください。Model::$validationErrors を出力することで、現在どういう状況なのかデバッグできます。

if ($this->Recipe->save($this->request->data)) {
    // 保存に成功した時の処理
}
debug($this->Recipe->validationErrors);

他に、データ保存に関連する便利なメソッドがいくつかあります。

`Model::set($one, $two = null)`¶

Model::set() は、モデルに1つまたは複数のフィールドのデータをセットするのに使われます。これは、モデルのActiveRecord機能を使う時に便利です。

$this->Post->read(null, 1);
$this->Post->set('title', 'New title for the article');
$this->Post->save();

この例は、 ActiveRecordで set() を使って単一のフィールドを更新して保存する方法です。複数のフィールドの値をセットするのにも set() が使えます。

$this->Post->read(null, 1);
$this->Post->set(array(
    'title' => 'New title',
    'published' => false
));
$this->Post->save();

上記の例では、titleとpublishedフィールドが保存されます。

`Model::save(array $data = null, boolean $validate = true, array $fieldList = array())`¶

このメソッドは配列の形式のデータを受け取ってそれを保存します。2つ目のパラメータはバリデーションをしない場合に使われ、3つめのパラメータは保存する対象のフィールドのリストを渡します。セキュリティ向上のために、 $fieldList を使って保存する対象のフィールドを制限することができます。

ノート

$fieldList が渡されなければ、もともとは変更する予定のなかったフィールドでも、悪意のあるユーザーがフォームデータに任意のフィールドのデータを追加できてしまいます(SecurityComponent を使っていない場合)。

以下のような引数を受け取るsaveメソッドもあります。

save(array $data = null, array $params = array())

$params 配列には、以下のキーを指定できます。

validate バリデーションの有効または無効について、trueまたはfalseを指定します。
fieldList 保存する対象のフィールドのリストを指定します。
callbacks falseをセットするとコールバックを無効にします。他に’before’または’after’を指定して、コールバックを有効にできます。

モデルのコールバックについての詳細は こちら を参照してください。

ちなみに

modified フィールドを自動更新したくない場合は、保存の際に $data 配列へ'modified' => false を追加してください。

saveが完了すると、モデルオブジェクトの $id に保存されたデータのIDがセットされます。このプロパティは、特に新しくオブジェクトを生成した時に使われます。

$this->Ingredient->save($newData);
$newIngredientId = $this->Ingredient->id;

データを新しく作るか更新するかは、モデルの id フィールドによって決まります。$Model->id がセットされていれば、このIDをプライマリーキーにもつレコードが更新されます。それ以外は新しくレコードが作られます。

// Create: idがセットされていない
$this->Recipe->create();
$this->Recipe->save($this->request->data);

// Update: idに整数値がセットされている
$this->Recipe->id = 2;
$this->Recipe->save($this->request->data);

ちなみに

ループ中でsaveを呼び出すときは、 create() を忘れないようにしてください。

新しくデータを作るのではなく、データを更新したい場合は、data配列にプライマリーキーのフィールドを渡してください。

$data = array('id' => 10, 'title' => 'My new title');
// idが10のレシピを更新
$this->Recipe->save($data);

`Model::create(array $data = array())`¶

このメソッドはデータを保存するためにモデルの状態をリセットします。実際にはデータベースにデータは保存されませんが、Model::$idフィールドがクリアされ、データベースのフィールドのデフォルト値を元にModel::$dataの値をセットします。データベースフィールドのデフォルト値が存在しない場合、Model::$dataには空の配列がセットされます。

$data パラメータ(上記で説明したような配列の形式)が渡されれば、データベースフィールドのデフォルト値とマージされ、モデルのインスタンスはデータを保存する準備ができます(データは $this->data でアクセスできます)。

$data パラメータへ false や null が渡された場合、Model::data には空の配列がセットされます。

ちなみに

既存のレコードを更新するのではなく新しくレコードを追加したい時は、最初にcreate()を呼び出してください。これによって、コールバックの中や他の場所からsaveメソッドを呼び出した時に、事前にコンフリクトを避けることができます。

`Model::saveField(string $fieldName, string $fieldValue, $validate = false)`¶

単一のフィールドを保存する時に使います。 saveField() を呼ぶ前にはモデルのIDをセットしておいてください($this->ModelName->id = $id)。また、 $fieldName にはモデル名 + フィールド名ではなく、フィールド名のみ含ませるようにしてください。

たとえば、ブログ投稿のタイトルを更新する場合は、コントローラーからの saveField の呼び出しは以下のようになります。

$this->Post->saveField('title', 'A New Title for a New Day');

警告

このメソッドを使うと、 modified フィールドは更新されてしまいます。更新したく無い場合はsave()メソッドを使う必要があります。

`Model::updateAll(array $fields, array $conditions)`¶

このメソッドは、1度の呼び出しで複数のレコードを更新できます。更新対象のレコードは $conditions で、更新対象のフィールドとその値は$fields で指定します。

たとえば、1年以上前にメンバーになったbakerを承認するには、以下のようにメソッドを呼び出します。

$this_year = date('Y-m-d h:i:s', strtotime('-1 year'));

$this->Baker->updateAll(
    array('Baker.approved' => true),
    array('Baker.created <=' => $this_year)
);

ちなみに

$fieldsにはSQLも指定できます。リテラルは Sanitize::escape() を使って手動でクォートしてください。

ノート

このメソッドは、modifiedフィールドがテーブルにあっても自動的に更新してくれません。modifiedフィールドも更新したければ配列に追加してください。

これは、特定の顧客に紐付くチケットを全て閉じる例です。

$this->Ticket->updateAll(
    array('Ticket.status' => "'closed'"),
    array('Ticket.customer_id' => 453)
);

デフォルトでは、updateAll()は自動的にbelongsToアソシエーション先を結合します。必要なければ、このメソッドを呼ぶ前に一時的にアソシエーションを解除してください。

`Model::saveMany(array $data = null, array $options = array())`¶

このメソッドは、同じモデルの複数のレコードを一度に保存するために使います。以下のオプションが指定できます。

validate: バリデーションを実行しない場合にfalseを指定します。trueを指定すると各レコードの保存前にバリデーションを行います。’first’を指定すると、データの保存前に全てのレコードのバリデーションを行います(これがデフォルトです)。
atomic: trueを指定すると(デフォルト)、単一のトランザクションで全レコードを保存しようとします。データベースがトランザクションをサポートしていない場合はfalseを指定してください。
fieldList: Model::save()の$fieldListパラメータと同じです。
deep: trueを指定すると、アソシエーションのデータも保存されます。saveAssociatedについても参照してください(このオプションは2.1以降)。

単一モデルで複数レコードを保存するためには、$data配列は以下のように数値をインデックスとしてもつ配列である必要があります。

$data = array(
    array('title' => 'title 1'),
    array('title' => 'title 2'),
);

ノート

いつものようにモデル名Articleというキーの $data 配列ではなく、数値のインデックスを渡していることに注意してください。同じモデルで複数のレコードを保存する時は、レコードの配列はモデル名がキーではなく数値がキーである必要があります。

以下のような形式のデータでも受け取る事ができます。

$data = array(
    array('Article' => array('title' => 'title 1')),
    array('Article' => array('title' => 'title 2')),
);

2.1からですが、 $options['deep'] = true と指定することで、アソシエーションデータも保存できます。以下の例を見てください。

$data = array(
    array('title' => 'title 1', 'Assoc' => array('field' => 'value')),
    array('title' => 'title 2'),
);
$data = array(
    array('Article' => array('title' => 'title 1'), 'Assoc' => array('field' => 'value')),
    array('Article' => array('title' => 'title 2')),
);
$Model->saveMany($data, array('deep' => true));

新しくレコードを作るのではなく、既存レコードの更新をしたい場合は、データ配列にプライマリーキーを追加してください。

$data = array(
    array('Article' => array('title' => 'New article')), // これは新しくレコードを作ります
    array('Article' => array('id' => 2, 'title' => 'title 2')), // これは既存のレコードを更新します
);

`Model::saveAssociated(array $data = null, array $options = array())`¶

一度に複数のアソシエーションモデルのデータを保存するのに使われるメソッドです。$options配列には以下のキーが使われます。

validate: バリデーションを実行しない場合にfalseを指定します。trueを指定すると各レコードの保存前にバリデーションを行います。’first’を指定すると、データの保存前に全てのレコードのバリデーションを行います(これがデフォルトです)。
atomic: trueを指定すると(デフォルト)、単一のトランザクションで全レコードを保存しようとします。データベースがトランザクションをサポートしていない場合はfalseを指定してください。
fieldList: Model::save()の$fieldListパラメータと同じです。
deep: (2.1から) trueを指定すると、1階層目のアソシエーションのデータだけでなく、より深い階層のアソシエーションのデータも保存されます。デフォルトではfalseです。

hasOneまたはbelongsToアソシエーションの関連レコードと一緒にレコードを保存する場合は、データ配列は以下のようになります。

$data = array(
    'User' => array('username' => 'billy'),
    'Profile' => array('sex' => 'Male', 'occupation' => 'Programmer'),
);

hasManyアソシエーションの関連レコードを保存するには、以下のようなデータ配列を準備してください。

$data = array(
    'Article' => array('title' => 'My first article'),
    'Comment' => array(
        array('body' => 'Comment 1', 'user_id' => 1),
        array('body' => 'Comment 2', 'user_id' => 12),
        array('body' => 'Comment 3', 'user_id' => 40),
    ),
);

2階層以上のhasManyアソシエーションの関連レコードを保存するには、以下のようなデータを準備してください。

$data = array(
    'User' => array('email' => 'john-doe@cakephp.org'),
    'Cart' => array(
        array(
            'payment_status_id' => 2,
            'total_cost' => 250,
            'CartItem' => array(
                array(
                    'cart_product_id' => 3,
                    'quantity' => 1,
                    'cost' => 100,
                ),
                array(
                    'cart_product_id' => 5,
                    'quantity' => 1,
                    'cost' => 150,
                )
            )
        )
    )
);

ノート

メインのモデルの外部キーは、関連モデルのidフィールドに保存されます。($this->RelatedModel->id のように)

警告

bool値の代わりに配列を戻り値としたい場合は、saveAssociatedを呼ぶ時に、$optionsのatomicキーにfalseをセットしてください。

バージョン 2.1 で変更: $options['deep'] = true とすることで、2階層以上のデータを保存できるようになりました。

hasManyアソシエーションの関連レコードを保存して、同時にComment belongsTo User というアソシエーションのデータも保存するには、以下のようなデータ配列を準備します。

$data = array(
    'Article' => array('title' => 'My first article'),
    'Comment' => array(
        array('body' => 'Comment 1', 'user_id' => 1),
        array('body' => 'Save a new user as well', 'User' => array('first' => 'mad', 'last' => 'coder')),
    ),
);

そしてこのようにして保存してください。

$Article->saveAssociated($data, array('deep' => true));

バージョン 2.1 で変更: Model::saveAll() とそれに関連するメソッドは、複数モデルに対応する fieldList を受け取ることができるようになりました。

このようにして、複数モデルに対応する fieldList を渡すことができます。

$this->SomeModel->saveAll($data, array(
    'fieldList' => array(
        'SomeModel' => array('field_1'),
        'AssociatedModel' => array('field_2', 'field_3')
    )
));

fieldListはキーにモデルのエイリアスを、値にフィールドの値一覧を配列で指定します。モデル名はネストしません。

`Model::saveAll(array $data = null, array $options = array())`¶

saveAll は saveMany と saveAssociated のラッパーです。このメソッドはデータ内容をみて、 saveMany か saveAssociated のどちらを使うのかを決定します。データの添字が数値であれば saveMany を、それ以外は saveAssociated を呼び出します。

このメソッドは、前に説明した2つのメソッド(saveManyとsaveAssociated)と互換性があり、同じオプション引数をとります。場合によって、 saveMany または saveAssociated を使ったほうがいいこともあります。

hasManyを保存する¶

結合された2つのテーブルのモデルのデータがどうやって保存されるのかを見て行きましょう。hasMany through (モデルの結合) セクションにあるように、結合されたそれぞれのテーブルは hasMany アソシエーションで関連付けられています。ここでは、生徒の授業への出席日数と成績を記録するアプリケーションをサンプルとして書いてみたいと思います。以下のコードを見て下さい。

// Controller/CourseMembershipController.php
class CourseMembershipsController extends AppController {
    public $uses = array('CourseMembership');

    public function index() {
        $this->set('courseMembershipsList', $this->CourseMembership->find('all'));
    }

    public function add() {
        if ($this->request->is('post')) {
            if ($this->CourseMembership->saveAssociated($this->request->data)) {
                return $this->redirect(array('action' => 'index'));
            }
        }
    }
}

// View/CourseMemberships/add.ctp

<?php echo $this->Form->create('CourseMembership'); ?>
    <?php echo $this->Form->input('Student.first_name'); ?>
    <?php echo $this->Form->input('Student.last_name'); ?>
    <?php echo $this->Form->input('Course.name'); ?>
    <?php echo $this->Form->input('CourseMembership.days_attended'); ?>
    <?php echo $this->Form->input('CourseMembership.grade'); ?>
    <button type="submit">Save</button>
<?php echo  $this->Form->end(); ?>

このコードで、データをサブミットした時、以下のような配列が渡ってきます。

Array
(
    [Student] => Array
    (
        [first_name] => Joe
        [last_name] => Bloggs
    )

    [Course] => Array
    (
        [name] => Cake
    )

    [CourseMembership] => Array
    (
        [days_attended] => 5
        [grade] => A
    )

)

Cakeはこれらの配列を saveAssociated に渡すことで、各モデルのデータを同時に保存し、CourseMembershipモデルに対してStudentとCourseを外部キーとして割り当てることができます。CourseMembershipsControllerのindexアクションが実行されると、そこのfind(‘all’)で以下のような構造のデータが取得できます。

Array
(
    [0] => Array
    (
        [CourseMembership] => Array
        (
            [id] => 1
            [student_id] => 1
            [course_id] => 1
            [days_attended] => 5
            [grade] => A
        )

        [Student] => Array
        (
            [id] => 1
            [first_name] => Joe
            [last_name] => Bloggs
        )

        [Course] => Array
        (
            [id] => 1
            [name] => Cake
        )
    )
)

もちろん結合されたモデルを処理する方法は他にもあります。このやり方は一度に全てを保存したい時に使うものです。StudentとCourseをそれぞれ別々に作りたい場合もあるでしょう。また後でCourseMembershipに関連付けることもあるでしょう。ですので、リストやIDから既存のStudentとCourseを選んで、それらを登録するフォームがあれば、たとえばCourseMembershipに対するフィールドを次のように作ります。

// View/CourseMemberships/add.ctp

<?php echo $form->create('CourseMembership'); ?>
    <?php echo $this->Form->input('Student.id', array('type' => 'text', 'label' => 'Student ID', 'default' => 1)); ?>
    <?php echo $this->Form->input('Course.id', array('type' => 'text', 'label' => 'Course ID', 'default' => 1)); ?>
    <?php echo $this->Form->input('CourseMembership.days_attended'); ?>
    <?php echo $this->Form->input('CourseMembership.grade'); ?>
    <button type="submit">Save</button>
<?php echo $this->Form->end(); ?>

POSTされると以下のようなデータが渡ってきます。

Array
(
    [Student] => Array
    (
        [id] => 1
    )

    [Course] => Array
    (
        [id] => 1
    )

    [CourseMembership] => Array
    (
        [days_attended] => 10
        [grade] => 5
    )
)

このデータを使えば saveAssociated はStudentのIDとCourseのIDをCourseMembershipモデルに保存してくれます。

データテーブル¶

CakePHPは特定のDBMSに依存しないように設計されていて、MySQL, MSSQL, PostgreSQL, また他のDBMSでも動作します。いつもやってるようにデータベースにテーブルを作れます。モデルクラスを作れば、自動的にデータベースに作ったテーブルにマッピングされます。テーブル名は規約に従って、小文字の複数形にして、単語同士はアンダースコアで区切ります。たとえば、Ingredientというクラスはingredientsというテーブル名と対応します。EventRegistrationというクラスはevent_registrationsというテーブル名と対応します。CakePHPは各フィールドの型を取得するためにテーブルについて調べます。そしてこの情報はビュー内でのフォームへの出力など、様々な機能で使われています。フィールド名は規約に従って、小文字のアンダースコア区切りとします。

createdとmodified¶

createdやmodifiedといった日付型のフィールドをデータベースのテーブルに定義しておけば、CakePHPはそれらのフィールドを認識して、自動的にレコードの保存または更新時にセットされます(保存されるデータ配列にcreatedやmodifiedフィールドが含まれていない場合に限る)。

createdとmodifiedフィールドには、新しくレコードが追加されるときには現在の日時がセットされます。modifiedフィールドは既存のレコードが更新された時に、現在の日時がセットされます。

Model::save()を呼び出す前に、 created や modified のキーが$this->dataにあると、自動的に更新はされずに、$this->dataの値が使われます。自動的に更新したい場合は、unset($this->data['Model']['modified'] などとします。または、Model::save()をオーバーライドして、常にunsetの動作をするようにも出来ます。

class AppModel extends Model {

    public function save($data = null, $validate = true, $fieldList = array()) {
        // 保存前にmodifiedフィールドをクリアする
        $this->set($data);
        if (isset($this->data[$this->alias]['modified'])) {
            unset($this->data[$this->alias]['modified']);
        }
        return parent::save($this->data, $validate, $fieldList);
    }

}

データを保存する¶

`Model::set($one, $two = null)`¶

`Model::save(array $data = null, boolean $validate = true, array $fieldList = array())`¶

`Model::create(array $data = array())`¶

`Model::saveField(string $fieldName, string $fieldValue, $validate = false)`¶

`Model::updateAll(array $fields, array $conditions)`¶

`Model::saveMany(array $data = null, array $options = array())`¶

`Model::saveAssociated(array $data = null, array $options = array())`¶

`Model::saveAll(array $data = null, array $options = array())`¶

関連データを保存する(hasOne, hasMany, belongsTo)¶

hasManyを保存する¶

関連データを保存する(HABTM)¶

HABTMが複雑になったらどうすればよいか？¶

データテーブル¶

createdとmodified¶

Table of Contents

Page contents

データを保存する¶

Model::set($one, $two = null)¶

Model::save(array $data = null, boolean $validate = true, array $fieldList = array())¶

Model::create(array $data = array())¶

Model::saveField(string $fieldName, string $fieldValue, $validate = false)¶

Model::updateAll(array $fields, array $conditions)¶

Model::saveMany(array $data = null, array $options = array())¶

Model::saveAssociated(array $data = null, array $options = array())¶

Model::saveAll(array $data = null, array $options = array())¶

関連データを保存する(hasOne, hasMany, belongsTo)¶

hasManyを保存する¶

関連データを保存する(HABTM)¶

HABTMが複雑になったらどうすればよいか？¶

データテーブル¶

createdとmodified¶

Table of Contents

Page contents

`Model::set($one, $two = null)`¶

`Model::save(array $data = null, boolean $validate = true, array $fieldList = array())`¶

`Model::create(array $data = array())`¶

`Model::saveField(string $fieldName, string $fieldValue, $validate = false)`¶

`Model::updateAll(array $fields, array $conditions)`¶

`Model::saveMany(array $data = null, array $options = array())`¶

`Model::saveAssociated(array $data = null, array $options = array())`¶

`Model::saveAll(array $data = null, array $options = array())`¶