->update()

->update() – オブジェクト変数でデータベースを更新する

Synopsis

int $DB_DataObject->update ( dataobject|boolean $original|$useWhere )

Description

現在のオブジェクト変数でデータベースを更新します。 もしデータオブジェクトを引数として提供した場合、 新旧データの間での違いだけが更新されます。

引数に DB_DATAOBJECT_WHEREADD_ONLY のみを指定してコールした場合は、 主キーではなく whereAdd の値に基づいてクエリが構築されます。 これを使用すると、一行ずつの更新ではなく複数レコードの一括更新が可能となります。

Parameter

  • DataObject $original - 現在のデータオブジェクトとオリジナルとの違いから、 更新クエリが構築されるかどうかを指定します。

Return value

int 作用した行数、あるいは失敗した場合 FALSE

Throws

Possible PEAR_Error values
エラーコード エラーメッセージ 意味 解決策
DB_DATAOBJECT_ERROR_INVALIDCONFIG "更新:$table の定義がありません"    
DB_DATAOBJECT_ERROR_NODATA "更新:クエリ $settings にデータが指定されていません"    

Note

This function can not be called statically.

Example

単純なフェッチと更新

<?php
$person 
= new DataObjects_Person;
$person->get(12);
$person->name='fred';
$person->update();

$person = new DataObjects_Person;
$person->get(12);
$original = clone($person); // clone is emulated in php4 for compatibility reasons.
$person->name='fred';
$person->update($original);
?>

結果の SQL


SELECT * FROM person WHERE id = 12
UPDATE person SET name='fred', age='21', eyes='blue' WHERE id = 12

SELECT * FROM person WHERE id = 12
UPDATE person SET name='fred'  WHERE id = 12

単純なフェッチと更新

<?php
$person 
= new DataObjects_Person;
$person->removed=1;
$person->whereAdd('age > 21');
$person->update();
?>

結果の SQL


SELECT * FROM person WHERE id = 12;
UPDATE person SET removed=1 WHERE age > 21
現在のオブジェクト変数をデータベースに挿入する (Previous) 表からアイテムを削除します (Next)
Last updated: Fri, 28 Nov 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

Note by: jacek
interesting case:

$person = new DataObjects_Person;
$person -> get(1);
$person -> name = 'fred';
$person -> update();

works but:

$person = new DataObjects_Person;
$person -> get(0);
$person -> name = 'fred';
$person -> update();

doesn't - (and apparently this is not a BUG - I tried to file bug report)

the table has only to records:

id, name
0 john
1 joe

id column is the primary key.





Note by: mike@mikebrittain.com
The second code example is missing the DB_DATAOBJECT_WHEREADD_ONLY parameter which allows for running update queries based only on whereAdd values and not by primary key. See description for this method (above).

$person = new DataObjects_Person;
$person->removed=1;
$person->whereAdd('age > 21');
$person->update(DB_DATAOBJECT_WHEREADD_ONLY);
Note by: evan@prodromou.name
update() will silently skip any columns that are keys -- even if they're just unique keys, not primary keys.

Say you have a table like this:

CREATE TABLE person (id integer primary key, name varchar(255), email varchar(255) unique key)

This is a pretty common pattern.

The following code will do nothing:

$p = Person::staticGet(1);
$orig = clone($p);
$p->email = 'newemail@example.com';
$result = $p->update($orig);

There doesn't seem to be a workaround for it -- I've resorted to updating unique key columns by hand.

It would be nice if the code for skipping key columns differentiated between primary keys and unique keys and let you update the latter.
Note by: pierre2543@hotmail.com
If you want to update a field to null in the database set the field in your DO to the string 'null'.

For string fields, setting it to '' or 'null' issues null in the update statement.

Example:
Set the contractNumber to null.

//INCORRECT
$contract->get(123);
$contract->contractNumber = null;
$contract->update();

//CORRECT
$contract->get(123);
$contract->contractNumber = 'null';
$contract->update();
Note by: user@example.com
When called with

$object->update($original);

this function appears to return true rather than 0 if no rows are affected.